query.h 13.2 KB
Newer Older
D
dapan1121 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/*
 * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
 *
 * This program is free software: you can use, redistribute, and/or modify
 * it under the terms of the GNU Affero General Public License, version 3
 * or later ("AGPL"), as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

D
dapan1121 已提交
16 17
#ifndef _TD_QUERY_H_
#define _TD_QUERY_H_
D
dapan1121 已提交
18

dengyihao's avatar
dengyihao 已提交
19
// clang-foramt off
D
dapan1121 已提交
20 21 22 23
#ifdef __cplusplus
extern "C" {
#endif

D
dapan1121 已提交
24
#include "tarray.h"
25
#include "thash.h"
26
#include "tlog.h"
H
Haojun Liao 已提交
27
#include "tmsg.h"
28
#include "tmsgcb.h"
D
dapan1121 已提交
29

S
Shengliang Guan 已提交
30
typedef enum {
D
dapan1121 已提交
31
  JOB_TASK_STATUS_NULL = 0,
D
dapan1121 已提交
32 33 34 35 36 37 38
  JOB_TASK_STATUS_INIT,
  JOB_TASK_STATUS_EXEC,
  JOB_TASK_STATUS_PART_SUCC,
  JOB_TASK_STATUS_SUCC,
  JOB_TASK_STATUS_FAIL,
  JOB_TASK_STATUS_DROP,
  JOB_TASK_STATUS_MAX,
S
Shengliang Guan 已提交
39
} EJobTaskType;
D
dapan1121 已提交
40

S
Shengliang Guan 已提交
41
typedef enum {
D
dapan1121 已提交
42 43
  TASK_TYPE_PERSISTENT = 1,
  TASK_TYPE_TEMP,
S
Shengliang Guan 已提交
44
} ETaskType;
D
dapan1121 已提交
45

D
dapan1121 已提交
46 47 48 49 50 51
typedef enum {
  TARGET_TYPE_MNODE = 1,
  TARGET_TYPE_VNODE,
  TARGET_TYPE_OTHER,
} ETargetType;

D
dapan1121 已提交
52 53 54
#define QUERY_POLICY_VNODE  1
#define QUERY_POLICY_HYBRID 2
#define QUERY_POLICY_QNODE  3
D
dapan1121 已提交
55
#define QUERY_POLICY_CLIENT 4
D
dapan1121 已提交
56

D
dapan1121 已提交
57 58 59
#define QUERY_RSP_POLICY_DELAY 0
#define QUERY_RSP_POLICY_QUICK 1

60
#define QUERY_MSG_MASK_SHOW_REWRITE() (1 << 0)
dengyihao's avatar
dengyihao 已提交
61
#define TEST_SHOW_REWRITE_MASK(m)     (((m)&QUERY_MSG_MASK_SHOW_REWRITE()) != 0)
62

D
dapan1121 已提交
63
typedef struct STableComInfo {
64 65 66 67
  uint8_t  numOfTags;     // the number of tags in schema
  uint8_t  precision;     // the number of precision
  col_id_t numOfColumns;  // the number of columns
  int32_t  rowSize;       // row size of the schema
D
dapan1121 已提交
68 69
} STableComInfo;

D
dapan1121 已提交
70
typedef struct SIndexMeta {
wafwerar's avatar
wafwerar 已提交
71
#if defined(WINDOWS) || defined(_TD_DARWIN_64)
wafwerar's avatar
wafwerar 已提交
72 73 74
  size_t avoidCompilationErrors;
#endif

D
dapan1121 已提交
75 76
} SIndexMeta;

D
dapan1121 已提交
77
typedef struct SExecResult {
H
Hongze Cheng 已提交
78 79 80 81 82
  int32_t  code;
  uint64_t numOfRows;
  uint64_t numOfBytes;
  int32_t  msgType;
  void*    res;
D
dapan1121 已提交
83 84
} SExecResult;

85
typedef struct STbVerInfo {
dengyihao's avatar
dengyihao 已提交
86
  char    tbFName[TSDB_TABLE_FNAME_LEN];
87 88 89 90
  int32_t sversion;
  int32_t tversion;
} STbVerInfo;

D
dapan1121 已提交
91
/*
92 93
 * ASSERT(sizeof(SCTableMeta) == 24)
 * ASSERT(tableType == TSDB_CHILD_TABLE)
D
dapan1121 已提交
94 95 96
 * The cached child table meta info. For each child table, 24 bytes are required to keep the essential table info.
 */
