include/ctdb.h

   1 /*
   2    ctdb database library
   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_H
  21 #define _CTDB_H
  22
  23 #define CTDB_IMMEDIATE_MIGRATION        0x00000001
  24 struct ctdb_call {
  25         int call_id;
  26         TDB_DATA key;
  27         TDB_DATA call_data;
  28         TDB_DATA reply_data;
  29         uint32_t status;
  30         uint32_t flags;
  31 };
  32
  33 /*
  34   structure passed to a ctdb call backend function
  35 */
  36 struct ctdb_call_info {
  37         TDB_DATA key;          /* record key */
  38         TDB_DATA record_data;  /* current data in the record */
  39         TDB_DATA *new_data;    /* optionally updated record data */
  40         TDB_DATA *call_data;   /* optionally passed from caller */
  41         TDB_DATA *reply_data;  /* optionally returned by function */
  42         uint32_t status;       /* optional reply status - defaults to zero */
  43 };
  44
  45 #define CTDB_ERR_INVALID 1
  46 #define CTDB_ERR_NOMEM 2
  47
  48 /*
  49   ctdb flags
  50 */
  51 #define CTDB_FLAG_TORTURE      (1<<1)
  52
  53 /*
  54    a message handler ID meaning "give me all messages"
  55  */
  56 #define CTDB_SRVID_ALL (~(uint64_t)0)
  57
  58 /*
  59   srvid type : RECOVERY
  60 */
  61 #define CTDB_SRVID_RECOVERY     0xF100000000000000LL
  62
  63 /*
  64    a message handler ID meaning that the cluster has been reconfigured
  65  */
  66 #define CTDB_SRVID_RECONFIGURE 0xF200000000000000LL
  67
  68 /*
  69    a message handler ID meaning that an IP address has been released
  70  */
  71 #define CTDB_SRVID_RELEASE_IP 0xF300000000000000LL
  72
  73 /*
  74    a message ID meaning that a nodes flags have changed
  75  */
  76 #define CTDB_SRVID_NODE_FLAGS_CHANGED 0xF400000000000000LL
  77
  78 /*
  79    a message ID meaning that a node should be banned
  80  */
  81 #define CTDB_SRVID_BAN_NODE 0xF500000000000000LL
  82
  83 /*
  84    a message ID meaning that a node should be unbanned
  85  */
  86 #define CTDB_SRVID_UNBAN_NODE 0xF600000000000000LL
  87
  88
  89 /* used on the domain socket, send a pdu to the local daemon */
  90 #define CTDB_CURRENT_NODE     0xF0000001
  91 /* send a broadcast to all nodes in the cluster, active or not */
  92 #define CTDB_BROADCAST_ALL    0xF0000002
  93 /* send a broadcast to all nodes in the current vnn map */
  94 #define CTDB_BROADCAST_VNNMAP 0xF0000003
  95 /* send a broadcast to all connected nodes */
  96 #define CTDB_BROADCAST_CONNECTED 0xF0000004
  97
  98
  99 enum control_state {CTDB_CONTROL_WAIT, CTDB_CONTROL_DONE, CTDB_CONTROL_ERROR, CTDB_CONTROL_TIMEOUT};
 100
 101 struct ctdb_client_control_state {
 102         struct ctdb_context *ctdb;
 103         uint32_t reqid;
 104         int32_t status;
 105         TDB_DATA outdata;
 106         enum control_state state;
 107         char *errormsg;
 108         struct ctdb_req_control *c;
 109
 110         /* if we have a callback registered for the completion (or failure) of
 111            this control
 112            if a callback is used, it MUST talloc_free the cb_data passed to it
 113         */
 114         struct {
 115                 void (*fn)(struct ctdb_client_control_state *);
 116                 void *private;
 117         } async;
 118 };
 119
 120
 121 struct event_context;
 122
 123 /*
 124   initialise ctdb subsystem
 125 */
 126 struct ctdb_context *ctdb_init(struct event_context *ev);
 127
 128 /*
 129   choose the transport
 130 */
 131 int ctdb_set_transport(struct ctdb_context *ctdb, const char *transport);
 132
 133 /*
 134   set the directory for the local databases
 135 */
 136 int ctdb_set_tdb_dir(struct ctdb_context *ctdb, const char *dir);
 137 int ctdb_set_tdb_dir_persistent(struct ctdb_context *ctdb, const char *dir);
 138
 139 /*
 140   set some flags
 141 */
 142 void ctdb_set_flags(struct ctdb_context *ctdb, unsigned flags);
 143
 144 /*
 145   set max acess count before a dmaster migration
 146 */
 147 void ctdb_set_max_lacount(struct ctdb_context *ctdb, unsigned count);
 148
 149 /*
 150   tell ctdb what address to listen on, in transport specific format
 151 */
 152 int ctdb_set_address(struct ctdb_context *ctdb, const char *address);
 153
 154 int ctdb_set_socketname(struct ctdb_context *ctdb, const char *socketname);
 155
 156 /*
 157   tell ctdb what nodes are available. This takes a filename, which will contain
 158   1 node address per line, in a transport specific format
 159 */
 160 int ctdb_set_nlist(struct ctdb_context *ctdb, const char *nlist);
 161
 162 /*
 163   start the ctdb protocol
 164 */
 165 int ctdb_start(struct ctdb_context *ctdb);
 166 int ctdb_start_daemon(struct ctdb_context *ctdb, bool do_fork);
 167
 168 /*
 169   attach to a ctdb database
 170 */
 171 struct ctdb_db_context *ctdb_attach(struct ctdb_context *ctdb, const char *name, bool persistent);
 172
 173 /*
 174   find an attached ctdb_db handle given a name
 175  */
 176 struct ctdb_db_context *ctdb_db_handle(struct ctdb_context *ctdb, const char *name);
 177
 178 /*
 179   error string for last ctdb error
 180 */
 181 const char *ctdb_errstr(struct ctdb_context *);
 182
 183 /* a ctdb call function */
 184 typedef int (*ctdb_fn_t)(struct ctdb_call_info *);
 185
 186 /*
 187   setup a ctdb call function
 188 */
 189 int ctdb_set_call(struct ctdb_db_context *ctdb_db, ctdb_fn_t fn, uint32_t id);
 190
 191
 192
 193 /*
 194   make a ctdb call. The associated ctdb call function will be called on the DMASTER
 195   for the given record
 196 */
 197 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
 198
 199 /*
 200   initiate an ordered ctdb cluster shutdown
 201   this function will never return
 202 */
 203 void ctdb_shutdown(struct ctdb_context *ctdb);
 204
 205 /* return pnn of this node */
 206 uint32_t ctdb_get_pnn(struct ctdb_context *ctdb);
 207
 208 /*
 209   return the number of nodes
 210 */
 211 uint32_t ctdb_get_num_nodes(struct ctdb_context *ctdb);
 212
 213 /* setup a handler for ctdb messages */
 214 typedef void (*ctdb_message_fn_t)(struct ctdb_context *, uint64_t srvid,
 215                                   TDB_DATA data, void *);
 216 int ctdb_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid,
 217                              ctdb_message_fn_t handler,
 218                              void *private_data);
 219
 220
 221 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
 222 struct ctdb_client_call_state *ctdb_call_send(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
 223 int ctdb_call_recv(struct ctdb_client_call_state *state, struct ctdb_call *call);
 224
 225 /* send a ctdb message */
 226 int ctdb_send_message(struct ctdb_context *ctdb, uint32_t pnn,
 227                       uint64_t srvid, TDB_DATA data);
 228
 229
 230 /*
 231    Fetch a ctdb record from a remote node
 232  . Underneath this will force the
 233    dmaster for the record to be moved to the local node.
 234 */
 235 struct ctdb_record_handle *ctdb_fetch_lock(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
 236                                            TDB_DATA key, TDB_DATA *data);
 237
 238 int ctdb_record_store(struct ctdb_record_handle *h, TDB_DATA data);
 239
 240 int ctdb_fetch(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
 241                TDB_DATA key, TDB_DATA *data);
 242
 243 int ctdb_register_message_handler(struct ctdb_context *ctdb,
 244                                   TALLOC_CTX *mem_ctx,
 245                                   uint64_t srvid,
 246                                   ctdb_message_fn_t handler,
 247                                   void *private_data);
 248
 249 struct ctdb_db_context *find_ctdb_db(struct ctdb_context *ctdb, uint32_t id);
 250
 251
 252 struct ctdb_context *ctdb_cmdline_client(struct event_context *ev);
 253
 254 struct ctdb_statistics;
 255 int ctdb_ctrl_statistics(struct ctdb_context *ctdb, uint32_t destnode, struct ctdb_statistics *status);
 256
 257 int ctdb_ctrl_shutdown(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
 258
 259 struct ctdb_vnn_map;
 260 int ctdb_ctrl_getvnnmap(struct ctdb_context *ctdb,
 261                 struct timeval timeout, uint32_t destnode,
 262                 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map **vnnmap);
 263 int ctdb_ctrl_setvnnmap(struct ctdb_context *ctdb,
 264                 struct timeval timeout, uint32_t destnode,
 265                 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map *vnnmap);
 266
 267 /* table that contains a list of all dbids on a node
 268  */
 269 struct ctdb_dbid_map {
 270         uint32_t num;
 271         struct ctdb_dbid {
 272                 uint32_t dbid;
 273                 bool persistent;
 274         } dbs[1];
 275 };
 276 int ctdb_ctrl_getdbmap(struct ctdb_context *ctdb,
 277         struct timeval timeout, uint32_t destnode,
 278         TALLOC_CTX *mem_ctx, struct ctdb_dbid_map **dbmap);
 279
 280
 281 struct ctdb_node_map;
 282
 283 int ctdb_ctrl_getnodemap(struct ctdb_context *ctdb,
 284                     struct timeval timeout, uint32_t destnode,
 285                     TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
 286
 287 struct ctdb_key_list {
 288         uint32_t dbid;
 289         uint32_t num;
 290         TDB_DATA *keys;
 291         struct ctdb_ltdb_header *headers;
 292         TDB_DATA *data;
 293 };
 294 int ctdb_ctrl_pulldb(struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid, uint32_t lmaster, TALLOC_CTX *mem_ctx, struct ctdb_key_list *keys);
 295 int ctdb_ctrl_copydb(struct ctdb_context *ctdb,
 296         struct timeval timeout, uint32_t sourcenode,
 297         uint32_t destnode, uint32_t dbid, uint32_t lmaster,
 298         TALLOC_CTX *mem_ctx);
 299
 300 int ctdb_ctrl_getdbpath(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **path);
 301 int ctdb_ctrl_getdbname(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **name);
 302 int ctdb_ctrl_createdb(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, const char *name, bool persistent);
 303
 304 int ctdb_ctrl_process_exists(struct ctdb_context *ctdb, uint32_t destnode, pid_t pid);
 305
 306 int ctdb_ctrl_ping(struct ctdb_context *ctdb, uint32_t destnode);
 307
 308 int ctdb_ctrl_get_config(struct ctdb_context *ctdb);
 309
 310 int ctdb_ctrl_get_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, uint32_t *level);
 311 int ctdb_ctrl_set_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, uint32_t level);
 312
 313 /*
 314   change dmaster for all keys in the database to the new value
 315  */
 316 int ctdb_ctrl_setdmaster(struct ctdb_context *ctdb,
 317         struct timeval timeout, uint32_t destnode,
 318         TALLOC_CTX *mem_ctx, uint32_t dbid, uint32_t dmaster);
 319
 320 /*
 321   write a record on a specific db (this implicitely updates dmaster of the record to locally be the vnn of the node where the control is executed on)
 322  */
 323 int ctdb_ctrl_write_record(struct ctdb_context *ctdb, uint32_t destnode, TALLOC_CTX *mem_ctx, uint32_t dbid, TDB_DATA key, TDB_DATA data);
 324
 325 #define CTDB_RECOVERY_NORMAL            0
 326 #define CTDB_RECOVERY_ACTIVE            1
 327
 328 /*
 329   get the recovery mode of a remote node
 330  */
 331 int ctdb_ctrl_getrecmode(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmode);
 332
 333 struct ctdb_client_control_state *ctdb_ctrl_getrecmode_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
 334
 335 int ctdb_ctrl_getrecmode_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmode);
 336
 337
 338 /*
 339   set the recovery mode of a remote node
 340  */
 341 int ctdb_ctrl_setrecmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmode);
 342 /*
 343   get the monitoring mode of a remote node
 344  */
 345 int ctdb_ctrl_getmonmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *monmode);
 346 /*
 347   set the monitoringmode of a remote node
 348  */
 349 int ctdb_ctrl_setmonmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t monmode);
 350
 351 /*
 352   get the recovery master of a remote node
 353  */
 354 int ctdb_ctrl_getrecmaster(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmaster);
 355
 356 struct ctdb_client_control_state *ctdb_ctrl_getrecmaster_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
 357
 358 int ctdb_ctrl_getrecmaster_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmaster);
 359
 360
 361
 362 /*
 363   set the recovery master of a remote node
 364  */
 365 int ctdb_ctrl_setrecmaster(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmaster);
 366
 367 uint32_t *ctdb_get_connected_nodes(struct ctdb_context *ctdb,
 368                                    struct timeval timeout,
 369                                    TALLOC_CTX *mem_ctx,
 370                                    uint32_t *num_nodes);
 371
 372 int ctdb_statistics_reset(struct ctdb_context *ctdb, uint32_t destnode);
 373
 374 int ctdb_set_logfile(struct ctdb_context *ctdb, const char *logfile);
 375
 376 typedef int (*ctdb_traverse_func)(struct ctdb_context *, TDB_DATA, TDB_DATA, void *);
 377 int ctdb_traverse(struct ctdb_db_context *ctdb_db, ctdb_traverse_func fn, void *private_data);
 378
 379 int ctdb_dump_db(struct ctdb_db_context *ctdb_db, FILE *f);
 380
 381 /*
 382   get the pid of a ctdb daemon
 383  */
 384 int ctdb_ctrl_getpid(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *pid);
 385
 386 int ctdb_ctrl_freeze(struct ctdb_context *ctdb, struct timeval timeout,
 387                         uint32_t destnode);
 388
 389 struct ctdb_client_control_state *
 390 ctdb_ctrl_freeze_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
 391                         struct timeval timeout, uint32_t destnode);
 392
 393 int ctdb_ctrl_freeze_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
 394                         struct ctdb_client_control_state *state);
 395
 396 int ctdb_ctrl_thaw(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
 397
 398 int ctdb_ctrl_getpnn(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
 399
 400 int ctdb_ctrl_get_tunable(struct ctdb_context *ctdb,
 401                           struct timeval timeout,
 402                           uint32_t destnode,
 403                           const char *name, uint32_t *value);
 404
 405 int ctdb_ctrl_set_tunable(struct ctdb_context *ctdb,
 406                           struct timeval timeout,
 407                           uint32_t destnode,
 408                           const char *name, uint32_t value);
 409
 410 int ctdb_ctrl_list_tunables(struct ctdb_context *ctdb,
 411                             struct timeval timeout,
 412                             uint32_t destnode,
 413                             TALLOC_CTX *mem_ctx,
 414                             const char ***list, uint32_t *count);
 415
 416 int ctdb_ctrl_modflags(struct ctdb_context *ctdb,
 417                        struct timeval timeout,
 418                        uint32_t destnode,
 419                        uint32_t set, uint32_t clear);
 420
 421 enum ctdb_server_id_type { SERVER_TYPE_SAMBA=1 };
 422
 423 struct ctdb_server_id {
 424         enum ctdb_server_id_type type;
 425         uint32_t pnn;
 426         uint32_t server_id;
 427 };
 428
 429 struct ctdb_server_id_list {
 430         uint32_t num;
 431         struct ctdb_server_id server_ids[1];
 432 };
 433
 434
 435 int ctdb_ctrl_register_server_id(struct ctdb_context *ctdb,
 436                 struct timeval timeout,
 437                 struct ctdb_server_id *id);
 438 int ctdb_ctrl_unregister_server_id(struct ctdb_context *ctdb,
 439                 struct timeval timeout,
 440                 struct ctdb_server_id *id);
 441 int ctdb_ctrl_check_server_id(struct ctdb_context *ctdb,
 442                 struct timeval timeout, uint32_t destnode,
 443                 struct ctdb_server_id *id, uint32_t *status);
 444 int ctdb_ctrl_get_server_id_list(struct ctdb_context *ctdb,
 445                 TALLOC_CTX *mem_ctx,
 446                 struct timeval timeout, uint32_t destnode,
 447                 struct ctdb_server_id_list **svid_list);
 448
 449 int ctdb_socket_connect(struct ctdb_context *ctdb);
 450
 451 #endif