1 /* 2 * Copyright (C) 2021 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 #ifndef HDC_DEFINE_H 16 #define HDC_DEFINE_H 17 #include "define_plus.h" 18 19 namespace Hdc { 20 // ############################## config ####################################### 21 #ifndef USE_CONFIG_UV_THREADS 22 constexpr size_t SIZE_THREAD_POOL = 16; 23 #endif 24 constexpr size_t SIZE_THREAD_POOL_MIN = 16; 25 constexpr size_t SIZE_THREAD_POOL_MAX = 256; 26 constexpr uint8_t GLOBAL_TIMEOUT = 30; 27 constexpr uint16_t DEFAULT_PORT = 8710; 28 constexpr uint16_t MAX_LOG_FILE_COUNT = 300; 29 constexpr uint64_t MAX_LOG_FILE_SIZE = static_cast<uint64_t>(100) * 1024 * 1024; // 100MB 30 constexpr uint64_t MAX_LOG_DIR_SIZE = static_cast<uint64_t>(3) * 1024 * 1024 * 1024; // 3GB 31 constexpr bool ENABLE_IO_CHECKSUM = false; 32 const string IPV4_MAPPING_PREFIX = "::ffff:"; 33 const string DEFAULT_SERVER_ADDR_IP = "::ffff:127.0.0.1"; 34 const string DEFAULT_SERVER_ADDR = "::ffff:127.0.0.1:8710"; 35 const string ENV_SERVER_PORT = "OHOS_HDC_SERVER_PORT"; 36 const string ENV_SERVER_LOG = "OHOS_HDC_LOG_LEVEL"; 37 const string ENV_SERVER_LOG_LIMIT = "OHOS_HDC_LOG_LIMIT"; 38 39 // ################################ macro define ################################### 40 constexpr uint8_t MINOR_TIMEOUT = 5; 41 constexpr uint8_t MILL_SECONDS = 10; 42 constexpr uint8_t WAIT_SECONDS = 30; 43 constexpr uint8_t DWORD_SERIALIZE_SIZE = 4; 44 constexpr uint8_t OFFSET = 2; 45 constexpr uint8_t CMD_ARG1_COUNT = 2; 46 constexpr uint8_t COUNT = 10; 47 constexpr uint8_t STREAM_MAIN = 0; // work at main thread 48 constexpr uint8_t STREAM_WORK = 1; // work at work thread 49 constexpr uint8_t STREAM_SIZE = 2; 50 constexpr uint8_t FEATURE_FLAG_MAX_SIZE = 8; 51 constexpr uint16_t TIME_BUF_SIZE = 32; 52 constexpr uint16_t BUF_SIZE_MICRO = 16; 53 constexpr uint16_t BUF_SIZE_TINY = 64; 54 constexpr uint16_t BUF_SIZE_SMALL = 256; 55 constexpr uint16_t BUF_SIZE_MEDIUM = 512; 56 constexpr uint16_t BUF_SIZE_DEFAULT = 1024; 57 constexpr uint16_t BUF_SIZE_DEFAULT2 = BUF_SIZE_DEFAULT * 2; 58 constexpr uint16_t BUF_SIZE_DEFAULT4 = BUF_SIZE_DEFAULT * 4; 59 constexpr uint16_t MAX_IP_PORT = 65535; 60 constexpr uint16_t MAX_CONNECTKEY_SIZE = 32; // usb sn/tcp ipport 61 constexpr uint16_t TIME_BASE = 1000; // time unit conversion base value 62 constexpr uint16_t UV_DEFAULT_INTERVAL = 250; // ms 63 constexpr uint16_t VER_PROTOCOL = 0x01; 64 constexpr uint16_t MAX_PACKET_SIZE_HISPEED = 512; 65 constexpr uint16_t DEVICE_CHECK_INTERVAL = 3000; // ms 66 constexpr uint32_t MAX_SIZE_IOBUF = 511 * 1024; // 511KB, large file transfer speed up 67 constexpr uint32_t MAX_USBFFS_BULK = 512 * 1024; // 512KB, large file transfer speed up 68 constexpr uint32_t MAX_SIZE_IOBUF_STABLE = 60 * 1024; // 60KB, compatible with previous version 69 constexpr uint32_t MAX_USBFFS_BULK_STABLE = 61 * 1024; // 61KB, compatible with provious version 70 constexpr double DECODE_SCALE = 0.75; 71 constexpr uint16_t LAST_EQUAL_NUM = 2; 72 constexpr uint16_t UV_START_TIMEOUT = 10; 73 constexpr uint16_t UV_START_REPEAT = 10; 74 constexpr uint16_t UV_LISTEN_LBACKOG = 4; 75 constexpr uint16_t BUF_EXTEND_SIZE = 4; 76 constexpr uint16_t BUF_MULTIPLE = 2; 77 constexpr uint16_t EXPECTED_LEN = 9; 78 constexpr uint16_t MAX_APP_PARAM_SIZE = 512; 79 constexpr uint16_t MIN_APP_PARAM_SIZE = 4; 80 constexpr uint16_t FORWORD_PORT_RM_BUF_SIZE = 9; 81 constexpr uint16_t FORWORD_PORT_OTHER_BUF_SIZE = 6; 82 constexpr uint16_t CMD_REMOTE_SIZE = 8; 83 constexpr uint16_t PORT_MAX_LEN = 5; 84 constexpr uint16_t START_SERVER_FOR_CLIENT_TIME = 300; 85 constexpr uint16_t CMD_FILE_PENULT_PARAM = 2; 86 #ifdef HDC_HOST 87 constexpr uint16_t MAX_DELETED_SESSION_ID_RECORD_COUNT = 32; 88 #else 89 constexpr uint16_t MAX_DELETED_SESSION_ID_RECORD_COUNT = 10; 90 #endif 91 constexpr uint16_t TCP_CONNECT_MAX_RETRY_COUNT = 6; 92 constexpr uint16_t TCP_CONNECT_RETRY_TIME_MS = 500; 93 constexpr uint16_t NEW_SESSION_DROP_USB_DATA_TIME_MS = 1000; 94 95 // double-word(hex)=[0]major[1][2]minor[3][4]version[5]fix(a-p)[6][7]reserve 96 // |----------------------------------------------------------------| 97 // | 31-28 | 27-24 | 23-20 | 19-16 | 15-12 | 11-08 | 07-00 | 98 // |----------------------------------------------------------------| 99 // | major |reserve| minor |reserve|version| fix | reserve | 100 // |----------------------------------------------------------------| 101 // 0x30100200 is 3.1.0c 102 constexpr uint32_t HDC_VERSION_NUMBER = 0x30100200; 103 constexpr uint32_t HDC_BUF_MAX_BYTES = INT_MAX; 104 #ifdef HDC_HOST 105 constexpr uint32_t HOST_SOCKETPAIR_SIZE = 1024 * 1024; 106 #endif 107 constexpr uint32_t HDC_SOCKETPAIR_SIZE = MAX_SIZE_IOBUF * 2; 108 // "\f" asicc is 12 109 const string HDC_HOST_DAEMON_BUF_SEPARATOR = "\f"; 110 constexpr int32_t RSA_KEY_BITS = 3072; 111 112 const string WHITE_SPACES = " \t\n\r"; 113 const string UT_TMP_PATH = "/tmp/hdc-ut"; 114 const string LOG_FILE_NAME = "hdc.log"; 115 const string LOG_FILE_NAME_PREFIX = "hdc-"; 116 const string LOG_FILE_SUFFIX = ".log"; 117 const string LOG_FILE_COMPRESS_SUFFIX = ".tgz"; 118 const string LOG_COMPRESS_TOOL_NAME = "tar"; 119 const string LOG_CACHE_NAME = ".hdc.cache.log"; 120 const string LOG_DIR_NAME = "hdc_logs"; 121 const string LOG_COMPRESS_TOOL_PARAMS = "czfp"; 122 const string SERVER_NAME = "HDCServer"; 123 const string STRING_EMPTY = ""; 124 const string HANDSHAKE_MESSAGE = "OHOS HDC"; // sep not char '-', not more than 11 bytes 125 const string HANDSHAKE_FAILED = "HS FAILED"; 126 const string PACKET_FLAG = "HW"; // must 2bytes 127 const string EMPTY_ECHO = "[Empty]"; 128 const string MESSAGE_INFO = "[Info]"; 129 const string MESSAGE_FAIL = "[Fail]"; 130 const string MESSAGE_SUCCESS = "[Success]"; 131 const char HUGE_BUF_TAG = 'H'; // support huge buffer 132 const size_t BANNER_FEATURE_TAG_OFFSET = 11; 133 const char WAIT_DEVICE_TAG = 'W'; 134 const size_t WAIT_TAG_OFFSET = 11; 135 // input command 136 const string CMDSTR_SOFTWARE_VERSION = "version"; 137 const string CMDSTR_SOFTWARE_HELP = "help"; 138 const string CMDSTR_TARGET_DISCOVER = "discover"; 139 const string CMDSTR_SERVICE_START = "start"; 140 const string CMDSTR_SERVICE_KILL = "kill"; 141 const string CMDSTR_GENERATE_KEY = "keygen"; 142 const string CMDSTR_LIST_TARGETS = "list targets"; 143 const string CMDSTR_CHECK_SERVER = "checkserver"; 144 const string CMDSTR_CHECK_DEVICE = "checkdevice"; 145 const string CMDSTR_WAIT_FOR = "wait"; 146 const string CMDSTR_CONNECT_TARGET = "tconn"; 147 const string CMDSTR_CONNECT_ANY = "any"; 148 const string CMDSTR_SHELL = "shell"; 149 const string CMDSTR_TARGET_REBOOT = "target boot"; 150 const string CMDSTR_TARGET_MOUNT = "target mount"; 151 const string CMDSTR_STARTUP_MODE = "smode"; 152 const string CMDSTR_TARGET_MODE = "tmode"; 153 const string CMDSTR_BUGREPORT = "bugreport"; 154 const string CMDSTR_HILOG = "hilog"; 155 const string CMDSTR_TMODE_USB = "usb"; 156 #ifdef _WIN32 157 const string HILOG_NAME = "hilog.exe"; 158 const string SPLIT = "\\"; 159 const string LOG_COMPRESS_TOOL_BIN_WIN32 = "C:\\Windows\\System32\\tar.exe"; 160 #else 161 const string LOG_COMPRESS_TOOL_BIN_UNIX = "tar"; 162 #endif 163 #ifdef HDC_SUPPORT_UART 164 const string CMDSTR_TMODE_UART = "uart"; 165 const string UART_HDC_NODE = "/dev/ttyS4"; 166 const string CONSOLE_ACTIVE_NODE = "/sys/class/tty/console/active"; 167 constexpr int UART_IO_WAIT_TIME_100 = 100; 168 constexpr int UART_IO_WAIT_TIME = 1000; 169 constexpr uint16_t MAX_UART_SIZE_IOBUF = 4096; // MAX_SIZE_IOBUF; 170 #endif 171 const string CMDSTR_TMODE_TCP = "tcp"; 172 #ifdef HDC_EMULATOR 173 const string CMDSTR_TMODE_BRIDGE = "bridge"; 174 #endif 175 const string CMDSTR_FILE_SEND = "file send"; 176 const string CMDSTR_FILE_RECV = "file recv"; 177 const string CMDSTR_REMOTE_PARAMETER = "remote"; 178 const string CMDSTR_FORWARD_FPORT = "fport"; 179 const string CMDSTR_FORWARD_RPORT = "rport"; 180 const string CMDSTR_APP_INSTALL = "install"; 181 const string CMDSTR_APP_UNINSTALL = "uninstall"; 182 const string CMDSTR_APP_SIDELOAD = "sideload"; 183 const string CMDSTR_LIST_JDWP = "jpid"; 184 const string CMDSTR_TRACK_JDWP = "track-jpid"; 185 const string CMDSTR_INNER_ENABLE_KEEPALIVE = "alive"; 186 const string CMDSTR_FLASHD_UPDATE = "update"; 187 const string CMDSTR_FLASHD_FLASH = "flash"; 188 const string CMDSTR_FLASHD_ERASE = "erase"; 189 const string CMDSTR_FLASHD_FORMAT = "format"; 190 191 // ################################ Error Message ################################### 192 const string TERMINAL_HDC_PROCESS_FAILED = "[E002101]:Terminal hdc process failed, "\ 193 "please terminal the hdc process in the task manager first."; 194 195 // ################################ Macro define ################################### 196 #ifdef IS_RELEASE_VERSION 197 #define WRITE_LOG(level, fmt, ...) Base::PrintLogEx(__FUNCTION__, __LINE__, level, fmt, ##__VA_ARGS__) 198 #else 199 #define WRITE_LOG(level, fmt, ...) Base::PrintLogEx(__FILE_NAME__, __LINE__, level, fmt, ##__VA_ARGS__) 200 #endif 201 #ifdef _WIN32 202 #define hdc_strerrno(buf) \ 203 char buf[1024] = { 0 }; \ 204 strerror_s(buf, 1024, errno) 205 #else 206 #define hdc_strerrno(buf) \ 207 char buf[1024] = { 0 }; \ 208 strerror_r(errno, buf, 1024) 209 #endif 210 } // namespace Hdc 211 #endif // HDC_DEFINE_H 212