typedef struct SCTableMeta {
L
Liu Jicong 已提交
97
  int32_t  vgId : 24;
D
dapan1121 已提交
98 99 100 101 102 103
  int8_t   tableType;
  uint64_t uid;
  uint64_t suid;
} SCTableMeta;

/*
L
Liu Jicong 已提交
104 105
 * Note that the first 24 bytes of STableMeta are identical to SCTableMeta, it is safe to cast a STableMeta to be a
 * SCTableMeta.
D
dapan1121 已提交
106 107
 */
typedef struct STableMeta {
L
Liu Jicong 已提交
108 109 110 111 112 113 114 115 116 117 118 119 120
  // BEGIN: KEEP THIS PART SAME WITH SCTableMeta
  int32_t  vgId : 24;
  int8_t   tableType;
  uint64_t uid;
  uint64_t suid;
  // END: KEEP THIS PART SAME WITH SCTableMeta

  // if the table is TSDB_CHILD_TABLE, the following information is acquired from the corresponding super table meta
  // info
  int16_t       sversion;
  int16_t       tversion;
  STableComInfo tableInfo;
  SSchema       schema[];
D
dapan1121 已提交
121 122
} STableMeta;

D
dapan1121 已提交
123
typedef struct SDBVgInfo {
L
Liu Jicong 已提交
124
  int32_t   vgVersion;
125 126
  int16_t   hashPrefix;
  int16_t   hashSuffix;
127
  int8_t    hashMethod;
D
dapan 已提交
128
  int32_t   numOfTable;  // DB's table num, unit is TSDB_TABLE_NUM_UNIT
D
dapan1121 已提交
129
  int64_t   stateTs;
dengyihao's avatar
dengyihao 已提交
130
  SHashObj* vgHash;  // key:vgId, value:SVgroupInfo
131
  SArray*   vgArray;
D
dapan1121 已提交
132
} SDBVgInfo;
D
dapan1121 已提交
133 134

typedef struct SUseDbOutput {
L
Liu Jicong 已提交
135 136 137
  char       db[TSDB_DB_FNAME_LEN];
  uint64_t   dbId;
  SDBVgInfo* dbVgroup;
D
dapan1121 已提交
138 139
} SUseDbOutput;

L
Liu Jicong 已提交
140
enum { META_TYPE_NULL_TABLE = 1, META_TYPE_CTABLE, META_TYPE_TABLE, META_TYPE_BOTH_TABLE };
D
dapan1121 已提交
141

D
dapan1121 已提交
142
typedef struct STableMetaOutput {
D
dapan1121 已提交
143
  int32_t     metaType;
D
dapan1121 已提交
144
  uint64_t    dbId;
D
dapan1121 已提交
145 146 147
  char        dbFName[TSDB_DB_FNAME_LEN];
  char        ctbName[TSDB_TABLE_NAME_LEN];
  char        tbName[TSDB_TABLE_NAME_LEN];
D
dapan1121 已提交
148
  SCTableMeta ctbMeta;
L
Liu Jicong 已提交
149
  STableMeta* tbMeta;
D
dapan1121 已提交
150
} STableMetaOutput;
D
dapan1121 已提交
151

