ctdb/include/ctdb_client.h

   1 /*
   2    ctdb database library: old client interface
   3
   4    Copyright (C) Andrew Tridgell  2006
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef _CTDB_CLIENT_H
  21 #define _CTDB_CLIENT_H
  22
  23 #include "common/srvid.h"
  24 #include "ctdb_protocol.h"
  25
  26 enum control_state {
  27         CTDB_CONTROL_WAIT,
  28         CTDB_CONTROL_DONE,
  29         CTDB_CONTROL_ERROR,
  30         CTDB_CONTROL_TIMEOUT
  31 };
  32
  33 struct ctdb_client_control_state {
  34         struct ctdb_context *ctdb;
  35         uint32_t reqid;
  36         int32_t status;
  37         TDB_DATA outdata;
  38         enum control_state state;
  39         char *errormsg;
  40         struct ctdb_req_control_old *c;
  41
  42         /* if we have a callback registered for the completion (or failure) of
  43            this control
  44            if a callback is used, it MUST talloc_free the cb_data passed to it
  45         */
  46         struct {
  47                 void (*fn)(struct ctdb_client_control_state *);
  48                 void *private_data;
  49         } async;
  50 };
  51
  52 struct tevent_context;
  53 struct ctdb_db_context;
  54
  55 /*
  56   allocate a packet for use in client<->daemon communication
  57  */
  58 struct ctdb_req_header *_ctdbd_allocate_pkt(struct ctdb_context *ctdb,
  59                                             TALLOC_CTX *mem_ctx,
  60                                             enum ctdb_operation operation,
  61                                             size_t length, size_t slength,
  62                                             const char *type);
  63
  64 #define ctdbd_allocate_pkt(ctdb, mem_ctx, operation, length, type) \
  65         (type *)_ctdbd_allocate_pkt(ctdb, mem_ctx, operation, length, \
  66                                     sizeof(type), #type)
  67
  68 int ctdb_call_local(struct ctdb_db_context *ctdb_db, struct ctdb_call *call,
  69                     struct ctdb_ltdb_header *header, TALLOC_CTX *mem_ctx,
  70                     TDB_DATA *data, bool updatetdb);
  71
  72 void ctdb_request_message(struct ctdb_context *ctdb,
  73                           struct ctdb_req_header *hdr);
  74
  75 void ctdb_client_read_cb(uint8_t *data, size_t cnt, void *args);
  76
  77 int ctdb_socket_connect(struct ctdb_context *ctdb);
  78
  79 /*
  80   make a ctdb call. The associated ctdb call function will be called on the DMASTER
  81   for the given record
  82 */
  83 struct ctdb_client_call_state *ctdb_call_send(struct ctdb_db_context *ctdb_db,
  84                                               struct ctdb_call *call);
  85 int ctdb_call_recv(struct ctdb_client_call_state *state,
  86                    struct ctdb_call *call);
  87 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
  88
  89 /* setup a handler for ctdb messages */
  90 typedef void (*ctdb_msg_fn_t)(struct ctdb_context *, uint64_t srvid,
  91                               TDB_DATA data, void *);
  92
  93 int ctdb_client_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid,
  94                                     srvid_handler_fn handler,
  95                                     void *private_data);
  96 int ctdb_client_remove_message_handler(struct ctdb_context *ctdb,
  97                                        uint64_t srvid, void *private_data);
  98
  99 /* send a ctdb message */
 100 int ctdb_client_send_message(struct ctdb_context *ctdb, uint32_t pnn,
 101                              uint64_t srvid, TDB_DATA data);
 102
 103 struct ctdb_client_control_state *ctdb_control_send(struct ctdb_context *ctdb,
 104                                                     uint32_t destnode,
 105                                                     uint64_t srvid,
 106                                                     uint32_t opcode,
 107                                                     uint32_t flags,
 108                                                     TDB_DATA data,
 109                                                     TALLOC_CTX *mem_ctx,
 110                                                     struct timeval *timeout,
 111                                                     char **errormsg);
 112 int ctdb_control_recv(struct ctdb_context *ctdb,
 113                       struct ctdb_client_control_state *state,
 114                       TALLOC_CTX *mem_ctx, TDB_DATA *outdata,
 115                       int32_t *status, char **errormsg);
 116 int ctdb_control(struct ctdb_context *ctdb, uint32_t destnode, uint64_t srvid,
 117                  uint32_t opcode, uint32_t flags, TDB_DATA data,
 118                  TALLOC_CTX *mem_ctx, TDB_DATA *outdata, int32_t *status,
 119                  struct timeval *timeout, char **errormsg);
 120
 121 int ctdb_ctrl_getvnnmap(struct ctdb_context *ctdb, struct timeval timeout,
 122                         uint32_t destnode, TALLOC_CTX *mem_ctx,
 123                         struct ctdb_vnn_map **vnnmap);
 124
 125 /*
 126   get the recovery mode of a remote node
 127  */
 128 struct ctdb_client_control_state *ctdb_ctrl_getrecmode_send(
 129                                         struct ctdb_context *ctdb,
 130                                         TALLOC_CTX *mem_ctx,
 131                                         struct timeval timeout,
 132                                         uint32_t destnode);
 133 int ctdb_ctrl_getrecmode_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
 134                               struct ctdb_client_control_state *state,
 135                               uint32_t *recmode);
 136 int ctdb_ctrl_getrecmode(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
 137                          struct timeval timeout, uint32_t destnode,
 138                          uint32_t *recmode);
 139
 140 /*
 141   set the recovery mode of a remote node
 142  */
 143 int ctdb_ctrl_setrecmode(struct ctdb_context *ctdb, struct timeval timeout,
 144                          uint32_t destnode, uint32_t recmode);
 145
 146 /*
 147   get the recovery master of a remote node
 148  */
 149 struct ctdb_client_control_state *ctdb_ctrl_getrecmaster_send(
 150                                         struct ctdb_context *ctdb,
 151                                         TALLOC_CTX *mem_ctx,
 152                                         struct timeval timeout,
 153                                         uint32_t destnode);
 154 int ctdb_ctrl_getrecmaster_recv(struct ctdb_context *ctdb,
 155                                 TALLOC_CTX *mem_ctx,
 156                                 struct ctdb_client_control_state *state,
 157                                 uint32_t *recmaster);
 158 int ctdb_ctrl_getrecmaster(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
 159                            struct timeval timeout, uint32_t destnode,
 160                            uint32_t *recmaster);
 161
 162 /*
 163   set the recovery master of a remote node
 164  */
 165 int ctdb_ctrl_setrecmaster(struct ctdb_context *ctdb, struct timeval timeout,
 166                            uint32_t destnode, uint32_t recmaster);
 167
 168 int ctdb_ctrl_getnodemap(struct ctdb_context *ctdb, struct timeval timeout,
 169                          uint32_t destnode, TALLOC_CTX *mem_ctx,
 170                          struct ctdb_node_map_old **nodemap);
 171
 172 int ctdb_ctrl_get_runstate(struct ctdb_context *ctdb, struct timeval timeout,
 173                            uint32_t destnode, uint32_t *runstate);
 174
 175 int ctdb_ctrl_get_debuglevel(struct ctdb_context *ctdb, uint32_t destnode,
 176                              int32_t *level);
 177
 178 int ctdb_ctrl_freeze(struct ctdb_context *ctdb, struct timeval timeout,
 179                      uint32_t destnode);
 180
 181 int ctdb_ctrl_getpnn(struct ctdb_context *ctdb, struct timeval timeout,
 182                      uint32_t destnode);
 183
 184 int ctdb_ctrl_get_public_ips_flags(struct ctdb_context *ctdb,
 185                                    struct timeval timeout, uint32_t destnode,
 186                                    TALLOC_CTX *mem_ctx, uint32_t flags,
 187                                    struct ctdb_public_ip_list_old **ips);
 188 int ctdb_ctrl_get_public_ips(struct ctdb_context *ctdb,
 189                              struct timeval timeout, uint32_t destnode,
 190                              TALLOC_CTX *mem_ctx,
 191                              struct ctdb_public_ip_list_old **ips);
 192
 193 int ctdb_ctrl_get_ifaces(struct ctdb_context *ctdb,
 194                          struct timeval timeout, uint32_t destnode,
 195                          TALLOC_CTX *mem_ctx,
 196                          struct ctdb_iface_list_old **ifaces);
 197
 198 int ctdb_ctrl_get_all_tunables(struct ctdb_context *ctdb,
 199                                struct timeval timeout, uint32_t destnode,
 200                                struct ctdb_tunable_list *tunables);
 201
 202 /*
 203   set some flags
 204 */
 205 void ctdb_set_flags(struct ctdb_context *ctdb, unsigned flags);
 206
 207 const char *ctdb_get_socketname(struct ctdb_context *ctdb);
 208
 209 /* return pnn of this node */
 210 uint32_t ctdb_get_pnn(struct ctdb_context *ctdb);
 211
 212 typedef void (*client_async_callback)(struct ctdb_context *ctdb,
 213                                       uint32_t node_pnn, int32_t res,
 214                                       TDB_DATA outdata, void *callback_data);
 215
 216 struct client_async_data {
 217         enum ctdb_controls opcode;
 218         bool dont_log_errors;
 219         uint32_t count;
 220         uint32_t fail_count;
 221         client_async_callback callback;
 222         client_async_callback fail_callback;
 223         void *callback_data;
 224 };
 225
 226 void ctdb_client_async_add(struct client_async_data *data,
 227                            struct ctdb_client_control_state *state);
 228 int ctdb_client_async_wait(struct ctdb_context *ctdb,
 229                            struct client_async_data *data);
 230 int ctdb_client_async_control(struct ctdb_context *ctdb,
 231                               enum ctdb_controls opcode, uint32_t *nodes,
 232                               uint64_t srvid, struct timeval timeout,
 233                               bool dont_log_errors, TDB_DATA data,
 234                               client_async_callback client_callback,
 235                               client_async_callback fail_callback,
 236                               void *callback_data);
 237
 238 uint32_t *list_of_vnnmap_nodes(struct ctdb_context *ctdb,
 239                                struct ctdb_vnn_map *vnn_map,
 240                                TALLOC_CTX *mem_ctx, bool include_self);
 241
 242 uint32_t *list_of_active_nodes(struct ctdb_context *ctdb,
 243                                struct ctdb_node_map_old *node_map,
 244                                TALLOC_CTX *mem_ctx, bool include_self);
 245 uint32_t *list_of_connected_nodes(struct ctdb_context *ctdb,
 246                                   struct ctdb_node_map_old *node_map,
 247                                   TALLOC_CTX *mem_ctx, bool include_self);
 248
 249 /*
 250   get capabilities of a remote node
 251  */
 252
 253 struct ctdb_client_control_state *ctdb_ctrl_getcapabilities_send(
 254                                         struct ctdb_context *ctdb,
 255                                         TALLOC_CTX *mem_ctx,
 256                                         struct timeval timeout,
 257                                         uint32_t destnode);
 258 int ctdb_ctrl_getcapabilities_recv(struct ctdb_context *ctdb,
 259                                    TALLOC_CTX *mem_ctx,
 260                                    struct ctdb_client_control_state *state,
 261                                    uint32_t *capabilities);
 262 int ctdb_ctrl_getcapabilities(struct ctdb_context *ctdb,
 263                               struct timeval timeout, uint32_t destnode,
 264                               uint32_t *capabilities);
 265
 266 struct ctdb_node_capabilities {
 267         bool retrieved;
 268         uint32_t capabilities;
 269 };
 270
 271 /* Retrieve capabilities for all connected nodes.  The length of the
 272  * returned array can be calculated using talloc_array_length(). */
 273 struct ctdb_node_capabilities *ctdb_get_capabilities(
 274                                         struct ctdb_context *ctdb,
 275                                         TALLOC_CTX *mem_ctx,
 276                                         struct timeval timeout,
 277                                         struct ctdb_node_map_old *nodemap);
 278
 279 /* Get capabilities for specified node, NULL if not found */
 280 uint32_t *ctdb_get_node_capabilities(struct ctdb_node_capabilities *caps,
 281                                      uint32_t pnn);
 282
 283 /* True if the given node has all of the required capabilities */
 284 bool ctdb_node_has_capabilities(struct ctdb_node_capabilities *caps,
 285                                 uint32_t pnn, uint32_t capabilities_required);
 286
 287 int ctdb_ctrl_recd_ping(struct ctdb_context *ctdb);
 288
 289 int ctdb_ctrl_report_recd_lock_latency(struct ctdb_context *ctdb,
 290                                        struct timeval timeout, double latency);
 291
 292 int ctdb_ctrl_set_ban(struct ctdb_context *ctdb, struct timeval timeout,
 293                       uint32_t destnode, struct ctdb_ban_state *bantime);
 294
 295 struct ctdb_client_control_state *ctdb_ctrl_updaterecord_send(
 296                                         struct ctdb_context *ctdb,
 297                                         TALLOC_CTX *mem_ctx,
 298                                         struct timeval timeout,
 299                                         uint32_t destnode,
 300                                         struct ctdb_db_context *ctdb_db,
 301                                         TDB_DATA key,
 302                                         struct ctdb_ltdb_header *header,
 303                                         TDB_DATA data);
 304 int ctdb_ctrl_updaterecord_recv(struct ctdb_context *ctdb,
 305                                 struct ctdb_client_control_state *state);
 306 int ctdb_ctrl_updaterecord(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
 307                            struct timeval timeout, uint32_t destnode,
 308                            struct ctdb_db_context *ctdb_db, TDB_DATA key,
 309                            struct ctdb_ltdb_header *header, TDB_DATA data);
 310
 311 #endif /* _CTDB_CLIENT_H */