/src/tdengine/include/common/tmsg.h

Source
/*
 * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
 *
 * SPDX-License-Identifier: AGPL-3.0-or-later
 *
 * 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/>.
 */

#ifndef _TD_COMMON_TAOS_MSG_H_
#define _TD_COMMON_TAOS_MSG_H_

#include <stdint.h>
#include "taosdef.h"
#include "taoserror.h"
#include "tarray.h"
#include "tcoding.h"
#include "tcol.h"
#include "tencode.h"
#include "thash.h"
#include "tlist.h"
#include "tname.h"
#include "tpriv.h"
#include "trow.h"
#include "tsimplehash.h"
#include "tuuid.h"

// Forward declaration  -  full definition in libs/nodes/nodes.h
typedef struct SNode SNode;

#ifdef __cplusplus
extern "C" {
#endif

/* ------------------------ MESSAGE DEFINITIONS ------------------------ */

#define TD_MSG_NUMBER_
#undef TD_MSG_DICT_
#undef TD_MSG_INFO_
#undef TD_MSG_TYPE_INFO_
#undef TD_MSG_RANGE_CODE_
#undef TD_MSG_SEG_CODE_
#include "tmsgdef.h"

#undef TD_MSG_NUMBER_
#undef TD_MSG_DICT_
#undef TD_MSG_INFO_
#undef TD_MSG_TYPE_INFO_
#undef TD_MSG_RANGE_CODE_
#define TD_MSG_SEG_CODE_
#include "tmsgdef.h"

#undef TD_MSG_NUMBER_
#undef TD_MSG_DICT_
#undef TD_MSG_INFO_
#undef TD_MSG_TYPE_INFO_
#undef TD_MSG_SEG_CODE_
#undef TD_MSG_RANGE_CODE_
#include "tmsgdef.h"

extern char*   tMsgInfo[];
extern int32_t tMsgDict[];
extern int32_t tMsgRangeDict[];

typedef uint16_t tmsg_t;

#define TMSG_SEG_CODE(TYPE) (((TYPE) & 0xff00) >> 8)
#define TMSG_SEG_SEQ(TYPE)  ((TYPE) & 0xff)
#define TMSG_INDEX(TYPE)    (tMsgDict[TMSG_SEG_CODE(TYPE)] + TMSG_SEG_SEQ(TYPE))

#define DECODESQL()                                                              \
  do {                                                                           \
    if (!tDecodeIsEnd(&decoder)) {                                               \
      TAOS_CHECK_EXIT(tDecodeI32(&decoder, &pReq->sqlLen));                      \
      if (pReq->sqlLen > 0) {                                                    \
        TAOS_CHECK_EXIT(tDecodeBinaryAlloc(&decoder, (void**)&pReq->sql, NULL)); \
      }                                                                          \
    }                                                                            \
  } while (0)

#define ENCODESQL()                                                                      \
  do {                                                                                   \
    TAOS_CHECK_EXIT(tEncodeI32(&encoder, pReq->sqlLen));                                 \
    if (pReq->sqlLen > 0) {                                                              \
      TAOS_CHECK_EXIT(tEncodeBinary(&encoder, (const uint8_t*)pReq->sql, pReq->sqlLen)); \
    }                                                                                    \
  } while (0)

#define FREESQL()                \
  do {                           \
    if (pReq->sql != NULL) {     \
      taosMemoryFree(pReq->sql); \
    }                            \
    pReq->sql = NULL;            \
  } while (0)

static inline bool tmsgIsValid(tmsg_t type) {
  // static int8_t sz = sizeof(tMsgRangeDict) / sizeof(tMsgRangeDict[0]);
  int8_t maxSegIdx = TMSG_SEG_CODE(TDMT_MAX_MSG_MIN);
  int    segIdx = TMSG_SEG_CODE(type);
  if (segIdx >= 0 && segIdx < maxSegIdx) {
    return type < tMsgRangeDict[segIdx];
  }
  return false;
}

#define TMSG_INFO(type) (tmsgIsValid(type) ? tMsgInfo[TMSG_INDEX(type)] : "unKnown")

static inline bool vnodeIsMsgBlock(tmsg_t type) {
  return (type == TDMT_VND_CREATE_TABLE) || (type == TDMT_VND_ALTER_TABLE) || (type == TDMT_VND_DROP_TABLE) ||
         (type == TDMT_VND_UPDATE_TAG_VAL) || (type == TDMT_VND_ALTER_CONFIRM) || (type == TDMT_VND_COMMIT) ||
         (type == TDMT_SYNC_CONFIG_CHANGE) || (type == TDMT_VND_SYNC_COMMIT);
}

static inline bool syncUtilUserCommit(tmsg_t msgType) {
  return msgType != TDMT_SYNC_NOOP && msgType != TDMT_SYNC_LEADER_TRANSFER;
}

/* ------------------------ OTHER DEFINITIONS ------------------------ */
// IE type
#define TSDB_IE_TYPE_SEC         1
#define TSDB_IE_TYPE_META        2
#define TSDB_IE_TYPE_MGMT_IP     3
#define TSDB_IE_TYPE_DNODE_CFG   4
#define TSDB_IE_TYPE_NEW_VERSION 5
#define TSDB_IE_TYPE_DNODE_EXT   6
#define TSDB_IE_TYPE_DNODE_STATE 7

enum {
  CONN_TYPE__QUERY = 1,
  CONN_TYPE__TMQ,
  CONN_TYPE__UDFD,
  CONN_TYPE__AUTH_TEST, // only for test authentication
  CONN_TYPE__MAX,
};

enum {
  HEARTBEAT_KEY_USER_AUTHINFO = 1,
  HEARTBEAT_KEY_DBINFO,
  HEARTBEAT_KEY_STBINFO,
  HEARTBEAT_KEY_TMQ,
  HEARTBEAT_KEY_DYN_VIEW,
  HEARTBEAT_KEY_VIEWINFO,
  HEARTBEAT_KEY_TSMA,
  HEARTBEAT_KEY_TXN_KEEPALIVE,
  HEARTBEAT_KEY_TXN_KILLED,  // MNode  ->  client: txn was forcibly rolled back due to inactivity timeout
  HEARTBEAT_KEY_EXTSOURCE,  // federated query: external source change notifications
};

typedef enum _mgmt_table {
  TSDB_MGMT_TABLE_START,
  TSDB_MGMT_TABLE_DNODE,
  TSDB_MGMT_TABLE_MNODE,
  TSDB_MGMT_TABLE_MODULE,
  TSDB_MGMT_TABLE_QNODE,
  TSDB_MGMT_TABLE_SNODE,
  TSDB_MGMT_TABLE_BACKUP_NODE,  // no longer used
  TSDB_MGMT_TABLE_CLUSTER,
  TSDB_MGMT_TABLE_DB,
  TSDB_MGMT_TABLE_FUNC,
  TSDB_MGMT_TABLE_INDEX,
  TSDB_MGMT_TABLE_STB,
  TSDB_MGMT_TABLE_STREAMS,
  TSDB_MGMT_TABLE_TABLE,
  TSDB_MGMT_TABLE_TAG,
  TSDB_MGMT_TABLE_COL,
  TSDB_MGMT_TABLE_USER,
  TSDB_MGMT_TABLE_GRANTS,
  TSDB_MGMT_TABLE_VGROUP,
  TSDB_MGMT_TABLE_TOPICS,
  TSDB_MGMT_TABLE_CONSUMERS,
  TSDB_MGMT_TABLE_SUBSCRIPTIONS,
  TSDB_MGMT_TABLE_TRANS,
  TSDB_MGMT_TABLE_SMAS,
  TSDB_MGMT_TABLE_CONFIGS,
  TSDB_MGMT_TABLE_CONNS,
  TSDB_MGMT_TABLE_QUERIES,
  TSDB_MGMT_TABLE_VNODES,
  TSDB_MGMT_TABLE_APPS,
  TSDB_MGMT_TABLE_STREAM_TASKS,
  TSDB_MGMT_TABLE_STREAM_RECALCULATES,
  TSDB_MGMT_TABLE_PRIVILEGES,
  TSDB_MGMT_TABLE_VIEWS,
  TSDB_MGMT_TABLE_TSMAS,
  TSDB_MGMT_TABLE_COMPACT,
  TSDB_MGMT_TABLE_COMPACT_DETAIL,
  TSDB_MGMT_TABLE_GRANTS_FULL,
  TSDB_MGMT_TABLE_GRANTS_LOGS,
  TSDB_MGMT_TABLE_MACHINES,
  TSDB_MGMT_TABLE_ARBGROUP,
  TSDB_MGMT_TABLE_ENCRYPTIONS,
  TSDB_MGMT_TABLE_USER_FULL,
  TSDB_MGMT_TABLE_ANODE,
  TSDB_MGMT_TABLE_ANODE_FULL,
  TSDB_MGMT_TABLE_USAGE,
  TSDB_MGMT_TABLE_FILESETS,
  TSDB_MGMT_TABLE_TRANSACTION_DETAIL,
  TSDB_MGMT_TABLE_SNAP_SEND_VNODES,
  TSDB_MGMT_TABLE_SNAP_SEND_FILESETS,
  TSDB_MGMT_TABLE_VC_COL,
  TSDB_MGMT_TABLE_BNODE,
  TSDB_MGMT_TABLE_MOUNT,
  TSDB_MGMT_TABLE_SSMIGRATE,
  TSDB_MGMT_TABLE_SCAN,
  TSDB_MGMT_TABLE_SCAN_DETAIL,
  TSDB_MGMT_TABLE_RSMA,
  TSDB_MGMT_TABLE_RETENTION,
  TSDB_MGMT_TABLE_RETENTION_DETAIL,
  TSDB_MGMT_TABLE_INSTANCE,
  TSDB_MGMT_TABLE_ENCRYPT_ALGORITHMS,
  TSDB_MGMT_TABLE_TOKEN,
  TSDB_MGMT_TABLE_ENCRYPT_STATUS,
  TSDB_MGMT_TABLE_ROLE,
  TSDB_MGMT_TABLE_ROLE_PRIVILEGES,
  TSDB_MGMT_TABLE_ROLE_COL_PRIVILEGES,
  TSDB_MGMT_TABLE_XNODES,
  TSDB_MGMT_TABLE_XNODE_TASKS,
  TSDB_MGMT_TABLE_XNODE_AGENTS,
  TSDB_MGMT_TABLE_XNODE_JOBS,
  TSDB_MGMT_TABLE_XNODE_FULL,
  TSDB_MGMT_TABLE_VIRTUAL_TABLES_REFERENCING,
  TSDB_MGMT_TABLE_SECURITY_POLICIES,
  TSDB_MGMT_TABLE_EXT_SOURCES,
  TSDB_MGMT_TABLE_TXN_LOG,
  TSDB_MGMT_TABLE_TXN_ORPHANS,
  TSDB_MGMT_TABLE_VSTABLE_INHERITS,
  TSDB_MGMT_TABLE_BACKUP,
  TSDB_MGMT_TABLE_MAX,
} EShowType;

typedef enum EExtSourceType {
  EXT_SOURCE_MYSQL      = 0,
  EXT_SOURCE_POSTGRESQL = 1,
  EXT_SOURCE_INFLUXDB   = 2,
  EXT_SOURCE_TDENGINE   = 3,  // reserved, not delivered in Phase 1
  EXT_SOURCE_SQLSERVER  = 4,  // Microsoft SQL Server (ODBC); appended, never reorder/reuse
} EExtSourceType;

// Federated pushdown demotion granularity.
typedef enum EExtCapDemoteKind {
  EXT_DEMOTE_KIND_NONE = 0,
  EXT_DEMOTE_KIND_FUNC,
  EXT_DEMOTE_KIND_OP,
  EXT_DEMOTE_KIND_CLAUSE,
  EXT_DEMOTE_KIND_TYPE,
} EExtCapDemoteKind;

typedef enum EExtDemoteReason {
  // Precise reasons (catalog-level demotion candidates)
  EXT_DEMOTE_REASON_REMOTE_FUNC_MISS      = 1,
  EXT_DEMOTE_REASON_REMOTE_SYNTAX_PRECISE = 2,
  EXT_DEMOTE_REASON_REMOTE_TYPE_MISMATCH  = 3,

  // Vague reasons (session overlay only)
  EXT_DEMOTE_REASON_REMOTE_SYNTAX_VAGUE = 10,
  EXT_DEMOTE_REASON_REMOTE_TIMEOUT,
  EXT_DEMOTE_REASON_REMOTE_INTERNAL,
  EXT_DEMOTE_REASON_REMOTE_NETWORK,
  EXT_DEMOTE_REASON_REMOTE_UNKNOWN,

  EXT_DEMOTE_REASON_RETRY_ESCALATION = 20,
  EXT_DEMOTE_REASON_DIALECT_BASELINE = 30,
  EXT_DEMOTE_REASON_USER_FORCED      = 40,
} EExtDemoteReason;

#define EXT_REASON_IS_PRECISE(reasonCode) ((reasonCode) >= 1 && (reasonCode) <= 9)

typedef enum EExtClauseKind {
  // -- GATE ------------------------------------------------------------------
  // These 6 values participate in the full 3-level pushdown fallback:
  //   * classifiable from remote error responses (via extResolveFuncClause /
  //     extResolveOpClause escalation or explicit clause=N token in errors)
  //   * support dynamic disable at runtime (catalog-level or session overlay)
  //   * planner gates on each: a disabled GATE prevents pushdown of queries
  //     that exercise that capability
  //   * extCapShouldUseBaseline() checks all 6: if every GATE is disabled
  //     the system falls back to TDengine-local execution (baseline mode)
  EXT_CLAUSE_FILTER = 0,      // WHERE predicates (comparisons, LIKE, MATCH, ...)
  EXT_CLAUSE_PROJECTION,      // SELECT expressions (scalar functions, casts, ...)
  EXT_CLAUSE_AGG,             // GROUP BY / aggregate functions
  EXT_CLAUSE_ORDER,           // ORDER BY
  EXT_CLAUSE_LIMIT,           // LIMIT / FETCH FIRST
  EXT_CLAUSE_JOIN,            // any join (coarse gate; covers all join subtypes)

  // -- STATIC ----------------------------------------------------------------
  // These values are set only via dialect defaults (extLoadDialectDefaults)
  // or explicit manual SQL (ALTER EXTERNAL SOURCE ... DISABLE CLAUSE ...).
  // They are NOT produced by error classification and do NOT trigger the
  // pushdown fallback machinery.  They serve as fine-grained capability
  // markers for display (SHOW EXTERNAL SOURCES) and for dialect-specific
  // default configurations.
  EXT_CLAUSE_GROUP_ROLLUP,        // GROUP BY ROLLUP (dialect default)
  EXT_CLAUSE_HAVING,              // HAVING clause (fine-grained AGG subtype)
  EXT_CLAUSE_ORDER_NULLS_FIRST,   // NULLS FIRST ordering (MySQL default: disabled)
  EXT_CLAUSE_ORDER_NULLS_LAST,    // NULLS LAST ordering  (MySQL default: disabled)
  EXT_CLAUSE_OFFSET,              // OFFSET keyword
  EXT_CLAUSE_DISTINCT,            // SELECT DISTINCT
  // JOIN subtypes - dialect defaults only; disabling any subtype must also
  // explicitly disable the parent EXT_CLAUSE_JOIN gate in the defaults table.
  EXT_CLAUSE_INNER_JOIN,
  EXT_CLAUSE_LEFT_JOIN,
  EXT_CLAUSE_RIGHT_JOIN,
  EXT_CLAUSE_FULL_OUTER_JOIN,
  EXT_CLAUSE_SEMI_JOIN,
  EXT_CLAUSE_ANTI_JOIN,
  EXT_CLAUSE_FROM_SUBQUERY,       // subquery in FROM (common default: disabled)
  EXT_CLAUSE_SCALAR_SUBQUERY,     // scalar subquery in SELECT (common default: disabled)
  EXT_CLAUSE_INTERVAL_TUMBLING,   // TDengine INTERVAL(...) tumbling window
  EXT_CLAUSE_INTERVAL_SLIDING,    // TDengine INTERVAL(...) SLIDING window
  EXT_CLAUSE_PARTITION_TBNAME,    // PARTITION BY tbname
  EXT_CLAUSE_PARTITION_COLUMN,    // PARTITION BY <column>
  // SQL feature flags - set in common/dialect defaults; no error-based demote.
  EXT_CLAUSE_FEAT_CTE,            // WITH (common table expressions; common default: disabled)
  EXT_CLAUSE_FEAT_WINDOW_FUNCTIONS, // window functions (common default: disabled)
  EXT_CLAUSE_FEAT_LARGE_IN_LIST,  // remote handles large IN (v1,...,vN) lists (common default: disabled)
  // Subquery expression types - dialect defaults only.
  // EXISTS/NOT EXISTS are tracked at the operator layer (disabledOps).
  EXT_CLAUSE_IN_SUBQUERY,         // IN/NOT IN (subquery) - InfluxDB default: disabled
  EXT_CLAUSE_ALL_ANY_SUBQUERY,    // ALL/ANY/SOME subquery - InfluxDB default: disabled
  // Additional JOIN subtypes - always local for all current dialects.
  // Disabling these does not require disabling the parent EXT_CLAUSE_JOIN gate
  // because they are never pushed down regardless.
  EXT_CLAUSE_ASOF_JOIN,           // ASOF Join - always local (common default: disabled)
  EXT_CLAUSE_WINDOW_JOIN,         // Window Join - always local (common default: disabled)
  // TDengine-specific window types - always local for all current dialects.
  // (INTERVAL tumbling/sliding are above; state/session/event/count are below.)
  EXT_CLAUSE_STATE_WINDOW,        // STATE_WINDOW - always local (common default: disabled)
  EXT_CLAUSE_SESSION_WINDOW,      // SESSION - always local (common default: disabled)
  EXT_CLAUSE_EVENT_WINDOW,        // EVENT_WINDOW - always local (common default: disabled)
  EXT_CLAUSE_COUNT_WINDOW,        // COUNT_WINDOW - always local (common default: disabled)
  // TDengine-specific sub-clauses - always local for all current dialects.
  EXT_CLAUSE_FILL,                // FILL clause (window fill) - always local (common default: disabled)
  EXT_CLAUSE_INTERP,              // INTERP + RANGE/EVERY - always local (common default: disabled)
  EXT_CLAUSE_SLIMIT,              // SLIMIT/SOFFSET (per-partition limit) - always local (common default: disabled)
  EXT_CLAUSE_EXISTS_SUBQUERY,     // EXISTS/NOT EXISTS (subquery) - InfluxDB default: disabled

  EXT_CLAUSE_MAX,
} EExtClauseKind;

// FQ subquery render mode (v2 two-state pushdown model).  Decided in the
// collect phase, carried on each REMOTE_* node, consumed by nodesRemotePlanToSQL.
//   FQ_SUBQ_RENDER_DIRECT_SQL   - clause directly pushable AND inner SELECT needs
//                                 no transform: inline the user's original SQL.
//   FQ_SUBQ_RENDER_ORIG_TYPE_2B - keep the original predicate form (IN/ALL/ANY/
//                                 EXISTS) but render the inner SELECT with dialect
//                                 transforms (function mapping, federated-name ->
//                                 schema/db/remoteTableName translation).
typedef enum EFqSubqRenderMode {
  FQ_SUBQ_RENDER_DIRECT_SQL = 0,
  FQ_SUBQ_RENDER_ORIG_TYPE_2B,
} EFqSubqRenderMode;

typedef struct SExtCapDisabledEntry {
  uint8_t  reasonCode;
  uint16_t hitCount;
  int64_t  firstHitMs;
} SExtCapDisabledEntry;

typedef struct SExtCapDemoteSpec {
  EExtCapDemoteKind kind;
  union {
    char           funcName[TSDB_FUNC_NAME_LEN];
    EOperatorType  opType;
    EExtClauseKind clauseKind;
    int8_t         tsdbTypeCode;
  } detail;
  uint8_t reasonCode;
} SExtCapDemoteSpec;

typedef struct SExtPushdownDiagnostic {
  int32_t          classifiedCode;
  EExtDemoteReason reasonCode;
  EExtCapDemoteKind suggestedDemoteKind;
  union {
    char           funcName[TSDB_FUNC_NAME_LEN];
    EOperatorType  opType;
    EExtClauseKind clauseKind;
    int8_t         tsdbTypeCode;
  } detail;
  char     remoteSqlState[8];
  int32_t  remoteCode;
  int32_t  httpStatus;
  char     remoteMessage[512];
  char     generatedSql[2048];
} SExtPushdownDiagnostic;

#define EXT_MAX_PUSHDOWN_ATTEMPTS 3

// Length constants for external source connection fields.
// External source names follow the same rules as database names (globally unique, must not
// conflict with local DB names), so the name length is capped at TSDB_DB_NAME_LEN (64 + NUL).
#define TSDB_EXT_SOURCE_NAME_LEN         TSDB_DB_NAME_LEN  // max external source name length (64 chars + NUL)
#define TSDB_EXT_SOURCE_HOST_LEN         257    // max hostname/IP length (256 chars + NUL)
// External DB usernames can be longer than TDengine usernames (TSDB_USER_LEN=24).
// MySQL max=32, PostgreSQL max=63; we use 128 for future-proofing.
#define TSDB_EXT_SOURCE_USER_LEN         129    // max external source username (128 chars + NUL)
// External DB passwords are stored as plaintext on the wire then AES-encrypted at rest.
// AES-CBC PKCS7: for 128-char plaintext, taes_encrypt_len(128)=144 (extra PKCS7 block).
#define TSDB_EXT_SOURCE_PASSWORD_LEN     129    // max plaintext password (128 chars + NUL, transport only)
#define TSDB_EXT_SOURCE_ENC_PASSWORD_LEN 144    // AES-CBC-encrypted password storage size
// External DB names (database/schema): MySQL max=64, PG max=63; TSDB_DB_NAME_LEN=65 is sufficient.
#define TSDB_EXT_SOURCE_DATABASE_LEN     TSDB_DB_NAME_LEN   // max default database name (64 chars + NUL)
#define TSDB_EXT_SOURCE_SCHEMA_LEN       TSDB_DB_NAME_LEN   // max default schema name (64 chars + NUL)
// OPTIONS key names (e.g. "tls_enabled", "api_token"): reuse column-name length (64 chars).
#define TSDB_EXT_SOURCE_OPTION_KEY_LEN   TSDB_COL_NAME_LEN  // max option key length (64 chars + NUL)
// Full OPTIONS JSON storage budget (includes keys + values + JSON syntax chars).
#define TSDB_EXT_SOURCE_OPTIONS_LEN      8192
// A single option value budget (value length boundary remains 4095 chars).
#define TSDB_EXT_SOURCE_OPTION_VALUE_LEN 4096

// SExtSourceCapability  -  push-down ability flags for an external source.
// Defined here (tmsg.h) so that SExtSourceInfo below and extConnector.h both
// share the same declaration without a circular-include.
typedef struct SExtSourceCapability {
  SHashObj* disabledFuncs;    // key: lowercase function name
  SHashObj* disabledOps;      // key: EOperatorType
  SHashObj* disabledTypes;    // key: int8_t (TSDB_DATA_TYPE_*)
  SHashObj* disabledClauses;  // key: EExtClauseKind
  int32_t   dialect;
  int64_t   loadedAtMs;
} SExtSourceCapability;

typedef struct SExtCapSessionOverlay {
  SHashObj* disabledFuncs;
  SHashObj* disabledOps;
  SHashObj* disabledTypes;
  SHashObj* disabledClauses;
  int32_t   attemptCount;
  EExtCapDemoteKind lastDemoteKind;
  union {
    char           funcName[TSDB_FUNC_NAME_LEN];
    EOperatorType  opType;
    EExtClauseKind clauseKind;
    int8_t         tsdbTypeCode;
  } lastDemoteDetail;
  uint8_t   repeatFailCount;
} SExtCapSessionOverlay;

int32_t extCapInit(SExtSourceCapability* pCap);
void    extCapDestroy(SExtSourceCapability* pCap);
int32_t extCapClone(const SExtSourceCapability* pSrc, SExtSourceCapability* pDst);

int32_t extCapSessionOverlayInit(SExtCapSessionOverlay* pOverlay);
void    extCapSessionOverlayDestroy(SExtCapSessionOverlay* pOverlay);
int32_t extCapSessionOverlayClone(const SExtCapSessionOverlay* pSrc, SExtCapSessionOverlay* pDst);

bool    capDisabled(const SExtSourceCapability* pCap, const SExtCapSessionOverlay* pOverlay,
                    EExtCapDemoteKind kind, const void* pKey);
int32_t extCapDemoteApply(SExtSourceCapability* pCap, const SExtCapDemoteSpec* pSpec);
int32_t extCapOverlayDemote(SExtCapSessionOverlay* pOverlay, const SExtCapDemoteSpec* pSpec);
bool    extCapOverlayTryEscalateOnRepeat(SExtCapSessionOverlay* pOverlay, const SExtCapDemoteSpec* pCurrent,
                                         SExtCapDemoteSpec* pEscalated);
void    extCapOverlayMarkAllCoarse(SExtCapSessionOverlay* pOverlay, uint8_t reasonCode);
bool    extCapShouldUseBaseline(const SExtSourceCapability* pCap, const SExtCapSessionOverlay* pOverlay);

EExtClauseKind extResolveFuncClause(const char* funcName);
EExtClauseKind extResolveOpClause(EOperatorType opType);
bool           extClauseIsGate(EExtClauseKind kind);

int32_t tEncodeSExtPushdownDiagnostic(SEncoder* pEncoder, const SExtPushdownDiagnostic* pDiag);
int32_t tDecodeSExtPushdownDiagnostic(SDecoder* pDecoder, SExtPushdownDiagnostic* pDiag);
// EExtSQLDialect - SQL dialect selector for remote SQL generation.
// Defined here (alongside EExtSourceType) so that nodes/plannodes.h can reference
// it without including extConnector.h, breaking the nodes  ->  extconnector dependency.
typedef enum EExtSQLDialect {
  EXT_SQL_DIALECT_MYSQL     = 0,
  EXT_SQL_DIALECT_POSTGRES  = 1,
  EXT_SQL_DIALECT_INFLUXQL  = 2,
  EXT_SQL_DIALECT_SQLSERVER = 3,  // appended, never reorder/reuse
} EExtSQLDialect;

// Declared width (in characters) used for InfluxDB tag columns, both when the
// ext reader fetches tag values at runtime (streamReaderExt.c's
// extInitInfluxTagPartition / fetchDataBatchInflux column-type mappings) and
// when the stream parser auto-derives an output TAG from a PARTITION BY tag
// column (parTranslater.c's createStreamReqSetDefaultTag).  Keeping both sides
// on this single constant prevents them drifting apart  -  InfluxDB tags have no
// declared TDengine-side width, so the two call sites must agree on one.
#define EXT_INFLUX_TAG_NCHAR_CHARS (257 * TSDB_NCHAR_SIZE + VARSTR_HEADER_SIZE)
#define EXT_INFLUX_KEY_NCHAR_CHARS ((TSDB_COL_NAME_LEN - 1) * TSDB_NCHAR_SIZE)
#define EXT_INFLUX_KEY_NCHAR_CHARS_TOO_LONG (TSDB_COL_NAME_LEN * TSDB_NCHAR_SIZE)

// -- FQ push-down capability bitmap ------------------------------------------
// uint16_t bitmap encoding:
//   bits [2:0]  - default capability per dialect (0 = not pushable)
//   bits [5:3]  - session-level override (1 = force-disable for that dialect)
//
// fqPushCap bitmap layout (uint16_t):
//
//   Low byte  (bits 0-7)  - static/global capability defaults
//   High byte (bits 8-15) - session-level overrides (set to force-disable)
//
//   The high byte mirrors the low byte: each bit in the high byte disables the
//   corresponding bit position in the low byte at session level.
//
//   Low-byte layout:
//     bits 0-2 : main capability    (MySQL=bit0, PG=bit1, Influx=bit2)
//     bits 3-5 : sub-cap 1: CAST(timestamp -> integer)
//     bit  6   : main capability - SQL Server (appended; see the note below)
//     bit  7   : reserved for future sub-capabilities
//
//   High-byte layout (FQ_CAP_SESSION_SHIFT = 8):
//     bits 8-10 : session override for main capability
//     bits 11-13: session override for CAST(ts->int) sub-capability
//     bit  14   : session override for SQL Server
//     bit  15   : reserved
//
//   SQL Server placement note: the 4th main-capability bit sits at bit 6, not at
//   bit 3, because bits 3-5 form the shift-derived CAST(ts->int) band shared by
//   the first three dialects; `fqDialectBit(SQLSERVER) << FQ_CAP_CAST_TS_INT_SHIFT`
//   (bit 9) would collide with the PG session-override bit.  SQL Server therefore
//   does NOT take part in the shift-derived sub-capability band: code that derives
//   a sub-capability bit must special-case it (SQL Server has no such sub-capability
//   today; return FQ_CAP_NONE).

// Main capability bits (low byte, bits 0-2):
#define FQ_CAP_MYSQL   ((uint16_t)(1u << 0))   // MySQL / MariaDB
#define FQ_CAP_PG      ((uint16_t)(1u << 1))   // PostgreSQL
#define FQ_CAP_INFLUX  ((uint16_t)(1u << 2))   // InfluxDB v3 (DataFusion)
#define FQ_CAP_SQLSERVER ((uint16_t)(1u << 6)) // SQL Server (ODBC); appended, see layout note
#define FQ_CAP_ALL     ((uint16_t)(FQ_CAP_MYSQL | FQ_CAP_PG | FQ_CAP_INFLUX))

// Session-override band: high byte (shift = 8).
// Set a bit here to force-disable the corresponding dialect at session level.
#define FQ_CAP_SESSION_SHIFT      8
#define FQ_CAP_SESSION_MYSQL      ((uint16_t)(FQ_CAP_MYSQL  << FQ_CAP_SESSION_SHIFT))
#define FQ_CAP_SESSION_PG         ((uint16_t)(FQ_CAP_PG     << FQ_CAP_SESSION_SHIFT))
#define FQ_CAP_SESSION_INFLUX     ((uint16_t)(FQ_CAP_INFLUX << FQ_CAP_SESSION_SHIFT))
#define FQ_CAP_SESSION_SQLSERVER  ((uint16_t)(FQ_CAP_SQLSERVER << FQ_CAP_SESSION_SHIFT))

// Convenience: the dialect combinations used in the capability tables
#define FQ_CAP_PG_INFLUX   ((uint16_t)(FQ_CAP_PG | FQ_CAP_INFLUX))
#define FQ_CAP_MYSQL_PG    ((uint16_t)(FQ_CAP_MYSQL | FQ_CAP_PG))
#define FQ_CAP_NONE        ((uint16_t)0)

// Sub-capability 1: CAST(timestamp AS integer/bigint/uint/ubigint)
//   default band   : bits 3-5  (FQ_CAP_CAST_TS_INT_SHIFT = 3)
//   session band   : bits 11-13 (= FQ_CAP_CAST_TS_INT_SHIFT + FQ_CAP_SESSION_SHIFT = 3+8)
//
// Only PostgreSQL supports CAST(timestamp -> integer) natively.
//   MySQL   : binary protocol returns MYSQL_TIME for TIMESTAMP; connector cannot safely
//             reinterpret that as an integer epoch, so local conversion is required.
//   InfluxDB: DataFusion does not support CAST(timestamp AS BIGINT).
#define FQ_CAP_CAST_TS_INT_SHIFT  3
#define FQ_CAP_CAST_TS_INT_PG     ((uint16_t)(FQ_CAP_PG << FQ_CAP_CAST_TS_INT_SHIFT))
// Session-level overrides for the CAST(ts->int) sub-capability:
#define FQ_CAP_CAST_TS_INT_SESSION_MYSQL   ((uint16_t)(FQ_CAP_MYSQL  << (FQ_CAP_CAST_TS_INT_SHIFT + FQ_CAP_SESSION_SHIFT)))
#define FQ_CAP_CAST_TS_INT_SESSION_PG      ((uint16_t)(FQ_CAP_PG     << (FQ_CAP_CAST_TS_INT_SHIFT + FQ_CAP_SESSION_SHIFT)))
#define FQ_CAP_CAST_TS_INT_SESSION_INFLUX  ((uint16_t)(FQ_CAP_INFLUX << (FQ_CAP_CAST_TS_INT_SHIFT + FQ_CAP_SESSION_SHIFT)))

// Convert EExtSQLDialect to the corresponding FQ_CAP_* default bit.
// Returns 0 for unknown dialects.
static inline uint16_t fqDialectBit(int32_t dialect) {
  switch ((EExtSQLDialect)dialect) {
    case EXT_SQL_DIALECT_MYSQL:    return FQ_CAP_MYSQL;
    case EXT_SQL_DIALECT_POSTGRES: return FQ_CAP_PG;
    case EXT_SQL_DIALECT_INFLUXQL: return FQ_CAP_INFLUX;
    case EXT_SQL_DIALECT_SQLSERVER: return FQ_CAP_SQLSERVER;
    default:                       return 0;
  }
}

// Query whether a function (by funcId), operator (by EOperatorType), or
// clause (by EExtClauseKind) is pushable for the given dialect, taking
// session-level overrides into account.
//
// fqFuncCapBitmap  - returns the uint16_t bitmap; FQ_CAP_NONE for UDFs/unknown.
// fqFuncArg0NcharCapBitmap - returns the arg0==NCHAR-specific bitmap when
// configured, otherwise inherits fqFuncCapBitmap(funcId).
// fqOpCapBitmap    - lookup in gFqOpCap[]; FQ_CAP_NONE for unmapped ops.
// fqClauseCapBitmap - lookup in gFqClauseCap[]; FQ_CAP_NONE for unknown kinds.
uint16_t fqFuncCapBitmap(int32_t funcId);
uint16_t fqFuncArg0NcharCapBitmap(int32_t funcId);
uint16_t fqOpCapBitmap(EOperatorType opType);
uint16_t fqClauseCapBitmap(EExtClauseKind clauseKind);
// Transform-pushdown capability bitmap for a subquery clause.
// Current DS/product semantics do not ship transform-only subquery pushdown;
// all entries are reserved and default to unsupported.
uint16_t fqClauseTransformCapBitmap(EExtClauseKind clauseKind);

// High-level pushability check: combines the static bitmap with any active
// session-level override (pOverlay may be NULL).
bool fqFuncIsPushable(int32_t funcId, int32_t dialect,
                      const SExtCapSessionOverlay* pOverlay);
bool fqFuncArg0NcharIsPushable(int32_t funcId, int32_t dialect,
                               const SExtCapSessionOverlay* pOverlay);
bool fqOpIsPushable(EOperatorType opType, int32_t dialect,
                    const SExtCapSessionOverlay* pOverlay);
bool fqClauseIsPushable(EExtClauseKind clauseKind, int32_t dialect,
                        const SExtCapSessionOverlay* pOverlay);
// Whether the dialect supports transform-pushdown of this clause.
// Current implementation returns false for all shipped subquery clauses.
bool fqClauseTransformIsPushable(EExtClauseKind clauseKind, int32_t dialect,
                                 const SExtCapSessionOverlay* pOverlay);

// Sub-capability check: tests a specific sub-capability band within a function's
// fqPushCap bitmap.  subCapShift is the bit offset of the sub-capability's default
// band in the low byte (e.g. FQ_CAP_CAST_TS_INT_SHIFT = 3).  The session-override
// band for the same sub-capability sits at (subCapShift + FQ_CAP_SESSION_SHIFT),
// i.e. in the high byte at the same relative position.
//
// Returns true only when the default bit for `dialect` is set in the sub-cap band
// AND the session-override bit is NOT set.
bool fqFuncSubCapIsPushable(int32_t funcId, int32_t subCapShift, int32_t dialect,
                             const SExtCapSessionOverlay* pOverlay);
// SExtColumnDef / SExtTableMeta - external table metadata types.
// Defined here so that nodes/querynodes.h and nodes source files can use them
// without depending on extConnector.h, which would create a nodes  ->  extconnector
// build dependency.
typedef struct SExtColumnDef {
  char colName[TSDB_COL_NAME_LEN];        // connector-normalized column name
  char extTypeName[64];                   // original type name from the external source
  // Charset / encoding for string columns:
  //   MySQL: CHARACTER_SET_NAME from INFORMATION_SCHEMA.COLUMNS (e.g. "utf8mb4").
  //   PG:    server_encoding (e.g. "UTF8"). InfluxDB: empty (always UTF-8).
  char extCharsetName[32];
  bool nullable;
  bool isTag;          // InfluxDB only
  bool isPrimaryKey;   // true if this column maps to the TDengine primary key (timestamp)
  bool isRemotePrimaryKey;  // original remote primary-key column
} SExtColumnDef;

typedef struct SExtTableMeta {
  SExtColumnDef *pCols;
  int32_t        numOfCols;
  int8_t         tableType;
  int8_t         tsPrecision;  // source-level timestamp precision for the primary-key column
                               // (TSDB_TIME_PRECISION_MILLI/MICRO/NANO); 0 = unknown/not set
  SName          name;                              // dbname + tname
  char           sourceName[TSDB_EXT_SOURCE_NAME_LEN];
  char           schemaName[TSDB_EXT_SOURCE_SCHEMA_LEN];
  int64_t        fetched_at;                        // monotonic time of cache fill
  char           remoteTableName[TSDB_TABLE_NAME_LEN]; // actual table name on remote (preserves case)
} SExtTableMeta;

typedef enum {
  TSDB_OPTR_NORMAL = 0,  // default
  TSDB_OPTR_SSMIGRATE = 1,
  TSDB_OPTR_ROLLUP = 2,
} ETsdbOpType;

typedef enum {
  TSDB_TRIGGER_MANUAL = 0,  // default
  TSDB_TRIGGER_AUTO = 1,
} ETriggerType;

#define TSDB_ALTER_TABLE_ADD_TAG                         1
#define TSDB_ALTER_TABLE_DROP_TAG                        2
#define TSDB_ALTER_TABLE_UPDATE_TAG_NAME                 3
#define TSDB_ALTER_TABLE_UPDATE_TAG_VAL                  4 // deprecated, kept for wire compatibility
#define TSDB_ALTER_TABLE_ADD_COLUMN                      5
#define TSDB_ALTER_TABLE_DROP_COLUMN                     6
#define TSDB_ALTER_TABLE_UPDATE_COLUMN_BYTES             7
#define TSDB_ALTER_TABLE_UPDATE_TAG_BYTES                8
#define TSDB_ALTER_TABLE_UPDATE_OPTIONS                  9
#define TSDB_ALTER_TABLE_UPDATE_COLUMN_NAME              10
#define TSDB_ALTER_TABLE_ADD_TAG_INDEX                   11
#define TSDB_ALTER_TABLE_DROP_TAG_INDEX                  12
#define TSDB_ALTER_TABLE_UPDATE_COLUMN_COMPRESS          13
#define TSDB_ALTER_TABLE_ADD_COLUMN_WITH_COMPRESS_OPTION 14
#define TSDB_ALTER_TABLE_UPDATE_MULTI_TAG_VAL            15 // deprecated, kept for wire compatibility
#define TSDB_ALTER_TABLE_ALTER_COLUMN_REF                16
#define TSDB_ALTER_TABLE_REMOVE_COLUMN_REF               17
#define TSDB_ALTER_TABLE_ADD_COLUMN_WITH_COLUMN_REF      18
#define TSDB_ALTER_TABLE_UPDATE_MULTI_TABLE_TAG_VAL      19 // alter multiple tag values of multi tables
#define TSDB_ALTER_TABLE_UPDATE_CHILD_TABLE_TAG_VAL      20 // alter multiple tag values of the child tables of a stable
#define TSDB_ALTER_TABLE_ALTER_TAG_REF                  21 // set/change tag reference for virtual child table
#define TSDB_ALTER_TABLE_ADD_SERIES                      22
#define TSDB_ALTER_TABLE_REMOVE_SERIES                   23
#define TSDB_ALTER_TABLE_ADD_BASE_ON                     24
#define TSDB_ALTER_TABLE_DROP_BASE_ON                    25
#define TSDB_ALTER_TABLE_ADD_TAG_WITH_TAG_REF           26 // add a tag reference to a virtual normal table

#define TSDB_FILL_NONE        0
#define TSDB_FILL_NULL        1
#define TSDB_FILL_NULL_F      2
#define TSDB_FILL_SET_VALUE   3
#define TSDB_FILL_SET_VALUE_F 4
#define TSDB_FILL_LINEAR      5
#define TSDB_FILL_PREV        6
#define TSDB_FILL_NEXT        7
#define TSDB_FILL_NEAR        8


#define TSDB_ALTER_USER_BASIC_INFO             1
// these definitions start from 5 is to keep compatible with old versions
#define TSDB_ALTER_USER_ADD_PRIVILEGES         5
#define TSDB_ALTER_USER_DEL_PRIVILEGES         6


#define TSDB_ALTER_ROLE_LOCK            0x1
#define TSDB_ALTER_ROLE_ROLE            0x2
#define TSDB_ALTER_ROLE_PRIVILEGES      0x3
#define TSDB_ALTER_ROLE_MAX             0x4 // increase according to actual use

#define TSDB_ALTER_RSMA_FUNCTION        0x1

#define TSDB_KILL_MSG_LEN 30

#define TSDB_TABLE_NUM_UNIT 100000

#define TSDB_VN_READ_ACCCESS  ((char)0x1)
#define TSDB_VN_WRITE_ACCCESS ((char)0x2)
#define TSDB_VN_ALL_ACCCESS   (TSDB_VN_READ_ACCCESS | TSDB_VN_WRITE_ACCCESS)

#define TSDB_COL_NORMAL 0x0u  // the normal column of the table
#define TSDB_COL_TAG    0x1u  // the tag column type
#define TSDB_COL_UDC    0x2u  // the user specified normal string column, it is a dummy column
#define TSDB_COL_TMP    0x4u  // internal column generated by the previous operators
#define TSDB_COL_NULL   0x8u  // the column filter NULL or not

#define TSDB_COL_IS_TAG(f)        (((f & (~(TSDB_COL_NULL))) & TSDB_COL_TAG) != 0)
#define TSDB_COL_IS_NORMAL_COL(f) ((f & (~(TSDB_COL_NULL))) == TSDB_COL_NORMAL)
#define TSDB_COL_IS_UD_COL(f)     ((f & (~(TSDB_COL_NULL))) == TSDB_COL_UDC)
#define TSDB_COL_REQ_NULL(f)      (((f) & TSDB_COL_NULL) != 0)

#define TD_SUPER_TABLE          TSDB_SUPER_TABLE
#define TD_CHILD_TABLE          TSDB_CHILD_TABLE
#define TD_NORMAL_TABLE         TSDB_NORMAL_TABLE
#define TD_VIRTUAL_NORMAL_TABLE TSDB_VIRTUAL_NORMAL_TABLE
#define TD_VIRTUAL_CHILD_TABLE  TSDB_VIRTUAL_CHILD_TABLE

typedef enum ENodeType {
  // Syntax nodes are used in parser and planner module, and some are also used in executor module, such as COLUMN,
  // VALUE, OPERATOR, FUNCTION and so on.
  QUERY_NODE_COLUMN = 1,
  QUERY_NODE_VALUE,
  QUERY_NODE_OPERATOR,
  QUERY_NODE_LOGIC_CONDITION,
  QUERY_NODE_FUNCTION,
  QUERY_NODE_REAL_TABLE,
  QUERY_NODE_TEMP_TABLE,
  QUERY_NODE_JOIN_TABLE,
  QUERY_NODE_GROUPING_SET,
  QUERY_NODE_ORDER_BY_EXPR,
  QUERY_NODE_LIMIT,
  QUERY_NODE_STATE_WINDOW,
  QUERY_NODE_SESSION_WINDOW,
  QUERY_NODE_INTERVAL_WINDOW,
  QUERY_NODE_NODE_LIST,
  QUERY_NODE_FILL,
  QUERY_NODE_RAW_EXPR,  // Only be used in parser module.
  QUERY_NODE_TARGET,
  QUERY_NODE_DATABLOCK_DESC,
  QUERY_NODE_SLOT_DESC,
  QUERY_NODE_COLUMN_DEF,
  QUERY_NODE_DOWNSTREAM_SOURCE,
  QUERY_NODE_DATABASE_OPTIONS,
  QUERY_NODE_TABLE_OPTIONS,
  QUERY_NODE_INDEX_OPTIONS,
  QUERY_NODE_EXPLAIN_OPTIONS,
  QUERY_NODE_LEFT_VALUE,
  QUERY_NODE_COLUMN_REF,
  QUERY_NODE_WHEN_THEN,
  QUERY_NODE_CASE_WHEN,
  QUERY_NODE_EVENT_WINDOW,
  QUERY_NODE_HINT,
  QUERY_NODE_VIEW,
  QUERY_NODE_WINDOW_OFFSET,
  QUERY_NODE_SQL_WINDOW_SPEC,
  QUERY_NODE_SQL_WINDOW_FRAME,
  QUERY_NODE_SQL_NAMED_WINDOW,
  QUERY_NODE_COUNT_WINDOW,
  QUERY_NODE_COLUMN_OPTIONS,
  QUERY_NODE_TSMA_OPTIONS,
  QUERY_NODE_ANOMALY_WINDOW,
  QUERY_NODE_RANGE_AROUND,
  QUERY_NODE_STREAM_NOTIFY_OPTIONS,
  QUERY_NODE_VIRTUAL_TABLE,
  QUERY_NODE_SLIDING_WINDOW,
  QUERY_NODE_PERIOD_WINDOW,
  QUERY_NODE_STREAM_TRIGGER,
  QUERY_NODE_STREAM,
  QUERY_NODE_STREAM_TAG_DEF,
  QUERY_NODE_EXTERNAL_WINDOW,
  QUERY_NODE_STREAM_TRIGGER_OPTIONS,
  QUERY_NODE_PLACE_HOLDER_TABLE,
  QUERY_NODE_TIME_RANGE,
  QUERY_NODE_STREAM_OUT_TABLE,
  QUERY_NODE_STREAM_CALC_RANGE,
  QUERY_NODE_COUNT_WINDOW_ARGS,
  QUERY_NODE_BNODE_OPTIONS,
  QUERY_NODE_DATE_TIME_RANGE,
  QUERY_NODE_IP_RANGE,
  QUERY_NODE_USER_OPTIONS,
  QUERY_NODE_REMOTE_VALUE,
  QUERY_NODE_TOKEN_OPTIONS,
  QUERY_NODE_TRUE_FOR,
  QUERY_NODE_REMOTE_VALUE_LIST,
  QUERY_NODE_SURROUND,
  QUERY_NODE_REMOTE_ROW,
  QUERY_NODE_REMOTE_ZERO_ROWS,
  QUERY_NODE_UPDATE_TAG_VALUE,
  QUERY_NODE_ALTER_TABLE_UPDATE_TAG_VAL_CLAUSE,
  QUERY_NODE_REMOTE_TABLE,
  QUERY_NODE_FILE_TABLE,
  QUERY_NODE_TEXT_TABLE,
  QUERY_NODE_TAG_REF_COLUMN,
  QUERY_NODE_EXTERNAL_TABLE,    // SExtTableNode: external table reference in FROM clause
  QUERY_NODE_EXT_OPTION,        // helper: single OPTIONS key='val' pair node
  QUERY_NODE_EXT_ALTER_CLAUSE,  // helper: one SET clause in ALTER EXTERNAL SOURCE
  QUERY_NODE_EVENT_START_LEAF,
  QUERY_NODE_STREAM_WINDOW_PLAN,
  QUERY_NODE_STREAM_WINDOW_LAYER,

  // Statement nodes are used in parser and planner module.
  QUERY_NODE_SET_OPERATOR = 100,
  QUERY_NODE_SELECT_STMT,
  QUERY_NODE_VNODE_MODIFY_STMT,
  QUERY_NODE_CREATE_DATABASE_STMT,
  QUERY_NODE_DROP_DATABASE_STMT,
  QUERY_NODE_ALTER_DATABASE_STMT,
  QUERY_NODE_FLUSH_DATABASE_STMT,
  QUERY_NODE_TRIM_DATABASE_STMT,
  QUERY_NODE_CREATE_TABLE_STMT,
  QUERY_NODE_CREATE_SUBTABLE_CLAUSE,
  QUERY_NODE_CREATE_MULTI_TABLES_STMT,
  QUERY_NODE_DROP_TABLE_CLAUSE,
  QUERY_NODE_DROP_TABLE_STMT,
  QUERY_NODE_DROP_SUPER_TABLE_STMT,
  QUERY_NODE_ALTER_TABLE_STMT,
  QUERY_NODE_ALTER_SUPER_TABLE_STMT,
  QUERY_NODE_CREATE_USER_STMT,
  QUERY_NODE_ALTER_USER_STMT,
  QUERY_NODE_DROP_USER_STMT,
  QUERY_NODE_USE_DATABASE_STMT,
  QUERY_NODE_USE_EXT_SOURCE_STMT,
  QUERY_NODE_CREATE_DNODE_STMT,
  QUERY_NODE_DROP_DNODE_STMT,
  QUERY_NODE_ALTER_DNODE_STMT,
  QUERY_NODE_CREATE_INDEX_STMT,
  QUERY_NODE_DROP_INDEX_STMT,
  QUERY_NODE_CREATE_QNODE_STMT,
  QUERY_NODE_DROP_QNODE_STMT,
  QUERY_NODE_CREATE_BACKUP_NODE_STMT,  // no longer used
  QUERY_NODE_DROP_BACKUP_NODE_STMT,    // no longer used
  QUERY_NODE_CREATE_SNODE_STMT,
  QUERY_NODE_DROP_SNODE_STMT,
  QUERY_NODE_CREATE_MNODE_STMT,
  QUERY_NODE_DROP_MNODE_STMT,
  QUERY_NODE_CREATE_TOPIC_STMT,
  QUERY_NODE_DROP_TOPIC_STMT,
  QUERY_NODE_DROP_CGROUP_STMT,
  QUERY_NODE_ALTER_LOCAL_STMT,
  QUERY_NODE_EXPLAIN_STMT,
  QUERY_NODE_DESCRIBE_STMT,
  QUERY_NODE_RESET_QUERY_CACHE_STMT,
  QUERY_NODE_COMPACT_DATABASE_STMT,
  QUERY_NODE_COMPACT_VGROUPS_STMT,
  QUERY_NODE_CREATE_FUNCTION_STMT,
  QUERY_NODE_DROP_FUNCTION_STMT,
  QUERY_NODE_CREATE_STREAM_STMT,
  QUERY_NODE_DROP_STREAM_STMT,
  QUERY_NODE_BALANCE_VGROUP_STMT,
  QUERY_NODE_MERGE_VGROUP_STMT,
  QUERY_NODE_REDISTRIBUTE_VGROUP_STMT,
  QUERY_NODE_SPLIT_VGROUP_STMT,
  QUERY_NODE_SYNCDB_STMT,
  QUERY_NODE_GRANT_STMT,
  QUERY_NODE_REVOKE_STMT,
  QUERY_NODE_ALTER_CLUSTER_STMT,
  QUERY_NODE_SSMIGRATE_DATABASE_STMT,
  QUERY_NODE_CREATE_TSMA_STMT,
  QUERY_NODE_DROP_TSMA_STMT,
  QUERY_NODE_CREATE_VIRTUAL_TABLE_STMT,
  QUERY_NODE_CREATE_VIRTUAL_SUBTABLE_STMT,
  QUERY_NODE_DROP_VIRTUAL_TABLE_STMT,
  QUERY_NODE_ALTER_VIRTUAL_TABLE_STMT,
  QUERY_NODE_CREATE_MOUNT_STMT,
  QUERY_NODE_DROP_MOUNT_STMT,
  QUERY_NODE_SCAN_DATABASE_STMT,
  QUERY_NODE_SCAN_VGROUPS_STMT,
  QUERY_NODE_TRIM_DATABASE_WAL_STMT,
  QUERY_NODE_ALTER_DNODES_RELOAD_TLS_STMT,
  QUERY_NODE_CREATE_TOKEN_STMT,
  QUERY_NODE_ALTER_TOKEN_STMT,
  QUERY_NODE_DROP_TOKEN_STMT,
  QUERY_NODE_ALTER_ENCRYPT_KEY_STMT,
  QUERY_NODE_CREATE_ROLE_STMT,
  QUERY_NODE_DROP_ROLE_STMT,
  QUERY_NODE_ALTER_ROLE_STMT,
  QUERY_NODE_CREATE_TOTP_SECRET_STMT,
  QUERY_NODE_DROP_TOTP_SECRET_STMT,
  QUERY_NODE_ALTER_KEY_EXPIRATION_STMT,
  QUERY_NODE_SET_TIMEZONE_STMT,
  QUERY_NODE_SET_FIRST_DAY_OF_WEEK_STMT,
  QUERY_NODE_CREATE_BACKUP_STMT,

  // show statement nodes
  QUERY_NODE_SHOW_CREATE_VIEW_STMT = 181,
  QUERY_NODE_SHOW_CREATE_DATABASE_STMT,
  QUERY_NODE_SHOW_CREATE_TABLE_STMT,
  QUERY_NODE_SHOW_CREATE_STABLE_STMT,
  QUERY_NODE_SHOW_TABLE_DISTRIBUTED_STMT,
  QUERY_NODE_SHOW_LOCAL_VARIABLES_STMT,
  QUERY_NODE_SHOW_SCORES_STMT,
  QUERY_NODE_SHOW_TABLE_TAGS_STMT,
  QUERY_NODE_KILL_CONNECTION_STMT,
  QUERY_NODE_KILL_QUERY_STMT,
  QUERY_NODE_KILL_TRANSACTION_STMT,
  QUERY_NODE_KILL_COMPACT_STMT,
  QUERY_NODE_DELETE_STMT,
  QUERY_NODE_INSERT_STMT,
  QUERY_NODE_QUERY,
  QUERY_NODE_SHOW_DB_ALIVE_STMT,
  QUERY_NODE_SHOW_CLUSTER_ALIVE_STMT,
  QUERY_NODE_BALANCE_VGROUP_LEADER_STMT,
  QUERY_NODE_BALANCE_VGROUP_LEADER_DATABASE_STMT,
  QUERY_NODE_RESTORE_DNODE_STMT,
  QUERY_NODE_RESTORE_QNODE_STMT,
  QUERY_NODE_RESTORE_MNODE_STMT,
  QUERY_NODE_RESTORE_VNODE_STMT,
  QUERY_NODE_PAUSE_STREAM_STMT,
  QUERY_NODE_RESUME_STREAM_STMT,
  QUERY_NODE_CREATE_VIEW_STMT,
  QUERY_NODE_DROP_VIEW_STMT,
  QUERY_NODE_CREATE_SUBTABLE_FROM_FILE_CLAUSE,
  QUERY_NODE_CREATE_ANODE_STMT,
  QUERY_NODE_DROP_ANODE_STMT,
  QUERY_NODE_UPDATE_ANODE_STMT,
  QUERY_NODE_ASSIGN_LEADER_STMT,
  QUERY_NODE_SHOW_CREATE_TSMA_STMT,
  QUERY_NODE_SHOW_CREATE_VTABLE_STMT,
  QUERY_NODE_RECALCULATE_STREAM_STMT,
  QUERY_NODE_CREATE_BNODE_STMT,
  QUERY_NODE_DROP_BNODE_STMT,
  QUERY_NODE_KILL_SSMIGRATE_STMT,
  QUERY_NODE_KILL_SCAN_STMT,
  QUERY_NODE_CREATE_RSMA_STMT,
  QUERY_NODE_DROP_RSMA_STMT,
  QUERY_NODE_ALTER_RSMA_STMT,
  QUERY_NODE_SHOW_CREATE_RSMA_STMT,
  QUERY_NODE_ROLLUP_DATABASE_STMT,
  QUERY_NODE_ROLLUP_VGROUPS_STMT,
  QUERY_NODE_KILL_RETENTION_STMT,
  QUERY_NODE_SET_VGROUP_KEEP_VERSION_STMT,
  QUERY_NODE_CREATE_ENCRYPT_ALGORITHMS_STMT,
  QUERY_NODE_DROP_ENCRYPT_ALGR_STMT,
  QUERY_NODE_SHOW_CREATE_STREAM_STMT,
  QUERY_NODE_KILL_BACKUP_STMT,

  // DDL statement nodes for federated query (external source)  -  240-249 reserved
  QUERY_NODE_CREATE_EXT_SOURCE_STMT   = 240,
  QUERY_NODE_ALTER_EXT_SOURCE_STMT,
  QUERY_NODE_DROP_EXT_SOURCE_STMT,
  QUERY_NODE_REFRESH_EXT_SOURCE_STMT,
  QUERY_NODE_SHOW_EXT_SOURCES_STMT,     // SHOW EXTERNAL SOURCES
  QUERY_NODE_DESCRIBE_EXT_SOURCE_STMT,  // DESCRIBE EXTERNAL SOURCE <name>
  QUERY_NODE_SHOW_EXT_SOURCE_CAPABILITY_STMT,  // SHOW EXTERNAL SOURCE <name> CAPABILITY

  QUERY_NODE_BEGIN_TRANS_STMT = 250,
  QUERY_NODE_COMMIT_TRANS_STMT,
  QUERY_NODE_ROLLBACK_TRANS_STMT,
  QUERY_NODE_CLOSE_VNODE_STMT,
  QUERY_NODE_OPEN_VNODE_STMT,

  // show statement nodes
  // see 'sysTableShowAdapter', 'SYSTABLE_SHOW_TYPE_OFFSET'
  QUERY_NODE_SHOW_DNODES_STMT = 400,
  QUERY_NODE_SHOW_MNODES_STMT,
  QUERY_NODE_SHOW_MODULES_STMT,
  QUERY_NODE_SHOW_QNODES_STMT,
  QUERY_NODE_SHOW_SNODES_STMT,
  QUERY_NODE_SHOW_BACKUP_NODES_STMT,  // no longer used
  QUERY_NODE_SHOW_ARBGROUPS_STMT,
  QUERY_NODE_SHOW_CLUSTER_STMT,
  QUERY_NODE_SHOW_DATABASES_STMT,
  QUERY_NODE_SHOW_FUNCTIONS_STMT,
  QUERY_NODE_SHOW_INDEXES_STMT,
  QUERY_NODE_SHOW_STABLES_STMT,
  QUERY_NODE_SHOW_STREAMS_STMT,
  QUERY_NODE_SHOW_TABLES_STMT,
  QUERY_NODE_SHOW_TAGS_STMT,
  QUERY_NODE_SHOW_USERS_STMT,
  QUERY_NODE_SHOW_USERS_FULL_STMT,
  QUERY_NODE_SHOW_LICENCES_STMT,
  QUERY_NODE_SHOW_VGROUPS_STMT,
  QUERY_NODE_SHOW_TOPICS_STMT,
  QUERY_NODE_SHOW_CONSUMERS_STMT,
  QUERY_NODE_SHOW_CONNECTIONS_STMT,
  QUERY_NODE_SHOW_QUERIES_STMT,
  QUERY_NODE_SHOW_APPS_STMT,
  QUERY_NODE_SHOW_VARIABLES_STMT,
  QUERY_NODE_SHOW_DNODE_VARIABLES_STMT,
  QUERY_NODE_SHOW_TRANSACTIONS_STMT,
  QUERY_NODE_SHOW_SUBSCRIPTIONS_STMT,
  QUERY_NODE_SHOW_VNODES_STMT,
  QUERY_NODE_SHOW_USER_PRIVILEGES_STMT,
  QUERY_NODE_SHOW_VIEWS_STMT,
  QUERY_NODE_SHOW_COMPACTS_STMT,
  QUERY_NODE_SHOW_COMPACT_DETAILS_STMT,
  QUERY_NODE_SHOW_GRANTS_FULL_STMT,
  QUERY_NODE_SHOW_GRANTS_LOGS_STMT,
  QUERY_NODE_SHOW_CLUSTER_MACHINES_STMT,
  QUERY_NODE_SHOW_ENCRYPTIONS_STMT,
  QUERY_NODE_SHOW_TSMAS_STMT,
  QUERY_NODE_SHOW_ANODES_STMT,
  QUERY_NODE_SHOW_ANODES_FULL_STMT,
  QUERY_NODE_SHOW_USAGE_STMT,
  QUERY_NODE_SHOW_FILESETS_STMT,
  QUERY_NODE_SHOW_TRANSACTION_DETAILS_STMT,
  QUERY_NODE_SHOW_VTABLES_STMT,
  QUERY_NODE_SHOW_BNODES_STMT,
  QUERY_NODE_SHOW_MOUNTS_STMT,
  QUERY_NODE_SHOW_SSMIGRATES_STMT,
  QUERY_NODE_SHOW_SCANS_STMT,
  QUERY_NODE_SHOW_SCAN_DETAILS_STMT,
  QUERY_NODE_SHOW_RSMAS_STMT,
  QUERY_NODE_SHOW_RETENTIONS_STMT,
  QUERY_NODE_SHOW_RETENTION_DETAILS_STMT,
  QUERY_NODE_SHOW_INSTANCES_STMT,
  QUERY_NODE_SHOW_ENCRYPT_ALGORITHMS_STMT,
  // the order of QUERY_NODE_SHOW_* must be aligned with the order of `sysTableShowAdapter` defines.
  QUERY_NODE_SHOW_TOKENS_STMT,
  QUERY_NODE_SHOW_ENCRYPT_STATUS_STMT,
  QUERY_NODE_SHOW_ROLES_STMT,
  QUERY_NODE_SHOW_ROLE_PRIVILEGES_STMT,
  QUERY_NODE_SHOW_ROLE_COL_PRIVILEGES_STMT,
  QUERY_NODE_SHOW_XNODES_STMT,
  QUERY_NODE_SHOW_XNODE_TASKS_STMT,
  QUERY_NODE_SHOW_XNODE_AGENTS_STMT,
  QUERY_NODE_SHOW_XNODE_JOBS_STMT,
  QUERY_NODE_SHOW_VALIDATE_VTABLE_STMT,
  QUERY_NODE_SHOW_SECURITY_POLICIES_STMT,
  QUERY_NODE_SHOW_CPU_ALLOCATION_STMT,
  QUERY_NODE_SHOW_TRANSACTION_LOGS_STMT,
  QUERY_NODE_SHOW_TRANSACTION_ORPHANS_STMT,
  // VST inheritance (BASE ON): appended at the end to preserve existing enum values.
  QUERY_NODE_SHOW_VSTABLE_INHERITS_STMT,
  QUERY_NODE_SHOW_BACKUPS_STMT,

  // logic plan node
  QUERY_NODE_LOGIC_PLAN_SCAN = 1000,
  QUERY_NODE_LOGIC_PLAN_JOIN,
  QUERY_NODE_LOGIC_PLAN_AGG,
  QUERY_NODE_LOGIC_PLAN_PROJECT,
  QUERY_NODE_LOGIC_PLAN_VNODE_MODIFY,
  QUERY_NODE_LOGIC_PLAN_EXCHANGE,
  QUERY_NODE_LOGIC_PLAN_MERGE,
  QUERY_NODE_LOGIC_PLAN_WINDOW,
  QUERY_NODE_LOGIC_PLAN_FILL,
  QUERY_NODE_LOGIC_PLAN_SORT,
  QUERY_NODE_LOGIC_PLAN_PARTITION,
  QUERY_NODE_LOGIC_PLAN_INDEF_ROWS_FUNC,
  QUERY_NODE_LOGIC_PLAN_INTERP_FUNC,
  QUERY_NODE_LOGIC_SUBPLAN,
  QUERY_NODE_LOGIC_PLAN,
  QUERY_NODE_LOGIC_PLAN_GROUP_CACHE,
  QUERY_NODE_LOGIC_PLAN_DYN_QUERY_CTRL,
  QUERY_NODE_LOGIC_PLAN_FORECAST_FUNC,
  QUERY_NODE_LOGIC_PLAN_VIRTUAL_TABLE_SCAN,
  QUERY_NODE_LOGIC_PLAN_ANALYSIS_FUNC,
  QUERY_NODE_LOGIC_PLAN_ROWSET_SOURCE,
  QUERY_NODE_LOGIC_PLAN_TAG_REF_SOURCE,
  QUERY_NODE_LOGIC_PLAN_DISTINCT_FILTER,
  QUERY_NODE_LOGIC_PLAN_WINDOW_FUNC,

  // physical plan node
  QUERY_NODE_PHYSICAL_PLAN_TAG_SCAN = 1100,
  QUERY_NODE_PHYSICAL_PLAN_TABLE_SCAN,
  QUERY_NODE_PHYSICAL_PLAN_TABLE_SEQ_SCAN,  // INACTIVE
  QUERY_NODE_PHYSICAL_PLAN_TABLE_MERGE_SCAN,
  QUERY_NODE_PHYSICAL_PLAN_STREAM_SCAN,
  QUERY_NODE_PHYSICAL_PLAN_SYSTABLE_SCAN,
  QUERY_NODE_PHYSICAL_PLAN_BLOCK_DIST_SCAN,
  QUERY_NODE_PHYSICAL_PLAN_LAST_ROW_SCAN,
  QUERY_NODE_PHYSICAL_PLAN_PROJECT,
  QUERY_NODE_PHYSICAL_PLAN_MERGE_JOIN,
  QUERY_NODE_PHYSICAL_PLAN_HASH_AGG,
  QUERY_NODE_PHYSICAL_PLAN_EXCHANGE,
  QUERY_NODE_PHYSICAL_PLAN_MERGE,
  QUERY_NODE_PHYSICAL_PLAN_SORT,
  QUERY_NODE_PHYSICAL_PLAN_GROUP_SORT,
  QUERY_NODE_PHYSICAL_PLAN_HASH_INTERVAL,
  QUERY_NODE_PHYSICAL_PLAN_MERGE_INTERVAL,  // INACTIVE
  QUERY_NODE_PHYSICAL_PLAN_MERGE_ALIGNED_INTERVAL,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_1,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_2,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_3,
  QUERY_NODE_PHYSICAL_PLAN_FILL,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_4,
  QUERY_NODE_PHYSICAL_PLAN_MERGE_SESSION,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_5,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_6,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_7,
  QUERY_NODE_PHYSICAL_PLAN_MERGE_STATE,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_8,
  QUERY_NODE_PHYSICAL_PLAN_PARTITION,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_9,
  QUERY_NODE_PHYSICAL_PLAN_INDEF_ROWS_FUNC,
  QUERY_NODE_PHYSICAL_PLAN_INTERP_FUNC,
  QUERY_NODE_PHYSICAL_PLAN_DISPATCH,
  QUERY_NODE_PHYSICAL_PLAN_INSERT,
  QUERY_NODE_PHYSICAL_PLAN_QUERY_INSERT,
  QUERY_NODE_PHYSICAL_PLAN_DELETE,
  QUERY_NODE_PHYSICAL_SUBPLAN,
  QUERY_NODE_PHYSICAL_PLAN,
  QUERY_NODE_PHYSICAL_PLAN_TABLE_COUNT_SCAN,
  QUERY_NODE_PHYSICAL_PLAN_MERGE_EVENT,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_10,
  QUERY_NODE_PHYSICAL_PLAN_HASH_JOIN,
  QUERY_NODE_PHYSICAL_PLAN_GROUP_CACHE,
  QUERY_NODE_PHYSICAL_PLAN_DYN_QUERY_CTRL,
  QUERY_NODE_PHYSICAL_PLAN_MERGE_COUNT,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_11,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_12,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_13,
  QUERY_NODE_PHYSICAL_PLAN_MERGE_ANOMALY,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_14,
  QUERY_NODE_PHYSICAL_PLAN_FORECAST_FUNC,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_15,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_16,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_17,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_18,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_19,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_20,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_21,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_22,
  QUERY_NODE_PHYSICAL_PLAN_UNUSED_23,
  QUERY_NODE_PHYSICAL_PLAN_WINDOW_FUNC,
  QUERY_NODE_PHYSICAL_PLAN_VIRTUAL_TABLE_SCAN,
  QUERY_NODE_PHYSICAL_PLAN_EXTERNAL_WINDOW,
  QUERY_NODE_PHYSICAL_PLAN_HASH_EXTERNAL,
  QUERY_NODE_PHYSICAL_PLAN_MERGE_ALIGNED_EXTERNAL,
  QUERY_NODE_PHYSICAL_PLAN_STREAM_INSERT,
  QUERY_NODE_PHYSICAL_PLAN_ANALYSIS_FUNC,
  QUERY_NODE_PHYSICAL_PLAN_ROWSET_SOURCE,
  QUERY_NODE_PHYSICAL_PLAN_TAG_REF_SOURCE,
  QUERY_NODE_PHYSICAL_PLAN_DISTINCT_FILTER, // deprecated
  QUERY_NODE_PHYSICAL_PLAN_FEDERATED_SCAN,  // federated query scan operator
  // Same plan as TABLE_COUNT_SCAN plus an ins_tables row type filter (tbCountType). Emitted only when
  // the filter is present so that older vnodes reject the unknown node type instead of silently
  // ignoring the filter and returning an unfiltered (too large) count during rolling upgrades.
  QUERY_NODE_PHYSICAL_PLAN_TABLE_COUNT_SCAN_BY_TYPE,
  QUERY_NODE_PHYSICAL_PLAN_THETA_JOIN,
  // xnode
  QUERY_NODE_CREATE_XNODE_STMT = 1200,  // Xnode
  QUERY_NODE_DROP_XNODE_STMT,
  QUERY_NODE_DRAIN_XNODE_STMT,
  QUERY_NODE_XNODE_TASK_OPTIONS,              // XNode task options
  QUERY_NODE_XNODE_TASK_SOURCE_OPT,           // XNode task source
  QUERY_NODE_XNODE_TASK_SINK_OPT,             // XNode task sink
  QUERY_NODE_CREATE_XNODE_TASK_STMT,          // XNode task
  QUERY_NODE_START_XNODE_TASK_STMT,           // XNode task
  QUERY_NODE_STOP_XNODE_TASK_STMT,            // XNode task
  QUERY_NODE_UPDATE_XNODE_TASK_STMT,          // XNode task
  QUERY_NODE_DROP_XNODE_TASK_STMT,            // XNode task
  QUERY_NODE_CREATE_XNODE_JOB_STMT,           // XNode job
  QUERY_NODE_ALTER_XNODE_JOB_STMT,            // XNode job
  QUERY_NODE_REBALANCE_XNODE_JOB_STMT,        // XNode job
  QUERY_NODE_REBALANCE_XNODE_JOB_WHERE_STMT,  // XNode job
  QUERY_NODE_DROP_XNODE_JOB_STMT,             // XNode job
  QUERY_NODE_CREATE_XNODE_AGENT_STMT,         // XNode agent
  QUERY_NODE_DROP_XNODE_AGENT_STMT,           // XNode agent
  QUERY_NODE_ALTER_XNODE_AGENT_STMT,          // XNode agent
  QUERY_NODE_ALTER_XNODE_STMT,                // Alter xnode

  // ext-source virtual table series (appended to avoid disturbing pinned QUERY_NODE_SHOW_CREATE_VIEW_STMT=181 block)
  QUERY_NODE_SERIES_DECL,
  QUERY_NODE_SERIES_TAG_ASSIGN,
  // appended to avoid disturbing pinned show-statement values
  QUERY_NODE_FLUSH_MNODE_STMT,

  // xnode restart (appended to preserve existing enum numeric values)
  QUERY_NODE_RESTART_XNODE_STMT,
  // Correlation nodes use a separate range; existing wire IDs stay unchanged.
  QUERY_NODE_OUTER_REF = 1300,
  QUERY_NODE_CORRELATION_PARAM,
  QUERY_NODE_CORRELATION_PARAM_BINDING,
  QUERY_NODE_CORRELATED_SUBQUERY,
  QUERY_NODE_CORRELATION_TEMPLATE,
  QUERY_NODE_CORRELATION_TIME_RANGE_INIT,
} ENodeType;

typedef struct {
  int32_t     vgId;
  uint8_t     option;         // 0x0 REQ_OPT_TBNAME, 0x01 REQ_OPT_TBUID
  uint8_t     autoCreateCtb;  // 0x0 not auto create, 0x01 auto create
  const char* dbFName;
  const char* tbName;
} SBuildTableInput;

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  int64_t dbId;
  int32_t vgVersion;
  int32_t numOfTable;  // unit is TSDB_TABLE_NUM_UNIT
  int64_t stateTs;
} SBuildUseDBInput;

typedef struct SField {
  char    name[TSDB_COL_NAME_LEN];
  uint8_t type;
  int8_t  flags;
  int32_t bytes;
} SField;

typedef struct SFieldWithOptions {
  char     name[TSDB_COL_NAME_LEN];
  uint8_t  type;
  int8_t   flags;
  int32_t  bytes;
  uint32_t compress;
  STypeMod typeMod;
} SFieldWithOptions;

typedef struct SRetention {
  int64_t freq;
  int64_t keep;
  int8_t  freqUnit;
  int8_t  keepUnit;
} SRetention;

#define RETENTION_VALID(l, r) ((((l) == 0 && (r)->freq >= 0) || ((r)->freq > 0)) && ((r)->keep > 0))

#pragma pack(push, 1)
// null-terminated string instead of char array to avoid too many memory consumption in case of more than 1M tableMeta
typedef struct SEp {
  char     fqdn[TSDB_FQDN_LEN];
  uint16_t port;
} SEp;

typedef struct {
  int32_t contLen;
  int32_t vgId;
} SMsgHead;

// Submit message for one table
typedef struct SSubmitBlk {
  int64_t uid;        // table unique id
  int64_t suid;       // stable id
  int32_t sversion;   // data schema version
  int32_t dataLen;    // data part length, not including the SSubmitBlk head
  int32_t schemaLen;  // schema length, if length is 0, no schema exists
  int32_t numOfRows;  // total number of rows in current submit block
  char    data[];
} SSubmitBlk;

// Submit message for this TSDB
typedef struct {
  SMsgHead header;
  int64_t  version;
  int32_t  length;
  int32_t  numOfBlocks;
  char     blocks[];
} SSubmitReq;

typedef struct {
  int32_t totalLen;
  int32_t len;
  STSRow* row;
} SSubmitBlkIter;

typedef struct {
  int32_t totalLen;
  int32_t len;
  // head of SSubmitBlk
  int64_t uid;        // table unique id
  int64_t suid;       // stable id
  int32_t sversion;   // data schema version
  int32_t dataLen;    // data part length, not including the SSubmitBlk head
  int32_t schemaLen;  // schema length, if length is 0, no schema exists
  int32_t numOfRows;  // total number of rows in current submit block
  // head of SSubmitBlk
  int32_t     numOfBlocks;
  const void* pMsg;
} SSubmitMsgIter;

int32_t tInitSubmitMsgIter(const SSubmitReq* pMsg, SSubmitMsgIter* pIter);
int32_t tGetSubmitMsgNext(SSubmitMsgIter* pIter, SSubmitBlk** pPBlock);
int32_t tInitSubmitBlkIter(SSubmitMsgIter* pMsgIter, SSubmitBlk* pBlock, SSubmitBlkIter* pIter);
STSRow* tGetSubmitBlkNext(SSubmitBlkIter* pIter);
// for debug
int32_t tPrintFixedSchemaSubmitReq(SSubmitReq* pReq, STSchema* pSchema);

typedef struct {
  bool     hasRef;
  col_id_t id;
  int8_t   refType;                                   // 0=internal, 1=external (DS section 6.2.7)
  char     refSourceName[TSDB_EXT_SOURCE_NAME_LEN];   // external source name (refType=1)
  char     refSchemaName[TSDB_EXT_SOURCE_SCHEMA_LEN];  // external schema captured at virtual-table creation (PG only)
  char     refDbName[TSDB_DB_NAME_LEN];
  char     refTableName[TSDB_TABLE_NAME_LEN];
  char     refColName[TSDB_COL_NAME_LEN];
  int32_t  tagCondLen;
  char     *tagCondJson; // serialized series tag condition (JSON string from nodesNodeToString), or NULL
  int32_t  filterCondLen;
  char     *filterCondJson;  // serialized MySQL/PostgreSQL column filter, or NULL
  char     colName[TSDB_COL_NAME_LEN];     // for tmq get json
} SColRef;

typedef struct {
  int32_t  nCols;
  int32_t  version;
  SColRef* pColRef;
  int32_t  nTagRefs;
  SColRef* pTagRef;
} SColRefWrapper;

int32_t tEncodeSColRefWrapper(SEncoder* pCoder, const SColRefWrapper* pWrapper);
int32_t tDecodeSColRefWrapperEx(SDecoder* pDecoder, SColRefWrapper* pWrapper);
void    tFreeSColRefArray(SColRef* pColRef, int32_t nCols);

typedef struct SSeriesEntry {
  char    alias[TSDB_COL_NAME_LEN];
  char    sourceName[TSDB_EXT_SOURCE_NAME_LEN];
  char    dbName[TSDB_DB_NAME_LEN];
  char    measurementName[TSDB_TABLE_NAME_LEN];
  int32_t tagCondLen;
  char*   tagCondJson;
} SSeriesEntry;

typedef struct SSeriesWrapper {
  int32_t       nSeries;
  SSeriesEntry* pSeries;
} SSeriesWrapper;

int32_t tEncodeSSeriesWrapper(SEncoder* pCoder, const SSeriesWrapper* pWrapper);
int32_t tDecodeSSeriesWrapper(SDecoder* pDecoder, SSeriesWrapper* pWrapper);
void    tFreeSSeriesWrapper(SSeriesWrapper* pWrapper);

typedef struct {
  int32_t vgId;
  SColRef colRef;
} SColRefEx;

typedef struct {
  int16_t colId;
  char    refDbName[TSDB_DB_NAME_LEN];
  char    refTableName[TSDB_TABLE_NAME_LEN];
  char    refColName[TSDB_COL_NAME_LEN];
  char    refSourceName[TSDB_EXT_SOURCE_NAME_LEN];  // external source name, empty for internal refs
  bool    hasFilterCond;  // saved external-column filter, including resolved leaf refs
} SRefColInfo;

typedef struct SVCTableRefCols {
  uint64_t     uid;
  int32_t      numOfSrcTbls;
  int32_t      numOfColRefs;
  SRefColInfo* refCols;
  int32_t      numOfTagRefs;
  SRefColInfo* tagRefCols;
} SVCTableRefCols;

typedef struct SVCTableMergeInfo {
  uint64_t uid;
  int32_t  numOfSrcTbls;
} SVCTableMergeInfo;

typedef struct {
  int32_t    nCols;
  SColRefEx* pColRefEx;
} SColRefExWrapper;

struct SSchema {
  int8_t   type;
  int8_t   flags;
  col_id_t colId;
  int32_t  bytes;
  char     name[TSDB_COL_NAME_LEN];
};
struct SSchemaExt {
  col_id_t colId;
  uint32_t compress;
  STypeMod typeMod;
};

struct SSchemaRsma {
  int64_t    interval[2];
  int32_t    nFuncs;
  int8_t     tbType;
  tb_uid_t   tbUid;
  func_id_t* funcIds;
  char       tbName[TSDB_TABLE_NAME_LEN];
};

struct SSchema2 {
  int8_t   type;
  int8_t   flags;
  col_id_t colId;
  int32_t  bytes;
  char     name[TSDB_COL_NAME_LEN];
  uint32_t compress;
};

typedef struct {
  char        tbName[TSDB_TABLE_NAME_LEN];
  char        stbName[TSDB_TABLE_NAME_LEN];
  char        dbFName[TSDB_DB_FNAME_LEN];
  int64_t     dbId;
  int32_t     numOfTags;
  int32_t     numOfColumns;
  int8_t      precision;
  int8_t      tableType;
  int32_t     sversion;
  int32_t     tversion;
  int32_t     rversion;
  uint64_t    suid;
  uint64_t    tuid;
  int32_t     vgId;
  union {
    uint8_t flag;
    struct {
      uint8_t sysInfo : 1;
      uint8_t isAudit : 1;
      uint8_t privCat : 3;  // ESysTblPrivCat
      uint8_t secLvl : 3;
    };
  };
  int64_t     ownerId;
  SSchema*    pSchemas;
  SSchemaExt* pSchemaExt;
  int8_t      virtualStb;
  int32_t     numOfColRefs;
  SColRef*    pColRefs;
  int32_t     numOfTagRefs;
  SColRef*    pTagRefs;
  int32_t       numOfSeries;
  SSeriesEntry* pSeries;
  int8_t        secureDelete;
  int8_t        hasInheritors;  // 1 if other VSTs inherit from this STB (non-leaf)
} STableMetaRsp;

typedef struct {
  int32_t        code;
  int64_t        uid;
  char*          tblFName;
  int32_t        numOfRows;
  int32_t        affectedRows;
  int64_t        sver;
  STableMetaRsp* pMeta;
} SSubmitBlkRsp;

typedef struct {
  int32_t numOfRows;
  int32_t affectedRows;
  int32_t nBlocks;
  union {
    SArray*        pArray;
    SSubmitBlkRsp* pBlocks;
  };
} SSubmitRsp;

// int32_t tEncodeSSubmitRsp(SEncoder* pEncoder, const SSubmitRsp* pRsp);
// int32_t tDecodeSSubmitRsp(SDecoder* pDecoder, SSubmitRsp* pRsp);
// void    tFreeSSubmitBlkRsp(void* param);
void tFreeSSubmitRsp(SSubmitRsp* pRsp);

#define COL_SMA_ON       ((int8_t)0x1)
#define COL_IDX_ON       ((int8_t)0x2)
#define COL_IS_KEY       ((int8_t)0x4)
#define COL_SET_NULL     ((int8_t)0x10)
#define COL_SET_VAL      ((int8_t)0x20)
#define COL_IS_SYSINFO   ((int8_t)0x40)
#define COL_HAS_TYPE_MOD ((int8_t)0x80)
#define COL_REF_BY_STM   ((int8_t)0x08)

#define COL_IS_SET(FLG)  (((FLG) & (COL_SET_VAL | COL_SET_NULL)) != 0)
#define COL_CLR_SET(FLG) ((FLG) &= (~(COL_SET_VAL | COL_SET_NULL)))

#define IS_BSMA_ON(s)  (((s)->flags & 0x01) == COL_SMA_ON)
#define IS_IDX_ON(s)   (((s)->flags & 0x02) == COL_IDX_ON)
#define IS_SET_NULL(s) (((s)->flags & COL_SET_NULL) == COL_SET_NULL)

#define SSCHMEA_SET_IDX_ON(s) \
  do {                        \
    (s)->flags |= COL_IDX_ON; \
  } while (0)

#define SSCHMEA_SET_IDX_OFF(s)   \
  do {                           \
    (s)->flags &= (~COL_IDX_ON); \
  } while (0)

#define SSCHEMA_SET_TYPE_MOD(s)     \
  do {                              \
    (s)->flags |= COL_HAS_TYPE_MOD; \
  } while (0)

#define HAS_TYPE_MOD(s) (((s)->flags & COL_HAS_TYPE_MOD))

#define SSCHMEA_TYPE(s)  ((s)->type)
#define SSCHMEA_FLAGS(s) ((s)->flags)
#define SSCHMEA_COLID(s) ((s)->colId)
#define SSCHMEA_BYTES(s) ((s)->bytes)
#define SSCHMEA_NAME(s)  ((s)->name)

typedef struct {
  bool    tsEnableMonitor;
  int32_t tsMonitorInterval;
  int32_t tsSlowLogThreshold;
  int32_t tsSlowLogMaxLen;
  int32_t tsSlowLogScope;
  int32_t tsSlowLogThresholdTest;  // Obsolete
  char    tsSlowLogExceptDb[TSDB_DB_NAME_LEN];
} SMonitorParas;

typedef struct {
  STypeMod typeMod;
} SExtSchema;

bool hasExtSchema(const SExtSchema* pExtSchema);

typedef struct {
  int32_t      nCols;
  int32_t      version;
  SSchema*     pSchema;
  SSchemaRsma* pRsma;
} SSchemaWrapper;

typedef struct {
  col_id_t id;
  uint32_t alg;
} SColCmpr;

typedef struct {
  int32_t   nCols;
  int32_t   version;
  SColCmpr* pColCmpr;
} SColCmprWrapper;

static FORCE_INLINE int32_t tInitDefaultSColRefWrapperByCols(SColRefWrapper* pRef, int32_t nCols) {
  if (pRef->pColRef) {
    return TSDB_CODE_INVALID_PARA;
  }
  pRef->pColRef = (SColRef*)taosMemoryCalloc(nCols, sizeof(SColRef));
  if (pRef->pColRef == NULL) {
    return terrno;
  }
  pRef->nCols = nCols;
  for (int32_t i = 0; i < nCols; i++) {
    pRef->pColRef[i].hasRef = false;
    pRef->pColRef[i].id = (col_id_t)(i + 1);
  }
  return 0;
}

static FORCE_INLINE int32_t tInitDefaultSColRefWrapperByTags(SColRefWrapper* pRef, int32_t nTags, col_id_t startColId) {
  if (pRef->pTagRef) {
    return TSDB_CODE_INVALID_PARA;
  }
  pRef->pTagRef = (SColRef*)taosMemoryCalloc(nTags, sizeof(SColRef));
  if (pRef->pTagRef == NULL) {
    return terrno;
  }
  pRef->nTagRefs = nTags;
  for (int32_t i = 0; i < nTags; i++) {
    pRef->pTagRef[i].hasRef = false;
    pRef->pTagRef[i].id = (col_id_t)(startColId + i);
  }
  return 0;
}

static FORCE_INLINE SColCmprWrapper* tCloneSColCmprWrapper(const SColCmprWrapper* pSrcWrapper) {
  if (pSrcWrapper->pColCmpr == NULL || pSrcWrapper->nCols == 0) {
    terrno = TSDB_CODE_INVALID_PARA;
    return NULL;
  }

  SColCmprWrapper* pDstWrapper = (SColCmprWrapper*)taosMemoryMalloc(sizeof(SColCmprWrapper));
  if (pDstWrapper == NULL) {
    return NULL;
  }
  pDstWrapper->nCols = pSrcWrapper->nCols;
  pDstWrapper->version = pSrcWrapper->version;

  int32_t size = sizeof(SColCmpr) * pDstWrapper->nCols;
  pDstWrapper->pColCmpr = (SColCmpr*)taosMemoryCalloc(1, size);
  if (pDstWrapper->pColCmpr == NULL) {
    taosMemoryFree(pDstWrapper);
    return NULL;
  }
  (void)memcpy(pDstWrapper->pColCmpr, pSrcWrapper->pColCmpr, size);

  return pDstWrapper;
}

static FORCE_INLINE int32_t tInitDefaultSColCmprWrapperByCols(SColCmprWrapper* pCmpr, int32_t nCols) {
  if (!(!pCmpr->pColCmpr)) {
    return TSDB_CODE_INVALID_PARA;
  }
  pCmpr->pColCmpr = (SColCmpr*)taosMemoryCalloc(nCols, sizeof(SColCmpr));
  if (pCmpr->pColCmpr == NULL) {
    return terrno;
  }
  pCmpr->nCols = nCols;
  return 0;
}

static FORCE_INLINE int32_t tInitDefaultSColCmprWrapper(SColCmprWrapper* pCmpr, SSchemaWrapper* pSchema) {
  pCmpr->nCols = pSchema->nCols;
  if (!(!pCmpr->pColCmpr)) {
    return TSDB_CODE_INVALID_PARA;
  }
  pCmpr->pColCmpr = (SColCmpr*)taosMemoryCalloc(pCmpr->nCols, sizeof(SColCmpr));
  if (pCmpr->pColCmpr == NULL) {
    return terrno;
  }
  for (int32_t i = 0; i < pCmpr->nCols; i++) {
    SColCmpr* pColCmpr = &pCmpr->pColCmpr[i];
    SSchema*  pColSchema = &pSchema->pSchema[i];
    pColCmpr->id = pColSchema->colId;
    pColCmpr->alg = 0;
  }
  return 0;
}

static FORCE_INLINE void tDeleteSColCmprWrapper(SColCmprWrapper* pWrapper) {
  if (pWrapper == NULL) return;

  taosMemoryFreeClear(pWrapper->pColCmpr);
  taosMemoryFreeClear(pWrapper);
}
static FORCE_INLINE SSchemaWrapper* tCloneSSchemaWrapper(const SSchemaWrapper* pSchemaWrapper) {
  if (pSchemaWrapper->pSchema == NULL) return NULL;

  SSchemaWrapper* pSW = (SSchemaWrapper*)taosMemoryCalloc(1, sizeof(SSchemaWrapper));
  if (pSW == NULL) {
    return NULL;
  }
  pSW->nCols = pSchemaWrapper->nCols;
  pSW->version = pSchemaWrapper->version;
  pSW->pSchema = (SSchema*)taosMemoryCalloc(pSW->nCols, sizeof(SSchema));
  if (pSW->pSchema == NULL) {
    taosMemoryFree(pSW);
    return NULL;
  }

  (void)memcpy(pSW->pSchema, pSchemaWrapper->pSchema, pSW->nCols * sizeof(SSchema));
  return pSW;
}

static FORCE_INLINE void tDeleteSchemaWrapper(SSchemaWrapper* pSchemaWrapper) {
  if (pSchemaWrapper) {
    taosMemoryFree(pSchemaWrapper->pSchema);
    if (pSchemaWrapper->pRsma) {
      taosMemoryFreeClear(pSchemaWrapper->pRsma->funcIds);
      taosMemoryFreeClear(pSchemaWrapper->pRsma);
    }
    taosMemoryFree(pSchemaWrapper);
  }
}

static FORCE_INLINE void tDestroySchemaWrapper(SSchemaWrapper* pSchemaWrapper) {
  if (pSchemaWrapper) {
    taosMemoryFreeClear(pSchemaWrapper->pSchema);
    if (pSchemaWrapper->pRsma) {
      taosMemoryFreeClear(pSchemaWrapper->pRsma->funcIds);
      taosMemoryFreeClear(pSchemaWrapper->pRsma);
    }
  }
}

static FORCE_INLINE void tDeleteSSchemaWrapperForHash(void* pSchemaWrapper) {
  if (pSchemaWrapper != NULL && *(SSchemaWrapper**)pSchemaWrapper != NULL) {
    tDeleteSchemaWrapper(*(SSchemaWrapper**)pSchemaWrapper);
  }
}

static FORCE_INLINE int32_t taosEncodeSSchema(void** buf, const SSchema* pSchema) {
  int32_t tlen = 0;
  tlen += taosEncodeFixedI8(buf, pSchema->type);
  tlen += taosEncodeFixedI8(buf, pSchema->flags);
  tlen += taosEncodeFixedI32(buf, pSchema->bytes);
  tlen += taosEncodeFixedI16(buf, pSchema->colId);
  tlen += taosEncodeString(buf, pSchema->name);
  return tlen;
}

static FORCE_INLINE void* taosDecodeSSchema(const void* buf, SSchema* pSchema) {
  buf = taosDecodeFixedI8(buf, &pSchema->type);
  buf = taosDecodeFixedI8(buf, &pSchema->flags);
  buf = taosDecodeFixedI32(buf, &pSchema->bytes);
  buf = taosDecodeFixedI16(buf, &pSchema->colId);
  buf = taosDecodeStringTo(buf, pSchema->name);
  return (void*)buf;
}

static FORCE_INLINE int32_t tEncodeSSchema(SEncoder* pEncoder, const SSchema* pSchema) {
  TAOS_CHECK_RETURN(tEncodeI8(pEncoder, pSchema->type));
  TAOS_CHECK_RETURN(tEncodeI8(pEncoder, pSchema->flags));
  TAOS_CHECK_RETURN(tEncodeI32v(pEncoder, pSchema->bytes));
  TAOS_CHECK_RETURN(tEncodeI16v(pEncoder, pSchema->colId));
  TAOS_CHECK_RETURN(tEncodeCStr(pEncoder, pSchema->name));
  return 0;
}

static FORCE_INLINE int32_t tDecodeSSchema(SDecoder* pDecoder, SSchema* pSchema) {
  TAOS_CHECK_RETURN(tDecodeI8(pDecoder, &pSchema->type));
  TAOS_CHECK_RETURN(tDecodeI8(pDecoder, &pSchema->flags));
  TAOS_CHECK_RETURN(tDecodeI32v(pDecoder, &pSchema->bytes));
  TAOS_CHECK_RETURN(tDecodeI16v(pDecoder, &pSchema->colId));
  TAOS_CHECK_RETURN(tDecodeCStrTo(pDecoder, pSchema->name));
  return 0;
}

static FORCE_INLINE int32_t tEncodeSSchemaExt(SEncoder* pEncoder, const SSchemaExt* pSchemaExt) {
  TAOS_CHECK_RETURN(tEncodeI16v(pEncoder, pSchemaExt->colId));
  TAOS_CHECK_RETURN(tEncodeU32(pEncoder, pSchemaExt->compress));
  TAOS_CHECK_RETURN(tEncodeI32(pEncoder, pSchemaExt->typeMod));
  return 0;
}

static FORCE_INLINE int32_t tDecodeSSchemaExt(SDecoder* pDecoder, SSchemaExt* pSchemaExt) {
  TAOS_CHECK_RETURN(tDecodeI16v(pDecoder, &pSchemaExt->colId));
  TAOS_CHECK_RETURN(tDecodeU32(pDecoder, &pSchemaExt->compress));
  TAOS_CHECK_RETURN(tDecodeI32(pDecoder, &pSchemaExt->typeMod));
  return 0;
}

static FORCE_INLINE int32_t tEncodeSColRef(SEncoder* pEncoder, const SColRef* pColRef) {
  TAOS_CHECK_RETURN(tEncodeI8(pEncoder, pColRef->hasRef));
  TAOS_CHECK_RETURN(tEncodeI16(pEncoder, pColRef->id));
  if (pColRef->hasRef) {
    TAOS_CHECK_RETURN(tEncodeCStr(pEncoder, pColRef->refDbName));
    TAOS_CHECK_RETURN(tEncodeCStr(pEncoder, pColRef->refTableName));
    TAOS_CHECK_RETURN(tEncodeCStr(pEncoder, pColRef->refColName));
  }
  return 0;
}

static FORCE_INLINE int32_t tDecodeSColRef(SDecoder* pDecoder, SColRef* pColRef) {
  pColRef->tagCondLen = 0;
  pColRef->tagCondJson = NULL;
  pColRef->filterCondLen = 0;
  pColRef->filterCondJson = NULL;
  pColRef->refType = 0;
  pColRef->refSourceName[0] = '\0';
  pColRef->refSchemaName[0] = '\0';
  TAOS_CHECK_RETURN(tDecodeI8(pDecoder, (int8_t*)&pColRef->hasRef));
  TAOS_CHECK_RETURN(tDecodeI16(pDecoder, &pColRef->id));
  if (pColRef->hasRef) {
    TAOS_CHECK_RETURN(tDecodeCStrTo(pDecoder, pColRef->refDbName));
    TAOS_CHECK_RETURN(tDecodeCStrTo(pDecoder, pColRef->refTableName));
    TAOS_CHECK_RETURN(tDecodeCStrTo(pDecoder, pColRef->refColName));
  }

  return 0;
}

static FORCE_INLINE int32_t tEncodeSColRefExt(SEncoder* pEncoder, const SColRef* pColRef) {
  if (pColRef->hasRef) {
    TAOS_CHECK_RETURN(tEncodeI8(pEncoder, pColRef->refType));
    TAOS_CHECK_RETURN(tEncodeCStr(pEncoder, pColRef->refSourceName));
    TAOS_CHECK_RETURN(tEncodeCStr(pEncoder, pColRef->refSchemaName));
    TAOS_CHECK_RETURN(tEncodeI32(pEncoder, pColRef->tagCondLen));
    if (pColRef->tagCondLen > 0) {
      TAOS_CHECK_RETURN(tEncodeBinary(pEncoder, (const uint8_t*)pColRef->tagCondJson, pColRef->tagCondLen));
    }
  }
  return 0;
}

static FORCE_INLINE int32_t tDecodeSColRefExt(SDecoder* pDecoder, SColRef* pColRef) {
  if (pColRef->hasRef) {
    TAOS_CHECK_RETURN(tDecodeI8(pDecoder, &pColRef->refType));
    TAOS_CHECK_RETURN(tDecodeCStrTo(pDecoder, pColRef->refSourceName));
    TAOS_CHECK_RETURN(tDecodeCStrTo(pDecoder, pColRef->refSchemaName));
    TAOS_CHECK_RETURN(tDecodeI32(pDecoder, &pColRef->tagCondLen));
    if (pColRef->tagCondLen > 0) {
      uint8_t* tmpBuf = NULL;
      uint32_t tmpLen = 0;
      TAOS_CHECK_RETURN(tDecodeBinary(pDecoder, &tmpBuf, &tmpLen));
      if ((int32_t)tmpLen != pColRef->tagCondLen) {
        return TSDB_CODE_INVALID_MSG;
      }
      pColRef->tagCondJson = (char*)taosMemoryMalloc(pColRef->tagCondLen + 1);
      if (pColRef->tagCondJson == NULL) {
        TAOS_CHECK_RETURN(terrno);
      }
      memcpy(pColRef->tagCondJson, tmpBuf, pColRef->tagCondLen);
      pColRef->tagCondJson[pColRef->tagCondLen] = '\0';
    }
  }

  return 0;
}

static FORCE_INLINE int32_t tEncodeSColRefFilterCond(SEncoder* pEncoder, const SColRef* pColRef) {
  int32_t len = pColRef->hasRef ? pColRef->filterCondLen : 0;
  if (len < 0 || (len > 0 && NULL == pColRef->filterCondJson)) {
    return TSDB_CODE_INVALID_MSG;
  }
  TAOS_CHECK_RETURN(tEncodeI32(pEncoder, len));
  if (len > 0) {
    TAOS_CHECK_RETURN(tEncodeBinary(pEncoder, (const uint8_t*)pColRef->filterCondJson, len));
  }
  return TSDB_CODE_SUCCESS;
}

static FORCE_INLINE int32_t tDecodeSColRefFilterCondRaw(SDecoder* pDecoder, SColRef* pColRef, uint8_t** ppBuf) {
  *ppBuf = NULL;
  TAOS_CHECK_RETURN(tDecodeI32(pDecoder, &pColRef->filterCondLen));
  if (pColRef->filterCondLen < 0 || (!pColRef->hasRef && pColRef->filterCondLen > 0)) {
    return TSDB_CODE_INVALID_MSG;
  }
  if (pColRef->filterCondLen > 0) {
    uint32_t len = 0;
    TAOS_CHECK_RETURN(tDecodeBinary(pDecoder, ppBuf, &len));
    if (len != (uint32_t)pColRef->filterCondLen) {
      return TSDB_CODE_INVALID_MSG;
    }
  }
  return TSDB_CODE_SUCCESS;
}

static FORCE_INLINE int32_t taosEncodeSSchemaWrapper(void** buf, const SSchemaWrapper* pSW) {
  int32_t tlen = 0;
  tlen += taosEncodeVariantI32(buf, pSW->nCols);
  tlen += taosEncodeVariantI32(buf, pSW->version);
  for (int32_t i = 0; i < pSW->nCols; i++) {
    tlen += taosEncodeSSchema(buf, &pSW->pSchema[i]);
  }
  return tlen;
}

static FORCE_INLINE void* taosDecodeSSchemaWrapper(const void* buf, SSchemaWrapper* pSW) {
  buf = taosDecodeVariantI32(buf, &pSW->nCols);
  buf = taosDecodeVariantI32(buf, &pSW->version);
  if (pSW->nCols > 0) {
    pSW->pSchema = (SSchema*)taosMemoryCalloc(pSW->nCols, sizeof(SSchema));
    if (pSW->pSchema == NULL) {
      return NULL;
    }

    for (int32_t i = 0; i < pSW->nCols; i++) {
      buf = taosDecodeSSchema(buf, &pSW->pSchema[i]);
    }
  } else {
    pSW->pSchema = NULL;
  }
  return (void*)buf;
}

static FORCE_INLINE int32_t tEncodeSSchemaWrapper(SEncoder* pEncoder, const SSchemaWrapper* pSW) {
  if (pSW == NULL) {
    return TSDB_CODE_INVALID_PARA;
  }
  TAOS_CHECK_RETURN(tEncodeI32v(pEncoder, pSW->nCols));
  TAOS_CHECK_RETURN(tEncodeI32v(pEncoder, pSW->version));
  for (int32_t i = 0; i < pSW->nCols; i++) {
    TAOS_CHECK_RETURN(tEncodeSSchema(pEncoder, &pSW->pSchema[i]));
  }
  return 0;
}

static FORCE_INLINE int32_t tDecodeSSchemaWrapperImpl(SDecoder* pDecoder, SSchemaWrapper* pSW, bool decoderMalloc) {
  if (pSW == NULL) {
    return TSDB_CODE_INVALID_PARA;
  }
  TAOS_CHECK_RETURN(tDecodeI32v(pDecoder, &pSW->nCols));
  TAOS_CHECK_RETURN(tDecodeI32v(pDecoder, &pSW->version));

  pSW->pSchema = decoderMalloc ? (SSchema*)tDecoderMalloc(pDecoder, (int64_t)pSW->nCols * sizeof(SSchema))
                               : (SSchema*)taosMemoryCalloc(pSW->nCols, sizeof(SSchema));
  if (pSW->pSchema == NULL) {
    TAOS_RETURN(TSDB_CODE_OUT_OF_MEMORY);
  }
  for (int32_t i = 0; i < pSW->nCols; i++) {
    TAOS_CHECK_RETURN(tDecodeSSchema(pDecoder, &pSW->pSchema[i]));
  }

  return 0;
}

static FORCE_INLINE int32_t tDecodeSSchemaWrapper(SDecoder* pDecoder, SSchemaWrapper* pSW) {
  return tDecodeSSchemaWrapperImpl(pDecoder, pSW, false);
}

static FORCE_INLINE int32_t tDecodeSSchemaWrapperEx(SDecoder* pDecoder, SSchemaWrapper* pSW) {
  return tDecodeSSchemaWrapperImpl(pDecoder, pSW, true);
}

typedef struct {
  char     name[TSDB_TABLE_FNAME_LEN];
  int8_t   igExists;
  int8_t   source;  // TD_REQ_FROM_TAOX-taosX or TD_REQ_FROM_APP-taosClient
  int8_t   reserved[6];
  tb_uid_t suid;
  int64_t  delay1;
  int64_t  delay2;
  int64_t  watermark1;
  int64_t  watermark2;
  int32_t  ttl;
  int32_t  colVer;
  int32_t  tagVer;
  int32_t  numOfColumns;
  int32_t  numOfTags;
  int32_t  numOfFuncs;
  int32_t  commentLen;
  int32_t  ast1Len;
  int32_t  ast2Len;
  SArray*  pColumns;  // array of SFieldWithOptions
  SArray*  pTags;     // array of SField
  SArray*  pFuncs;
  char*    pComment;
  char*    pAst1;
  char*    pAst2;
  int64_t  deleteMark1;
  int64_t  deleteMark2;
  int32_t  sqlLen;
  char*    sql;
  int64_t  keep;
  int64_t  txnId;  // batch meta txn ID (0 = not in txn)
  int8_t   virtualStb;
  int8_t   secureDelete;
  int8_t   securityLevel;
  // VST inheritance
  int8_t   numParents;
  char     parentStbFNames[TSDB_MAX_VST_PARENTS][TSDB_TABLE_FNAME_LEN];
  int16_t  ownColStart;
  int16_t  ownTagStart;
} SMCreateStbReq;

int32_t tSerializeSMCreateStbReq(void* buf, int32_t bufLen, SMCreateStbReq* pReq);
int32_t tDeserializeSMCreateStbReq(void* buf, int32_t bufLen, SMCreateStbReq* pReq);
void    tFreeSMCreateStbReq(SMCreateStbReq* pReq);

typedef struct {
  STableMetaRsp* pMeta;
} SMCreateStbRsp;

int32_t tEncodeSMCreateStbRsp(SEncoder* pEncoder, const SMCreateStbRsp* pRsp);
int32_t tDecodeSMCreateStbRsp(SDecoder* pDecoder, SMCreateStbRsp* pRsp);
void    tFreeSMCreateStbRsp(SMCreateStbRsp* pRsp);

typedef struct {
  char     name[TSDB_TABLE_FNAME_LEN];
  int8_t   igNotExists;
  int8_t   source;  // TD_REQ_FROM_TAOX-taosX or TD_REQ_FROM_APP-taosClient
  int8_t   reserved[6];
  tb_uid_t suid;
  int32_t  sqlLen;
  char*    sql;
  int64_t  txnId;  // batch meta txn ID (0 = not in txn)
} SMDropStbReq;

int32_t tSerializeSMDropStbReq(void* buf, int32_t bufLen, SMDropStbReq* pReq);
int32_t tDeserializeSMDropStbReq(void* buf, int32_t bufLen, SMDropStbReq* pReq);
void    tFreeSMDropStbReq(SMDropStbReq* pReq);

typedef struct {
  char    name[TSDB_TABLE_FNAME_LEN];
  int8_t  alterType;
  int32_t numOfFields;
  SArray* pFields;
  int32_t ttl;
  int32_t commentLen;
  char*   comment;
  int32_t sqlLen;
  char*   sql;
  int64_t keep;
  int64_t txnId;  // batch meta txn ID (0 = not in txn)
  SArray* pTypeMods;
  int8_t  secureDelete;
  int8_t  securityLevel;
  // VST inheritance: for ADD_BASE_ON / DROP_BASE_ON
  int8_t   numParents;
  char     parentStbFNames[TSDB_MAX_VST_PARENTS][TSDB_TABLE_FNAME_LEN];
} SMAlterStbReq;

int32_t tSerializeSMAlterStbReq(void* buf, int32_t bufLen, SMAlterStbReq* pReq);
int32_t tDeserializeSMAlterStbReq(void* buf, int32_t bufLen, SMAlterStbReq* pReq);
void    tFreeSMAltertbReq(SMAlterStbReq* pReq);

typedef struct SEpSet {
  int8_t inUse;
  int8_t numOfEps;
  SEp    eps[TSDB_MAX_REPLICA];
} SEpSet;

int32_t tEncodeSEpSet(SEncoder* pEncoder, const SEpSet* pEp);
int32_t tDecodeSEpSet(SDecoder* pDecoder, SEpSet* pEp);
int32_t taosEncodeSEpSet(void** buf, const SEpSet* pEp);
void*   taosDecodeSEpSet(const void* buf, SEpSet* pEp);

int32_t tSerializeSEpSet(void* buf, int32_t bufLen, const SEpSet* pEpset);
int32_t tDeserializeSEpSet(void* buf, int32_t buflen, SEpSet* pEpset);

typedef struct {
  int8_t  connType;
  int32_t pid;
  int32_t totpCode;
  char    app[TSDB_APP_NAME_LEN];
  char    db[TSDB_DB_NAME_LEN];
  char    user[TSDB_USER_LEN];
  char    passwd[TSDB_PASSWORD_LEN];
  char    token[TSDB_TOKEN_LEN];
  int64_t startTime;
  int64_t connectTime;
  char    sVer[TSDB_VERSION_LEN];
  char    signature[20]; // SHA1 produces a 20-byte signature
  char    saslToken[TSDB_TOKEN_LEN]; // one-time token from a completed SASL handshake (empty for legacy auth)
} SConnectReq;

int32_t tSerializeSConnectReq(void* buf, int32_t bufLen, SConnectReq* pReq);
int32_t tDeserializeSConnectReq(void* buf, int32_t bufLen, SConnectReq* pReq);
void    tSignConnectReq(SConnectReq* pReq);
int32_t tVerifyConnectReqSignature(const SConnectReq* pReq);

typedef struct {
  int64_t       clusterId;
  int32_t       acctId;
  uint32_t      connId;
  int32_t       dnodeNum;
  int8_t        superUser;
  int8_t        sysInfo;
  int8_t        connType;
  int8_t        enableAuditDelete;
  SEpSet        epSet;
  int32_t       svrTimestamp;
  int32_t       passVer;
  int32_t       authVer;
  char          sVer[TSDB_VERSION_LEN];
  char          sDetailVer[128];
  int64_t       whiteListVer;
  int64_t       timeWhiteListVer;
  int64_t       userId;
  SMonitorParas monitorParas;
  char          user[TSDB_USER_LEN];
  char          tokenName[TSDB_TOKEN_NAME_LEN];
  int8_t        enableAuditSelect;
  int8_t        enableAuditInsert;
  int8_t        auditLevel;
  union {
    uint32_t flags;
    struct {
      uint32_t minSecLevel : 3;  // per-user
      uint32_t maxSecLevel : 3;  // per-user
      uint32_t sodInitial  : 1;  // cluster-wide: 1 = SoD still in initial phase
      uint32_t macActive   : 1;  // cluster-wide: 1 = MAC mandatory mode activated
      uint32_t reserved    : 24;
    };
  };
} SConnectRsp;

int32_t tSerializeSConnectRsp(void* buf, int32_t bufLen, SConnectRsp* pRsp);
int32_t tDeserializeSConnectRsp(void* buf, int32_t bufLen, SConnectRsp* pRsp);

// One round of a SASL (SCRAM-SHA-256) authentication handshake. The `data` field carries the opaque
// SASL token produced by gsasl_step64() and is shuttled verbatim between client and server; neither
// side interprets it. The handshake repeats (TDMT_MND_AUTH_SASL) until the response sets done=1.
typedef struct {
  char     mech[TSDB_SASL_MECH_LEN];     // SASL mechanism, e.g. "SCRAM-SHA-256"
  char     user[TSDB_USER_LEN];          // login user; used to look up credentials on the first round
  char     authId[TSDB_SASL_AUTH_ID_LEN];// server-assigned handshake id; empty on the first round
  char     sVer[TSDB_VERSION_LEN];       // client version, for compatibility checks
  int32_t  dataLen;                      // opaque SASL payload length
  uint8_t* data;                         // opaque SASL payload (gsasl_step64 output, base64 text)
} SSaslStepReq;

int32_t tSerializeSSaslStepReq(void* buf, int32_t bufLen, SSaslStepReq* pReq);
int32_t tDeserializeSSaslStepReq(void* buf, int32_t bufLen, SSaslStepReq* pReq);
void    tFreeSSaslStepReq(SSaslStepReq* pReq);

typedef struct {
  char     authId[TSDB_SASL_AUTH_ID_LEN];// echo back on the next round
  int8_t   done;                         // 1 when the handshake has succeeded
  int32_t  dataLen;
  uint8_t* data;                         // opaque SASL payload
  char     authToken[TSDB_TOKEN_LEN];    // short-lived token issued on success to drive CONNECT
} SSaslStepRsp;

int32_t tSerializeSSaslStepRsp(void* buf, int32_t bufLen, SSaslStepRsp* pRsp);
int32_t tDeserializeSSaslStepRsp(void* buf, int32_t bufLen, SSaslStepRsp* pRsp);
void    tFreeSSaslStepRsp(SSaslStepRsp* pRsp);

typedef struct {
  char    user[TSDB_USER_LEN];
  char    pass[TSDB_PASSWORD_LEN];
  int32_t maxUsers;
  int32_t maxDbs;
  int32_t maxTimeSeries;
  int32_t maxStreams;
  int32_t accessState;  // Configured only by command
  int64_t maxStorage;
} SCreateAcctReq, SAlterAcctReq;

// int32_t tSerializeSCreateAcctReq(void* buf, int32_t bufLen, SCreateAcctReq* pReq);
// int32_t tDeserializeSCreateAcctReq(void* buf, int32_t bufLen, SCreateAcctReq* pReq);

typedef struct {
  char    user[TSDB_USER_LEN];
  int8_t  ignoreNotExists;
  int32_t sqlLen;
  char*   sql;
} SDropUserReq, SDropAcctReq;

int32_t tSerializeSDropUserReq(void* buf, int32_t bufLen, SDropUserReq* pReq);
int32_t tDeserializeSDropUserReq(void* buf, int32_t bufLen, SDropUserReq* pReq);
void    tFreeSDropUserReq(SDropUserReq* pReq);

typedef struct {
  char name[TSDB_ROLE_LEN];
  union {
    uint8_t flag;
    struct {
      uint8_t ignoreExists : 1;
      uint8_t reserve : 7;
    };
  };
  int32_t sqlLen;
  char*   sql;
} SCreateRoleReq;

int32_t tSerializeSCreateRoleReq(void* buf, int32_t bufLen, SCreateRoleReq* pReq);
int32_t tDeserializeSCreateRoleReq(void* buf, int32_t bufLen, SCreateRoleReq* pReq);
void    tFreeSCreateRoleReq(SCreateRoleReq* pReq);

typedef struct {
  char name[TSDB_ROLE_LEN];
  union {
    uint8_t flag;
    struct {
      uint8_t ignoreNotExists : 1;
      uint8_t reserve : 7;
    };
  };
  int32_t sqlLen;
  char*   sql;
} SDropRoleReq;

int32_t tSerializeSDropRoleReq(void* buf, int32_t bufLen, SDropRoleReq* pReq);
int32_t tDeserializeSDropRoleReq(void* buf, int32_t bufLen, SDropRoleReq* pReq);
void    tFreeSDropRoleReq(SDropRoleReq* pReq);

typedef struct {
  SPrivSet privSet;
  SArray*  selectCols;  // SColIdNameKV, for table privileges
  SArray*  insertCols;  // SColIdNameKV, for table privileges
  SArray*  updateCols;  // SColIdNameKV, for table privileges
  // delete can only specify conditions by cond and cannot specify columns
  char*    cond;     // for table privileges
  int32_t  condLen;  // for table privileges
} SPrivSetReqArgs;

typedef struct {
  uint8_t alterType;  // TSDB_ALTER_ROLE_LOCK, TSDB_ALTER_ROLE_ROLE, TSDB_ALTER_ROLE_PRIVILEGES
  uint8_t objType;    // none, db, table, view, rsma, topic, etc.
  union {
    uint32_t flag;
    struct {
      uint32_t lock : 1;     // lock or unlock role
      uint32_t add : 1;      // add or remove
      uint32_t sysPriv : 1;  // system or object privileges
      uint32_t objLevel : 2;
      uint32_t ignoreNotExists : 1;
      uint32_t reserve : 26;
    };
  };
  union {
    SPrivSetReqArgs privileges;
    char            roleName[TSDB_ROLE_LEN];
  };
  char    principal[TSDB_ROLE_LEN];      // role or user name
  char    objFName[TSDB_OBJ_FNAME_LEN];  // db
  char    tblName[TSDB_TABLE_NAME_LEN];  // none, table, view, rsma, topic, etc.
  int32_t sqlLen;
  char*   sql;
} SAlterRoleReq;

int32_t tSerializeSAlterRoleReq(void* buf, int32_t bufLen, SAlterRoleReq* pReq);
int32_t tDeserializeSAlterRoleReq(void* buf, int32_t bufLen, SAlterRoleReq* pReq);
void    tFreeSAlterRoleReq(SAlterRoleReq* pReq);

typedef struct {
  char    algorithmId[TSDB_ENCRYPT_ALGR_NAME_LEN];
  int32_t sqlLen;
  char*   sql;
} SDropEncryptAlgrReq;

int32_t tSerializeSDropEncryptAlgrReq(void* buf, int32_t bufLen, SDropEncryptAlgrReq* pReq);
int32_t tDeserializeSDropEncryptAlgrReq(void* buf, int32_t bufLen, SDropEncryptAlgrReq* pReq);
void    tFreeSDropEncryptAlgrReq(SDropEncryptAlgrReq* pReq);

typedef struct SIpV4Range {
  uint32_t ip;
  uint32_t mask;
} SIpV4Range;

typedef struct SIpv6Range {
  uint64_t addr[2];
  uint32_t mask;
} SIpV6Range;

typedef struct {
  int8_t type;   // 0: IPv4, 1: IPv6
  int8_t neg;    // only used in SIpWhiteListDual, if neg is 1, means this is a blacklist entry
  union {
    SIpV4Range ipV4;
    SIpV6Range ipV6;
  };
} SIpRange;

typedef struct {
  int32_t    num;
  SIpV4Range pIpRange[];
} SIpWhiteList;

typedef struct {
  int32_t  num;
  SIpRange pIpRanges[];
} SIpWhiteListDual;

SIpWhiteListDual* cloneIpWhiteList(const SIpWhiteListDual* src);
int32_t           cvtIpWhiteListToDual(SIpWhiteList* pWhiteList, SIpWhiteListDual** pWhiteListDual);
int32_t           cvtIpWhiteListDualToV4(SIpWhiteListDual* pWhiteListDual, SIpWhiteList** pWhiteList);
int32_t           createDefaultIp6Range(SIpRange* pRange);
int32_t           createDefaultIp4Range(SIpRange* pRange);

typedef struct {
  int32_t sessPerUser;
  int32_t sessConnTime;
  int32_t sessConnIdleTime;
  int32_t sessMaxConcurrency;
  int32_t sessMaxCallVnodeNum;
} SUserSessCfg;

void initUserDefautSessCfg(SUserSessCfg* pCfg);
// copyIpRange ensures that unused bytes are always zeroed, so that [pDst] can be used as a key in hash tables
void copyIpRange(SIpRange* pDst, const SIpRange* pSrc);

// SDateTimeRange is used in client side during SQL statement parsing, client sends this structure
// to server, and server will convert it to SDateTimeWhiteListItem for internal usage.
typedef struct {
  int16_t year;
  int8_t month; // 1-12, when month is -1, it means day is week day and year is not used.
  int8_t day;   // 1-31 or 0-6 (0 means Sunday), depends on the month value.
  int8_t hour;
  int8_t minute;
  int8_t neg;   // this is a negative entry
  int32_t duration; // duration in minute
} SDateTimeRange;

bool isValidDateTimeRange(SDateTimeRange* pRange);
int32_t tEncodeSDateTimeRange(SEncoder* pEncoder, const SDateTimeRange* pRange);
int32_t tDecodeSDateTimeRange(SDecoder* pDecoder, SDateTimeRange* pRange);

// SDateTimeWhiteListItem is used by server internally to represent datetime ranges.
typedef struct {
  bool absolute;    // true: absolute datetime range; false: weekly recurring datetime range
  bool neg;         // this is a negative entry
  int32_t duration; // duration in seconds
  int64_t start;    // absolute timestamp in seconds or weekly offset in seconds
} SDateTimeWhiteListItem;

void DateTimeRangeToWhiteListItem(SDateTimeWhiteListItem* dst, const SDateTimeRange* src);
bool isDateTimeWhiteListItemExpired(const SDateTimeWhiteListItem* item);

typedef struct {
  int32_t num;
  SDateTimeWhiteListItem ranges[];
} SDateTimeWhiteList;

SDateTimeWhiteList* cloneDateTimeWhiteList(const SDateTimeWhiteList* src);
bool isTimeInDateTimeWhiteList(const SDateTimeWhiteList *wl, int64_t tm);


// SCRAM-SHA-256 credentials. When algo==TSDB_SCRAM_ALGO_SHA256, the client has
// pre-derived the credentials locally and the server stores them directly  -  the
// password hash is never sent over the wire.
typedef struct {
  int8_t  algo;     // TSDB_SCRAM_ALGO_*
  int32_t iter;     // PBKDF2 iteration count
  int32_t saltLen;  // length of salt actually used
  uint8_t salt[TSDB_SCRAM_SALT_LEN];
  uint8_t storedKey[TSDB_SCRAM_KEY_LEN];
  uint8_t serverKey[TSDB_SCRAM_KEY_LEN];
} SScramCred;

void tDeriveScramCred(const char *passHash, SScramCred *pScram);

typedef struct {
  int8_t createType;

  int8_t hasSessionPerUser;
  int8_t hasConnectTime;
  int8_t hasConnectIdleTime;
  int8_t hasCallPerSession;
  int8_t hasVnodePerCall;
  int8_t hasFailedLoginAttempts;
  int8_t hasPasswordLifeTime;
  int8_t hasPasswordReuseTime;
  int8_t hasPasswordReuseMax;
  int8_t hasPasswordLockTime;
  int8_t hasPasswordGraceTime;
  int8_t hasInactiveAccountTime;
  int8_t hasAllowTokenNum;
  int8_t hasSecurityLevel;

  int8_t superUser;  // denote if it is a super user or not
  int8_t ignoreExists;

  char   user[TSDB_USER_LEN];
  char   pass[TSDB_PASSWORD_LEN];
  int8_t isComplexPass;
  int8_t isSimplePass;
  int8_t isDefaultPass;
  int16_t passLen;
  char   totpseed[TSDB_USER_TOTPSEED_MAX_LEN + 1];

  int8_t sysInfo;
  int8_t createDb;
  int8_t isImport;
  int8_t changepass;
  int8_t enable;
  int8_t minSecLevel;
  int8_t maxSecLevel;

  int8_t negIpRanges;
  int8_t negTimeRanges;

  int32_t sessionPerUser;
  int32_t connectTime;
  int32_t connectIdleTime;
  int32_t callPerSession;
  int32_t vnodePerCall;
  int32_t failedLoginAttempts;
  int32_t passwordLifeTime;
  int32_t passwordReuseTime;
  int32_t passwordReuseMax;
  int32_t passwordLockTime;
  int32_t passwordGraceTime;
  int32_t inactiveAccountTime;
  int32_t allowTokenNum;

  int32_t         numIpRanges;
  SIpRange*       pIpDualRanges;
  int32_t         numTimeRanges;
  SDateTimeRange* pTimeRanges;

  int32_t sqlLen;
  char*   sql;
  SScramCred scram;
} SCreateUserReq;

int32_t tSerializeSCreateUserReq(void* buf, int32_t bufLen, SCreateUserReq* pReq);
int32_t tDeserializeSCreateUserReq(void* buf, int32_t bufLen, SCreateUserReq* pReq);
void    tFreeSCreateUserReq(SCreateUserReq* pReq);

typedef struct {
  char    algorithmId[TSDB_ENCRYPT_ALGR_NAME_LEN];
  char    name[TSDB_ENCRYPT_ALGR_NAME_LEN];
  char    desc[TSDB_ENCRYPT_ALGR_DESC_LEN];
  char    type[TSDB_ENCRYPT_ALGR_TYPE_LEN];
  char    osslAlgrName[TSDB_ENCRYPT_ALGR_NAME_LEN];
  int32_t sqlLen;
  char*   sql;
} SCreateEncryptAlgrReq;

int32_t tSerializeSCreateEncryptAlgrReq(void* buf, int32_t bufLen, SCreateEncryptAlgrReq* pReq);
int32_t tDeserializeSCreateEncryptAlgrReq(void* buf, int32_t bufLen, SCreateEncryptAlgrReq* pReq);
void    tFreeSCreateEncryptAlgrReq(SCreateEncryptAlgrReq* pReq);

typedef struct {
  int32_t dnodeId;
  int64_t analVer;
} SRetrieveAnalyticsAlgoReq;

typedef struct {
  int64_t   ver;
  SHashObj* hash;  // algoname:algotype -> SAnalUrl
} SRetrieveAnalyticAlgoRsp;

int32_t tSerializeRetrieveAnalyticAlgoReq(void* buf, int32_t bufLen, SRetrieveAnalyticsAlgoReq* pReq);
int32_t tDeserializeRetrieveAnalyticAlgoReq(void* buf, int32_t bufLen, SRetrieveAnalyticsAlgoReq* pReq);
int32_t tSerializeRetrieveAnalyticAlgoRsp(void* buf, int32_t bufLen, SRetrieveAnalyticAlgoRsp* pRsp);
int32_t tDeserializeRetrieveAnalyticAlgoRsp(void* buf, int32_t bufLen, SRetrieveAnalyticAlgoRsp* pRsp);
void    tFreeRetrieveAnalyticAlgoRsp(SRetrieveAnalyticAlgoRsp* pRsp);

typedef struct {
  int8_t alterType;

  int8_t isView;

  int8_t hasPassword;
  int8_t hasTotpseed;
  int8_t hasEnable;
  int8_t hasSysinfo;
  int8_t hasCreatedb;
  int8_t hasChangepass;
  int8_t hasSessionPerUser;
  int8_t hasConnectTime;
  int8_t hasConnectIdleTime;
  int8_t hasCallPerSession;
  int8_t hasVnodePerCall;
  int8_t hasFailedLoginAttempts;
  int8_t hasPasswordLifeTime;
  int8_t hasPasswordReuseTime;
  int8_t hasPasswordReuseMax;
  int8_t hasPasswordLockTime;
  int8_t hasPasswordGraceTime;
  int8_t hasInactiveAccountTime;
  int8_t hasAllowTokenNum;
  int8_t hasSecurityLevel;

  int8_t enable;
  int8_t sysinfo;
  int8_t createdb;
  int8_t changepass;
  int8_t minSecLevel;
  int8_t maxSecLevel;

  char   user[TSDB_USER_LEN];
  char   pass[TSDB_PASSWORD_LEN];
  int8_t isComplexPass;
  int8_t isSimplePass;
  int8_t isDefaultPass;
  int16_t passLen;
  char   totpseed[TSDB_USER_TOTPSEED_MAX_LEN + 1];
  int32_t sessionPerUser;
  int32_t connectTime;
  int32_t connectIdleTime;
  int32_t callPerSession;
  int32_t vnodePerCall;
  int32_t failedLoginAttempts;
  int32_t passwordLifeTime;
  int32_t passwordReuseTime;
  int32_t passwordReuseMax;
  int32_t passwordLockTime;
  int32_t passwordGraceTime;
  int32_t inactiveAccountTime;
  int32_t allowTokenNum;

  int32_t         numIpRanges;
  int32_t         numTimeRanges;
  int32_t         numDropIpRanges;
  int32_t         numDropTimeRanges;
  SIpRange*       pIpRanges;
  SDateTimeRange* pTimeRanges;
  SIpRange*       pDropIpRanges;
  SDateTimeRange* pDropTimeRanges;
  SPrivSet        privileges;

  char        objname[TSDB_OBJ_FNAME_LEN];  // db or topic
  char        tabName[TSDB_TABLE_NAME_LEN];
  char*       tagCond;
  int32_t     tagCondLen;
  int32_t     sqlLen;
  char*       sql;
  SScramCred  scram;
} SAlterUserReq;

int32_t tSerializeSAlterUserReq(void* buf, int32_t bufLen, SAlterUserReq* pReq);
int32_t tDeserializeSAlterUserReq(void* buf, int32_t bufLen, SAlterUserReq* pReq);
void    tFreeSAlterUserReq(SAlterUserReq* pReq);

typedef struct {
  char    name[TSDB_TOKEN_NAME_LEN];
  char    user[TSDB_USER_LEN];
  int8_t  enable;
  int8_t  ignoreExists;
  int32_t ttl;
  char    provider[TSDB_TOKEN_PROVIDER_LEN];
  char    extraInfo[TSDB_TOKEN_EXTRA_INFO_LEN];

  int32_t sqlLen;
  char*   sql;
} SCreateTokenReq;

int32_t tSerializeSCreateTokenReq(void* buf, int32_t bufLen, SCreateTokenReq* pReq);
int32_t tDeserializeSCreateTokenReq(void* buf, int32_t bufLen, SCreateTokenReq* pReq);
void    tFreeSCreateTokenReq(SCreateTokenReq* pReq);

typedef struct {
  char name[TSDB_TOKEN_NAME_LEN];
  char user[TSDB_USER_LEN];
  char token[TSDB_TOKEN_LEN];
} SCreateTokenRsp;

int32_t tSerializeSCreateTokenResp(void* buf, int32_t bufLen, SCreateTokenRsp* pRsp);
int32_t tDeserializeSCreateTokenResp(void* buf, int32_t bufLen, SCreateTokenRsp* pRsp);
void    tFreeSCreateTokenResp(SCreateTokenRsp* pRsp);

typedef struct {
  char    name[TSDB_TOKEN_NAME_LEN];

  int8_t hasEnable;
  int8_t hasTtl;
  int8_t hasProvider;
  int8_t hasExtraInfo;

  int8_t  enable;
  int32_t ttl;
  char    provider[TSDB_TOKEN_PROVIDER_LEN];
  char    extraInfo[TSDB_TOKEN_EXTRA_INFO_LEN];

  int32_t     sqlLen;
  char*       sql;
} SAlterTokenReq;

int32_t tSerializeSAlterTokenReq(void* buf, int32_t bufLen, SAlterTokenReq* pReq);
int32_t tDeserializeSAlterTokenReq(void* buf, int32_t bufLen, SAlterTokenReq* pReq);
void    tFreeSAlterTokenReq(SAlterTokenReq* pReq);

typedef struct {
  char    name[TSDB_TOKEN_NAME_LEN];
  int8_t  ignoreNotExists;
  int32_t sqlLen;
  char*   sql;
} SDropTokenReq;

int32_t tSerializeSDropTokenReq(void* buf, int32_t bufLen, SDropTokenReq* pReq);
int32_t tDeserializeSDropTokenReq(void* buf, int32_t bufLen, SDropTokenReq* pReq);
void    tFreeSDropTokenReq(SDropTokenReq* pReq);

typedef struct {
  char    user[TSDB_USER_LEN];
  int32_t sqlLen;
  char*   sql;
} SCreateTotpSecretReq;

int32_t tSerializeSCreateTotpSecretReq(void* buf, int32_t bufLen, SCreateTotpSecretReq* pReq);
int32_t tDeserializeSCreateTotpSecretReq(void* buf, int32_t bufLen, SCreateTotpSecretReq* pReq);
void    tFreeSCreateTotpSecretReq(SCreateTotpSecretReq* pReq);

typedef struct {
  char user[TSDB_USER_LEN];
  char totpSecret[(TSDB_TOTP_SECRET_LEN * 8 + 4) / 5 + 1];  // base32 encoded totp secret + null terminator
} SCreateTotpSecretRsp;

int32_t tSerializeSCreateTotpSecretRsp(void* buf, int32_t bufLen, SCreateTotpSecretRsp* pRsp);
int32_t tDeserializeSCreateTotpSecretRsp(void* buf, int32_t bufLen, SCreateTotpSecretRsp* pRsp);

typedef SCreateTotpSecretReq SDropTotpSecretReq;
#define tSerializeSDropTotpSecretReq tSerializeSCreateTotpSecretReq
#define tDeserializeSDropTotpSecretReq tDeserializeSCreateTotpSecretReq
#define tFreeSDropTotpSecretReq tFreeSCreateTotpSecretReq

typedef struct {
  char user[TSDB_USER_LEN];
} SGetUserAuthReq;

int32_t tSerializeSGetUserAuthReq(void* buf, int32_t bufLen, SGetUserAuthReq* pReq);
int32_t tDeserializeSGetUserAuthReq(void* buf, int32_t bufLen, SGetUserAuthReq* pReq);

typedef struct {
  int8_t  enabled;
  int32_t expireTime;
} STokenStatus;

typedef struct {
  char    user[TSDB_USER_LEN];
  int64_t userId;
  int32_t version;
  int32_t passVer;
  int8_t  superAuth;
  int8_t  sysInfo;
  int8_t  enable;
  int8_t  dropped;
  union {
    uint8_t flags;
    struct {
      uint8_t minSecLevel    : 3;
      uint8_t withInsertCond : 1;
      uint8_t maxSecLevel    : 3;
      uint8_t reserved       : 1;
    };
  };
  SPrivSet  sysPrivs;
  SHashObj* objPrivs;
  SHashObj* selectTbs;
  SHashObj* insertTbs;
  SHashObj* deleteTbs;
  SHashObj* ownedDbs;
  int64_t   whiteListVer;

  SUserSessCfg sessCfg;
  int64_t      timeWhiteListVer;
  SHashObj*    tokens;
} SGetUserAuthRsp;

int32_t tSerializeSGetUserAuthRsp(void* buf, int32_t bufLen, SGetUserAuthRsp* pRsp);
int32_t tDeserializeSGetUserAuthRsp(void* buf, int32_t bufLen, SGetUserAuthRsp* pRsp);
void    tFreeSGetUserAuthRsp(SGetUserAuthRsp* pRsp);

int32_t tSerializePrivSysObjPolicies(SEncoder* pEncoder, SPrivSet* sysPriv, SHashObj* pHash);
int32_t tDeserializePrivSysObjPolicies(SDecoder* pDecoder, SPrivSet* sysPriv, SHashObj** pHash);
int32_t tSerializePrivTblPolicies(SEncoder* pEncoder, SHashObj* pHash);
int32_t tDeserializePrivTblPolicies(SDecoder* pDecoder, SHashObj** pHash);

int32_t tSerializeIpRange(SEncoder* encoder, SIpRange* pRange);
int32_t tDeserializeIpRange(SDecoder* decoder, SIpRange* pRange, bool supportNeg);
typedef struct {
  int64_t ver;
  char    user[TSDB_USER_LEN];
  int32_t numOfRange;
  union {
    SIpV4Range* pIpRanges;
    SIpRange*   pIpDualRanges;
  };
} SUpdateUserIpWhite;

typedef struct {
  int64_t             ver;
  int                 numOfUser;
  SUpdateUserIpWhite* pUserIpWhite;
} SUpdateIpWhite;

int32_t tSerializeSUpdateIpWhite(void* buf, int32_t bufLen, SUpdateIpWhite* pReq);
int32_t tDeserializeSUpdateIpWhite(void* buf, int32_t bufLen, SUpdateIpWhite* pReq);
void    tFreeSUpdateIpWhiteReq(SUpdateIpWhite* pReq);
int32_t cloneSUpdateIpWhiteReq(SUpdateIpWhite* pReq, SUpdateIpWhite** pUpdate);

int32_t tSerializeSUpdateIpWhiteDual(void* buf, int32_t bufLen, SUpdateIpWhite* pReq);
int32_t tDeserializeSUpdateIpWhiteDual(void* buf, int32_t bufLen, SUpdateIpWhite* pReq);
void    tFreeSUpdateIpWhiteDualReq(SUpdateIpWhite* pReq);


// SRetrieveWhiteListReq is used to retrieve both ip and datetime whitelist, but the
// corresponding response struct is different.
typedef struct {
  int64_t ver;
} SRetrieveWhiteListReq;

int32_t tSerializeRetrieveWhiteListReq(void* buf, int32_t bufLen, SRetrieveWhiteListReq* pReq);
int32_t tDeserializeRetrieveWhiteListReq(void* buf, int32_t bufLen, SRetrieveWhiteListReq* pReq);


// SGetUserWhiteListReq is used to get both ip and datetime whitelist, but the
// corresponding response struct is different.
typedef struct {
  char user[TSDB_USER_LEN];
} SGetUserWhiteListReq;

int32_t tSerializeSGetUserWhiteListReq(void* buf, int32_t bufLen, SGetUserWhiteListReq* pReq);
int32_t tDeserializeSGetUserWhiteListReq(void* buf, int32_t bufLen, SGetUserWhiteListReq* pReq);

typedef struct {
  char    user[TSDB_USER_LEN];
  int32_t numWhiteLists;
  union {
    SIpV4Range* pWhiteLists;
    SIpRange*   pWhiteListsDual;
  };
} SGetUserIpWhiteListRsp;

int32_t tIpStrToUint(const SIpAddr* addr, SIpRange* range);
int32_t tIpUintToStr(const SIpRange* range, SIpAddr* addr);
int32_t tIpRangeSetMask(SIpRange* range, int32_t mask);
void    tIpRangeSetDefaultMask(SIpRange* range);

int32_t tSerializeSGetUserIpWhiteListRsp(void* buf, int32_t bufLen, SGetUserIpWhiteListRsp* pRsp);
int32_t tDeserializeSGetUserIpWhiteListRsp(void* buf, int32_t bufLen, SGetUserIpWhiteListRsp* pRsp);
void    tFreeSGetUserIpWhiteListRsp(SGetUserIpWhiteListRsp* pRsp);

int32_t tSerializeSGetUserIpWhiteListDualRsp(void* buf, int32_t bufLen, SGetUserIpWhiteListRsp* pRsp);
int32_t tDeserializeSGetUserIpWhiteListDualRsp(void* buf, int32_t bufLen, SGetUserIpWhiteListRsp* pRsp);
void    tFreeSGetUserIpWhiteListDualRsp(SGetUserIpWhiteListRsp* pRsp);

typedef struct {
  int64_t ver;
  char    user[TSDB_USER_LEN];
  int32_t numWhiteLists;
  SDateTimeWhiteListItem* pWhiteLists;
} SUserDateTimeWhiteList;


int32_t tSerializeSUserDateTimeWhiteList(void* buf, int32_t bufLen, SUserDateTimeWhiteList* pRsp);
int32_t tDeserializeSUserDateTimeWhiteList(void* buf, int32_t bufLen, SUserDateTimeWhiteList* pRsp);
void    tFreeSUserDateTimeWhiteList(SUserDateTimeWhiteList* pRsp);
int32_t cloneSUserDateTimeWhiteList(const SUserDateTimeWhiteList* src, SUserDateTimeWhiteList* dest);

typedef struct {
  int64_t             ver;
  int                 numOfUser;
  SUserDateTimeWhiteList *pUsers;
} SRetrieveDateTimeWhiteListRsp;

int32_t tSerializeSRetrieveDateTimeWhiteListRsp(void* buf, int32_t bufLen, SRetrieveDateTimeWhiteListRsp* pRsp);
int32_t tDeserializeSRetrieveDateTimeWhiteListRsp(void* buf, int32_t bufLen, SRetrieveDateTimeWhiteListRsp* pRsp);
void    tFreeSRetrieveDateTimeWhiteListRsp(SRetrieveDateTimeWhiteListRsp* pRsp);
int32_t cloneDataTimeWhiteListRsp(const SRetrieveDateTimeWhiteListRsp* src, SRetrieveDateTimeWhiteListRsp** dest);

/*
 * for client side struct, only column id, type, bytes are necessary
 * But for data in vnode side, we need all the following information.
 */
typedef struct {
  union {
    col_id_t colId;
    int16_t  slotId;
  };

  uint8_t precision;
  uint8_t scale;
  int32_t bytes;
  int8_t  type;
  uint8_t pk;
  bool    noData;
} SColumnInfo;

typedef struct STimeWindow {
  TSKEY skey;
  TSKEY ekey;
} STimeWindow;

typedef struct SQueryHint {
  bool batchScan;
} SQueryHint;

typedef struct {
  int32_t tsOffset;       // offset value in current msg body, NOTE: ts list is compressed
  int32_t tsLen;          // total length of ts comp block
  int32_t tsNumOfBlocks;  // ts comp block numbers
  int32_t tsOrder;        // ts comp block order
} STsBufInfo;

typedef struct {
  void*       timezone;
  char        intervalUnit;
  char        slidingUnit;
  char        offsetUnit;
  int8_t      precision;
  int8_t      firstDayOfWeek;
  int64_t     interval;
  int64_t     sliding;
  int64_t     offset;
  STimeWindow timeRange;
} SInterval;

typedef struct STbVerInfo {
  char    tbFName[TSDB_TABLE_FNAME_LEN];
  int32_t sversion;
  int32_t tversion;
  int32_t rversion;  // virtual table's column ref's version
} STbVerInfo;

typedef struct {
  int32_t code;
  int64_t affectedRows;
  SArray* tbVerInfo;    // STbVerInfo
  char*   extErrMsg;    // federated query remote-side error string (NULL if no ext error)
  SExtPushdownDiagnostic* extPushdownDiag;  // optional structured pushdown diagnostic (NULL if absent)
} SQueryTableRsp;

int32_t tSerializeSQueryTableRsp(void* buf, int32_t bufLen, SQueryTableRsp* pRsp);

int32_t tDeserializeSQueryTableRsp(void* buf, int32_t bufLen, SQueryTableRsp* pRsp);

typedef struct {
  SMsgHead header;
  char     dbFName[TSDB_DB_FNAME_LEN];
  char     tbName[TSDB_TABLE_NAME_LEN];
  int64_t  txnId;  // batch meta txn: same-txn visibility for PRE_CREATE entries
} STableCfgReq;

typedef struct {
  char        tbName[TSDB_TABLE_NAME_LEN];
  char        stbName[TSDB_TABLE_NAME_LEN];
  char        dbFName[TSDB_DB_FNAME_LEN];
  int32_t     numOfTags;
  int32_t     numOfColumns;
  int8_t      tableType;
  int64_t     delay1;
  int64_t     delay2;
  int64_t     watermark1;
  int64_t     watermark2;
  int32_t     ttl;
  int32_t     keep;
  int64_t     ownerId;
  SArray*     pFuncs;
  int32_t     commentLen;
  char*       pComment;
  SSchema*    pSchemas;
  int32_t     tagsLen;
  char*       pTags;
  SSchemaExt* pSchemaExt;
  union {
    uint8_t flag;
    struct {
      uint8_t virtualStb : 1;  // no compatibility problem for little-endian arch
      uint8_t isAudit : 1;
      uint8_t securityLevel : 3;
      uint8_t reserve : 3;
    };
  };
  SColRef* pColRefs;
  int32_t  numOfTagRefs;
  SColRef* pTagRefs;
  int32_t       numOfSeries;
  SSeriesEntry* pSeries;
  int8_t   secureDelete;
  int8_t   numParents;
  char     parentStbNames[TSDB_MAX_VST_PARENTS][TSDB_TABLE_NAME_LEN];
  int16_t  ownColStart;  // index of first own (non-inherited) column; 0 when no inheritance
  int16_t  ownTagStart;  // index of first own (non-inherited) tag; 0 when no inheritance
} STableCfg;

typedef STableCfg STableCfgRsp;

int32_t tSerializeSTableCfgReq(void* buf, int32_t bufLen, STableCfgReq* pReq);
int32_t tDeserializeSTableCfgReq(void* buf, int32_t bufLen, STableCfgReq* pReq);

int32_t tSerializeSTableCfgRsp(void* buf, int32_t bufLen, STableCfgRsp* pRsp);
int32_t tDeserializeSTableCfgRsp(void* buf, int32_t bufLen, STableCfgRsp* pRsp);
void    tFreeSTableCfgRsp(STableCfgRsp* pRsp);

// VST leaf descendants query
typedef struct {
  char    dbFName[TSDB_DB_FNAME_LEN];
  int64_t suid;
} SVstLeavesReq;

typedef struct {
  char    dbFName[TSDB_DB_FNAME_LEN];
  char    stbName[TSDB_TABLE_NAME_LEN];
  int64_t suid;
} SVstLeafInfo;

typedef struct {
  int32_t       numLeaves;
  SVstLeafInfo* pLeaves;
} SVstLeavesRsp;

int32_t tSerializeSVstLeavesReq(void* buf, int32_t bufLen, SVstLeavesReq* pReq);
int32_t tDeserializeSVstLeavesReq(void* buf, int32_t bufLen, SVstLeavesReq* pReq);
int32_t tSerializeSVstLeavesRsp(void* buf, int32_t bufLen, SVstLeavesRsp* pRsp);
int32_t tDeserializeSVstLeavesRsp(void* buf, int32_t bufLen, SVstLeavesRsp* pRsp);
void    tFreeSVstLeavesRsp(SVstLeavesRsp* pRsp);

typedef struct {
  SMsgHead header;
  tb_uid_t suid;
} SVSubTablesReq;

int32_t tSerializeSVSubTablesReq(void* buf, int32_t bufLen, SVSubTablesReq* pReq);
int32_t tDeserializeSVSubTablesReq(void* buf, int32_t bufLen, SVSubTablesReq* pReq);

typedef struct {
  int32_t vgId;
  SArray* pTables;  // SArray<SVCTableRefCols*>
} SVSubTablesRsp;

int32_t tSerializeSVSubTablesRsp(void* buf, int32_t bufLen, SVSubTablesRsp* pRsp);
int32_t tDeserializeSVSubTablesRsp(void* buf, int32_t bufLen, SVSubTablesRsp* pRsp);
void    tDestroySVSubTablesRsp(void* rsp);

typedef struct {
  SMsgHead header;
  tb_uid_t suid;
} SVStbRefDbsReq;

int32_t tSerializeSVStbRefDbsReq(void* buf, int32_t bufLen, SVStbRefDbsReq* pReq);
int32_t tDeserializeSVStbRefDbsReq(void* buf, int32_t bufLen, SVStbRefDbsReq* pReq);

typedef struct {
  int32_t vgId;
  SArray* pDbs;         // SArray<char* (db name)>
  SArray* pExtSources;  // SArray<char* (ext source name)>
  // Resolved col-ref info synthesized in catalog for local planner/parser consumption only.
  // Not serialized in vnode wire format.
  int32_t      numOfColRefs;
  SRefColInfo* pColRefCols;  // Array[numOfColRefs]
  SColRef*     pResolvedColRefs;  // leaf refs, Array[numOfColRefs], catalog-local only
  // Tag ref info synthesized from first child (local only, not serialized in vnode wire format)
  int32_t      numOfTagRefs;
  SRefColInfo* pTagRefCols;  // Array[numOfTagRefs]
} SVStbRefDbsRsp;

int32_t tSerializeSVStbRefDbsRsp(void* buf, int32_t bufLen, SVStbRefDbsRsp* pRsp);
int32_t tDeserializeSVStbRefDbsRsp(void* buf, int32_t bufLen, SVStbRefDbsRsp* pRsp);
void    tDestroySVStbRefDbsRsp(void* rsp);

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  int32_t numOfVgroups;
  int32_t numOfStables;  // single_stable
  int32_t buffer;        // MB
  int32_t pageSize;
  int32_t pages;
  int32_t cacheLastSize;
  int32_t cacheLastShardBits;  // Number of shards for last cache LRU, -1 for auto
  int32_t daysPerFile;
  int32_t daysToKeep0;
  int32_t daysToKeep1;
  int32_t daysToKeep2;
  int32_t keepTimeOffset;
  int32_t minRows;
  int32_t maxRows;
  int32_t walFsyncPeriod;
  int8_t  walLevel;
  int8_t  precision;  // time resolution
  int8_t  compression;
  int8_t  replications;
  int8_t  strict;
  int8_t  cacheLast;
  int8_t  schemaless;
  int8_t  ignoreExist;
  int32_t numOfRetensions;
  SArray* pRetensions;  // SRetention
  int32_t walRetentionPeriod;
  int64_t walRetentionSize;
  int32_t walRollPeriod;
  int64_t walSegmentSize;
  int32_t sstTrigger;
  int16_t hashPrefix;
  int16_t hashSuffix;
  int32_t ssChunkSize;
  int32_t ssKeepLocal;
  int8_t  ssCompact;
  int32_t tsdbPageSize;
  int32_t sqlLen;
  char*   sql;
  int8_t  withArbitrator;
  int8_t  encryptAlgorithm;
  char    dnodeListStr[TSDB_DNODE_LIST_LEN];
  // 1. add auto-compact parameters
  int32_t compactInterval;    // minutes
  int32_t compactStartTime;   // minutes
  int32_t compactEndTime;     // minutes
  int8_t  compactTimeOffset;  // hour
  char    encryptAlgrName[TSDB_ENCRYPT_ALGR_NAME_LEN];
  int8_t  isAudit;
  int8_t  allowDrop;
  int8_t  secureDelete;
  int8_t  securityLevel;
} SCreateDbReq;

int32_t tSerializeSCreateDbReq(void* buf, int32_t bufLen, SCreateDbReq* pReq);
int32_t tDeserializeSCreateDbReq(void* buf, int32_t bufLen, SCreateDbReq* pReq);
void    tFreeSCreateDbReq(SCreateDbReq* pReq);

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  int32_t buffer;
  int32_t pageSize;
  int32_t pages;
  int32_t cacheLastSize;
  int32_t cacheLastShardBits;  // Number of shards for last cache LRU, -1 for auto
  int32_t daysPerFile;
  int32_t daysToKeep0;
  int32_t daysToKeep1;
  int32_t daysToKeep2;
  int32_t keepTimeOffset;
  int32_t walFsyncPeriod;
  int8_t  walLevel;
  int8_t  strict;
  int8_t  cacheLast;
  int8_t  replications;
  int32_t sstTrigger;
  int32_t minRows;
  int32_t walRetentionPeriod;
  int32_t walRetentionSize;
  int32_t ssKeepLocal;
  int8_t  ssCompact;
  int32_t sqlLen;
  char*   sql;
  int8_t  withArbitrator;
  // 1. add auto-compact parameters
  int32_t compactInterval;
  int32_t compactStartTime;
  int32_t compactEndTime;
  int8_t  compactTimeOffset;
  char    encryptAlgrName[TSDB_ENCRYPT_ALGR_NAME_LEN];
  int8_t  isAudit;
  int8_t  allowDrop;
  int8_t  secureDelete;  
  int8_t  securityLevel;
  int32_t parallel;       // group parallel concurrency limit for replica changes, 0 = unlimited
  int32_t maxRows;
} SAlterDbReq;

int32_t tSerializeSAlterDbReq(void* buf, int32_t bufLen, SAlterDbReq* pReq);
int32_t tDeserializeSAlterDbReq(void* buf, int32_t bufLen, SAlterDbReq* pReq);
void    tFreeSAlterDbReq(SAlterDbReq* pReq);

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  int8_t  ignoreNotExists;
  int8_t  force;
  int32_t sqlLen;
  char*   sql;
} SDropDbReq;

int32_t tSerializeSDropDbReq(void* buf, int32_t bufLen, SDropDbReq* pReq);
int32_t tDeserializeSDropDbReq(void* buf, int32_t bufLen, SDropDbReq* pReq);
void    tFreeSDropDbReq(SDropDbReq* pReq);

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  int64_t uid;
} SDropDbRsp;

int32_t tSerializeSDropDbRsp(void* buf, int32_t bufLen, SDropDbRsp* pRsp);
int32_t tDeserializeSDropDbRsp(void* buf, int32_t bufLen, SDropDbRsp* pRsp);

typedef struct {
  char    name[TSDB_MOUNT_NAME_LEN];
  int64_t uid;
} SDropMountRsp;

int32_t tSerializeSDropMountRsp(void* buf, int32_t bufLen, SDropMountRsp* pRsp);
int32_t tDeserializeSDropMountRsp(void* buf, int32_t bufLen, SDropMountRsp* pRsp);

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  int64_t dbId;
  int32_t vgVersion;
  int32_t numOfTable;  // unit is TSDB_TABLE_NUM_UNIT
  int64_t stateTs;     // ms
} SUseDbReq;

int32_t tSerializeSUseDbReq(void* buf, int32_t bufLen, SUseDbReq* pReq);
int32_t tDeserializeSUseDbReq(void* buf, int32_t bufLen, SUseDbReq* pReq);

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  int64_t uid;
  int32_t vgVersion;
  int32_t vgNum;
  int16_t hashPrefix;
  int16_t hashSuffix;
  int8_t  hashMethod;
  union {
    uint8_t flags;
    struct {
      uint8_t isMount : 1;  // TS-5868
      uint8_t padding : 7;
    };
  };
  SArray* pVgroupInfos;  // Array of SVgroupInfo
  int32_t errCode;
  int64_t stateTs;  // ms
  int8_t  precision;
} SUseDbRsp;

int32_t tSerializeSUseDbRsp(void* buf, int32_t bufLen, const SUseDbRsp* pRsp);
int32_t tDeserializeSUseDbRsp(void* buf, int32_t bufLen, SUseDbRsp* pRsp);
int32_t tSerializeSUseDbRspImp(SEncoder* pEncoder, const SUseDbRsp* pRsp);
int32_t tDeserializeSUseDbRspImp(SDecoder* pDecoder, SUseDbRsp* pRsp);
void    tFreeSUsedbRsp(SUseDbRsp* pRsp);

typedef struct {
  char db[TSDB_DB_FNAME_LEN];
} SDbCfgReq;

int32_t tSerializeSDbCfgReq(void* buf, int32_t bufLen, SDbCfgReq* pReq);
int32_t tDeserializeSDbCfgReq(void* buf, int32_t bufLen, SDbCfgReq* pReq);

typedef struct {
  char db[TSDB_DB_FNAME_LEN];
} SSsMigrateDbReq;

int32_t tSerializeSSsMigrateDbReq(void* buf, int32_t bufLen, SSsMigrateDbReq* pReq);
int32_t tDeserializeSSsMigrateDbReq(void* buf, int32_t bufLen, SSsMigrateDbReq* pReq);

typedef struct {
  int32_t ssMigrateId;
  bool    bAccepted;
} SSsMigrateDbRsp;

int32_t tSerializeSSsMigrateDbRsp(void* buf, int32_t bufLen, SSsMigrateDbRsp* pRsp);
int32_t tDeserializeSSsMigrateDbRsp(void* buf, int32_t bufLen, SSsMigrateDbRsp* pRsp);

// Request and response for TDMT_VND_LIST_SSMIGRATE_FILESETS
typedef struct {
  int32_t ssMigrateId;
} SListSsMigrateFileSetsReq;

int32_t tSerializeSListSsMigrateFileSetsReq(void* buf, int32_t bufLen, SListSsMigrateFileSetsReq* pReq);
int32_t tDeserializeSListSsMigrateFileSetsReq(void* buf, int32_t bufLen, SListSsMigrateFileSetsReq* pReq);

typedef struct {
  int32_t ssMigrateId;
  int32_t vgId;       // vgroup id
  SArray* pFileSets;  // SArray<int32_t>
} SListSsMigrateFileSetsRsp;

int32_t tSerializeSListSsMigrateFileSetsRsp(void* buf, int32_t bufLen, SListSsMigrateFileSetsRsp* pRsp);
int32_t tDeserializeSListSsMigrateFileSetsRsp(void* buf, int32_t bufLen, SListSsMigrateFileSetsRsp* pRsp);
void    tFreeSListSsMigrateFileSetsRsp(SListSsMigrateFileSetsRsp* pRsp);

// Request and response for TDMT_VND_SSMIGRATE_FILESET
typedef struct {
  int32_t ssMigrateId;
  int32_t nodeId;  // node id of the leader vnode, filled by vnode
  int32_t fid;
  int64_t startTimeSec;
} SSsMigrateFileSetReq;

int32_t tSerializeSSsMigrateFileSetReq(void* buf, int32_t bufLen, SSsMigrateFileSetReq* pReq);
int32_t tDeserializeSSsMigrateFileSetReq(void* buf, int32_t bufLen, SSsMigrateFileSetReq* pReq);

typedef struct {
  int32_t ssMigrateId;
  int32_t nodeId;  // node id of the leader vnode
  int32_t vgId;
  int32_t fid;
} SSsMigrateFileSetRsp;

int32_t tSerializeSSsMigrateFileSetRsp(void* buf, int32_t bufLen, SSsMigrateFileSetRsp* pRsp);
int32_t tDeserializeSSsMigrateFileSetRsp(void* buf, int32_t bufLen, SSsMigrateFileSetRsp* pRsp);

#define SSMIGRATE_FILESET_STATE_IN_PROGRESS 0
#define SSMIGRATE_FILESET_STATE_SUCCEEDED   1
#define SSMIGRATE_FILESET_STATE_COMPACT     2
#define SSMIGRATE_FILESET_STATE_SKIPPED     3
#define SSMIGRATE_FILESET_STATE_FAILED      4

// Request and response for TDMT_VND_QUERY_SSMIGRATE_PROGRESS and TDMT_VND_FOLLOWER_SSMIGRATE
// Note this struct is reused as both request and response in TDMT_VND_QUERY_SSMIGRATE_PROGRESS,
// while as a request, the 'state' field is not used.
// This struct is also used in TDMT_VND_FOLLOWER_SSMIGRATE as request, which don't need a response.
typedef struct {
  int32_t ssMigrateId;  // ss migrate id
  int32_t nodeId;       // node id of the leader vnode
  int32_t vgId;         // vgroup id
  int32_t fid;          // file set id
  int32_t state;        // SSMIGRATE_FILESET_STATE_*
} SSsMigrateProgress;

int tSerializeSSsMigrateProgress(void* buf, int32_t bufLen, SSsMigrateProgress* pProgress);
int tDeserializeSSsMigrateProgress(void* buf, int32_t bufLen, SSsMigrateProgress* pProgress);

// Request for TDMT_MND_KILL_SSMIGRATE
typedef struct {
  int32_t ssMigrateId;
  int32_t sqlLen;
  char*   sql;
} SKillSsMigrateReq;

int32_t tSerializeSKillSsMigrateReq(void* buf, int32_t bufLen, SKillSsMigrateReq* pReq);
int32_t tDeserializeSKillSsMigrateReq(void* buf, int32_t bufLen, SKillSsMigrateReq* pReq);
void    tFreeSKillSsMigrateReq(SKillSsMigrateReq* pReq);

// Request for TDMT_VND_KILL_SSMIGRATE
typedef struct {
  int32_t ssMigrateId;
} SVnodeKillSsMigrateReq;

int32_t tSerializeSVnodeKillSsMigrateReq(void* buf, int32_t bufLen, SVnodeKillSsMigrateReq* pReq);
int32_t tDeserializeSVnodeKillSsMigrateReq(void* buf, int32_t bufLen, SVnodeKillSsMigrateReq* pReq);

typedef struct {
  int32_t vgId;
  int64_t keepVersion;
} SMndSetVgroupKeepVersionReq;

int32_t tSerializeSMndSetVgroupKeepVersionReq(void* buf, int32_t bufLen, SMndSetVgroupKeepVersionReq* pReq);
int32_t tDeserializeSMndSetVgroupKeepVersionReq(void* buf, int32_t bufLen, SMndSetVgroupKeepVersionReq* pReq);

typedef struct {
  int32_t timestampSec;
  int32_t ttlDropMaxCount;
  int32_t nUids;
  SArray* pTbUids;
} SVDropTtlTableReq;

int32_t tSerializeSVDropTtlTableReq(void* buf, int32_t bufLen, SVDropTtlTableReq* pReq);
int32_t tDeserializeSVDropTtlTableReq(void* buf, int32_t bufLen, SVDropTtlTableReq* pReq);

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  int64_t dbId;
  int64_t ownerId;
  int32_t cfgVersion;
  int32_t numOfVgroups;
  int32_t numOfStables;
  int32_t buffer;
  int32_t cacheSize;
  int32_t cacheShardBits;
  int32_t pageSize;
  int32_t pages;
  int32_t daysPerFile;
  int32_t daysToKeep0;
  int32_t daysToKeep1;
  int32_t daysToKeep2;
  int32_t keepTimeOffset;
  int32_t minRows;
  int32_t maxRows;
  int32_t walFsyncPeriod;
  int16_t hashPrefix;
  int16_t hashSuffix;
  int8_t  hashMethod;
  int8_t  walLevel;
  int8_t  precision;
  int8_t  compression;
  int8_t  replications;
  int8_t  strict;
  int8_t  cacheLast;
  int8_t  encryptAlgr;
  char    algorithmsId[TSDB_ENCRYPT_ALGR_NAME_LEN];
  int32_t ssChunkSize;
  int32_t ssKeepLocal;
  int8_t  ssCompact;
  union {
    uint8_t flags;
    struct {
      uint8_t isMount : 1;    // TS-5868
      uint8_t allowDrop : 1;  // TS-7232
      uint8_t securityLevel : 3;   // 6671585124
      uint8_t padding : 3;
    };
  };
  int8_t  compactTimeOffset;
  int32_t compactInterval;
  int32_t compactStartTime;
  int32_t compactEndTime;
  int32_t tsdbPageSize;
  int32_t walRetentionPeriod;
  int32_t walRollPeriod;
  int64_t walRetentionSize;
  int64_t walSegmentSize;
  int32_t numOfRetensions;
  SArray* pRetensions;
  int8_t  schemaless;
  int16_t sstTrigger;
  int8_t  withArbitrator;
  int8_t  isAudit;
  int8_t  secureDelete;
} SDbCfgRsp;

typedef SDbCfgRsp SDbCfgInfo;

int32_t tSerializeSDbCfgRspImpl(SEncoder* encoder, const SDbCfgRsp* pRsp);
int32_t tSerializeSDbCfgRsp(void* buf, int32_t bufLen, const SDbCfgRsp* pRsp);
int32_t tDeserializeSDbCfgRsp(void* buf, int32_t bufLen, SDbCfgRsp* pRsp);
int32_t tDeserializeSDbCfgRspImpl(SDecoder* decoder, SDbCfgRsp* pRsp);
void    tFreeSDbCfgRsp(SDbCfgRsp* pRsp);

typedef struct {
  int32_t rowNum;
} SQnodeListReq;

int32_t tSerializeSQnodeListReq(void* buf, int32_t bufLen, SQnodeListReq* pReq);
int32_t tDeserializeSQnodeListReq(void* buf, int32_t bufLen, SQnodeListReq* pReq);

typedef struct {
  int32_t rowNum;
} SDnodeListReq;

int32_t tSerializeSDnodeListReq(void* buf, int32_t bufLen, SDnodeListReq* pReq);

typedef struct {
  int32_t useless;  // useless
} SServerVerReq;

int32_t tSerializeSServerVerReq(void* buf, int32_t bufLen, SServerVerReq* pReq);
// int32_t tDeserializeSServerVerReq(void* buf, int32_t bufLen, SServerVerReq* pReq);

typedef struct {
  char ver[TSDB_VERSION_LEN];
} SServerVerRsp;

int32_t tSerializeSServerVerRsp(void* buf, int32_t bufLen, SServerVerRsp* pRsp);
int32_t tDeserializeSServerVerRsp(void* buf, int32_t bufLen, SServerVerRsp* pRsp);

typedef struct SQueryNodeAddr {
  int32_t nodeId;  // vgId or qnodeId
  SEpSet  epSet;
} SQueryNodeAddr;

typedef struct {
  SQueryNodeAddr addr;
  uint64_t       load;
} SQueryNodeLoad;

typedef struct {
  SArray* qnodeList;  // SArray<SQueryNodeLoad>
} SQnodeListRsp;

int32_t tSerializeSQnodeListRsp(void* buf, int32_t bufLen, SQnodeListRsp* pRsp);
int32_t tDeserializeSQnodeListRsp(void* buf, int32_t bufLen, SQnodeListRsp* pRsp);
void    tFreeSQnodeListRsp(SQnodeListRsp* pRsp);


typedef struct SDownstreamSourceNode {
  ENodeType      type;
  SQueryNodeAddr addr;
  uint64_t       clientId;
  uint64_t       taskId;
  uint64_t       sId;
  uint64_t       srcTaskId;
  int32_t        execId;
  int32_t        fetchMsgType;
  bool           localExec;
  uint64_t       producerQueryId;  // Zero means the legacy same-query producer.
  bool           allowFollowerRead;
} SDownstreamSourceNode;

#define DOWNSTREAM_SOURCE_LOCAL_BLOCK_FLAG (1U << 30)
#define DOWNSTREAM_SOURCE_FETCH_TYPE(type) ((type) & ~DOWNSTREAM_SOURCE_LOCAL_BLOCK_FLAG)



typedef struct SDNodeAddr {
  int32_t nodeId;  // dnodeId
  SEpSet  epSet;
} SDNodeAddr;

typedef struct {
  SArray* dnodeList;  // SArray<SDNodeAddr>
} SDnodeListRsp;

int32_t tSerializeSDnodeListRsp(void* buf, int32_t bufLen, SDnodeListRsp* pRsp);
int32_t tDeserializeSDnodeListRsp(void* buf, int32_t bufLen, SDnodeListRsp* pRsp);
void    tFreeSDnodeListRsp(SDnodeListRsp* pRsp);

typedef struct {
  SArray* pTsmas;  // SArray<STableTSMAInfo*>
} STableTSMAInfoRsp;

typedef struct {
  SUseDbRsp*         useDbRsp;
  SDbCfgRsp*         cfgRsp;
  STableTSMAInfoRsp* pTsmaRsp;
  int32_t            dbTsmaVersion;
  char               db[TSDB_DB_FNAME_LEN];
  int64_t            dbId;
} SDbHbRsp;

typedef struct {
  SArray* pArray;  // Array of SDbHbRsp
} SDbHbBatchRsp;

int32_t tSerializeSDbHbBatchRsp(void* buf, int32_t bufLen, SDbHbBatchRsp* pRsp);
int32_t tDeserializeSDbHbBatchRsp(void* buf, int32_t bufLen, SDbHbBatchRsp* pRsp);
void    tFreeSDbHbBatchRsp(SDbHbBatchRsp* pRsp);

typedef struct {
  SArray* pArray;  // Array of SGetUserAuthRsp
} SUserAuthBatchRsp;

int32_t tSerializeSUserAuthBatchRsp(void* buf, int32_t bufLen, SUserAuthBatchRsp* pRsp);
int32_t tDeserializeSUserAuthBatchRsp(void* buf, int32_t bufLen, SUserAuthBatchRsp* pRsp);
void    tFreeSUserAuthBatchRsp(SUserAuthBatchRsp* pRsp);

typedef struct {
  char        db[TSDB_DB_FNAME_LEN];
  STimeWindow timeRange;
  int32_t     sqlLen;
  char*       sql;
  SArray*     vgroupIds;
  int32_t     compactId;
  int8_t      metaOnly;
  int8_t      force;
} SCompactDbReq;

int32_t tSerializeSCompactDbReq(void* buf, int32_t bufLen, SCompactDbReq* pReq);
int32_t tDeserializeSCompactDbReq(void* buf, int32_t bufLen, SCompactDbReq* pReq);
void    tFreeSCompactDbReq(SCompactDbReq* pReq);

typedef struct {
  union {
    int32_t compactId;
    int32_t id;
  };
  int8_t bAccepted;
} SCompactDbRsp;

int32_t tSerializeSCompactDbRsp(void* buf, int32_t bufLen, SCompactDbRsp* pRsp);
int32_t tDeserializeSCompactDbRsp(void* buf, int32_t bufLen, SCompactDbRsp* pRsp);

typedef struct {
  union {
    int32_t compactId;
    int32_t id;
  };
  int8_t  force;
  int32_t sqlLen;
  char*   sql;
} SKillCompactReq;

int32_t tSerializeSKillCompactReq(void* buf, int32_t bufLen, SKillCompactReq* pReq);
int32_t tDeserializeSKillCompactReq(void* buf, int32_t bufLen, SKillCompactReq* pReq);
void    tFreeSKillCompactReq(SKillCompactReq* pReq);

// ==================== Cluster-level backup/restore ====================
// client -> mnode: start a backup. Phase 2 only wires cluster-level FULL backup;
// isFull and dbName are reserved for later phases.
typedef struct {
  int32_t dnodeId;                     // dnode that owns backupRoot and runs the agent
  char    backupRoot[TSDB_MOUNT_PATH_LEN];
  int8_t  isFull;                      // reserved: 1 = full, 0 = incremental
  int64_t backupChainId;               // reserved: target chain for incremental; 0 = latest
  char    dbName[TSDB_DB_FNAME_LEN];   // reserved: empty = whole cluster
  int8_t  hasPassword;
  char    password[TSDB_PASSWORD_LEN];
  int32_t parallel;                    // vgroup backup parallelism; >= 1, 1 = serial
  int32_t sqlLen;
  char*   sql;
} SBackupReq;

int32_t tSerializeSBackupReq(void* buf, int32_t bufLen, SBackupReq* pReq);
int32_t tDeserializeSBackupReq(void* buf, int32_t bufLen, SBackupReq* pReq);
void    tFreeSBackupReq(SBackupReq* pReq);

typedef struct {
  int64_t chainId;   // backup chain id assigned by mnode
  int64_t backupId;  // individual backup id within the chain
  int8_t  bAccepted;
} SBackupRsp;

int32_t tSerializeSBackupRsp(void* buf, int32_t bufLen, SBackupRsp* pRsp);
int32_t tDeserializeSBackupRsp(void* buf, int32_t bufLen, SBackupRsp* pRsp);

typedef struct {
  int64_t backupId;
  int32_t sqlLen;
  char*   sql;
} SKillBackupReq;

int32_t tSerializeSKillBackupReq(void* buf, int32_t bufLen, SKillBackupReq* pReq);
int32_t tDeserializeSKillBackupReq(void* buf, int32_t bufLen, SKillBackupReq* pReq);
void    tFreeSKillBackupReq(SKillBackupReq* pReq);

typedef struct {
  int32_t vgId;
  int64_t dbUid;
  char    dbName[TSDB_DB_FNAME_LEN];
  int8_t  numOfDnodes;
  int32_t dnodeIds[TSDB_MAX_REPLICA];
} SBackupVgroupInfo;

typedef struct {
  int64_t streamId;
  int32_t snodeDnodeId;
} SBackupStreamSnodeInfo;

typedef struct {
  int32_t id;
  int8_t  isSnode;
  int8_t  isMnode;
} SBackupDnodeInfo;

// mnode -> target dnode agent: dispatch a backup job
typedef struct {
  int64_t chainId;  // resolved chain id assigned/selected by mnode
  int64_t backupId;
  int32_t dnodeId;
  char    backupRoot[TSDB_MOUNT_PATH_LEN];
  int8_t  isFull;
  char    dbName[TSDB_DB_FNAME_LEN];  // reserved: empty = whole cluster
  int8_t  hasPassword;
  char    password[TSDB_PASSWORD_LEN];
  int32_t parallel;                   // vgroup backup parallelism; >= 1, 1 = serial
  SArray *dnodes;                      // SBackupDnodeInfo, sorted ascending by id
  SArray *streamSnodes;                 // SBackupStreamSnodeInfo
  SArray *vgroups;                     // SBackupVgroupInfo
} SBackupDnodeReq;

int32_t tSerializeSBackupDnodeReq(void* buf, int32_t bufLen, SBackupDnodeReq* pReq);
int32_t tDeserializeSBackupDnodeReq(void* buf, int32_t bufLen, SBackupDnodeReq* pReq);
void    tFreeSBackupDnodeReq(SBackupDnodeReq* pReq);

// mnode <-> dnode agent: query backup progress
typedef struct {
  int64_t chainId;
  int64_t backupId;
} SBackupProgressReq;

int32_t tSerializeSBackupProgressReq(void* buf, int32_t bufLen, SBackupProgressReq* pReq);
int32_t tDeserializeSBackupProgressReq(void* buf, int32_t bufLen, SBackupProgressReq* pReq);

typedef struct {
  int64_t chainId;
  int64_t backupId;
  int8_t  finished;  // 1 = the agent-side task has finished (success or failure)
  int64_t totalSize; // bytes written so far
  int32_t totalVgroups;
  int32_t finishedVgroups;
  int32_t code;       // agent-side result code; 0 = success
} SBackupProgressRsp;

int32_t tSerializeSBackupProgressRsp(void* buf, int32_t bufLen, SBackupProgressRsp* pRsp);
int32_t tDeserializeSBackupProgressRsp(void* buf, int32_t bufLen, SBackupProgressRsp* pRsp);

// dnode agent -> mnode: pull mnode metadata for backup
typedef struct {
  int64_t chainId;
  int64_t backupId;
} SBackupMetaReq;

int32_t tSerializeSBackupMetaReq(void* buf, int32_t bufLen, SBackupMetaReq* pReq);
int32_t tDeserializeSBackupMetaReq(void* buf, int32_t bufLen, SBackupMetaReq* pReq);

// One packaged file within a backup unit. relPath is relative to the unit's
// directory (e.g. "sdb.data", "mnode.json", "sync/raft_config.json"), so the
// agent can recreate the exact tree. Reusable across mnode/vnode/snode units.
typedef struct {
  char    relPath[TSDB_FILENAME_LEN];
  int32_t dataLen;
  void*   data;
} SBackupFile;

typedef struct {
  int64_t     sdbEndVersion;  // sdb.data end version at snapshot time
  int32_t     numOfFiles;     // number of valid entries in files[]
  SBackupFile files[4];       // sdb.data + mnode.json + sync raft config/store
} SBackupMetaRsp;

int32_t tSerializeSBackupMetaRsp(void* buf, int32_t bufLen, SBackupMetaRsp* pRsp);
int32_t tDeserializeSBackupMetaRsp(void* buf, int32_t bufLen, SBackupMetaRsp* pRsp);
void    tFreeSBackupMetaRsp(SBackupMetaRsp* pRsp);

// dnode backup agent -> mnode: resolve the current leader immediately before
// starting this vgroup's snapshot. The returned endpoint is the sole source
// for that snapshot session.
typedef struct {
  int64_t chainId;
  int64_t backupId;
  int32_t vgId;
} SBackupVgroupLeaderReq;

typedef struct {
  int32_t vgId;
  int32_t leaderDnodeId;
  SEpSet  leaderEpSet;
} SBackupVgroupLeaderRsp;

int32_t tSerializeSBackupVgroupLeaderReq(void* buf, int32_t bufLen, SBackupVgroupLeaderReq* pReq);
int32_t tDeserializeSBackupVgroupLeaderReq(void* buf, int32_t bufLen, SBackupVgroupLeaderReq* pReq);
int32_t tSerializeSBackupVgroupLeaderRsp(void* buf, int32_t bufLen, SBackupVgroupLeaderRsp* pRsp);
int32_t tDeserializeSBackupVgroupLeaderRsp(void* buf, int32_t bufLen, SBackupVgroupLeaderRsp* pRsp);

// dnode backup agent -> SNode dnode: package the requested stream checkpoints.
typedef struct {
  int32_t dnodeId;
  SArray* streamIds;  // int64_t
} SBackupSnodeReq;

typedef struct {
  SArray* files;  // SBackupFile
} SBackupSnodeRsp;

int32_t tSerializeSBackupSnodeReq(void* buf, int32_t bufLen, SBackupSnodeReq* pReq);
int32_t tDeserializeSBackupSnodeReq(void* buf, int32_t bufLen, SBackupSnodeReq* pReq);
void    tFreeSBackupSnodeReq(SBackupSnodeReq* pReq);
int32_t tSerializeSBackupSnodeRsp(void* buf, int32_t bufLen, SBackupSnodeRsp* pRsp);
int32_t tDeserializeSBackupSnodeRsp(void* buf, int32_t bufLen, SBackupSnodeRsp* pRsp);
void    tFreeSBackupSnodeRsp(SBackupSnodeRsp* pRsp);

// Check column/tag reference by privilege (for RENAME COLUMN/TAG on normal/virtual tables)
typedef struct {
  char     tbFName[TSDB_TABLE_FNAME_LEN];
  col_id_t colId;
  char     colName[TSDB_COL_NAME_LEN];
} SMndCheckColRefReq;

typedef struct {
  int32_t code;  // TSDB_CODE_SUCCESS or error code (e.g., TSDB_CODE_MND_COL_REF_BY_USER_PRIV)
} SMndCheckColRefRsp;

int32_t tSerializeSMndCheckColRefReq(void* buf, int32_t bufLen, SMndCheckColRefReq* pReq);
int32_t tDeserializeSMndCheckColRefReq(void* buf, int32_t bufLen, SMndCheckColRefReq* pReq);
int32_t tSerializeSMndCheckColRefRsp(void* buf, int32_t bufLen, SMndCheckColRefRsp* pRsp);
int32_t tDeserializeSMndCheckColRefRsp(void* buf, int32_t bufLen, SMndCheckColRefRsp* pRsp);

typedef enum {
  BACKUP_VNODE_SNAP_BEGIN = 1,
  BACKUP_VNODE_SNAP_FETCH = 2,
  BACKUP_VNODE_SNAP_RELEASE = 3,
} EBackupVnodeSnapOp;

// vnode write queue: establish a committed boundary after all preceding writes
typedef struct {
  int32_t vgId;
} SVnodeSyncCommitReq;

int32_t tSerializeSVnodeSyncCommitReq(void* buf, int32_t bufLen, SVnodeSyncCommitReq* pReq);
int32_t tDeserializeSVnodeSyncCommitReq(void* buf, int32_t bufLen, SVnodeSyncCommitReq* pReq);

// dnode agent -> vnode leader: manage one backup snapshot session
typedef struct {
  int32_t vgId;
  int64_t chainId;
  int64_t backupId;
  int8_t  isFull;
  int8_t  op;
} SBackupVnodeSnapReq;

typedef struct {
  int32_t vgId;
  int64_t snapshotIndex;
  int8_t  eof;
  int32_t dataLen;
  void*   data;
} SBackupVnodeSnapRsp;

int32_t tSerializeSBackupVnodeSnapReq(void* buf, int32_t bufLen, SBackupVnodeSnapReq* pReq);
int32_t tDeserializeSBackupVnodeSnapReq(void* buf, int32_t bufLen, SBackupVnodeSnapReq* pReq);
int32_t tSerializeSBackupVnodeSnapRsp(void* buf, int32_t bufLen, SBackupVnodeSnapRsp* pRsp);
int32_t tDeserializeSBackupVnodeSnapRsp(void* buf, int32_t bufLen, SBackupVnodeSnapRsp* pRsp);
void    tFreeSBackupVnodeSnapRsp(SBackupVnodeSnapRsp* pRsp);

typedef SCompactDbRsp   STrimDbRsp;         // reuse structs
typedef SKillCompactReq SKillRetentionReq;  // reuse structs

typedef struct {
  char    name[TSDB_FUNC_NAME_LEN];
  int8_t  igExists;
  int8_t  funcType;
  int8_t  scriptType;
  int8_t  outputType;
  int32_t outputLen;
  int32_t bufSize;
  int32_t codeLen;
  int64_t signature;
  char*   pComment;
  char*   pCode;
  int8_t  orReplace;
} SCreateFuncReq;

int32_t tSerializeSCreateFuncReq(void* buf, int32_t bufLen, SCreateFuncReq* pReq);
int32_t tDeserializeSCreateFuncReq(void* buf, int32_t bufLen, SCreateFuncReq* pReq);
void    tFreeSCreateFuncReq(SCreateFuncReq* pReq);

typedef struct {
  char   name[TSDB_FUNC_NAME_LEN];
  int8_t igNotExists;
} SDropFuncReq;

int32_t tSerializeSDropFuncReq(void* buf, int32_t bufLen, SDropFuncReq* pReq);
int32_t tDeserializeSDropFuncReq(void* buf, int32_t bufLen, SDropFuncReq* pReq);

typedef struct {
  int32_t numOfFuncs;
  bool    ignoreCodeComment;
  SArray* pFuncNames;
} SRetrieveFuncReq;

int32_t tSerializeSRetrieveFuncReq(void* buf, int32_t bufLen, SRetrieveFuncReq* pReq);
int32_t tDeserializeSRetrieveFuncReq(void* buf, int32_t bufLen, SRetrieveFuncReq* pReq);
void    tFreeSRetrieveFuncReq(SRetrieveFuncReq* pReq);

typedef struct {
  char    name[TSDB_FUNC_NAME_LEN];
  int8_t  funcType;
  int8_t  scriptType;
  int8_t  outputType;
  int32_t outputLen;
  int32_t bufSize;
  int64_t signature;
  int32_t commentSize;
  int32_t codeSize;
  char*   pComment;
  char*   pCode;
} SFuncInfo;

typedef struct {
  int32_t funcVersion;
  int64_t funcCreatedTime;
} SFuncExtraInfo;

typedef struct {
  int32_t numOfFuncs;
  SArray* pFuncInfos;
  SArray* pFuncExtraInfos;
} SRetrieveFuncRsp;

int32_t tSerializeSRetrieveFuncRsp(void* buf, int32_t bufLen, SRetrieveFuncRsp* pRsp);
int32_t tDeserializeSRetrieveFuncRsp(void* buf, int32_t bufLen, SRetrieveFuncRsp* pRsp);
void    tFreeSFuncInfo(SFuncInfo* pInfo);
void    tFreeSRetrieveFuncRsp(SRetrieveFuncRsp* pRsp);

typedef struct {
  int32_t       statusInterval;
  /*
    Local timezone UTC offset in seconds (east-positive, e.g. +28800 for
    Asia/Shanghai).  Derived from taosGetLocalTimezoneOffset() on each
    status report.  Paired with the timezone string in
    mndCheckClusterCfgPara: a mismatch is reported only when both the
    timezone string AND this offset differ.
  */
  int64_t       checkTime;
  char          timezone[TD_TIMEZONE_LEN];  // tsTimezone
  char          locale[TD_LOCALE_LEN];      // tsLocale
  char          charset[TD_LOCALE_LEN];     // tsCharset
  int8_t        ttlChangeOnWrite;
  int8_t        enableWhiteList;
  int8_t        encryptionKeyStat;
  uint32_t      encryptionKeyChksum;
  SMonitorParas monitorParas;
  int32_t       statusIntervalMs;
} SClusterCfg;

typedef struct {
  int32_t openVnodes;
  int32_t dropVnodes;
  int32_t totalVnodes;
  int32_t masterNum;
  int64_t numOfSelectReqs;
  int64_t numOfInsertReqs;
  int64_t numOfInsertSuccessReqs;
  int64_t numOfBatchInsertReqs;
  int64_t numOfBatchInsertSuccessReqs;
  int64_t errors;
} SVnodesStat;

// Progress (byte-level) of a single snapshot-send target. One entry per destDnodeId, reported to
// the mnode via SVnodeLoad, so the mnode can display progress on the column matching the target
// follower's dnodeId, fixing the "misaligned display" problem.
typedef struct {
  int32_t destDnodeId;          // target follower dnodeId
  int64_t snapTotalSize;        // total snapshot bytes being sent to this target
  int64_t snapTransferredSize;  // snapshot bytes already sent to this target
} SVnodeSnapProgress;

typedef struct {
  int32_t vgId;
  int8_t  syncState;
  int8_t  syncRestore;
  int64_t syncTerm;
  int64_t roleTimeMs;
  int64_t startTimeMs;
  int8_t  syncCanRead;
  int64_t cacheUsage;
  int64_t numOfTables;
  int64_t numOfTimeSeries;
  int64_t totalStorage;
  int64_t compStorage;
  int64_t pointsWritten;
  int64_t numOfSelectReqs;
  int64_t numOfInsertReqs;
  int64_t numOfInsertSuccessReqs;
  int64_t numOfBatchInsertReqs;
  int64_t numOfBatchInsertSuccessReqs;
  int32_t numOfCachedTables;
  int32_t learnerProgress;  // use one reservered
  int64_t syncAppliedIndex;
  int64_t syncCommitIndex;
  int64_t bufferSegmentUsed;
  int64_t bufferSegmentSize;
  int32_t snapSeq;
  int64_t syncTotalIndex;
  int8_t  snapshotSending;  // 1 if this vnode is currently sending a snapshot
  // Per-target snapshot-send progress: SArray<SVnodeSnapProgress>, grouped by target follower dnodeId.
  // Replaces the former single scalar snapTotalSize/snapTransferredSize so the mnode can display
  // progress per target.
  SArray* pSnapProgress;
} SVnodeLoad;

typedef struct {
  int64_t total_requests;
  int64_t total_rows;
  int64_t total_bytes;
  double  write_size;
  double  cache_hit_ratio;
  int64_t rpc_queue_wait;
  int64_t preprocess_time;

  int64_t memory_table_size;
  int64_t commit_count;
  int64_t merge_count;
  double  commit_time;
  double  merge_time;
  int64_t block_commit_time;
  int64_t memtable_wait_time;
} SVnodeMetrics;

typedef struct {
  int32_t     vgId;
  int64_t     numOfTables;
  int64_t     memSize;
  int64_t     l1Size;
  int64_t     l2Size;
  int64_t     l3Size;
  int64_t     cacheSize;
  int64_t     walSize;
  int64_t     metaSize;
  int64_t     rawDataSize;
  int64_t     ssSize;
  const char* dbname;
  int8_t      estimateRawData;
} SDbSizeStatisInfo;

typedef struct SLastCacheStats {
  int32_t dnodeId;
  int64_t blockCacheCapacity;
  int64_t blockCacheUsage;
  int64_t blockCachePinnedUsage;
  int64_t estimateTableReadersMem;
  int64_t curSizeActiveMemTable;
  int64_t curSizeAllMemTables;
  int32_t numImmutableMemTable;
  bool    memTableFlushPending;
  int32_t numRunningFlushes;
  bool    compactionPending;
  int32_t numRunningCompactions;
  int64_t estimatePendingCompactionBytes;
  bool    isWriteStopped;
  int64_t actualDelayedWriteRate;
  int32_t numFilesAtLevel0;
  int64_t totalSstFilesSize;
  int64_t estimateNumKeys;
  int32_t numLiveVersions;
  int32_t backgroundErrors;
} SLastCacheStats;

typedef struct {
  int32_t vgId;
  int64_t nTimeSeries;
} SVnodeLoadLite;

typedef struct {
  int8_t  syncState;
  int64_t syncTerm;
  int8_t  syncRestore;
  int64_t roleTimeMs;
} SMnodeLoad;

typedef struct {
  int32_t dnodeId;
  int64_t numOfProcessedQuery;
  int64_t numOfProcessedCQuery;
  int64_t numOfProcessedFetch;
  int64_t numOfProcessedDrop;
  int64_t numOfProcessedNotify;
  int64_t numOfProcessedHb;
  int64_t numOfProcessedDelete;
  int64_t cacheDataSize;
  int64_t numOfQueryInQueue;
  int64_t numOfFetchInQueue;
  int64_t timeInQueryQueue;
  int64_t timeInFetchQueue;
} SQnodeLoad;

typedef struct {
  int32_t     sver;      // software version
  int64_t     dnodeVer;  // dnode table version in sdb
  int32_t     dnodeId;
  int64_t     clusterId;
  int64_t     rebootTime;
  int64_t     updateTime;
  float       numOfCores;
  int32_t     numOfSupportVnodes;
  int32_t     numOfDiskCfg;
  int64_t     memTotal;
  int64_t     memAvail;
  char        dnodeEp[TSDB_EP_LEN];
  char        machineId[TSDB_MACHINE_ID_LEN + 1];
  SMnodeLoad  mload;
  SQnodeLoad  qload;
  SClusterCfg clusterCfg;
  SArray*     pVloads;  // array of SVnodeLoad
  int32_t     statusSeq;
  int64_t     ipWhiteVer;
  int64_t     timeWhiteVer;
  int64_t     analVer;
  int64_t     timestamp;
  char        auditDB[TSDB_DB_FNAME_LEN];
  char        auditToken[TSDB_TOKEN_LEN];
  SEpSet      auditEpSet;
  int32_t     auditVgId;
  SArray*     pTxnActiveQueries;  // array of STxnActiveQuery, optional (NULL if no idle txns)
} SStatusReq;

int32_t tSerializeSStatusReq(void* buf, int32_t bufLen, SStatusReq* pReq);
int32_t tDeserializeSStatusReq(void* buf, int32_t bufLen, SStatusReq* pReq);
void    tFreeSStatusReq(SStatusReq* pReq);
// Free an SArray of SVnodeLoad. Each SVnodeLoad may embed a per-target snapshot
// progress array (pSnapProgress) allocated in vnodeGetLoad(); it must be freed
// before destroying the outer array, otherwise pSnapProgress leaks. Use this
// helper anywhere an SVnodeLoad array is destroyed to avoid such leaks.
void    tFreeSVnodeLoadArray(SArray* pVloads);

typedef struct {
  int32_t forceReadConfig;
  int32_t cver;
  SArray* array;
} SConfigReq;

int32_t tSerializeSConfigReq(void* buf, int32_t bufLen, SConfigReq* pReq);
int32_t tDeserializeSConfigReq(void* buf, int32_t bufLen, SConfigReq* pReq);
void    tFreeSConfigReq(SConfigReq* pReq);

typedef struct {
  int32_t dnodeId;
  char    machineId[TSDB_MACHINE_ID_LEN + 1];
} SDnodeInfoReq;

int32_t tSerializeSDnodeInfoReq(void* buf, int32_t bufLen, SDnodeInfoReq* pReq);
int32_t tDeserializeSDnodeInfoReq(void* buf, int32_t bufLen, SDnodeInfoReq* pReq);

typedef enum {
  MONITOR_TYPE_COUNTER = 0,
  MONITOR_TYPE_SLOW_LOG = 1,
} MONITOR_TYPE;

typedef struct {
  int32_t      contLen;
  char*        pCont;
  MONITOR_TYPE type;
} SStatisReq;

int32_t tSerializeSStatisReq(void* buf, int32_t bufLen, SStatisReq* pReq);
int32_t tDeserializeSStatisReq(void* buf, int32_t bufLen, SStatisReq* pReq);
void    tFreeSStatisReq(SStatisReq* pReq);

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  char    table[TSDB_TABLE_NAME_LEN];
  char    operation[AUDIT_OPERATION_LEN];
  int32_t sqlLen;
  char*   pSql;
  double  duration;
  int64_t affectedRows;
} SAuditReq;
int32_t tSerializeSAuditReq(void* buf, int32_t bufLen, SAuditReq* pReq);
int32_t tDeserializeSAuditReq(void* buf, int32_t bufLen, SAuditReq* pReq);
void    tFreeSAuditReq(SAuditReq* pReq);

typedef struct {
  SArray* auditArr;
} SBatchAuditReq;
int32_t tSerializeSBatchAuditReq(void* buf, int32_t bufLen, SBatchAuditReq* pReq);
int32_t tDeserializeSBatchAuditReq(void* buf, int32_t bufLen, SBatchAuditReq* pReq);
void    tFreeSBatchAuditReq(SBatchAuditReq* pReq);

typedef struct {
  int32_t dnodeId;
  int64_t clusterId;
  SArray* pVloads;
} SNotifyReq;

int32_t tSerializeSNotifyReq(void* buf, int32_t bufLen, SNotifyReq* pReq);
int32_t tDeserializeSNotifyReq(void* buf, int32_t bufLen, SNotifyReq* pReq);
void    tFreeSNotifyReq(SNotifyReq* pReq);

typedef struct {
  int32_t dnodeId;
  int64_t clusterId;
} SDnodeCfg;

typedef struct {
  int32_t id;
  int8_t  isMnode;
  SEp     ep;
} SDnodeEp;

typedef struct {
  int32_t id;
  int8_t  isMnode;
  int8_t  offlineReason;
  SEp     ep;
  char    active[TSDB_ACTIVE_KEY_LEN];
  char    connActive[TSDB_CONN_ACTIVE_KEY_LEN];
} SDnodeInfo;

typedef struct {
  int64_t   dnodeVer;
  SDnodeCfg dnodeCfg;
  SArray*   pDnodeEps;  // Array of SDnodeEp
  int32_t   statusSeq;
  int64_t   ipWhiteVer;
  int64_t   analVer;
  int64_t   timeWhiteVer;
  char      auditDB[TSDB_DB_FNAME_LEN];
  char      auditToken[TSDB_TOKEN_LEN];
  SEpSet    auditEpSet;
  int32_t   auditVgId;
} SStatusRsp;

int32_t tSerializeSStatusRsp(void* buf, int32_t bufLen, SStatusRsp* pRsp);
int32_t tDeserializeSStatusRsp(void* buf, int32_t bufLen, SStatusRsp* pRsp);
void    tFreeSStatusRsp(SStatusRsp* pRsp);

typedef struct {
  int32_t forceReadConfig;
  int32_t isConifgVerified;
  int32_t isVersionVerified;
  int32_t cver;
  SArray* array;
} SConfigRsp;

int32_t tSerializeSConfigRsp(void* buf, int32_t bufLen, SConfigRsp* pRsp);
int32_t tDeserializeSConfigRsp(void* buf, int32_t bufLen, SConfigRsp* pRsp);
void    tFreeSConfigRsp(SConfigRsp* pRsp);

typedef struct {
  int32_t dnodeId;
  int32_t keyVersion;  // Local key version
} SKeySyncReq;

int32_t tSerializeSKeySyncReq(void* buf, int32_t bufLen, SKeySyncReq* pReq);
int32_t tDeserializeSKeySyncReq(void* buf, int32_t bufLen, SKeySyncReq* pReq);

typedef struct {
  int32_t keyVersion;        // mnode's key version
  int8_t  needUpdate;        // 1 if dnode needs to update keys
  int32_t encryptionKeyStatus;  // Encryption key status (TSDB_ENCRYPT_KEY_STAT_*)
  char    svrKey[129];       // Server key (if needUpdate)
  char    dbKey[129];        // Database key (if needUpdate)
  char    cfgKey[129];       // Config key (if needUpdate)
  char    metaKey[129];      // Metadata key (if needUpdate)
  char    dataKey[129];      // Data key (if needUpdate)
  int32_t algorithm;         // Encryption algorithm for master keys
  int32_t cfgAlgorithm;      // Encryption algorithm for CFG_KEY
  int32_t metaAlgorithm;     // Encryption algorithm for META_KEY
  int64_t createTime;        // Key creation time
  int64_t svrKeyUpdateTime;  // Server key update time
  int64_t dbKeyUpdateTime;   // Database key update time
} SKeySyncRsp;

int32_t tSerializeSKeySyncRsp(void* buf, int32_t bufLen, SKeySyncRsp* pRsp);
int32_t tDeserializeSKeySyncRsp(void* buf, int32_t bufLen, SKeySyncRsp* pRsp);

typedef struct {
  int32_t reserved;
} SMTimerReq;

int32_t tSerializeSMTimerMsg(void* buf, int32_t bufLen, SMTimerReq* pReq);
// int32_t tDeserializeSMTimerMsg(void* buf, int32_t bufLen, SMTimerReq* pReq);

typedef struct SOrphanTask {
  int64_t streamId;
  int32_t taskId;
  int32_t nodeId;
} SOrphanTask;

typedef struct SMStreamDropOrphanMsg {
  SArray* pList;  // SArray<SOrphanTask>
} SMStreamDropOrphanMsg;

int32_t tSerializeDropOrphanTaskMsg(void* buf, int32_t bufLen, SMStreamDropOrphanMsg* pMsg);
int32_t tDeserializeDropOrphanTaskMsg(void* buf, int32_t bufLen, SMStreamDropOrphanMsg* pMsg);
void    tDestroyDropOrphanTaskMsg(SMStreamDropOrphanMsg* pMsg);

typedef struct {
  int32_t  id;
  uint16_t port;                 // node sync Port
  char     fqdn[TSDB_FQDN_LEN];  // node FQDN
} SReplica;

typedef struct {
  int32_t  vgId;
  char     db[TSDB_DB_FNAME_LEN];
  int64_t  dbUid;
  int32_t  vgVersion;
  int32_t  numOfStables;
  int32_t  buffer;
  int32_t  pageSize;
  int32_t  pages;
  int32_t  cacheLastSize;
  int32_t  cacheLastShardBits;  // Number of shards for last cache LRU, -1 for auto
  int32_t  daysPerFile;
  int32_t  daysToKeep0;
  int32_t  daysToKeep1;
  int32_t  daysToKeep2;
  int32_t  keepTimeOffset;
  int32_t  minRows;
  int32_t  maxRows;
  int32_t  walFsyncPeriod;
  uint32_t hashBegin;
  uint32_t hashEnd;
  int8_t   hashMethod;
  int8_t   walLevel;
  int8_t   precision;
  int8_t   compression;
  int8_t   strict;
  int8_t   cacheLast;
  int8_t   isTsma;
  int8_t   replica;
  int8_t   selfIndex;
  SReplica replicas[TSDB_MAX_REPLICA];
  int32_t  numOfRetensions;
  SArray*  pRetensions;  // SRetention
  void*    pTsma;
  int32_t  walRetentionPeriod;
  int64_t  walRetentionSize;
  int32_t  walRollPeriod;
  int64_t  walSegmentSize;
  int16_t  sstTrigger;
  int16_t  hashPrefix;
  int16_t  hashSuffix;
  int32_t  tsdbPageSize;
  int32_t  ssChunkSize;
  int32_t  ssKeepLocal;
  int8_t   ssCompact;
  int64_t  reserved[6];
  int8_t   learnerReplica;
  int8_t   learnerSelfIndex;
  SReplica learnerReplicas[TSDB_MAX_LEARNER_REPLICA];
  int32_t  changeVersion;
  int8_t   encryptAlgorithm;
  char     encryptAlgrName[TSDB_ENCRYPT_ALGR_NAME_LEN];
  union {
    uint8_t flags;
    struct {
      uint8_t isAudit : 1;
      uint8_t allowDrop : 1;
      uint8_t securityLevel : 3;   // 6671585124
      uint8_t padding : 3;
    };
  };
  int8_t secureDelete;
} SCreateVnodeReq;

int32_t tSerializeSCreateVnodeReq(void* buf, int32_t bufLen, SCreateVnodeReq* pReq);
int32_t tDeserializeSCreateVnodeReq(void* buf, int32_t bufLen, SCreateVnodeReq* pReq);
int32_t tFreeSCreateVnodeReq(SCreateVnodeReq* pReq);

typedef struct {
  union {
    int32_t compactId;
    int32_t id;
  };
  int32_t vgId;
  int32_t dnodeId;
} SQueryCompactProgressReq;

int32_t tSerializeSQueryCompactProgressReq(void* buf, int32_t bufLen, SQueryCompactProgressReq* pReq);
int32_t tDeserializeSQueryCompactProgressReq(void* buf, int32_t bufLen, SQueryCompactProgressReq* pReq);

typedef struct {
  union {
    int32_t compactId;
    int32_t id;
  };
  int32_t vgId;
  int32_t dnodeId;
  int32_t numberFileset;
  int32_t finished;
  int32_t progress;
  int64_t remainingTime;
} SQueryCompactProgressRsp;

int32_t tSerializeSQueryCompactProgressRsp(void* buf, int32_t bufLen, SQueryCompactProgressRsp* pReq);
int32_t tDeserializeSQueryCompactProgressRsp(void* buf, int32_t bufLen, SQueryCompactProgressRsp* pReq);

// Snap send progress query (mnode  ->  dnode, dnode  ->  mnode RSP)
typedef struct {
  int32_t fid;
  int32_t fileCount;
  int32_t finishedFileCount;
  int64_t totalSize;
  int64_t readSize;
  int64_t startTime;    // ms timestamp
  int64_t sver;
  int64_t ever;
  int8_t  transferType; // SNAP_DATA_TSDB(2) or SNAP_DATA_RAW(14)
} SSnapSendFileSetInfo;

typedef struct {
  int32_t             vgId;
  int32_t             dnodeId;
  int32_t             totalFileSets;
  int32_t             finishedFileSets;
  int64_t             startTime;    // ms timestamp of reader open
  int32_t             fileSetCount; // length of pFileSetInfos
  SSnapSendFileSetInfo *pFileSetInfos;
} SSnapSendVnodeInfo;

typedef struct {
  int32_t dnodeId;
  int32_t numOfVnodes;
  SSnapSendVnodeInfo *pVnodeInfos; // array of numOfVnodes elements
} SDnodeQuerySnapSendProgressRsp;

int32_t tSerializeSDnodeQuerySnapSendProgressRsp(void *buf, int32_t bufLen, SDnodeQuerySnapSendProgressRsp *pRsp);
int32_t tDeserializeSDnodeQuerySnapSendProgressRsp(void *buf, int32_t bufLen, SDnodeQuerySnapSendProgressRsp *pRsp);
void    tFreeSDnodeQuerySnapSendProgressRsp(SDnodeQuerySnapSendProgressRsp *pRsp);
typedef struct {
  int32_t compactId;
} SDnodeQueryCompactProgressReq;

int32_t tSerializeSDnodeQueryCompactProgressReq(void *buf, int32_t bufLen, SDnodeQueryCompactProgressReq *pReq);
int32_t tDeserializeSDnodeQueryCompactProgressReq(void *buf, int32_t bufLen, SDnodeQueryCompactProgressReq *pReq);

typedef struct {
  int32_t                   dnodeId;
  int32_t                   numOfVnodes;
  SQueryCompactProgressRsp *vnodeProgress;  // array of numOfVnodes elements
} SDnodeQueryCompactProgressRsp;

int32_t tSerializeSDnodeQueryCompactProgressRsp(void *buf, int32_t bufLen, SDnodeQueryCompactProgressRsp *pRsp);
int32_t tDeserializeSDnodeQueryCompactProgressRsp(void *buf, int32_t bufLen, SDnodeQueryCompactProgressRsp *pRsp);
void    tFreeSDnodeQueryCompactProgressRsp(SDnodeQueryCompactProgressRsp *pRsp);
typedef SQueryCompactProgressReq SQueryRetentionProgressReq;
typedef SQueryCompactProgressRsp SQueryRetentionProgressRsp;

typedef struct {
  int32_t vgId;
  int32_t dnodeId;
  int64_t dbUid;
  char    db[TSDB_DB_FNAME_LEN];
  int64_t reserved[8];
} SDropVnodeReq;

int32_t tSerializeSDropVnodeReq(void* buf, int32_t bufLen, SDropVnodeReq* pReq);
int32_t tDeserializeSDropVnodeReq(void* buf, int32_t bufLen, SDropVnodeReq* pReq);

typedef struct {
  char    colName[TSDB_COL_NAME_LEN];
  char    stb[TSDB_TABLE_FNAME_LEN];
  int64_t stbUid;
  int64_t dbUid;
  int64_t reserved[8];
} SDropIndexReq;

int32_t tSerializeSDropIdxReq(void* buf, int32_t bufLen, SDropIndexReq* pReq);
int32_t tDeserializeSDropIdxReq(void* buf, int32_t bufLen, SDropIndexReq* pReq);

typedef struct {
  int64_t dbUid;
  char    db[TSDB_DB_FNAME_LEN];
  union {
    int64_t compactStartTime;
    int64_t startTime;
  };

  STimeWindow tw;
  union {
    int32_t compactId;
    int32_t id;
  };
  int8_t metaOnly;
  union {
    uint16_t flags;
    struct {
      uint16_t optrType : 3;     // ETsdbOpType
      uint16_t triggerType : 1;  // ETriggerType 0 manual, 1 auto
      uint16_t reserved : 12;
    };
  };
  int8_t force;  // force compact
} SCompactVnodeReq;

int32_t tSerializeSCompactVnodeReq(void* buf, int32_t bufLen, SCompactVnodeReq* pReq);
int32_t tDeserializeSCompactVnodeReq(void* buf, int32_t bufLen, SCompactVnodeReq* pReq);

typedef struct {
  union {
    int32_t compactId;
    int32_t taskId;
  };
  int32_t vgId;
  int32_t dnodeId;
} SVKillCompactReq;

int32_t tSerializeSVKillCompactReq(void* buf, int32_t bufLen, SVKillCompactReq* pReq);
int32_t tDeserializeSVKillCompactReq(void* buf, int32_t bufLen, SVKillCompactReq* pReq);

typedef SVKillCompactReq SVKillRetentionReq;

typedef struct {
  char        db[TSDB_DB_FNAME_LEN];
  int32_t     maxSpeed;
  int32_t     sqlLen;
  char*       sql;
  SArray*     vgroupIds;
  STimeWindow tw;  // unit is second
  union {
    uint32_t flags;
    struct {
      uint32_t optrType : 3;     // ETsdbOpType
      uint32_t triggerType : 1;  // ETriggerType 0 manual, 1 auto
      uint32_t reserved : 28;
    };
  };
} STrimDbReq;

int32_t tSerializeSTrimDbReq(void* buf, int32_t bufLen, STrimDbReq* pReq);
int32_t tDeserializeSTrimDbReq(void* buf, int32_t bufLen, STrimDbReq* pReq);
void    tFreeSTrimDbReq(STrimDbReq* pReq);

typedef SCompactVnodeReq SVTrimDbReq;  // reuse SCompactVnodeReq, add task monitor since 3.3.8.0

int32_t tSerializeSVTrimDbReq(void* buf, int32_t bufLen, SVTrimDbReq* pReq);
int32_t tDeserializeSVTrimDbReq(void* buf, int32_t bufLen, SVTrimDbReq* pReq);

typedef struct {
  int32_t vgVersion;
  int32_t buffer;
  int32_t pageSize;
  int32_t pages;
  int32_t cacheLastSize;
  int32_t cacheLastShardBits;  // Number of shards for last cache LRU, -1 for auto
  int32_t daysPerFile;
  int32_t daysToKeep0;
  int32_t daysToKeep1;
  int32_t daysToKeep2;
  int32_t keepTimeOffset;
  int32_t walFsyncPeriod;
  int8_t  walLevel;
  int8_t  strict;
  int8_t  cacheLast;
  int64_t reserved[7];
  // 1st modification
  int16_t sttTrigger;
  int32_t minRows;
  // 2nd modification
  int32_t walRetentionPeriod;
  int32_t walRetentionSize;
  int32_t ssKeepLocal;
  int8_t  ssCompact;
  int8_t  allowDrop;
  int8_t  secureDelete;
  int8_t  securityLevel;
  int32_t maxRows;
} SAlterVnodeConfigReq;

int32_t tSerializeSAlterVnodeConfigReq(void* buf, int32_t bufLen, SAlterVnodeConfigReq* pReq);
int32_t tDeserializeSAlterVnodeConfigReq(void* buf, int32_t bufLen, SAlterVnodeConfigReq* pReq);

typedef struct {
  int32_t  vgId;
  int8_t   strict;
  int8_t   selfIndex;
  int8_t   replica;
  SReplica replicas[TSDB_MAX_REPLICA];
  int64_t  reserved[8];
  int8_t   learnerSelfIndex;
  int8_t   learnerReplica;
  SReplica learnerReplicas[TSDB_MAX_LEARNER_REPLICA];
  int32_t  changeVersion;
  int32_t  electBaseLine;
} SAlterVnodeReplicaReq, SAlterVnodeTypeReq, SCheckLearnCatchupReq, SAlterVnodeElectBaselineReq;

int32_t tSerializeSAlterVnodeReplicaReq(void* buf, int32_t bufLen, SAlterVnodeReplicaReq* pReq);
int32_t tDeserializeSAlterVnodeReplicaReq(void* buf, int32_t bufLen, SAlterVnodeReplicaReq* pReq);

typedef struct {
  int32_t vgId;
  int8_t  disable;
} SDisableVnodeWriteReq;

int32_t tSerializeSDisableVnodeWriteReq(void* buf, int32_t bufLen, SDisableVnodeWriteReq* pReq);
int32_t tDeserializeSDisableVnodeWriteReq(void* buf, int32_t bufLen, SDisableVnodeWriteReq* pReq);

typedef struct {
  int32_t  srcVgId;
  int32_t  dstVgId;
  uint32_t hashBegin;
  uint32_t hashEnd;
  int32_t  changeVersion;
  int32_t  reserved;
} SAlterVnodeHashRangeReq;

int32_t tSerializeSAlterVnodeHashRangeReq(void* buf, int32_t bufLen, SAlterVnodeHashRangeReq* pReq);
int32_t tDeserializeSAlterVnodeHashRangeReq(void* buf, int32_t bufLen, SAlterVnodeHashRangeReq* pReq);

#define REQ_OPT_TBNAME 0x0
#define REQ_OPT_TBUID  0x01
typedef struct {
  SMsgHead header;
  char     dbFName[TSDB_DB_FNAME_LEN];
  char     tbName[TSDB_TABLE_NAME_LEN];
  uint8_t  option;
  uint8_t  autoCreateCtb;
  int64_t  txnId;  // batch meta txn: same-txn visibility for PRE_CREATE entries
} STableInfoReq;

int32_t tSerializeSTableInfoReq(void* buf, int32_t bufLen, STableInfoReq* pReq);
int32_t tDeserializeSTableInfoReq(void* buf, int32_t bufLen, STableInfoReq* pReq);

typedef struct {
  int8_t  metaClone;  // create local clone of the cached table meta
  int32_t numOfVgroups;
  int32_t numOfTables;
  int32_t numOfUdfs;
  char    tableNames[];
} SMultiTableInfoReq;

// todo refactor
typedef struct SVgroupInfo {
  int32_t  vgId;
  uint32_t hashBegin;
  uint32_t hashEnd;
  SEpSet   epSet;
  union {
    int32_t numOfTable;  // unit is TSDB_TABLE_NUM_UNIT
    int32_t taskId;      // used in stream
  };
} SVgroupInfo;

typedef struct {
  int32_t     numOfVgroups;
  SVgroupInfo vgroups[];
} SVgroupsInfo;

typedef struct {
  STableMetaRsp* pMeta;
} SMAlterStbRsp;

int32_t tEncodeSMAlterStbRsp(SEncoder* pEncoder, const SMAlterStbRsp* pRsp);
int32_t tDecodeSMAlterStbRsp(SDecoder* pDecoder, SMAlterStbRsp* pRsp);
void    tFreeSMAlterStbRsp(SMAlterStbRsp* pRsp);

int32_t tSerializeSTableMetaRsp(void* buf, int32_t bufLen, STableMetaRsp* pRsp);
int32_t tDeserializeSTableMetaRsp(void* buf, int32_t bufLen, STableMetaRsp* pRsp);
void    tFreeSTableMetaRsp(void* pRsp);
void    tFreeSTableIndexRsp(void* info);

typedef struct {
  SArray* pMetaRsp;   // Array of STableMetaRsp
  SArray* pIndexRsp;  // Array of STableIndexRsp;
} SSTbHbRsp;

int32_t tSerializeSSTbHbRsp(void* buf, int32_t bufLen, SSTbHbRsp* pRsp);
int32_t tDeserializeSSTbHbRsp(void* buf, int32_t bufLen, SSTbHbRsp* pRsp);
void    tFreeSSTbHbRsp(SSTbHbRsp* pRsp);

typedef struct {
  SArray* pViewRsp;  // Array of SViewMetaRsp*;
} SViewHbRsp;

int32_t tSerializeSViewHbRsp(void* buf, int32_t bufLen, SViewHbRsp* pRsp);
int32_t tDeserializeSViewHbRsp(void* buf, int32_t bufLen, SViewHbRsp* pRsp);
void    tFreeSViewHbRsp(SViewHbRsp* pRsp);

typedef struct {
  int32_t numOfTables;
  int32_t numOfVgroup;
  int32_t numOfUdf;
  int32_t contLen;
  int8_t  compressed;  // denote if compressed or not
  int32_t rawLen;      // size before compress
  uint8_t metaClone;   // make meta clone after retrieve meta from mnode
  char    meta[];
} SMultiTableMeta;

typedef struct {
  int32_t dataLen;
  char    name[TSDB_TABLE_FNAME_LEN];
  char*   data;
} STagData;

typedef struct {
  int32_t  opType;
  uint32_t valLen;
  char*    val;
} SShowVariablesReq;

int32_t tSerializeSShowVariablesReq(void* buf, int32_t bufLen, SShowVariablesReq* pReq);
int32_t tDeserializeSShowVariablesReq(void* buf, int32_t bufLen, SShowVariablesReq* pReq);
void    tFreeSShowVariablesReq(SShowVariablesReq* pReq);

typedef struct {
  char name[TSDB_CONFIG_OPTION_LEN + 1];
  char value[TSDB_CONFIG_PATH_LEN + 1];
  char scope[TSDB_CONFIG_SCOPE_LEN + 1];
  char category[TSDB_CONFIG_CATEGORY_LEN + 1];
  char info[TSDB_CONFIG_INFO_LEN + 1];
  char reboot[TSDB_CONFIG_REBOOT_LEN + 1];
} SVariablesInfo;

typedef struct {
  SArray* variables;  // SArray<SVariablesInfo>
} SShowVariablesRsp;

int32_t tSerializeSShowVariablesRsp(void* buf, int32_t bufLen, SShowVariablesRsp* pReq);
int32_t tDeserializeSShowVariablesRsp(void* buf, int32_t bufLen, SShowVariablesRsp* pReq);

void tFreeSShowVariablesRsp(SShowVariablesRsp* pRsp);

/*
 * sql: show tables like '%a_%'
 * payload is the query condition, e.g., '%a_%'
 * payloadLen is the length of payload
 */
typedef struct {
  int32_t type;
  char    db[TSDB_DB_FNAME_LEN];
  int32_t payloadLen;
  char*   payload;
} SShowReq;

int32_t tSerializeSShowReq(void* buf, int32_t bufLen, SShowReq* pReq);
// int32_t tDeserializeSShowReq(void* buf, int32_t bufLen, SShowReq* pReq);
void tFreeSShowReq(SShowReq* pReq);

typedef struct {
  int64_t       showId;
  STableMetaRsp tableMeta;
} SShowRsp, SVShowTablesRsp;

// int32_t tSerializeSShowRsp(void* buf, int32_t bufLen, SShowRsp* pRsp);
// int32_t tDeserializeSShowRsp(void* buf, int32_t bufLen, SShowRsp* pRsp);
// void    tFreeSShowRsp(SShowRsp* pRsp);

typedef struct {
  char    db[TSDB_DB_FNAME_LEN];
  char    tb[TSDB_TABLE_NAME_LEN];
  char    user[TSDB_USER_LEN];
  char    filterTb[TSDB_TABLE_NAME_LEN];  // for ins_columns
  int64_t showId;
  int64_t compactId;  // for compact
  int64_t txnId;      // batch meta txn: same-txn visibility
  bool    withFull;   // for show users full
  int8_t  xnodeDsnOutputMode;
  int8_t  xnodeRetrieveFilterType;
  int64_t xnodeRetrieveFilterValue;
} SRetrieveTableReq;

typedef enum {
  XNODE_DSN_OUTPUT_DEFAULT = 0,
  XNODE_DSN_OUTPUT_ENCRYPTED = 1,
} EXnodeDsnOutputMode;

typedef enum {
  XNODE_RETRIEVE_FILTER_NONE = 0,
  XNODE_RETRIEVE_FILTER_ID_EQ = 1,
  XNODE_RETRIEVE_FILTER_TASK_ID_EQ = 2,
} EXnodeRetrieveFilterType;

typedef struct SSysTableSchema {
  int8_t   type;
  col_id_t colId;
  int32_t  bytes;
} SSysTableSchema;

int32_t tSerializeSRetrieveTableReq(void* buf, int32_t bufLen, SRetrieveTableReq* pReq);
int32_t tDeserializeSRetrieveTableReq(void* buf, int32_t bufLen, SRetrieveTableReq* pReq);
// Checks that the xnode retrieve options are consistent with the requested system table.
// Defined in common/src/systable.c, next to the schemas the rules are derived from.
int32_t tValidateSRetrieveTableReq(const SRetrieveTableReq* pReq);

#define RETRIEVE_TABLE_RSP_VERSION         0
#define RETRIEVE_TABLE_RSP_TMQ_VERSION     1
#define RETRIEVE_TABLE_RSP_TMQ_RAW_VERSION 2

typedef struct {
  int64_t useconds;
  int8_t  completed;  // all results are returned to client
  int8_t  precision;
  int8_t  compressed;
  int8_t  streamBlockType;
  int32_t payloadLen;
  int32_t compLen;
  int32_t numOfBlocks;
  int64_t numOfRows;  // from int32_t change to int64_t
  int64_t numOfCols;
  int64_t skey;
  int64_t ekey;
  int64_t version;                         // for stream
  TSKEY   watermark;                       // for stream
  char    parTbName[TSDB_TABLE_NAME_LEN];  // for stream
  char    data[];
} SRetrieveTableRsp;

#define PAYLOAD_PREFIX_LEN ((sizeof(int32_t)) << 1)

#define SET_PAYLOAD_LEN(_p, _compLen, _fullLen) \
  do {                                          \
    ((int32_t*)(_p))[0] = (_compLen);           \
    ((int32_t*)(_p))[1] = (_fullLen);           \
  } while (0);

typedef struct {
  int64_t version;
  int64_t numOfRows;
  int8_t  compressed;
  int8_t  precision;
  char    data[];
} SRetrieveTableRspForTmq;

typedef struct {
  int64_t handle;
  int64_t useconds;
  int8_t  completed;  // all results are returned to client
  int8_t  precision;
  int8_t  compressed;
  int32_t compLen;
  int32_t numOfRows;
  int32_t fullLen;
  char    data[];
} SRetrieveMetaTableRsp;

typedef struct SExplainCorrelationStat {
  int32_t  templateId;
  uint64_t inputRows;
  uint64_t calls;
  int64_t  elapsedUs;
} SExplainCorrelationStat;

typedef struct SExplainExecInfo {
  /* the number of rows returned */
  uint64_t numOfRows;
  uint32_t verboseLen;
  void*    verboseInfo;

  /* the timestamp when the operator is created */
  TSKEY    execCreate;
  /* the first timestamp when the operator's next interface is called */
  TSKEY    execStart;
  /* the timestamp when the first row is returned */
  TSKEY    execFirstRow;
  /* the timestamp when the last row is returned */
  TSKEY    execLastRow;
  /* the number of times the operator's next interface is called */
  uint32_t execTimes;
  /**
    the time elapsed for executing the operator's next interface,
    not including waiting time for data from downstream
  */
  TSKEY    execElapsed;
  /* the time elapsed for waiting for data from downstream */
  TSKEY    inputWaitElapsed;
  /* the time elapsed for waiting call from upstream */
  TSKEY    outputWaitElapsed;
  /* the number of rows input */
  uint64_t inputRows;

  int32_t  vgId;
  uint32_t correlationStatNum;
  SExplainCorrelationStat* pCorrelationStats;
} SExplainExecInfo;

typedef struct {
  int32_t           numOfPlans;
  SExplainExecInfo* subplanInfo;
} SExplainRsp;

typedef struct {
  SExplainRsp rsp;
  uint64_t    qId;
  uint64_t    cId;
  uint64_t    tId;
  int64_t     rId;
  int32_t     eId;
} SExplainLocalRsp;

typedef struct STableScanAnalyzeInfo {
  int64_t totalBlocks;
  int64_t fileLoadBlocks;
  double  fileLoadElapsed;
  int64_t sttLoadBlocks;
  double  sttLoadElapsed;
  int64_t memLoadBlocks;
  double  memLoadElapsed;
  int64_t smaLoadBlocks;
  double  smaLoadElapsed;
  int64_t composedBlocks;
  double  composedElapsed;
  
  uint64_t checkRows;

  uint64_t skipBlocks;
  uint64_t filterOutBlocks;
  double   filterTime;
} STableScanAnalyzeInfo;

int32_t tSerializeSExplainRsp(void* buf, int32_t bufLen, SExplainRsp* pRsp);
int32_t tDeserializeSExplainRsp(void* buf, int32_t bufLen, SExplainRsp* pRsp);
void    tFreeSExplainRsp(SExplainRsp* pRsp);

typedef struct {
  char    config[TSDB_DNODE_CONFIG_LEN];
  char    value[TSDB_CLUSTER_VALUE_LEN];
  int32_t sqlLen;
  char*   sql;
} SMCfgClusterReq;

int32_t tSerializeSMCfgClusterReq(void* buf, int32_t bufLen, SMCfgClusterReq* pReq);
int32_t tDeserializeSMCfgClusterReq(void* buf, int32_t bufLen, SMCfgClusterReq* pReq);
void    tFreeSMCfgClusterReq(SMCfgClusterReq* pReq);

typedef struct {
  char    fqdn[TSDB_FQDN_LEN];  // end point, hostname:port
  int32_t port;
  int32_t sqlLen;
  char*   sql;
} SCreateDnodeReq;

int32_t tSerializeSCreateDnodeReq(void* buf, int32_t bufLen, SCreateDnodeReq* pReq);
int32_t tDeserializeSCreateDnodeReq(void* buf, int32_t bufLen, SCreateDnodeReq* pReq);
void    tFreeSCreateDnodeReq(SCreateDnodeReq* pReq);

typedef struct {
  int32_t dnodeId;
  char    fqdn[TSDB_FQDN_LEN];
  int32_t port;
  int8_t  force;
  int8_t  unsafe;
  int32_t sqlLen;
  char*   sql;
} SDropDnodeReq;

int32_t tSerializeSDropDnodeReq(void* buf, int32_t bufLen, SDropDnodeReq* pReq);
int32_t tDeserializeSDropDnodeReq(void* buf, int32_t bufLen, SDropDnodeReq* pReq);
void    tFreeSDropDnodeReq(SDropDnodeReq* pReq);

enum {
  RESTORE_TYPE__ALL = 1,
  RESTORE_TYPE__MNODE,
  RESTORE_TYPE__VNODE,
  RESTORE_TYPE__QNODE,
};

typedef struct {
  int32_t dnodeId;
  int8_t  restoreType;
  int32_t sqlLen;
  char*   sql;
  int32_t vgId;
  // parallel: upper limit on the number of vnodes restored in parallel. 0 means no limit (backward compatible).
  int32_t parallel;
} SRestoreDnodeReq;

int32_t tSerializeSRestoreDnodeReq(void* buf, int32_t bufLen, SRestoreDnodeReq* pReq);
int32_t tDeserializeSRestoreDnodeReq(void* buf, int32_t bufLen, SRestoreDnodeReq* pReq);
void    tFreeSRestoreDnodeReq(SRestoreDnodeReq* pReq);

typedef struct {
  int32_t dnodeId;
  char    config[TSDB_DNODE_CONFIG_LEN];
  char    value[TSDB_DNODE_VALUE_LEN];
  int32_t sqlLen;
  char*   sql;
} SMCfgDnodeReq;

int32_t tSerializeSMCfgDnodeReq(void* buf, int32_t bufLen, SMCfgDnodeReq* pReq);
int32_t tDeserializeSMCfgDnodeReq(void* buf, int32_t bufLen, SMCfgDnodeReq* pReq);
void    tFreeSMCfgDnodeReq(SMCfgDnodeReq* pReq);

typedef struct {
  int8_t  keyType;  // 0: SVR_KEY, 1: DB_KEY
  char    newKey[ENCRYPT_KEY_LEN + 1];
  int32_t sqlLen;
  char*   sql;
} SMAlterEncryptKeyReq;

int32_t tSerializeSMAlterEncryptKeyReq(void* buf, int32_t bufLen, SMAlterEncryptKeyReq* pReq);
int32_t tDeserializeSMAlterEncryptKeyReq(void* buf, int32_t bufLen, SMAlterEncryptKeyReq* pReq);
void    tFreeSMAlterEncryptKeyReq(SMAlterEncryptKeyReq* pReq);

typedef struct {
  int32_t days;
  char    strategy[ENCRYPT_KEY_EXPIRE_STRATEGY_LEN + 1];
  int32_t sqlLen;
  char*   sql;
} SMAlterKeyExpirationReq;

int32_t tSerializeSMAlterKeyExpirationReq(void* buf, int32_t bufLen, SMAlterKeyExpirationReq* pReq);
int32_t tDeserializeSMAlterKeyExpirationReq(void* buf, int32_t bufLen, SMAlterKeyExpirationReq* pReq);
void    tFreeSMAlterKeyExpirationReq(SMAlterKeyExpirationReq* pReq);

typedef struct {
  char    config[TSDB_DNODE_CONFIG_LEN];
  char    value[TSDB_DNODE_VALUE_LEN];
  int32_t version;
} SDCfgDnodeReq;

int32_t tSerializeSDCfgDnodeReq(void* buf, int32_t bufLen, SDCfgDnodeReq* pReq);
int32_t tDeserializeSDCfgDnodeReq(void* buf, int32_t bufLen, SDCfgDnodeReq* pReq);

typedef struct {
  int32_t dnodeId;
  int32_t sqlLen;
  char*   sql;
} SMCreateMnodeReq, SMDropMnodeReq, SDDropMnodeReq, SMCreateQnodeReq, SMDropQnodeReq, SDCreateQnodeReq, SDDropQnodeReq,
    SMCreateSnodeReq, SMDropSnodeReq, SDDropSnodeReq;

int32_t tSerializeSCreateDropMQSNodeReq(void* buf, int32_t bufLen, SMCreateQnodeReq* pReq);
int32_t tDeserializeSCreateDropMQSNodeReq(void* buf, int32_t bufLen, SMCreateQnodeReq* pReq);

typedef struct {
  int32_t nodeId;
  SEpSet  epSet;
} SNodeEpSet;

typedef struct {
  int32_t    snodeId;
  SNodeEpSet leaders[2];
  SNodeEpSet replica;
  int32_t    sqlLen;
  char*      sql;
} SDCreateSnodeReq;

int32_t tSerializeSDCreateSNodeReq(void* buf, int32_t bufLen, SDCreateSnodeReq* pReq);
int32_t tDeserializeSDCreateSNodeReq(void* buf, int32_t bufLen, SDCreateSnodeReq* pReq);
void    tFreeSDCreateSnodeReq(SDCreateSnodeReq* pReq);

void tFreeSMCreateQnodeReq(SMCreateQnodeReq* pReq);
void tFreeSDDropQnodeReq(SDDropQnodeReq* pReq);
typedef struct {
  int8_t   replica;
  SReplica replicas[TSDB_MAX_REPLICA];
  int8_t   learnerReplica;
  SReplica learnerReplicas[TSDB_MAX_LEARNER_REPLICA];
  int64_t  lastIndex;
  int8_t   encrypted;  // Whether sdb.data is encrypted (0=false, 1=true)
} SDCreateMnodeReq, SDAlterMnodeReq, SDAlterMnodeTypeReq;

int32_t tSerializeSDCreateMnodeReq(void* buf, int32_t bufLen, SDCreateMnodeReq* pReq);
int32_t tDeserializeSDCreateMnodeReq(void* buf, int32_t bufLen, SDCreateMnodeReq* pReq);

typedef struct {
  int32_t urlLen;
  int32_t sqlLen;
  char*   url;
  char*   sql;
} SMCreateAnodeReq;

int32_t tSerializeSMCreateAnodeReq(void* buf, int32_t bufLen, SMCreateAnodeReq* pReq);
int32_t tDeserializeSMCreateAnodeReq(void* buf, int32_t bufLen, SMCreateAnodeReq* pReq);
void    tFreeSMCreateAnodeReq(SMCreateAnodeReq* pReq);

typedef struct {
  int32_t anodeId;
  int32_t sqlLen;
  char*   sql;
} SMDropAnodeReq, SMUpdateAnodeReq;

int32_t tSerializeSMDropAnodeReq(void* buf, int32_t bufLen, SMDropAnodeReq* pReq);
int32_t tDeserializeSMDropAnodeReq(void* buf, int32_t bufLen, SMDropAnodeReq* pReq);
void    tFreeSMDropAnodeReq(SMDropAnodeReq* pReq);
int32_t tSerializeSMUpdateAnodeReq(void* buf, int32_t bufLen, SMUpdateAnodeReq* pReq);
int32_t tDeserializeSMUpdateAnodeReq(void* buf, int32_t bufLen, SMUpdateAnodeReq* pReq);
void    tFreeSMUpdateAnodeReq(SMUpdateAnodeReq* pReq);

typedef struct {
  int32_t dnodeId;
  int32_t bnodeProto;
  int32_t sqlLen;
  char*   sql;
} SMCreateBnodeReq, SDCreateBnodeReq;

int32_t tSerializeSMCreateBnodeReq(void* buf, int32_t bufLen, SMCreateBnodeReq* pReq);
int32_t tDeserializeSMCreateBnodeReq(void* buf, int32_t bufLen, SMCreateBnodeReq* pReq);
void    tFreeSMCreateBnodeReq(SMCreateBnodeReq* pReq);

typedef struct {
  int32_t dnodeId;
  int32_t sqlLen;
  char*   sql;
} SMDropBnodeReq, SDDropBnodeReq;

int32_t tSerializeSMDropBnodeReq(void* buf, int32_t bufLen, SMDropBnodeReq* pReq);
int32_t tDeserializeSMDropBnodeReq(void* buf, int32_t bufLen, SMDropBnodeReq* pReq);
void    tFreeSMDropBnodeReq(SMDropBnodeReq* pReq);

typedef struct {
  bool        shouldFree;
  int32_t     len;
  const char* ptr;
} CowStr;
/**
 * @brief Create a CowStr object.
 *
 * @param len: length of the string.
 * @param ptr: pointer to the string input.
 * @param shouldClone: whether to clone the string.
 * @return CowStr object.
 */
CowStr xCreateCowStr(int32_t len, const char* ptr, bool shouldClone);
/**
 * @brief Set a CowStr object with given string.
 *
 * @param cow: pointer to the CowStr object.
 * @param len: length of the string.
 * @param ptr: pointer to the string input.
 * @param shouldFree: whether to free the string.
 */
void xSetCowStr(CowStr* cow, int32_t len, const char* ptr, bool shouldFree);
/**
 * @brief Clone a CowStr object without copy the string.
 *
 * @param cow: pointer to the CowStr object.
 * @return CowStr object.
 */
CowStr xCloneRefCowStr(CowStr* cow);
/**
 * @brief Convert a CowStr object to a string.
 *
 * @param cow: pointer to the CowStr object.
 */
char* xCowStrToStr(CowStr* cow);
/**
 * @brief Deallocate a CowStr object. Clears the string and resets length to 0.
 *
 * @param cow: pointer to the CowStr object.
 */
void xFreeCowStr(CowStr* cow);
/**
 * @brief Encode and push a CowStr object into the encoder.
 *
 * @param encoder
 * @param cow
 * @return int32_t
 */
int32_t xEncodeCowStr(SEncoder* encoder, CowStr* cow);
/**
 * @brief Decode a CowStr from the encoder.
 *
 * @param decoder
 * @param cow
 * @param shouldClone
 * @return int32_t
 */
int32_t xDecodeCowStr(SDecoder* decoder, CowStr* cow, bool shouldClone);

typedef struct {
  int32_t sqlLen;
  int32_t urlLen;
  int32_t userLen;
  int32_t passLen;
  int32_t passIsMd5;
  char*   sql;
  char*   url;
  char*   user;
  char*   pass;
  CowStr  token;
} SMCreateXnodeReq, SDCreateXnodeReq;

int32_t tSerializeSMCreateXnodeReq(void* buf, int32_t bufLen, SMCreateXnodeReq* pReq);
int32_t tDeserializeSMCreateXnodeReq(void* buf, int32_t bufLen, SMCreateXnodeReq* pReq);
void    tFreeSMCreateXnodeReq(SMCreateXnodeReq* pReq);

typedef struct {
  int32_t xnodeId;
  int32_t force;
  int32_t urlLen;
  int32_t sqlLen;
  char*   url;
  char*   sql;
} SMDropXnodeReq, SDDropXnodeReq;

int32_t tSerializeSMDropXnodeReq(void* buf, int32_t bufLen, SMDropXnodeReq* pReq);
int32_t tDeserializeSMDropXnodeReq(void* buf, int32_t bufLen, SMDropXnodeReq* pReq);
void    tFreeSMDropXnodeReq(SMDropXnodeReq* pReq);

typedef struct {
  int32_t id;
  CowStr  token;
  CowStr  user;
  CowStr  pass;
  int32_t urlLen;
  int32_t sqlLen;
  char*   url;
  char*   sql;
} SMUpdateXnodeReq;
int32_t tSerializeSMUpdateXnodeReq(void* buf, int32_t bufLen, SMUpdateXnodeReq* pReq);
int32_t tDeserializeSMUpdateXnodeReq(void* buf, int32_t bufLen, SMUpdateXnodeReq* pReq);
void    tFreeSMUpdateXnodeReq(SMUpdateXnodeReq* pReq);

typedef struct {
  int32_t xnodeId;
  int32_t sqlLen;
  char*   sql;
} SMDrainXnodeReq;
int32_t tSerializeSMDrainXnodeReq(void* buf, int32_t bufLen, SMDrainXnodeReq* pReq);
int32_t tDeserializeSMDrainXnodeReq(void* buf, int32_t bufLen, SMDrainXnodeReq* pReq);
void    tFreeSMDrainXnodeReq(SMDrainXnodeReq* pReq);

typedef struct {
  int32_t sqlLen;
  char*   sql;
} SMRestartXnodeReq;
int32_t tSerializeSMRestartXnodeReq(void* buf, int32_t bufLen, SMRestartXnodeReq* pReq);
int32_t tDeserializeSMRestartXnodeReq(void* buf, int32_t bufLen, SMRestartXnodeReq* pReq);
void    tFreeSMRestartXnodeReq(SMRestartXnodeReq* pReq);

typedef enum {
  XNODE_TASK_SOURCE_DSN = 1,
  XNODE_TASK_SOURCE_DATABASE,
  XNODE_TASK_SOURCE_TOPIC,
} ENodeXTaskSourceType;

typedef enum {
  XNODE_TASK_SINK_DSN = 1,
  XNODE_TASK_SINK_DATABASE,
} ENodeXTaskSinkType;

typedef struct {
  ENodeXTaskSourceType type;
  CowStr               cstr;
} xTaskSource;
/**
 * @brief Deallocate a xTaskSource object.
 *
 * @param source ptr
 */
void xFreeTaskSource(xTaskSource* source);
/**
 * @brief Create a xTaskSource object with cloned source string.
 *
 * @param sourceType: source type.
 * @param len: length of source string.
 * @param source: source string ptr.
 * @return xTaskSource object
 */
xTaskSource xCreateClonedTaskSource(ENodeXTaskSourceType sourceType, int32_t len, char* ptr);
xTaskSource xCloneTaskSourceRef(xTaskSource* source);
xTaskSource xCreateTaskSource(ENodeXTaskSourceType sourceType, int32_t len, char* ptr);
const char* xGetTaskSourceTypeAsStr(xTaskSource* source);
const char* xGetTaskSourceStr(xTaskSource* source);
int32_t     xSerializeTaskSource(SEncoder* encoder, xTaskSource* source);
int32_t     xDeserializeTaskSource(SDecoder* decoder, xTaskSource* source);

typedef struct {
  ENodeXTaskSinkType type;
  CowStr             cstr;
} xTaskSink;
/**
 * @brief Deallocate a xTaskSink object.
 *
 * @param sink ptr
 */
void xFreeTaskSink(xTaskSink* sink);
/**
 * @brief Create a xTaskSink object with cloned name string.
 *
 * @param sinkType: sink type.
 * @param len: length of sink string.
 * @param ptr: sink string ptr.
 * @return xTaskSink object
 */
xTaskSink   xCreateClonedTaskSink(ENodeXTaskSinkType sinkType, int32_t len, char* ptr);
xTaskSink   xCreateTaskSink(ENodeXTaskSinkType sinkType, int32_t len, char* ptr);
xTaskSink   xCloneTaskSinkRef(xTaskSink* sink);
const char* xGetTaskSinkTypeAsStr(xTaskSink* sink);
const char* xGetTaskSinkStr(xTaskSink* sink);
int32_t     xSerializeTaskSink(SEncoder* encoder, xTaskSink* sink);
int32_t     xDeserializeTaskSink(SDecoder* decoder, xTaskSink* sink);

typedef struct {
  int32_t via;
  CowStr  parser;
  // CowStr  reason;
  CowStr  trigger;
  CowStr  health;
  int32_t optionsNum;
  CowStr  options[TSDB_XNODE_TASK_OPTIONS_MAX_NUM];
} xTaskOptions;
/**
 * @brief Deallocate a xTaskOptions object.
 *
 * @param options ptr
 */
void    xFreeTaskOptions(xTaskOptions* options);
void    printXnodeTaskOptions(xTaskOptions* options);
int32_t xSerializeTaskOptions(SEncoder* encoder, xTaskOptions* options);
int32_t xDeserializeTaskOptions(SDecoder* decoder, xTaskOptions* options);

typedef struct {
  int32_t sqlLen;
  char*   sql;
  int32_t      xnodeId;
  CowStr       name;
  xTaskSource  source;
  xTaskSink    sink;
  xTaskOptions options;
  CowStr       desiredState;
} SMCreateXnodeTaskReq;
int32_t tSerializeSMCreateXnodeTaskReq(void* buf, int32_t bufLen, SMCreateXnodeTaskReq* pReq);
int32_t tDeserializeSMCreateXnodeTaskReq(void* buf, int32_t bufLen, SMCreateXnodeTaskReq* pReq);
void    tFreeSMCreateXnodeTaskReq(SMCreateXnodeTaskReq* pReq);

typedef struct {
  int32_t     tid;
  CowStr      name;
  int32_t     via;
  int32_t     xnodeId;
  CowStr      status;
  xTaskSource source;
  xTaskSink   sink;
  CowStr      parser;
  CowStr      reason;
  CowStr      desiredState;
  CowStr      updateName;
  CowStr      labels;
  int32_t     sqlLen;
  char*       sql;
} SMUpdateXnodeTaskReq;
int32_t tSerializeSMUpdateXnodeTaskReq(void* buf, int32_t bufLen, SMUpdateXnodeTaskReq* pReq);
int32_t tDeserializeSMUpdateXnodeTaskReq(void* buf, int32_t bufLen, SMUpdateXnodeTaskReq* pReq);
void    tFreeSMUpdateXnodeTaskReq(SMUpdateXnodeTaskReq* pReq);

typedef struct {
  int32_t id;
  bool    force;
  CowStr  name;
  int32_t sqlLen;
  char*   sql;
} SMDropXnodeTaskReq;
int32_t tSerializeSMDropXnodeTaskReq(void* buf, int32_t bufLen, SMDropXnodeTaskReq* pReq);
int32_t tDeserializeSMDropXnodeTaskReq(void* buf, int32_t bufLen, SMDropXnodeTaskReq* pReq);
void    tFreeSMDropXnodeTaskReq(SMDropXnodeTaskReq* pReq);

typedef struct {
  int32_t tid;
  CowStr  name;
  int32_t sqlLen;
  char*   sql;
} SMStartXnodeTaskReq, SMStopXnodeTaskReq;
int32_t tSerializeSMStartXnodeTaskReq(void* buf, int32_t bufLen, SMStartXnodeTaskReq* pReq);
int32_t tDeserializeSMStartXnodeTaskReq(void* buf, int32_t bufLen, SMStartXnodeTaskReq* pReq);
void    tFreeSMStartXnodeTaskReq(SMStartXnodeTaskReq* pReq);

int32_t tSerializeSMStopXnodeTaskReq(void* buf, int32_t bufLen, SMStopXnodeTaskReq* pReq);
int32_t tDeserializeSMStopXnodeTaskReq(void* buf, int32_t bufLen, SMStopXnodeTaskReq* pReq);
void    tFreeSMStopXnodeTaskReq(SMStopXnodeTaskReq* pReq);

typedef struct {
  int32_t tid;
  int32_t via;
  int32_t xnodeId;
  CowStr  status;
  CowStr  desiredState;
  CowStr  config;
  CowStr  reason;
  int32_t sqlLen;
  char*   sql;
} SMCreateXnodeJobReq;
int32_t tSerializeSMCreateXnodeJobReq(void* buf, int32_t bufLen, SMCreateXnodeJobReq* pReq);
int32_t tDeserializeSMCreateXnodeJobReq(void* buf, int32_t bufLen, SMCreateXnodeJobReq* pReq);
void    tFreeSMCreateXnodeJobReq(SMCreateXnodeJobReq* pReq);

typedef struct {
  int32_t jid;
  int32_t via;
  int32_t xnodeId;
  CowStr  status;
  CowStr  desiredState;
  int32_t configLen;
  int32_t reasonLen;
  int32_t sqlLen;
  char*   config;
  char*   reason;
  char*   sql;
} SMUpdateXnodeJobReq;
int32_t tSerializeSMUpdateXnodeJobReq(void* buf, int32_t bufLen, SMUpdateXnodeJobReq* pReq);
int32_t tDeserializeSMUpdateXnodeJobReq(void* buf, int32_t bufLen, SMUpdateXnodeJobReq* pReq);
void    tFreeSMUpdateXnodeJobReq(SMUpdateXnodeJobReq* pReq);

typedef struct {
  int32_t jid;
  int32_t xnodeId;
  int32_t sqlLen;
  char*   sql;
} SMRebalanceXnodeJobReq;
int32_t tSerializeSMRebalanceXnodeJobReq(void* buf, int32_t bufLen, SMRebalanceXnodeJobReq* pReq);
int32_t tDeserializeSMRebalanceXnodeJobReq(void* buf, int32_t bufLen, SMRebalanceXnodeJobReq* pReq);
void    tFreeSMRebalanceXnodeJobReq(SMRebalanceXnodeJobReq* pReq);

typedef struct {
  CowStr  ast;
  int32_t sqlLen;
  char*   sql;
} SMRebalanceXnodeJobsWhereReq;
int32_t tSerializeSMRebalanceXnodeJobsWhereReq(void* buf, int32_t bufLen, SMRebalanceXnodeJobsWhereReq* pReq);
int32_t tDeserializeSMRebalanceXnodeJobsWhereReq(void* buf, int32_t bufLen, SMRebalanceXnodeJobsWhereReq* pReq);
void    tFreeSMRebalanceXnodeJobsWhereReq(SMRebalanceXnodeJobsWhereReq* pReq);

typedef struct {
  int32_t jid;
  CowStr  ast;
  int32_t sqlLen;
  char*   sql;
} SMDropXnodeJobReq;
int32_t tSerializeSMDropXnodeJobReq(void* buf, int32_t bufLen, SMDropXnodeJobReq* pReq);
int32_t tDeserializeSMDropXnodeJobReq(void* buf, int32_t bufLen, SMDropXnodeJobReq* pReq);
void    tFreeSMDropXnodeJobReq(SMDropXnodeJobReq* pReq);

typedef struct {
  int32_t      sqlLen;
  char*        sql;
  CowStr       name;
  CowStr       status;
  xTaskOptions options;
} SMCreateXnodeAgentReq;
int32_t tSerializeSMCreateXnodeAgentReq(void* buf, int32_t bufLen, SMCreateXnodeAgentReq* pReq);
int32_t tDeserializeSMCreateXnodeAgentReq(void* buf, int32_t bufLen, SMCreateXnodeAgentReq* pReq);
void    tFreeSMCreateXnodeAgentReq(SMCreateXnodeAgentReq* pReq);

typedef struct {
  int32_t      sqlLen;
  char*        sql;
  int32_t      id;
  CowStr       name;
  xTaskOptions options;
} SMUpdateXnodeAgentReq;
int32_t tSerializeSMUpdateXnodeAgentReq(void* buf, int32_t bufLen, SMUpdateXnodeAgentReq* pReq);
int32_t tDeserializeSMUpdateXnodeAgentReq(void* buf, int32_t bufLen, SMUpdateXnodeAgentReq* pReq);
void    tFreeSMUpdateXnodeAgentReq(SMUpdateXnodeAgentReq* pReq);

typedef SMDropXnodeTaskReq SMDropXnodeAgentReq;
int32_t                    tSerializeSMDropXnodeAgentReq(void* buf, int32_t bufLen, SMDropXnodeAgentReq* pReq);
int32_t                    tDeserializeSMDropXnodeAgentReq(void* buf, int32_t bufLen, SMDropXnodeAgentReq* pReq);
void                       tFreeSMDropXnodeAgentReq(SMDropXnodeAgentReq* pReq);

typedef struct {
  int32_t vgId;
  int32_t hbSeq;
} SVArbHbReqMember;

typedef struct {
  int32_t dnodeId;
  char*   arbToken;
  int64_t arbTerm;
  SArray* hbMembers;  // SVArbHbReqMember
} SVArbHeartBeatReq;

int32_t tSerializeSVArbHeartBeatReq(void* buf, int32_t bufLen, SVArbHeartBeatReq* pReq);
int32_t tDeserializeSVArbHeartBeatReq(void* buf, int32_t bufLen, SVArbHeartBeatReq* pReq);
void    tFreeSVArbHeartBeatReq(SVArbHeartBeatReq* pReq);

typedef struct {
  int32_t vgId;
  char    memberToken[TSDB_ARB_TOKEN_SIZE];
  int32_t hbSeq;
} SVArbHbRspMember;

typedef struct {
  char    arbToken[TSDB_ARB_TOKEN_SIZE];
  int32_t dnodeId;
  SArray* hbMembers;  // SVArbHbRspMember
} SVArbHeartBeatRsp;

int32_t tSerializeSVArbHeartBeatRsp(void* buf, int32_t bufLen, SVArbHeartBeatRsp* pRsp);
int32_t tDeserializeSVArbHeartBeatRsp(void* buf, int32_t bufLen, SVArbHeartBeatRsp* pRsp);
void    tFreeSVArbHeartBeatRsp(SVArbHeartBeatRsp* pRsp);

typedef struct {
  char*   arbToken;
  int64_t arbTerm;
  char*   member0Token;
  char*   member1Token;
} SVArbCheckSyncReq;

int32_t tSerializeSVArbCheckSyncReq(void* buf, int32_t bufLen, SVArbCheckSyncReq* pReq);
int32_t tDeserializeSVArbCheckSyncReq(void* buf, int32_t bufLen, SVArbCheckSyncReq* pReq);
void    tFreeSVArbCheckSyncReq(SVArbCheckSyncReq* pRsp);

typedef struct {
  char*   arbToken;
  char*   member0Token;
  char*   member1Token;
  int32_t vgId;
  int32_t errCode;
} SVArbCheckSyncRsp;

int32_t tSerializeSVArbCheckSyncRsp(void* buf, int32_t bufLen, SVArbCheckSyncRsp* pRsp);
int32_t tDeserializeSVArbCheckSyncRsp(void* buf, int32_t bufLen, SVArbCheckSyncRsp* pRsp);
void    tFreeSVArbCheckSyncRsp(SVArbCheckSyncRsp* pRsp);

typedef struct {
  char*   arbToken;
  int64_t arbTerm;
  char*   memberToken;
  int8_t  force;
} SVArbSetAssignedLeaderReq;

int32_t tSerializeSVArbSetAssignedLeaderReq(void* buf, int32_t bufLen, SVArbSetAssignedLeaderReq* pReq);
int32_t tDeserializeSVArbSetAssignedLeaderReq(void* buf, int32_t bufLen, SVArbSetAssignedLeaderReq* pReq);
void    tFreeSVArbSetAssignedLeaderReq(SVArbSetAssignedLeaderReq* pReq);

typedef struct {
  char* data;
} SVAuditRecordReq;
int32_t tSerializeSVAuditRecordReq(void* buf, int32_t bufLen, SVAuditRecordReq* pReq);
int32_t tDeserializeSVAuditRecordReq(void* buf, int32_t bufLen, SVAuditRecordReq* pReq);
void    tFreeSVAuditRecordReq(SVAuditRecordReq* pReq);

typedef struct {
  char*   arbToken;
  char*   memberToken;
  int32_t vgId;
} SVArbSetAssignedLeaderRsp;

int32_t tSerializeSVArbSetAssignedLeaderRsp(void* buf, int32_t bufLen, SVArbSetAssignedLeaderRsp* pRsp);
int32_t tDeserializeSVArbSetAssignedLeaderRsp(void* buf, int32_t bufLen, SVArbSetAssignedLeaderRsp* pRsp);
void    tFreeSVArbSetAssignedLeaderRsp(SVArbSetAssignedLeaderRsp* pRsp);

typedef struct {
  int32_t dnodeId;
  char*   token;
} SMArbUpdateGroupMember;

typedef struct {
  int32_t dnodeId;
  char*   token;
  int8_t  acked;
} SMArbUpdateGroupAssigned;

typedef struct {
  int32_t                  vgId;
  int64_t                  dbUid;
  SMArbUpdateGroupMember   members[2];
  int8_t                   isSync;
  int8_t                   assignedAcked;
  SMArbUpdateGroupAssigned assignedLeader;
  int64_t                  version;
  int32_t                  code;
  int64_t                  updateTimeMs;
} SMArbUpdateGroup;

typedef struct {
  SArray* updateArray;  // SMArbUpdateGroup
} SMArbUpdateGroupBatchReq;

int32_t tSerializeSMArbUpdateGroupBatchReq(void* buf, int32_t bufLen, SMArbUpdateGroupBatchReq* pReq);
int32_t tDeserializeSMArbUpdateGroupBatchReq(void* buf, int32_t bufLen, SMArbUpdateGroupBatchReq* pReq);
void    tFreeSMArbUpdateGroupBatchReq(SMArbUpdateGroupBatchReq* pReq);

typedef struct {
  char queryStrId[TSDB_QUERY_ID_LEN];
} SKillQueryReq;

int32_t tSerializeSKillQueryReq(void* buf, int32_t bufLen, SKillQueryReq* pReq);
int32_t tDeserializeSKillQueryReq(void* buf, int32_t bufLen, SKillQueryReq* pReq);

typedef struct {
  uint32_t connId;
} SKillConnReq;

int32_t tSerializeSKillConnReq(void* buf, int32_t bufLen, SKillConnReq* pReq);
int32_t tDeserializeSKillConnReq(void* buf, int32_t bufLen, SKillConnReq* pReq);

typedef struct {
  int64_t transId;
} SKillTransReq;

int32_t tSerializeSKillTransReq(void* buf, int32_t bufLen, SKillTransReq* pReq);
int32_t tDeserializeSKillTransReq(void* buf, int32_t bufLen, SKillTransReq* pReq);

// Distributed transaction: BEGIN / COMMIT / ROLLBACK
typedef struct {
  int32_t useless;  // placeholder
  int32_t sqlLen;
  char*   sql;
} SBeginTransReq;

int32_t tSerializeSBeginTransReq(void* buf, int32_t bufLen, SBeginTransReq* pReq);
int32_t tDeserializeSBeginTransReq(void* buf, int32_t bufLen, SBeginTransReq* pReq);
void    tFreeSBeginTransReq(SBeginTransReq* pReq);

typedef struct {
  int32_t useless;  // placeholder
  int32_t sqlLen;
  char*   sql;
} SCommitTransReq;

int32_t tSerializeSCommitTransReq(void* buf, int32_t bufLen, SCommitTransReq* pReq);
int32_t tDeserializeSCommitTransReq(void* buf, int32_t bufLen, SCommitTransReq* pReq);
void    tFreeSCommitTransReq(SCommitTransReq* pReq);

typedef struct {
  int32_t useless;  // placeholder
  int32_t sqlLen;
  char*   sql;
} SRollbackTransReq;

int32_t tSerializeSRollbackTransReq(void* buf, int32_t bufLen, SRollbackTransReq* pReq);
int32_t tDeserializeSRollbackTransReq(void* buf, int32_t bufLen, SRollbackTransReq* pReq);
void    tFreeSRollbackTransReq(SRollbackTransReq* pReq);

typedef struct {
  int32_t useless;  // useless
  int32_t sqlLen;
  char*   sql;
} SBalanceVgroupReq;

int32_t tSerializeSBalanceVgroupReq(void* buf, int32_t bufLen, SBalanceVgroupReq* pReq);
int32_t tDeserializeSBalanceVgroupReq(void* buf, int32_t bufLen, SBalanceVgroupReq* pReq);
void    tFreeSBalanceVgroupReq(SBalanceVgroupReq* pReq);

typedef struct {
  int32_t useless;  // reserved; empty request
} SFlushMnodeReq;

int32_t tSerializeSFlushMnodeReq(void* buf, int32_t bufLen, SFlushMnodeReq* pReq);
int32_t tDeserializeSFlushMnodeReq(void* buf, int32_t bufLen, SFlushMnodeReq* pReq);
void    tFreeSFlushMnodeReq(SFlushMnodeReq* pReq);

typedef struct {
  int32_t useless;  // useless
  int32_t sqlLen;
  char*   sql;
} SAssignLeaderReq;

int32_t tSerializeSAssignLeaderReq(void* buf, int32_t bufLen, SAssignLeaderReq* pReq);
int32_t tDeserializeSAssignLeaderReq(void* buf, int32_t bufLen, SAssignLeaderReq* pReq);
void    tFreeSAssignLeaderReq(SAssignLeaderReq* pReq);
typedef struct {
  int32_t vgId1;
  int32_t vgId2;
} SMergeVgroupReq;

int32_t tSerializeSMergeVgroupReq(void* buf, int32_t bufLen, SMergeVgroupReq* pReq);
int32_t tDeserializeSMergeVgroupReq(void* buf, int32_t bufLen, SMergeVgroupReq* pReq);

typedef struct {
  int32_t vgId;
  int32_t dnodeId1;
  int32_t dnodeId2;
  int32_t dnodeId3;
  int32_t sqlLen;
  char*   sql;
} SRedistributeVgroupReq;

int32_t tSerializeSRedistributeVgroupReq(void* buf, int32_t bufLen, SRedistributeVgroupReq* pReq);
int32_t tDeserializeSRedistributeVgroupReq(void* buf, int32_t bufLen, SRedistributeVgroupReq* pReq);
void    tFreeSRedistributeVgroupReq(SRedistributeVgroupReq* pReq);

typedef struct {
  int32_t reserved;
  int32_t vgId;
  int32_t sqlLen;
  char*   sql;
  char    db[TSDB_DB_FNAME_LEN];
} SBalanceVgroupLeaderReq;

int32_t tSerializeSBalanceVgroupLeaderReq(void* buf, int32_t bufLen, SBalanceVgroupLeaderReq* pReq);
int32_t tDeserializeSBalanceVgroupLeaderReq(void* buf, int32_t bufLen, SBalanceVgroupLeaderReq* pReq);
void    tFreeSBalanceVgroupLeaderReq(SBalanceVgroupLeaderReq* pReq);

typedef struct {
  int32_t vgId;
} SForceBecomeFollowerReq;

int32_t tSerializeSForceBecomeFollowerReq(void* buf, int32_t bufLen, SForceBecomeFollowerReq* pReq);
// int32_t tDeserializeSForceBecomeFollowerReq(void* buf, int32_t bufLen, SForceBecomeFollowerReq* pReq);

typedef struct {
  int32_t vgId;
  bool    force;
} SSplitVgroupReq;

int32_t tSerializeSSplitVgroupReq(void* buf, int32_t bufLen, SSplitVgroupReq* pReq);
int32_t tDeserializeSSplitVgroupReq(void* buf, int32_t bufLen, SSplitVgroupReq* pReq);

typedef struct {
  int32_t vgId;
  int32_t dnodeId;
  int32_t sqlLen;
  char*   sql;
} SCloseVnodeReq;

int32_t tSerializeSCloseVnodeReq(void* buf, int32_t bufLen, SCloseVnodeReq* pReq);
int32_t tDeserializeSCloseVnodeReq(void* buf, int32_t bufLen, SCloseVnodeReq* pReq);
void    tFreeSCloseVnodeReq(SCloseVnodeReq* pReq);

typedef struct {
  int32_t vgId;
  int32_t dnodeId;
  int32_t sqlLen;
  char*   sql;
} SOpenVnodeReq;

int32_t tSerializeSOpenVnodeReq(void* buf, int32_t bufLen, SOpenVnodeReq* pReq);
int32_t tDeserializeSOpenVnodeReq(void* buf, int32_t bufLen, SOpenVnodeReq* pReq);
void    tFreeSOpenVnodeReq(SOpenVnodeReq* pReq);

typedef struct {
  char user[TSDB_USER_LEN];
  char spi;
  char encrypt;
  char secret[TSDB_PASSWORD_LEN];
  char ckey[TSDB_PASSWORD_LEN];
} SAuthReq, SAuthRsp;

// int32_t tSerializeSAuthReq(void* buf, int32_t bufLen, SAuthReq* pReq);
// int32_t tDeserializeSAuthReq(void* buf, int32_t bufLen, SAuthReq* pReq);

typedef struct {
  int32_t statusCode;
  char    details[1024];
} SServerStatusRsp;

int32_t tSerializeSServerStatusRsp(void* buf, int32_t bufLen, SServerStatusRsp* pRsp);
int32_t tDeserializeSServerStatusRsp(void* buf, int32_t bufLen, SServerStatusRsp* pRsp);

/**
 * The layout of the query message payload is as following:
 * +--------------------+---------------------------------+
 * |Sql statement       | Physical plan                   |
 * |(denoted by sqlLen) |(In JSON, denoted by contentLen) |
 * +--------------------+---------------------------------+
 */
typedef struct SCorrelationParamDef {
  int32_t   paramId;
  SDataType dataType;
} SCorrelationParamDef;

typedef struct SCorrelationWireValue {
  int32_t   paramId;
  SDataType dataType;
  bool      isNull;
  int32_t   dataLen;  // Exact byte length; zero when isNull is true.
  uint8_t*  pData;    // May contain NUL; owned on decode/copy, borrowed on send.
} SCorrelationWireValue;

typedef struct SCorrelationExecution {
  uint64_t rootExecutionId;
  uint64_t rootQueryId;
  uint64_t rootClientId;
  uint32_t executionGeneration;
  uint64_t parentQueryId;
  uint64_t parentClientId;
  uint64_t parentTaskId;
  uint64_t parentSeriesId;
  int32_t  parentExecId;
  int32_t  templateId;
  uint64_t callOrdinal;
  // Bounded NUL-terminated names copied into the task-session context.
  char     user[TSDB_USER_LEN];
  char     dbFName[TSDB_DB_FNAME_LEN];
  char     timezoneName[TD_TIMEZONE_LEN];
  char     charsetName[TD_LOCALE_LEN];
} SCorrelationExecution;

typedef struct SSubQueryMsg {
  SMsgHead header;
  uint64_t sId;
  uint64_t queryId;
  uint64_t clientId;
  uint64_t taskId;
  int64_t  refId;
  int32_t  execId;
  int32_t  msgMask;
  int32_t  subQType;
  int8_t   taskType;
  int8_t   explain;
  int8_t   needFetch;
  int8_t   compress;
  int8_t   firstDayOfWeek;
  uint32_t sqlLen;
  char*    sql;
  uint32_t msgLen;
  char*    msg;
  SArray*  subEndPoints;  // subJobs's endpoints, element is SDownstreamSourceNode*
  int64_t  txnId;         // batch meta txn ID (0 = not in txn)
  SCorrelationExecution correlation;
  SArray*  pCorrelationParamDefs;    // SCorrelationParamDef elements.
  SArray*  pCorrelationParamValues;  // SCorrelationWireValue elements.
  uint32_t correlationTemplatesLen;
  char*    pCorrelationTemplates;    // Owned on decode; borrowed on send.
  uint32_t correlationTimeInitLen;
  char*    pCorrelationTimeInit;     // Owned on decode; borrowed on send.
  SArray*  pCorrelationNodeList;     // SQueryNodeLoad candidates inherited by nested jobs.
  // Set only by the scheduler for a pure VNode scan eligible for replica execution.
  bool     allowFollowerRead;
} SSubQueryMsg;

int32_t tSerializeSSubQueryMsg(void* buf, int32_t bufLen, SSubQueryMsg* pReq);
int32_t tDeserializeSSubQueryMsg(void* buf, int32_t bufLen, SSubQueryMsg* pReq);
void    tFreeSSubQueryMsg(SSubQueryMsg* pReq);
int32_t tValidateCorrelationParams(const SArray* pDefs, const SArray* pValues);

typedef struct {
  SMsgHead header;
  uint64_t sId;
  uint64_t queryId;
  uint64_t taskId;
} SSinkDataReq;

typedef struct {
  SMsgHead header;
  uint64_t sId;
  uint64_t queryId;
  uint64_t clientId;
  uint64_t taskId;
  int32_t  execId;
  int32_t  taskType;
} SQueryContinueReq;

typedef struct {
  SMsgHead header;
  uint64_t sId;
  uint64_t queryId;
  uint64_t taskId;
} SResReadyReq;

typedef struct {
  int32_t code;
  char    tbFName[TSDB_TABLE_FNAME_LEN];
  int32_t sversion;
  int32_t tversion;
} SResReadyRsp;

typedef enum { OP_GET_PARAM = 1, OP_NOTIFY_PARAM } SOperatorParamType;

typedef struct SOperatorParam {
  int32_t opType;
  int32_t downstreamIdx;
  void*   value;
  SArray* pChildren;  // SArray<SOperatorParam*>
  bool    reUse;
} SOperatorParam;


int32_t tSerializeSOperatorParam(SEncoder *pEncoder, SOperatorParam *pOpParam);
int32_t tDeserializeSOperatorParam(SDecoder *pDecoder, SOperatorParam *pOpParam);
void freeOperatorParam(SOperatorParam* pParam, SOperatorParamType type);

// virtual table's colId to origin table's colname
typedef struct SColIdNameKV {
  col_id_t colId;
  char     colName[TSDB_COL_NAME_LEN];
} SColIdNameKV;

typedef struct SVTagCondEntry {
  col_id_t colId;
  int32_t  tagCondLen;
  char*    tagCondJson;  // heap, owned by SVTagCondRsp
} SVTagCondEntry;

typedef struct SVtbColFilterCond {
  col_id_t colId;
  int32_t  filterCondLen;
  char*    filterCondJson;  // heap, owned by SVTagCondRsp
} SVtbColFilterCond;

typedef struct SVTagCondReq {
  SMsgHead header;
  char     dbFName[TSDB_DB_FNAME_LEN];
  int64_t  uid;  // virtual sub-table uid
} SVTagCondReq;

typedef struct SVTagCondRsp {
  int32_t numOfRefs;
  SArray* pEntries;  // SArray<SVTagCondEntry>
  int32_t numOfFilterConds;
  SArray* pFilterConds;  // optional tail extension: SArray<SVtbColFilterCond>
} SVTagCondRsp;

int32_t tSerializeSVTagCondReq(void* buf, int32_t bufLen, SVTagCondReq* pReq);
int32_t tDeserializeSVTagCondReq(void* buf, int32_t bufLen, SVTagCondReq* pReq);
int32_t tSerializeSVTagCondRsp(void* buf, int32_t bufLen, SVTagCondRsp* pRsp);
int32_t tDeserializeSVTagCondRsp(void* buf, int32_t bufLen, SVTagCondRsp* pRsp);
void    tDestroySVTagCondRsp(void* rsp);

#define COL_MASK_ON   ((int8_t)0x1)
#define IS_MASK_ON(c) (((c)->flags & 0x01) == COL_MASK_ON)
#define COL_SET_MASK_ON(c)     \
  do {                         \
    (c)->flags |= COL_MASK_ON; \
  } while (0)

typedef struct SColNameFlag {
  col_id_t colId;
  char     colName[TSDB_COL_NAME_LEN];
  int8_t   flags;  // 0x01: COL_MASK_ON
} SColNameFlag;

typedef struct SColIdPair {
  col_id_t  vtbColId;
  col_id_t  orgColId;
  SDataType type;
} SColIdPair;

typedef struct SColIdSlotIdPair {
  int32_t  vtbSlotId;
  col_id_t orgColId;
} SColIdSlotIdPair;

typedef struct SOrgTbInfo {
  int32_t vgId;
  char    tbName[TSDB_TABLE_FNAME_LEN];
  SArray* colMap;       // SArray<SColIdNameKV>
  uint8_t srcPrecision; // source DB precision; UINT8_MAX = unknown (use getVnodePrecision at runtime)
  uint8_t dstPrecision; // vtable precision; UINT8_MAX = unknown
} SOrgTbInfo;

typedef struct SForeignSourceInfo {
  char    sourceName[TSDB_EXT_SOURCE_NAME_LEN];
  char    dbName[TSDB_DB_NAME_LEN];
  char    tableName[TSDB_TABLE_NAME_LEN];
  SArray* colMap;   // SArray<SColIdNameKV>
  char*   tagCond;  // heap, owned; external series filter shared by this group (may be NULL)
  int32_t tagCondLen;
  uint64_t scanParamId;    // stable identity of one external scan parameter group
  int32_t  filterCondLen;
  char*    filterCondJson;  // serialized external column filter, heap owned
  int64_t rowLimit;  // optional per-stream top-N limit for VStb remote SQL; <=0 means unset
  SNode*  pPushedCond;  // heap, owned; VStb local filter fragment safe to push to this foreign source
  uint64_t virtualChildUid;  // virtual child whose row is reconstructed from this remote table
} SForeignSourceInfo;

void destroySOrgTbInfo(void *info);
void destroySForeignSourceInfo(void *info);

typedef enum {
  DYN_TYPE_STB_JOIN = 1,
  DYN_TYPE_VSTB_SINGLE_SCAN,
  DYN_TYPE_VSTB_BATCH_SCAN,
  DYN_TYPE_VSTB_WIN_SCAN,
  DYN_TYPE_TWO_PASS_RESCAN,  // coord-driven vtable two-pass phase-2 rescan
} ETableScanDynType;

typedef enum {
  DYN_TYPE_SCAN_PARAM = 1,
  NOTIFY_TYPE_SCAN_PARAM,
} ETableScanGetParamType;

typedef struct STableScanOperatorParam {
  ETableScanGetParamType paramType;
  /* for building scan data source */
  bool                   tableSeq;
  bool                   isNewParam;
  uint64_t               groupid;
  SArray*                pUidList;
  SOrgTbInfo*            pOrgTbInfo;
  SArray*                pBatchTbInfo;  // SArray<SOrgTbInfo>
  SArray*                pTagList;
  STimeWindow            window;
  ETableScanDynType      dynType;
  /* for notifying source step done */
  bool     notifyToProcess;    // received notify STEP DONE message
  TSKEY    notifyTs;           // notify timestamp
  int8_t   notifyPhase;        // EScanPhase of the source scan
  uint64_t notifyScanGroupId;  // source scan group identity
} STableScanOperatorParam;

typedef struct STagScanOperatorParam {
  tb_uid_t vcUid;
} STagScanOperatorParam;

typedef struct SRefColIdGroup {
  SArray* pSlotIdList;  // SArray<int32_t>
} SRefColIdGroup;

typedef struct SVTableScanOperatorParam {
  uint64_t        uid;
  STimeWindow     window;
  SOperatorParam* pTagScanOp;
  int32_t         tagDownStreamId;
  char            tbName[TSDB_TABLE_NAME_LEN];
  SArray*         pOpParamArray;       // SArray<SOperatorParam>  -  internal Exchange params
  SArray*         pForeignParamArray;  // SArray<SOperatorParam>  -  external FederatedScan params
  SArray*         pRefColGroups;       // SArray<SRefColIdGroup>
  SArray*         pResolvedTags;       // SArray<STagVal>, resolved tag values from source tables
} SVTableScanOperatorParam;

typedef struct SSysTableScanVtbRefReq {
  int32_t vgId;                            // target vnode id that owns the referenced table
  char    dbName[TSDB_DB_NAME_LEN];        // short database name of the referenced table
  char    tbName[TSDB_TABLE_NAME_LEN];     // referenced table name
  char    colName[TSDB_COL_NAME_LEN];      // referenced column name on the target table
} SSysTableScanVtbRefReq;

typedef struct SSysTableScanOperatorParam {
  SArray* pVtbRefReqs;  // SArray<SSysTableScanVtbRefReq>
} SSysTableScanOperatorParam;

typedef enum EForeignScanParamType {
  FOREIGN_SCAN_PARAM_SINGLE = 0,
  FOREIGN_SCAN_PARAM_BATCH,
} EForeignScanParamType;

typedef struct SForeignTableInfo {
  char    dbName[TSDB_DB_NAME_LEN];
  char    tableName[TSDB_TABLE_NAME_LEN];
  SArray* colMap;       // SArray<SColIdNameKV>
  int8_t  dstPrecision;
  char*   tagCond;      // heap, owned
  int32_t tagCondLen;
  uint64_t scanParamId;
  int32_t  filterCondLen;
  char*    filterCondJson;  // serialized external column filter, heap owned
  int64_t rowLimit;
  char*   pPushedCondJson;  // serialized SNode, heap owned
  SNode*  pPushedCond;      // runtime-only SNode, heap owned
  uint64_t virtualChildUid;  // virtual child whose row is reconstructed from this table
  SArray* pVtbTagList;       // runtime-only SArray<STagVal>, owned by the batch table
} SForeignTableInfo;

typedef struct SForeignScanOperatorParam {
  EForeignScanParamType paramType;
  char    sourceName[TSDB_EXT_SOURCE_NAME_LEN];
  int64_t sourceMetaVersion;
  char    dbName[TSDB_DB_NAME_LEN];
  char    tableName[TSDB_TABLE_NAME_LEN];
  SArray* colMap;  // SArray<SColIdNameKV>
  // Destination precision for TIMESTAMP columns of the virtual table this
  // dispatch targets.  Set by the upstream VTable scan operator from the
  // input block's ts slot precision.  -1 means unset (legacy path).
  int8_t  dstPrecision;
  char*   tagCond;  // heap, owned; external series filter pushed into the remote SQL (may be NULL)
  int32_t tagCondLen;
  uint64_t scanParamId;
  int32_t  filterCondLen;
  char*    filterCondJson;  // serialized external column filter, heap owned in standalone params
  int64_t rowLimit;  // optional per-stream top-N limit for VStb remote SQL; <=0 means unset
  SNode*  pPushedCond;  // heap, owned; optional VStb data filter pushed into the remote SQL
  SArray* pBatchTables;  // SArray<SForeignTableInfo>, owned in batch mode
  int32_t groupId;       // virtual-table group; zero when the query has no grouping
  STimeWindow window;    // common half-open scan range applied to every table in the batch
  bool isNewParam;       // true when FederatedScan must start this batch from its first table
  uint64_t virtualChildUid;  // runtime-only discriminator for one table view inside a batch
  bool      hasVtbGroupId;   // runtime-only full-width virtual-table group id discriminator
  uint64_t  vtbGroupId;      // runtime-only; never encoded by the legacy batch codec
  SArray*   pVtbTagList;     // runtime-only borrowed tag payload for the active table view
  // Runtime-only: consumer accepts timestamp order changes between batch tables.
  bool allowUnorderedBatch;
} SForeignScanOperatorParam;
typedef struct SMergeOperatorParam {
  int32_t winNum;
  bool    mergeSameCols;
  bool    activeSourcesOnly;  // runtime-only scoped row-merge dispatch
} SMergeOperatorParam;

typedef struct SAggOperatorParam {
  bool            needCleanRes;
} SAggOperatorParam;

typedef struct SExternalWindowOperatorParam {
  SArray*         ExtWins;          // SArray<SExtWinTimeWindow>
  SArray*         pNullOutputSlots; // SArray<int32_t>, aggregate outputs not owned by this execution unit
} SExternalWindowOperatorParam;

typedef struct SDynQueryCtrlOperatorParam {
  STimeWindow    window;
} SDynQueryCtrlOperatorParam;

struct SStreamRuntimeFuncInfo;
typedef struct SStreamContextFrames SStreamContextFrames;
typedef struct SStreamFetchContextSelection SStreamFetchContextSelection;
typedef struct {
  SMsgHead        header;
  uint64_t        sId;
  uint64_t        queryId;
  uint64_t        clientId;
  uint64_t        taskId;
  uint64_t        srcTaskId;  // used for subQ
  uint64_t        blockIdx;   // used for subQ
  int32_t         execId;
  SOperatorParam* pOpParam;

  // used for new-stream
  struct SStreamRuntimeFuncInfo* pStRtFuncInfo;
  bool                           reset;
  bool                           dynTbname;
  bool                           forceFetchCompleted;
  bool                           phase2Rescan;  // vtable two-pass: remote origin reuses reader and rescans
  bool                           reuseReader;
  bool                           readerGroupMode;
  bool                           readerDimensionBatch;
  bool                           runnerEogBatch;
  uint64_t                       readerFetchId;
  SStreamContextFrames*          pContextFrames;  // optional owned validated frame copy
  // Set only by the scheduler for a pure VNode scan eligible for replica execution.
  bool                           allowFollowerRead;
  // used for new-stream
} SResFetchReq;

#define SRES_FETCH_FOLLOWER_READ_FRAME_VERSION 1
#define SRES_FETCH_FOLLOWER_READ_FRAME_MAGIC   UINT32_C(0x46525244)

int32_t tSerializeSResFetchReq(void* buf, int32_t bufLen, SResFetchReq* pReq, bool needStreamRtInfo, bool needStreamGrpInfo);
int32_t tDeserializeSResFetchReq(void* buf, int32_t bufLen, SResFetchReq* pReq);
int32_t tDeserializeSResFetchReqWithContextFrames(void* buf, int32_t bufLen, SResFetchReq* pReq);
int32_t tBuildStreamRunnerFetchReq(SResFetchReq* pReq, const SStreamContextFrames* pFrames, void** ppBuf,
                                   int32_t* pLen);
int32_t tBuildStreamReaderFetchReq(SResFetchReq* pReq, void** ppBuf, int32_t* pLen);
int32_t tBuildStreamPreparedFetchReq(SResFetchReq* pReq, const struct SStreamRuntimeFuncInfo* pBatch,
                                     const SStreamFetchContextSelection* pSelection, void** ppBuf, int32_t* pLen);
void    tDestroySResFetchReq(SResFetchReq* pReq);
typedef struct {
  SMsgHead header;
  uint64_t clientId;
} SSchTasksStatusReq;

typedef struct {
  uint64_t queryId;
  uint64_t clientId;
  uint64_t taskId;
  int64_t  refId;
  int32_t  subJobId;
  int32_t  execId;
  int8_t   status;
} STaskStatus;

typedef struct {
  int64_t refId;
  SArray* taskStatus;  // SArray<STaskStatus>
} SSchedulerStatusRsp;

typedef struct {
  uint64_t queryId;
  uint64_t taskId;
  int8_t   action;
} STaskAction;

typedef struct SQueryNodeEpId {
  int32_t nodeId;  // vgId or qnodeId
  SEp     ep;
} SQueryNodeEpId;

typedef struct {
  SMsgHead       header;
  uint64_t       clientId;
  SQueryNodeEpId epId;
  SArray*        taskAction;  // SArray<STaskAction>
} SSchedulerHbReq;

int32_t tSerializeSSchedulerHbReq(void* buf, int32_t bufLen, SSchedulerHbReq* pReq);
int32_t tDeserializeSSchedulerHbReq(void* buf, int32_t bufLen, SSchedulerHbReq* pReq);
void    tFreeSSchedulerHbReq(SSchedulerHbReq* pReq);

typedef struct {
  SQueryNodeEpId epId;
  SArray*        taskStatus;  // SArray<STaskStatus>
} SSchedulerHbRsp;

int32_t tSerializeSSchedulerHbRsp(void* buf, int32_t bufLen, SSchedulerHbRsp* pRsp);
int32_t tDeserializeSSchedulerHbRsp(void* buf, int32_t bufLen, SSchedulerHbRsp* pRsp);
void    tFreeSSchedulerHbRsp(SSchedulerHbRsp* pRsp);

typedef struct {
  SMsgHead header;
  uint64_t sId;
  uint64_t queryId;
  uint64_t clientId;
  uint64_t taskId;
  int64_t  refId;
  int32_t  execId;
} STaskCancelReq;

typedef struct {
  int32_t code;
} STaskCancelRsp;

typedef struct {
  SMsgHead header;
  uint64_t sId;
  uint64_t queryId;
  uint64_t clientId;
  uint64_t taskId;
  int64_t  refId;
  int32_t  execId;
} STaskDropReq;

int32_t tSerializeSTaskDropReq(void* buf, int32_t bufLen, STaskDropReq* pReq);
int32_t tDeserializeSTaskDropReq(void* buf, int32_t bufLen, STaskDropReq* pReq);

typedef enum {
  TASK_NOTIFY_FINISHED = 1,
} ETaskNotifyType;

typedef struct {
  SMsgHead        header;
  uint64_t        sId;
  uint64_t        queryId;
  uint64_t        clientId;
  uint64_t        taskId;
  int64_t         refId;
  int32_t         execId;
  ETaskNotifyType type;
} STaskNotifyReq;

int32_t tSerializeSTaskNotifyReq(void* buf, int32_t bufLen, STaskNotifyReq* pReq);
int32_t tDeserializeSTaskNotifyReq(void* buf, int32_t bufLen, STaskNotifyReq* pReq);

int32_t tSerializeSQueryTableRsp(void* buf, int32_t bufLen, SQueryTableRsp* pRsp);
int32_t tDeserializeSQueryTableRsp(void* buf, int32_t bufLen, SQueryTableRsp* pRsp);

typedef struct {
  int32_t code;
} STaskDropRsp;

#define STREAM_TRIGGER_AT_ONCE                 1
#define STREAM_TRIGGER_WINDOW_CLOSE            2
#define STREAM_TRIGGER_MAX_DELAY               3
#define STREAM_TRIGGER_FORCE_WINDOW_CLOSE      4
#define STREAM_TRIGGER_CONTINUOUS_WINDOW_CLOSE 5

#define STREAM_DEFAULT_IGNORE_EXPIRED 1
#define STREAM_FILL_HISTORY_ON        1
#define STREAM_FILL_HISTORY_OFF       0
#define STREAM_DEFAULT_FILL_HISTORY   STREAM_FILL_HISTORY_OFF
#define STREAM_DEFAULT_IGNORE_UPDATE  1
#define STREAM_CREATE_STABLE_TRUE     1
#define STREAM_CREATE_STABLE_FALSE    0

typedef struct SVgroupVer {
  int32_t vgId;
  int64_t ver;
} SVgroupVer;

enum {
  TOPIC_SUB_TYPE__DB = 1,
  TOPIC_SUB_TYPE__TABLE,
  TOPIC_SUB_TYPE__COLUMN,
};

#define DEFAULT_MAX_POLL_INTERVAL  300000
#define DEFAULT_SESSION_TIMEOUT    12000
#define DEFAULT_MAX_POLL_WAIT_TIME 1000
#define DEFAULT_MIN_POLL_ROWS      4096

typedef struct {
  char   name[TSDB_TOPIC_FNAME_LEN];  // accout.topic
  int8_t igExists;
  int8_t subType;
  int8_t withMeta;
  char*  sql;
  char   subDbName[TSDB_DB_FNAME_LEN];
  char*  ast;
  char   subStbName[TSDB_TABLE_FNAME_LEN];
  int8_t reload;
} SCMCreateTopicReq;

int32_t tSerializeSCMCreateTopicReq(void* buf, int32_t bufLen, const SCMCreateTopicReq* pReq);
int32_t tDeserializeSCMCreateTopicReq(void* buf, int32_t bufLen, SCMCreateTopicReq* pReq);
void    tFreeSCMCreateTopicReq(SCMCreateTopicReq* pReq);

typedef struct {
  int64_t consumerId;
} SMqConsumerRecoverMsg, SMqConsumerClearMsg;

typedef struct {
  int64_t consumerId;
  char    cgroup[TSDB_CGROUP_LEN];
  char    clientId[TSDB_CLIENT_ID_LEN];
  char    user[TSDB_USER_LEN];
  char    fqdn[TSDB_FQDN_LEN];
  SArray* topicNames;  // SArray<char**>

  int8_t  withTbName;
  int8_t  autoCommit;
  int32_t autoCommitInterval;
  int8_t  resetOffsetCfg;
  int8_t  enableReplay;
  int8_t  enableBatchMeta;
  int32_t sessionTimeoutMs;
  int32_t maxPollIntervalMs;
  int64_t ownerId;
} SCMSubscribeReq;

static FORCE_INLINE int32_t tSerializeSCMSubscribeReq(void** buf, const SCMSubscribeReq* pReq) {
  int32_t tlen = 0;
  tlen += taosEncodeFixedI64(buf, pReq->consumerId);
  tlen += taosEncodeString(buf, pReq->cgroup);
  tlen += taosEncodeString(buf, pReq->clientId);

  int32_t topicNum = taosArrayGetSize(pReq->topicNames);
  tlen += taosEncodeFixedI32(buf, topicNum);

  for (int32_t i = 0; i < topicNum; i++) {
    tlen += taosEncodeString(buf, (char*)taosArrayGetP(pReq->topicNames, i));
  }

  tlen += taosEncodeFixedI8(buf, pReq->withTbName);
  tlen += taosEncodeFixedI8(buf, pReq->autoCommit);
  tlen += taosEncodeFixedI32(buf, pReq->autoCommitInterval);
  tlen += taosEncodeFixedI8(buf, pReq->resetOffsetCfg);
  tlen += taosEncodeFixedI8(buf, pReq->enableReplay);
  tlen += taosEncodeFixedI8(buf, pReq->enableBatchMeta);
  tlen += taosEncodeFixedI32(buf, pReq->sessionTimeoutMs);
  tlen += taosEncodeFixedI32(buf, pReq->maxPollIntervalMs);
  tlen += taosEncodeString(buf, pReq->user);
  tlen += taosEncodeString(buf, pReq->fqdn);

  return tlen;
}

int32_t tDeserializeSCMSubscribeReq(void* buf, SCMSubscribeReq* pReq, int32_t len);

typedef struct {
  char    key[TSDB_SUBSCRIBE_KEY_LEN];
  SArray* removedConsumers;  // SArray<int64_t>
  SArray* newConsumers;      // SArray<int64_t>
} SMqRebInfo;

static FORCE_INLINE SMqRebInfo* tNewSMqRebSubscribe(const char* key) {
  SMqRebInfo* pRebInfo = (SMqRebInfo*)taosMemoryCalloc(1, sizeof(SMqRebInfo));
  if (pRebInfo == NULL) {
    return NULL;
  }
  tstrncpy(pRebInfo->key, key, TSDB_SUBSCRIBE_KEY_LEN);
  pRebInfo->removedConsumers = taosArrayInit(0, sizeof(int64_t));
  if (pRebInfo->removedConsumers == NULL) {
    goto _err;
  }
  pRebInfo->newConsumers = taosArrayInit(0, sizeof(int64_t));
  if (pRebInfo->newConsumers == NULL) {
    goto _err;
  }
  return pRebInfo;
_err:
  taosArrayDestroy(pRebInfo->removedConsumers);
  taosArrayDestroy(pRebInfo->newConsumers);
  taosMemoryFreeClear(pRebInfo);
  return NULL;
}

typedef struct {
  int64_t streamId;
  int64_t checkpointId;
  char    streamName[TSDB_STREAM_FNAME_LEN];
} SMStreamDoCheckpointMsg;

typedef struct {
  int64_t status;
} SMVSubscribeRsp;

typedef struct {
  char    name[TSDB_TOPIC_FNAME_LEN];
  int8_t  igNotExists;
  int32_t sqlLen;
  char*   sql;
  int8_t  force;
} SMDropTopicReq;

int32_t tSerializeSMDropTopicReq(void* buf, int32_t bufLen, SMDropTopicReq* pReq);
int32_t tDeserializeSMDropTopicReq(void* buf, int32_t bufLen, SMDropTopicReq* pReq);
void    tFreeSMDropTopicReq(SMDropTopicReq* pReq);

typedef struct {
  char    name[TSDB_TOPIC_FNAME_LEN];
  int8_t  igNotExists;
  int32_t sqlLen;
  char*   sql;
} SMReloadTopicReq;

int32_t tSerializeSMReloadTopicReq(void* buf, int32_t bufLen, SMReloadTopicReq* pReq);
int32_t tDeserializeSMReloadTopicReq(void* buf, int32_t bufLen, SMReloadTopicReq* pReq);
void    tFreeSMReloadTopicReq(SMReloadTopicReq* pReq);

typedef struct {
  char   topic[TSDB_TOPIC_FNAME_LEN];
  char   cgroup[TSDB_CGROUP_LEN];
  int8_t igNotExists;
  int8_t force;
} SMDropCgroupReq;

int32_t tSerializeSMDropCgroupReq(void* buf, int32_t bufLen, SMDropCgroupReq* pReq);
int32_t tDeserializeSMDropCgroupReq(void* buf, int32_t bufLen, SMDropCgroupReq* pReq);

typedef struct {
  int8_t reserved;
} SMDropCgroupRsp;

typedef struct {
  char    name[TSDB_TABLE_FNAME_LEN];
  int8_t  alterType;
  SSchema schema;
} SAlterTopicReq;

typedef struct {
  SMsgHead head;
  char     name[TSDB_TABLE_FNAME_LEN];
  int64_t  tuid;
  int32_t  sverson;
  int32_t  execLen;
  char*    executor;
  int32_t  sqlLen;
  char*    sql;
} SDCreateTopicReq;

typedef struct {
  SMsgHead head;
  char     name[TSDB_TABLE_FNAME_LEN];
  int64_t  tuid;
} SDDropTopicReq;

typedef struct {
  char*      name;
  int64_t    uid;
  int64_t    interval[2];
  int8_t     intervalUnit;
  int16_t    nFuncs;
  col_id_t*  funcColIds;  // column ids specified by user
  func_id_t* funcIds;     // function ids specified by user
} SRSmaParam;

int32_t tEncodeSRSmaParam(SEncoder* pCoder, const SRSmaParam* pRSmaParam);
int32_t tDecodeSRSmaParam(SDecoder* pCoder, SRSmaParam* pRSmaParam);

// TDMT_VND_CREATE_STB ==============
typedef struct SVCreateStbReq {
  char*           name;
  tb_uid_t        suid;
  int8_t          rollup;
  SSchemaWrapper  schemaRow;
  SSchemaWrapper  schemaTag;
  SRSmaParam      rsmaParam;
  int32_t         alterOriDataLen;
  void*           alterOriData;
  int8_t          source;
  int8_t          colCmpred;
  SColCmprWrapper colCmpr;
  int64_t         keep;
  int64_t         ownerId;
  txn_id_t        txnId;  // batch-meta-txn: STB belongs to this txn (VNode marks as PRE_CREATE)
  SExtSchema*     pExtSchemas;
  int8_t          virtualStb;
  int8_t          secureDelete;
  int8_t          securityLevel;
  // VST inheritance
  int8_t   numParents;
  int64_t  parentSuids[TSDB_MAX_VST_PARENTS];
  int16_t  ownColStart;
  int16_t  ownTagStart;
  // parent full names, resolved from parentSuids on the mnode when building the
  // WAL entry, so the TMQ meta path (which has no catalog/connection handle and
  // no suid index, and on a cross-cluster replay sees foreign suids) can emit a
  // replayable BASE ON clause without a suid lookup.
  char     parentStbFNames[TSDB_MAX_VST_PARENTS][TSDB_TABLE_FNAME_LEN];
} SVCreateStbReq;

int tEncodeSVCreateStbReq(SEncoder* pCoder, const SVCreateStbReq* pReq);
int tDecodeSVCreateStbReq(SDecoder* pCoder, SVCreateStbReq* pReq);

// TDMT_VND_DROP_STB ==============
typedef struct SVDropStbReq {
  char*    name;
  tb_uid_t suid;
  txn_id_t txnId;  // batch-meta-txn: DROP STB belongs to this txn (VNode marks as PRE_DROP)
} SVDropStbReq;

int32_t tEncodeSVDropStbReq(SEncoder* pCoder, const SVDropStbReq* pReq);
int32_t tDecodeSVDropStbReq(SDecoder* pCoder, SVDropStbReq* pReq);

// TDMT_VND_CHECK_HAS_CTB ==============
typedef struct SVCheckHasCtbReq {
  int64_t suid;
} SVCheckHasCtbReq;

int32_t tSerializeSVCheckHasCtbReq(void* buf, int32_t bufLen, const SVCheckHasCtbReq* pReq);
int32_t tDeserializeSVCheckHasCtbReq(const void* buf, int32_t bufLen, SVCheckHasCtbReq* pReq);

// TDMT_VND_CHECK_STB_ALTER_NAME ==============
// Pre-check for a virtual stb alter that introduces new column/tag names: each vnode owning
// vchild tables of the stb verifies that none of them already owns one of the names as an
// own (extension) column/tag. Response carries only the error code.
typedef struct SVCheckStbAlterNameReq {
  int64_t suid;    // uid of the virtual super table being altered
  SArray* pNames;  // array of char[TSDB_COL_NAME_LEN], new names introduced by the alter
} SVCheckStbAlterNameReq;

int32_t tSerializeSVCheckStbAlterNameReq(void* buf, int32_t bufLen, const SVCheckStbAlterNameReq* pReq);
int32_t tDeserializeSVCheckStbAlterNameReq(const void* buf, int32_t bufLen, SVCheckStbAlterNameReq* pReq);
void    tFreeSVCheckStbAlterNameReq(SVCheckStbAlterNameReq* pReq);

// TDMT_VND_CREATE_TABLE ==============
#define TD_CREATE_IF_NOT_EXISTS       0x1
#define TD_CREATE_NORMAL_TB_IN_STREAM 0x2
#define TD_CREATE_SUB_TB_IN_STREAM    0x4

// Own (extension) column of a virtual child table declared at CREATE VTABLE time
// (see SVChildOwnSchema in storageapi.h). schema.colId is a placeholder on the wire;
// the vnode assigns colIds from TSDB_VCHILD_OWN_COL_ID_BASE upwards.
typedef struct SVChildOwnColDef {
  SSchema  schema;
  SColRef  ref;  // hasRef is always true: an own data column must carry an origin reference
  STypeMod typeMod;  // decimal precision/scale for own columns of decimal type (0 otherwise)
} SVChildOwnColDef;

// Own (extension) tag of a virtual child table declared at CREATE VTABLE time. Carries
// an optional literal value (hasValue) or an optional tag reference (ref.hasRef); both
// empty means the tag value is NULL. schema.colId is a placeholder as above.
typedef struct SVChildOwnTagDef {
  SSchema  schema;
  SColRef  ref;
  bool     hasValue;
  int8_t   valType;
  int64_t  valI64;   // fixed-width literal value
  int32_t  valLen;   // payload length for var-width types
  uint8_t *pVal;     // var-width literal payload
} SVChildOwnTagDef;

typedef struct SVCreateTbReq {
  int32_t  flags;
  char*    name;
  tb_uid_t uid;
  int64_t  btime;
  int32_t  ttl;
  int32_t  commentLen;
  char*    comment;
  int8_t   type;
  union {
    struct {
      char*    stbName;  // super table name
      uint8_t  tagNum;
      tb_uid_t suid;
      SArray*  tagName;
      uint8_t* pTag;
    } ctb;
    struct {
      SSchemaWrapper schemaRow;
      SSchemaWrapper schemaTag;  // owned tag schema (normal/virtual-normal table with tags); nCols==0 when no tags
      uint8_t*       pTags;      // owned tag values, STag container (NULL when no tags)
      int64_t        userId;
    } ntb;
  };
  int32_t         sqlLen;
  char*           sql;
  SColCmprWrapper colCmpr;
  SExtSchema*     pExtSchemas;
  SColRefWrapper  colRef;  // col reference for virtual table
  SSeriesWrapper  series;  // series declarations for virtual table
  int64_t         txnId;   // batch meta txn ID (0 = not in txn)
  int8_t          txnStatus; // EMetaTxnStatus for snapshot replication (0 = normal/PRE_CREATE)
  // vchild own (extension) columns/tags declared at create time, TSDB_VIRTUAL_CHILD_TABLE only
  int32_t           nOwnColDefs;
  SVChildOwnColDef *pOwnColDefs;
  int32_t           nOwnTagDefs;
  SVChildOwnTagDef *pOwnTagDefs;
} SVCreateTbReq;

int  tEncodeSVCreateTbReq(SEncoder* pCoder, const SVCreateTbReq* pReq);
int  tDecodeSVCreateTbReq(SDecoder* pCoder, SVCreateTbReq* pReq);
void tdDestroySVCreateTbReq(SVCreateTbReq* pReq);

typedef struct {
  int32_t nReqs;
  union {
    SVCreateTbReq* pReqs;
    SArray*        pArray;
  };
  int8_t source;  // TD_REQ_FROM_TAOX-taosX or TD_REQ_FROM_APP-taosClient
} SVCreateTbBatchReq;

int  tEncodeSVCreateTbBatchReq(SEncoder* pCoder, const SVCreateTbBatchReq* pReq);
int  tDecodeSVCreateTbBatchReq(SDecoder* pCoder, SVCreateTbBatchReq* pReq);
void tDeleteSVCreateTbBatchReq(SVCreateTbBatchReq* pReq);

typedef struct {
  int32_t        code;
  int32_t        index;  // index in batch req, start from 0
  STableMetaRsp* pMeta;
} SVCreateTbRsp, SVUpdateTbRsp;

int  tEncodeSVCreateTbRsp(SEncoder* pCoder, const SVCreateTbRsp* pRsp);
int  tDecodeSVCreateTbRsp(SDecoder* pCoder, SVCreateTbRsp* pRsp);
void tFreeSVCreateTbRsp(void* param);

int32_t tSerializeSVCreateTbReq(void** buf, SVCreateTbReq* pReq);
void*   tDeserializeSVCreateTbReq(void* buf, SVCreateTbReq* pReq);

typedef struct {
  int32_t nRsps;
  union {
    SVCreateTbRsp* pRsps;
    SArray*        pArray;
  };
} SVCreateTbBatchRsp;

int tEncodeSVCreateTbBatchRsp(SEncoder* pCoder, const SVCreateTbBatchRsp* pRsp);
int tDecodeSVCreateTbBatchRsp(SDecoder* pCoder, SVCreateTbBatchRsp* pRsp);

// int32_t tSerializeSVCreateTbBatchRsp(void* buf, int32_t bufLen, SVCreateTbBatchRsp* pRsp);
// int32_t tDeserializeSVCreateTbBatchRsp(void* buf, int32_t bufLen, SVCreateTbBatchRsp* pRsp);

// TDMT_VND_DROP_TABLE =================
typedef struct {
  char*    name;
  uint64_t suid;  // for tmq in wal format
  int64_t  uid;
  int8_t   igNotExists;
  int8_t   isVirtual;
  int64_t  txnId;  // batch meta txn ID (0 = not in txn)
} SVDropTbReq;

typedef struct {
  int32_t code;
} SVDropTbRsp;

typedef struct {
  int32_t nReqs;
  union {
    SVDropTbReq* pReqs;
    SArray*      pArray;
  };
} SVDropTbBatchReq;

int32_t tEncodeSVDropTbBatchReq(SEncoder* pCoder, const SVDropTbBatchReq* pReq);
int32_t tDecodeSVDropTbBatchReq(SDecoder* pCoder, SVDropTbBatchReq* pReq);

typedef struct {
  int32_t nRsps;
  union {
    SVDropTbRsp* pRsps;
    SArray*      pArray;
  };
} SVDropTbBatchRsp;

int32_t tEncodeSVDropTbBatchRsp(SEncoder* pCoder, const SVDropTbBatchRsp* pRsp);
int32_t tDecodeSVDropTbBatchRsp(SDecoder* pCoder, SVDropTbBatchRsp* pRsp);

// TDMT_VND_ALTER_TABLE =====================
typedef struct SUpdatedTagVal {
  char*    tagName;
  int32_t  colId;
  int8_t   tagType;
  int8_t   tagFree;
  uint32_t nTagVal;
  uint8_t* pTagVal;
  int8_t   isNull;
  SArray*  pTagArray;
  // NOTE: regexp and replacement are only a temporary solution for tag value update,
  // they should be replaced by a more generic solution in the future for full expression
  // support
  char*    regexp;
  char*    replacement;
} SUpdatedTagVal;

typedef struct SUpdateTableTagVal {
  char *tbName;
  SArray* tags; // Array of SUpdatedTagVal
} SUpdateTableTagVal;


typedef struct SVAlterTbReq {
  char*   tbName;
  int8_t  action;
  char*   colName;
  int32_t colId;
  // TSDB_ALTER_TABLE_ADD_COLUMN
  int8_t  type;
  int8_t  flags;
  int32_t bytes;
  // TSDB_ALTER_TABLE_DROP_COLUMN
  // TSDB_ALTER_TABLE_UPDATE_COLUMN_BYTES
  int8_t   colModType;
  int32_t  colModBytes;
  char*    colNewName;  // TSDB_ALTER_TABLE_UPDATE_COLUMN_NAME
  char*    tagName;     // TSDB_ALTER_TABLE_UPDATE_TAG_VAL
  int8_t   isNull;
  int8_t   tagType;
  int8_t   tagFree;
  uint32_t nTagVal;
  uint8_t* pTagVal;
  SArray*  pTagArray;
  // TSDB_ALTER_TABLE_UPDATE_OPTIONS
  int8_t   updateTTL;
  int32_t  newTTL;
  int32_t  newCommentLen;
  char*    newComment;
  int64_t  ctimeMs;    // fill by vnode
  int8_t   source;     // TD_REQ_FROM_TAOX-taosX or TD_REQ_FROM_APP-taosClient
  uint32_t compress;   // TSDB_ALTER_TABLE_UPDATE_COLUMN_COMPRESS
  SArray*  pMultiTag;  // TSDB_ALTER_TABLE_ADD_MULTI_TAGS and TSDB_ALTER_TABLE_UPDATE_CHILD_TABLE_TAG_VAL
  SArray*  tables;     // Array of SUpdateTableTagVal, for TSDB_ALTER_TABLE_UPDATE_MULTI_TABLE_TAG_VAL
  int32_t  whereLen;   // [whereLen] & [where] are for TSDB_ALTER_TABLE_UPDATE_CHILD_TABLE_TAG_VAL,
  uint8_t* where;      // [where] is the encode where condition.
  // for Add column
  STypeMod typeMod;
  // TSDB_ALTER_TABLE_ALTER_COLUMN_REF / TSDB_ALTER_TABLE_ALTER_TAG_REF
  char* refDbName;
  char* refTbName;
  char* refColName;
  char* refSourceName;
  // External schema segment of the reference (SQL Server 5-part paths; empty otherwise).
  // Encoded as the last field of the message so that older readers simply ignore it and
  // this decoder treats its absence as empty (same pattern as txnDdlQuota).
  char* refSchemaName;
  int8_t refType;  // 0=local, 1=external
  int32_t filterCondLen;
  char*   filterCondJson;
  // TSDB_ALTER_TABLE_REMOVE_COLUMN_REF
  // TSDB_ALTER_TABLE_ADD_SERIES
  char*   seriesAlias;
  char*   seriesSourceName;
  char*   seriesDbName;
  char*   seriesMeasurementName;
  int32_t seriesTagCondLen;
  char*   seriesTagCondJson;
  // TSDB_ALTER_TABLE_REMOVE_SERIES  -  uses seriesAlias above
  int64_t txnId;  // batch meta txn ID (0 = not in txn)
  // Per-vnode share of the remaining TSDB_TXN_MAX_DDL_OPS_PER_TXN budget, for
  // TSDB_ALTER_TABLE_UPDATE_CHILD_TABLE_TAG_VAL only. The client cannot know how many
  // children a WHERE predicate matches (tag values live on the vnode, and inside a txn the
  // predicate must be evaluated against uncommitted shadow state), so it sends the quota it
  // can afford and the vnode aborts its pre-scan once the match count exceeds it. 0 = no
  // limit (non-txn path). See metaPreScanChildTableTagUpdate.
  int32_t txnDdlQuota;
} SVAlterTbReq;

int32_t tEncodeSVAlterTbReq(SEncoder* pEncoder, const SVAlterTbReq* pReq);
int32_t tDecodeSVAlterTbReq(SDecoder* pDecoder, SVAlterTbReq* pReq);
void    destroyAlterTbReq(SVAlterTbReq* pReq);
int32_t tDecodeSVAlterTbReqSetCtime(SDecoder* pDecoder, SVAlterTbReq* pReq, int64_t ctimeMs);
void    tfreeMultiTagUpdateVal(void* pMultiTag);
void    tfreeUpdateTableTagVal(void* pMultiTable);

typedef struct {
  int32_t        code;
  STableMetaRsp* pMeta;
  // Number of child tables this vnode actually rewrote, for
  // TSDB_ALTER_TABLE_UPDATE_CHILD_TABLE_TAG_VAL (WHERE-based bulk tag update) inside a
  // txn. The vnode fills this in when that action runs with txnId != 0
  // (vnodeProcessAlterTbReq, txn path); it stays 0 on the non-txn path and for all
  // other action types. Only txn callers consume it: the client sums this across
  // vgroups into txnDdlCount so the per-object accounting in FS Sec.4.13 reflects the
  // real object count for a statement whose reach is only knowable server-side.
  int32_t        numTouched;
} SVAlterTbRsp;

int32_t tEncodeSVAlterTbRsp(SEncoder* pEncoder, const SVAlterTbRsp* pRsp);
int32_t tDecodeSVAlterTbRsp(SDecoder* pDecoder, SVAlterTbRsp* pRsp);
// ======================

typedef struct {
  SMsgHead head;
  int64_t  uid;
  int32_t  tid;
  int16_t  tversion;
  int16_t  colId;
  int8_t   type;
  int16_t  bytes;
  int32_t  tagValLen;
  int16_t  numOfTags;
  int32_t  schemaLen;
  char     data[];
} SUpdateTagValReq;

typedef struct {
  SMsgHead head;
} SUpdateTagValRsp;

typedef struct {
  SMsgHead head;
} SVShowTablesReq;

typedef struct {
  SMsgHead head;
  int32_t  id;
} SVShowTablesFetchReq;

typedef struct {
  int64_t useconds;
  int8_t  completed;  // all results are returned to client
  int8_t  precision;
  int8_t  compressed;
  int32_t compLen;
  int32_t numOfRows;
  char    data[];
} SVShowTablesFetchRsp;

typedef struct {
  int64_t consumerId;
  int32_t epoch;
  char    cgroup[TSDB_CGROUP_LEN];
} SMqAskEpReq;

typedef struct {
  int32_t key;
  int32_t valueLen;
  void*   value;
} SKv;

typedef struct {
  int64_t tscRid;
  int8_t  connType;
} SClientHbKey;

typedef struct {
  int64_t tid;
  char    status[TSDB_JOB_STATUS_LEN];
  int64_t startTs;  // sub-task first execution start time, us
} SQuerySubDesc;

typedef enum EQueryExecPhase {
  /* Main phases: 0-9 */
  QUERY_PHASE_NONE     = 0,
  QUERY_PHASE_PARSE    = 1,
  QUERY_PHASE_CATALOG  = 2,
  QUERY_PHASE_PLAN     = 3,
  QUERY_PHASE_SCHEDULE = 4,
  QUERY_PHASE_EXECUTE  = 5,
  QUERY_PHASE_FETCH    = 6,
  QUERY_PHASE_DONE     = 7,

  /* SCHEDULE sub-phases: 4x */
  QUERY_PHASE_SCHEDULE_ANALYSIS       = 41,
  QUERY_PHASE_SCHEDULE_PLANNING       = 42,
  QUERY_PHASE_SCHEDULE_NODE_SELECTION = 43,

  /* EXECUTE sub-phases: 5x */
  QUERY_PHASE_EXEC_DATA_QUERY       = 51,
  QUERY_PHASE_EXEC_MERGE_QUERY      = 52,
  QUERY_PHASE_EXEC_WAITING_CHILDREN = 53,

  /* FETCH sub-phases: 6x */
  QUERY_PHASE_FETCH_IN_PROGRESS = 60,  // A single fetch operation is in progress
  QUERY_PHASE_FETCH_RETURNED    = 61,  // Data returned to client, business logic processing
} EQueryExecPhase;

const char* queryPhaseStr(int32_t phase);

typedef struct {
  char     sql[TSDB_SHOW_SQL_LEN];
  uint64_t queryId;
  int64_t  useconds;
  int64_t  stime;  // timestamp precision ms
  int64_t  reqRid;
  bool     stableQuery;
  bool     isSubQuery;
  char     fqdn[TSDB_FQDN_LEN];
  int32_t  subPlanNum;
  SArray*  subDesc;  // SArray<SQuerySubDesc>
  int32_t  execPhase;       // EQueryExecPhase
  int64_t  phaseStartTime;  // when current phase started, ms
} SQueryDesc;

typedef struct {
  uint32_t connId;
  SArray*  queryDesc;  // SArray<SQueryDesc>
} SQueryHbReqBasic;

// values for SQueryHbRspBasic.killConnection
#define HB_KILL_CONN       1  // close the connection (e.g. KILL CONNECTION)
#define HB_KILL_CONN_AUTH  2  // password changed after login; reject access with auth failure

typedef struct {
  uint32_t connId;
  uint64_t killRid;
  int32_t  totalDnodes;
  int32_t  onlineDnodes;
  int8_t   killConnection;  // HB_KILL_CONN_*: 0 keep, 1 close, 2 reject with auth failure
  int8_t   align[3];
  SEpSet   epSet;
  SArray*  pQnodeList;
} SQueryHbRspBasic;

typedef struct SAppClusterSummary {
  uint64_t numOfInsertsReq;
  uint64_t numOfInsertRows;
  uint64_t insertElapsedTime;
  uint64_t insertBytes;  // submit to tsdb since launched.

  uint64_t fetchBytes;
  uint64_t numOfQueryReq;
  uint64_t queryElapsedTime;
  uint64_t numOfSlowQueries;
  uint64_t totalRequests;
  uint64_t currentRequests;  // the number of SRequestObj
} SAppClusterSummary;

typedef struct {
  int64_t            appId;
  int32_t            pid;
  char               name[TSDB_APP_NAME_LEN];
  int64_t            startTime;
  SAppClusterSummary summary;
} SAppHbReq;

typedef struct {
  SClientHbKey      connKey;
  int64_t           clusterId;
  SAppHbReq         app;
  SQueryHbReqBasic* query;
  SHashObj*         info;  // hash<Skv.key, Skv>
  char              user[TSDB_USER_LEN];
  char              tokenName[TSDB_TOKEN_NAME_LEN];
  char              userApp[TSDB_APP_NAME_LEN];
  uint32_t          userIp;
  SIpRange          userDualIp;
  char              sVer[TSDB_VERSION_LEN];
  char              cInfo[CONNECTOR_INFO_LEN];
  int32_t           passVer;  // password version the client authenticated with (-1: not reported)
} SClientHbReq;

typedef struct {
  int64_t reqId;
  SArray* reqs;  // SArray<SClientHbReq>
  int64_t ipWhiteListVer;
} SClientHbBatchReq;

typedef struct {
  SClientHbKey      connKey;
  int32_t           status;
  SQueryHbRspBasic* query;
  SArray*           info;  // Array<Skv>
} SClientHbRsp;

typedef struct {
  int64_t       reqId;
  int64_t       rspId;
  int32_t       svrTimestamp;
  SArray*       rsps;  // SArray<SClientHbRsp>
  SMonitorParas monitorParas;
  int8_t        enableAuditDelete;
  int8_t        enableStrongPass;
  int8_t        enableAuditSelect;
  int8_t        enableAuditInsert;
  int8_t        auditLevel;
  union {
    uint32_t flags;
    struct {
      uint32_t sodInitial : 1;   // cluster-wide: 1 = SoD still in initial phase
      uint32_t macActive  : 1;   // cluster-wide: 1 = MAC mandatory mode activated
      uint32_t reserved   : 30;
    };
  };
} SClientHbBatchRsp;

static FORCE_INLINE uint32_t hbKeyHashFunc(const char* key, uint32_t keyLen) { return taosIntHash_64(key, keyLen); }

static FORCE_INLINE void tFreeReqKvHash(SHashObj* info) {
  void* pIter = taosHashIterate(info, NULL);
  while (pIter != NULL) {
    SKv* kv = (SKv*)pIter;
    taosMemoryFreeClear(kv->value);
    pIter = taosHashIterate(info, pIter);
  }
}

static FORCE_INLINE void tFreeClientHbQueryDesc(void* pDesc) {
  SQueryDesc* desc = (SQueryDesc*)pDesc;
  if (desc->subDesc) {
    taosArrayDestroy(desc->subDesc);
    desc->subDesc = NULL;
  }
}

static FORCE_INLINE void tFreeClientHbReq(void* pReq) {
  SClientHbReq* req = (SClientHbReq*)pReq;
  if (req->query) {
    if (req->query->queryDesc) {
      taosArrayDestroyEx(req->query->queryDesc, tFreeClientHbQueryDesc);
    }
    taosMemoryFreeClear(req->query);
  }

  if (req->info) {
    tFreeReqKvHash(req->info);
    taosHashCleanup(req->info);
    req->info = NULL;
  }
}

int32_t tSerializeSClientHbBatchReq(void* buf, int32_t bufLen, const SClientHbBatchReq* pReq);
int32_t tDeserializeSClientHbBatchReq(void* buf, int32_t bufLen, SClientHbBatchReq* pReq);

static FORCE_INLINE void tFreeClientHbBatchReq(void* pReq) {
  if (pReq == NULL) return;
  SClientHbBatchReq* req = (SClientHbBatchReq*)pReq;
  taosArrayDestroyEx(req->reqs, tFreeClientHbReq);
  taosMemoryFree(pReq);
}

static FORCE_INLINE void tFreeClientKv(void* pKv) {
  SKv* kv = (SKv*)pKv;
  if (kv) {
    taosMemoryFreeClear(kv->value);
  }
}

static FORCE_INLINE void tFreeClientHbRsp(void* pRsp) {
  SClientHbRsp* rsp = (SClientHbRsp*)pRsp;
  if (rsp->query) {
    taosArrayDestroy(rsp->query->pQnodeList);
    taosMemoryFreeClear(rsp->query);
  }
  if (rsp->info) taosArrayDestroyEx(rsp->info, tFreeClientKv);
}

static FORCE_INLINE void tFreeClientHbBatchRsp(void* pRsp) {
  SClientHbBatchRsp* rsp = (SClientHbBatchRsp*)pRsp;
  taosArrayDestroyEx(rsp->rsps, tFreeClientHbRsp);
}

int32_t tSerializeSClientHbBatchRsp(void* buf, int32_t bufLen, const SClientHbBatchRsp* pBatchRsp);
int32_t tDeserializeSClientHbBatchRsp(void* buf, int32_t bufLen, SClientHbBatchRsp* pBatchRsp);
void    tFreeSClientHbBatchRsp(SClientHbBatchRsp* pBatchRsp);

static FORCE_INLINE int32_t tEncodeSKv(SEncoder* pEncoder, const SKv* pKv) {
  TAOS_CHECK_RETURN(tEncodeI32(pEncoder, pKv->key));
  TAOS_CHECK_RETURN(tEncodeI32(pEncoder, pKv->valueLen));
  TAOS_CHECK_RETURN(tEncodeBinary(pEncoder, (uint8_t*)pKv->value, pKv->valueLen));
  return 0;
}

static FORCE_INLINE int32_t tDecodeSKv(SDecoder* pDecoder, SKv* pKv) {
  TAOS_CHECK_RETURN(tDecodeI32(pDecoder, &pKv->key));
  TAOS_CHECK_RETURN(tDecodeI32(pDecoder, &pKv->valueLen));

  if (pKv->valueLen < 0) {
    return TSDB_CODE_INVALID_MSG;
  }

  pKv->value = taosMemoryMalloc(pKv->valueLen + 1);
  if (pKv->value == NULL) {
    return TSDB_CODE_OUT_OF_MEMORY;
  }
  int32_t code = tDecodeCStrToN(pDecoder, (char*)pKv->value, pKv->valueLen + 1);
  if (code != 0) {
    taosMemoryFreeClear(pKv->value);
    return code;
  }
  return 0;
}

static FORCE_INLINE int32_t tEncodeSClientHbKey(SEncoder* pEncoder, const SClientHbKey* pKey) {
  TAOS_CHECK_RETURN(tEncodeI64(pEncoder, pKey->tscRid));
  TAOS_CHECK_RETURN(tEncodeI8(pEncoder, pKey->connType));
  return 0;
}

static FORCE_INLINE int32_t tDecodeSClientHbKey(SDecoder* pDecoder, SClientHbKey* pKey) {
  TAOS_CHECK_RETURN(tDecodeI64(pDecoder, &pKey->tscRid));
  TAOS_CHECK_RETURN(tDecodeI8(pDecoder, &pKey->connType));
  return 0;
}

typedef struct {
  int32_t vgId;
  // TODO stas
} SMqReportVgInfo;

static FORCE_INLINE int32_t taosEncodeSMqVgInfo(void** buf, const SMqReportVgInfo* pVgInfo) {
  int32_t tlen = 0;
  tlen += taosEncodeFixedI32(buf, pVgInfo->vgId);
  return tlen;
}

static FORCE_INLINE void* taosDecodeSMqVgInfo(void* buf, SMqReportVgInfo* pVgInfo) {
  buf = taosDecodeFixedI32(buf, &pVgInfo->vgId);
  return buf;
}

typedef struct {
  int32_t epoch;
  int64_t topicUid;
  char    name[TSDB_TOPIC_FNAME_LEN];
  SArray* pVgInfo;  // SArray<SMqHbVgInfo>
} SMqTopicInfo;

static FORCE_INLINE int32_t taosEncodeSMqTopicInfoMsg(void** buf, const SMqTopicInfo* pTopicInfo) {
  int32_t tlen = 0;
  tlen += taosEncodeFixedI32(buf, pTopicInfo->epoch);
  tlen += taosEncodeFixedI64(buf, pTopicInfo->topicUid);
  tlen += taosEncodeString(buf, pTopicInfo->name);
  int32_t sz = taosArrayGetSize(pTopicInfo->pVgInfo);
  tlen += taosEncodeFixedI32(buf, sz);
  for (int32_t i = 0; i < sz; i++) {
    SMqReportVgInfo* pVgInfo = (SMqReportVgInfo*)taosArrayGet(pTopicInfo->pVgInfo, i);
    tlen += taosEncodeSMqVgInfo(buf, pVgInfo);
  }
  return tlen;
}

static FORCE_INLINE void* taosDecodeSMqTopicInfoMsg(void* buf, SMqTopicInfo* pTopicInfo) {
  buf = taosDecodeFixedI32(buf, &pTopicInfo->epoch);
  buf = taosDecodeFixedI64(buf, &pTopicInfo->topicUid);
  buf = taosDecodeStringTo(buf, pTopicInfo->name);
  int32_t sz;
  buf = taosDecodeFixedI32(buf, &sz);
  if ((pTopicInfo->pVgInfo = taosArrayInit(sz, sizeof(SMqReportVgInfo))) == NULL) {
    return NULL;
  }
  for (int32_t i = 0; i < sz; i++) {
    SMqReportVgInfo vgInfo;
    buf = taosDecodeSMqVgInfo(buf, &vgInfo);
    if (taosArrayPush(pTopicInfo->pVgInfo, &vgInfo) == NULL) {
      return NULL;
    }
  }
  return buf;
}

typedef struct {
  int32_t status;  // ask hb endpoint
  int32_t epoch;
  int64_t consumerId;
  SArray* pTopics;  // SArray<SMqHbTopicInfo>
} SMqReportReq;

static FORCE_INLINE int32_t taosEncodeSMqReportMsg(void** buf, const SMqReportReq* pMsg) {
  int32_t tlen = 0;
  tlen += taosEncodeFixedI32(buf, pMsg->status);
  tlen += taosEncodeFixedI32(buf, pMsg->epoch);
  tlen += taosEncodeFixedI64(buf, pMsg->consumerId);
  int32_t sz = taosArrayGetSize(pMsg->pTopics);
  tlen += taosEncodeFixedI32(buf, sz);
  for (int32_t i = 0; i < sz; i++) {
    SMqTopicInfo* topicInfo = (SMqTopicInfo*)taosArrayGet(pMsg->pTopics, i);
    tlen += taosEncodeSMqTopicInfoMsg(buf, topicInfo);
  }
  return tlen;
}

static FORCE_INLINE void* taosDecodeSMqReportMsg(void* buf, SMqReportReq* pMsg) {
  buf = taosDecodeFixedI32(buf, &pMsg->status);
  buf = taosDecodeFixedI32(buf, &pMsg->epoch);
  buf = taosDecodeFixedI64(buf, &pMsg->consumerId);
  int32_t sz;
  buf = taosDecodeFixedI32(buf, &sz);
  if ((pMsg->pTopics = taosArrayInit(sz, sizeof(SMqTopicInfo))) == NULL) {
    return NULL;
  }
  for (int32_t i = 0; i < sz; i++) {
    SMqTopicInfo topicInfo;
    buf = taosDecodeSMqTopicInfoMsg(buf, &topicInfo);
    if (taosArrayPush(pMsg->pTopics, &topicInfo) == NULL) {
      return NULL;
    }
  }
  return buf;
}

typedef struct {
  SMsgHead head;
  int64_t  leftForVer;
  int32_t  vgId;
  int64_t  consumerId;
  char     subKey[TSDB_SUBSCRIBE_KEY_LEN];
} SMqVDeleteReq;

typedef struct {
  int8_t reserved;
} SMqVDeleteRsp;

typedef struct {
  char**  name;
  int32_t count;
  int8_t  igNotExists;
  int64_t txnId;  // batch meta txn ID (0 = not in txn)
} SMDropStreamReq;

typedef struct {
  int8_t reserved;
} SMDropStreamRsp;

typedef struct {
  SMsgHead head;
  int64_t  resetRelHalt;  // reset related stream task halt status
  int64_t  streamId;
  int32_t  taskId;
} SVDropStreamTaskReq;

typedef struct {
  int8_t reserved;
} SVDropStreamTaskRsp;

int32_t tSerializeSMDropStreamReq(void* buf, int32_t bufLen, const SMDropStreamReq* pReq);
int32_t tDeserializeSMDropStreamReq(void* buf, int32_t bufLen, SMDropStreamReq* pReq);
void    tFreeMDropStreamReq(SMDropStreamReq* pReq);

typedef struct {
  char*  name;
  int8_t igNotExists;
} SMPauseStreamReq;

int32_t tSerializeSMPauseStreamReq(void* buf, int32_t bufLen, const SMPauseStreamReq* pReq);
int32_t tDeserializeSMPauseStreamReq(void* buf, int32_t bufLen, SMPauseStreamReq* pReq);
void    tFreeMPauseStreamReq(SMPauseStreamReq* pReq);

typedef struct {
  char*  name;
  int8_t igNotExists;
  int8_t igUntreated;
} SMResumeStreamReq;

int32_t tSerializeSMResumeStreamReq(void* buf, int32_t bufLen, const SMResumeStreamReq* pReq);
int32_t tDeserializeSMResumeStreamReq(void* buf, int32_t bufLen, SMResumeStreamReq* pReq);
void    tFreeMResumeStreamReq(SMResumeStreamReq* pReq);

typedef struct {
  char*       name;
  int8_t      calcAll;
  STimeWindow timeRange;
} SMRecalcStreamReq;

int32_t tSerializeSMRecalcStreamReq(void* buf, int32_t bufLen, const SMRecalcStreamReq* pReq);
int32_t tDeserializeSMRecalcStreamReq(void* buf, int32_t bufLen, SMRecalcStreamReq* pReq);
void    tFreeMRecalcStreamReq(SMRecalcStreamReq* pReq);

typedef struct SVndSetKeepVersionReq {
  int64_t keepVersion;
} SVndSetKeepVersionReq;

int32_t tSerializeSVndSetKeepVersionReq(void* buf, int32_t bufLen, SVndSetKeepVersionReq* pReq);
int32_t tDeserializeSVndSetKeepVersionReq(void* buf, int32_t bufLen, SVndSetKeepVersionReq* pReq);

typedef struct SVUpdateCheckpointInfoReq {
  SMsgHead head;
  int64_t  streamId;
  int32_t  taskId;
  int64_t  checkpointId;
  int64_t  checkpointVer;
  int64_t  checkpointTs;
  int32_t  transId;
  int64_t  hStreamId;  // add encode/decode
  int64_t  hTaskId;
  int8_t   dropRelHTask;
} SVUpdateCheckpointInfoReq;

#define SMQ_REB_VG_REQ_VERSION                 1

typedef struct {
  int64_t        leftForVer;
  int32_t        vgId;
  int64_t        oldConsumerId;
  int64_t        newConsumerId;
  char           subKey[TSDB_SUBSCRIBE_KEY_LEN];
  int8_t         subType;
  int8_t         withMeta;
  char*          qmsg;  // SubPlanToString
  SSchemaWrapper schema;
  int64_t        suid;
} SMqRebVgReq;

int32_t tEncodeSMqRebVgReq(SEncoder* pCoder, const SMqRebVgReq* pReq);
int32_t tDecodeSMqRebVgReq(SDecoder* pCoder, SMqRebVgReq* pReq);

// tqOffset
enum {
  TMQ_OFFSET__RESET_NONE = -3,
  TMQ_OFFSET__RESET_EARLIEST = -2,
  TMQ_OFFSET__RESET_LATEST = -1,
  TMQ_OFFSET__LOG = 1,
  TMQ_OFFSET__SNAPSHOT_DATA = 2,
  TMQ_OFFSET__SNAPSHOT_META = 3,
};

enum {
  ONLY_DATA = 0,
  WITH_META = 1,
  ONLY_META = 2,
};

#define TQ_OFFSET_VERSION 1

typedef struct {
  int8_t type;
  union {
    // snapshot
    struct {
      int64_t uid;
      int64_t ts;
      SValue  primaryKey;
    };
    // log
    struct {
      int64_t version;
    };
  };
} STqOffsetVal;

static FORCE_INLINE void tqOffsetResetToData(STqOffsetVal* pOffsetVal, int64_t uid, int64_t ts, SValue primaryKey) {
  pOffsetVal->type = TMQ_OFFSET__SNAPSHOT_DATA;
  pOffsetVal->uid = uid;
  pOffsetVal->ts = ts;
  if (IS_VAR_DATA_TYPE(pOffsetVal->primaryKey.type)) {
    taosMemoryFree(pOffsetVal->primaryKey.pData);
  }
  pOffsetVal->primaryKey = primaryKey;
}

static FORCE_INLINE void tqOffsetResetToMeta(STqOffsetVal* pOffsetVal, int64_t uid) {
  pOffsetVal->type = TMQ_OFFSET__SNAPSHOT_META;
  pOffsetVal->uid = uid;
}

static FORCE_INLINE void tqOffsetResetToLog(STqOffsetVal* pOffsetVal, int64_t ver) {
  pOffsetVal->type = TMQ_OFFSET__LOG;
  pOffsetVal->version = ver;
}

int32_t tEncodeSTqOffsetVal(SEncoder* pEncoder, const STqOffsetVal* pOffsetVal);
int32_t tDecodeSTqOffsetVal(SDecoder* pDecoder, STqOffsetVal* pOffsetVal);
void    tFormatOffset(char* buf, int32_t maxLen, const STqOffsetVal* pVal);
bool    tOffsetEqual(const STqOffsetVal* pLeft, const STqOffsetVal* pRight);
void    tOffsetCopy(STqOffsetVal* pLeft, const STqOffsetVal* pRight);
void    tOffsetDestroy(void* pVal);

typedef struct {
  STqOffsetVal val;
  char         subKey[TSDB_SUBSCRIBE_KEY_LEN];
} STqOffset;

int32_t tEncodeSTqOffset(SEncoder* pEncoder, const STqOffset* pOffset);
int32_t tDecodeSTqOffset(SDecoder* pDecoder, STqOffset* pOffset);
void    tDeleteSTqOffset(void* val);

typedef struct SMqVgOffset {
  int64_t   consumerId;
  STqOffset offset;
} SMqVgOffset;

int32_t tEncodeMqVgOffset(SEncoder* pEncoder, const SMqVgOffset* pOffset);
int32_t tDecodeMqVgOffset(SDecoder* pDecoder, SMqVgOffset* pOffset);

typedef struct {
  char    name[TSDB_TABLE_FNAME_LEN];
  char    stb[TSDB_TABLE_FNAME_LEN];
  int8_t  igExists;
  int8_t  intervalUnit;
  int8_t  slidingUnit;
  int8_t  timezone;  // int8_t is not enough, timezone is unit of second
  int32_t dstVgId;   // for stream
  int64_t interval;
  int64_t offset;
  int64_t sliding;
  int64_t maxDelay;
  int64_t watermark;
  int32_t exprLen;        // strlen + 1
  int32_t tagsFilterLen;  // strlen + 1
  int32_t sqlLen;         // strlen + 1
  int32_t astLen;         // strlen + 1
  char*   expr;
  char*   tagsFilter;
  char*   sql;
  char*   ast;
  int64_t deleteMark;
  int64_t lastTs;
  int64_t normSourceTbUid;  // the Uid of source tb if its a normal table, otherwise 0
  SArray* pVgroupVerList;
  int8_t  recursiveTsma;
  char    baseTsmaName[TSDB_TABLE_FNAME_LEN];  // base tsma name for recursively created tsma
  char*   createStreamReq;
  int32_t streamReqLen;
  char*   dropStreamReq;
  int32_t dropStreamReqLen;
  int64_t uid;
} SMCreateSmaReq;

int32_t tSerializeSMCreateSmaReq(void* buf, int32_t bufLen, SMCreateSmaReq* pReq);
int32_t tDeserializeSMCreateSmaReq(void* buf, int32_t bufLen, SMCreateSmaReq* pReq);
void    tFreeSMCreateSmaReq(SMCreateSmaReq* pReq);

typedef struct {
  char    name[TSDB_TABLE_FNAME_LEN];
  int8_t  igNotExists;
  char*   dropStreamReq;
  int32_t dropStreamReqLen;
} SMDropSmaReq;

int32_t tSerializeSMDropSmaReq(void* buf, int32_t bufLen, SMDropSmaReq* pReq);
int32_t tDeserializeSMDropSmaReq(void* buf, int32_t bufLen, SMDropSmaReq* pReq);
void    tFreeSMDropSmaReq(SMDropSmaReq* pReq);

typedef struct {
  int32_t    msgType;  // begin, commit, rollback
  int8_t     clientStage;
  txn_id_t   txnId;
  int64_t    connId;
  SSHashObj* pVgSet;                      // Hash set of int32_t vgId  ->  dummy, client-tracked participant VGroups
  char       dbFName[TSDB_DB_FNAME_LEN];  // participating DB fullName (replicated txn COMMIT/ROLLBACK)
} SMTransReq;

int32_t tSerializeSMTransReq(void* buf, int32_t bufLen, SMTransReq* pReq);
int32_t tDeserializeSMTransReq(void* buf, int32_t bufLen, SMTransReq* pReq);
void    tFreeSMTransReq(SMTransReq* pReq);

// VNode registers with MNode to participate in a transaction (sent on first DDL carrying txnId)
typedef struct {
  txn_id_t  txnId;   // global transaction ID
  int32_t   vgId;    // sender VGroup ID
} SMndTxnRegReq;

typedef struct {
  int32_t code;      // 0=success, non-zero=failure (e.g. txn expired or already rolled back)
  txn_id_t txnId;
} SMndTxnRegRsp;

// MNode  ->  VNode: COMMIT instruction for a single transaction
typedef struct {
  txn_id_t  txnId;
  int64_t   term;    // current MNode Raft term (SyncTerm); used for VNode-side fencing
} SVTxnCommitReq;

// MNode  ->  VNode: ROLLBACK instruction for a single transaction
typedef struct {
  txn_id_t  txnId;
  int64_t   term;    // current MNode Raft term (SyncTerm); used for VNode-side fencing
  int32_t   reason;  // rollback reason code (timeout / client disconnect / explicit user rollback, etc.)
} SVTxnRollbackReq;

int32_t tSerializeSMndTxnRegReq(void* buf, int32_t bufLen, SMndTxnRegReq* pReq);
int32_t tDeserializeSMndTxnRegReq(void* buf, int32_t bufLen, SMndTxnRegReq* pReq);
int32_t tSerializeSMndTxnRegRsp(void* buf, int32_t bufLen, SMndTxnRegRsp* pRsp);
int32_t tDeserializeSMndTxnRegRsp(void* buf, int32_t bufLen, SMndTxnRegRsp* pRsp);
int32_t tSerializeSVTxnCommitReq(void* buf, int32_t bufLen, SVTxnCommitReq* pReq);
int32_t tDeserializeSVTxnCommitReq(void* buf, int32_t bufLen, SVTxnCommitReq* pReq);
int32_t tSerializeSVTxnRollbackReq(void* buf, int32_t bufLen, SVTxnRollbackReq* pReq);
int32_t tDeserializeSVTxnRollbackReq(void* buf, int32_t bufLen, SVTxnRollbackReq* pReq);

// VNode  ->  DNode  ->  MNode keepalive query (piggy-backed onto SStatusReq)
typedef struct {
  txn_id_t  txnId;
  int32_t   vgId;  // VNode issuing the query
} STxnActiveQuery;

typedef struct {
  char name[TSDB_TABLE_NAME_LEN];
  union {
    char tbFName[TSDB_TABLE_FNAME_LEN];  // used by mnode
    char tbName[TSDB_TABLE_NAME_LEN];    // used by vnode
  };
  int8_t tbType;  // ETableType: 1 stable, 3 normal table
  union {
    int8_t igExists;   // used by mnode
    int8_t alterType;  // used by vnode
  };
  int8_t     intervalUnit;
  int16_t    nFuncs;       // number of functions specified by user
  col_id_t*  funcColIds;   // column ids specified by user
  func_id_t* funcIds;      // function ids specified by user
  int64_t    interval[2];  // 0 unspecified, > 0 valid interval
  int64_t    tbUid;
  int64_t    uid;     // rsma uid
  int32_t    sqlLen;  // strlen + 1
  char*      sql;
} SMCreateRsmaReq;

int32_t tSerializeSMCreateRsmaReq(void* buf, int32_t bufLen, SMCreateRsmaReq* pReq);
int32_t tDeserializeSMCreateRsmaReq(void* buf, int32_t bufLen, SMCreateRsmaReq* pReq);
void    tFreeSMCreateRsmaReq(SMCreateRsmaReq* pReq);

typedef SMCreateRsmaReq SVCreateRsmaReq;

int32_t tSerializeSVCreateRsmaReq(void* buf, int32_t bufLen, SVCreateRsmaReq* pReq);
int32_t tDeserializeSVCreateRsmaReq(void* buf, int32_t bufLen, SVCreateRsmaReq* pReq);
void    tFreeSVCreateRsmaReq(SVCreateRsmaReq* pReq);

typedef SMCreateRsmaReq SVAlterRsmaReq;

int32_t tSerializeSVAlterRsmaReq(void* buf, int32_t bufLen, SVAlterRsmaReq* pReq);
int32_t tDeserializeSVAlterRsmaReq(void* buf, int32_t bufLen, SVAlterRsmaReq* pReq);
void    tFreeSVAlterRsmaReq(SVAlterRsmaReq* pReq);

typedef struct {
  char       name[TSDB_TABLE_NAME_LEN];
  int8_t     alterType;
  int8_t     tbType;  // ETableType: 1 stable, 3 normal table
  int8_t     igNotExists;
  int16_t    nFuncs;      // number of functions specified by user
  col_id_t*  funcColIds;  // column ids specified by user
  func_id_t* funcIds;     // function ids specified by user
  int32_t    sqlLen;      // strlen + 1
  char*      sql;
} SMAlterRsmaReq;

int32_t tSerializeSMAlterRsmaReq(void* buf, int32_t bufLen, SMAlterRsmaReq* pReq);
int32_t tDeserializeSMAlterRsmaReq(void* buf, int32_t bufLen, SMAlterRsmaReq* pReq);
void    tFreeSMAlterRsmaReq(SMAlterRsmaReq* pReq);

typedef struct {
  int64_t    id;
  char       name[TSDB_TABLE_NAME_LEN];
  char       tbFName[TSDB_TABLE_FNAME_LEN];
  int64_t    ownerId;
  int32_t    code;
  int32_t    version;
  int8_t     tbType;
  int8_t     intervalUnit;
  col_id_t   nFuncs;
  col_id_t   nColNames;
  int64_t    interval[2];
  col_id_t*  funcColIds;
  func_id_t* funcIds;
  SArray*    colNames;
} SRsmaInfoRsp;

int32_t tSerializeRsmaInfoRsp(void* buf, int32_t bufLen, SRsmaInfoRsp* pReq);
int32_t tDeserializeRsmaInfoRsp(void* buf, int32_t bufLen, SRsmaInfoRsp* pReq);
void    tFreeRsmaInfoRsp(SRsmaInfoRsp* pReq, bool deep);

typedef struct {
  char   name[TSDB_TABLE_FNAME_LEN];
  int8_t igNotExists;
} SMDropRsmaReq;

int32_t tSerializeSMDropRsmaReq(void* buf, int32_t bufLen, SMDropRsmaReq* pReq);
int32_t tDeserializeSMDropRsmaReq(void* buf, int32_t bufLen, SMDropRsmaReq* pReq);

typedef struct {
  char    name[TSDB_TABLE_NAME_LEN];
  char    tbName[TSDB_TABLE_NAME_LEN];
  int64_t uid;
  int64_t tbUid;
  int8_t  tbType;
} SVDropRsmaReq;

int32_t tSerializeSVDropRsmaReq(void* buf, int32_t bufLen, SVDropRsmaReq* pReq);
int32_t tDeserializeSVDropRsmaReq(void* buf, int32_t bufLen, SVDropRsmaReq* pReq);

typedef struct {
  char   dbFName[TSDB_DB_FNAME_LEN];
  char   stbName[TSDB_TABLE_NAME_LEN];
  char   colName[TSDB_COL_NAME_LEN];
  char   idxName[TSDB_INDEX_FNAME_LEN];
  int8_t idxType;
} SCreateTagIndexReq;

int32_t tSerializeSCreateTagIdxReq(void* buf, int32_t bufLen, SCreateTagIndexReq* pReq);
int32_t tDeserializeSCreateTagIdxReq(void* buf, int32_t bufLen, SCreateTagIndexReq* pReq);

typedef SMDropSmaReq SDropTagIndexReq;

// int32_t tSerializeSDropTagIdxReq(void* buf, int32_t bufLen, SDropTagIndexReq* pReq);
int32_t tDeserializeSDropTagIdxReq(void* buf, int32_t bufLen, SDropTagIndexReq* pReq);

typedef struct {
  int8_t         version;       // for compatibility(default 0)
  int8_t         intervalUnit;  // MACRO: TIME_UNIT_XXX
  int8_t         slidingUnit;   // MACRO: TIME_UNIT_XXX
  int8_t         timezoneInt;   // sma data expired if timezone changes.
  int32_t        dstVgId;
  char           indexName[TSDB_INDEX_NAME_LEN];
  int32_t        exprLen;
  int32_t        tagsFilterLen;
  int64_t        indexUid;
  tb_uid_t       tableUid;  // super/child/common table uid
  tb_uid_t       dstTbUid;  // for dstVgroup
  int64_t        interval;
  int64_t        offset;  // use unit by precision of DB
  int64_t        sliding;
  char*          dstTbName;  // for dstVgroup
  char*          expr;       // sma expression
  char*          tagsFilter;
  SSchemaWrapper schemaRow;  // for dstVgroup
  SSchemaWrapper schemaTag;  // for dstVgroup
} STSma;                     // Time-range-wise SMA

typedef STSma SVCreateTSmaReq;

typedef struct {
  int8_t  type;  // 0 status report, 1 update data
  int64_t indexUid;
  int64_t skey;  // start TS key of interval/sliding window
} STSmaMsg;

typedef struct {
  int64_t indexUid;
  char    indexName[TSDB_INDEX_NAME_LEN];
} SVDropTSmaReq;

typedef struct {
  int tmp;  // TODO: to avoid compile error
} SVCreateTSmaRsp, SVDropTSmaRsp;

#if 0
int32_t tSerializeSVCreateTSmaReq(void** buf, SVCreateTSmaReq* pReq);
void*   tDeserializeSVCreateTSmaReq(void* buf, SVCreateTSmaReq* pReq);
int32_t tSerializeSVDropTSmaReq(void** buf, SVDropTSmaReq* pReq);
void*   tDeserializeSVDropTSmaReq(void* buf, SVDropTSmaReq* pReq);
#endif

int32_t tEncodeSVCreateTSmaReq(SEncoder* pCoder, const SVCreateTSmaReq* pReq);
int32_t tDecodeSVCreateTSmaReq(SDecoder* pCoder, SVCreateTSmaReq* pReq);
int32_t tEncodeSVDropTSmaReq(SEncoder* pCoder, const SVDropTSmaReq* pReq);
// int32_t tDecodeSVDropTSmaReq(SDecoder* pCoder, SVDropTSmaReq* pReq);

typedef struct {
  int32_t number;
  STSma*  tSma;
} STSmaWrapper;

static FORCE_INLINE void tDestroyTSma(STSma* pSma) {
  if (pSma) {
    taosMemoryFreeClear(pSma->dstTbName);
    taosMemoryFreeClear(pSma->expr);
    taosMemoryFreeClear(pSma->tagsFilter);
  }
}

static FORCE_INLINE void tDestroyTSmaWrapper(STSmaWrapper* pSW, bool deepCopy) {
  if (pSW) {
    if (pSW->tSma) {
      if (deepCopy) {
        for (uint32_t i = 0; i < pSW->number; ++i) {
          tDestroyTSma(pSW->tSma + i);
        }
      }
      taosMemoryFreeClear(pSW->tSma);
    }
  }
}

static FORCE_INLINE void* tFreeTSmaWrapper(STSmaWrapper* pSW, bool deepCopy) {
  tDestroyTSmaWrapper(pSW, deepCopy);
  taosMemoryFreeClear(pSW);
  return NULL;
}

int32_t tEncodeSVCreateTSmaReq(SEncoder* pCoder, const SVCreateTSmaReq* pReq);
int32_t tDecodeSVCreateTSmaReq(SDecoder* pCoder, SVCreateTSmaReq* pReq);

int32_t tEncodeTSma(SEncoder* pCoder, const STSma* pSma);
int32_t tDecodeTSma(SDecoder* pCoder, STSma* pSma, bool deepCopy);

static int32_t tEncodeTSmaWrapper(SEncoder* pEncoder, const STSmaWrapper* pReq) {
  TAOS_CHECK_RETURN(tEncodeI32(pEncoder, pReq->number));
  for (int32_t i = 0; i < pReq->number; ++i) {
    TAOS_CHECK_RETURN(tEncodeTSma(pEncoder, pReq->tSma + i));
  }
  return 0;
}

static int32_t tDecodeTSmaWrapper(SDecoder* pDecoder, STSmaWrapper* pReq, bool deepCopy) {
  TAOS_CHECK_RETURN(tDecodeI32(pDecoder, &pReq->number));
  for (int32_t i = 0; i < pReq->number; ++i) {
    TAOS_CHECK_RETURN(tDecodeTSma(pDecoder, pReq->tSma + i, deepCopy));
  }
  return 0;
}

typedef struct {
  int idx;
} SMCreateFullTextReq;

int32_t tSerializeSMCreateFullTextReq(void* buf, int32_t bufLen, SMCreateFullTextReq* pReq);
int32_t tDeserializeSMCreateFullTextReq(void* buf, int32_t bufLen, SMCreateFullTextReq* pReq);
void    tFreeSMCreateFullTextReq(SMCreateFullTextReq* pReq);

typedef struct {
  char   name[TSDB_TABLE_FNAME_LEN];
  int8_t igNotExists;
} SMDropFullTextReq;

// int32_t tSerializeSMDropFullTextReq(void* buf, int32_t bufLen, SMDropFullTextReq* pReq);
// int32_t tDeserializeSMDropFullTextReq(void* buf, int32_t bufLen, SMDropFullTextReq* pReq);

typedef struct {
  char indexFName[TSDB_INDEX_FNAME_LEN];
} SUserIndexReq;

int32_t tSerializeSUserIndexReq(void* buf, int32_t bufLen, SUserIndexReq* pReq);
int32_t tDeserializeSUserIndexReq(void* buf, int32_t bufLen, SUserIndexReq* pReq);

typedef struct {
  char dbFName[TSDB_DB_FNAME_LEN];
  char tblFName[TSDB_TABLE_FNAME_LEN];
  char colName[TSDB_COL_NAME_LEN];
  char owner[TSDB_USER_LEN];
  char indexType[TSDB_INDEX_TYPE_LEN];
  char indexExts[TSDB_INDEX_EXTS_LEN];
} SUserIndexRsp;

int32_t tSerializeSUserIndexRsp(void* buf, int32_t bufLen, const SUserIndexRsp* pRsp);
int32_t tDeserializeSUserIndexRsp(void* buf, int32_t bufLen, SUserIndexRsp* pRsp);

typedef struct {
  char tbFName[TSDB_TABLE_FNAME_LEN];
} STableIndexReq;

int32_t tSerializeSTableIndexReq(void* buf, int32_t bufLen, STableIndexReq* pReq);
int32_t tDeserializeSTableIndexReq(void* buf, int32_t bufLen, STableIndexReq* pReq);

typedef struct {
  int8_t  intervalUnit;
  int8_t  slidingUnit;
  int64_t interval;
  int64_t offset;
  int64_t sliding;
  int64_t dstTbUid;
  int32_t dstVgId;
  SEpSet  epSet;
  char*   expr;
} STableIndexInfo;

typedef struct {
  char     tbName[TSDB_TABLE_NAME_LEN];
  char     dbFName[TSDB_DB_FNAME_LEN];
  uint64_t suid;
  int32_t  version;
  int32_t  indexSize;
  SArray*  pIndex;  // STableIndexInfo
} STableIndexRsp;

int32_t tSerializeSTableIndexRsp(void* buf, int32_t bufLen, const STableIndexRsp* pRsp);
int32_t tDeserializeSTableIndexRsp(void* buf, int32_t bufLen, STableIndexRsp* pRsp);
void    tFreeSerializeSTableIndexRsp(STableIndexRsp* pRsp);

void tFreeSTableIndexInfo(void* pInfo);

typedef struct {
  int8_t  mqMsgType;
  int32_t code;
  int32_t epoch;
  int64_t consumerId;
  int64_t walsver;
  int64_t walever;
} SMqRspHead;

typedef struct {
  SMsgHead     head;
  char         subKey[TSDB_SUBSCRIBE_KEY_LEN];
  int8_t       withTbName;
  int8_t       useSnapshot;
  int32_t      epoch;
  uint64_t     reqId;
  int64_t      consumerId;
  int64_t      timeout;
  STqOffsetVal reqOffset;
  int8_t       enableReplay;
  int8_t       sourceExcluded;
  int8_t       rawData;
  int32_t      minPollRows;
  int8_t       enableBatchMeta;
  SHashObj*    uidHash;  // to find if uid is duplicated
} SMqPollReq;

int32_t tSerializeSMqPollReq(void* buf, int32_t bufLen, SMqPollReq* pReq);
int32_t tDeserializeSMqPollReq(void* buf, int32_t bufLen, SMqPollReq* pReq);
void    tDestroySMqPollReq(SMqPollReq* pReq);

typedef struct {
  int32_t vgId;
  int64_t offset;
  SEpSet  epSet;
} SMqSubVgEp;

static FORCE_INLINE int32_t tEncodeSMqSubVgEp(void** buf, const SMqSubVgEp* pVgEp) {
  int32_t tlen = 0;
  tlen += taosEncodeFixedI32(buf, pVgEp->vgId);
  tlen += taosEncodeFixedI64(buf, pVgEp->offset);
  tlen += taosEncodeSEpSet(buf, &pVgEp->epSet);
  return tlen;
}

static FORCE_INLINE void* tDecodeSMqSubVgEp(void* buf, SMqSubVgEp* pVgEp) {
  buf = taosDecodeFixedI32(buf, &pVgEp->vgId);
  buf = taosDecodeFixedI64(buf, &pVgEp->offset);
  buf = taosDecodeSEpSet(buf, &pVgEp->epSet);
  return buf;
}

typedef struct {
  char    topic[TSDB_TOPIC_FNAME_LEN];
  char    db[TSDB_DB_FNAME_LEN];
  SArray* vgs;  // SArray<SMqSubVgEp>
} SMqSubTopicEp;

int32_t tEncodeMqSubTopicEp(void** buf, const SMqSubTopicEp* pTopicEp);
void*   tDecodeMqSubTopicEp(void* buf, SMqSubTopicEp* pTopicEp);
void    tDeleteMqSubTopicEp(SMqSubTopicEp* pSubTopicEp);

typedef struct {
  SMqRspHead   head;
  STqOffsetVal rspOffset;
  int16_t      resMsgType;
  int32_t      metaRspLen;
  void*        metaRsp;
} SMqMetaRsp;

int32_t tEncodeMqMetaRsp(SEncoder* pEncoder, const SMqMetaRsp* pRsp);
int32_t tDecodeMqMetaRsp(SDecoder* pDecoder, SMqMetaRsp* pRsp);
void    tDeleteMqMetaRsp(SMqMetaRsp* pRsp);

#define MQ_DATA_RSP_VERSION 100

typedef struct {
  SMqRspHead   head;
  STqOffsetVal rspOffset;
  STqOffsetVal reqOffset;
  int32_t      blockNum;
  int8_t       withTbName;
  int8_t       withSchema;
  SArray*      blockDataLen;
  SArray*      blockData;
  SArray*      blockTbName;
  SArray*      blockSchema;

  union {
    struct {
      int64_t sleepTime;
    };
    struct {
      int32_t createTableNum;
      SArray* createTableLen;
      SArray* createTableReq;
    };
    struct {
      int32_t len;
      void*   rawData;
    };
  };
  void* data;                  // for free in client, only effected if type is data or metadata. raw data not effected
  bool  blockDataElementFree;  // if true, free blockDataElement in blockData,(true in server, false in client)
  bool  timeout;
} SMqDataRsp;

int32_t tEncodeMqDataRsp(SEncoder* pEncoder, const SMqDataRsp* pObj);
int32_t tDecodeMqDataRsp(SDecoder* pDecoder, SMqDataRsp* pRsp);
int32_t tDecodeMqRawDataRsp(SDecoder* pDecoder, SMqDataRsp* pRsp);
void    tDeleteMqDataRsp(SMqDataRsp* pRsp);
void    tDeleteMqRawDataRsp(SMqDataRsp* pRsp);

int32_t tEncodeSTaosxRsp(SEncoder* pEncoder, const SMqDataRsp* pRsp);
int32_t tDecodeSTaosxRsp(SDecoder* pDecoder, SMqDataRsp* pRsp);
void    tDeleteSTaosxRsp(SMqDataRsp* pRsp);

typedef struct SMqBatchMetaRsp {
  SMqRspHead   head;  // not serialize
  STqOffsetVal rspOffset;
  SArray*      batchMetaLen;
  SArray*      batchMetaReq;
  void*        pMetaBuff;    // not serialize
  uint32_t     metaBuffLen;  // not serialize
} SMqBatchMetaRsp;

int32_t tEncodeMqBatchMetaRsp(SEncoder* pEncoder, const SMqBatchMetaRsp* pRsp);
int32_t tDecodeMqBatchMetaRsp(SDecoder* pDecoder, SMqBatchMetaRsp* pRsp);
int32_t tSemiDecodeMqBatchMetaRsp(SDecoder* pDecoder, SMqBatchMetaRsp* pRsp);
void    tDeleteMqBatchMetaRsp(SMqBatchMetaRsp* pRsp);

typedef struct {
  int32_t code;
  SArray* topics;  // SArray<SMqSubTopicEp>
} SMqAskEpRsp;

static FORCE_INLINE int32_t tEncodeSMqAskEpRsp(void** buf, const SMqAskEpRsp* pRsp) {
  int32_t tlen = 0;
  // tlen += taosEncodeString(buf, pRsp->cgroup);
  int32_t sz = taosArrayGetSize(pRsp->topics);
  tlen += taosEncodeFixedI32(buf, sz);
  for (int32_t i = 0; i < sz; i++) {
    SMqSubTopicEp* pVgEp = (SMqSubTopicEp*)taosArrayGet(pRsp->topics, i);
    tlen += tEncodeMqSubTopicEp(buf, pVgEp);
  }
  tlen += taosEncodeFixedI32(buf, pRsp->code);

  return tlen;
}

static FORCE_INLINE void* tDecodeSMqAskEpRsp(void* buf, SMqAskEpRsp* pRsp) {
  // buf = taosDecodeStringTo(buf, pRsp->cgroup);
  int32_t sz;
  buf = taosDecodeFixedI32(buf, &sz);
  pRsp->topics = taosArrayInit(sz, sizeof(SMqSubTopicEp));
  if (pRsp->topics == NULL) {
    return NULL;
  }
  for (int32_t i = 0; i < sz; i++) {
    SMqSubTopicEp topicEp;
    buf = tDecodeMqSubTopicEp(buf, &topicEp);
    if (buf == NULL) {
      return NULL;
    }
    if ((taosArrayPush(pRsp->topics, &topicEp) == NULL)) {
      return NULL;
    }
  }
  buf = taosDecodeFixedI32(buf, &pRsp->code);

  return buf;
}

static FORCE_INLINE void tDeleteSMqAskEpRsp(SMqAskEpRsp* pRsp) {
  taosArrayDestroyEx(pRsp->topics, (FDelete)tDeleteMqSubTopicEp);
}

typedef struct {
  int32_t      vgId;
  STqOffsetVal offset;
  int64_t      rows;
  int64_t      ever;
} OffsetRows;

typedef struct {
  char    topicName[TSDB_TOPIC_FNAME_LEN];
  SArray* offsetRows;
} TopicOffsetRows;

typedef struct {
  int64_t consumerId;
  int32_t epoch;
  SArray* topics;
  int8_t  pollFlag;
} SMqHbReq;

typedef struct {
  char   topic[TSDB_TOPIC_FNAME_LEN];
  int8_t noPrivilege;
} STopicPrivilege;

typedef struct {
  SArray* topicPrivileges;  // SArray<STopicPrivilege>
  int32_t debugFlag;
} SMqHbRsp;

#define TD_AUTO_CREATE_TABLE 0x1
typedef struct {
  int64_t       suid;
  int64_t       uid;
  int32_t       sver;
  uint32_t      nData;
  uint8_t*      pData;
  SVCreateTbReq cTbReq;
} SVSubmitBlk;

typedef struct {
  SMsgHead header;
  uint64_t sId;
  uint64_t queryId;
  uint64_t clientId;
  uint64_t taskId;
  uint32_t sqlLen;
  uint32_t phyLen;
  char*    sql;
  char*    msg;
  int8_t   source;
  int8_t   secureDelete;
} SVDeleteReq;

int32_t tSerializeSVDeleteReq(void* buf, int32_t bufLen, SVDeleteReq* pReq);
int32_t tDeserializeSVDeleteReq(void* buf, int32_t bufLen, SVDeleteReq* pReq);

typedef struct {
  int64_t affectedRows;
} SVDeleteRsp;

int32_t tEncodeSVDeleteRsp(SEncoder* pCoder, const SVDeleteRsp* pReq);
int32_t tDecodeSVDeleteRsp(SDecoder* pCoder, SVDeleteRsp* pReq);

// One matched point produced by a DELETE carrying an ordinary column filter, for the subtable
// `uid`. The deleter (dataDeleter.c) only ever emits the degenerate form skey == ekey == the
// matched row's ts -- it never widens [skey, ekey] into a true multi-row range, and consecutive
// duplicate timestamps for the same uid collapse into one entry. Do not read this as "every row
// inside [skey, ekey] matches the filter" for a non-degenerate range: that invariant has never
// been established here, and treating a wider range as safe to bulk-delete would delete rows the
// filter never matched.
typedef struct SDeleteInterval {
  uint64_t uid;
  int64_t  skey;
  int64_t  ekey;
} SDeleteInterval;

typedef struct SDeleteRes {
  uint64_t suid;
  SArray*  uidList;
  int64_t  skey;
  int64_t  ekey;
  int64_t  affectedRows;
  char     tableFName[TSDB_TABLE_NAME_LEN];
  char     tsColName[TSDB_COL_NAME_LEN];
  int64_t  ctimeMs;  // fill by vnode
  int8_t   source;
  int8_t   secureDelete;  // force physical overwrite
  // SArray<SDeleteInterval>. In-process scratch only, and NOT one entry per matched row: the
  // deleter (dataDeleter.c) collapses consecutive duplicate timestamps for the same uid into a
  // single degenerate entry, so this list can be shorter than affectedRows. It is populated by
  // qwGetDeleteResFromSink (copied from SDeleterRes.pIntervals, which the deleter itself fills
  // in), and read exactly once by vnodePreProcessDeleteMsg on the leader to fan the statement out
  // into N independent old-shape SDeleteRes proposals before Raft ever sees anything.
  // tEncodeDeleteRes/tDecodeDeleteRes never touch this field -- it must never appear on the wire,
  // and every SDeleteRes must be zero-initialized before use so an unset pointer here is never
  // mistaken for a live one.
  SArray*  pSplitPoints;
} SDeleteRes;

int32_t tEncodeDeleteRes(SEncoder* pCoder, const SDeleteRes* pRes);
int32_t tDecodeDeleteRes(SDecoder* pCoder, SDeleteRes* pRes);

typedef struct {
  // int64_t uid;
  char    tbname[TSDB_TABLE_NAME_LEN];
  int64_t startTs;
  int64_t endTs;
} SSingleDeleteReq;

int32_t tEncodeSSingleDeleteReq(SEncoder* pCoder, const SSingleDeleteReq* pReq);
int32_t tDecodeSSingleDeleteReq(SDecoder* pCoder, SSingleDeleteReq* pReq);

typedef struct {
  int64_t suid;
  SArray* deleteReqs;  // SArray<SSingleDeleteReq>
  int64_t ctimeMs;     // fill by vnode
  int8_t  level;       // 0 tsdb(default), 1 rsma1 , 2 rsma2
} SBatchDeleteReq;

int32_t tEncodeSBatchDeleteReq(SEncoder* pCoder, const SBatchDeleteReq* pReq);
int32_t tDecodeSBatchDeleteReq(SDecoder* pCoder, SBatchDeleteReq* pReq);
int32_t tDecodeSBatchDeleteReqSetCtime(SDecoder* pDecoder, SBatchDeleteReq* pReq, int64_t ctimeMs);

typedef struct {
  int32_t msgIdx;
  int32_t msgType;
  int32_t msgLen;
  void*   msg;
} SBatchMsg;

typedef struct {
  SMsgHead header;
  SArray*  pMsgs;  // SArray<SBatchMsg>
} SBatchReq;

typedef struct {
  int32_t reqType;
  int32_t msgIdx;
  int32_t msgLen;
  int32_t rspCode;
  void*   msg;
} SBatchRspMsg;

typedef struct {
  SArray* pRsps;  // SArray<SBatchRspMsg>
} SBatchRsp;

int32_t                  tSerializeSBatchReq(void* buf, int32_t bufLen, SBatchReq* pReq);
int32_t                  tDeserializeSBatchReq(void* buf, int32_t bufLen, SBatchReq* pReq);
static FORCE_INLINE void tFreeSBatchReqMsg(void* msg) {
  if (NULL == msg) {
    return;
  }
  SBatchMsg* pMsg = (SBatchMsg*)msg;
  taosMemoryFree(pMsg->msg);
}

int32_t tSerializeSBatchRsp(void* buf, int32_t bufLen, SBatchRsp* pRsp);
int32_t tDeserializeSBatchRsp(void* buf, int32_t bufLen, SBatchRsp* pRsp);

static FORCE_INLINE void tFreeSBatchRspMsg(void* p) {
  if (NULL == p) {
    return;
  }

  SBatchRspMsg* pRsp = (SBatchRspMsg*)p;
  taosMemoryFree(pRsp->msg);
}

int32_t tSerializeSMqAskEpReq(void* buf, int32_t bufLen, SMqAskEpReq* pReq);
int32_t tDeserializeSMqAskEpReq(void* buf, int32_t bufLen, SMqAskEpReq* pReq);
int32_t tSerializeSMqHbReq(void* buf, int32_t bufLen, SMqHbReq* pReq);
int32_t tDeserializeSMqHbReq(void* buf, int32_t bufLen, SMqHbReq* pReq);
void    tDestroySMqHbReq(SMqHbReq* pReq);

int32_t tSerializeSMqHbRsp(void* buf, int32_t bufLen, SMqHbRsp* pRsp);
int32_t tDeserializeSMqHbRsp(void* buf, int32_t bufLen, SMqHbRsp* pRsp);
void    tDestroySMqHbRsp(SMqHbRsp* pRsp);

#define TD_REQ_FROM_APP               0x0
#define SUBMIT_REQ_AUTO_CREATE_TABLE  0x1
#define SUBMIT_REQ_COLUMN_DATA_FORMAT 0x2
#define SUBMIT_REQ_FROM_FILE          0x4
#define TD_REQ_FROM_TAOX              0x8
#define TD_REQ_FROM_SML               0x10
#define SUBMIT_REQUEST_VERSION        (2)
#define SUBMIT_REQ_WITH_BLOB          0x10
#define SUBMIT_REQ_SCHEMA_RES         0x20
#define SUBMIT_REQ_ONLY_CREATE_TABLE  0x40

#define TD_REQ_FROM_TAOX_OLD 0x1  // for compatibility

typedef struct {
  int32_t        flags;
  SVCreateTbReq* pCreateTbReq;
  int64_t        suid;
  int64_t        uid;
  int32_t        sver;
  union {
    SArray* aRowP;
    SArray* aCol;
  };
  int64_t   ctimeMs;
  SBlobSet* pBlobSet;
} SSubmitTbData;

typedef struct {
  SArray* aSubmitTbData;  // SArray<SSubmitTbData>
  SArray* aSubmitBlobData;
  bool    raw;
} SSubmitReq2;

typedef struct {
  SMsgHead header;
  int64_t  version;
  char     data[];  // SSubmitReq2
} SSubmitReq2Msg;

int32_t transformRawSSubmitTbData(void* data, int64_t suid, int64_t uid, int32_t sver);
int32_t tEncodeSubmitReq(SEncoder* pCoder, const SSubmitReq2* pReq);
int32_t tDecodeSubmitReq(SDecoder* pCoder, SSubmitReq2* pReq, SArray* rawList);
void    tDestroySubmitTbData(SSubmitTbData* pTbData, int32_t flag);
void    tDestroySubmitReq(SSubmitReq2* pReq, int32_t flag);

typedef struct {
  int32_t affectedRows;
  SArray* aCreateTbRsp;  // SArray<SVCreateTbRsp>
} SSubmitRsp2;

int32_t tEncodeSSubmitRsp2(SEncoder* pCoder, const SSubmitRsp2* pRsp);
int32_t tDecodeSSubmitRsp2(SDecoder* pCoder, SSubmitRsp2* pRsp);
void    tDestroySSubmitRsp2(SSubmitRsp2* pRsp, int32_t flag);

#define TSDB_MSG_FLG_ENCODE 0x1
#define TSDB_MSG_FLG_DECODE 0x2
#define TSDB_MSG_FLG_CMPT   0x3

typedef struct {
  union {
    struct {
      void*   msgStr;
      int32_t msgLen;
      int64_t ver;
    };
    void* pDataBlock;
  };
} SPackedData;

typedef struct {
  char     fullname[TSDB_VIEW_FNAME_LEN];
  char     name[TSDB_VIEW_NAME_LEN];
  char     dbFName[TSDB_DB_FNAME_LEN];
  char*    querySql;
  char*    sql;
  int8_t   orReplace;
  int8_t   precision;
  int32_t  numOfCols;
  SSchema* pSchema;
} SCMCreateViewReq;

int32_t tSerializeSCMCreateViewReq(void* buf, int32_t bufLen, const SCMCreateViewReq* pReq);
int32_t tDeserializeSCMCreateViewReq(void* buf, int32_t bufLen, SCMCreateViewReq* pReq);
void    tFreeSCMCreateViewReq(SCMCreateViewReq* pReq);

typedef struct {
  char   fullname[TSDB_VIEW_FNAME_LEN];
  char   name[TSDB_VIEW_NAME_LEN];
  char   dbFName[TSDB_DB_FNAME_LEN];
  char*  sql;
  int8_t igNotExists;
} SCMDropViewReq;

int32_t tSerializeSCMDropViewReq(void* buf, int32_t bufLen, const SCMDropViewReq* pReq);
int32_t tDeserializeSCMDropViewReq(void* buf, int32_t bufLen, SCMDropViewReq* pReq);
void    tFreeSCMDropViewReq(SCMDropViewReq* pReq);

typedef struct {
  char fullname[TSDB_VIEW_FNAME_LEN];
} SViewMetaReq;
int32_t tSerializeSViewMetaReq(void* buf, int32_t bufLen, const SViewMetaReq* pReq);
int32_t tDeserializeSViewMetaReq(void* buf, int32_t bufLen, SViewMetaReq* pReq);

typedef struct {
  char     name[TSDB_VIEW_NAME_LEN];
  char     dbFName[TSDB_DB_FNAME_LEN];
  char*    createUser;
  int64_t  ownerId;
  uint64_t dbId;
  uint64_t viewId;
  char*    querySql;
  int8_t   precision;
  int8_t   type;
  int32_t  version;
  int32_t  numOfCols;
  SSchema* pSchema;
} SViewMetaRsp;
int32_t tSerializeSViewMetaRsp(void* buf, int32_t bufLen, const SViewMetaRsp* pRsp);
int32_t tDeserializeSViewMetaRsp(void* buf, int32_t bufLen, SViewMetaRsp* pRsp);
void    tFreeSViewMetaRsp(SViewMetaRsp* pRsp);
typedef struct {
  char name[TSDB_TABLE_FNAME_LEN];  // table name or tsma name
  bool fetchingWithTsmaName;        // if we are fetching with tsma name
} STableTSMAInfoReq;

int32_t tSerializeTableTSMAInfoReq(void* buf, int32_t bufLen, const STableTSMAInfoReq* pReq);
int32_t tDeserializeTableTSMAInfoReq(void* buf, int32_t bufLen, STableTSMAInfoReq* pReq);

typedef struct {
  char name[TSDB_TABLE_NAME_LEN];  // rsmaName
  union {
    uint8_t flags;
    struct {
      uint8_t withColName : 1;
      uint8_t reserved : 7;
    };
  };

} SRsmaInfoReq;

int32_t tSerializeRsmaInfoReq(void* buf, int32_t bufLen, const SRsmaInfoReq* pReq);
int32_t tDeserializeRsmaInfoReq(void* buf, int32_t bufLen, SRsmaInfoReq* pReq);

typedef struct {
  int32_t  funcId;
  col_id_t colId;
} STableTSMAFuncInfo;

typedef struct {
  char     name[TSDB_TABLE_NAME_LEN];
  uint64_t tsmaId;
  char     targetTb[TSDB_TABLE_NAME_LEN];
  char     targetDbFName[TSDB_DB_FNAME_LEN];
  char     tb[TSDB_TABLE_NAME_LEN];
  char     dbFName[TSDB_DB_FNAME_LEN];
  uint64_t suid;
  uint64_t destTbUid;
  uint64_t dbId;
  int32_t  version;
  int64_t  interval;
  int8_t   unit;
  SArray*  pFuncs;     // SArray<STableTSMAFuncInfo>
  SArray*  pTags;      // SArray<SSchema>
  SArray*  pUsedCols;  // SArray<SSchema>
  char*    ast;

  int64_t streamUid;
  int64_t reqTs;
  int64_t rspTs;
  int64_t delayDuration;  // ms
  bool    fillHistoryFinished;

  void* streamAddr;  // for stream task, the address of the stream task
} STableTSMAInfo;

int32_t tSerializeTableTSMAInfoRsp(void* buf, int32_t bufLen, const STableTSMAInfoRsp* pRsp);
int32_t tDeserializeTableTSMAInfoRsp(void* buf, int32_t bufLen, STableTSMAInfoRsp* pRsp);
int32_t tCloneTbTSMAInfo(STableTSMAInfo* pInfo, STableTSMAInfo** pRes);
void    tFreeTableTSMAInfo(void* p);
void    tFreeAndClearTableTSMAInfo(void* p);
void    tFreeTableTSMAInfoRsp(STableTSMAInfoRsp* pRsp);

#define STSMAHbRsp            STableTSMAInfoRsp
#define tSerializeTSMAHbRsp   tSerializeTableTSMAInfoRsp
#define tDeserializeTSMAHbRsp tDeserializeTableTSMAInfoRsp
#define tFreeTSMAHbRsp        tFreeTableTSMAInfoRsp

typedef struct SDropCtbWithTsmaSingleVgReq {
  SVgroupInfo vgInfo;
  SArray*     pTbs;  // SVDropTbReq
} SMDropTbReqsOnSingleVg;

int32_t tEncodeSMDropTbReqOnSingleVg(SEncoder* pEncoder, const SMDropTbReqsOnSingleVg* pReq);
int32_t tDecodeSMDropTbReqOnSingleVg(SDecoder* pDecoder, SMDropTbReqsOnSingleVg* pReq);
void    tFreeSMDropTbReqOnSingleVg(void* p);

typedef struct SDropTbsReq {
  SArray* pVgReqs;  // SMDropTbReqsOnSingleVg
} SMDropTbsReq;

int32_t tSerializeSMDropTbsReq(void* buf, int32_t bufLen, const SMDropTbsReq* pReq);
int32_t tDeserializeSMDropTbsReq(void* buf, int32_t bufLen, SMDropTbsReq* pReq);
void    tFreeSMDropTbsReq(void*);

typedef struct SVFetchTtlExpiredTbsRsp {
  SArray* pExpiredTbs;  // SVDropTbReq
  int32_t vgId;
} SVFetchTtlExpiredTbsRsp;

int32_t tEncodeVFetchTtlExpiredTbsRsp(SEncoder* pCoder, const SVFetchTtlExpiredTbsRsp* pRsp);
int32_t tDecodeVFetchTtlExpiredTbsRsp(SDecoder* pCoder, SVFetchTtlExpiredTbsRsp* pRsp);

void tFreeFetchTtlExpiredTbsRsp(void* p);

void setDefaultOptionsForField(SFieldWithOptions* field);
void setFieldWithOptions(SFieldWithOptions* fieldWithOptions, SField* field);

int32_t tSerializeSVSubTablesRspImpl(SEncoder* pEncoder, SVSubTablesRsp* pRsp);
int32_t tDeserializeSVSubTablesRspImpl(SDecoder* pDecoder, SVSubTablesRsp* pRsp);

typedef struct {
  char    id[TSDB_INSTANCE_ID_LEN];
  char    type[TSDB_INSTANCE_TYPE_LEN];
  char    desc[TSDB_INSTANCE_DESC_LEN];
  int32_t expire;
} SInstanceRegisterReq;

int32_t tSerializeSInstanceRegisterReq(void* buf, int32_t bufLen, SInstanceRegisterReq* pReq);
int32_t tDeserializeSInstanceRegisterReq(void* buf, int32_t bufLen, SInstanceRegisterReq* pReq);

typedef struct {
  char filter_type[TSDB_INSTANCE_TYPE_LEN];
} SInstanceListReq;

typedef struct {
  int32_t count;
  char**  ids;  // Array of instance IDs
} SInstanceListRsp;

int32_t tSerializeSInstanceListReq(void* buf, int32_t bufLen, SInstanceListReq* pReq);
int32_t tDeserializeSInstanceListReq(void* buf, int32_t bufLen, SInstanceListReq* pReq);
int32_t tSerializeSInstanceListRsp(void* buf, int32_t bufLen, SInstanceListRsp* pRsp);
int32_t tDeserializeSInstanceListRsp(void* buf, int32_t bufLen, SInstanceListRsp* pRsp);

#ifdef USE_MOUNT
typedef struct {
  char     mountName[TSDB_MOUNT_NAME_LEN];
  int8_t   ignoreExist;
  int16_t  nMounts;
  int32_t* dnodeIds;
  char**   mountPaths;
  int32_t  sqlLen;
  char*    sql;
} SCreateMountReq;

int32_t tSerializeSCreateMountReq(void* buf, int32_t bufLen, SCreateMountReq* pReq);
int32_t tDeserializeSCreateMountReq(void* buf, int32_t bufLen, SCreateMountReq* pReq);
void    tFreeSCreateMountReq(SCreateMountReq* pReq);

typedef struct {
  char    mountName[TSDB_MOUNT_NAME_LEN];
  int8_t  ignoreNotExists;
  int32_t sqlLen;
  char*   sql;
} SDropMountReq;

int32_t tSerializeSDropMountReq(void* buf, int32_t bufLen, SDropMountReq* pReq);
int32_t tDeserializeSDropMountReq(void* buf, int32_t bufLen, SDropMountReq* pReq);
void    tFreeSDropMountReq(SDropMountReq* pReq);

typedef struct {
  char     mountName[TSDB_MOUNT_NAME_LEN];
  char     mountPath[TSDB_MOUNT_PATH_LEN];
  int64_t  mountUid;
  int32_t  dnodeId;
  uint32_t valLen;
  int8_t   ignoreExist;
  void*    pVal;
} SRetrieveMountPathReq;

int32_t tSerializeSRetrieveMountPathReq(void* buf, int32_t bufLen, SRetrieveMountPathReq* pReq);
int32_t tDeserializeSRetrieveMountPathReq(void* buf, int32_t bufLen, SRetrieveMountPathReq* pReq);

typedef struct {
  // path
  int32_t diskPrimary;
  // vgInfo
  int32_t  vgId;
  int32_t  cacheLastSize;
  int32_t  szPage;
  int32_t  szCache;
  uint64_t szBuf;
  int8_t   cacheLast;
  int8_t   standby;
  int8_t   hashMethod;
  uint32_t hashBegin;
  uint32_t hashEnd;
  int16_t  hashPrefix;
  int16_t  hashSuffix;
  int16_t  sttTrigger;
  // syncInfo
  int32_t replications;
  // tsdbInfo
  int8_t  precision;
  int8_t  compression;
  int8_t  slLevel;
  int32_t daysPerFile;
  int32_t keep0;
  int32_t keep1;
  int32_t keep2;
  int32_t keepTimeOffset;
  int32_t minRows;
  int32_t maxRows;
  int32_t tsdbPageSize;
  int32_t ssChunkSize;
  int32_t ssKeepLocal;
  int8_t  ssCompact;
  union {
    uint8_t flags;
    struct {
      uint8_t isAudit : 1;
      uint8_t allowDrop : 1;
      uint8_t securityLevel : 3;
      uint8_t reserved : 3;
    };
  };
  int8_t secureDelete;
  // walInfo
  int32_t walFsyncPeriod;      // millisecond
  int32_t walRetentionPeriod;  // secs
  int32_t walRollPeriod;       // secs
  int64_t walRetentionSize;
  int64_t walSegSize;
  int32_t walLevel;
  // encryptInfo
  int32_t encryptAlgorithm;
  // SVState
  int64_t committed;
  int64_t commitID;
  int64_t commitTerm;
  // stats
  int64_t numOfSTables;
  int64_t numOfCTables;
  int64_t numOfNTables;
  // dbInfo
  uint64_t dbId;
} SMountVgInfo;

typedef struct {
  SMCreateStbReq req;
  SArray*        pColExts;  // element: column id
  SArray*        pTagExts;  // element: tag id
} SMountStbInfo;

int32_t tSerializeSMountStbInfo(void* buf, int32_t bufLen, int32_t* pFLen, SMountStbInfo* pInfo);
int32_t tDeserializeSMountStbInfo(void* buf, int32_t bufLen, int32_t flen, SMountStbInfo* pInfo);

typedef struct {
  char     dbName[TSDB_DB_FNAME_LEN];
  uint64_t dbId;
  SArray*  pVgs;   // SMountVgInfo
  SArray*  pStbs;  // 0 serialized binary of SMountStbInfo, 1 SMountStbInfo
} SMountDbInfo;

typedef struct {
  // common fields
  char     mountName[TSDB_MOUNT_NAME_LEN];
  char     mountPath[TSDB_MOUNT_PATH_LEN];
  int8_t   ignoreExist;
  int64_t  mountUid;
  int64_t  clusterId;
  int32_t  dnodeId;
  uint32_t valLen;
  void*    pVal;

  // response fields
  SArray* pDbs;  // SMountDbInfo

  // memory fields, no serialized
  SArray*   pDisks[TFS_MAX_TIERS];
  TdFilePtr pFile;
} SMountInfo;

int32_t tSerializeSMountInfo(void* buf, int32_t bufLen, SMountInfo* pReq);
int32_t tDeserializeSMountInfo(SDecoder* decoder, SMountInfo* pReq, bool extractStb);
void    tFreeMountInfo(SMountInfo* pReq, bool stbExtracted);

typedef struct {
  SCreateVnodeReq createReq;
  char            mountPath[TSDB_MOUNT_FPATH_LEN];
  char            mountName[TSDB_MOUNT_NAME_LEN];
  int64_t         mountId;
  int32_t         diskPrimary;
  int32_t         mountVgId;
  int64_t         committed;
  int64_t         commitID;
  int64_t         commitTerm;
  int64_t         numOfSTables;
  int64_t         numOfCTables;
  int64_t         numOfNTables;
} SMountVnodeReq;

int32_t tSerializeSMountVnodeReq(void* buf, int32_t* cBufLen, int32_t* tBufLen, SMountVnodeReq* pReq);
int32_t tDeserializeSMountVnodeReq(void* buf, int32_t bufLen, SMountVnodeReq* pReq);
int32_t tFreeSMountVnodeReq(SMountVnodeReq* pReq);

#endif  // USE_MOUNT

#pragma pack(pop)

typedef struct {
  char        db[TSDB_DB_FNAME_LEN];
  STimeWindow timeRange;
  int32_t     sqlLen;
  char*       sql;
  SArray*     vgroupIds;
} SScanDbReq;

int32_t tSerializeSScanDbReq(void* buf, int32_t bufLen, SScanDbReq* pReq);
int32_t tDeserializeSScanDbReq(void* buf, int32_t bufLen, SScanDbReq* pReq);
void    tFreeSScanDbReq(SScanDbReq* pReq);

typedef struct {
  int32_t scanId;
  int8_t  bAccepted;
} SScanDbRsp;

int32_t tSerializeSScanDbRsp(void* buf, int32_t bufLen, SScanDbRsp* pRsp);
int32_t tDeserializeSScanDbRsp(void* buf, int32_t bufLen, SScanDbRsp* pRsp);

typedef struct {
  int32_t scanId;
  int32_t sqlLen;
  char*   sql;
} SKillScanReq;

int32_t tSerializeSKillScanReq(void* buf, int32_t bufLen, SKillScanReq* pReq);
int32_t tDeserializeSKillScanReq(void* buf, int32_t bufLen, SKillScanReq* pReq);
void    tFreeSKillScanReq(SKillScanReq* pReq);

typedef struct {
  int32_t scanId;
  int32_t vgId;
  int32_t dnodeId;
} SVKillScanReq;

int32_t tSerializeSVKillScanReq(void* buf, int32_t bufLen, SVKillScanReq* pReq);
int32_t tDeserializeSVKillScanReq(void* buf, int32_t bufLen, SVKillScanReq* pReq);

typedef struct {
  int32_t scanId;
  int32_t vgId;
  int32_t dnodeId;
  int32_t numberFileset;
  int32_t finished;
  int32_t progress;
  int64_t remainingTime;
} SQueryScanProgressRsp;

int32_t tSerializeSQueryScanProgressRsp(void* buf, int32_t bufLen, SQueryScanProgressRsp* pReq);
int32_t tDeserializeSQueryScanProgressRsp(void* buf, int32_t bufLen, SQueryScanProgressRsp* pReq);

typedef struct {
  int32_t scanId;
  int32_t vgId;
  int32_t dnodeId;
} SQueryScanProgressReq;

int32_t tSerializeSQueryScanProgressReq(void* buf, int32_t bufLen, SQueryScanProgressReq* pReq);
int32_t tDeserializeSQueryScanProgressReq(void* buf, int32_t bufLen, SQueryScanProgressReq* pReq);

typedef struct {
  int64_t     dbUid;
  char        db[TSDB_DB_FNAME_LEN];
  int64_t     scanStartTime;
  STimeWindow tw;
  int32_t     scanId;
} SScanVnodeReq;

int32_t tSerializeSScanVnodeReq(void* buf, int32_t bufLen, SScanVnodeReq* pReq);
int32_t tDeserializeSScanVnodeReq(void* buf, int32_t bufLen, SScanVnodeReq* pReq);

// ============== Federated query: external source DDL messages ==============

typedef struct SCreateExtSourceReq {
  char   source_name[TSDB_EXT_SOURCE_NAME_LEN];  // external source name
  int8_t type;                                    // EExtSourceType
  char   host[TSDB_EXT_SOURCE_HOST_LEN];
  int32_t port;
  char   user[TSDB_EXT_SOURCE_USER_LEN];
  char   password[TSDB_EXT_SOURCE_PASSWORD_LEN]; // plaintext (transport only)
  char   database[TSDB_EXT_SOURCE_DATABASE_LEN]; // default database (empty = not configured)
  char   schema_name[TSDB_EXT_SOURCE_SCHEMA_LEN];// default schema (PG only; empty otherwise)
  char   options[TSDB_EXT_SOURCE_OPTIONS_LEN];   // OPTIONS JSON string
  int8_t ignoreExists;                            // IF NOT EXISTS flag
} SCreateExtSourceReq;

int32_t tSerializeSCreateExtSourceReq(void* buf, int32_t bufLen, SCreateExtSourceReq* pReq);
int32_t tDeserializeSCreateExtSourceReq(void* buf, int32_t bufLen, SCreateExtSourceReq* pReq);
void    tFreeSCreateExtSourceReq(SCreateExtSourceReq* pReq);

// alterMask bit definitions: bit0=host, bit1=port, bit2=user, bit3=password,
//                             bit4=database, bit5=schema, bit6=options
#define EXT_SOURCE_ALTER_HOST     (1 << 0)
#define EXT_SOURCE_ALTER_PORT     (1 << 1)
#define EXT_SOURCE_ALTER_USER     (1 << 2)
#define EXT_SOURCE_ALTER_PASSWORD (1 << 3)
#define EXT_SOURCE_ALTER_DATABASE (1 << 4)
#define EXT_SOURCE_ALTER_SCHEMA   (1 << 5)
#define EXT_SOURCE_ALTER_OPTIONS  (1 << 6)

typedef struct SAlterExtSourceReq {
  char    source_name[TSDB_EXT_SOURCE_NAME_LEN];
  int32_t alterMask;    // bit flags indicating which fields to update
  char    host[TSDB_EXT_SOURCE_HOST_LEN];
  int32_t port;
  char    user[TSDB_EXT_SOURCE_USER_LEN];
  char    password[TSDB_EXT_SOURCE_PASSWORD_LEN];
  char    database[TSDB_EXT_SOURCE_DATABASE_LEN];
  char    schema_name[TSDB_EXT_SOURCE_SCHEMA_LEN];
  char    options[TSDB_EXT_SOURCE_OPTIONS_LEN];
  int8_t  ignoreNotExists;  // IF EXISTS flag
} SAlterExtSourceReq;

int32_t tSerializeSAlterExtSourceReq(void* buf, int32_t bufLen, SAlterExtSourceReq* pReq);
int32_t tDeserializeSAlterExtSourceReq(void* buf, int32_t bufLen, SAlterExtSourceReq* pReq);
void    tFreeSAlterExtSourceReq(SAlterExtSourceReq* pReq);

typedef struct SDropExtSourceReq {
  char   source_name[TSDB_EXT_SOURCE_NAME_LEN];
  int8_t ignoreNotExists;  // IF EXISTS flag
} SDropExtSourceReq;

int32_t tSerializeSDropExtSourceReq(void* buf, int32_t bufLen, SDropExtSourceReq* pReq);
int32_t tDeserializeSDropExtSourceReq(void* buf, int32_t bufLen, SDropExtSourceReq* pReq);
void    tFreeSDropExtSourceReq(SDropExtSourceReq* pReq);

typedef struct SRefreshExtSourceReq {
  char source_name[TSDB_EXT_SOURCE_NAME_LEN];
} SRefreshExtSourceReq;

int32_t tSerializeSRefreshExtSourceReq(void* buf, int32_t bufLen, SRefreshExtSourceReq* pReq);
int32_t tDeserializeSRefreshExtSourceReq(void* buf, int32_t bufLen, SRefreshExtSourceReq* pReq);
void    tFreeSRefreshExtSourceReq(SRefreshExtSourceReq* pReq);

// Catalog  ->  Mnode: query a single external source (on cache miss)
typedef struct SGetExtSourceReq {
  char source_name[TSDB_EXT_SOURCE_NAME_LEN];
} SGetExtSourceReq;

int32_t tSerializeSGetExtSourceReq(void* buf, int32_t bufLen, SGetExtSourceReq* pReq);
int32_t tDeserializeSGetExtSourceReq(void* buf, int32_t bufLen, SGetExtSourceReq* pReq);
void    tFreeSGetExtSourceReq(SGetExtSourceReq* pReq);

// Mnode  ->  Catalog: external source info response (password decrypted by mnode for internal RPC)
typedef struct SGetExtSourceRsp {
  char    source_name[TSDB_EXT_SOURCE_NAME_LEN];
  int8_t  type;          // EExtSourceType
  char    host[TSDB_EXT_SOURCE_HOST_LEN];
  int32_t port;
  char    user[TSDB_EXT_SOURCE_USER_LEN];
  char    password[TSDB_EXT_SOURCE_PASSWORD_LEN];  // mnode decrypts and fills plaintext
  char    database[TSDB_EXT_SOURCE_DATABASE_LEN];
  char    schema_name[TSDB_EXT_SOURCE_SCHEMA_LEN];
  char    options[TSDB_EXT_SOURCE_OPTIONS_LEN];
  int64_t meta_version;  // incremented on every ALTER/REFRESH
  int64_t create_time;
} SGetExtSourceRsp;

int32_t tSerializeSGetExtSourceRsp(void* buf, int32_t bufLen, SGetExtSourceRsp* pRsp);
int32_t tDeserializeSGetExtSourceRsp(void* buf, int32_t bufLen, SGetExtSourceRsp* pRsp);
void    tFreeSGetExtSourceRsp(SGetExtSourceRsp* pRsp);

// Heartbeat version struct for external sources (used by HEARTBEAT_KEY_EXTSOURCE)
typedef struct SExtSourceVersion {
  char    sourceName[TSDB_EXT_SOURCE_NAME_LEN];
  int64_t metaVersion;
} SExtSourceVersion;

// Heartbeat response entry for one external source
typedef struct SExtSourceHbInfo {
  char    sourceName[TSDB_EXT_SOURCE_NAME_LEN];
  int64_t metaVersion;
  bool    deleted;
} SExtSourceHbInfo;

// Full heartbeat response payload for HEARTBEAT_KEY_EXTSOURCE
typedef struct SExtSourceHbRsp {
  int64_t  globalVer;    // monotonic version of the external-source catalog
  SArray  *pSources;     // SExtSourceHbInfo[]
} SExtSourceHbRsp;

int32_t tSerializeSExtSourceHbRsp(void *buf, int32_t bufLen, SExtSourceHbRsp *pRsp);
int32_t tDeserializeSExtSourceHbRsp(void *buf, int32_t bufLen, SExtSourceHbRsp *pRsp);
void    tFreeSExtSourceHbRsp(SExtSourceHbRsp *pRsp);

// SQueryTableRsp.extErrMsg / extPushdownDiag: federated query diagnostics payload.
// Both are appended optional fields at the end of SQueryTableRsp.
// See SQueryTableRsp definition above; tSerializeSQueryTableRsp / tDeserializeSQueryTableRsp
// encode/decode both fields with dedicated has-* flags after all existing fields.

// SExtTableMetaReq  -  identifies an external table to be resolved by catalog.
// Parser registers one per external table reference during collectMetaKey.
// sourceName matches the ext source name; rawMidSegs holds 0-2 intermediate
// path segments (db / schema) whose interpretation depends on source type;
// tableName is the leaf table name. The number of active segments is inferred
// from whether rawMidSegs[0] and rawMidSegs[1] are non-empty.
typedef struct SExtTableMetaReq {
  char   sourceName[TSDB_EXT_SOURCE_NAME_LEN];
  char   rawMidSegs[2][TSDB_DB_NAME_LEN];
  char   tableName[TSDB_TABLE_NAME_LEN];
} SExtTableMetaReq;

// ============== end of federated query messages ==============

#ifdef __cplusplus
}
#endif

#endif /*_TD_COMMON_TAOS_MSG_H_*/

Coverage Report

Created: 2026-10-22 06:46

Line	Count	Source
1		/*
2		* Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
3		*
4		* SPDX-License-Identifier: AGPL-3.0-or-later
5		*
6		* This program is free software: you can use, redistribute, and/or modify
7		* it under the terms of the GNU Affero General Public License, version 3
8		* or later ("AGPL"), as published by the Free Software Foundation.
9		*
10		* This program is distributed in the hope that it will be useful, but WITHOUT
11		* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12		* FITNESS FOR A PARTICULAR PURPOSE.
13		*
14		* You should have received a copy of the GNU Affero General Public License
15		* along with this program. If not, see <http://www.gnu.org/licenses/>.
16		*/
17
18		#ifndef _TD_COMMON_TAOS_MSG_H_
19		#define _TD_COMMON_TAOS_MSG_H_
20
21		#include <stdint.h>
22		#include "taosdef.h"
23		#include "taoserror.h"
24		#include "tarray.h"
25		#include "tcoding.h"
26		#include "tcol.h"
27		#include "tencode.h"
28		#include "thash.h"
29		#include "tlist.h"
30		#include "tname.h"
31		#include "tpriv.h"
32		#include "trow.h"
33		#include "tsimplehash.h"
34		#include "tuuid.h"
35
36		// Forward declaration - full definition in libs/nodes/nodes.h
37		typedef struct SNode SNode;
38
39		#ifdef __cplusplus