L
Liu Jicong 已提交
152
typedef struct SDataBuf {
D
dapan1121 已提交
153
  int32_t  msgType;
L
Liu Jicong 已提交
154 155 156
  void*    pData;
  uint32_t len;
  void*    handle;
D
dapan1121 已提交
157
  SEpSet*  pEpSet;
L
Liu Jicong 已提交
158 159
} SDataBuf;

D
dapan1121 已提交
160 161
typedef struct STargetInfo {
  ETargetType type;
dengyihao's avatar
dengyihao 已提交
162
  char*       dbFName;  // used to update db's vgroup epset
D
dapan1121 已提交
163 164 165
  int32_t     vgId;
} STargetInfo;

D
dapan1121 已提交
166
typedef int32_t (*__async_send_cb_fn_t)(void* param, SDataBuf* pMsg, int32_t code);
L
Liu Jicong 已提交
167 168
typedef int32_t (*__async_exec_fn_t)(void* param);

D
dapan1121 已提交
169
typedef struct SRequestConnInfo {
dengyihao's avatar
dengyihao 已提交
170 171 172 173
  void*    pTrans;
  uint64_t requestId;
  int64_t  requestObjRefId;
  SEpSet   mgmtEps;
D
dapan1121 已提交
174 175
} SRequestConnInfo;

H
Hongze Cheng 已提交
176
typedef void (*__freeFunc)(void* param);
D
dapan1121 已提交
177

L
Liu Jicong 已提交
178
typedef struct SMsgSendInfo {
dengyihao's avatar
dengyihao 已提交
179 180
  __async_send_cb_fn_t fp;      // async callback function
  STargetInfo          target;  // for update epset
D
dapan1121 已提交
181
  __freeFunc           paramFreeFp;
L
Liu Jicong 已提交
182 183 184 185 186
  void*                param;
  uint64_t             requestId;
  uint64_t             requestObjRefId;
  int32_t              msgType;
  SDataBuf             msgInfo;
L
Liu Jicong 已提交
187 188
} SMsgSendInfo;

D
dapan1121 已提交
189
typedef struct SQueryNodeStat {
190
  int32_t tableNum;  // vg table number, unit is TSDB_TABLE_NUM_UNIT
D
dapan1121 已提交
191 192
} SQueryNodeStat;

L
Liu Jicong 已提交
193 194 195 196 197 198 199 200 201 202 203 204
int32_t initTaskQueue();
int32_t cleanupTaskQueue();

/**
 *
 * @param execFn      The asynchronously execution function
 * @param execParam   The parameters of the execFn
 * @param code        The response code during execution the execFn
 * @return
 */
int32_t taosAsyncExec(__async_exec_fn_t execFn, void* execParam, int32_t* code);

D
dapan1121 已提交
205 206
void destroySendMsgInfo(SMsgSendInfo* pMsgBody);

dengyihao's avatar
dengyihao 已提交
207 208
void destroyAhandle(void* ahandle);

D
dapan1121 已提交
209
int32_t asyncSendMsgToServerExt(void* pTransporter, SEpSet* epSet, int64_t* pTransporterId, SMsgSendInfo* pInfo,
210
                                bool persistHandle, void* ctx);
D
dapan1121 已提交
211

L
Liu Jicong 已提交
212 213 214 215 216 217 218 219 220
/**
 * Asynchronously send message to server, after the response received, the callback will be incured.
 *
 * @param pTransporter
 * @param epSet
 * @param pTransporterId
 * @param pInfo
 * @return
 */
D
dapan1121 已提交
221
int32_t asyncSendMsgToServer(void* pTransporter, SEpSet* epSet, int64_t* pTransporterId, SMsgSendInfo* pInfo);
L
Liu Jicong 已提交
222

L
Liu Jicong 已提交
223
int32_t queryBuildUseDbOutput(SUseDbOutput* pOut, SUseDbRsp* usedbRsp);
X
Xiaoyu Wang 已提交
224

225
void initQueryModuleMsgHandle();
D
dapan1121 已提交
226

