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 
16 #ifndef DISTRIBUTEDDB_CONSTANT_H
17 #define DISTRIBUTEDDB_CONSTANT_H
18 
19 #include <string>
20 
21 namespace DistributedDB {
22 class DBConstant {
23 public:
24     static constexpr size_t MAX_KEY_SIZE = 1024;
25     static constexpr size_t MAX_VALUE_SIZE = 4194304;
26     static constexpr size_t MAX_BATCH_SIZE = 128;
27     static constexpr size_t MAX_DEV_LENGTH = 128;
28     static constexpr size_t MAX_TRANSACTION_KEY_VALUE_LENS = 512 * 1024 * 1024; // 512M
29 
30     static constexpr size_t MAX_DATA_DIR_LENGTH = 512;
31 
32     static constexpr size_t MAX_INKEYS_SIZE = 128;
33     static constexpr size_t MAX_SQL_ARGS_COUNT = 100;
34     static constexpr size_t MAX_IN_COUNT = 100;
35 
36     static constexpr int DB_TYPE_LOCAL = 1;
37     static constexpr int DB_TYPE_MULTI_VER = 2;
38     static constexpr int DB_TYPE_SINGLE_VER = 3;
39 
40     static constexpr int QUEUED_SYNC_LIMIT_DEFAULT = 32;
41     static constexpr int QUEUED_SYNC_LIMIT_MIN = 1;
42     static constexpr int QUEUED_SYNC_LIMIT_MAX = 4096;
43 
44     static constexpr int MAX_DEVICES_SIZE = 100;
45     static constexpr int MAX_COMMIT_SIZE = 1000000;
46     static constexpr int MAX_ENTRIES_SIZE = 1000000;
47 
48     static constexpr uint32_t MAX_COLUMN  = 32767;
49 
50     static constexpr int MAX_REMOTEDATA_SIZE = 4194304;  // 4M.
51 
52     static constexpr int DEFAULT_ITER_TIMES = 5000;
53 
54     // In querySync, when getting query data finished,
55     // if the block size reach the half of max block size, will get deleted data next;
56     // if the block size not reach the half of max block size, will not get deleted data.
57     static constexpr float QUERY_SYNC_THRESHOLD = 0.50;
58 
59     static constexpr uint64_t MAX_USER_ID_LENGTH = 128;
60     static constexpr uint64_t MAX_APP_ID_LENGTH = 128;
61     static constexpr uint64_t MAX_STORE_ID_LENGTH = 128;
62     static constexpr uint64_t MAX_SUB_USER_LENGTH = 128;
63 
64     static const std::string MULTI_SUB_DIR;
65     static const std::string SINGLE_SUB_DIR;
66     static const std::string LOCAL_SUB_DIR;
67 
68     static const std::string MAINDB_DIR;
69     static const std::string METADB_DIR;
70     static const std::string CACHEDB_DIR;
71 
72     static constexpr const char *LOCAL_DATABASE_NAME = "local";
73     static constexpr const char *MULTI_VER_DATA_STORE = "multi_ver_data";
74     static constexpr const char *MULTI_VER_COMMIT_STORE = "commit_logs";
75     static constexpr const char *MULTI_VER_VALUE_STORE = "value_storage";
76     static constexpr const char *MULTI_VER_META_STORE = "meta_storage";
77     static const std::string SINGLE_VER_DATA_STORE;
78     static const std::string SINGLE_VER_META_STORE;
79     static const std::string SINGLE_VER_CACHE_STORE;
80 
81     static constexpr const char *SQLITE_URL_PRE = "file:";
82     static constexpr const char *DB_EXTENSION = ".db";
83     static constexpr const char *SQLITE_MEMDB_IDENTIFY = "?mode=memory&cache=shared";
84 
85     static constexpr const char *SCHEMA_KEY = "schemaKey";
86     static const std::string RELATIONAL_SCHEMA_KEY;
87     static const std::string RELATIONAL_TRACKER_SCHEMA_KEY;
88 
89     static constexpr const char *RD_KV_COLLECTION_MODE = "{\"mode\" : \"kv\"}";
90     static constexpr const char *RD_KV_HASH_COLLECTION_MODE = "{\"mode\" : \"kv\",\"indextype\" : \"hash\"}";
91 
92     static constexpr const char *PATH_POSTFIX_UNPACKED = "_unpacked";
93     static constexpr const char *PATH_POSTFIX_IMPORT_BACKUP = "_import_bak";
94     static constexpr const char *PATH_POSTFIX_IMPORT_ORIGIN = "_import_ori";
95     static constexpr const char *PATH_POSTFIX_IMPORT_DUP = "_import_dup";
96     static constexpr const char *PATH_POSTFIX_EXPORT_BACKUP = "_export_bak";
97     // use for make sure create datebase and set label complete
98     static constexpr const char *PATH_POSTFIX_DB_INCOMPLETE = "_db_incomplete.lock";
99 
100     static constexpr const char *REKEY_FILENAME_POSTFIX_PRE = "_ctrl_pre";
101     static constexpr const char *REKEY_FILENAME_POSTFIX_OK = "_ctrl_ok";
102     static constexpr const char *UPGRADE_POSTFIX = "_upgrade.lock";
103     // used for make sure meta split upgrade atomically
104     static constexpr const char *SET_SECOPT_POSTFIX = "_secopt.lock";
105     static constexpr const char *PATH_BACKUP_POSTFIX = "_bak";
106 
107     static constexpr const char *ID_CONNECTOR = "-";
108 
109     static constexpr const char *DELETE_KVSTORE_REMOVING = "_removing";
110     static constexpr const char *DB_LOCK_POSTFIX = ".lock";
111 
112     static constexpr const char *SUBSCRIBE_QUERY_PREFIX = "subscribe_query_";
113 
114     static constexpr const char *TRIGGER_REFERENCES_NEW = "NEW.";
115     static constexpr const char *TRIGGER_REFERENCES_OLD = "OLD.";
116 
117     static const std::string UPDATE_META_FUNC;
118 
119     // Prefix Key in meta db
120     static constexpr const char *DEVICEID_PREFIX_KEY = "deviceId";
121     static constexpr const char *QUERY_SYNC_PREFIX_KEY = "querySync";
122     static constexpr const char *DELETE_SYNC_PREFIX_KEY = "deleteSync";
123 
124     static const size_t MAX_NORMAL_PACK_ITEM_SIZE = 4000;
125     static const size_t MAX_HPMODE_PACK_ITEM_SIZE = 2000; // slide window mode to reduce last ack transfer time
126 
127     static constexpr uint32_t MIN_MTU_SIZE = 1024; // 1KB
128     static constexpr uint32_t MAX_MTU_SIZE = 5242880; // 5MB
129 
130     static constexpr uint32_t MIN_TIMEOUT = 5000; // 5s
131     static constexpr uint32_t MAX_TIMEOUT = 60000; // 60s
132     static constexpr uint32_t MAX_SYNC_TIMEOUT = 300000; // 300s
133     static constexpr int INFINITE_WAIT = -1; // -1 is infinite waiting
134 
135     static constexpr uint8_t DEFAULT_COMPTRESS_RATE = 100;
136 
137     static constexpr size_t MAX_SYNC_BLOCK_SIZE = 31457280; // 30MB
138 
139     static constexpr int DOUBLE_PRECISION = 15;
140     static constexpr int MAX_DISTRIBUTED_TABLE_COUNT = 32;
141 
142     static constexpr uint64_t MAX_LOG_SIZE_HIGH = 0x400000000ULL; // 16GB
143     static constexpr uint64_t MAX_LOG_SIZE_LOW = 0x400000ULL; // 4MB
144     static constexpr uint64_t MAX_LOG_SIZE_DEFAULT = 0x40000000ULL; // 1GB
145 
146     static constexpr int DEF_LIFE_CYCLE_TIME = 60000; // 60S
147 
148     static constexpr int RELATIONAL_LOG_TABLE_FIELD_NUM = 7; // field num is relational distributed log table
149 
150     static constexpr uint64_t IGNORE_CONNECTION_ID = 0;
151     // Soft limit of a connection observer count.
152     static constexpr int MAX_OBSERVER_COUNT = 8;
153 
154     // For relational
155     static const std::string SYSTEM_TABLE_PREFIX;
156     static const std::string RELATIONAL_PREFIX;
157     static const std::string TIMESTAMP_ALIAS;
158     static constexpr const char *LOG_POSTFIX = "_log";
159     static constexpr const char *META_TABLE_POSTFIX = "metadata";
160 
161     static constexpr const char *LOG_TABLE_VERSION_3 = "3.0";
162     static constexpr const char *LOG_TABLE_VERSION_5_1 = "5.01";
163     static constexpr const char *LOG_TABLE_VERSION_5_3 = "5.03"; // add sharing_resource field
164     static constexpr const char *LOG_TABLE_VERSION_5_5 = "5.05"; // add status field
165     static constexpr const char *LOG_TABLE_VERSION_5_8 = "5.08"; // migrate cursor to meta table
166     static constexpr const char *LOG_TABLE_VERSION_5_9 = "5.09"; // insert retains the old version
167     static constexpr const char *LOG_TABLE_VERSION_CURRENT = LOG_TABLE_VERSION_5_9;
168 
169     static const std::string LOG_TABLE_VERSION_KEY;
170 
171     static constexpr const char *REMOTE_DEVICE_SCHEMA_KEY_PREFIX = "remote_device_schema_";
172 
173     static constexpr uint32_t MAX_CONDITION_KEY_LEN = 128;
174     static constexpr uint32_t MAX_CONDITION_VALUE_LEN = 128;
175     static constexpr uint32_t MAX_CONDITION_COUNT = 32;
176 
177     static constexpr uint32_t REMOTE_QUERY_MAX_SQL_LEN = 1000000U;
178 
179     static constexpr int HASH_KEY_SIZE = 32; // size of SHA256_DIGEST_LENGTH
180 
181     static constexpr const char *TABLE_IS_DROPPED = "table_is_dropped_";
182 
183     static constexpr const char *SQLITE_INNER_ROWID = "_rowid_";
184     static constexpr int32_t DEFAULT_ROW_ID = -1;
185     static constexpr int STR_TO_LL_BY_DEVALUE = 10;
186     // key in meta_data
187     static constexpr const char *LOCALTIME_OFFSET_KEY = "localTimeOffset";
188 
189     static constexpr uint64_t OBSERVER_CHANGES_MASK = 0XF00;
190 
191     static constexpr const char *STORAGE_TYPE_LONG = "long";
192 };
193 } // namespace DistributedDB
194 #endif // DISTRIBUTEDDB_CONSTANT_H
195