include/ctdb_private.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_PRIVATE_H
  21 #define _CTDB_PRIVATE_H
  22
  23 #include "ctdb.h"
  24 #include <sys/socket.h>
  25
  26 /* location of daemon socket */
  27 #define CTDB_PATH       "/tmp/ctdb.socket"
  28
  29 /* default ctdb port number */
  30 #define CTDB_PORT 4379
  31
  32 /* we must align packets to ensure ctdb works on all architectures (eg. sparc) */
  33 #define CTDB_DS_ALIGNMENT 8
  34
  35
  36 #define CTDB_NULL_FUNC      0xFF000001
  37 #define CTDB_FETCH_FUNC     0xFF000002
  38
  39
  40 /*
  41   recovery daemon memdump reply address
  42  */
  43 struct rd_memdump_reply {
  44         uint32_t pnn;
  45         uint64_t srvid;
  46 };
  47
  48 /*
  49   description for a TAKEOVER_RUN message reply address
  50  */
  51 struct takeover_run_reply {
  52         uint32_t pnn;
  53         uint64_t srvid;
  54 };
  55
  56 /*
  57  * pid of the ctdbd daemon
  58  */
  59 extern pid_t ctdbd_pid;
  60
  61 /*
  62   a tcp connection description
  63  */
  64 struct ctdb_tcp_connection {
  65         ctdb_sock_addr src_addr;
  66         ctdb_sock_addr dst_addr;
  67 };
  68
  69 /* the wire representation for a tcp tickle array */
  70 struct ctdb_tcp_wire_array {
  71         uint32_t num;
  72         struct ctdb_tcp_connection connections[1];
  73 };
  74
  75 /* the list of tcp tickles used by get/set tcp tickle list */
  76 struct ctdb_control_tcp_tickle_list {
  77         ctdb_sock_addr addr;
  78         struct ctdb_tcp_wire_array tickles;
  79 };
  80
  81 /*
  82   array of tcp connections
  83  */
  84 struct ctdb_tcp_array {
  85         uint32_t num;
  86         struct ctdb_tcp_connection *connections;
  87 };
  88
  89
  90 /* all tunable variables go in here */
  91 struct ctdb_tunable {
  92         uint32_t max_redirect_count;
  93         uint32_t seqnum_interval; /* unit is ms */
  94         uint32_t control_timeout;
  95         uint32_t traverse_timeout;
  96         uint32_t keepalive_interval;
  97         uint32_t keepalive_limit;
  98         uint32_t holdback_cleanup_interval;
  99         uint32_t max_lacount;
 100         uint32_t recover_timeout;
 101         uint32_t recover_interval;
 102         uint32_t election_timeout;
 103         uint32_t takeover_timeout;
 104         uint32_t monitor_interval;
 105         uint32_t tickle_update_interval;
 106         uint32_t script_timeout;
 107         uint32_t script_timeout_count; /* allow dodgy scripts to hang this many times in a row before we mark the node unhealthy */
 108         uint32_t recovery_grace_period;
 109         uint32_t recovery_ban_period;
 110         uint32_t database_hash_size;
 111         uint32_t database_max_dead;
 112         uint32_t rerecovery_timeout;
 113         uint32_t enable_bans;
 114         uint32_t deterministic_public_ips;
 115         uint32_t reclock_ping_period;
 116         uint32_t no_ip_failback;
 117         uint32_t verbose_memory_names;
 118         uint32_t recd_ping_timeout;
 119         uint32_t recd_ping_failcount;
 120         uint32_t log_latency_ms;
 121         uint32_t reclock_latency_ms;
 122         uint32_t recovery_drop_all_ips;
 123         uint32_t verify_recovery_lock;
 124         uint32_t vacuum_default_interval;
 125         uint32_t vacuum_max_run_time;
 126         uint32_t repack_limit;
 127         uint32_t vacuum_limit;
 128         uint32_t vacuum_min_interval;
 129         uint32_t vacuum_max_interval;
 130         uint32_t max_queue_depth_drop_msg;
 131         uint32_t use_status_events_for_monitoring;
 132 };
 133
 134 /*
 135   an installed ctdb remote call
 136 */
 137 struct ctdb_registered_call {
 138         struct ctdb_registered_call *next, *prev;
 139         uint32_t id;
 140         ctdb_fn_t fn;
 141 };
 142
 143 /*
 144   this address structure might need to be generalised later for some
 145   transports
 146 */
 147 struct ctdb_address {
 148         const char *address;
 149         int port;
 150 };
 151
 152 /*
 153   check that a pnn is valid
 154  */
 155 #define ctdb_validate_pnn(ctdb, pnn) (((uint32_t)(pnn)) < (ctdb)->num_nodes)
 156
 157
 158 /* called from the queue code when a packet comes in. Called with data==NULL
 159    on error */
 160 typedef void (*ctdb_queue_cb_fn_t)(uint8_t *data, size_t length,
 161                                    void *private_data);
 162
 163 /* used for callbacks in ctdb_control requests */
 164 typedef void (*ctdb_control_callback_fn_t)(struct ctdb_context *,
 165                                            int32_t status, TDB_DATA data,
 166                                            const char *errormsg,
 167                                            void *private_data);
 168 /*
 169   structure describing a connected client in the daemon
 170  */
 171 struct ctdb_client {
 172         struct ctdb_context *ctdb;
 173         int fd;
 174         struct ctdb_queue *queue;
 175         uint32_t client_id;
 176         pid_t pid;
 177         struct ctdb_tcp_list *tcp_list;
 178         uint32_t db_id;
 179         uint32_t num_persistent_updates;
 180         struct ctdb_client_notify_list *notify;
 181 };
 182
 183
 184 /* state associated with a public ip address */
 185 struct ctdb_vnn {
 186         struct ctdb_vnn *prev, *next;
 187
 188         const char *iface;
 189         ctdb_sock_addr public_address;
 190         uint8_t public_netmask_bits;
 191
 192         /* the node number that is serving this public address, if any.
 193            If no node serves this ip it is set to -1 */
 194         int32_t pnn;
 195
 196         /* List of clients to tickle for this public address */
 197         struct ctdb_tcp_array *tcp_array;
 198
 199         /* whether we need to update the other nodes with changes to our list
 200            of connected clients */
 201         bool tcp_update_needed;
 202
 203         /* a context to hang sending gratious arp events off */
 204         TALLOC_CTX *takeover_ctx;
 205
 206         struct ctdb_kill_tcp *killtcp;
 207 };
 208
 209 /*
 210   state associated with one node
 211 */
 212 struct ctdb_node {
 213         struct ctdb_context *ctdb;
 214         struct ctdb_address address;
 215         const char *name; /* for debug messages */
 216         void *private_data; /* private to transport */
 217         uint32_t pnn;
 218 #define NODE_FLAGS_DISCONNECTED         0x00000001 /* node isn't connected */
 219 #define NODE_FLAGS_UNHEALTHY            0x00000002 /* monitoring says node is unhealthy */
 220 #define NODE_FLAGS_PERMANENTLY_DISABLED 0x00000004 /* administrator has disabled node */
 221 #define NODE_FLAGS_BANNED               0x00000008 /* recovery daemon has banned the node */
 222 #define NODE_FLAGS_DELETED              0x00000010 /* this node has been deleted */
 223 #define NODE_FLAGS_STOPPED              0x00000020 /* this node has been stopped */
 224 #define NODE_FLAGS_DISABLED             (NODE_FLAGS_UNHEALTHY|NODE_FLAGS_PERMANENTLY_DISABLED)
 225 #define NODE_FLAGS_INACTIVE             (NODE_FLAGS_DELETED|NODE_FLAGS_DISCONNECTED|NODE_FLAGS_BANNED|NODE_FLAGS_STOPPED)
 226         uint32_t flags;
 227
 228         /* used by the dead node monitoring */
 229         uint32_t dead_count;
 230         uint32_t rx_cnt;
 231         uint32_t tx_cnt;
 232
 233         /* used to track node capabilities, is only valid/tracked inside the
 234            recovery daemon.
 235         */
 236         uint32_t capabilities;
 237
 238         /* a list of controls pending to this node, so we can time them out quickly
 239            if the node becomes disconnected */
 240         struct daemon_control_state *pending_controls;
 241
 242         /* used by the recovery daemon when distributing ip addresses
 243            across the nodes.  it needs to know which public ip's can be handled
 244            by each node.
 245         */
 246         struct ctdb_all_public_ips *public_ips;
 247         /* used by the recovery dameon to track when a node should be banned */
 248         struct ctdb_banning_state *ban_state;
 249 };
 250
 251 /*
 252   transport specific methods
 253 */
 254 struct ctdb_methods {
 255         int (*initialise)(struct ctdb_context *); /* initialise transport structures */
 256         int (*start)(struct ctdb_context *); /* start the transport */
 257         int (*add_node)(struct ctdb_node *); /* setup a new node */
 258         int (*connect_node)(struct ctdb_node *); /* connect to node */
 259         int (*queue_pkt)(struct ctdb_node *, uint8_t *data, uint32_t length);
 260         void *(*allocate_pkt)(TALLOC_CTX *mem_ctx, size_t );
 261         void (*shutdown)(struct ctdb_context *); /* shutdown transport */
 262         void (*restart)(struct ctdb_node *); /* stop and restart the connection */
 263 };
 264
 265 /*
 266   transport calls up to the ctdb layer
 267 */
 268 struct ctdb_upcalls {
 269         /* recv_pkt is called when a packet comes in */
 270         void (*recv_pkt)(struct ctdb_context *, uint8_t *data, uint32_t length);
 271
 272         /* node_dead is called when an attempt to send to a node fails */
 273         void (*node_dead)(struct ctdb_node *);
 274
 275         /* node_connected is called when a connection to a node is established */
 276         void (*node_connected)(struct ctdb_node *);
 277 };
 278
 279 /* list of message handlers - needs to be changed to a more efficient data
 280    structure so we can find a message handler given a srvid quickly */
 281 struct ctdb_message_list {
 282         struct ctdb_context *ctdb;
 283         struct ctdb_message_list *next, *prev;
 284         uint64_t srvid;
 285         ctdb_message_fn_t message_handler;
 286         void *message_private;
 287 };
 288
 289 /* additional data required for the daemon mode */
 290 struct ctdb_daemon_data {
 291         int sd;
 292         char *name;
 293         struct ctdb_queue *queue;
 294 };
 295
 296 /*
 297   ctdb status information
 298  */
 299 struct ctdb_statistics {
 300         uint32_t num_clients;
 301         uint32_t frozen;
 302         uint32_t recovering;
 303         uint32_t client_packets_sent;
 304         uint32_t client_packets_recv;
 305         uint32_t node_packets_sent;
 306         uint32_t node_packets_recv;
 307         uint32_t keepalive_packets_sent;
 308         uint32_t keepalive_packets_recv;
 309         struct {
 310                 uint32_t req_call;
 311                 uint32_t reply_call;
 312                 uint32_t req_dmaster;
 313                 uint32_t reply_dmaster;
 314                 uint32_t reply_error;
 315                 uint32_t req_message;
 316                 uint32_t req_control;
 317                 uint32_t reply_control;
 318         } node;
 319         struct {
 320                 uint32_t req_call;
 321                 uint32_t req_message;
 322                 uint32_t req_control;
 323         } client;
 324         struct {
 325                 uint32_t call;
 326                 uint32_t control;
 327                 uint32_t traverse;
 328         } timeouts;
 329         struct {
 330                 double ctdbd;
 331                 double recd;
 332         } reclock;
 333         uint32_t total_calls;
 334         uint32_t pending_calls;
 335         uint32_t lockwait_calls;
 336         uint32_t pending_lockwait_calls;
 337         uint32_t childwrite_calls;
 338         uint32_t pending_childwrite_calls;
 339         uint32_t memory_used;
 340         uint32_t __last_counter; /* hack for control_statistics_all */
 341         uint32_t max_hop_count;
 342         double max_call_latency;
 343         double max_lockwait_latency;
 344         double max_childwrite_latency;
 345 };
 346
 347
 348 #define INVALID_GENERATION 1
 349 /* table that contains the mapping between a hash value and lmaster
 350  */
 351 struct ctdb_vnn_map {
 352         uint32_t generation;
 353         uint32_t size;
 354         uint32_t *map;
 355 };
 356
 357 /*
 358    a wire representation of the vnn map
 359  */
 360 struct ctdb_vnn_map_wire {
 361         uint32_t generation;
 362         uint32_t size;
 363         uint32_t map[1];
 364 };
 365
 366 /* a structure that contains the elements required for the write record
 367    control
 368 */
 369 struct ctdb_write_record {
 370         uint32_t dbid;
 371         uint32_t keylen;
 372         uint32_t datalen;
 373         unsigned char blob[1];
 374 };
 375
 376 enum ctdb_freeze_mode {CTDB_FREEZE_NONE, CTDB_FREEZE_PENDING, CTDB_FREEZE_FROZEN};
 377
 378 #define CTDB_MONITORING_ACTIVE          0
 379 #define CTDB_MONITORING_DISABLED        1
 380
 381 /* The different capabilities of the ctdb daemon. */
 382 #define CTDB_CAP_RECMASTER              0x00000001
 383 #define CTDB_CAP_LMASTER                0x00000002
 384 /* This capability is set if CTDB_LVS_PUBLIC_IP is set */
 385 #define CTDB_CAP_LVS                    0x00000004
 386 /* This capability is set if NATGW is enabled */
 387 #define CTDB_CAP_NATGW                  0x00000008
 388
 389 #define NUM_DB_PRIORITIES 3
 390 /* main state of the ctdb daemon */
 391 struct ctdb_context {
 392         struct event_context *ev;
 393         struct timeval ctdbd_start_time;
 394         struct timeval last_recovery_started;
 395         struct timeval last_recovery_finished;
 396         uint32_t recovery_mode;
 397         TALLOC_CTX *tickle_update_context;
 398         TALLOC_CTX *keepalive_ctx;
 399         struct timed_event *holdback_cleanup_te;
 400         struct ctdb_tunable tunable;
 401         enum ctdb_freeze_mode freeze_mode[NUM_DB_PRIORITIES+1];
 402         struct ctdb_freeze_handle *freeze_handles[NUM_DB_PRIORITIES+1];
 403         bool freeze_transaction_started;
 404         uint32_t freeze_transaction_id;
 405         struct ctdb_address address;
 406         const char *name;
 407         const char *db_directory;
 408         const char *db_directory_persistent;
 409         const char *transport;
 410         char *recovery_lock_file;
 411         int recovery_lock_fd;
 412         uint32_t pnn; /* our own pnn */
 413         uint32_t num_nodes;
 414         uint32_t num_connected;
 415         unsigned flags;
 416         uint32_t capabilities;
 417         struct idr_context *idr;
 418         uint16_t idr_cnt;
 419         struct ctdb_node **nodes; /* array of nodes in the cluster - indexed by vnn */
 420         struct ctdb_vnn *vnn; /* list of public ip addresses and interfaces */
 421         struct ctdb_vnn *single_ip_vnn; /* a structure for the single ip */
 422         char *err_msg;
 423         const struct ctdb_methods *methods; /* transport methods */
 424         const struct ctdb_upcalls *upcalls; /* transport upcalls */
 425         void *private_data; /* private to transport */
 426         struct ctdb_db_context *db_list;
 427         struct ctdb_message_list *message_list;
 428         struct ctdb_daemon_data daemon;
 429         struct ctdb_statistics statistics;
 430         struct ctdb_vnn_map *vnn_map;
 431         uint32_t num_clients;
 432         uint32_t recovery_master;
 433         struct ctdb_call_state *pending_calls;
 434         struct ctdb_client_ip *client_ip_list;
 435         bool do_setsched;
 436         bool do_checkpublicip;
 437         void *saved_scheduler_param;
 438         struct _trbt_tree_t *server_ids;
 439         const char *event_script_dir;
 440         const char *notification_script;
 441         const char *default_public_interface;
 442         pid_t ctdbd_pid;
 443         pid_t recoverd_pid;
 444         pid_t syslogd_pid;
 445         bool done_startup;
 446         const char *node_ip;
 447         struct ctdb_monitor_state *monitor;
 448         struct ctdb_log_state *log;
 449         int start_as_disabled;
 450         int start_as_stopped;
 451         uint32_t event_script_timeouts; /* counting how many consecutive times an eventscript has timedout */
 452         uint32_t *recd_ping_count;
 453         TALLOC_CTX *release_ips_ctx; /* a context used to automatically drop all IPs if we fail to recover the node */
 454
 455         TALLOC_CTX *event_script_ctx;
 456
 457         struct ctdb_event_script_state *current_monitor;
 458         struct ctdb_scripts_wire *last_status[CTDB_EVENT_MAX];
 459
 460         TALLOC_CTX *banning_ctx;
 461
 462         /* mapping from pid to ctdb_client * */
 463         struct ctdb_client_pid_list *client_pids;
 464 };
 465
 466 struct ctdb_db_context {
 467         struct ctdb_db_context *next, *prev;
 468         struct ctdb_context *ctdb;
 469         uint32_t db_id;
 470         uint32_t priority;
 471         bool persistent;
 472         const char *db_name;
 473         const char *db_path;
 474         struct tdb_wrap *ltdb;
 475         struct ctdb_registered_call *calls; /* list of registered calls */
 476         uint32_t seqnum;
 477         struct timed_event *seqnum_update;
 478         struct ctdb_traverse_local_handle *traverse;
 479         bool transaction_active;
 480         struct ctdb_vacuum_handle *vacuum_handle;
 481
 482         /*
 483          * The keys to hold back until CTDB_CONTROL_GOTIT is being
 484          * sent by a client having forced a migration to us.
 485          */
 486         uint8_t **holdback_keys;
 487
 488         /*
 489          * The CTDB_REQ_CALLs held back according to "holdback_keys"
 490          */
 491         struct ctdb_req_header **held_back;
 492 };
 493
 494
 495 #define CTDB_NO_MEMORY(ctdb, p) do { if (!(p)) { \
 496           DEBUG(0,("Out of memory for %s at %s\n", #p, __location__)); \
 497           ctdb_set_error(ctdb, "Out of memory at %s:%d", __FILE__, __LINE__); \
 498           return -1; }} while (0)
 499
 500 #define CTDB_NO_MEMORY_VOID(ctdb, p) do { if (!(p)) { \
 501           DEBUG(0,("Out of memory for %s at %s\n", #p, __location__)); \
 502           ctdb_set_error(ctdb, "Out of memory at %s:%d", __FILE__, __LINE__); \
 503           return; }} while (0)
 504
 505 #define CTDB_NO_MEMORY_NULL(ctdb, p) do { if (!(p)) { \
 506           DEBUG(0,("Out of memory for %s at %s\n", #p, __location__)); \
 507           ctdb_set_error(ctdb, "Out of memory at %s:%d", __FILE__, __LINE__); \
 508           return NULL; }} while (0)
 509
 510 #define CTDB_NO_MEMORY_FATAL(ctdb, p) do { if (!(p)) { \
 511           DEBUG(0,("Out of memory for %s at %s\n", #p, __location__)); \
 512           ctdb_fatal(ctdb, "Out of memory in " __location__ ); \
 513           }} while (0)
 514
 515 /*
 516   the extended header for records in the ltdb
 517 */
 518 struct ctdb_ltdb_header {
 519         uint64_t rsn;
 520         uint32_t dmaster;
 521         uint32_t laccessor;
 522         uint32_t lacount;
 523 };
 524
 525 enum ctdb_controls {CTDB_CONTROL_PROCESS_EXISTS          = 0,
 526                     CTDB_CONTROL_STATISTICS              = 1,
 527                     /* #2 removed */
 528                     CTDB_CONTROL_PING                    = 3,
 529                     CTDB_CONTROL_GETDBPATH               = 4,
 530                     CTDB_CONTROL_GETVNNMAP               = 5,
 531                     CTDB_CONTROL_SETVNNMAP               = 6,
 532                     CTDB_CONTROL_GET_DEBUG               = 7,
 533                     CTDB_CONTROL_SET_DEBUG               = 8,
 534                     CTDB_CONTROL_GET_DBMAP               = 9,
 535                     CTDB_CONTROL_GET_NODEMAPv4           = 10, /* obsolete */
 536                     CTDB_CONTROL_SET_DMASTER             = 11,
 537                     /* #12 removed */
 538                     CTDB_CONTROL_PULL_DB                 = 13,
 539                     CTDB_CONTROL_PUSH_DB                 = 14,
 540                     CTDB_CONTROL_GET_RECMODE             = 15,
 541                     CTDB_CONTROL_SET_RECMODE             = 16,
 542                     CTDB_CONTROL_STATISTICS_RESET        = 17,
 543                     CTDB_CONTROL_DB_ATTACH               = 18,
 544                     CTDB_CONTROL_SET_CALL                = 19,
 545                     CTDB_CONTROL_TRAVERSE_START          = 20,
 546                     CTDB_CONTROL_TRAVERSE_ALL            = 21,
 547                     CTDB_CONTROL_TRAVERSE_DATA           = 22,
 548                     CTDB_CONTROL_REGISTER_SRVID          = 23,
 549                     CTDB_CONTROL_DEREGISTER_SRVID        = 24,
 550                     CTDB_CONTROL_GET_DBNAME              = 25,
 551                     CTDB_CONTROL_ENABLE_SEQNUM           = 26,
 552                     CTDB_CONTROL_UPDATE_SEQNUM           = 27,
 553                     /* #28 removed */
 554                     CTDB_CONTROL_DUMP_MEMORY             = 29,
 555                     CTDB_CONTROL_GET_PID                 = 30,
 556                     CTDB_CONTROL_GET_RECMASTER           = 31,
 557                     CTDB_CONTROL_SET_RECMASTER           = 32,
 558                     CTDB_CONTROL_FREEZE                  = 33,
 559                     CTDB_CONTROL_THAW                    = 34,
 560                     CTDB_CONTROL_GET_PNN                 = 35,
 561                     CTDB_CONTROL_SHUTDOWN                = 36,
 562                     CTDB_CONTROL_GET_MONMODE             = 37,
 563                     /* #38 removed */
 564                     /* #39 removed */
 565                     /* #40 removed */
 566                     /* #41 removed */
 567                     CTDB_CONTROL_TAKEOVER_IPv4           = 42, /* obsolete */
 568                     CTDB_CONTROL_RELEASE_IPv4            = 43, /* obsolete */
 569                     CTDB_CONTROL_TCP_CLIENT              = 44,
 570                     CTDB_CONTROL_TCP_ADD                 = 45,
 571                     CTDB_CONTROL_TCP_REMOVE              = 46,
 572                     CTDB_CONTROL_STARTUP                 = 47,
 573                     CTDB_CONTROL_SET_TUNABLE             = 48,
 574                     CTDB_CONTROL_GET_TUNABLE             = 49,
 575                     CTDB_CONTROL_LIST_TUNABLES           = 50,
 576                     CTDB_CONTROL_GET_PUBLIC_IPSv4        = 51, /* obsolete */
 577                     CTDB_CONTROL_MODIFY_FLAGS            = 52,
 578                     CTDB_CONTROL_GET_ALL_TUNABLES        = 53,
 579                     CTDB_CONTROL_KILL_TCP                = 54,
 580                     CTDB_CONTROL_GET_TCP_TICKLE_LIST     = 55,
 581                     CTDB_CONTROL_SET_TCP_TICKLE_LIST     = 56,
 582                     CTDB_CONTROL_REGISTER_SERVER_ID      = 57,
 583                     CTDB_CONTROL_UNREGISTER_SERVER_ID    = 58,
 584                     CTDB_CONTROL_CHECK_SERVER_ID         = 59,
 585                     CTDB_CONTROL_GET_SERVER_ID_LIST      = 60,
 586                     CTDB_CONTROL_DB_ATTACH_PERSISTENT    = 61,
 587                     CTDB_CONTROL_PERSISTENT_STORE        = 62,
 588                     CTDB_CONTROL_UPDATE_RECORD           = 63,
 589                     CTDB_CONTROL_SEND_GRATIOUS_ARP       = 64,
 590                     CTDB_CONTROL_TRANSACTION_START       = 65,
 591                     CTDB_CONTROL_TRANSACTION_COMMIT      = 66,
 592                     CTDB_CONTROL_WIPE_DATABASE           = 67,
 593                     /* #68 removed */
 594                     CTDB_CONTROL_UPTIME                  = 69,
 595                     CTDB_CONTROL_START_RECOVERY          = 70,
 596                     CTDB_CONTROL_END_RECOVERY            = 71,
 597                     CTDB_CONTROL_RELOAD_NODES_FILE       = 72,
 598                     /* #73 removed */
 599                     CTDB_CONTROL_TRY_DELETE_RECORDS      = 74,
 600                     CTDB_CONTROL_ENABLE_MONITOR          = 75,
 601                     CTDB_CONTROL_DISABLE_MONITOR         = 76,
 602                     CTDB_CONTROL_ADD_PUBLIC_IP           = 77,
 603                     CTDB_CONTROL_DEL_PUBLIC_IP           = 78,
 604                     CTDB_CONTROL_RUN_EVENTSCRIPTS        = 79,
 605                     CTDB_CONTROL_GET_CAPABILITIES        = 80,
 606                     CTDB_CONTROL_START_PERSISTENT_UPDATE = 81,
 607                     CTDB_CONTROL_CANCEL_PERSISTENT_UPDATE= 82,
 608                     CTDB_CONTROL_TRANS2_COMMIT           = 83,
 609                     CTDB_CONTROL_TRANS2_FINISHED         = 84,
 610                     CTDB_CONTROL_TRANS2_ERROR            = 85,
 611                     CTDB_CONTROL_TRANS2_COMMIT_RETRY     = 86,
 612                     CTDB_CONTROL_RECD_PING               = 87,
 613                     CTDB_CONTROL_RELEASE_IP              = 88,
 614                     CTDB_CONTROL_TAKEOVER_IP             = 89,
 615                     CTDB_CONTROL_GET_PUBLIC_IPS          = 90,
 616                     CTDB_CONTROL_GET_NODEMAP             = 91,
 617                     CTDB_CONTROL_GET_EVENT_SCRIPT_STATUS = 96,
 618                     CTDB_CONTROL_TRAVERSE_KILL           = 97,
 619                     CTDB_CONTROL_RECD_RECLOCK_LATENCY    = 98,
 620                     CTDB_CONTROL_GET_RECLOCK_FILE        = 99,
 621                     CTDB_CONTROL_SET_RECLOCK_FILE        = 100,
 622                     CTDB_CONTROL_STOP_NODE               = 101,
 623                     CTDB_CONTROL_CONTINUE_NODE           = 102,
 624                     CTDB_CONTROL_SET_NATGWSTATE          = 103,
 625                     CTDB_CONTROL_SET_LMASTERROLE         = 104,
 626                     CTDB_CONTROL_SET_RECMASTERROLE       = 105,
 627                     CTDB_CONTROL_ENABLE_SCRIPT           = 107,
 628                     CTDB_CONTROL_DISABLE_SCRIPT          = 108,
 629                     CTDB_CONTROL_SET_BAN_STATE           = 109,
 630                     CTDB_CONTROL_GET_BAN_STATE           = 110,
 631                     CTDB_CONTROL_SET_DB_PRIORITY         = 111,
 632                     CTDB_CONTROL_GET_DB_PRIORITY         = 112,
 633                     CTDB_CONTROL_TRANSACTION_CANCEL      = 113,
 634                     CTDB_CONTROL_REGISTER_NOTIFY         = 114,
 635                     CTDB_CONTROL_DEREGISTER_NOTIFY       = 115,
 636                     CTDB_CONTROL_TRANS2_ACTIVE           = 116,
 637                     CTDB_CONTROL_GET_LOG                 = 117,
 638                     CTDB_CONTROL_CLEAR_LOG               = 118,
 639                     CTDB_CONTROL_TRANS3_COMMIT           = 119,
 640                     CTDB_CONTROL_GET_DB_SEQNUM           = 120,
 641                     CTDB_CONTROL_GOTIT                   = 121,
 642 };
 643
 644 /*
 645   structure passed in set_call control
 646  */
 647 struct ctdb_control_set_call {
 648         uint32_t db_id;
 649         ctdb_fn_t fn;
 650         uint32_t id;
 651 };
 652
 653 /*
 654   struct for kill_tcp control
 655  */
 656 struct ctdb_control_killtcp {
 657         ctdb_sock_addr src_addr;
 658         ctdb_sock_addr dst_addr;
 659 };
 660
 661 /*
 662   struct holding a ctdb_sock_addr and an interface name,
 663   used to add/remove public addresses
 664  */
 665 struct ctdb_control_ip_iface {
 666         ctdb_sock_addr addr;
 667         uint32_t mask;
 668         uint32_t len;
 669         char iface[1];
 670 };
 671
 672 /*
 673   struct holding a ctdb_sock_addr and an interface name,
 674   used for send_gratious_arp
 675  */
 676 struct ctdb_control_gratious_arp {
 677         ctdb_sock_addr addr;
 678         uint32_t mask;
 679         uint32_t len;
 680         char iface[1];
 681 };
 682
 683 /*
 684   struct for tcp_add and tcp_remove controls
 685  */
 686 struct ctdb_control_tcp_vnn {
 687         ctdb_sock_addr src;
 688         ctdb_sock_addr dest;
 689 };
 690
 691 /*
 692   persistent store control - update this record on all other nodes
 693  */
 694 struct ctdb_control_persistent_store {
 695         uint32_t db_id;
 696         uint32_t len;
 697         uint8_t  data[1];
 698 };
 699
 700 /*
 701   structure used for CTDB_SRVID_NODE_FLAGS_CHANGED
 702  */
 703 struct ctdb_node_flag_change {
 704         uint32_t pnn;
 705         uint32_t new_flags;
 706         uint32_t old_flags;
 707 };
 708
 709 /*
 710   struct for admin setting a ban
 711  */
 712 struct ctdb_ban_info {
 713         uint32_t pnn;
 714         uint32_t ban_time;
 715 };
 716
 717 enum call_state {CTDB_CALL_WAIT, CTDB_CALL_DONE, CTDB_CALL_ERROR};
 718
 719 #define CTDB_LMASTER_ANY        0xffffffff
 720
 721 /*
 722   state of a in-progress ctdb call
 723 */
 724 struct ctdb_call_state {
 725         struct ctdb_call_state *next, *prev;
 726         enum call_state state;
 727         uint32_t reqid;
 728         struct ctdb_req_call *c;
 729         struct ctdb_db_context *ctdb_db;
 730         const char *errmsg;
 731         struct ctdb_call *call;
 732         uint32_t generation;
 733         struct {
 734                 void (*fn)(struct ctdb_call_state *);
 735                 void *private_data;
 736         } async;
 737 };
 738
 739
 740 /* used for fetch_lock */
 741 struct ctdb_fetch_handle {
 742         struct ctdb_db_context *ctdb_db;
 743         TDB_DATA key;
 744         TDB_DATA *data;
 745         struct ctdb_ltdb_header header;
 746 };
 747
 748 /*
 749   operation IDs
 750 */
 751 enum ctdb_operation {
 752         CTDB_REQ_CALL           = 0,
 753         CTDB_REPLY_CALL         = 1,
 754         CTDB_REQ_DMASTER        = 2,
 755         CTDB_REPLY_DMASTER      = 3,
 756         CTDB_REPLY_ERROR        = 4,
 757         CTDB_REQ_MESSAGE        = 5,
 758         /* #6 removed */
 759         CTDB_REQ_CONTROL        = 7,
 760         CTDB_REPLY_CONTROL      = 8,
 761         CTDB_REQ_KEEPALIVE      = 9,
 762 };
 763
 764 #define CTDB_MAGIC 0x43544442 /* CTDB */
 765 #define CTDB_VERSION 1
 766
 767 /*
 768   packet structures
 769 */
 770 struct ctdb_req_header {
 771         uint32_t length;
 772         uint32_t ctdb_magic;
 773         uint32_t ctdb_version;
 774         uint32_t generation;
 775         uint32_t operation;
 776         uint32_t destnode;
 777         uint32_t srcnode;
 778         uint32_t reqid;
 779 };
 780
 781 struct ctdb_req_call {
 782         struct ctdb_req_header hdr;
 783         uint32_t flags;
 784         uint32_t db_id;
 785         uint32_t callid;
 786         uint32_t hopcount;
 787         uint32_t keylen;
 788         uint32_t calldatalen;
 789         uint8_t data[1]; /* key[] followed by calldata[] */
 790 };
 791
 792 struct ctdb_reply_call {
 793         struct ctdb_req_header hdr;
 794         uint32_t status;
 795         uint32_t datalen;
 796         uint8_t  data[1];
 797 };
 798
 799 struct ctdb_reply_error {
 800         struct ctdb_req_header hdr;
 801         uint32_t status;
 802         uint32_t msglen;
 803         uint8_t  msg[1];
 804 };
 805
 806 struct ctdb_req_dmaster {
 807         struct ctdb_req_header hdr;
 808         uint32_t db_id;
 809         uint64_t rsn;
 810         uint32_t dmaster;
 811         uint32_t keylen;
 812         uint32_t datalen;
 813         uint8_t  data[1];
 814 };
 815
 816 struct ctdb_reply_dmaster {
 817         struct ctdb_req_header hdr;
 818         uint32_t db_id;
 819         uint64_t rsn;
 820         uint32_t keylen;
 821         uint32_t datalen;
 822         uint8_t  data[1];
 823 };
 824
 825 struct ctdb_req_message {
 826         struct ctdb_req_header hdr;
 827         uint64_t srvid;
 828         uint32_t datalen;
 829         uint8_t data[1];
 830 };
 831
 832 struct ctdb_req_getdbpath {
 833         struct ctdb_req_header hdr;
 834         uint32_t db_id;
 835 };
 836
 837 struct ctdb_reply_getdbpath {
 838         struct ctdb_req_header hdr;
 839         uint32_t datalen;
 840         uint8_t data[1];
 841 };
 842
 843 struct ctdb_req_control {
 844         struct ctdb_req_header hdr;
 845         uint32_t opcode;
 846         uint64_t srvid;
 847         uint32_t client_id;
 848 #define CTDB_CTRL_FLAG_NOREPLY   1
 849         uint32_t flags;
 850         uint32_t datalen;
 851         uint8_t data[1];
 852 };
 853
 854 struct ctdb_reply_control {
 855         struct ctdb_req_header hdr;
 856         int32_t  status;
 857         uint32_t datalen;
 858         uint32_t errorlen;
 859         uint8_t data[1];
 860 };
 861
 862 struct ctdb_req_keepalive {
 863         struct ctdb_req_header hdr;
 864 };
 865
 866
 867 /* types of failures possible from TRANS2_COMMIT */
 868 enum ctdb_trans2_commit_error {
 869         CTDB_TRANS2_COMMIT_SUCCESS=0, /* all nodes committed successfully */
 870         CTDB_TRANS2_COMMIT_TIMEOUT=1, /* at least one node timed out */
 871         CTDB_TRANS2_COMMIT_ALLFAIL=2, /* all nodes failed the commit */
 872         CTDB_TRANS2_COMMIT_SOMEFAIL=3 /* some nodes failed the commit, some allowed it */
 873 };
 874
 875 /* internal prototypes */
 876 void ctdb_set_error(struct ctdb_context *ctdb, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 877 void ctdb_fatal(struct ctdb_context *ctdb, const char *msg);
 878 bool ctdb_same_address(struct ctdb_address *a1, struct ctdb_address *a2);
 879 int ctdb_parse_address(struct ctdb_context *ctdb,
 880                        TALLOC_CTX *mem_ctx, const char *str,
 881                        struct ctdb_address *address);
 882 bool ctdb_same_ip(const ctdb_sock_addr *ip1, const ctdb_sock_addr *ip2);
 883 bool ctdb_same_sockaddr(const ctdb_sock_addr *ip1, const ctdb_sock_addr *ip2);
 884 uint32_t ctdb_hash(const TDB_DATA *key);
 885 uint32_t ctdb_hash_string(const char *str);
 886 void ctdb_request_call(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
 887 void ctdb_request_dmaster(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
 888 void ctdb_request_message(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
 889 void ctdb_reply_dmaster(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
 890 void ctdb_reply_call(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
 891 void ctdb_reply_error(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
 892
 893 uint32_t ctdb_lmaster(struct ctdb_context *ctdb, const TDB_DATA *key);
 894 int ctdb_ltdb_fetch(struct ctdb_db_context *ctdb_db,
 895                     TDB_DATA key, struct ctdb_ltdb_header *header,
 896                     TALLOC_CTX *mem_ctx, TDB_DATA *data);
 897 int ctdb_ltdb_store(struct ctdb_db_context *ctdb_db, TDB_DATA key,
 898                     struct ctdb_ltdb_header *header, TDB_DATA data);
 899 int32_t ctdb_control_start_persistent_update(struct ctdb_context *ctdb,
 900                         struct ctdb_req_control *c,
 901                         TDB_DATA recdata);
 902 int32_t ctdb_control_cancel_persistent_update(struct ctdb_context *ctdb,
 903                         struct ctdb_req_control *c,
 904                         TDB_DATA recdata);
 905 void ctdb_queue_packet(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
 906 void ctdb_queue_packet_opcode(struct ctdb_context *ctdb, struct ctdb_req_header *hdr, unsigned opcode);
 907 int ctdb_ltdb_lock_requeue(struct ctdb_db_context *ctdb_db,
 908                            TDB_DATA key, struct ctdb_req_header *hdr,
 909                            void (*recv_pkt)(void *, struct ctdb_req_header *),
 910                            void *recv_context, bool ignore_generation);
 911 int ctdb_ltdb_lock_fetch_requeue(struct ctdb_db_context *ctdb_db,
 912                                  TDB_DATA key, struct ctdb_ltdb_header *header,
 913                                  struct ctdb_req_header *hdr, TDB_DATA *data,
 914                                  void (*recv_pkt)(void *, struct ctdb_req_header *),
 915                                  void *recv_context, bool ignore_generation);
 916 void ctdb_input_pkt(struct ctdb_context *ctdb, struct ctdb_req_header *);
 917
 918 struct ctdb_call_state *ctdb_call_local_send(struct ctdb_db_context *ctdb_db,
 919                                              struct ctdb_call *call,
 920                                              struct ctdb_ltdb_header *header,
 921                                              TDB_DATA *data);
 922
 923
 924 int ctdbd_start(struct ctdb_context *ctdb);
 925 struct ctdb_call_state *ctdbd_call_send(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
 926 int ctdbd_call_recv(struct ctdb_call_state *state, struct ctdb_call *call);
 927
 928 /*
 929   queue a packet for sending
 930 */
 931 int ctdb_queue_send(struct ctdb_queue *queue, uint8_t *data, uint32_t length);
 932
 933 /*
 934   setup the fd used by the queue
 935  */
 936 int ctdb_queue_set_fd(struct ctdb_queue *queue, int fd);
 937
 938 /*
 939   setup a packet queue on a socket
 940  */
 941 struct ctdb_queue *ctdb_queue_setup(struct ctdb_context *ctdb,
 942                                     TALLOC_CTX *mem_ctx, int fd, int alignment,
 943
 944                                     ctdb_queue_cb_fn_t callback,
 945                                     void *private_data);
 946
 947 /*
 948   allocate a packet for use in client<->daemon communication
 949  */
 950 struct ctdb_req_header *_ctdbd_allocate_pkt(struct ctdb_context *ctdb,
 951                                             TALLOC_CTX *mem_ctx,
 952                                             enum ctdb_operation operation,
 953                                             size_t length, size_t slength,
 954                                             const char *type);
 955 #define ctdbd_allocate_pkt(ctdb, mem_ctx, operation, length, type) \
 956         (type *)_ctdbd_allocate_pkt(ctdb, mem_ctx, operation, length, sizeof(type), #type)
 957
 958 struct ctdb_req_header *_ctdb_transport_allocate(struct ctdb_context *ctdb,
 959                                                  TALLOC_CTX *mem_ctx,
 960                                                  enum ctdb_operation operation,
 961                                                  size_t length, size_t slength,
 962                                                  const char *type);
 963 #define ctdb_transport_allocate(ctdb, mem_ctx, operation, length, type) \
 964         (type *)_ctdb_transport_allocate(ctdb, mem_ctx, operation, length, sizeof(type), #type)
 965
 966 int ctdb_queue_length(struct ctdb_queue *queue);
 967
 968 /*
 969   lock a record in the ltdb, given a key
 970  */
 971 int ctdb_ltdb_lock(struct ctdb_db_context *ctdb_db, TDB_DATA key);
 972
 973 /*
 974   unlock a record in the ltdb, given a key
 975  */
 976 int ctdb_ltdb_unlock(struct ctdb_db_context *ctdb_db, TDB_DATA key);
 977
 978
 979 /*
 980   make a ctdb call to the local daemon - async send. Called from client context.
 981
 982   This constructs a ctdb_call request and queues it for processing.
 983   This call never blocks.
 984 */
 985 struct ctdb_call_state *ctdb_client_call_send(struct ctdb_db_context *ctdb_db,
 986                                               struct ctdb_call *call);
 987
 988 /*
 989   make a recv call to the local ctdb daemon - called from client context
 990
 991   This is called when the program wants to wait for a ctdb_call to complete and get the
 992   results. This call will block unless the call has already completed.
 993 */
 994 int ctdb_client_call_recv(struct ctdb_call_state *state, struct ctdb_call *call);
 995
 996 int ctdb_daemon_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid,
 997                              ctdb_message_fn_t handler,
 998                              void *private_data);
 999
1000 int ctdb_client_send_message(struct ctdb_context *ctdb, uint32_t vnn,
1001                              uint64_t srvid, TDB_DATA data);
1002
1003 /*
1004   send a ctdb message
1005 */
1006 int ctdb_daemon_send_message(struct ctdb_context *ctdb, uint32_t pnn,
1007                              uint64_t srvid, TDB_DATA data);
1008
1009
1010 struct lockwait_handle *ctdb_lockwait(struct ctdb_db_context *ctdb_db,
1011                                       TDB_DATA key,
1012                                       void (*callback)(void *), void *private_data);
1013
1014 struct ctdb_call_state *ctdb_daemon_call_send(struct ctdb_db_context *ctdb_db,
1015                                               struct ctdb_call *call);
1016
1017 int ctdb_daemon_call_recv(struct ctdb_call_state *state, struct ctdb_call *call);
1018
1019 struct ctdb_call_state *ctdb_daemon_call_send_remote(struct ctdb_db_context *ctdb_db,
1020                                                      struct ctdb_call *call,
1021                                                      struct ctdb_ltdb_header *header);
1022
1023 int ctdb_call_local(struct ctdb_db_context *ctdb_db, struct ctdb_call *call,
1024                     struct ctdb_ltdb_header *header, TALLOC_CTX *mem_ctx, TDB_DATA *data,
1025                     uint32_t caller);
1026
1027 #define ctdb_reqid_find(ctdb, reqid, type)      (type *)_ctdb_reqid_find(ctdb, reqid, #type, __location__)
1028
1029 void ctdb_recv_raw_pkt(void *p, uint8_t *data, uint32_t length);
1030
1031 int ctdb_socket_connect(struct ctdb_context *ctdb);
1032
1033 void ctdb_latency(struct ctdb_db_context *ctdb_db, const char *name, double *latency, struct timeval t);
1034 void ctdb_reclock_latency(struct ctdb_context *ctdb, const char *name, double *latency, double l);
1035
1036 uint32_t ctdb_reqid_new(struct ctdb_context *ctdb, void *state);
1037 void *_ctdb_reqid_find(struct ctdb_context *ctdb, uint32_t reqid, const char *type, const char *location);
1038 void ctdb_reqid_remove(struct ctdb_context *ctdb, uint32_t reqid);
1039
1040 void ctdb_request_control(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
1041 void ctdb_reply_control(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
1042
1043 int ctdb_daemon_send_control(struct ctdb_context *ctdb, uint32_t destnode,
1044                              uint64_t srvid, uint32_t opcode, uint32_t client_id, uint32_t flags,
1045                              TDB_DATA data,
1046                              ctdb_control_callback_fn_t callback,
1047                              void *private_data);
1048
1049 int32_t ctdb_control_db_attach(struct ctdb_context *ctdb, TDB_DATA indata,
1050                                TDB_DATA *outdata, uint64_t tdb_flags, bool persistent);
1051
1052 int ctdb_daemon_set_call(struct ctdb_context *ctdb, uint32_t db_id,
1053                          ctdb_fn_t fn, int id);
1054
1055 int ctdb_control(struct ctdb_context *ctdb, uint32_t destnode, uint64_t srvid,
1056                  uint32_t opcode, uint32_t flags, TDB_DATA data,
1057                  TALLOC_CTX *mem_ctx, TDB_DATA *outdata, int32_t *status,
1058                  struct timeval *timeout, char **errormsg);
1059 int ctdb_control_recv(struct ctdb_context *ctdb,
1060                 struct ctdb_client_control_state *state,
1061                 TALLOC_CTX *mem_ctx,
1062                 TDB_DATA *outdata, int32_t *status, char **errormsg);
1063
1064 struct ctdb_client_control_state *
1065 ctdb_control_send(struct ctdb_context *ctdb,
1066                 uint32_t destnode, uint64_t srvid,
1067                 uint32_t opcode, uint32_t flags, TDB_DATA data,
1068                 TALLOC_CTX *mem_ctx,
1069                 struct timeval *timeout,
1070                 char **errormsg);
1071
1072
1073
1074
1075 #define CHECK_CONTROL_DATA_SIZE(size) do { \
1076  if (indata.dsize != size) { \
1077          DEBUG(0,(__location__ " Invalid data size in opcode %u. Got %u expected %u\n", \
1078                   opcode, (unsigned)indata.dsize, (unsigned)size));     \
1079          return -1; \
1080  } \
1081  } while (0)
1082
1083 int ctdb_control_getvnnmap(struct ctdb_context *ctdb, uint32_t opcode, TDB_DATA indata, TDB_DATA *outdata);
1084 int ctdb_control_setvnnmap(struct ctdb_context *ctdb, uint32_t opcode, TDB_DATA indata, TDB_DATA *outdata);
1085 int ctdb_control_getdbmap(struct ctdb_context *ctdb, uint32_t opcode, TDB_DATA indata, TDB_DATA *outdata);
1086 int ctdb_control_getnodemapv4(struct ctdb_context *ctdb, uint32_t opcode, TDB_DATA indata, TDB_DATA *outdata);
1087 int ctdb_control_getnodemap(struct ctdb_context *ctdb, uint32_t opcode, TDB_DATA indata, TDB_DATA *outdata);
1088 int ctdb_control_writerecord(struct ctdb_context *ctdb, uint32_t opcode, TDB_DATA indata, TDB_DATA *outdata);
1089
1090
1091 struct ctdb_traverse_start {
1092         uint32_t db_id;
1093         uint32_t reqid;
1094         uint64_t srvid;
1095 };
1096
1097 /*
1098   structure used to pass record data between the child and parent
1099  */
1100 struct ctdb_rec_data {
1101         uint32_t length;
1102         uint32_t reqid;
1103         uint32_t keylen;
1104         uint32_t datalen;
1105         uint8_t  data[1];
1106 };
1107
1108
1109 /* structure used for pulldb control */
1110 struct ctdb_control_pulldb {
1111         uint32_t db_id;
1112         uint32_t lmaster;
1113 };
1114
1115 /* structure used for sending lists of records */
1116 struct ctdb_marshall_buffer {
1117         uint32_t db_id;
1118         uint32_t count;
1119         uint8_t data[1];
1120 };
1121
1122 /* set dmaster control structure */
1123 struct ctdb_control_set_dmaster {
1124         uint32_t db_id;
1125         uint32_t dmaster;
1126 };
1127
1128 /*
1129   structure for setting a tunable
1130  */
1131 struct ctdb_control_set_tunable {
1132         uint32_t value;
1133         uint32_t length;
1134         uint8_t  name[1];
1135 };
1136
1137 /*
1138   structure for getting a tunable
1139  */
1140 struct ctdb_control_get_tunable {
1141         uint32_t length;
1142         uint8_t  name[1];
1143 };
1144
1145 /*
1146   structure for listing tunables
1147  */
1148 struct ctdb_control_list_tunable {
1149         uint32_t length;
1150         /* returns a : separated list of tunable names */
1151         uint8_t  data[1];
1152 };
1153
1154
1155 /* table that contains a list of all nodes a ctdb knows about and their
1156    status
1157  */
1158 struct ctdb_node_and_flags {
1159         uint32_t pnn;
1160         uint32_t flags;
1161         ctdb_sock_addr addr;
1162 };
1163
1164 struct ctdb_node_map {
1165         uint32_t num;
1166         struct ctdb_node_and_flags nodes[1];
1167 };
1168
1169 struct ctdb_node_and_flagsv4 {
1170         uint32_t pnn;
1171         uint32_t flags;
1172         struct sockaddr_in sin;
1173 };
1174
1175 struct ctdb_node_mapv4 {
1176         uint32_t num;
1177         struct ctdb_node_and_flagsv4 nodes[1];
1178 };
1179
1180 struct ctdb_control_wipe_database {
1181         uint32_t db_id;
1182         uint32_t transaction_id;
1183 };
1184
1185 struct ctdb_control_gotit {
1186         uint32_t db_id;
1187         uint8_t key[1];
1188 };
1189
1190 /*
1191   state of a in-progress ctdb call in client
1192 */
1193 struct ctdb_client_call_state {
1194         enum call_state state;
1195         uint32_t reqid;
1196         struct ctdb_db_context *ctdb_db;
1197         struct ctdb_call *call;
1198         struct {
1199                 void (*fn)(struct ctdb_client_call_state *);
1200                 void *private_data;
1201         } async;
1202 };
1203
1204
1205 int32_t ctdb_control_traverse_start(struct ctdb_context *ctdb, TDB_DATA indata,
1206                                     TDB_DATA *outdata, uint32_t srcnode, uint32_t client_id);
1207 int32_t ctdb_control_traverse_all(struct ctdb_context *ctdb, TDB_DATA data, TDB_DATA *outdata);
1208 int32_t ctdb_control_traverse_data(struct ctdb_context *ctdb, TDB_DATA data, TDB_DATA *outdata);
1209 int32_t ctdb_control_traverse_kill(struct ctdb_context *ctdb, TDB_DATA indata,
1210                                     TDB_DATA *outdata, uint32_t srcnode);
1211
1212 int ctdb_dispatch_message(struct ctdb_context *ctdb, uint64_t srvid, TDB_DATA data);
1213
1214 int daemon_register_message_handler(struct ctdb_context *ctdb, uint32_t client_id, uint64_t srvid);
1215 int ctdb_deregister_message_handler(struct ctdb_context *ctdb, uint64_t srvid, void *private_data);
1216 int daemon_deregister_message_handler(struct ctdb_context *ctdb, uint32_t client_id, uint64_t srvid);
1217
1218 int32_t ctdb_ltdb_enable_seqnum(struct ctdb_context *ctdb, uint32_t db_id);
1219 int32_t ctdb_ltdb_update_seqnum(struct ctdb_context *ctdb, uint32_t db_id, uint32_t srcnode);
1220
1221 struct ctdb_rec_data *ctdb_marshall_record(TALLOC_CTX *mem_ctx, uint32_t reqid,
1222                                            TDB_DATA key, struct ctdb_ltdb_header *, TDB_DATA data);
1223
1224 struct ctdb_rec_data *ctdb_marshall_loop_next(struct ctdb_marshall_buffer *m, struct ctdb_rec_data *r,
1225                                               uint32_t *reqid,
1226                                               struct ctdb_ltdb_header *header,
1227                                               TDB_DATA *key, TDB_DATA *data);
1228
1229 int32_t ctdb_control_pull_db(struct ctdb_context *ctdb, TDB_DATA indata, TDB_DATA *outdata);
1230 int32_t ctdb_control_push_db(struct ctdb_context *ctdb, TDB_DATA indata);
1231 int32_t ctdb_control_set_dmaster(struct ctdb_context *ctdb, TDB_DATA indata);
1232
1233 int32_t ctdb_control_set_recmode(struct ctdb_context *ctdb,
1234                                  struct ctdb_req_control *c,
1235                                  TDB_DATA indata, bool *async_reply,
1236                                  const char **errormsg);
1237 void ctdb_request_control_reply(struct ctdb_context *ctdb, struct ctdb_req_control *c,
1238                                 TDB_DATA *outdata, int32_t status, const char *errormsg);
1239
1240 int32_t ctdb_control_freeze(struct ctdb_context *ctdb, struct ctdb_req_control *c, bool *async_reply);
1241 int32_t ctdb_control_thaw(struct ctdb_context *ctdb, uint32_t priority);
1242
1243 int ctdb_start_recoverd(struct ctdb_context *ctdb);
1244 void ctdb_stop_recoverd(struct ctdb_context *ctdb);
1245
1246 uint32_t ctdb_get_num_active_nodes(struct ctdb_context *ctdb);
1247
1248 void ctdb_disable_monitoring(struct ctdb_context *ctdb);
1249 void ctdb_enable_monitoring(struct ctdb_context *ctdb);
1250 void ctdb_stop_monitoring(struct ctdb_context *ctdb);
1251 void ctdb_start_monitoring(struct ctdb_context *ctdb);
1252 void ctdb_start_tcp_tickle_update(struct ctdb_context *ctdb);
1253 void ctdb_send_keepalive(struct ctdb_context *ctdb, uint32_t destnode);
1254 void ctdb_start_keepalive(struct ctdb_context *ctdb);
1255 void ctdb_stop_keepalive(struct ctdb_context *ctdb);
1256 int32_t ctdb_run_eventscripts(struct ctdb_context *ctdb, struct ctdb_req_control *c, TDB_DATA data, bool *async_reply);
1257
1258 void ctdb_start_holdback_cleanup(struct ctdb_context *ctdb);
1259 void ctdb_stop_holdback_cleanup(struct ctdb_context *ctdb);
1260 int32_t ctdb_control_gotit(struct ctdb_context *ctdb, TDB_DATA indata);
1261
1262
1263 void ctdb_daemon_cancel_controls(struct ctdb_context *ctdb, struct ctdb_node *node);
1264 void ctdb_call_resend_all(struct ctdb_context *ctdb);
1265 void ctdb_node_dead(struct ctdb_node *node);
1266 void ctdb_node_connected(struct ctdb_node *node);
1267 bool ctdb_blocking_freeze(struct ctdb_context *ctdb);
1268 void ctdb_set_scheduler(struct ctdb_context *ctdb);
1269 void ctdb_restore_scheduler(struct ctdb_context *ctdb);
1270 int32_t ctdb_control_takeover_ip(struct ctdb_context *ctdb,
1271                                  struct ctdb_req_control *c,
1272                                  TDB_DATA indata,
1273                                  bool *async_reply);
1274 int32_t ctdb_control_takeover_ipv4(struct ctdb_context *ctdb,
1275                                  struct ctdb_req_control *c,
1276                                  TDB_DATA indata,
1277                                  bool *async_reply);
1278 int32_t ctdb_control_release_ip(struct ctdb_context *ctdb,
1279                                  struct ctdb_req_control *c,
1280                                  TDB_DATA indata,
1281                                  bool *async_reply);
1282 int32_t ctdb_control_release_ipv4(struct ctdb_context *ctdb,
1283                                  struct ctdb_req_control *c,
1284                                  TDB_DATA indata,
1285                                  bool *async_reply);
1286 int32_t ctdb_control_start_recovery(struct ctdb_context *ctdb,
1287                                  struct ctdb_req_control *c,
1288                                  bool *async_reply);
1289 int32_t ctdb_control_end_recovery(struct ctdb_context *ctdb,
1290                                  struct ctdb_req_control *c,
1291                                  bool *async_reply);
1292
1293 struct ctdb_public_ipv4 {
1294         uint32_t pnn;
1295         struct sockaddr_in sin;
1296 };
1297
1298 struct ctdb_public_ip {
1299         uint32_t pnn;
1300         ctdb_sock_addr addr;
1301 };
1302 int ctdb_ctrl_takeover_ip(struct ctdb_context *ctdb, struct timeval timeout,
1303                           uint32_t destnode, struct ctdb_public_ip *ip);
1304 int ctdb_ctrl_release_ip(struct ctdb_context *ctdb, struct timeval timeout,
1305                          uint32_t destnode, struct ctdb_public_ip *ip);
1306
1307 struct ctdb_all_public_ipsv4 {
1308         uint32_t num;
1309         struct ctdb_public_ipv4 ips[1];
1310 };
1311
1312 struct ctdb_all_public_ips {
1313         uint32_t num;
1314         struct ctdb_public_ip ips[1];
1315 };
1316 int32_t ctdb_control_get_public_ipsv4(struct ctdb_context *ctdb, struct ctdb_req_control *c, TDB_DATA *outdata);
1317 int32_t ctdb_control_get_public_ips(struct ctdb_context *ctdb, struct ctdb_req_control *c, TDB_DATA *outdata);
1318 int ctdb_ctrl_get_public_ips(struct ctdb_context *ctdb,
1319                         struct timeval timeout, uint32_t destnode,
1320                         TALLOC_CTX *mem_ctx, struct ctdb_all_public_ips **ips);
1321 int ctdb_ctrl_get_public_ipsv4(struct ctdb_context *ctdb,
1322                         struct timeval timeout, uint32_t destnode,
1323                         TALLOC_CTX *mem_ctx, struct ctdb_all_public_ips **ips);
1324
1325
1326 /* from takeover/system.c */
1327 uint32_t uint16_checksum(uint16_t *data, size_t n);
1328 int ctdb_sys_send_arp(const ctdb_sock_addr *addr, const char *iface);
1329 bool ctdb_sys_have_ip(ctdb_sock_addr *addr);
1330 int ctdb_sys_send_tcp(const ctdb_sock_addr *dest,
1331                       const ctdb_sock_addr *src,
1332                       uint32_t seq, uint32_t ack, int rst);
1333
1334 int ctdb_set_public_addresses(struct ctdb_context *ctdb, const char *alist);
1335 int ctdb_set_event_script(struct ctdb_context *ctdb, const char *script);
1336 int ctdb_set_event_script_dir(struct ctdb_context *ctdb, const char *script_dir);
1337 int ctdb_set_notification_script(struct ctdb_context *ctdb, const char *script);
1338 int ctdb_takeover_run(struct ctdb_context *ctdb, struct ctdb_node_map *nodemap);
1339
1340 int32_t ctdb_control_tcp_client(struct ctdb_context *ctdb, uint32_t client_id,
1341                                 TDB_DATA indata);
1342 int32_t ctdb_control_tcp_add(struct ctdb_context *ctdb, TDB_DATA indata);
1343 int32_t ctdb_control_tcp_remove(struct ctdb_context *ctdb, TDB_DATA indata);
1344 int32_t ctdb_control_startup(struct ctdb_context *ctdb, uint32_t vnn);
1345 int32_t ctdb_control_kill_tcp(struct ctdb_context *ctdb, TDB_DATA indata);
1346 int32_t ctdb_control_send_gratious_arp(struct ctdb_context *ctdb, TDB_DATA indata);
1347 int32_t ctdb_control_get_tcp_tickle_list(struct ctdb_context *ctdb, TDB_DATA indata, TDB_DATA *outdata);
1348 int32_t ctdb_control_set_tcp_tickle_list(struct ctdb_context *ctdb, TDB_DATA indata);
1349
1350 void ctdb_takeover_client_destructor_hook(struct ctdb_client *client);
1351 int ctdb_event_script(struct ctdb_context *ctdb, enum ctdb_eventscript_call call);
1352 int ctdb_event_script_args(struct ctdb_context *ctdb, enum ctdb_eventscript_call call,
1353                            const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
1354 int ctdb_event_script_callback(struct ctdb_context *ctdb,
1355                                TALLOC_CTX *mem_ctx,
1356                                void (*callback)(struct ctdb_context *, int, void *),
1357                                void *private_data,
1358                                bool from_user,
1359                                enum ctdb_eventscript_call call,
1360                                const char *fmt, ...) PRINTF_ATTRIBUTE(7,8);
1361 void ctdb_release_all_ips(struct ctdb_context *ctdb);
1362
1363 void set_nonblocking(int fd);
1364 void set_close_on_exec(int fd);
1365
1366 bool ctdb_recovery_lock(struct ctdb_context *ctdb, bool keep);
1367
1368 int ctdb_set_recovery_lock_file(struct ctdb_context *ctdb, const char *file);
1369
1370 int32_t ctdb_control_get_tunable(struct ctdb_context *ctdb, TDB_DATA indata,
1371                                  TDB_DATA *outdata);
1372 int32_t ctdb_control_set_tunable(struct ctdb_context *ctdb, TDB_DATA indata);
1373 int32_t ctdb_control_list_tunables(struct ctdb_context *ctdb, TDB_DATA *outdata);
1374 int32_t ctdb_control_try_delete_records(struct ctdb_context *ctdb, TDB_DATA indata, TDB_DATA *outdata);
1375 int32_t ctdb_control_add_public_address(struct ctdb_context *ctdb, TDB_DATA indata);
1376 int32_t ctdb_control_del_public_address(struct ctdb_context *ctdb, TDB_DATA indata);
1377
1378 void ctdb_tunables_set_defaults(struct ctdb_context *ctdb);
1379
1380 int32_t ctdb_control_modflags(struct ctdb_context *ctdb, TDB_DATA indata);
1381
1382 int ctdb_ctrl_get_all_tunables(struct ctdb_context *ctdb,
1383                                struct timeval timeout,
1384                                uint32_t destnode,
1385                                struct ctdb_tunable *tunables);
1386
1387 int ctdb_start_freeze(struct ctdb_context *ctdb, uint32_t priority);
1388
1389 bool parse_ip_mask(const char *s, const char *iface, ctdb_sock_addr *addr, unsigned *mask);
1390 bool parse_ip_port(const char *s, ctdb_sock_addr *addr);
1391 bool parse_ip(const char *s, const char *iface, unsigned port, ctdb_sock_addr *addr);
1392 bool parse_ipv4(const char *s, unsigned port, struct sockaddr_in *sin);
1393
1394
1395 int ctdb_sys_open_capture_socket(const char *iface, void **private_data);
1396 int ctdb_sys_close_capture_socket(void *private_data);
1397 int ctdb_sys_read_tcp_packet(int s, void *private_data, ctdb_sock_addr *src, ctdb_sock_addr *dst, uint32_t *ack_seq, uint32_t *seq);
1398
1399 int ctdb_ctrl_killtcp(struct ctdb_context *ctdb,
1400                       struct timeval timeout,
1401                       uint32_t destnode,
1402                       struct ctdb_control_killtcp *killtcp);
1403
1404 int ctdb_ctrl_add_public_ip(struct ctdb_context *ctdb,
1405                       struct timeval timeout,
1406                       uint32_t destnode,
1407                       struct ctdb_control_ip_iface *pub);
1408
1409 int ctdb_ctrl_del_public_ip(struct ctdb_context *ctdb,
1410                       struct timeval timeout,
1411                       uint32_t destnode,
1412                       struct ctdb_control_ip_iface *pub);
1413
1414 int ctdb_ctrl_gratious_arp(struct ctdb_context *ctdb,
1415                       struct timeval timeout,
1416                       uint32_t destnode,
1417                       ctdb_sock_addr *addr,
1418                       const char *ifname);
1419
1420 int ctdb_ctrl_get_tcp_tickles(struct ctdb_context *ctdb,
1421                       struct timeval timeout,
1422                       uint32_t destnode,
1423                       TALLOC_CTX *mem_ctx,
1424                       ctdb_sock_addr *addr,
1425                       struct ctdb_control_tcp_tickle_list **list);
1426
1427
1428 int32_t ctdb_control_register_server_id(struct ctdb_context *ctdb,
1429                       uint32_t client_id,
1430                       TDB_DATA indata);
1431 int32_t ctdb_control_check_server_id(struct ctdb_context *ctdb,
1432                       TDB_DATA indata);
1433 int32_t ctdb_control_unregister_server_id(struct ctdb_context *ctdb,
1434                       TDB_DATA indata);
1435 int32_t ctdb_control_get_server_id_list(struct ctdb_context *ctdb,
1436                       TDB_DATA *outdata);
1437 int32_t ctdb_control_uptime(struct ctdb_context *ctdb,
1438                       TDB_DATA *outdata);
1439
1440 int ctdb_attach_persistent(struct ctdb_context *ctdb);
1441
1442 int32_t ctdb_control_persistent_store(struct ctdb_context *ctdb,
1443                                       struct ctdb_req_control *c,
1444                                       TDB_DATA recdata, bool *async_reply);
1445 int32_t ctdb_control_update_record(struct ctdb_context *ctdb,
1446                                    struct ctdb_req_control *c, TDB_DATA recdata,
1447                                    bool *async_reply);
1448 int32_t ctdb_control_trans2_commit(struct ctdb_context *ctdb,
1449                                    struct ctdb_req_control *c,
1450                                    TDB_DATA recdata, bool *async_reply);
1451
1452 int32_t ctdb_control_trans3_commit(struct ctdb_context *ctdb,
1453                                    struct ctdb_req_control *c,
1454                                    TDB_DATA recdata, bool *async_reply);
1455
1456 int32_t ctdb_control_transaction_start(struct ctdb_context *ctdb, uint32_t id);
1457 int32_t ctdb_control_transaction_commit(struct ctdb_context *ctdb, uint32_t id);
1458 int32_t ctdb_control_transaction_cancel(struct ctdb_context *ctdb);
1459 int32_t ctdb_control_wipe_database(struct ctdb_context *ctdb, TDB_DATA indata);
1460
1461
1462 int ctdb_vacuum(struct ctdb_context *ctdb, int argc, const char **argv);
1463 int ctdb_repack(struct ctdb_context *ctdb, int argc, const char **argv);
1464
1465 void ctdb_block_signal(int signum);
1466 void ctdb_unblock_signal(int signum);
1467 int32_t ctdb_monitoring_mode(struct ctdb_context *ctdb);
1468 int ctdb_set_child_logging(struct ctdb_context *ctdb);
1469
1470
1471 typedef void (*client_async_callback)(struct ctdb_context *ctdb, uint32_t node_pnn, int32_t res, TDB_DATA outdata, void *callback_data);
1472
1473 struct client_async_data {
1474         enum ctdb_controls opcode;
1475         bool dont_log_errors;
1476         uint32_t count;
1477         uint32_t fail_count;
1478         client_async_callback callback;
1479         client_async_callback fail_callback;
1480         void *callback_data;
1481 };
1482 void ctdb_client_async_add(struct client_async_data *data, struct ctdb_client_control_state *state);
1483 int ctdb_client_async_wait(struct ctdb_context *ctdb, struct client_async_data *data);
1484 int ctdb_client_async_control(struct ctdb_context *ctdb,
1485                                 enum ctdb_controls opcode,
1486                                 uint32_t *nodes,
1487                                 uint64_t srvid,
1488                                 struct timeval timeout,
1489                                 bool dont_log_errors,
1490                                 TDB_DATA data,
1491                                 client_async_callback client_callback,
1492                                 client_async_callback fail_callback,
1493                                 void *callback_data);
1494
1495 void ctdb_load_nodes_file(struct ctdb_context *ctdb);
1496
1497 int ctdb_control_reload_nodes_file(struct ctdb_context *ctdb, uint32_t opcode);
1498
1499 int32_t ctdb_dump_memory(struct ctdb_context *ctdb, TDB_DATA *outdata);
1500 int32_t ctdb_control_get_capabilities(struct ctdb_context *ctdb, TDB_DATA *outdata);
1501
1502 int32_t ctdb_control_trans2_finished(struct ctdb_context *ctdb,
1503                                      struct ctdb_req_control *c);
1504 int32_t ctdb_control_trans2_error(struct ctdb_context *ctdb,
1505                                   struct ctdb_req_control *c);
1506 int32_t ctdb_control_trans2_active(struct ctdb_context *ctdb,
1507                                    struct ctdb_req_control *c,
1508                                    uint32_t db_id);
1509
1510 char *ctdb_addr_to_str(ctdb_sock_addr *addr);
1511 unsigned ctdb_addr_to_port(ctdb_sock_addr *addr);
1512 void ctdb_canonicalize_ip(const ctdb_sock_addr *ip, ctdb_sock_addr *cip);
1513
1514 int32_t ctdb_control_recd_ping(struct ctdb_context *ctdb);
1515 int32_t ctdb_control_set_recmaster(struct ctdb_context *ctdb, uint32_t opcode, TDB_DATA indata);
1516
1517 extern int script_log_level;
1518
1519 int32_t ctdb_control_get_event_script_status(struct ctdb_context *ctdb,
1520                                              uint32_t call_type,
1521                                              TDB_DATA *outdata);
1522
1523 int ctdb_log_event_script_output(struct ctdb_context *ctdb, char *str, uint16_t len);
1524 int ctdb_ctrl_report_recd_lock_latency(struct ctdb_context *ctdb, struct timeval timeout, double latency);
1525
1526 int32_t ctdb_control_stop_node(struct ctdb_context *ctdb, struct ctdb_req_control *c, bool *async_reply);
1527 int32_t ctdb_control_continue_node(struct ctdb_context *ctdb);
1528
1529 int ctdb_vacuum_init(struct ctdb_db_context *ctdb_db);
1530
1531 int32_t ctdb_control_enable_script(struct ctdb_context *ctdb, TDB_DATA indata);
1532 int32_t ctdb_control_disable_script(struct ctdb_context *ctdb, TDB_DATA indata);
1533
1534 int32_t ctdb_control_set_ban_state(struct ctdb_context *ctdb, TDB_DATA indata);
1535 int32_t ctdb_control_get_ban_state(struct ctdb_context *ctdb, TDB_DATA *outdata);
1536 int32_t ctdb_control_set_db_priority(struct ctdb_context *ctdb, TDB_DATA indata);
1537 void ctdb_ban_self(struct ctdb_context *ctdb);
1538
1539 int32_t ctdb_control_register_notify(struct ctdb_context *ctdb, uint32_t client_id, TDB_DATA indata);
1540
1541 int32_t ctdb_control_deregister_notify(struct ctdb_context *ctdb, uint32_t client_id, TDB_DATA indata);
1542
1543 int start_syslog_daemon(struct ctdb_context *ctdb);
1544
1545 /* Where to send the log messages back to */
1546 struct ctdb_get_log_addr {
1547         uint32_t pnn;
1548         uint64_t srvid;
1549         int32_t level;
1550 };
1551
1552 int32_t ctdb_control_get_log(struct ctdb_context *ctdb, TDB_DATA addr);
1553 int32_t ctdb_control_clear_log(struct ctdb_context *ctdb);
1554 struct ctdb_log_state *ctdb_fork_with_logging(TALLOC_CTX *mem_ctx,
1555                                               struct ctdb_context *ctdb,
1556                                               void (*logfn)(const char *, uint16_t, void *),
1557                                               void *logfn_private, pid_t *pid);
1558
1559 int32_t ctdb_control_process_exists(struct ctdb_context *ctdb, pid_t pid);
1560 struct ctdb_client *ctdb_find_client_by_pid(struct ctdb_context *ctdb, pid_t pid);
1561
1562 int32_t ctdb_control_get_db_seqnum(struct ctdb_context *ctdb,
1563                                    TDB_DATA indata,
1564                                    TDB_DATA *outdata);
1565
1566 #endif