L
Liu Jicong 已提交
227
const SSchema* tGetTbnameColumnSchema();
L
Liu Jicong 已提交
228
bool           tIsValidSchema(struct SSchema* pSchema, int32_t numOfCols, int32_t numOfTags);
L
Liu Jicong 已提交
229

H
Hongze Cheng 已提交
230
int32_t queryCreateCTableMetaFromMsg(STableMetaRsp* msg, SCTableMeta* pMeta);
L
Liu Jicong 已提交
231
int32_t queryCreateTableMetaFromMsg(STableMetaRsp* msg, bool isSuperTable, STableMeta** pMeta);
232
char*   jobTaskStatusStr(int32_t status);
D
dapan1121 已提交
233

234
SSchema createSchema(int8_t type, int32_t bytes, col_id_t colId, const char* name);
dengyihao's avatar
dengyihao 已提交
235

D
dapan1121 已提交
236
void    destroyQueryExecRes(SExecResult* pRes);
dengyihao's avatar
dengyihao 已提交
237 238
int32_t dataConverToStr(char* str, int type, void* buf, int32_t bufSize, int32_t* len);
char*   parseTagDatatoJson(void* p);
D
dapan1121 已提交
239 240
int32_t cloneTableMeta(STableMeta* pSrc, STableMeta** pDst);
int32_t cloneDbVgInfo(SDBVgInfo* pSrc, SDBVgInfo** pDst);
241
void    freeVgInfo(SDBVgInfo* vgInfo);
D
dapan1121 已提交
242

dengyihao's avatar
dengyihao 已提交
243
extern int32_t (*queryBuildMsg[TDMT_MAX])(void* input, char** msg, int32_t msgSize, int32_t* msgLen,
wafwerar's avatar
wafwerar 已提交
244
                                          void* (*mallocFp)(int64_t));
L
Liu Jicong 已提交
245
extern int32_t (*queryProcessMsgRsp[TDMT_MAX])(void* output, char* msg, int32_t msgSize);
D
dapan1121 已提交
246

L
Liu Jicong 已提交
247 248 249
#define SET_META_TYPE_NULL(t)       (t) = META_TYPE_NULL_TABLE
#define SET_META_TYPE_CTABLE(t)     (t) = META_TYPE_CTABLE
#define SET_META_TYPE_TABLE(t)      (t) = META_TYPE_TABLE
D
dapan1121 已提交
250 251
#define SET_META_TYPE_BOTH_TABLE(t) (t) = META_TYPE_BOTH_TABLE

252
#define NEED_CLIENT_RM_TBLMETA_ERROR(_code)                                                   \
253
  ((_code) == TSDB_CODE_PAR_TABLE_NOT_EXIST || (_code) == TSDB_CODE_TDB_TABLE_NOT_EXIST ||    \
254
   (_code) == TSDB_CODE_PAR_INVALID_COLUMNS_NUM || (_code) == TSDB_CODE_PAR_INVALID_COLUMN || \
dengyihao's avatar
dengyihao 已提交
255
   (_code) == TSDB_CODE_PAR_TAGS_NOT_MATCHED || (_code) == TSDB_CODE_PAR_VALUE_TOO_LONG ||    \
D
dapan1121 已提交
256
   (_code) == TSDB_CODE_PAR_INVALID_DROP_COL || ((_code) == TSDB_CODE_TDB_INVALID_TABLE_ID))
257 258
#define NEED_CLIENT_REFRESH_VG_ERROR(_code) \
  ((_code) == TSDB_CODE_VND_HASH_MISMATCH || (_code) == TSDB_CODE_VND_INVALID_VGROUP_ID)
D
dapan1121 已提交
259
#define NEED_CLIENT_REFRESH_TBLMETA_ERROR(_code) ((_code) == TSDB_CODE_TDB_INVALID_TABLE_SCHEMA_VER)
260 261 262
#define NEED_CLIENT_HANDLE_ERROR(_code)                                          \
  (NEED_CLIENT_RM_TBLMETA_ERROR(_code) || NEED_CLIENT_REFRESH_VG_ERROR(_code) || \
   NEED_CLIENT_REFRESH_TBLMETA_ERROR(_code))
