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