2 CTDB protocol marshalling
4 Copyright (C) Amitay Isaacs 2015
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.
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.
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/>.
20 #ifndef __CTDB_PROTOCOL_H__
21 #define __CTDB_PROTOCOL_H__
25 #define CTDB_MAGIC 0x43544442 /* CTDB */
26 #define CTDB_PROTOCOL 1
32 CTDB_REPLY_DMASTER = 3,
37 CTDB_REPLY_CONTROL = 8,
38 CTDB_REQ_KEEPALIVE = 9,
41 /* used on the domain socket, send a pdu to the local daemon */
42 #define CTDB_CURRENT_NODE 0xF0000001
43 /* send a broadcast to all nodes in the cluster, active or not */
44 #define CTDB_BROADCAST_ALL 0xF0000002
45 /* send a broadcast to all nodes in the current vnn map */
46 #define CTDB_BROADCAST_VNNMAP 0xF0000003
47 /* send a broadcast to all connected nodes */
48 #define CTDB_BROADCAST_CONNECTED 0xF0000004
49 /* send a broadcast to selected connected nodes */
50 #define CTDB_MULTICAST 0xF0000005
52 #define CTDB_UNKNOWN_PNN 0xFFFFFFFF
54 /* the key used to store persistent db sequence number */
55 #define CTDB_DB_SEQNUM_KEY "__db_sequence_number__"
57 struct ctdb_req_header {
60 uint32_t ctdb_version;
68 struct ctdb_req_call {
77 struct ctdb_reply_call {
82 struct ctdb_reply_error {
87 struct ctdb_req_dmaster {
95 struct ctdb_reply_dmaster {
102 #define CTDB_NULL_FUNC 0xFF000001
103 #define CTDB_FETCH_FUNC 0xFF000002
104 #define CTDB_FETCH_WITH_HEADER_FUNC 0xFF000003
112 #define CTDB_IMMEDIATE_MIGRATION 0x00000001
113 #define CTDB_CALL_FLAG_VACUUM_MIGRATION 0x00000002
114 #define CTDB_WANT_READONLY 0x00000004
118 /* SRVID to catch all messages */
119 #define CTDB_SRVID_ALL (~(uint64_t)0)
121 /* SRVID prefix used during recovery for pulling and pushing databases */
122 #define CTDB_SRVID_RECOVERY 0xF001000000000000LL
124 /* SRVID to assign of banning credits */
125 #define CTDB_SRVID_BANNING 0xF002000000000000LL
127 /* SRVID to inform of election data */
128 #define CTDB_SRVID_ELECTION 0xF100000000000000LL
130 /* SRVID to inform clients that the cluster has been reconfigured */
131 #define CTDB_SRVID_RECONFIGURE 0xF200000000000000LL
133 /* SRVID to inform clients an IP address has been released */
134 #define CTDB_SRVID_RELEASE_IP 0xF300000000000000LL
136 /* SRVID to inform clients that an IP address has been taken over */
137 #define CTDB_SRVID_TAKE_IP 0xF301000000000000LL
139 /* SRVID to inform recovery daemon of the node flags */
140 #define CTDB_SRVID_SET_NODE_FLAGS 0xF400000000000000LL
142 /* SRVID to inform recovery daemon to update public ip assignment */
143 #define CTDB_SRVID_RECD_UPDATE_IP 0xF500000000000000LL
145 /* SRVID to inform recovery daemon to migrate a set of records */
146 #define CTDB_SRVID_VACUUM_FETCH 0xF700000000000000LL
148 /* SRVID to inform recovery daemon to detach a database */
149 #define CTDB_SRVID_DETACH_DATABASE 0xF701000000000000LL
151 /* SRVID to inform recovery daemon to dump talloc memdump to the log */
152 #define CTDB_SRVID_MEM_DUMP 0xF800000000000000LL
154 /* SRVID to inform recovery daemon to send logs */
155 #define CTDB_SRVID_GETLOG 0xF801000000000000LL
157 /* SRVID to inform recovery daemon to clear logs */
158 #define CTDB_SRVID_CLEARLOG 0xF802000000000000LL
160 /* SRVID to inform recovery daemon to push the node flags to other nodes */
161 #define CTDB_SRVID_PUSH_NODE_FLAGS 0xF900000000000000LL
163 /* SRVID to inform recovery daemon to reload the nodes file */
164 #define CTDB_SRVID_RELOAD_NODES 0xFA00000000000000LL
166 /* SRVID to inform recovery daemon to perform a takeover run */
167 #define CTDB_SRVID_TAKEOVER_RUN 0xFB00000000000000LL
169 /* SRVID to inform recovery daemon to rebalance ips for a node. */
170 #define CTDB_SRVID_REBALANCE_NODE 0xFB01000000000000LL
172 /* SRVID to inform recovery daemon to stop takeover runs from occurring */
173 #define CTDB_SRVID_DISABLE_TAKEOVER_RUNS 0xFB03000000000000LL
175 /* SRVID to inform recovery daemon to stop recoveries from occurring */
176 #define CTDB_SRVID_DISABLE_RECOVERIES 0xFB04000000000000LL
178 /* SRVID to inform recovery daemon to disable the public ip checks */
179 #define CTDB_SRVID_DISABLE_IP_CHECK 0xFC00000000000000LL
181 /* A range of ports reserved for registering a PID (top 8 bits)
182 * All ports matching the 8 top bits are reserved for exclusive use by
183 * registering a SRVID that matches the process-id of the requesting process
185 #define CTDB_SRVID_PID_RANGE 0x0000000000000000LL
187 /* A range of ports reserved for samba (top 8 bits)
188 * All ports matching the 8 top bits are reserved for exclusive use by
191 #define CTDB_SRVID_SAMBA_NOTIFY 0xFE00000000000000LL
192 #define CTDB_SRVID_SAMBA_RANGE 0xFE00000000000000LL
194 /* A range of ports reserved for a CTDB NFS server (top 8 bits)
195 * All ports matching the 8 top bits are reserved for exclusive use by
198 #define CTDB_SRVID_NFSD_RANGE 0xEE00000000000000LL
200 /* A range of ports reserved for a CTDB ISCSI server (top 8 bits)
201 * All ports matching the 8 top bits are reserved for exclusive use by
204 #define CTDB_SRVID_ISCSID_RANGE 0xDE00000000000000LL
206 /* A range of ports reserved for CTDB tool (top 8 bits)
207 * All ports matching the 8 top bits are reserved for exclusive use by
210 #define CTDB_SRVID_TOOL_RANGE 0xCE00000000000000LL
212 /* Range of ports reserved for test applications (top 8 bits)
213 * All ports matching the 8 top bits are reserved for exclusive use by
216 #define CTDB_SRVID_TEST_RANGE 0xBE00000000000000LL
219 enum ctdb_controls {CTDB_CONTROL_PROCESS_EXISTS = 0,
220 CTDB_CONTROL_STATISTICS = 1,
222 CTDB_CONTROL_PING = 3,
223 CTDB_CONTROL_GETDBPATH = 4,
224 CTDB_CONTROL_GETVNNMAP = 5,
225 CTDB_CONTROL_SETVNNMAP = 6,
226 CTDB_CONTROL_GET_DEBUG = 7,
227 CTDB_CONTROL_SET_DEBUG = 8,
228 CTDB_CONTROL_GET_DBMAP = 9,
229 CTDB_CONTROL_GET_NODEMAPv4 = 10, /* obsolete */
230 CTDB_CONTROL_SET_DMASTER = 11, /* obsolete */
232 CTDB_CONTROL_PULL_DB = 13,
233 CTDB_CONTROL_PUSH_DB = 14,
234 CTDB_CONTROL_GET_RECMODE = 15,
235 CTDB_CONTROL_SET_RECMODE = 16,
236 CTDB_CONTROL_STATISTICS_RESET = 17,
237 CTDB_CONTROL_DB_ATTACH = 18,
238 CTDB_CONTROL_SET_CALL = 19, /* obsolete */
239 CTDB_CONTROL_TRAVERSE_START = 20,
240 CTDB_CONTROL_TRAVERSE_ALL = 21,
241 CTDB_CONTROL_TRAVERSE_DATA = 22,
242 CTDB_CONTROL_REGISTER_SRVID = 23,
243 CTDB_CONTROL_DEREGISTER_SRVID = 24,
244 CTDB_CONTROL_GET_DBNAME = 25,
245 CTDB_CONTROL_ENABLE_SEQNUM = 26,
246 CTDB_CONTROL_UPDATE_SEQNUM = 27,
248 CTDB_CONTROL_DUMP_MEMORY = 29,
249 CTDB_CONTROL_GET_PID = 30,
250 CTDB_CONTROL_GET_RECMASTER = 31,
251 CTDB_CONTROL_SET_RECMASTER = 32,
252 CTDB_CONTROL_FREEZE = 33,
253 CTDB_CONTROL_THAW = 34, /* obsolete */
254 CTDB_CONTROL_GET_PNN = 35,
255 CTDB_CONTROL_SHUTDOWN = 36,
256 CTDB_CONTROL_GET_MONMODE = 37,
261 CTDB_CONTROL_TAKEOVER_IPv4 = 42, /* obsolete */
262 CTDB_CONTROL_RELEASE_IPv4 = 43, /* obsolete */
263 CTDB_CONTROL_TCP_CLIENT = 44,
264 CTDB_CONTROL_TCP_ADD = 45,
265 CTDB_CONTROL_TCP_REMOVE = 46,
266 CTDB_CONTROL_STARTUP = 47,
267 CTDB_CONTROL_SET_TUNABLE = 48,
268 CTDB_CONTROL_GET_TUNABLE = 49,
269 CTDB_CONTROL_LIST_TUNABLES = 50,
270 CTDB_CONTROL_GET_PUBLIC_IPSv4 = 51, /* obsolete */
271 CTDB_CONTROL_MODIFY_FLAGS = 52,
272 CTDB_CONTROL_GET_ALL_TUNABLES = 53,
273 CTDB_CONTROL_KILL_TCP = 54, /* obsolete */
274 CTDB_CONTROL_GET_TCP_TICKLE_LIST = 55,
275 CTDB_CONTROL_SET_TCP_TICKLE_LIST = 56,
276 CTDB_CONTROL_REGISTER_SERVER_ID = 57, /* obsolete */
277 CTDB_CONTROL_UNREGISTER_SERVER_ID = 58, /* obsolete */
278 CTDB_CONTROL_CHECK_SERVER_ID = 59, /* obsolete */
279 CTDB_CONTROL_GET_SERVER_ID_LIST = 60, /* obsolete */
280 CTDB_CONTROL_DB_ATTACH_PERSISTENT = 61,
281 CTDB_CONTROL_PERSISTENT_STORE = 62, /* obsolete */
282 CTDB_CONTROL_UPDATE_RECORD = 63,
283 CTDB_CONTROL_SEND_GRATUITOUS_ARP = 64,
284 CTDB_CONTROL_TRANSACTION_START = 65, /* obsolete */
285 CTDB_CONTROL_TRANSACTION_COMMIT = 66, /* obsolete */
286 CTDB_CONTROL_WIPE_DATABASE = 67,
288 CTDB_CONTROL_UPTIME = 69,
289 CTDB_CONTROL_START_RECOVERY = 70,
290 CTDB_CONTROL_END_RECOVERY = 71,
291 CTDB_CONTROL_RELOAD_NODES_FILE = 72,
293 CTDB_CONTROL_TRY_DELETE_RECORDS = 74,
294 CTDB_CONTROL_ENABLE_MONITOR = 75,
295 CTDB_CONTROL_DISABLE_MONITOR = 76,
296 CTDB_CONTROL_ADD_PUBLIC_IP = 77,
297 CTDB_CONTROL_DEL_PUBLIC_IP = 78,
298 CTDB_CONTROL_RUN_EVENTSCRIPTS = 79, /* obsolete */
299 CTDB_CONTROL_GET_CAPABILITIES = 80,
300 CTDB_CONTROL_START_PERSISTENT_UPDATE = 81, /* obsolete */
301 CTDB_CONTROL_CANCEL_PERSISTENT_UPDATE= 82, /* obsolete */
302 CTDB_CONTROL_TRANS2_COMMIT = 83, /* obsolete */
303 CTDB_CONTROL_TRANS2_FINISHED = 84, /* obsolete */
304 CTDB_CONTROL_TRANS2_ERROR = 85, /* obsolete */
305 CTDB_CONTROL_TRANS2_COMMIT_RETRY = 86, /* obsolete */
306 CTDB_CONTROL_RECD_PING = 87,
307 CTDB_CONTROL_RELEASE_IP = 88,
308 CTDB_CONTROL_TAKEOVER_IP = 89,
309 CTDB_CONTROL_GET_PUBLIC_IPS = 90,
310 CTDB_CONTROL_GET_NODEMAP = 91,
312 CTDB_CONTROL_GET_EVENT_SCRIPT_STATUS = 96, /* obsolete */
313 CTDB_CONTROL_TRAVERSE_KILL = 97,
314 CTDB_CONTROL_RECD_RECLOCK_LATENCY = 98,
315 CTDB_CONTROL_GET_RECLOCK_FILE = 99,
316 CTDB_CONTROL_SET_RECLOCK_FILE = 100, /* obsolete */
317 CTDB_CONTROL_STOP_NODE = 101,
318 CTDB_CONTROL_CONTINUE_NODE = 102,
319 CTDB_CONTROL_SET_NATGWSTATE = 103, /* obsolete */
320 CTDB_CONTROL_SET_LMASTERROLE = 104,
321 CTDB_CONTROL_SET_RECMASTERROLE = 105,
322 CTDB_CONTROL_ENABLE_SCRIPT = 107, /* obsolete */
323 CTDB_CONTROL_DISABLE_SCRIPT = 108, /* obsolete */
324 CTDB_CONTROL_SET_BAN_STATE = 109,
325 CTDB_CONTROL_GET_BAN_STATE = 110,
326 CTDB_CONTROL_SET_DB_PRIORITY = 111, /* obsolete */
327 CTDB_CONTROL_GET_DB_PRIORITY = 112, /* obsolete */
328 CTDB_CONTROL_TRANSACTION_CANCEL = 113, /* obsolete */
329 CTDB_CONTROL_REGISTER_NOTIFY = 114,
330 CTDB_CONTROL_DEREGISTER_NOTIFY = 115,
331 CTDB_CONTROL_TRANS2_ACTIVE = 116, /* obsolete */
332 CTDB_CONTROL_GET_LOG = 117, /* obsolete */
333 CTDB_CONTROL_CLEAR_LOG = 118, /* obsolete */
334 CTDB_CONTROL_TRANS3_COMMIT = 119,
335 CTDB_CONTROL_GET_DB_SEQNUM = 120,
336 CTDB_CONTROL_DB_SET_HEALTHY = 121,
337 CTDB_CONTROL_DB_GET_HEALTH = 122,
338 CTDB_CONTROL_GET_PUBLIC_IP_INFO = 123,
339 CTDB_CONTROL_GET_IFACES = 124,
340 CTDB_CONTROL_SET_IFACE_LINK_STATE = 125,
341 CTDB_CONTROL_TCP_ADD_DELAYED_UPDATE = 126,
342 CTDB_CONTROL_GET_STAT_HISTORY = 127,
343 CTDB_CONTROL_SCHEDULE_FOR_DELETION = 128,
344 CTDB_CONTROL_SET_DB_READONLY = 129,
345 CTDB_CONTROL_CHECK_SRVIDS = 130,
346 CTDB_CONTROL_TRAVERSE_START_EXT = 131,
347 CTDB_CONTROL_GET_DB_STATISTICS = 132,
348 CTDB_CONTROL_SET_DB_STICKY = 133,
349 CTDB_CONTROL_RELOAD_PUBLIC_IPS = 134,
350 CTDB_CONTROL_TRAVERSE_ALL_EXT = 135,
351 CTDB_CONTROL_RECEIVE_RECORDS = 136,
352 CTDB_CONTROL_IPREALLOCATED = 137,
353 CTDB_CONTROL_GET_RUNSTATE = 138,
354 CTDB_CONTROL_DB_DETACH = 139,
355 CTDB_CONTROL_GET_NODES_FILE = 140,
356 CTDB_CONTROL_DB_FREEZE = 141,
357 CTDB_CONTROL_DB_THAW = 142,
358 CTDB_CONTROL_DB_TRANSACTION_START = 143,
359 CTDB_CONTROL_DB_TRANSACTION_COMMIT = 144,
360 CTDB_CONTROL_DB_TRANSACTION_CANCEL = 145,
361 CTDB_CONTROL_DB_PULL = 146,
362 CTDB_CONTROL_DB_PUSH_START = 147,
363 CTDB_CONTROL_DB_PUSH_CONFIRM = 148,
366 #define CTDB_MONITORING_ENABLED 0
367 #define CTDB_MONITORING_DISABLED 1
369 #define MAX_COUNT_BUCKETS 16
370 #define MAX_HOT_KEYS 10
372 struct ctdb_latency_counter {
379 struct ctdb_statistics {
380 uint32_t num_clients;
383 uint32_t client_packets_sent;
384 uint32_t client_packets_recv;
385 uint32_t node_packets_sent;
386 uint32_t node_packets_recv;
387 uint32_t keepalive_packets_sent;
388 uint32_t keepalive_packets_recv;
392 uint32_t req_dmaster;
393 uint32_t reply_dmaster;
394 uint32_t reply_error;
395 uint32_t req_message;
396 uint32_t req_control;
397 uint32_t reply_control;
401 uint32_t req_message;
402 uint32_t req_control;
410 struct ctdb_latency_counter ctdbd;
411 struct ctdb_latency_counter recd;
415 uint32_t num_current;
416 uint32_t num_pending;
418 struct ctdb_latency_counter latency;
419 uint32_t buckets[MAX_COUNT_BUCKETS];
421 uint32_t total_calls;
422 uint32_t pending_calls;
423 uint32_t childwrite_calls;
424 uint32_t pending_childwrite_calls;
425 uint32_t memory_used;
426 uint32_t __last_counter; /* hack */
427 uint32_t max_hop_count;
428 uint32_t hop_count_bucket[MAX_COUNT_BUCKETS];
429 struct ctdb_latency_counter call_latency;
430 struct ctdb_latency_counter childwrite_latency;
431 uint32_t num_recoveries;
432 struct timeval statistics_start_time;
433 struct timeval statistics_current_time;
434 uint32_t total_ro_delegations;
435 uint32_t total_ro_revokes;
438 #define INVALID_GENERATION 1
439 /* table that contains the mapping between a hash value and lmaster
441 struct ctdb_vnn_map {
449 #define CTDB_DB_FLAGS_PERSISTENT 0x01
450 #define CTDB_DB_FLAGS_READONLY 0x02
451 #define CTDB_DB_FLAGS_STICKY 0x04
455 struct ctdb_dbid_map {
457 struct ctdb_dbid *dbs;
462 #define CTDB_LMASTER_ANY 0xffffffff
466 struct ctdb_pulldb_ext {
472 #define CTDB_RECOVERY_NORMAL 0
473 #define CTDB_RECOVERY_ACTIVE 1
476 the extended header for records in the ltdb
478 struct ctdb_ltdb_header {
482 #define CTDB_REC_FLAG_DEFAULT 0x00000000
483 #define CTDB_REC_FLAG_MIGRATED_WITH_DATA 0x00010000
484 #define CTDB_REC_FLAG_VACUUM_MIGRATED 0x00020000
485 #define CTDB_REC_FLAG_AUTOMATIC 0x00040000
486 #define CTDB_REC_RO_HAVE_DELEGATIONS 0x01000000
487 #define CTDB_REC_RO_HAVE_READONLY 0x02000000
488 #define CTDB_REC_RO_REVOKING_READONLY 0x04000000
489 #define CTDB_REC_RO_REVOKE_COMPLETE 0x08000000
490 #define CTDB_REC_RO_FLAGS (CTDB_REC_RO_HAVE_DELEGATIONS|\
491 CTDB_REC_RO_HAVE_READONLY|\
492 CTDB_REC_RO_REVOKING_READONLY|\
493 CTDB_REC_RO_REVOKE_COMPLETE)
497 struct ctdb_rec_data {
499 struct ctdb_ltdb_header *header;
503 struct ctdb_rec_buffer {
510 typedef int (*ctdb_rec_parser_func_t)(uint32_t reqid,
511 struct ctdb_ltdb_header *header,
512 TDB_DATA key, TDB_DATA data,
515 struct ctdb_traverse_start {
521 struct ctdb_traverse_all {
525 uint32_t client_reqid;
529 struct ctdb_traverse_start_ext {
533 bool withemptyrecords;
536 struct ctdb_traverse_all_ext {
540 uint32_t client_reqid;
542 bool withemptyrecords;
547 struct sockaddr_in ip;
548 struct sockaddr_in6 ip6;
551 struct ctdb_connection {
556 struct ctdb_tunable {
561 struct ctdb_var_list {
566 struct ctdb_node_flag_change {
572 /* all tunable variables go in here */
573 struct ctdb_tunable_list {
574 uint32_t max_redirect_count;
575 uint32_t seqnum_interval; /* unit is ms */
576 uint32_t control_timeout;
577 uint32_t traverse_timeout;
578 uint32_t keepalive_interval;
579 uint32_t keepalive_limit;
580 uint32_t recover_timeout;
581 uint32_t recover_interval;
582 uint32_t election_timeout;
583 uint32_t takeover_timeout;
584 uint32_t monitor_interval;
585 uint32_t tickle_update_interval;
586 uint32_t script_timeout;
587 uint32_t monitor_timeout_count; /* allow dodgy scripts to hang this many times in a row before we mark the node unhealthy */
588 uint32_t script_unhealthy_on_timeout; /* obsolete */
589 uint32_t recovery_grace_period;
590 uint32_t recovery_ban_period;
591 uint32_t database_hash_size;
592 uint32_t database_max_dead;
593 uint32_t rerecovery_timeout;
594 uint32_t enable_bans;
595 uint32_t deterministic_public_ips;
596 uint32_t reclock_ping_period;
597 uint32_t no_ip_failback;
598 uint32_t disable_ip_failover;
599 uint32_t verbose_memory_names;
600 uint32_t recd_ping_timeout;
601 uint32_t recd_ping_failcount;
602 uint32_t log_latency_ms;
603 uint32_t reclock_latency_ms;
604 uint32_t recovery_drop_all_ips;
605 uint32_t verify_recovery_lock;
606 uint32_t vacuum_interval;
607 uint32_t vacuum_max_run_time;
608 uint32_t repack_limit;
609 uint32_t vacuum_limit;
610 uint32_t max_queue_depth_drop_msg;
611 uint32_t allow_unhealthy_db_read;
612 uint32_t stat_history_interval;
613 uint32_t deferred_attach_timeout;
614 uint32_t vacuum_fast_path_count;
615 uint32_t lcp2_public_ip_assignment;
616 uint32_t allow_client_db_attach;
617 uint32_t recover_pdb_by_seqnum;
618 uint32_t deferred_rebalance_on_node_add;
619 uint32_t fetch_collapse;
620 uint32_t hopcount_make_sticky;
621 uint32_t sticky_duration;
622 uint32_t sticky_pindown;
623 uint32_t no_ip_takeover;
624 uint32_t db_record_count_warn;
625 uint32_t db_record_size_warn;
626 uint32_t db_size_warn;
627 uint32_t pulldb_preallocation_size;
628 uint32_t no_ip_host_on_all_disabled;
629 uint32_t samba3_hack;
630 uint32_t mutex_enabled;
631 uint32_t lock_processes_per_db;
632 uint32_t rec_buffer_size_limit;
633 uint32_t queue_buffer_size;
634 uint32_t ip_alloc_algorithm;
635 uint32_t allow_mixed_versions;
638 struct ctdb_tickle_list {
641 struct ctdb_connection *conn;
644 struct ctdb_addr_info {
650 struct ctdb_transdb {
656 struct timeval current_time;
657 struct timeval ctdbd_start_time;
658 struct timeval last_recovery_started;
659 struct timeval last_recovery_finished;
662 struct ctdb_public_ip {
667 struct ctdb_public_ip_list {
669 struct ctdb_public_ip *ip;
675 #define NODE_FLAGS_DISCONNECTED 0x00000001 /* node isn't connected */
676 #define NODE_FLAGS_UNHEALTHY 0x00000002 /* monitoring says node is unhealthy */
677 #define NODE_FLAGS_PERMANENTLY_DISABLED 0x00000004 /* administrator has disabled node */
678 #define NODE_FLAGS_BANNED 0x00000008 /* recovery daemon has banned the node */
679 #define NODE_FLAGS_DELETED 0x00000010 /* this node has been deleted */
680 #define NODE_FLAGS_STOPPED 0x00000020 /* this node has been stopped */
681 #define NODE_FLAGS_DISABLED (NODE_FLAGS_UNHEALTHY|NODE_FLAGS_PERMANENTLY_DISABLED)
682 #define NODE_FLAGS_INACTIVE (NODE_FLAGS_DELETED|NODE_FLAGS_DISCONNECTED|NODE_FLAGS_BANNED|NODE_FLAGS_STOPPED)
687 #define CTDB_CAP_RECMASTER 0x00000001
688 #define CTDB_CAP_LMASTER 0x00000002
689 #define CTDB_CAP_LVS 0x00000004 /* obsolete */
690 #define CTDB_CAP_NATGW 0x00000008 /* obsolete */
695 #define CTDB_CAP_PARALLEL_RECOVERY 0x00010000
696 #define CTDB_CAP_FRAGMENTED_CONTROLS 0x00020000
698 #define CTDB_CAP_FEATURES (CTDB_CAP_PARALLEL_RECOVERY | \
699 CTDB_CAP_FRAGMENTED_CONTROLS)
701 #define CTDB_CAP_DEFAULT (CTDB_CAP_RECMASTER | \
705 struct ctdb_node_and_flags {
711 struct ctdb_node_map {
713 struct ctdb_node_and_flags *node;
717 CTDB_EVENT_INIT, /* CTDB starting up: no args */
718 CTDB_EVENT_SETUP, /* CTDB starting up after transport is readdy: no args. */
719 CTDB_EVENT_STARTUP, /* CTDB starting up after initial recovery: no args. */
720 CTDB_EVENT_START_RECOVERY, /* CTDB recovery starting: no args. */
721 CTDB_EVENT_RECOVERED, /* CTDB recovery finished: no args. */
722 CTDB_EVENT_TAKE_IP, /* IP taken: interface, IP address, netmask bits. */
723 CTDB_EVENT_RELEASE_IP, /* IP released: interface, IP address, netmask bits. */
724 CTDB_EVENT_STOPPED, /* Deprecated, do not use. */
725 CTDB_EVENT_MONITOR, /* Please check if service is healthy: no args. */
726 CTDB_EVENT_STATUS, /* Deprecated, do not use. */
727 CTDB_EVENT_SHUTDOWN, /* CTDB shutting down: no args. */
728 CTDB_EVENT_RELOAD, /* Deprecated, do not use */
729 CTDB_EVENT_UPDATE_IP, /* IP updating: old interface, new interface, IP address, netmask bits. */
730 CTDB_EVENT_IPREALLOCATED, /* when a takeover_run() completes */
734 #define MAX_SCRIPT_NAME 31
735 #define MAX_SCRIPT_OUTPUT 511
738 char name[MAX_SCRIPT_NAME+1];
739 struct timeval start;
740 struct timeval finished;
742 char output[MAX_SCRIPT_OUTPUT+1];
745 struct ctdb_script_list {
746 uint32_t num_scripts;
747 struct ctdb_script *script;
750 struct ctdb_ban_state {
755 struct ctdb_notify_data {
761 #define CTDB_IFACE_SIZE IFNAMSIZ
763 #define CTDB_IFACE_SIZE 16
767 char name[CTDB_IFACE_SIZE+2];
772 struct ctdb_iface_list {
774 struct ctdb_iface *iface;
777 struct ctdb_public_ip_info {
778 struct ctdb_public_ip ip;
780 struct ctdb_iface_list *ifaces;
783 struct ctdb_statistics_list {
785 struct ctdb_statistics *stats;
788 struct ctdb_key_data {
790 struct ctdb_ltdb_header header;
794 struct ctdb_uint8_array {
799 struct ctdb_uint64_array {
804 struct ctdb_db_statistics {
807 uint32_t num_current;
808 uint32_t num_pending;
810 struct ctdb_latency_counter latency;
811 uint32_t buckets[MAX_COUNT_BUCKETS];
814 struct ctdb_latency_counter latency;
816 uint32_t db_ro_delegations;
817 uint32_t db_ro_revokes;
818 uint32_t hop_count_bucket[MAX_COUNT_BUCKETS];
819 uint32_t num_hot_keys;
823 } hot_keys[MAX_HOT_KEYS];
827 CTDB_RUNSTATE_UNKNOWN,
830 CTDB_RUNSTATE_FIRST_RECOVERY,
831 CTDB_RUNSTATE_STARTUP,
832 CTDB_RUNSTATE_RUNNING,
833 CTDB_RUNSTATE_SHUTDOWN,
836 struct ctdb_req_control_data {
841 struct ctdb_vnn_map *vnnmap;
843 struct ctdb_pulldb *pulldb;
844 struct ctdb_pulldb_ext *pulldb_ext;
845 struct ctdb_rec_buffer *recbuf;
848 struct ctdb_traverse_start *traverse_start;
849 struct ctdb_traverse_all *traverse_all;
850 struct ctdb_rec_data *rec_data;
852 struct ctdb_connection *conn;
853 struct ctdb_tunable *tunable;
855 struct ctdb_node_flag_change *flag_change;
856 ctdb_sock_addr *addr;
857 struct ctdb_tickle_list *tickles;
858 struct ctdb_client_id *cid;
859 struct ctdb_addr_info *addr_info;
860 struct ctdb_transdb *transdb;
861 struct ctdb_public_ip *pubip;
862 enum ctdb_event event;
863 double reclock_latency;
865 struct ctdb_ban_state *ban_state;
866 struct ctdb_notify_data *notify;
868 struct ctdb_iface *iface;
869 struct ctdb_key_data *key;
870 struct ctdb_uint64_array *u64_array;
871 struct ctdb_traverse_start_ext *traverse_start_ext;
872 struct ctdb_traverse_all_ext *traverse_all_ext;
876 struct ctdb_reply_control_data {
879 struct ctdb_statistics *stats;
881 struct ctdb_vnn_map *vnnmap;
883 struct ctdb_dbid_map *dbmap;
884 struct ctdb_rec_buffer *recbuf;
889 struct ctdb_var_list *tun_var_list;
890 struct ctdb_tunable_list *tun_list;
891 struct ctdb_tickle_list *tickles;
892 struct ctdb_client_id_map *cid_map;
893 struct ctdb_uptime *uptime;
895 struct ctdb_public_ip_list *pubip_list;
896 struct ctdb_node_map *nodemap;
897 const char *reclock_file;
898 struct ctdb_ban_state *ban_state;
901 struct ctdb_public_ip_info *ipinfo;
902 struct ctdb_iface_list *iface_list;
903 struct ctdb_statistics_list *stats_list;
904 struct ctdb_uint8_array *u8_array;
905 struct ctdb_db_statistics *dbstats;
906 enum ctdb_runstate runstate;
907 uint32_t num_records;
911 struct ctdb_req_control {
916 #define CTDB_CTRL_FLAG_NOREPLY 1
917 #define CTDB_CTRL_FLAG_OPCODE_SPECIFIC 0xFFFF0000
918 /* Ugly overloading of this field... */
919 #define CTDB_PUBLIC_IP_FLAGS_ONLY_AVAILABLE 0x00010000
921 struct ctdb_req_control_data rdata;
924 struct ctdb_reply_control {
927 struct ctdb_reply_control_data rdata;
930 struct ctdb_election_message {
931 uint32_t num_connected;
932 struct timeval priority_time;
937 struct ctdb_srvid_message {
942 struct ctdb_disable_message {
948 union ctdb_message_data {
950 struct ctdb_election_message *election;
951 /* SRVID_RELEASE_IP, SRVID_TAKE_IP */
953 /* SRVID_SET_NODE_FLAGS, SERVID_PUSH_NODE_FLAGS */
954 struct ctdb_node_flag_change *flag_change;
955 /* SRVID_RECD_UPDATE_IP */
956 struct ctdb_public_ip *pubip;
957 /* SRVID_VACUUM_FETCH */
958 struct ctdb_rec_buffer *recbuf;
959 /* SRVID_DETACH_DATABASE */
961 /* SRVID_MEM_DUMP, SRVID_TAKEOVER_RUN */
962 struct ctdb_srvid_message *msg;
963 /* SRVID_BANNING, SRVID_REBALANCE_NODE */
965 /* SRVID_DISABLE_TAKEOVER_RUNS, SRVID_DISABLE_RECOVERIES */
966 struct ctdb_disable_message *disable;
967 /* SRVID_DISABLE_IP_CHECK */
973 struct ctdb_req_message {
975 union ctdb_message_data data;
978 struct ctdb_req_message_data {
983 struct ctdb_req_keepalive {
989 /* This is equivalent to server_id */
990 struct ctdb_server_id {
997 enum ctdb_g_lock_type {
998 CTDB_G_LOCK_READ = 0,
999 CTDB_G_LOCK_WRITE = 1,
1002 struct ctdb_g_lock {
1003 enum ctdb_g_lock_type type;
1004 struct ctdb_server_id sid;
1007 struct ctdb_g_lock_list {
1009 struct ctdb_g_lock *lock;
1016 enum ctdb_event_command {
1017 CTDB_EVENT_COMMAND_RUN = 1,
1018 CTDB_EVENT_COMMAND_STATUS = 2,
1019 CTDB_EVENT_COMMAND_SCRIPT_LIST = 3,
1020 CTDB_EVENT_COMMAND_SCRIPT_ENABLE = 4,
1021 CTDB_EVENT_COMMAND_SCRIPT_DISABLE = 5,
1024 enum ctdb_event_status_state {
1025 CTDB_EVENT_LAST_RUN = 1,
1026 CTDB_EVENT_LAST_PASS = 2,
1027 CTDB_EVENT_LAST_FAIL = 3,
1030 struct ctdb_event_request_run {
1031 enum ctdb_event event;
1033 const char *arg_str;
1036 struct ctdb_event_request_status {
1037 enum ctdb_event event;
1038 enum ctdb_event_status_state state;
1041 struct ctdb_event_request_script_enable {
1042 const char *script_name;
1045 struct ctdb_event_request_script_disable {
1046 const char *script_name;
1049 struct ctdb_event_request_data {
1050 enum ctdb_event_command command;
1052 struct ctdb_event_request_run *run;
1053 struct ctdb_event_request_status *status;
1054 struct ctdb_event_request_script_enable *script_enable;
1055 struct ctdb_event_request_script_disable *script_disable;
1059 struct ctdb_event_reply_status {
1061 struct ctdb_script_list *script_list;
1064 struct ctdb_event_reply_script_list {
1065 struct ctdb_script_list *script_list;
1068 struct ctdb_event_reply_data {
1069 enum ctdb_event_command command;
1072 struct ctdb_event_reply_status *status;
1073 struct ctdb_event_reply_script_list *script_list;
1077 struct ctdb_event_header {
1082 struct ctdb_event_request {
1083 struct ctdb_event_header header;
1084 struct ctdb_event_request_data rdata;
1087 struct ctdb_event_reply {
1088 struct ctdb_event_header header;
1089 struct ctdb_event_reply_data rdata;
1092 #endif /* __CTDB_PROTOCOL_H__ */