263

dengyihao's avatar
dengyihao 已提交
264 265 266 267 268 269
#define SYNC_UNKNOWN_LEADER_REDIRECT_ERROR(_code)                                    \
  ((_code) == TSDB_CODE_SYN_NOT_LEADER || (_code) == TSDB_CODE_SYN_INTERNAL_ERROR || \
   (_code) == TSDB_CODE_VND_STOPPED || (_code) == TSDB_CODE_APP_IS_STARTING || (_code) == TSDB_CODE_APP_IS_STOPPING)
#define SYNC_SELF_LEADER_REDIRECT_ERROR(_code) \
  ((_code) == TSDB_CODE_SYN_NOT_LEADER || (_code) == TSDB_CODE_SYN_RESTORING || (_code) == TSDB_CODE_SYN_INTERNAL_ERROR)
#define SYNC_OTHER_LEADER_REDIRECT_ERROR(_code) ((_code) == TSDB_CODE_MNODE_NOT_FOUND)
270

A
Alex Duan 已提交
271
#define NO_RET_REDIRECT_ERROR(_code) ((_code) == TSDB_CODE_RPC_BROKEN_LINK || (_code) == TSDB_CODE_RPC_NETWORK_UNAVAIL || (_code) == TSDB_CODE_RPC_SOMENODE_NOT_CONNECTED)
272

dengyihao's avatar
dengyihao 已提交
273
#define NEED_REDIRECT_ERROR(_code)                                              \
274 275
  (NO_RET_REDIRECT_ERROR(_code) || SYNC_UNKNOWN_LEADER_REDIRECT_ERROR(_code) || \
   SYNC_SELF_LEADER_REDIRECT_ERROR(_code) || SYNC_OTHER_LEADER_REDIRECT_ERROR(_code))
H
Hongze Cheng 已提交
276

dengyihao's avatar
dengyihao 已提交
277
#define NEED_CLIENT_RM_TBLMETA_REQ(_type)                                                                  \
wmmhello's avatar
wmmhello 已提交
278 279
  ((_type) == TDMT_VND_CREATE_TABLE || (_type) == TDMT_MND_CREATE_STB || (_type) == TDMT_VND_DROP_TABLE || \
   (_type) == TDMT_MND_DROP_STB)
D
dapan 已提交
280

dengyihao's avatar
dengyihao 已提交
281 282 283
#define NEED_SCHEDULER_REDIRECT_ERROR(_code)                                              \
  (SYNC_UNKNOWN_LEADER_REDIRECT_ERROR(_code) || SYNC_SELF_LEADER_REDIRECT_ERROR(_code) || \
   SYNC_OTHER_LEADER_REDIRECT_ERROR(_code))
D
dapan1121 已提交
284

285
#define REQUEST_TOTAL_EXEC_TIMES 2
D
dapan1121 已提交
286

H
Hongze Cheng 已提交
287 288 289
#define IS_SYS_DBNAME(_dbname)                                                    \
  (((*(_dbname) == 'i') && (0 == strcmp(_dbname, TSDB_INFORMATION_SCHEMA_DB))) || \
   ((*(_dbname) == 'p') && (0 == strcmp(_dbname, TSDB_PERFORMANCE_SCHEMA_DB))))
D
dapan1121 已提交
290

H
Hongze Cheng 已提交
291 292 293
#define qFatal(...)                                                     \
  do {                                                                  \
    if (qDebugFlag & DEBUG_FATAL) {                                     \
D
dapan1121 已提交
294
      taosPrintLog("QRY FATAL ", DEBUG_FATAL, qDebugFlag, __VA_ARGS__); \
H
Hongze Cheng 已提交
295
    }                                                                   \
L
Liu Jicong 已提交
296
  } while (0)
