homework-jianmu/include/dnode/mnode/mnode.h

/*
 * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
 *
 * This program is free software: you can use, redistribute, and/or modify
 * it under the terms of the GNU Affero General Public License, version 3
 * or later ("AGPL"), as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _TD_MND_H_
#define _TD_MND_H_

#ifdef __cplusplus
extern "C" {
#endif

/* ------------------------ TYPES EXPOSED ------------------------ */
typedef struct SDnode    SDnode;
typedef struct SMnode    SMnode;
typedef struct SMnodeMsg SMnodeMsg;
typedef void (*SendMsgToDnodeFp)(SDnode *pDnode, struct SEpSet *epSet, struct SRpcMsg *rpcMsg);
typedef void (*SendMsgToMnodeFp)(SDnode *pDnode, struct SRpcMsg *rpcMsg);
typedef void (*SendRedirectMsgFp)(SDnode *pDnode, struct SRpcMsg *rpcMsg);
typedef int32_t (*PutMsgToMnodeQFp)(SDnode *pDnode, SMnodeMsg *pMsg);

typedef struct SMnodeLoad {
  /**
   * @brief the number of dnodes in cluster.
   *
   */
  int64_t numOfDnode;

  /**
   * @brief the number of mnodes in cluster.
   *
   */
  int64_t numOfMnode;

  /**
   * @brief the number of vgroups in cluster.
   *
   */
  int64_t numOfVgroup;

  /**
   * @brief the number of databases in cluster.
   *
   */
  int64_t numOfDatabase;

  /**
   * @brief the number of super tables in cluster.
   *
   */
  int64_t numOfSuperTable;

  /**
   * @brief the number of child tables in cluster.
   *
   */
  int64_t numOfChildTable;

  /**
   * @brief the number of normal tables in cluster.
   *
   */
  int64_t numOfNormalTable;

  /**
   * @brief the number of numOfTimeseries in cluster.
   *
   */
  int64_t numOfColumn;

  /**
   * @brief total points written in cluster.
   *
   */
  int64_t totalPoints;

  /**
   * @brief total storage in cluster.
   *
   */
  int64_t totalStorage;

  /**
   * @brief total compressed storage in cluster.
   *
   */
  int64_t compStorage;
} SMnodeLoad;

typedef struct {
  /**
   * @brief dnodeId of this mnode.
   *
   */
  int32_t dnodeId;

  /**
   * @brief clusterId of this mnode.
   *
   */
  int64_t clusterId;

  /**
   * @brief replica num of this mnode.
   *
   */
  int8_t replica;

  /**
   * @brief self index in the array of replicas.
   *
   */
  int8_t selfIndex;

  /**
   * @brief detail replica information of this mnode.
   *
   */
  SReplica replicas[TSDB_MAX_REPLICA];

  /**
   * @brief the parent dnode of this mnode.
   *
   */
  SDnode *pDnode;

  /**
   * @brief put apply msg to the write queue in dnode.
   *
   */
  PutMsgToMnodeQFp putMsgToApplyMsgFp;

  /**
   * @brief the callback function while send msg to dnode.
   *
   */
  SendMsgToDnodeFp sendMsgToDnodeFp;

  /**
   * @brief the callback function while send msg to mnode.
   *
   */
  SendMsgToMnodeFp sendMsgToMnodeFp;

  /**
   * @brief the callback function while send redirect msg to clients or peers.
   *
   */
  SendRedirectMsgFp sendRedirectMsgFp;
} SMnodeOpt;

/* ------------------------ SMnode ------------------------ */
/**
 * @brief Open a mnode.
 *
 * @param path Path of the mnode.
 * @param pOption Option of the mnode.
 * @return SMnode* The mnode object.
 */
SMnode *mndOpen(const char *path, const SMnodeOpt *pOption);

/**
 * @brief Close a mnode.
 *
 * @param pMnode The mnode object to close.
 */
void mndClose(SMnode *pMnode);

/**
 * @brief Close a mnode.
 *
 * @param pMnode The mnode object to close.
 * @param pOption Options of the mnode.
 * @return int32_t 0 for success, -1 for failure.
 */
int32_t mndAlter(SMnode *pMnode, const SMnodeOpt *pOption);

/**
 * @brief Drop a mnode.
 *
 * @param path Path of the mnode.
 */
void mndDestroy(const char *path);

/**
 * @brief Get mnode statistics info.
 *
 * @param pMnode The mnode object.
 * @param pLoad Statistics of the mnode.
 * @return int32_t 0 for success, -1 for failure.
 */
int32_t mndGetLoad(SMnode *pMnode, SMnodeLoad *pLoad);

/**
 * @brief Get user authentication info.
 *
 * @param pMnode The mnode object.
 * @param user
 * @param spi
 * @param encrypt
 * @param secret
 * @param ckey
 * @return int32_t 0 for success, -1 for failure.
 */
int32_t mndRetriveAuth(SMnode *pMnode, char *user, char *spi, char *encrypt, char *secret, char *ckey);

/**
 * @brief Initialize mnode msg.
 *
 * @param pMnode The mnode object.
 * @param pMsg The request rpc msg.
 * @return int32_t The created mnode msg.
 */
SMnodeMsg *mndInitMsg(SMnode *pMnode, SRpcMsg *pRpcMsg);

/**
 * @brief Cleanup mnode msg.
 *
 * @param pMsg The request msg.
 */
void mndCleanupMsg(SMnodeMsg *pMsg);

/**
 * @brief Cleanup mnode msg.
 *
 * @param pMsg The request msg.
 * @param code The error code.
 */
void mndSendRsp(SMnodeMsg *pMsg, int32_t code);

/**
 * @brief Process the read request.
 *
 * @param pMsg The request msg.
 * @return int32_t 0 for success, -1 for failure.
 */
void mndProcessReadMsg(SMnodeMsg *pMsg);

/**
 * @brief Process the write request.
 *
 * @param pMsg The request msg.
 * @return int32_t 0 for success, -1 for failure.
 */
void mndProcessWriteMsg(SMnodeMsg *pMsg);

/**
 * @brief Process the sync request.
 *
 * @param pMsg The request msg.
 * @return int32_t 0 for success, -1 for failure.
 */
void mndProcessSyncMsg(SMnodeMsg *pMsg);

/**
 * @brief Process the apply request.
 *
 * @param pMsg The request msg.
 * @return int32_t 0 for success, -1 for failure.
 */
void mndProcessApplyMsg(SMnodeMsg *pMsg);

#ifdef __cplusplus
}
#endif

#endif /*_TD_MND_H_*/