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 set max acess count before a dmaster migration
82 void ctdb_set_max_lacount(struct ctdb_context *ctdb, unsigned count);
85 tell ctdb what address to listen on, in transport specific format
87 int ctdb_set_address(struct ctdb_context *ctdb, const char *address);
89 int ctdb_set_socketname(struct ctdb_context *ctdb, const char *socketname);
90 const char *ctdb_get_socketname(struct ctdb_context *ctdb);
93 tell ctdb what nodes are available. This takes a filename, which will contain
94 1 node address per line, in a transport specific format
96 int ctdb_set_nlist(struct ctdb_context *ctdb, const char *nlist);
99 Check that a specific ip address exists in the node list and returns
100 the id for the node or -1
102 int ctdb_ip_to_nodeid(struct ctdb_context *ctdb, const char *nodeip);
105 start the ctdb protocol
107 int ctdb_start(struct ctdb_context *ctdb);
108 int ctdb_start_daemon(struct ctdb_context *ctdb, bool do_fork, bool use_syslog);
111 attach to a ctdb database
113 struct ctdb_db_context *ctdb_attach(struct ctdb_context *ctdb, const char *name, bool persistent, uint32_t tdb_flags);
116 find an attached ctdb_db handle given a name
118 struct ctdb_db_context *ctdb_db_handle(struct ctdb_context *ctdb, const char *name);
121 error string for last ctdb error
123 const char *ctdb_errstr(struct ctdb_context *);
125 /* a ctdb call function */
126 typedef int (*ctdb_fn_t)(struct ctdb_call_info *);
129 setup a ctdb call function
131 int ctdb_set_call(struct ctdb_db_context *ctdb_db, ctdb_fn_t fn, uint32_t id);
136 make a ctdb call. The associated ctdb call function will be called on the DMASTER
139 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
142 initiate an ordered ctdb cluster shutdown
143 this function will never return
145 void ctdb_shutdown(struct ctdb_context *ctdb);
147 /* return pnn of this node */
148 uint32_t ctdb_get_pnn(struct ctdb_context *ctdb);
151 return the number of nodes
153 uint32_t ctdb_get_num_nodes(struct ctdb_context *ctdb);
155 /* setup a handler for ctdb messages */
156 typedef void (*ctdb_msg_fn_t)(struct ctdb_context *, uint64_t srvid,
157 TDB_DATA data, void *);
158 int ctdb_client_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid,
159 ctdb_msg_fn_t handler,
161 int ctdb_client_remove_message_handler(struct ctdb_context *ctdb,
162 uint64_t srvid, void *private_data);
165 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
166 struct ctdb_client_call_state *ctdb_call_send(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
167 int ctdb_call_recv(struct ctdb_client_call_state *state, struct ctdb_call *call);
169 /* send a ctdb message */
170 int ctdb_client_send_message(struct ctdb_context *ctdb, uint32_t pnn,
171 uint64_t srvid, TDB_DATA data);
175 Fetch a ctdb record from a remote node
176 . Underneath this will force the
177 dmaster for the record to be moved to the local node.
179 struct ctdb_record_handle *ctdb_fetch_lock(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
180 TDB_DATA key, TDB_DATA *data);
182 int ctdb_record_store(struct ctdb_record_handle *h, TDB_DATA data);
184 int ctdb_fetch(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
185 TDB_DATA key, TDB_DATA *data);
187 int ctdb_register_message_handler(struct ctdb_context *ctdb,
190 ctdb_msg_fn_t handler,
193 struct ctdb_db_context *find_ctdb_db(struct ctdb_context *ctdb, uint32_t id);
196 struct ctdb_context *ctdb_cmdline_client(struct tevent_context *ev);
198 struct ctdb_statistics;
199 int ctdb_ctrl_statistics(struct ctdb_context *ctdb, uint32_t destnode, struct ctdb_statistics *status);
201 int ctdb_ctrl_shutdown(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
204 int ctdb_ctrl_getvnnmap(struct ctdb_context *ctdb,
205 struct timeval timeout, uint32_t destnode,
206 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map **vnnmap);
207 int ctdb_ctrl_setvnnmap(struct ctdb_context *ctdb,
208 struct timeval timeout, uint32_t destnode,
209 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map *vnnmap);
211 /* table that contains a list of all dbids on a node
213 struct ctdb_dbid_map {
220 int ctdb_ctrl_getdbmap(struct ctdb_context *ctdb,
221 struct timeval timeout, uint32_t destnode,
222 TALLOC_CTX *mem_ctx, struct ctdb_dbid_map **dbmap);
225 struct ctdb_node_map;
227 int ctdb_ctrl_getnodemap(struct ctdb_context *ctdb,
228 struct timeval timeout, uint32_t destnode,
229 TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
231 int ctdb_ctrl_getnodemapv4(struct ctdb_context *ctdb,
232 struct timeval timeout, uint32_t destnode,
233 TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
235 int ctdb_ctrl_reload_nodes_file(struct ctdb_context *ctdb,
236 struct timeval timeout, uint32_t destnode);
238 struct ctdb_key_list {
242 struct ctdb_ltdb_header *headers;
246 int ctdb_ctrl_pulldb(
247 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
248 uint32_t lmaster, TALLOC_CTX *mem_ctx,
249 struct timeval timeout, TDB_DATA *outdata);
251 struct ctdb_client_control_state *ctdb_ctrl_pulldb_send(
252 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
253 uint32_t lmaster, TALLOC_CTX *mem_ctx, struct timeval timeout);
255 int ctdb_ctrl_pulldb_recv(
256 struct ctdb_context *ctdb,
257 TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state,
260 int ctdb_ctrl_pushdb(
261 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
263 struct timeval timeout, TDB_DATA indata);
265 struct ctdb_client_control_state *ctdb_ctrl_pushdb_send(
266 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
267 TALLOC_CTX *mem_ctx, struct timeval timeout,
270 int ctdb_ctrl_pushdb_recv(
271 struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
272 struct ctdb_client_control_state *state);
275 int ctdb_ctrl_copydb(struct ctdb_context *ctdb,
276 struct timeval timeout, uint32_t sourcenode,
277 uint32_t destnode, uint32_t dbid, uint32_t lmaster,
278 TALLOC_CTX *mem_ctx);
280 int ctdb_ctrl_getdbpath(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **path);
281 int ctdb_ctrl_getdbname(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **name);
282 int ctdb_ctrl_getdbhealth(struct ctdb_context *ctdb,
283 struct timeval timeout,
285 uint32_t dbid, TALLOC_CTX *mem_ctx,
286 const char **reason);
287 int ctdb_ctrl_createdb(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, const char *name, bool persistent);
289 int ctdb_ctrl_process_exists(struct ctdb_context *ctdb, uint32_t destnode, pid_t pid);
291 int ctdb_ctrl_ping(struct ctdb_context *ctdb, uint32_t destnode);
293 int ctdb_ctrl_get_config(struct ctdb_context *ctdb);
295 int ctdb_ctrl_get_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t *level);
296 int ctdb_ctrl_set_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t level);
299 change dmaster for all keys in the database to the new value
301 int ctdb_ctrl_setdmaster(struct ctdb_context *ctdb,
302 struct timeval timeout, uint32_t destnode,
303 TALLOC_CTX *mem_ctx, uint32_t dbid, uint32_t dmaster);
306 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)
308 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);
310 #define CTDB_RECOVERY_NORMAL 0
311 #define CTDB_RECOVERY_ACTIVE 1
314 get the recovery mode of a remote node
316 int ctdb_ctrl_getrecmode(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmode);
318 struct ctdb_client_control_state *ctdb_ctrl_getrecmode_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
320 int ctdb_ctrl_getrecmode_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmode);
324 set the recovery mode of a remote node
326 int ctdb_ctrl_setrecmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmode);
328 get the monitoring mode of a remote node
330 int ctdb_ctrl_getmonmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *monmode);
333 set the monitoring mode of a remote node to active
335 int ctdb_ctrl_enable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
338 set the monitoring mode of a remote node to disabled
340 int ctdb_ctrl_disable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
344 get the recovery master of a remote node
346 int ctdb_ctrl_getrecmaster(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmaster);
348 struct ctdb_client_control_state *ctdb_ctrl_getrecmaster_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
350 int ctdb_ctrl_getrecmaster_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmaster);
355 set the recovery master of a remote node
357 int ctdb_ctrl_setrecmaster(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmaster);
359 uint32_t *ctdb_get_connected_nodes(struct ctdb_context *ctdb,
360 struct timeval timeout,
362 uint32_t *num_nodes);
364 int ctdb_statistics_reset(struct ctdb_context *ctdb, uint32_t destnode);
366 int ctdb_set_logfile(struct ctdb_context *ctdb, const char *logfile, bool use_syslog);
368 typedef int (*ctdb_traverse_func)(struct ctdb_context *, TDB_DATA, TDB_DATA, void *);
369 int ctdb_traverse(struct ctdb_db_context *ctdb_db, ctdb_traverse_func fn, void *private_data);
371 int ctdb_dumpdb_record(struct ctdb_context *ctdb, TDB_DATA key, TDB_DATA data, void *p);
372 int ctdb_dump_db(struct ctdb_db_context *ctdb_db, FILE *f);
375 get the pid of a ctdb daemon
377 int ctdb_ctrl_getpid(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *pid);
379 int ctdb_ctrl_freeze(struct ctdb_context *ctdb, struct timeval timeout,
381 int ctdb_ctrl_freeze_priority(struct ctdb_context *ctdb, struct timeval timeout,
382 uint32_t destnode, uint32_t priority);
384 struct ctdb_client_control_state *
385 ctdb_ctrl_freeze_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
386 struct timeval timeout, uint32_t destnode,
389 int ctdb_ctrl_freeze_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
390 struct ctdb_client_control_state *state);
392 int ctdb_ctrl_thaw_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t priority);
393 int ctdb_ctrl_thaw(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
395 int ctdb_ctrl_getpnn(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
397 int ctdb_ctrl_get_tunable(struct ctdb_context *ctdb,
398 struct timeval timeout,
400 const char *name, uint32_t *value);
402 int ctdb_ctrl_set_tunable(struct ctdb_context *ctdb,
403 struct timeval timeout,
405 const char *name, uint32_t value);
407 int ctdb_ctrl_list_tunables(struct ctdb_context *ctdb,
408 struct timeval timeout,
411 const char ***list, uint32_t *count);
413 int ctdb_ctrl_modflags(struct ctdb_context *ctdb,
414 struct timeval timeout,
416 uint32_t set, uint32_t clear);
418 enum ctdb_server_id_type { SERVER_TYPE_SAMBA=1 };
420 struct ctdb_server_id {
421 enum ctdb_server_id_type type;
426 struct ctdb_server_id_list {
428 struct ctdb_server_id server_ids[1];
432 int ctdb_ctrl_register_server_id(struct ctdb_context *ctdb,
433 struct timeval timeout,
434 struct ctdb_server_id *id);
435 int ctdb_ctrl_unregister_server_id(struct ctdb_context *ctdb,
436 struct timeval timeout,
437 struct ctdb_server_id *id);
438 int ctdb_ctrl_check_server_id(struct ctdb_context *ctdb,
439 struct timeval timeout, uint32_t destnode,
440 struct ctdb_server_id *id, uint32_t *status);
441 int ctdb_ctrl_get_server_id_list(struct ctdb_context *ctdb,
443 struct timeval timeout, uint32_t destnode,
444 struct ctdb_server_id_list **svid_list);
447 struct timeval current_time;
448 struct timeval ctdbd_start_time;
449 struct timeval last_recovery_started;
450 struct timeval last_recovery_finished;
454 definitions for different socket structures
456 typedef struct sockaddr_in ctdb_addr_in;
457 typedef struct sockaddr_in6 ctdb_addr_in6;
465 struct for tcp_client control
466 this is an ipv4 only version of this structure used by samba
467 samba will later be migrated over to use the
468 ctdb_control_tcp_addr structure instead
470 struct ctdb_control_tcp {
471 struct sockaddr_in src; // samba uses this
472 struct sockaddr_in dest;// samba uses this
474 /* new style structure */
475 struct ctdb_control_tcp_addr {
480 int ctdb_socket_connect(struct ctdb_context *ctdb);
483 get the uptime of a remote node
485 int ctdb_ctrl_uptime(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, struct ctdb_uptime **uptime);
487 struct ctdb_client_control_state *ctdb_ctrl_uptime_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
489 int ctdb_ctrl_uptime_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, struct ctdb_uptime **uptime);
491 int ctdb_ctrl_end_recovery(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
493 int ctdb_ctrl_getreclock(struct ctdb_context *ctdb,
494 struct timeval timeout, uint32_t destnode,
495 TALLOC_CTX *mem_ctx, const char **reclock);
496 int ctdb_ctrl_setreclock(struct ctdb_context *ctdb,
497 struct timeval timeout, uint32_t destnode,
498 const char *reclock);
501 uint32_t *list_of_connected_nodes(struct ctdb_context *ctdb,
502 struct ctdb_node_map *node_map,
505 uint32_t *list_of_active_nodes(struct ctdb_context *ctdb,
506 struct ctdb_node_map *node_map,
509 uint32_t *list_of_vnnmap_nodes(struct ctdb_context *ctdb,
510 struct ctdb_vnn_map *vnn_map,
513 uint32_t *list_of_active_nodes_except_pnn(struct ctdb_context *ctdb,
514 struct ctdb_node_map *node_map,
518 int ctdb_read_pnn_lock(int fd, int32_t pnn);
521 get capabilities of a remote node
523 int ctdb_ctrl_getcapabilities(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *capabilities);
525 struct ctdb_client_control_state *ctdb_ctrl_getcapabilities_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
527 int ctdb_ctrl_getcapabilities_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *capabilities);
530 int32_t ctdb_ctrl_transaction_active(struct ctdb_context *ctdb,
534 struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx,
535 struct ctdb_marshall_buffer *m,
539 struct ctdb_ltdb_header *header,
541 TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m);
543 struct ctdb_transaction_handle *ctdb_transaction_start(struct ctdb_db_context *ctdb_db,
544 TALLOC_CTX *mem_ctx);
545 int ctdb_transaction_fetch(struct ctdb_transaction_handle *h,
547 TDB_DATA key, TDB_DATA *data);
548 int ctdb_transaction_store(struct ctdb_transaction_handle *h,
549 TDB_DATA key, TDB_DATA data);
550 int ctdb_transaction_commit(struct ctdb_transaction_handle *h);
552 int ctdb_ctrl_recd_ping(struct ctdb_context *ctdb);
554 int switch_from_server_to_client(struct ctdb_context *ctdb, const char *fmt,
557 int ctdb_ctrl_getscriptstatus(struct ctdb_context *ctdb,
558 struct timeval timeout, uint32_t destnode,
559 TALLOC_CTX *mem_ctx, enum ctdb_eventscript_call type,
560 struct ctdb_scripts_wire **script_status);
563 struct debug_levels {
565 const char *description;
567 extern struct debug_levels debug_levels[];
569 const char *get_debug_by_level(int32_t level);
570 int32_t get_debug_by_desc(const char *desc);
572 int ctdb_ctrl_stop_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
573 int ctdb_ctrl_continue_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
575 int ctdb_ctrl_setnatgwstate(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t natgwstate);
576 int ctdb_ctrl_setlmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t lmasterrole);
577 int ctdb_ctrl_setrecmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmasterrole);
579 int ctdb_ctrl_enablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
580 int ctdb_ctrl_disablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
582 struct ctdb_ban_time {
587 int ctdb_ctrl_set_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_ban_time *bantime);
588 int ctdb_ctrl_get_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, struct ctdb_ban_time **bantime);
590 struct ctdb_db_priority {
595 int ctdb_ctrl_set_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_db_priority *db_prio);
596 int ctdb_ctrl_get_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t db_id, uint32_t *priority);
598 #endif /* _CTDB_CLIENT_H */