H
Hongze Cheng 已提交
297 298 299
#define qError(...)                                                     \
  do {                                                                  \
    if (qDebugFlag & DEBUG_ERROR) {                                     \
D
dapan1121 已提交
300
      taosPrintLog("QRY ERROR ", DEBUG_ERROR, qDebugFlag, __VA_ARGS__); \
H
Hongze Cheng 已提交
301
    }                                                                   \
L
Liu Jicong 已提交
302
  } while (0)
H
Hongze Cheng 已提交
303 304 305
#define qWarn(...)                                                    \
  do {                                                                \
    if (qDebugFlag & DEBUG_WARN) {                                    \
D
dapan1121 已提交
306
      taosPrintLog("QRY WARN ", DEBUG_WARN, qDebugFlag, __VA_ARGS__); \
H
Hongze Cheng 已提交
307
    }                                                                 \
L
Liu Jicong 已提交
308
  } while (0)
H
Hongze Cheng 已提交
309 310 311
#define qInfo(...)                                               \
  do {                                                           \
    if (qDebugFlag & DEBUG_INFO) {                               \
D
dapan1121 已提交
312
      taosPrintLog("QRY ", DEBUG_INFO, qDebugFlag, __VA_ARGS__); \
H
Hongze Cheng 已提交
313
    }                                                            \
L
Liu Jicong 已提交
314
  } while (0)
H
Hongze Cheng 已提交
315 316 317
#define qDebug(...)                                               \
  do {                                                            \
    if (qDebugFlag & DEBUG_DEBUG) {                               \
D
dapan1121 已提交
318
      taosPrintLog("QRY ", DEBUG_DEBUG, qDebugFlag, __VA_ARGS__); \
H
Hongze Cheng 已提交
319
    }                                                             \
L
Liu Jicong 已提交
320
  } while (0)
H
Hongze Cheng 已提交
321 322 323
#define qTrace(...)                                               \
  do {                                                            \
    if (qDebugFlag & DEBUG_TRACE) {                               \
D
dapan1121 已提交
324
      taosPrintLog("QRY ", DEBUG_TRACE, qDebugFlag, __VA_ARGS__); \
H
Hongze Cheng 已提交
325
    }                                                             \
L
Liu Jicong 已提交
326
  } while (0)
H
Hongze Cheng 已提交
327 328 329
#define qDebugL(...)                                                     \
  do {                                                                   \
    if (qDebugFlag & DEBUG_DEBUG) {                                      \
D
dapan1121 已提交
330
      taosPrintLongString("QRY ", DEBUG_DEBUG, qDebugFlag, __VA_ARGS__); \
H
Hongze Cheng 已提交
331
    }                                                                    \
L
Liu Jicong 已提交
332
  } while (0)
D
dapan1121 已提交
333

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
#define QRY_ERR_RET(c)                \
  do {                                \
    int32_t _code = c;                \
    if (_code != TSDB_CODE_SUCCESS) { \
      terrno = _code;                 \
      return _code;                   \
    }                                 \
  } while (0)
#define QRY_RET(c)                    \
  do {                                \
    int32_t _code = c;                \
    if (_code != TSDB_CODE_SUCCESS) { \
      terrno = _code;                 \
    }                                 \
    return _code;                     \
  } while (0)
#define QRY_ERR_JRET(c)              \
  do {                               \
    code = c;                        \
    if (code != TSDB_CODE_SUCCESS) { \
      terrno = code;                 \
      goto _return;                  \
    }                                \
  } while (0)
D
dapan1121 已提交
358

D
dapan1121 已提交
359 360 361 362
#ifdef __cplusplus
}
#endif

D
dapan1121 已提交
363
#endif /*_TD_QUERY_H_*/
dengyihao's avatar
dengyihao 已提交
364
       // clang-foramt on