?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
smb.conf.5: add clarification how configuration changes reflected by Samba
[Samba.git] / ctdb / protocol / protocol.h
blobe4b76c6b9864524cd523550755ab5e535c6efb77
1 /*
2 CTDB protocol marshalling
3
4 Copyright (C) Amitay Isaacs 2015
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 <tdb.h>
24
25 #define CTDB_MAGIC 0x43544442 /* CTDB */
26 #define CTDB_PROTOCOL 1
27
28 enum ctdb_operation {
29 CTDB_REQ_CALL = 0,
30 CTDB_REPLY_CALL = 1,
31 CTDB_REQ_DMASTER = 2,
32 CTDB_REPLY_DMASTER = 3,
33 CTDB_REPLY_ERROR = 4,
34 CTDB_REQ_MESSAGE = 5,
35 /* #6 removed */
36 CTDB_REQ_CONTROL = 7,
37 CTDB_REPLY_CONTROL = 8,
38 CTDB_REQ_KEEPALIVE = 9,
39 CTDB_REQ_TUNNEL = 10,
40 };
41
42 /* used on the domain socket, send a pdu to the local daemon */
43 #define CTDB_CURRENT_NODE 0xF0000001
44 /* send a broadcast to all nodes in the cluster, active or not */
45 #define CTDB_BROADCAST_ALL 0xF0000002
46 /* send a broadcast to all nodes in the current vnn map */
47 #define CTDB_BROADCAST_ACTIVE 0xF0000003
48 /* send a broadcast to all connected nodes */
49 #define CTDB_BROADCAST_CONNECTED 0xF0000004
50 /* send a broadcast to selected connected nodes */
51 #define CTDB_MULTICAST 0xF0000005
52
53 #define CTDB_UNKNOWN_PNN 0xFFFFFFFF
54
55 /* the key used to store persistent db sequence number */
56 #define CTDB_DB_SEQNUM_KEY "__db_sequence_number__"
57
58 struct ctdb_req_header {
59 uint32_t length;
60 uint32_t ctdb_magic;
61 uint32_t ctdb_version;
62 uint32_t generation;
63 uint32_t operation;
64 uint32_t destnode;
65 uint32_t srcnode;
66 uint32_t reqid;
67 };
68
69 struct ctdb_req_call {
70 uint32_t flags;
71 uint32_t db_id;
72 uint32_t callid;
73 uint32_t hopcount;
74 TDB_DATA key;
75 TDB_DATA calldata;
76 };
77
78 struct ctdb_reply_call {
79 int32_t status;
80 TDB_DATA data;
81 };
82
83 struct ctdb_reply_error {
84 int32_t status;
85 TDB_DATA msg;
86 };
87
88 struct ctdb_req_dmaster {
89 uint32_t db_id;
90 uint64_t rsn;
91 uint32_t dmaster;
92 TDB_DATA key;
93 TDB_DATA data;
94 };
95
96 struct ctdb_reply_dmaster {
97 uint32_t db_id;
98 uint64_t rsn;
99 TDB_DATA key;
100 TDB_DATA data;
101 };
102
103 #define CTDB_NULL_FUNC 0xFF000001
104 #define CTDB_FETCH_FUNC 0xFF000002
105 #define CTDB_FETCH_WITH_HEADER_FUNC 0xFF000003
106
107 struct ctdb_call {
108 int call_id;
109 TDB_DATA key;
110 TDB_DATA call_data;
111 TDB_DATA reply_data;
112 uint32_t status;
113 #define CTDB_IMMEDIATE_MIGRATION 0x00000001
114 #define CTDB_CALL_FLAG_VACUUM_MIGRATION 0x00000002
115 #define CTDB_WANT_READONLY 0x00000004
116 uint32_t flags;
117 };
118
119 /* SRVID to catch all messages */
120 #define CTDB_SRVID_ALL (~(uint64_t)0)
121
122 /* SRVID prefix used during recovery for pulling and pushing databases */
123 #define CTDB_SRVID_RECOVERY 0xF001000000000000LL
124
125 /* SRVID to assign of banning credits */
126 #define CTDB_SRVID_BANNING 0xF002000000000000LL
127
128 /* SRVID to inform of election data */
129 #define CTDB_SRVID_ELECTION 0xF100000000000000LL
130
131 /* SRVID to inform clients that the cluster has been reconfigured */
132 #define CTDB_SRVID_RECONFIGURE 0xF200000000000000LL
133
134 /* SRVID to inform clients an IP address has been released */
135 #define CTDB_SRVID_RELEASE_IP 0xF300000000000000LL
136
137 /* SRVID to inform clients that an IP address has been taken over */
138 #define CTDB_SRVID_TAKE_IP 0xF301000000000000LL
139
140 /* SRVID to inform recovery daemon of the node flags */
141 #define CTDB_SRVID_SET_NODE_FLAGS 0xF400000000000000LL
142
143 /* SRVID to inform recovery daemon to update public ip assignment */
144 #define CTDB_SRVID_RECD_UPDATE_IP 0xF500000000000000LL
145
146 /* SRVID to inform recovery daemon to migrate a set of records */
147 #define CTDB_SRVID_VACUUM_FETCH 0xF700000000000000LL
148
149 /* SRVID to inform recovery daemon to detach a database */
150 #define CTDB_SRVID_DETACH_DATABASE 0xF701000000000000LL
151
152 /* SRVID to inform recovery daemon to dump talloc memdump to the log */
153 #define CTDB_SRVID_MEM_DUMP 0xF800000000000000LL
154
155 /* SRVID to inform recovery daemon to send logs */
156 #define CTDB_SRVID_GETLOG 0xF801000000000000LL
157
158 /* SRVID to inform recovery daemon to clear logs */
159 #define CTDB_SRVID_CLEARLOG 0xF802000000000000LL
160
161 /* SRVID to inform recovery daemon to push the node flags to other nodes */
162 #define CTDB_SRVID_PUSH_NODE_FLAGS 0xF900000000000000LL
163
164 /* SRVID to inform recovery daemon to reload the nodes file */
165 #define CTDB_SRVID_RELOAD_NODES 0xFA00000000000000LL
166
167 /* SRVID to inform recovery daemon to perform a takeover run */
168 #define CTDB_SRVID_TAKEOVER_RUN 0xFB00000000000000LL
169
170 /* SRVID to inform recovery daemon to rebalance ips for a node. */
171 #define CTDB_SRVID_REBALANCE_NODE 0xFB01000000000000LL
172
173 /* SRVID to inform recovery daemon to stop takeover runs from occurring */
174 #define CTDB_SRVID_DISABLE_TAKEOVER_RUNS 0xFB03000000000000LL
175
176 /* SRVID to inform recovery daemon to stop recoveries from occurring */
177 #define CTDB_SRVID_DISABLE_RECOVERIES 0xFB04000000000000LL
178
179 /* SRVID to inform recovery daemon to disable the public ip checks */
180 #define CTDB_SRVID_DISABLE_IP_CHECK 0xFC00000000000000LL
181
182 /* A range of ports reserved for registering a PID (top 8 bits)
183 * All ports matching the 8 top bits are reserved for exclusive use by
184 * registering a SRVID that matches the process-id of the requesting process
185 */
186 #define CTDB_SRVID_PID_RANGE 0x0000000000000000LL
187
188 /* A range of ports reserved for samba (top 8 bits)
189 * All ports matching the 8 top bits are reserved for exclusive use by
190 * CIFS server
191 */
192 #define CTDB_SRVID_SAMBA_NOTIFY 0xFE00000000000000LL
193 #define CTDB_SRVID_SAMBA_RANGE 0xFE00000000000000LL
194
195 /* A range of ports reserved for a CTDB NFS server (top 8 bits)
196 * All ports matching the 8 top bits are reserved for exclusive use by
197 * NFS server
198 */
199 #define CTDB_SRVID_NFSD_RANGE 0xEE00000000000000LL
200
201 /* A range of ports reserved for a CTDB ISCSI server (top 8 bits)
202 * All ports matching the 8 top bits are reserved for exclusive use by
203 * ISCSI server
204 */
205 #define CTDB_SRVID_ISCSID_RANGE 0xDE00000000000000LL
206
207 /* A range of ports reserved for CTDB tool (top 8 bits)
208 * All ports matching the 8 top bits are reserved for exclusive use by
209 * CTDB tool
210 */
211 #define CTDB_SRVID_TOOL_RANGE 0xCE00000000000000LL
212
213 /* A range of ports reserved by client (top 8 bits)
214 * All ports matching the 8 top bits are reserved for exclusive use by
215 * CTDB client code
216 */
217 #define CTDB_SRVID_CLIENT_RANGE 0xBE00000000000000LL
218
219 /* Range of ports reserved for test applications (top 8 bits)
220 * All ports matching the 8 top bits are reserved for exclusive use by
221 * test applications
222 */
223 #define CTDB_SRVID_TEST_RANGE 0xAE00000000000000LL
224
225
226 enum ctdb_controls {CTDB_CONTROL_PROCESS_EXISTS = 0,
227 CTDB_CONTROL_STATISTICS = 1,
228 /* #2 removed */
229 CTDB_CONTROL_PING = 3,
230 CTDB_CONTROL_GETDBPATH = 4,
231 CTDB_CONTROL_GETVNNMAP = 5,
232 CTDB_CONTROL_SETVNNMAP = 6,
233 CTDB_CONTROL_GET_DEBUG = 7,
234 CTDB_CONTROL_SET_DEBUG = 8,
235 CTDB_CONTROL_GET_DBMAP = 9,
236 CTDB_CONTROL_GET_NODEMAPv4 = 10, /* obsolete */
237 CTDB_CONTROL_SET_DMASTER = 11, /* obsolete */
238 /* #12 removed */
239 CTDB_CONTROL_PULL_DB = 13, /* obsolete */
240 CTDB_CONTROL_PUSH_DB = 14, /* obsolete */
241 CTDB_CONTROL_GET_RECMODE = 15,
242 CTDB_CONTROL_SET_RECMODE = 16,
243 CTDB_CONTROL_STATISTICS_RESET = 17,
244 CTDB_CONTROL_DB_ATTACH = 18,
245 CTDB_CONTROL_SET_CALL = 19, /* obsolete */
246 CTDB_CONTROL_TRAVERSE_START = 20,
247 CTDB_CONTROL_TRAVERSE_ALL = 21,
248 CTDB_CONTROL_TRAVERSE_DATA = 22,
249 CTDB_CONTROL_REGISTER_SRVID = 23,
250 CTDB_CONTROL_DEREGISTER_SRVID = 24,
251 CTDB_CONTROL_GET_DBNAME = 25,
252 CTDB_CONTROL_ENABLE_SEQNUM = 26,
253 CTDB_CONTROL_UPDATE_SEQNUM = 27,
254 /* #28 removed */
255 CTDB_CONTROL_DUMP_MEMORY = 29,
256 CTDB_CONTROL_GET_PID = 30,
257 CTDB_CONTROL_GET_RECMASTER = 31,
258 CTDB_CONTROL_SET_RECMASTER = 32,
259 CTDB_CONTROL_FREEZE = 33,
260 CTDB_CONTROL_THAW = 34, /* obsolete */
261 CTDB_CONTROL_GET_PNN = 35,
262 CTDB_CONTROL_SHUTDOWN = 36,
263 CTDB_CONTROL_GET_MONMODE = 37, /* obsolete */
264 /* #38 removed */
265 /* #39 removed */
266 /* #40 removed */
267 /* #41 removed */
268 CTDB_CONTROL_TAKEOVER_IPv4 = 42, /* obsolete */
269 CTDB_CONTROL_RELEASE_IPv4 = 43, /* obsolete */
270 CTDB_CONTROL_TCP_CLIENT = 44,
271 CTDB_CONTROL_TCP_ADD = 45,
272 CTDB_CONTROL_TCP_REMOVE = 46,
273 CTDB_CONTROL_STARTUP = 47,
274 CTDB_CONTROL_SET_TUNABLE = 48,
275 CTDB_CONTROL_GET_TUNABLE = 49,
276 CTDB_CONTROL_LIST_TUNABLES = 50,
277 CTDB_CONTROL_GET_PUBLIC_IPSv4 = 51, /* obsolete */
278 CTDB_CONTROL_MODIFY_FLAGS = 52,
279 CTDB_CONTROL_GET_ALL_TUNABLES = 53,
280 CTDB_CONTROL_KILL_TCP = 54, /* obsolete */
281 CTDB_CONTROL_GET_TCP_TICKLE_LIST = 55,
282 CTDB_CONTROL_SET_TCP_TICKLE_LIST = 56,
283 CTDB_CONTROL_REGISTER_SERVER_ID = 57, /* obsolete */
284 CTDB_CONTROL_UNREGISTER_SERVER_ID = 58, /* obsolete */
285 CTDB_CONTROL_CHECK_SERVER_ID = 59, /* obsolete */
286 CTDB_CONTROL_GET_SERVER_ID_LIST = 60, /* obsolete */
287 CTDB_CONTROL_DB_ATTACH_PERSISTENT = 61,
288 CTDB_CONTROL_PERSISTENT_STORE = 62, /* obsolete */
289 CTDB_CONTROL_UPDATE_RECORD = 63,
290 CTDB_CONTROL_SEND_GRATUITOUS_ARP = 64,
291 CTDB_CONTROL_TRANSACTION_START = 65, /* obsolete */
292 CTDB_CONTROL_TRANSACTION_COMMIT = 66, /* obsolete */
293 CTDB_CONTROL_WIPE_DATABASE = 67,
294 /* #68 removed */
295 CTDB_CONTROL_UPTIME = 69,
296 CTDB_CONTROL_START_RECOVERY = 70,
297 CTDB_CONTROL_END_RECOVERY = 71,
298 CTDB_CONTROL_RELOAD_NODES_FILE = 72,
299 /* #73 removed */
300 CTDB_CONTROL_TRY_DELETE_RECORDS = 74,
301 CTDB_CONTROL_ENABLE_MONITOR = 75, /* obsolete */
302 CTDB_CONTROL_DISABLE_MONITOR = 76, /* obsolete */
303 CTDB_CONTROL_ADD_PUBLIC_IP = 77,
304 CTDB_CONTROL_DEL_PUBLIC_IP = 78,
305 CTDB_CONTROL_RUN_EVENTSCRIPTS = 79, /* obsolete */
306 CTDB_CONTROL_GET_CAPABILITIES = 80,
307 CTDB_CONTROL_START_PERSISTENT_UPDATE = 81, /* obsolete */
308 CTDB_CONTROL_CANCEL_PERSISTENT_UPDATE= 82, /* obsolete */
309 CTDB_CONTROL_TRANS2_COMMIT = 83, /* obsolete */
310 CTDB_CONTROL_TRANS2_FINISHED = 84, /* obsolete */
311 CTDB_CONTROL_TRANS2_ERROR = 85, /* obsolete */
312 CTDB_CONTROL_TRANS2_COMMIT_RETRY = 86, /* obsolete */
313 CTDB_CONTROL_RECD_PING = 87,
314 CTDB_CONTROL_RELEASE_IP = 88,
315 CTDB_CONTROL_TAKEOVER_IP = 89,
316 CTDB_CONTROL_GET_PUBLIC_IPS = 90,
317 CTDB_CONTROL_GET_NODEMAP = 91,
318 /* missing */
319 CTDB_CONTROL_GET_EVENT_SCRIPT_STATUS = 96, /* obsolete */
320 CTDB_CONTROL_TRAVERSE_KILL = 97,
321 CTDB_CONTROL_RECD_RECLOCK_LATENCY = 98,
322 CTDB_CONTROL_GET_RECLOCK_FILE = 99,
323 CTDB_CONTROL_SET_RECLOCK_FILE = 100, /* obsolete */
324 CTDB_CONTROL_STOP_NODE = 101,
325 CTDB_CONTROL_CONTINUE_NODE = 102,
326 CTDB_CONTROL_SET_NATGWSTATE = 103, /* obsolete */
327 CTDB_CONTROL_SET_LMASTERROLE = 104,
328 CTDB_CONTROL_SET_RECMASTERROLE = 105,
329 CTDB_CONTROL_ENABLE_SCRIPT = 107, /* obsolete */
330 CTDB_CONTROL_DISABLE_SCRIPT = 108, /* obsolete */
331 CTDB_CONTROL_SET_BAN_STATE = 109,
332 CTDB_CONTROL_GET_BAN_STATE = 110,
333 CTDB_CONTROL_SET_DB_PRIORITY = 111, /* obsolete */
334 CTDB_CONTROL_GET_DB_PRIORITY = 112, /* obsolete */
335 CTDB_CONTROL_TRANSACTION_CANCEL = 113, /* obsolete */
336 CTDB_CONTROL_REGISTER_NOTIFY = 114,
337 CTDB_CONTROL_DEREGISTER_NOTIFY = 115,
338 CTDB_CONTROL_TRANS2_ACTIVE = 116, /* obsolete */
339 CTDB_CONTROL_GET_LOG = 117, /* obsolete */
340 CTDB_CONTROL_CLEAR_LOG = 118, /* obsolete */
341 CTDB_CONTROL_TRANS3_COMMIT = 119,
342 CTDB_CONTROL_GET_DB_SEQNUM = 120,
343 CTDB_CONTROL_DB_SET_HEALTHY = 121,
344 CTDB_CONTROL_DB_GET_HEALTH = 122,
345 CTDB_CONTROL_GET_PUBLIC_IP_INFO = 123,
346 CTDB_CONTROL_GET_IFACES = 124,
347 CTDB_CONTROL_SET_IFACE_LINK_STATE = 125,
348 CTDB_CONTROL_TCP_ADD_DELAYED_UPDATE = 126,
349 CTDB_CONTROL_GET_STAT_HISTORY = 127,
350 CTDB_CONTROL_SCHEDULE_FOR_DELETION = 128,
351 CTDB_CONTROL_SET_DB_READONLY = 129,
352 CTDB_CONTROL_CHECK_SRVIDS = 130, /* obsolete */
353 CTDB_CONTROL_TRAVERSE_START_EXT = 131,
354 CTDB_CONTROL_GET_DB_STATISTICS = 132,
355 CTDB_CONTROL_SET_DB_STICKY = 133,
356 CTDB_CONTROL_RELOAD_PUBLIC_IPS = 134,
357 CTDB_CONTROL_TRAVERSE_ALL_EXT = 135,
358 CTDB_CONTROL_RECEIVE_RECORDS = 136, /* obsolete */
359 CTDB_CONTROL_IPREALLOCATED = 137,
360 CTDB_CONTROL_GET_RUNSTATE = 138,
361 CTDB_CONTROL_DB_DETACH = 139,
362 CTDB_CONTROL_GET_NODES_FILE = 140,
363 CTDB_CONTROL_DB_FREEZE = 141,
364 CTDB_CONTROL_DB_THAW = 142,
365 CTDB_CONTROL_DB_TRANSACTION_START = 143,
366 CTDB_CONTROL_DB_TRANSACTION_COMMIT = 144,
367 CTDB_CONTROL_DB_TRANSACTION_CANCEL = 145,
368 CTDB_CONTROL_DB_PULL = 146,
369 CTDB_CONTROL_DB_PUSH_START = 147,
370 CTDB_CONTROL_DB_PUSH_CONFIRM = 148,
371 CTDB_CONTROL_DB_OPEN_FLAGS = 149,
372 CTDB_CONTROL_DB_ATTACH_REPLICATED = 150,
373 CTDB_CONTROL_CHECK_PID_SRVID = 151,
374 CTDB_CONTROL_TUNNEL_REGISTER = 152,
375 CTDB_CONTROL_TUNNEL_DEREGISTER = 153,
376 CTDB_CONTROL_VACUUM_FETCH = 154,
377 CTDB_CONTROL_DB_VACUUM = 155,
378 CTDB_CONTROL_ECHO_DATA = 156,
379 };
380
381 #define MAX_COUNT_BUCKETS 16
382 #define MAX_HOT_KEYS 10
383
384 struct ctdb_latency_counter {
385 int num;
386 double min;
387 double max;
388 double total;
389 };
390
391 struct ctdb_statistics {
392 uint32_t num_clients;
393 uint32_t frozen;
394 uint32_t recovering;
395 uint32_t client_packets_sent;
396 uint32_t client_packets_recv;
397 uint32_t node_packets_sent;
398 uint32_t node_packets_recv;
399 uint32_t keepalive_packets_sent;
400 uint32_t keepalive_packets_recv;
401 struct {
402 uint32_t req_call;
403 uint32_t reply_call;
404 uint32_t req_dmaster;
405 uint32_t reply_dmaster;
406 uint32_t reply_error;
407 uint32_t req_message;
408 uint32_t req_control;
409 uint32_t reply_control;
410 uint32_t req_tunnel;
411 } node;
412 struct {
413 uint32_t req_call;
414 uint32_t req_message;
415 uint32_t req_control;
416 uint32_t req_tunnel;
417 } client;
418 struct {
419 uint32_t call;
420 uint32_t control;
421 uint32_t traverse;
422 } timeouts;
423 struct {
424 struct ctdb_latency_counter ctdbd;
425 struct ctdb_latency_counter recd;
426 } reclock;
427 struct {
428 uint32_t num_calls;
429 uint32_t num_current;
430 uint32_t num_pending;
431 uint32_t num_failed;
432 struct ctdb_latency_counter latency;
433 uint32_t buckets[MAX_COUNT_BUCKETS];
434 } locks;
435 uint32_t total_calls;
436 uint32_t pending_calls;
437 uint32_t childwrite_calls;
438 uint32_t pending_childwrite_calls;
439 uint32_t memory_used;
440 uint32_t __last_counter; /* hack */
441 uint32_t max_hop_count;
442 uint32_t hop_count_bucket[MAX_COUNT_BUCKETS];
443 struct ctdb_latency_counter call_latency;
444 struct ctdb_latency_counter childwrite_latency;
445 uint32_t num_recoveries;
446 struct timeval statistics_start_time;
447 struct timeval statistics_current_time;
448 uint32_t total_ro_delegations;
449 uint32_t total_ro_revokes;
450 };
451
452 #define INVALID_GENERATION 1
453 /* table that contains the mapping between a hash value and lmaster
454 */
455 struct ctdb_vnn_map {
456 uint32_t generation;
457 uint32_t size;
458 uint32_t *map;
459 };
460
461 struct ctdb_dbid {
462 uint32_t db_id;
463 #define CTDB_DB_FLAGS_PERSISTENT 0x01
464 #define CTDB_DB_FLAGS_READONLY 0x02
465 #define CTDB_DB_FLAGS_STICKY 0x04
466 #define CTDB_DB_FLAGS_REPLICATED 0x08
467 uint8_t flags;
468 };
469
470 struct ctdb_dbid_map {
471 uint32_t num;
472 struct ctdb_dbid *dbs;
473 };
474
475 struct ctdb_pulldb {
476 uint32_t db_id;
477 #define CTDB_LMASTER_ANY 0xffffffff
478 uint32_t lmaster;
479 };
480
481 struct ctdb_pulldb_ext {
482 uint32_t db_id;
483 uint32_t lmaster;
484 uint64_t srvid;
485 };
486
487 #define CTDB_RECOVERY_NORMAL 0
488 #define CTDB_RECOVERY_ACTIVE 1
489
490 /*
491 the extended header for records in the ltdb
492 */
493 struct ctdb_ltdb_header {
494 uint64_t rsn;
495 uint32_t dmaster;
496 uint32_t reserved1;
497 #define CTDB_REC_FLAG_DEFAULT 0x00000000
498 #define CTDB_REC_FLAG_MIGRATED_WITH_DATA 0x00010000
499 #define CTDB_REC_FLAG_VACUUM_MIGRATED 0x00020000
500 #define CTDB_REC_FLAG_AUTOMATIC 0x00040000
501 #define CTDB_REC_RO_HAVE_DELEGATIONS 0x01000000
502 #define CTDB_REC_RO_HAVE_READONLY 0x02000000
503 #define CTDB_REC_RO_REVOKING_READONLY 0x04000000
504 #define CTDB_REC_RO_REVOKE_COMPLETE 0x08000000
505 #define CTDB_REC_RO_FLAGS (CTDB_REC_RO_HAVE_DELEGATIONS|\
506 CTDB_REC_RO_HAVE_READONLY|\
507 CTDB_REC_RO_REVOKING_READONLY|\
508 CTDB_REC_RO_REVOKE_COMPLETE)
509 uint32_t flags;
510 };
511
512 struct ctdb_rec_data {
513 uint32_t reqid;
514 struct ctdb_ltdb_header *header;
515 TDB_DATA key, data;
516 };
517
518 struct ctdb_rec_buffer {
519 uint32_t db_id;
520 uint32_t count;
521 uint8_t *buf;
522 size_t buflen;
523 };
524
525 typedef int (*ctdb_rec_parser_func_t)(uint32_t reqid,
526 struct ctdb_ltdb_header *header,
527 TDB_DATA key, TDB_DATA data,
528 void *private_data);
529
530 struct ctdb_traverse_start {
531 uint32_t db_id;
532 uint32_t reqid;
533 uint64_t srvid;
534 };
535
536 struct ctdb_traverse_all {
537 uint32_t db_id;
538 uint32_t reqid;
539 uint32_t pnn;
540 uint32_t client_reqid;
541 uint64_t srvid;
542 };
543
544 struct ctdb_traverse_start_ext {
545 uint32_t db_id;
546 uint32_t reqid;
547 uint64_t srvid;
548 bool withemptyrecords;
549 };
550
551 struct ctdb_traverse_all_ext {
552 uint32_t db_id;
553 uint32_t reqid;
554 uint32_t pnn;
555 uint32_t client_reqid;
556 uint64_t srvid;
557 bool withemptyrecords;
558 };
559
560 typedef union {
561 struct sockaddr sa;
562 struct sockaddr_in ip;
563 struct sockaddr_in6 ip6;
564 } ctdb_sock_addr;
565
566 struct ctdb_connection {
567 union {
568 ctdb_sock_addr src;
569 ctdb_sock_addr server;
570 };
571 union {
572 ctdb_sock_addr dst;
573 ctdb_sock_addr client;
574 };
575 };
576
577 struct ctdb_connection_list {
578 uint32_t num;
579 struct ctdb_connection *conn;
580 };
581
582 struct ctdb_tunable {
583 const char *name;
584 uint32_t value;
585 };
586
587 struct ctdb_var_list {
588 int count;
589 const char **var;
590 };
591
592 struct ctdb_node_flag_change {
593 uint32_t pnn;
594 uint32_t new_flags;
595 uint32_t old_flags;
596 };
597
598 /* all tunable variables go in here */
599 struct ctdb_tunable_list {
600 uint32_t max_redirect_count;
601 uint32_t seqnum_interval; /* unit is ms */
602 uint32_t control_timeout;
603 uint32_t traverse_timeout;
604 uint32_t keepalive_interval;
605 uint32_t keepalive_limit;
606 uint32_t recover_timeout;
607 uint32_t recover_interval;
608 uint32_t election_timeout;
609 uint32_t takeover_timeout;
610 uint32_t monitor_interval;
611 uint32_t tickle_update_interval;
612 uint32_t script_timeout;
613 uint32_t monitor_timeout_count; /* allow dodgy scripts to hang this many times in a row before we mark the node unhealthy */
614 uint32_t script_unhealthy_on_timeout; /* obsolete */
615 uint32_t recovery_grace_period;
616 uint32_t recovery_ban_period;
617 uint32_t database_hash_size;
618 uint32_t database_max_dead;
619 uint32_t rerecovery_timeout;
620 uint32_t enable_bans;
621 uint32_t deterministic_public_ips;
622 uint32_t reclock_ping_period;
623 uint32_t no_ip_failback;
624 uint32_t disable_ip_failover;
625 uint32_t verbose_memory_names;
626 uint32_t recd_ping_timeout;
627 uint32_t recd_ping_failcount;
628 uint32_t log_latency_ms;
629 uint32_t reclock_latency_ms;
630 uint32_t recovery_drop_all_ips;
631 uint32_t verify_recovery_lock;
632 uint32_t vacuum_interval;
633 uint32_t vacuum_max_run_time;
634 uint32_t repack_limit;
635 uint32_t vacuum_limit;
636 uint32_t max_queue_depth_drop_msg;
637 uint32_t allow_unhealthy_db_read;
638 uint32_t stat_history_interval;
639 uint32_t deferred_attach_timeout;
640 uint32_t vacuum_fast_path_count;
641 uint32_t lcp2_public_ip_assignment;
642 uint32_t allow_client_db_attach;
643 uint32_t recover_pdb_by_seqnum;
644 uint32_t deferred_rebalance_on_node_add;
645 uint32_t fetch_collapse;
646 uint32_t hopcount_make_sticky;
647 uint32_t sticky_duration;
648 uint32_t sticky_pindown;
649 uint32_t no_ip_takeover;
650 uint32_t db_record_count_warn;
651 uint32_t db_record_size_warn;
652 uint32_t db_size_warn;
653 uint32_t pulldb_preallocation_size;
654 uint32_t no_ip_host_on_all_disabled;
655 uint32_t samba3_hack;
656 uint32_t mutex_enabled;
657 uint32_t lock_processes_per_db;
658 uint32_t rec_buffer_size_limit;
659 uint32_t queue_buffer_size;
660 uint32_t ip_alloc_algorithm;
661 uint32_t allow_mixed_versions;
662 };
663
664 struct ctdb_tickle_list {
665 ctdb_sock_addr addr;
666 uint32_t num;
667 struct ctdb_connection *conn;
668 };
669
670 struct ctdb_addr_info {
671 ctdb_sock_addr addr;
672 uint32_t mask;
673 const char *iface;
674 };
675
676 struct ctdb_transdb {
677 uint32_t db_id;
678 uint32_t tid;
679 };
680
681 struct ctdb_uptime {
682 struct timeval current_time;
683 struct timeval ctdbd_start_time;
684 struct timeval last_recovery_started;
685 struct timeval last_recovery_finished;
686 };
687
688 struct ctdb_public_ip {
689 uint32_t pnn;
690 ctdb_sock_addr addr;
691 };
692
693 struct ctdb_public_ip_list {
694 uint32_t num;
695 struct ctdb_public_ip *ip;
696 };
697
698 /*
699 * Node flags
700 */
701 #define NODE_FLAGS_DISCONNECTED 0x00000001 /* node isn't connected */
702 #define NODE_FLAGS_UNHEALTHY 0x00000002 /* monitoring says node is unhealthy */
703 #define NODE_FLAGS_PERMANENTLY_DISABLED 0x00000004 /* administrator has disabled node */
704 #define NODE_FLAGS_BANNED 0x00000008 /* recovery daemon has banned the node */
705 #define NODE_FLAGS_DELETED 0x00000010 /* this node has been deleted */
706 #define NODE_FLAGS_STOPPED 0x00000020 /* this node has been stopped */
707 #define NODE_FLAGS_DISABLED (NODE_FLAGS_UNHEALTHY|NODE_FLAGS_PERMANENTLY_DISABLED)
708 #define NODE_FLAGS_INACTIVE (NODE_FLAGS_DELETED|NODE_FLAGS_DISCONNECTED|NODE_FLAGS_BANNED|NODE_FLAGS_STOPPED)
709
710 /*
711 * Node capabilities
712 */
713 #define CTDB_CAP_RECMASTER 0x00000001
714 #define CTDB_CAP_LMASTER 0x00000002
715 #define CTDB_CAP_LVS 0x00000004 /* obsolete */
716 #define CTDB_CAP_NATGW 0x00000008 /* obsolete */
717
718 /*
719 * Node features
720 */
721 #define CTDB_CAP_PARALLEL_RECOVERY 0x00010000
722 #define CTDB_CAP_FRAGMENTED_CONTROLS 0x00020000
723
724 #define CTDB_CAP_FEATURES (CTDB_CAP_PARALLEL_RECOVERY | \
725 CTDB_CAP_FRAGMENTED_CONTROLS)
726
727 #define CTDB_CAP_DEFAULT (CTDB_CAP_RECMASTER | \
728 CTDB_CAP_LMASTER | \
729 CTDB_CAP_FEATURES)
730
731 struct ctdb_node_and_flags {
732 uint32_t pnn;
733 uint32_t flags;
734 ctdb_sock_addr addr;
735 };
736
737 struct ctdb_node_map {
738 uint32_t num;
739 struct ctdb_node_and_flags *node;
740 };
741
742 enum ctdb_event {
743 CTDB_EVENT_INIT, /* CTDB starting up: no args */
744 CTDB_EVENT_SETUP, /* CTDB starting up after transport is readdy: no args. */
745 CTDB_EVENT_STARTUP, /* CTDB starting up after initial recovery: no args. */
746 CTDB_EVENT_START_RECOVERY, /* CTDB recovery starting: no args. */
747 CTDB_EVENT_RECOVERED, /* CTDB recovery finished: no args. */
748 CTDB_EVENT_TAKE_IP, /* IP taken: interface, IP address, netmask bits. */
749 CTDB_EVENT_RELEASE_IP, /* IP released: interface, IP address, netmask bits. */
750 CTDB_EVENT_STOPPED, /* Deprecated, do not use. */
751 CTDB_EVENT_MONITOR, /* Please check if service is healthy: no args. */
752 CTDB_EVENT_STATUS, /* Deprecated, do not use. */
753 CTDB_EVENT_SHUTDOWN, /* CTDB shutting down: no args. */
754 CTDB_EVENT_RELOAD, /* Deprecated, do not use */
755 CTDB_EVENT_UPDATE_IP, /* IP updating: old interface, new interface, IP address, netmask bits. */
756 CTDB_EVENT_IPREALLOCATED, /* when a takeover_run() completes */
757 CTDB_EVENT_MAX
758 };
759
760 #define MAX_SCRIPT_NAME 31
761 #define MAX_SCRIPT_OUTPUT 511
762
763 struct ctdb_script {
764 char name[MAX_SCRIPT_NAME+1];
765 struct timeval start;
766 struct timeval finished;
767 int32_t status;
768 char output[MAX_SCRIPT_OUTPUT+1];
769 };
770
771 struct ctdb_script_list {
772 uint32_t num_scripts;
773 struct ctdb_script *script;
774 };
775
776 struct ctdb_ban_state {
777 uint32_t pnn;
778 uint32_t time;
779 };
780
781 struct ctdb_notify_data {
782 uint64_t srvid;
783 TDB_DATA data;
784 };
785
786 #ifdef IFNAMSIZ
787 #define CTDB_IFACE_SIZE IFNAMSIZ
788 #else
789 #define CTDB_IFACE_SIZE 16
790 #endif
791
792 struct ctdb_iface {
793 char name[CTDB_IFACE_SIZE+2];
794 uint16_t link_state;
795 uint32_t references;
796 };
797
798 struct ctdb_iface_list {
799 uint32_t num;
800 struct ctdb_iface *iface;
801 };
802
803 struct ctdb_public_ip_info {
804 struct ctdb_public_ip ip;
805 uint32_t active_idx;
806 struct ctdb_iface_list *ifaces;
807 };
808
809 struct ctdb_statistics_list {
810 int num;
811 struct ctdb_statistics *stats;
812 };
813
814 struct ctdb_key_data {
815 uint32_t db_id;
816 struct ctdb_ltdb_header header;
817 TDB_DATA key;
818 };
819
820 struct ctdb_db_statistics {
821 struct {
822 uint32_t num_calls;
823 uint32_t num_current;
824 uint32_t num_pending;
825 uint32_t num_failed;
826 struct ctdb_latency_counter latency;
827 uint32_t buckets[MAX_COUNT_BUCKETS];
828 } locks;
829 struct {
830 struct ctdb_latency_counter latency;
831 } vacuum;
832 uint32_t db_ro_delegations;
833 uint32_t db_ro_revokes;
834 uint32_t hop_count_bucket[MAX_COUNT_BUCKETS];
835 uint32_t num_hot_keys;
836 struct {
837 uint32_t count;
838 TDB_DATA key;
839 } hot_keys[MAX_HOT_KEYS];
840 };
841
842 enum ctdb_runstate {
843 CTDB_RUNSTATE_UNKNOWN,
844 CTDB_RUNSTATE_INIT,
845 CTDB_RUNSTATE_SETUP,
846 CTDB_RUNSTATE_FIRST_RECOVERY,
847 CTDB_RUNSTATE_STARTUP,
848 CTDB_RUNSTATE_RUNNING,
849 CTDB_RUNSTATE_SHUTDOWN,
850 };
851
852 struct ctdb_pid_srvid {
853 pid_t pid;
854 uint64_t srvid;
855 };
856
857 struct ctdb_db_vacuum {
858 uint32_t db_id;
859 bool full_vacuum_run;
860
861 };
862
863 struct ctdb_echo_data {
864 uint32_t timeout;
865 TDB_DATA buf;
866 };
867
868 struct ctdb_req_control_data {
869 uint32_t opcode;
870 union {
871 pid_t pid;
872 uint32_t db_id;
873 struct ctdb_vnn_map *vnnmap;
874 uint32_t loglevel;
875 struct ctdb_pulldb *pulldb;
876 struct ctdb_pulldb_ext *pulldb_ext;
877 struct ctdb_rec_buffer *recbuf;
878 uint32_t recmode;
879 const char *db_name;
880 struct ctdb_traverse_start *traverse_start;
881 struct ctdb_traverse_all *traverse_all;
882 struct ctdb_rec_data *rec_data;
883 uint32_t recmaster;
884 struct ctdb_connection *conn;
885 struct ctdb_tunable *tunable;
886 const char *tun_var;
887 struct ctdb_node_flag_change *flag_change;
888 ctdb_sock_addr *addr;
889 struct ctdb_tickle_list *tickles;
890 struct ctdb_client_id *cid;
891 struct ctdb_addr_info *addr_info;
892 struct ctdb_transdb *transdb;
893 struct ctdb_public_ip *pubip;
894 enum ctdb_event event;
895 double reclock_latency;
896 uint32_t role;
897 struct ctdb_ban_state *ban_state;
898 struct ctdb_notify_data *notify;
899 uint64_t srvid;
900 struct ctdb_iface *iface;
901 struct ctdb_key_data *key;
902 struct ctdb_traverse_start_ext *traverse_start_ext;
903 struct ctdb_traverse_all_ext *traverse_all_ext;
904 struct ctdb_pid_srvid *pid_srvid;
905 struct ctdb_db_vacuum *db_vacuum;
906 struct ctdb_echo_data *echo_data;
907 } data;
908 };
909
910 struct ctdb_reply_control_data {
911 uint32_t opcode;
912 union {
913 struct ctdb_statistics *stats;
914 const char *db_path;
915 struct ctdb_vnn_map *vnnmap;
916 uint32_t loglevel;
917 struct ctdb_dbid_map *dbmap;
918 struct ctdb_rec_buffer *recbuf;
919 uint32_t db_id;
920 const char *db_name;
921 const char *mem_str;
922 uint32_t tun_value;
923 struct ctdb_var_list *tun_var_list;
924 struct ctdb_tunable_list *tun_list;
925 struct ctdb_tickle_list *tickles;
926 struct ctdb_client_id_map *cid_map;
927 struct ctdb_uptime *uptime;
928 uint32_t caps;
929 struct ctdb_public_ip_list *pubip_list;
930 struct ctdb_node_map *nodemap;
931 const char *reclock_file;
932 struct ctdb_ban_state *ban_state;
933 uint64_t seqnum;
934 const char *reason;
935 struct ctdb_public_ip_info *ipinfo;
936 struct ctdb_iface_list *iface_list;
937 struct ctdb_statistics_list *stats_list;
938 struct ctdb_db_statistics *dbstats;
939 enum ctdb_runstate runstate;
940 uint32_t num_records;
941 int tdb_flags;
942 struct ctdb_echo_data *echo_data;
943 } data;
944 };
945
946 struct ctdb_req_control {
947 uint32_t opcode;
948 uint32_t pad;
949 uint64_t srvid;
950 uint32_t client_id;
951 #define CTDB_CTRL_FLAG_NOREPLY 1
952 #define CTDB_CTRL_FLAG_OPCODE_SPECIFIC 0xFFFF0000
953 /* Ugly overloading of this field... */
954 #define CTDB_PUBLIC_IP_FLAGS_ONLY_AVAILABLE 0x00010000
955 #define CTDB_CTRL_FLAG_ATTACH_RECOVERY 0x00020000
956 uint32_t flags;
957 struct ctdb_req_control_data rdata;
958 };
959
960 struct ctdb_reply_control {
961 int32_t status;
962 const char *errmsg;
963 struct ctdb_reply_control_data rdata;
964 };
965
966 struct ctdb_election_message {
967 uint32_t num_connected;
968 struct timeval priority_time;
969 uint32_t pnn;
970 uint32_t node_flags;
971 };
972
973 struct ctdb_srvid_message {
974 uint32_t pnn;
975 uint64_t srvid;
976 };
977
978 struct ctdb_disable_message {
979 uint32_t pnn;
980 uint64_t srvid;
981 uint32_t timeout;
982 };
983
984 union ctdb_message_data {
985 /* SRVID_ELECTION */
986 struct ctdb_election_message *election;
987 /* SRVID_RELEASE_IP, SRVID_TAKE_IP */
988 const char *ipaddr;
989 /* SRVID_SET_NODE_FLAGS, SERVID_PUSH_NODE_FLAGS */
990 struct ctdb_node_flag_change *flag_change;
991 /* SRVID_RECD_UPDATE_IP */
992 struct ctdb_public_ip *pubip;
993 /* SRVID_VACUUM_FETCH */
994 struct ctdb_rec_buffer *recbuf;
995 /* SRVID_DETACH_DATABASE */
996 uint32_t db_id;
997 /* SRVID_MEM_DUMP, SRVID_TAKEOVER_RUN */
998 struct ctdb_srvid_message *msg;
999 /* SRVID_BANNING, SRVID_REBALANCE_NODE */
1000 uint32_t pnn;
1001 /* SRVID_DISABLE_TAKEOVER_RUNS, SRVID_DISABLE_RECOVERIES */
1002 struct ctdb_disable_message *disable;
1003 /* SRVID_DISABLE_IP_CHECK */
1004 uint32_t timeout;
1005 /* Other */
1006 TDB_DATA data;
1007 };
1008
1009 struct ctdb_req_message {
1010 uint64_t srvid;
1011 union ctdb_message_data data;
1012 };
1013
1014 struct ctdb_req_message_data {
1015 uint64_t srvid;
1016 TDB_DATA data;
1017 };
1018
1019 struct ctdb_req_keepalive {
1020 uint32_t version;
1021 uint32_t uptime;
1022 };
1023
1024 #define CTDB_TUNNEL_TEST 0xffffffff00000000
1025
1026 #define CTDB_TUNNEL_FLAG_REQUEST 0x00000001
1027 #define CTDB_TUNNEL_FLAG_REPLY 0x00000002
1028 #define CTDB_TUNNEL_FLAG_NOREPLY 0x00000010
1029
1030 struct ctdb_req_tunnel {
1031 uint64_t tunnel_id;
1032 uint32_t flags;
1033 TDB_DATA data;
1034 };
1035
1036
1037 /* This is equivalent to server_id */
1038 struct ctdb_server_id {
1039 uint64_t pid;
1040 uint32_t task_id;
1041 uint32_t vnn;
1042 uint64_t unique_id;
1043 };
1044
1045 enum ctdb_g_lock_type {
1046 CTDB_G_LOCK_READ = 0,
1047 CTDB_G_LOCK_WRITE = 1,
1048 };
1049
1050 struct ctdb_g_lock {
1051 enum ctdb_g_lock_type type;
1052 struct ctdb_server_id sid;
1053 };
1054
1055 struct ctdb_g_lock_list {
1056 unsigned int num;
1057 struct ctdb_g_lock *lock;
1058 };
1059
1060 /*
1061 * Generic packet header
1062 */
1063
1064 struct sock_packet_header {
1065 uint32_t length;
1066 uint32_t reqid;
1067 };
1068
1069 #endif /* __CTDB_PROTOCOL_H__ */
Samba GIT mirror