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