4 Copyright (C) Andrew Tridgell 2006
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/>.
23 #define CTDB_IMMEDIATE_MIGRATION 0x00000001
34 structure passed to a ctdb call backend function
36 struct ctdb_call_info {
37 TDB_DATA key; /* record key */
38 TDB_DATA record_data; /* current data in the record */
39 TDB_DATA *new_data; /* optionally updated record data */
40 TDB_DATA *call_data; /* optionally passed from caller */
41 TDB_DATA *reply_data; /* optionally returned by function */
42 uint32_t status; /* optional reply status - defaults to zero */
45 #define CTDB_ERR_INVALID 1
46 #define CTDB_ERR_NOMEM 2
51 #define CTDB_FLAG_TORTURE (1<<1)
54 a message handler ID meaning "give me all messages"
56 #define CTDB_SRVID_ALL (~(uint64_t)0)
61 #define CTDB_SRVID_RECOVERY 0xF100000000000000LL
64 a message handler ID meaning that the cluster has been reconfigured
66 #define CTDB_SRVID_RECONFIGURE 0xF200000000000000LL
69 a message handler ID meaning that an IP address has been released
71 #define CTDB_SRVID_RELEASE_IP 0xF300000000000000LL
74 a message ID meaning that a nodes flags have changed
76 #define CTDB_SRVID_NODE_FLAGS_CHANGED 0xF400000000000000LL
79 a message ID meaning that a node should be banned
81 #define CTDB_SRVID_BAN_NODE 0xF500000000000000LL
84 a message ID meaning that a node should be unbanned
86 #define CTDB_SRVID_UNBAN_NODE 0xF600000000000000LL
89 a message to tell the recovery daemon to fetch a set of records
91 #define CTDB_SRVID_VACUUM_FETCH 0xF700000000000000LL
94 a message to tell the recovery daemon to write a talloc memdump
97 #define CTDB_SRVID_MEM_DUMP 0xF800000000000000LL
100 /* used on the domain socket, send a pdu to the local daemon */
101 #define CTDB_CURRENT_NODE 0xF0000001
102 /* send a broadcast to all nodes in the cluster, active or not */
103 #define CTDB_BROADCAST_ALL 0xF0000002
104 /* send a broadcast to all nodes in the current vnn map */
105 #define CTDB_BROADCAST_VNNMAP 0xF0000003
106 /* send a broadcast to all connected nodes */
107 #define CTDB_BROADCAST_CONNECTED 0xF0000004
109 /* the key used for transaction locking on persistent databases */
110 #define CTDB_TRANSACTION_LOCK_KEY "__transaction_lock__"
112 enum control_state {CTDB_CONTROL_WAIT, CTDB_CONTROL_DONE, CTDB_CONTROL_ERROR, CTDB_CONTROL_TIMEOUT};
114 struct ctdb_client_control_state {
115 struct ctdb_context *ctdb;
119 enum control_state state;
121 struct ctdb_req_control *c;
123 /* if we have a callback registered for the completion (or failure) of
125 if a callback is used, it MUST talloc_free the cb_data passed to it
128 void (*fn)(struct ctdb_client_control_state *);
134 struct event_context;
137 initialise ctdb subsystem
139 struct ctdb_context *ctdb_init(struct event_context *ev);
144 int ctdb_set_transport(struct ctdb_context *ctdb, const char *transport);
147 set the directory for the local databases
149 int ctdb_set_tdb_dir(struct ctdb_context *ctdb, const char *dir);
150 int ctdb_set_tdb_dir_persistent(struct ctdb_context *ctdb, const char *dir);
155 void ctdb_set_flags(struct ctdb_context *ctdb, unsigned flags);
158 set max acess count before a dmaster migration
160 void ctdb_set_max_lacount(struct ctdb_context *ctdb, unsigned count);
163 tell ctdb what address to listen on, in transport specific format
165 int ctdb_set_address(struct ctdb_context *ctdb, const char *address);
167 int ctdb_set_socketname(struct ctdb_context *ctdb, const char *socketname);
170 tell ctdb what nodes are available. This takes a filename, which will contain
171 1 node address per line, in a transport specific format
173 int ctdb_set_nlist(struct ctdb_context *ctdb, const char *nlist);
176 Check that a specific ip address exists in the node list and returns
177 the id for the node or -1
179 int ctdb_ip_to_nodeid(struct ctdb_context *ctdb, const char *nodeip);
182 start the ctdb protocol
184 int ctdb_start(struct ctdb_context *ctdb);
185 int ctdb_start_daemon(struct ctdb_context *ctdb, bool do_fork);
188 attach to a ctdb database
190 struct ctdb_db_context *ctdb_attach(struct ctdb_context *ctdb, const char *name, bool persistent, uint32_t tdb_flags);
193 find an attached ctdb_db handle given a name
195 struct ctdb_db_context *ctdb_db_handle(struct ctdb_context *ctdb, const char *name);
198 error string for last ctdb error
200 const char *ctdb_errstr(struct ctdb_context *);
202 /* a ctdb call function */
203 typedef int (*ctdb_fn_t)(struct ctdb_call_info *);
206 setup a ctdb call function
208 int ctdb_set_call(struct ctdb_db_context *ctdb_db, ctdb_fn_t fn, uint32_t id);
213 make a ctdb call. The associated ctdb call function will be called on the DMASTER
216 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
219 initiate an ordered ctdb cluster shutdown
220 this function will never return
222 void ctdb_shutdown(struct ctdb_context *ctdb);
224 /* return pnn of this node */
225 uint32_t ctdb_get_pnn(struct ctdb_context *ctdb);
228 return the number of nodes
230 uint32_t ctdb_get_num_nodes(struct ctdb_context *ctdb);
232 /* setup a handler for ctdb messages */
233 typedef void (*ctdb_message_fn_t)(struct ctdb_context *, uint64_t srvid,
234 TDB_DATA data, void *);
235 int ctdb_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid,
236 ctdb_message_fn_t handler,
240 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
241 struct ctdb_client_call_state *ctdb_call_send(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
242 int ctdb_call_recv(struct ctdb_client_call_state *state, struct ctdb_call *call);
244 /* send a ctdb message */
245 int ctdb_send_message(struct ctdb_context *ctdb, uint32_t pnn,
246 uint64_t srvid, TDB_DATA data);
250 Fetch a ctdb record from a remote node
251 . Underneath this will force the
252 dmaster for the record to be moved to the local node.
254 struct ctdb_record_handle *ctdb_fetch_lock(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
255 TDB_DATA key, TDB_DATA *data);
257 int ctdb_record_store(struct ctdb_record_handle *h, TDB_DATA data);
259 int ctdb_fetch(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
260 TDB_DATA key, TDB_DATA *data);
262 int ctdb_register_message_handler(struct ctdb_context *ctdb,
265 ctdb_message_fn_t handler,
268 struct ctdb_db_context *find_ctdb_db(struct ctdb_context *ctdb, uint32_t id);
271 struct ctdb_context *ctdb_cmdline_client(struct event_context *ev);
273 struct ctdb_statistics;
274 int ctdb_ctrl_statistics(struct ctdb_context *ctdb, uint32_t destnode, struct ctdb_statistics *status);
276 int ctdb_ctrl_shutdown(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
279 int ctdb_ctrl_getvnnmap(struct ctdb_context *ctdb,
280 struct timeval timeout, uint32_t destnode,
281 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map **vnnmap);
282 int ctdb_ctrl_setvnnmap(struct ctdb_context *ctdb,
283 struct timeval timeout, uint32_t destnode,
284 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map *vnnmap);
286 /* table that contains a list of all dbids on a node
288 struct ctdb_dbid_map {
295 int ctdb_ctrl_getdbmap(struct ctdb_context *ctdb,
296 struct timeval timeout, uint32_t destnode,
297 TALLOC_CTX *mem_ctx, struct ctdb_dbid_map **dbmap);
300 struct ctdb_node_map;
302 int ctdb_ctrl_getnodemap(struct ctdb_context *ctdb,
303 struct timeval timeout, uint32_t destnode,
304 TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
306 int ctdb_ctrl_reload_nodes_file(struct ctdb_context *ctdb,
307 struct timeval timeout, uint32_t destnode);
309 struct ctdb_key_list {
313 struct ctdb_ltdb_header *headers;
317 int ctdb_ctrl_pulldb(
318 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
319 uint32_t lmaster, TALLOC_CTX *mem_ctx,
320 struct timeval timeout, TDB_DATA *outdata);
322 struct ctdb_client_control_state *ctdb_ctrl_pulldb_send(
323 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
324 uint32_t lmaster, TALLOC_CTX *mem_ctx, struct timeval timeout);
326 int ctdb_ctrl_pulldb_recv(
327 struct ctdb_context *ctdb,
328 TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state,
331 int ctdb_ctrl_pushdb(
332 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
334 struct timeval timeout, TDB_DATA indata);
336 struct ctdb_client_control_state *ctdb_ctrl_pushdb_send(
337 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
338 TALLOC_CTX *mem_ctx, struct timeval timeout,
341 int ctdb_ctrl_pushdb_recv(
342 struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
343 struct ctdb_client_control_state *state);
346 int ctdb_ctrl_copydb(struct ctdb_context *ctdb,
347 struct timeval timeout, uint32_t sourcenode,
348 uint32_t destnode, uint32_t dbid, uint32_t lmaster,
349 TALLOC_CTX *mem_ctx);
351 int ctdb_ctrl_getdbpath(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **path);
352 int ctdb_ctrl_getdbname(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **name);
353 int ctdb_ctrl_createdb(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, const char *name, bool persistent);
355 int ctdb_ctrl_process_exists(struct ctdb_context *ctdb, uint32_t destnode, pid_t pid);
357 int ctdb_ctrl_ping(struct ctdb_context *ctdb, uint32_t destnode);
359 int ctdb_ctrl_get_config(struct ctdb_context *ctdb);
361 int ctdb_ctrl_get_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t *level);
362 int ctdb_ctrl_set_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t level);
365 change dmaster for all keys in the database to the new value
367 int ctdb_ctrl_setdmaster(struct ctdb_context *ctdb,
368 struct timeval timeout, uint32_t destnode,
369 TALLOC_CTX *mem_ctx, uint32_t dbid, uint32_t dmaster);
372 write a record on a specific db (this implicitely updates dmaster of the record to locally be the vnn of the node where the control is executed on)
374 int ctdb_ctrl_write_record(struct ctdb_context *ctdb, uint32_t destnode, TALLOC_CTX *mem_ctx, uint32_t dbid, TDB_DATA key, TDB_DATA data);
376 #define CTDB_RECOVERY_NORMAL 0
377 #define CTDB_RECOVERY_ACTIVE 1
380 get the recovery mode of a remote node
382 int ctdb_ctrl_getrecmode(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmode);
384 struct ctdb_client_control_state *ctdb_ctrl_getrecmode_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
386 int ctdb_ctrl_getrecmode_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmode);
390 set the recovery mode of a remote node
392 int ctdb_ctrl_setrecmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmode);
394 get the monitoring mode of a remote node
396 int ctdb_ctrl_getmonmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *monmode);
399 set the monitoring mode of a remote node to active
401 int ctdb_ctrl_enable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
404 set the monitoring mode of a remote node to disabled
406 int ctdb_ctrl_disable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
410 get the recovery master of a remote node
412 int ctdb_ctrl_getrecmaster(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmaster);
414 struct ctdb_client_control_state *ctdb_ctrl_getrecmaster_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
416 int ctdb_ctrl_getrecmaster_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmaster);
421 set the recovery master of a remote node
423 int ctdb_ctrl_setrecmaster(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmaster);
425 uint32_t *ctdb_get_connected_nodes(struct ctdb_context *ctdb,
426 struct timeval timeout,
428 uint32_t *num_nodes);
430 int ctdb_statistics_reset(struct ctdb_context *ctdb, uint32_t destnode);
432 int ctdb_set_logfile(struct ctdb_context *ctdb, const char *logfile, bool use_syslog);
434 typedef int (*ctdb_traverse_func)(struct ctdb_context *, TDB_DATA, TDB_DATA, void *);
435 int ctdb_traverse(struct ctdb_db_context *ctdb_db, ctdb_traverse_func fn, void *private_data);
437 int ctdb_dump_db(struct ctdb_db_context *ctdb_db, FILE *f);
440 get the pid of a ctdb daemon
442 int ctdb_ctrl_getpid(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *pid);
444 int ctdb_ctrl_freeze(struct ctdb_context *ctdb, struct timeval timeout,
447 struct ctdb_client_control_state *
448 ctdb_ctrl_freeze_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
449 struct timeval timeout, uint32_t destnode);
451 int ctdb_ctrl_freeze_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
452 struct ctdb_client_control_state *state);
454 int ctdb_ctrl_thaw(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
456 int ctdb_ctrl_getpnn(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
458 int ctdb_ctrl_get_tunable(struct ctdb_context *ctdb,
459 struct timeval timeout,
461 const char *name, uint32_t *value);
463 int ctdb_ctrl_set_tunable(struct ctdb_context *ctdb,
464 struct timeval timeout,
466 const char *name, uint32_t value);
468 int ctdb_ctrl_list_tunables(struct ctdb_context *ctdb,
469 struct timeval timeout,
472 const char ***list, uint32_t *count);
474 int ctdb_ctrl_modflags(struct ctdb_context *ctdb,
475 struct timeval timeout,
477 uint32_t set, uint32_t clear);
479 enum ctdb_server_id_type { SERVER_TYPE_SAMBA=1 };
481 struct ctdb_server_id {
482 enum ctdb_server_id_type type;
487 struct ctdb_server_id_list {
489 struct ctdb_server_id server_ids[1];
493 int ctdb_ctrl_register_server_id(struct ctdb_context *ctdb,
494 struct timeval timeout,
495 struct ctdb_server_id *id);
496 int ctdb_ctrl_unregister_server_id(struct ctdb_context *ctdb,
497 struct timeval timeout,
498 struct ctdb_server_id *id);
499 int ctdb_ctrl_check_server_id(struct ctdb_context *ctdb,
500 struct timeval timeout, uint32_t destnode,
501 struct ctdb_server_id *id, uint32_t *status);
502 int ctdb_ctrl_get_server_id_list(struct ctdb_context *ctdb,
504 struct timeval timeout, uint32_t destnode,
505 struct ctdb_server_id_list **svid_list);
508 struct timeval current_time;
509 struct timeval ctdbd_start_time;
510 struct timeval last_recovery_started;
511 struct timeval last_recovery_finished;
514 int ctdb_socket_connect(struct ctdb_context *ctdb);
517 get the uptime of a remote node
519 int ctdb_ctrl_uptime(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, struct ctdb_uptime **uptime);
521 struct ctdb_client_control_state *ctdb_ctrl_uptime_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
523 int ctdb_ctrl_uptime_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, struct ctdb_uptime **uptime);
525 int ctdb_ctrl_end_recovery(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
527 int ctdb_ctrl_getreclock(struct ctdb_context *ctdb,
528 struct timeval timeout, uint32_t destnode,
529 TALLOC_CTX *mem_ctx, const char **reclock);
531 uint32_t *list_of_active_nodes(struct ctdb_context *ctdb,
532 struct ctdb_node_map *node_map,
535 uint32_t *list_of_vnnmap_nodes(struct ctdb_context *ctdb,
536 struct ctdb_vnn_map *vnn_map,
540 int ctdb_read_pnn_lock(int fd, int32_t pnn);
543 get capabilities of a remote node
545 int ctdb_ctrl_getcapabilities(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *capabilities);
547 struct ctdb_client_control_state *ctdb_ctrl_getcapabilities_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
549 int ctdb_ctrl_getcapabilities_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *capabilities);
551 struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx,
552 struct ctdb_marshall_buffer *m,
556 struct ctdb_ltdb_header *header,
558 TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m);
560 struct ctdb_transaction_handle *ctdb_transaction_start(struct ctdb_db_context *ctdb_db,
561 TALLOC_CTX *mem_ctx);
562 int ctdb_transaction_fetch(struct ctdb_transaction_handle *h,
564 TDB_DATA key, TDB_DATA *data);
565 int ctdb_transaction_store(struct ctdb_transaction_handle *h,
566 TDB_DATA key, TDB_DATA data);
567 int ctdb_transaction_commit(struct ctdb_transaction_handle *h);