ctdb/include/ctdb_protocol.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_PROTOCOL_H
  21 #define _CTDB_PROTOCOL_H
  22
  23 /* location of daemon socket */
  24 #define CTDB_PATH       "/tmp/ctdb.socket"
  25
  26 /* default ctdb port number */
  27 #define CTDB_PORT 4379
  28
  29 /* we must align packets to ensure ctdb works on all architectures (eg. sparc) */
  30 #define CTDB_DS_ALIGNMENT 8
  31
  32
  33 #define CTDB_NULL_FUNC                  0xFF000001
  34 #define CTDB_FETCH_FUNC                 0xFF000002
  35 #define CTDB_FETCH_WITH_HEADER_FUNC     0xFF000003
  36
  37
  38 struct ctdb_call {
  39         int call_id;
  40         TDB_DATA key;
  41         TDB_DATA call_data;
  42         TDB_DATA reply_data;
  43         uint32_t status;
  44 #define CTDB_IMMEDIATE_MIGRATION                0x00000001
  45 #define CTDB_CALL_FLAG_VACUUM_MIGRATION         0x00000002
  46 #define CTDB_WANT_READONLY                      0x00000004
  47         uint32_t flags;
  48 };
  49
  50 /*
  51   structure passed to a ctdb call backend function
  52 */
  53 struct ctdb_call_info {
  54         TDB_DATA key;          /* record key */
  55         struct ctdb_ltdb_header *header;
  56         TDB_DATA record_data;  /* current data in the record */
  57         TDB_DATA *new_data;    /* optionally updated record data */
  58         TDB_DATA *call_data;   /* optionally passed from caller */
  59         TDB_DATA *reply_data;  /* optionally returned by function */
  60         uint32_t status;       /* optional reply status - defaults to zero */
  61 };
  62
  63 #define CTDB_ERR_INVALID 1
  64 #define CTDB_ERR_NOMEM 2
  65
  66 /*
  67   ctdb flags
  68 */
  69 #define CTDB_FLAG_TORTURE      (1<<1)
  70
  71 /*
  72    a message handler ID meaning "give me all messages"
  73  */
  74 #define CTDB_SRVID_ALL (~(uint64_t)0)
  75
  76 /*
  77   srvid type : RECOVERY
  78 */
  79 #define CTDB_SRVID_RECOVERY     0xF100000000000000LL
  80
  81 /*
  82    a message handler ID meaning that the cluster has been reconfigured
  83  */
  84 #define CTDB_SRVID_RECONFIGURE 0xF200000000000000LL
  85
  86 /*
  87    a message handler ID meaning that an IP address has been released
  88  */
  89 #define CTDB_SRVID_RELEASE_IP 0xF300000000000000LL
  90
  91 /*
  92    a message handler ID meaning that an IP address has been taken
  93  */
  94 #define CTDB_SRVID_TAKE_IP 0xF301000000000000LL
  95
  96 /*
  97    a message ID to set the node flags in the recovery daemon
  98  */
  99 #define CTDB_SRVID_SET_NODE_FLAGS 0xF400000000000000LL
 100
 101 /*
 102    a message ID to ask the recovery daemon to update the expected node
 103    assignment for a public ip
 104  */
 105 #define CTDB_SRVID_RECD_UPDATE_IP 0xF500000000000000LL
 106
 107 /*
 108   a message to tell the recovery daemon to fetch a set of records
 109  */
 110 #define CTDB_SRVID_VACUUM_FETCH 0xF700000000000000LL
 111
 112 /*
 113   a message to tell the recovery daemon to write a talloc memdump
 114   to the log
 115  */
 116 #define CTDB_SRVID_MEM_DUMP 0xF800000000000000LL
 117
 118 /*
 119    a message ID to get the recovery daemon to push the node flags out
 120  */
 121 #define CTDB_SRVID_PUSH_NODE_FLAGS 0xF900000000000000LL
 122
 123 /*
 124    a message ID to get the recovery daemon to reload the nodes file
 125  */
 126 #define CTDB_SRVID_RELOAD_NODES 0xFA00000000000000LL
 127
 128 /*
 129    a message ID to get the recovery daemon to perform a takeover run
 130  */
 131 #define CTDB_SRVID_TAKEOVER_RUN 0xFB00000000000000LL
 132
 133 /* A message id to ask the recovery daemon to temporarily disable the
 134    public ip checks
 135 */
 136 #define CTDB_SRVID_DISABLE_IP_CHECK  0xFC00000000000000LL
 137
 138 /* A dummy port used for sending back ipreallocate resposnes to the main
 139    daemon
 140 */
 141 #define CTDB_SRVID_TAKEOVER_RUN_RESPONSE  0xFD00000000000000LL
 142
 143 /* A range of ports reserved for registering a PID (top 8 bits)
 144  * All ports matching the 8 top bits are reserved for exclusive use by
 145  * registering a SRVID that matches the process-id of the requesting process
 146  */
 147 #define CTDB_SRVID_PID_RANGE   0x0000000000000000LL
 148
 149 /* A range of ports reserved for samba (top 8 bits)
 150  * All ports matching the 8 top bits are reserved for exclusive use by
 151  * CIFS server
 152  */
 153 #define CTDB_SRVID_SAMBA_NOTIFY  0xFE00000000000000LL
 154 #define CTDB_SRVID_SAMBA_RANGE   0xFE00000000000000LL
 155
 156 /* A range of ports reserved for a CTDB NFS server (top 8 bits)
 157  * All ports matching the 8 top bits are reserved for exclusive use by
 158  * NFS server
 159  */
 160 #define CTDB_SRVID_NFSD_RANGE  0xEE00000000000000LL
 161
 162 /* A range of ports reserved for a CTDB ISCSI server (top 8 bits)
 163  * All ports matching the 8 top bits are reserved for exclusive use by
 164  * ISCSI server
 165  */
 166 #define CTDB_SRVID_ISCSID_RANGE  0xDE00000000000000LL
 167
 168 /* A range of ports reserved for testing (top 8 bits)
 169  * All ports matching the 8 top bits are reserved for exclusive use by
 170  * test applications
 171  */
 172 #define CTDB_SRVID_TEST_RANGE  0xCE00000000000000LL
 173
 174 /* Range of ports reserved for traversals */
 175 #define CTDB_SRVID_TRAVERSE_RANGE  0xBE00000000000000LL
 176
 177 /* used on the domain socket, send a pdu to the local daemon */
 178 #define CTDB_CURRENT_NODE     0xF0000001
 179 /* send a broadcast to all nodes in the cluster, active or not */
 180 #define CTDB_BROADCAST_ALL    0xF0000002
 181 /* send a broadcast to all nodes in the current vnn map */
 182 #define CTDB_BROADCAST_VNNMAP 0xF0000003
 183 /* send a broadcast to all connected nodes */
 184 #define CTDB_BROADCAST_CONNECTED 0xF0000004
 185 /* send a broadcast to selected connected nodes */
 186 #define CTDB_MULTICAST 0xF0000005
 187
 188 /* the key used for transaction locking on persistent databases */
 189 #define CTDB_TRANSACTION_LOCK_KEY "__transaction_lock__"
 190
 191 /* the key used to store persistent db sequence number */
 192 #define CTDB_DB_SEQNUM_KEY "__db_sequence_number__"
 193
 194 #define MONITOR_SCRIPT_OK      0
 195 #define MONITOR_SCRIPT_TIMEOUT 1
 196
 197 #define MAX_SCRIPT_NAME 31
 198 #define MAX_SCRIPT_OUTPUT 511
 199 struct ctdb_script_wire {
 200         char name[MAX_SCRIPT_NAME+1];
 201         struct timeval start;
 202         struct timeval finished;
 203         int32_t status;
 204         char output[MAX_SCRIPT_OUTPUT+1];
 205 };
 206
 207 struct ctdb_scripts_wire {
 208         uint32_t num_scripts;
 209         struct ctdb_script_wire scripts[1];
 210 };
 211
 212 /* different calls to event scripts. */
 213 enum ctdb_eventscript_call {
 214         CTDB_EVENT_INIT,                /* CTDB starting up: no args */
 215         CTDB_EVENT_SETUP,               /* CTDB starting up after transport is readdy: no args. */
 216         CTDB_EVENT_STARTUP,             /* CTDB starting up after initial recovery: no args. */
 217         CTDB_EVENT_START_RECOVERY,      /* CTDB recovery starting: no args. */
 218         CTDB_EVENT_RECOVERED,           /* CTDB recovery finished: no args. */
 219         CTDB_EVENT_TAKE_IP,             /* IP taken: interface, IP address, netmask bits. */
 220         CTDB_EVENT_RELEASE_IP,          /* IP released: interface, IP address, netmask bits. */
 221         CTDB_EVENT_STOPPED,             /* This node is stopped: no args. */
 222         CTDB_EVENT_MONITOR,             /* Please check if service is healthy: no args. */
 223         CTDB_EVENT_STATUS,              /* Report service status: no args. */
 224         CTDB_EVENT_SHUTDOWN,            /* CTDB shutting down: no args. */
 225         CTDB_EVENT_RELOAD,              /* magic */
 226         CTDB_EVENT_UPDATE_IP,           /* IP updating: old interface, new interface, IP address, netmask bits. */
 227         CTDB_EVENT_IPREALLOCATED,       /* when a takeover_run() completes */
 228         CTDB_EVENT_MAX
 229 };
 230
 231 /* Mapping from enum to names. */
 232 extern const char *ctdb_eventscript_call_names[];
 233
 234 /*
 235   operation IDs
 236 */
 237 enum ctdb_operation {
 238         CTDB_REQ_CALL           = 0,
 239         CTDB_REPLY_CALL         = 1,
 240         CTDB_REQ_DMASTER        = 2,
 241         CTDB_REPLY_DMASTER      = 3,
 242         CTDB_REPLY_ERROR        = 4,
 243         CTDB_REQ_MESSAGE        = 5,
 244         /* #6 removed */
 245         CTDB_REQ_CONTROL        = 7,
 246         CTDB_REPLY_CONTROL      = 8,
 247         CTDB_REQ_KEEPALIVE      = 9,
 248 };
 249
 250 #define CTDB_MAGIC 0x43544442 /* CTDB */
 251 #define CTDB_VERSION 1
 252
 253 enum ctdb_controls {CTDB_CONTROL_PROCESS_EXISTS          = 0,
 254                     CTDB_CONTROL_STATISTICS              = 1,
 255                     /* #2 removed */
 256                     CTDB_CONTROL_PING                    = 3,
 257                     CTDB_CONTROL_GETDBPATH               = 4,
 258                     CTDB_CONTROL_GETVNNMAP               = 5,
 259                     CTDB_CONTROL_SETVNNMAP               = 6,
 260                     CTDB_CONTROL_GET_DEBUG               = 7,
 261                     CTDB_CONTROL_SET_DEBUG               = 8,
 262                     CTDB_CONTROL_GET_DBMAP               = 9,
 263                     CTDB_CONTROL_GET_NODEMAPv4           = 10, /* obsolete */
 264                     CTDB_CONTROL_SET_DMASTER             = 11,
 265                     /* #12 removed */
 266                     CTDB_CONTROL_PULL_DB                 = 13,
 267                     CTDB_CONTROL_PUSH_DB                 = 14,
 268                     CTDB_CONTROL_GET_RECMODE             = 15,
 269                     CTDB_CONTROL_SET_RECMODE             = 16,
 270                     CTDB_CONTROL_STATISTICS_RESET        = 17,
 271                     CTDB_CONTROL_DB_ATTACH               = 18,
 272                     CTDB_CONTROL_SET_CALL                = 19,
 273                     CTDB_CONTROL_TRAVERSE_START          = 20,
 274                     CTDB_CONTROL_TRAVERSE_ALL            = 21,
 275                     CTDB_CONTROL_TRAVERSE_DATA           = 22,
 276                     CTDB_CONTROL_REGISTER_SRVID          = 23,
 277                     CTDB_CONTROL_DEREGISTER_SRVID        = 24,
 278                     CTDB_CONTROL_GET_DBNAME              = 25,
 279                     CTDB_CONTROL_ENABLE_SEQNUM           = 26,
 280                     CTDB_CONTROL_UPDATE_SEQNUM           = 27,
 281                     /* #28 removed */
 282                     CTDB_CONTROL_DUMP_MEMORY             = 29,
 283                     CTDB_CONTROL_GET_PID                 = 30,
 284                     CTDB_CONTROL_GET_RECMASTER           = 31,
 285                     CTDB_CONTROL_SET_RECMASTER           = 32,
 286                     CTDB_CONTROL_FREEZE                  = 33,
 287                     CTDB_CONTROL_THAW                    = 34,
 288                     CTDB_CONTROL_GET_PNN                 = 35,
 289                     CTDB_CONTROL_SHUTDOWN                = 36,
 290                     CTDB_CONTROL_GET_MONMODE             = 37,
 291                     /* #38 removed */
 292                     /* #39 removed */
 293                     /* #40 removed */
 294                     /* #41 removed */
 295                     CTDB_CONTROL_TAKEOVER_IPv4           = 42, /* obsolete */
 296                     CTDB_CONTROL_RELEASE_IPv4            = 43, /* obsolete */
 297                     CTDB_CONTROL_TCP_CLIENT              = 44,
 298                     CTDB_CONTROL_TCP_ADD                 = 45,
 299                     CTDB_CONTROL_TCP_REMOVE              = 46,
 300                     CTDB_CONTROL_STARTUP                 = 47,
 301                     CTDB_CONTROL_SET_TUNABLE             = 48,
 302                     CTDB_CONTROL_GET_TUNABLE             = 49,
 303                     CTDB_CONTROL_LIST_TUNABLES           = 50,
 304                     CTDB_CONTROL_GET_PUBLIC_IPSv4        = 51, /* obsolete */
 305                     CTDB_CONTROL_MODIFY_FLAGS            = 52,
 306                     CTDB_CONTROL_GET_ALL_TUNABLES        = 53,
 307                     CTDB_CONTROL_KILL_TCP                = 54,
 308                     CTDB_CONTROL_GET_TCP_TICKLE_LIST     = 55,
 309                     CTDB_CONTROL_SET_TCP_TICKLE_LIST     = 56,
 310                     CTDB_CONTROL_REGISTER_SERVER_ID      = 57,
 311                     CTDB_CONTROL_UNREGISTER_SERVER_ID    = 58,
 312                     CTDB_CONTROL_CHECK_SERVER_ID         = 59,
 313                     CTDB_CONTROL_GET_SERVER_ID_LIST      = 60,
 314                     CTDB_CONTROL_DB_ATTACH_PERSISTENT    = 61,
 315                     CTDB_CONTROL_PERSISTENT_STORE        = 62,
 316                     CTDB_CONTROL_UPDATE_RECORD           = 63,
 317                     CTDB_CONTROL_SEND_GRATIOUS_ARP       = 64,
 318                     CTDB_CONTROL_TRANSACTION_START       = 65,
 319                     CTDB_CONTROL_TRANSACTION_COMMIT      = 66,
 320                     CTDB_CONTROL_WIPE_DATABASE           = 67,
 321                     /* #68 removed */
 322                     CTDB_CONTROL_UPTIME                  = 69,
 323                     CTDB_CONTROL_START_RECOVERY          = 70,
 324                     CTDB_CONTROL_END_RECOVERY            = 71,
 325                     CTDB_CONTROL_RELOAD_NODES_FILE       = 72,
 326                     /* #73 removed */
 327                     CTDB_CONTROL_TRY_DELETE_RECORDS      = 74,
 328                     CTDB_CONTROL_ENABLE_MONITOR          = 75,
 329                     CTDB_CONTROL_DISABLE_MONITOR         = 76,
 330                     CTDB_CONTROL_ADD_PUBLIC_IP           = 77,
 331                     CTDB_CONTROL_DEL_PUBLIC_IP           = 78,
 332                     CTDB_CONTROL_RUN_EVENTSCRIPTS        = 79,
 333                     CTDB_CONTROL_GET_CAPABILITIES        = 80,
 334                     CTDB_CONTROL_START_PERSISTENT_UPDATE = 81,
 335                     CTDB_CONTROL_CANCEL_PERSISTENT_UPDATE= 82,
 336                     CTDB_CONTROL_TRANS2_COMMIT           = 83,
 337                     CTDB_CONTROL_TRANS2_FINISHED         = 84,
 338                     CTDB_CONTROL_TRANS2_ERROR            = 85,
 339                     CTDB_CONTROL_TRANS2_COMMIT_RETRY     = 86,
 340                     CTDB_CONTROL_RECD_PING               = 87,
 341                     CTDB_CONTROL_RELEASE_IP              = 88,
 342                     CTDB_CONTROL_TAKEOVER_IP             = 89,
 343                     CTDB_CONTROL_GET_PUBLIC_IPS          = 90,
 344                     CTDB_CONTROL_GET_NODEMAP             = 91,
 345                     CTDB_CONTROL_GET_EVENT_SCRIPT_STATUS = 96,
 346                     CTDB_CONTROL_TRAVERSE_KILL           = 97,
 347                     CTDB_CONTROL_RECD_RECLOCK_LATENCY    = 98,
 348                     CTDB_CONTROL_GET_RECLOCK_FILE        = 99,
 349                     CTDB_CONTROL_SET_RECLOCK_FILE        = 100,
 350                     CTDB_CONTROL_STOP_NODE               = 101,
 351                     CTDB_CONTROL_CONTINUE_NODE           = 102,
 352                     CTDB_CONTROL_SET_NATGWSTATE          = 103,
 353                     CTDB_CONTROL_SET_LMASTERROLE         = 104,
 354                     CTDB_CONTROL_SET_RECMASTERROLE       = 105,
 355                     CTDB_CONTROL_ENABLE_SCRIPT           = 107,
 356                     CTDB_CONTROL_DISABLE_SCRIPT          = 108,
 357                     CTDB_CONTROL_SET_BAN_STATE           = 109,
 358                     CTDB_CONTROL_GET_BAN_STATE           = 110,
 359                     CTDB_CONTROL_SET_DB_PRIORITY         = 111,
 360                     CTDB_CONTROL_GET_DB_PRIORITY         = 112,
 361                     CTDB_CONTROL_TRANSACTION_CANCEL      = 113,
 362                     CTDB_CONTROL_REGISTER_NOTIFY         = 114,
 363                     CTDB_CONTROL_DEREGISTER_NOTIFY       = 115,
 364                     CTDB_CONTROL_TRANS2_ACTIVE           = 116,
 365                     CTDB_CONTROL_GET_LOG                 = 117,
 366                     CTDB_CONTROL_CLEAR_LOG               = 118,
 367                     CTDB_CONTROL_TRANS3_COMMIT           = 119,
 368                     CTDB_CONTROL_GET_DB_SEQNUM           = 120,
 369                     CTDB_CONTROL_DB_SET_HEALTHY          = 121,
 370                     CTDB_CONTROL_DB_GET_HEALTH           = 122,
 371                     CTDB_CONTROL_GET_PUBLIC_IP_INFO      = 123,
 372                     CTDB_CONTROL_GET_IFACES              = 124,
 373                     CTDB_CONTROL_SET_IFACE_LINK_STATE    = 125,
 374                     CTDB_CONTROL_TCP_ADD_DELAYED_UPDATE  = 126,
 375                     CTDB_CONTROL_GET_STAT_HISTORY        = 127,
 376                     CTDB_CONTROL_SCHEDULE_FOR_DELETION   = 128,
 377                     CTDB_CONTROL_SET_DB_READONLY         = 129,
 378                     CTDB_CONTROL_CHECK_SRVIDS            = 130,
 379                     CTDB_CONTROL_TRAVERSE_START_EXT      = 131,
 380 };
 381
 382 /*
 383   packet structures
 384 */
 385 struct ctdb_req_header {
 386         uint32_t length;
 387         uint32_t ctdb_magic;
 388         uint32_t ctdb_version;
 389         uint32_t generation;
 390         uint32_t operation;
 391         uint32_t destnode;
 392         uint32_t srcnode;
 393         uint32_t reqid;
 394 };
 395
 396 struct ctdb_req_call {
 397         struct ctdb_req_header hdr;
 398         uint32_t flags;
 399         uint32_t db_id;
 400         uint32_t callid;
 401         uint32_t hopcount;
 402         uint32_t keylen;
 403         uint32_t calldatalen;
 404         uint8_t data[1]; /* key[] followed by calldata[] */
 405 };
 406
 407 struct ctdb_reply_call {
 408         struct ctdb_req_header hdr;
 409         uint32_t status;
 410         uint32_t datalen;
 411         uint8_t  data[1];
 412 };
 413
 414 struct ctdb_reply_error {
 415         struct ctdb_req_header hdr;
 416         uint32_t status;
 417         uint32_t msglen;
 418         uint8_t  msg[1];
 419 };
 420
 421 struct ctdb_req_dmaster {
 422         struct ctdb_req_header hdr;
 423         uint32_t db_id;
 424         uint64_t rsn;
 425         uint32_t dmaster;
 426         uint32_t keylen;
 427         uint32_t datalen;
 428         uint8_t  data[1];
 429 };
 430
 431 struct ctdb_reply_dmaster {
 432         struct ctdb_req_header hdr;
 433         uint32_t db_id;
 434         uint64_t rsn;
 435         uint32_t keylen;
 436         uint32_t datalen;
 437         uint8_t  data[1];
 438 };
 439
 440 struct ctdb_req_message {
 441         struct ctdb_req_header hdr;
 442         uint64_t srvid;
 443         uint32_t datalen;
 444         uint8_t data[1];
 445 };
 446
 447 struct ctdb_req_getdbpath {
 448         struct ctdb_req_header hdr;
 449         uint32_t db_id;
 450 };
 451
 452 struct ctdb_reply_getdbpath {
 453         struct ctdb_req_header hdr;
 454         uint32_t datalen;
 455         uint8_t data[1];
 456 };
 457
 458 struct ctdb_req_control {
 459         struct ctdb_req_header hdr;
 460         uint32_t opcode;
 461         uint32_t pad;
 462         uint64_t srvid;
 463         uint32_t client_id;
 464 #define CTDB_CTRL_FLAG_NOREPLY   1
 465 #define CTDB_CTRL_FLAG_OPCODE_SPECIFIC   0xFFFF0000
 466         uint32_t flags;
 467         uint32_t datalen;
 468         uint8_t data[1];
 469 };
 470
 471 struct ctdb_reply_control {
 472         struct ctdb_req_header hdr;
 473         int32_t  status;
 474         uint32_t datalen;
 475         uint32_t errorlen;
 476         uint8_t data[1];
 477 };
 478
 479 struct ctdb_req_keepalive {
 480         struct ctdb_req_header hdr;
 481 };
 482
 483
 484 /* types of failures possible from TRANS2_COMMIT */
 485 enum ctdb_trans2_commit_error {
 486         CTDB_TRANS2_COMMIT_SUCCESS=0, /* all nodes committed successfully */
 487         CTDB_TRANS2_COMMIT_TIMEOUT=1, /* at least one node timed out */
 488         CTDB_TRANS2_COMMIT_ALLFAIL=2, /* all nodes failed the commit */
 489         CTDB_TRANS2_COMMIT_SOMEFAIL=3 /* some nodes failed the commit, some allowed it */
 490 };
 491
 492 /*
 493   the extended header for records in the ltdb
 494 */
 495 struct ctdb_ltdb_header {
 496         uint64_t rsn;
 497         uint32_t dmaster;
 498         uint32_t reserved1;
 499 #define CTDB_REC_FLAG_DEFAULT                   0x00000000
 500 #define CTDB_REC_FLAG_MIGRATED_WITH_DATA        0x00010000
 501 #define CTDB_REC_FLAG_VACUUM_MIGRATED           0x00020000
 502 #define CTDB_REC_FLAG_AUTOMATIC                 0x00040000
 503 #define CTDB_REC_RO_HAVE_DELEGATIONS            0x01000000
 504 #define CTDB_REC_RO_HAVE_READONLY               0x02000000
 505 #define CTDB_REC_RO_REVOKING_READONLY           0x04000000
 506 #define CTDB_REC_RO_REVOKE_COMPLETE             0x08000000
 507         uint32_t flags;
 508 };
 509
 510
 511 /*
 512   definitions for different socket structures
 513  */
 514 typedef struct sockaddr_in ctdb_addr_in;
 515 typedef struct sockaddr_in6 ctdb_addr_in6;
 516 typedef union {
 517         struct sockaddr sa;
 518         ctdb_addr_in    ip;
 519         ctdb_addr_in6   ip6;
 520 } ctdb_sock_addr;
 521
 522 /*
 523    A structure describing a single node, its flags and its address
 524 */
 525 struct ctdb_node_and_flags {
 526         uint32_t pnn;
 527         uint32_t flags;
 528         ctdb_sock_addr addr;
 529 };
 530
 531
 532 /*
 533    Structure used for a nodemap.
 534    The nodemap is the structure containing a list of all nodes
 535    known to the cluster and their associated flags.
 536 */
 537 struct ctdb_node_map {
 538         uint32_t num;
 539         struct ctdb_node_and_flags nodes[1];
 540 };
 541
 542 /*
 543  * Node flags
 544  */
 545 #define NODE_FLAGS_DISCONNECTED         0x00000001 /* node isn't connected */
 546 #define NODE_FLAGS_UNHEALTHY            0x00000002 /* monitoring says node is unhealthy */
 547 #define NODE_FLAGS_PERMANENTLY_DISABLED 0x00000004 /* administrator has disabled node */
 548 #define NODE_FLAGS_BANNED               0x00000008 /* recovery daemon has banned the node */
 549 #define NODE_FLAGS_DELETED              0x00000010 /* this node has been deleted */
 550 #define NODE_FLAGS_STOPPED              0x00000020 /* this node has been stopped */
 551 #define NODE_FLAGS_DISABLED             (NODE_FLAGS_UNHEALTHY|NODE_FLAGS_PERMANENTLY_DISABLED)
 552 #define NODE_FLAGS_INACTIVE             (NODE_FLAGS_DELETED|NODE_FLAGS_DISCONNECTED|NODE_FLAGS_BANNED|NODE_FLAGS_STOPPED)
 553
 554
 555 struct ctdb_public_ip {
 556         uint32_t pnn;
 557         ctdb_sock_addr addr;
 558 };
 559
 560 struct ctdb_all_public_ips {
 561         uint32_t num;
 562         struct ctdb_public_ip ips[1];
 563 };
 564
 565
 566 struct latency_counter {
 567         int num;
 568         double min;
 569         double max;
 570         double total;
 571 };
 572
 573 /*
 574   structure used to pass record data between the child and parent
 575  */
 576 struct ctdb_rec_data {
 577         uint32_t length;
 578         uint32_t reqid;
 579         uint32_t keylen;
 580         uint32_t datalen;
 581         uint8_t  data[1];
 582 };
 583
 584 struct ctdb_traverse_start {
 585         uint32_t db_id;
 586         uint32_t reqid;
 587         uint64_t srvid;
 588 };
 589
 590 struct ctdb_traverse_start_ext {
 591         uint32_t db_id;
 592         uint32_t reqid;
 593         uint64_t srvid;
 594         bool withemptyrecords;
 595 };
 596
 597 /*
 598   ctdb statistics information
 599  */
 600 struct ctdb_statistics {
 601         uint32_t num_clients;
 602         uint32_t frozen;
 603         uint32_t recovering;
 604         uint32_t client_packets_sent;
 605         uint32_t client_packets_recv;
 606         uint32_t node_packets_sent;
 607         uint32_t node_packets_recv;
 608         uint32_t keepalive_packets_sent;
 609         uint32_t keepalive_packets_recv;
 610         struct {
 611                 uint32_t req_call;
 612                 uint32_t reply_call;
 613                 uint32_t req_dmaster;
 614                 uint32_t reply_dmaster;
 615                 uint32_t reply_error;
 616                 uint32_t req_message;
 617                 uint32_t req_control;
 618                 uint32_t reply_control;
 619         } node;
 620         struct {
 621                 uint32_t req_call;
 622                 uint32_t req_message;
 623                 uint32_t req_control;
 624         } client;
 625         struct {
 626                 uint32_t call;
 627                 uint32_t control;
 628                 uint32_t traverse;
 629         } timeouts;
 630         struct {
 631                 struct latency_counter ctdbd;
 632                 struct latency_counter recd;
 633         } reclock;
 634         uint32_t total_calls;
 635         uint32_t pending_calls;
 636         uint32_t lockwait_calls;
 637         uint32_t pending_lockwait_calls;
 638         uint32_t childwrite_calls;
 639         uint32_t pending_childwrite_calls;
 640         uint32_t memory_used;
 641         uint32_t __last_counter; /* hack for control_statistics_all */
 642         uint32_t max_hop_count;
 643         struct latency_counter call_latency;
 644         struct latency_counter lockwait_latency;
 645         struct latency_counter childwrite_latency;
 646         uint32_t num_recoveries;
 647         struct timeval statistics_start_time;
 648         struct timeval statistics_current_time;
 649 };
 650
 651 /*
 652  * wire format for statistics history
 653  */
 654 struct ctdb_statistics_wire {
 655         uint32_t num;
 656         struct ctdb_statistics stats[1];
 657 };
 658
 659 /*
 660  * wire format for interface list
 661  */
 662 #ifdef IFNAMSIZ
 663 #define CTDB_IFACE_SIZE IFNAMSIZ
 664 #else
 665 #define CTDB_IFACE_SIZE 16
 666 #endif
 667
 668 struct ctdb_iface_info {
 669         char name[CTDB_IFACE_SIZE+2];
 670         uint16_t link_state;
 671         uint32_t references;
 672 };
 673
 674 struct ctdb_ifaces_list {
 675         uint32_t num;
 676         struct ctdb_iface_info ifaces[1];
 677 };
 678
 679 #endif