2 ctdb database library: old client interface
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/>.
20 #ifndef _CTDB_CLIENT_H
21 #define _CTDB_CLIENT_H
22 #include <ctdb_protocol.h>
24 enum control_state {CTDB_CONTROL_WAIT, CTDB_CONTROL_DONE, CTDB_CONTROL_ERROR, CTDB_CONTROL_TIMEOUT};
26 struct ctdb_client_control_state {
27 struct ctdb_context *ctdb;
31 enum control_state state;
33 struct ctdb_req_control *c;
35 /* if we have a callback registered for the completion (or failure) of
37 if a callback is used, it MUST talloc_free the cb_data passed to it
40 void (*fn)(struct ctdb_client_control_state *);
45 struct ctdb_client_notify_register {
48 uint8_t notify_data[1];
51 struct ctdb_client_notify_deregister {
55 struct tevent_context;
58 initialise ctdb subsystem
60 struct ctdb_context *ctdb_init(struct tevent_context *ev);
65 int ctdb_set_transport(struct ctdb_context *ctdb, const char *transport);
68 set the directory for the local databases
70 int ctdb_set_tdb_dir(struct ctdb_context *ctdb, const char *dir);
71 int ctdb_set_tdb_dir_persistent(struct ctdb_context *ctdb, const char *dir);
72 int ctdb_set_tdb_dir_state(struct ctdb_context *ctdb, const char *dir);
77 void ctdb_set_flags(struct ctdb_context *ctdb, unsigned flags);
80 tell ctdb what address to listen on, in transport specific format
82 int ctdb_set_address(struct ctdb_context *ctdb, const char *address);
84 int ctdb_set_socketname(struct ctdb_context *ctdb, const char *socketname);
85 const char *ctdb_get_socketname(struct ctdb_context *ctdb);
88 tell ctdb what nodes are available. This takes a filename, which will contain
89 1 node address per line, in a transport specific format
91 int ctdb_set_nlist(struct ctdb_context *ctdb, const char *nlist);
94 Check that a specific ip address exists in the node list and returns
95 the id for the node or -1
97 int ctdb_ip_to_nodeid(struct ctdb_context *ctdb, const char *nodeip);
100 start the ctdb protocol
102 int ctdb_start(struct ctdb_context *ctdb);
103 int ctdb_start_daemon(struct ctdb_context *ctdb, bool do_fork, bool use_syslog, const char *public_address_list);
106 attach to a ctdb database
108 struct ctdb_db_context *ctdb_attach(struct ctdb_context *ctdb, const char *name, bool persistent, uint32_t tdb_flags);
111 find an attached ctdb_db handle given a name
113 struct ctdb_db_context *ctdb_db_handle(struct ctdb_context *ctdb, const char *name);
116 error string for last ctdb error
118 const char *ctdb_errstr(struct ctdb_context *);
120 /* a ctdb call function */
121 typedef int (*ctdb_fn_t)(struct ctdb_call_info *);
124 setup a ctdb call function
126 int ctdb_set_call(struct ctdb_db_context *ctdb_db, ctdb_fn_t fn, uint32_t id);
131 make a ctdb call. The associated ctdb call function will be called on the DMASTER
134 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
137 initiate an ordered ctdb cluster shutdown
138 this function will never return
140 void ctdb_shutdown(struct ctdb_context *ctdb);
142 /* return pnn of this node */
143 uint32_t ctdb_get_pnn(struct ctdb_context *ctdb);
146 return the number of nodes
148 uint32_t ctdb_get_num_nodes(struct ctdb_context *ctdb);
150 /* setup a handler for ctdb messages */
151 typedef void (*ctdb_msg_fn_t)(struct ctdb_context *, uint64_t srvid,
152 TDB_DATA data, void *);
153 int ctdb_client_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid,
154 ctdb_msg_fn_t handler,
156 int ctdb_client_remove_message_handler(struct ctdb_context *ctdb,
157 uint64_t srvid, void *private_data);
160 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
161 struct ctdb_client_call_state *ctdb_call_send(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
162 int ctdb_call_recv(struct ctdb_client_call_state *state, struct ctdb_call *call);
164 /* send a ctdb message */
165 int ctdb_client_send_message(struct ctdb_context *ctdb, uint32_t pnn,
166 uint64_t srvid, TDB_DATA data);
170 Fetch a ctdb record from a remote node
171 . Underneath this will force the
172 dmaster for the record to be moved to the local node.
174 struct ctdb_record_handle *ctdb_fetch_lock(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
175 TDB_DATA key, TDB_DATA *data);
177 int ctdb_record_store(struct ctdb_record_handle *h, TDB_DATA data);
179 int ctdb_fetch(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
180 TDB_DATA key, TDB_DATA *data);
182 int ctdb_register_message_handler(struct ctdb_context *ctdb,
185 ctdb_msg_fn_t handler,
188 struct ctdb_db_context *find_ctdb_db(struct ctdb_context *ctdb, uint32_t id);
191 struct ctdb_context *ctdb_cmdline_client(struct tevent_context *ev);
193 struct ctdb_statistics;
194 int ctdb_ctrl_statistics(struct ctdb_context *ctdb, uint32_t destnode, struct ctdb_statistics *status);
196 int ctdb_ctrl_shutdown(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
199 int ctdb_ctrl_getvnnmap(struct ctdb_context *ctdb,
200 struct timeval timeout, uint32_t destnode,
201 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map **vnnmap);
202 int ctdb_ctrl_setvnnmap(struct ctdb_context *ctdb,
203 struct timeval timeout, uint32_t destnode,
204 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map *vnnmap);
206 /* table that contains a list of all dbids on a node
208 struct ctdb_dbid_map {
215 int ctdb_ctrl_getdbmap(struct ctdb_context *ctdb,
216 struct timeval timeout, uint32_t destnode,
217 TALLOC_CTX *mem_ctx, struct ctdb_dbid_map **dbmap);
220 struct ctdb_node_map;
222 int ctdb_ctrl_getnodemap(struct ctdb_context *ctdb,
223 struct timeval timeout, uint32_t destnode,
224 TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
226 int ctdb_ctrl_getnodemapv4(struct ctdb_context *ctdb,
227 struct timeval timeout, uint32_t destnode,
228 TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
230 int ctdb_ctrl_reload_nodes_file(struct ctdb_context *ctdb,
231 struct timeval timeout, uint32_t destnode);
233 struct ctdb_key_list {
237 struct ctdb_ltdb_header *headers;
241 int ctdb_ctrl_pulldb(
242 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
243 uint32_t lmaster, TALLOC_CTX *mem_ctx,
244 struct timeval timeout, TDB_DATA *outdata);
246 struct ctdb_client_control_state *ctdb_ctrl_pulldb_send(
247 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
248 uint32_t lmaster, TALLOC_CTX *mem_ctx, struct timeval timeout);
250 int ctdb_ctrl_pulldb_recv(
251 struct ctdb_context *ctdb,
252 TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state,
255 int ctdb_ctrl_pushdb(
256 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
258 struct timeval timeout, TDB_DATA indata);
260 struct ctdb_client_control_state *ctdb_ctrl_pushdb_send(
261 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
262 TALLOC_CTX *mem_ctx, struct timeval timeout,
265 int ctdb_ctrl_pushdb_recv(
266 struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
267 struct ctdb_client_control_state *state);
270 int ctdb_ctrl_copydb(struct ctdb_context *ctdb,
271 struct timeval timeout, uint32_t sourcenode,
272 uint32_t destnode, uint32_t dbid, uint32_t lmaster,
273 TALLOC_CTX *mem_ctx);
275 int ctdb_ctrl_getdbpath(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **path);
276 int ctdb_ctrl_getdbname(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **name);
277 int ctdb_ctrl_getdbhealth(struct ctdb_context *ctdb,
278 struct timeval timeout,
280 uint32_t dbid, TALLOC_CTX *mem_ctx,
281 const char **reason);
282 int ctdb_ctrl_createdb(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, const char *name, bool persistent);
284 int ctdb_ctrl_process_exists(struct ctdb_context *ctdb, uint32_t destnode, pid_t pid);
286 int ctdb_ctrl_ping(struct ctdb_context *ctdb, uint32_t destnode);
288 int ctdb_ctrl_get_config(struct ctdb_context *ctdb);
290 int ctdb_ctrl_get_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t *level);
291 int ctdb_ctrl_set_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t level);
294 change dmaster for all keys in the database to the new value
296 int ctdb_ctrl_setdmaster(struct ctdb_context *ctdb,
297 struct timeval timeout, uint32_t destnode,
298 TALLOC_CTX *mem_ctx, uint32_t dbid, uint32_t dmaster);
301 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)
303 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);
305 #define CTDB_RECOVERY_NORMAL 0
306 #define CTDB_RECOVERY_ACTIVE 1
309 get the recovery mode of a remote node
311 int ctdb_ctrl_getrecmode(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmode);
313 struct ctdb_client_control_state *ctdb_ctrl_getrecmode_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
315 int ctdb_ctrl_getrecmode_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmode);
319 set the recovery mode of a remote node
321 int ctdb_ctrl_setrecmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmode);
323 get the monitoring mode of a remote node
325 int ctdb_ctrl_getmonmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *monmode);
328 set the monitoring mode of a remote node to active
330 int ctdb_ctrl_enable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
333 set the monitoring mode of a remote node to disabled
335 int ctdb_ctrl_disable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
339 get the recovery master of a remote node
341 int ctdb_ctrl_getrecmaster(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmaster);
343 struct ctdb_client_control_state *ctdb_ctrl_getrecmaster_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
345 int ctdb_ctrl_getrecmaster_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmaster);
350 set the recovery master of a remote node
352 int ctdb_ctrl_setrecmaster(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmaster);
354 uint32_t *ctdb_get_connected_nodes(struct ctdb_context *ctdb,
355 struct timeval timeout,
357 uint32_t *num_nodes);
359 int ctdb_statistics_reset(struct ctdb_context *ctdb, uint32_t destnode);
361 int ctdb_set_logfile(struct ctdb_context *ctdb, const char *logfile, bool use_syslog);
363 typedef int (*ctdb_traverse_func)(struct ctdb_context *, TDB_DATA, TDB_DATA, void *);
364 int ctdb_traverse(struct ctdb_db_context *ctdb_db, ctdb_traverse_func fn, void *private_data);
366 int ctdb_dumpdb_record(struct ctdb_context *ctdb, TDB_DATA key, TDB_DATA data, void *p);
367 int ctdb_dump_db(struct ctdb_db_context *ctdb_db, FILE *f);
370 get the pid of a ctdb daemon
372 int ctdb_ctrl_getpid(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *pid);
374 int ctdb_ctrl_freeze(struct ctdb_context *ctdb, struct timeval timeout,
376 int ctdb_ctrl_freeze_priority(struct ctdb_context *ctdb, struct timeval timeout,
377 uint32_t destnode, uint32_t priority);
379 struct ctdb_client_control_state *
380 ctdb_ctrl_freeze_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
381 struct timeval timeout, uint32_t destnode,
384 int ctdb_ctrl_freeze_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
385 struct ctdb_client_control_state *state);
387 int ctdb_ctrl_thaw_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t priority);
388 int ctdb_ctrl_thaw(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
390 int ctdb_ctrl_getpnn(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
392 int ctdb_ctrl_get_tunable(struct ctdb_context *ctdb,
393 struct timeval timeout,
395 const char *name, uint32_t *value);
397 int ctdb_ctrl_set_tunable(struct ctdb_context *ctdb,
398 struct timeval timeout,
400 const char *name, uint32_t value);
402 int ctdb_ctrl_list_tunables(struct ctdb_context *ctdb,
403 struct timeval timeout,
406 const char ***list, uint32_t *count);
408 int ctdb_ctrl_modflags(struct ctdb_context *ctdb,
409 struct timeval timeout,
411 uint32_t set, uint32_t clear);
413 enum ctdb_server_id_type {
419 struct ctdb_server_id {
420 enum ctdb_server_id_type type;
425 struct ctdb_server_id_list {
427 struct ctdb_server_id server_ids[1];
431 int ctdb_ctrl_register_server_id(struct ctdb_context *ctdb,
432 struct timeval timeout,
433 struct ctdb_server_id *id);
434 int ctdb_ctrl_unregister_server_id(struct ctdb_context *ctdb,
435 struct timeval timeout,
436 struct ctdb_server_id *id);
437 int ctdb_ctrl_check_server_id(struct ctdb_context *ctdb,
438 struct timeval timeout, uint32_t destnode,
439 struct ctdb_server_id *id, uint32_t *status);
440 int ctdb_ctrl_get_server_id_list(struct ctdb_context *ctdb,
442 struct timeval timeout, uint32_t destnode,
443 struct ctdb_server_id_list **svid_list);
446 struct timeval current_time;
447 struct timeval ctdbd_start_time;
448 struct timeval last_recovery_started;
449 struct timeval last_recovery_finished;
453 struct for tcp_client control
454 this is an ipv4 only version of this structure used by samba
455 samba will later be migrated over to use the
456 ctdb_control_tcp_addr structure instead
458 struct ctdb_control_tcp {
459 struct sockaddr_in src; // samba uses this
460 struct sockaddr_in dest;// samba uses this
462 /* new style structure */
463 struct ctdb_control_tcp_addr {
468 int ctdb_socket_connect(struct ctdb_context *ctdb);
471 get the uptime of a remote node
473 int ctdb_ctrl_uptime(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, struct ctdb_uptime **uptime);
475 struct ctdb_client_control_state *ctdb_ctrl_uptime_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
477 int ctdb_ctrl_uptime_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, struct ctdb_uptime **uptime);
479 int ctdb_ctrl_end_recovery(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
481 int ctdb_ctrl_getreclock(struct ctdb_context *ctdb,
482 struct timeval timeout, uint32_t destnode,
483 TALLOC_CTX *mem_ctx, const char **reclock);
484 int ctdb_ctrl_setreclock(struct ctdb_context *ctdb,
485 struct timeval timeout, uint32_t destnode,
486 const char *reclock);
489 uint32_t *list_of_connected_nodes(struct ctdb_context *ctdb,
490 struct ctdb_node_map *node_map,
493 uint32_t *list_of_active_nodes(struct ctdb_context *ctdb,
494 struct ctdb_node_map *node_map,
497 uint32_t *list_of_vnnmap_nodes(struct ctdb_context *ctdb,
498 struct ctdb_vnn_map *vnn_map,
501 uint32_t *list_of_active_nodes_except_pnn(struct ctdb_context *ctdb,
502 struct ctdb_node_map *node_map,
506 int ctdb_read_pnn_lock(int fd, int32_t pnn);
509 get capabilities of a remote node
511 int ctdb_ctrl_getcapabilities(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *capabilities);
513 struct ctdb_client_control_state *ctdb_ctrl_getcapabilities_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
515 int ctdb_ctrl_getcapabilities_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *capabilities);
518 int32_t ctdb_ctrl_transaction_active(struct ctdb_context *ctdb,
522 struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx,
523 struct ctdb_marshall_buffer *m,
527 struct ctdb_ltdb_header *header,
529 TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m);
531 struct ctdb_transaction_handle *ctdb_transaction_start(struct ctdb_db_context *ctdb_db,
532 TALLOC_CTX *mem_ctx);
533 int ctdb_transaction_fetch(struct ctdb_transaction_handle *h,
535 TDB_DATA key, TDB_DATA *data);
536 int ctdb_transaction_store(struct ctdb_transaction_handle *h,
537 TDB_DATA key, TDB_DATA data);
538 int ctdb_transaction_commit(struct ctdb_transaction_handle *h);
540 int ctdb_ctrl_recd_ping(struct ctdb_context *ctdb);
542 int switch_from_server_to_client(struct ctdb_context *ctdb, const char *fmt,
545 int ctdb_ctrl_getscriptstatus(struct ctdb_context *ctdb,
546 struct timeval timeout, uint32_t destnode,
547 TALLOC_CTX *mem_ctx, enum ctdb_eventscript_call type,
548 struct ctdb_scripts_wire **script_status);
551 struct debug_levels {
553 const char *description;
555 extern struct debug_levels debug_levels[];
557 const char *get_debug_by_level(int32_t level);
558 int32_t get_debug_by_desc(const char *desc);
560 int ctdb_ctrl_stop_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
561 int ctdb_ctrl_continue_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
563 int ctdb_ctrl_setnatgwstate(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t natgwstate);
564 int ctdb_ctrl_setlmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t lmasterrole);
565 int ctdb_ctrl_setrecmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmasterrole);
567 int ctdb_ctrl_enablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
568 int ctdb_ctrl_disablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
570 struct ctdb_ban_time {
575 int ctdb_ctrl_set_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_ban_time *bantime);
576 int ctdb_ctrl_get_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, struct ctdb_ban_time **bantime);
578 struct ctdb_db_priority {
583 int ctdb_ctrl_set_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_db_priority *db_prio);
584 int ctdb_ctrl_get_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t db_id, uint32_t *priority);
586 int ctdb_ctrl_getstathistory(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, struct ctdb_statistics_wire **stats);
589 #endif /* _CTDB_CLIENT_H */