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 {
58 initialise ctdb subsystem
60 struct ctdb_context *ctdb_init(struct event_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);
92 tell ctdb what nodes are available. This takes a filename, which will contain
93 1 node address per line, in a transport specific format
95 int ctdb_set_nlist(struct ctdb_context *ctdb, const char *nlist);
98 Check that a specific ip address exists in the node list and returns
99 the id for the node or -1
101 int ctdb_ip_to_nodeid(struct ctdb_context *ctdb, const char *nodeip);
104 start the ctdb protocol
106 int ctdb_start(struct ctdb_context *ctdb);
107 int ctdb_start_daemon(struct ctdb_context *ctdb, bool do_fork, bool use_syslog);
110 attach to a ctdb database
112 struct ctdb_db_context *ctdb_attach(struct ctdb_context *ctdb, const char *name, bool persistent, uint32_t tdb_flags);
115 find an attached ctdb_db handle given a name
117 struct ctdb_db_context *ctdb_db_handle(struct ctdb_context *ctdb, const char *name);
120 error string for last ctdb error
122 const char *ctdb_errstr(struct ctdb_context *);
124 /* a ctdb call function */
125 typedef int (*ctdb_fn_t)(struct ctdb_call_info *);
128 setup a ctdb call function
130 int ctdb_set_call(struct ctdb_db_context *ctdb_db, ctdb_fn_t fn, uint32_t id);
135 make a ctdb call. The associated ctdb call function will be called on the DMASTER
138 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
141 initiate an ordered ctdb cluster shutdown
142 this function will never return
144 void ctdb_shutdown(struct ctdb_context *ctdb);
146 /* return pnn of this node */
147 uint32_t ctdb_get_pnn(struct ctdb_context *ctdb);
150 return the number of nodes
152 uint32_t ctdb_get_num_nodes(struct ctdb_context *ctdb);
154 /* setup a handler for ctdb messages */
155 typedef void (*ctdb_message_fn_t)(struct ctdb_context *, uint64_t srvid,
156 TDB_DATA data, void *);
157 int ctdb_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid,
158 ctdb_message_fn_t handler,
162 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
163 struct ctdb_client_call_state *ctdb_call_send(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
164 int ctdb_call_recv(struct ctdb_client_call_state *state, struct ctdb_call *call);
166 /* send a ctdb message */
167 int ctdb_send_message(struct ctdb_context *ctdb, uint32_t pnn,
168 uint64_t srvid, TDB_DATA data);
172 Fetch a ctdb record from a remote node
173 . Underneath this will force the
174 dmaster for the record to be moved to the local node.
176 struct ctdb_record_handle *ctdb_fetch_lock(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
177 TDB_DATA key, TDB_DATA *data);
179 int ctdb_record_store(struct ctdb_record_handle *h, TDB_DATA data);
181 int ctdb_fetch(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
182 TDB_DATA key, TDB_DATA *data);
184 int ctdb_register_message_handler(struct ctdb_context *ctdb,
187 ctdb_message_fn_t handler,
190 struct ctdb_db_context *find_ctdb_db(struct ctdb_context *ctdb, uint32_t id);
193 struct ctdb_context *ctdb_cmdline_client(struct event_context *ev);
195 struct ctdb_statistics;
196 int ctdb_ctrl_statistics(struct ctdb_context *ctdb, uint32_t destnode, struct ctdb_statistics *status);
198 int ctdb_ctrl_shutdown(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
201 int ctdb_ctrl_getvnnmap(struct ctdb_context *ctdb,
202 struct timeval timeout, uint32_t destnode,
203 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map **vnnmap);
204 int ctdb_ctrl_setvnnmap(struct ctdb_context *ctdb,
205 struct timeval timeout, uint32_t destnode,
206 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map *vnnmap);
208 /* table that contains a list of all dbids on a node
210 struct ctdb_dbid_map {
217 int ctdb_ctrl_getdbmap(struct ctdb_context *ctdb,
218 struct timeval timeout, uint32_t destnode,
219 TALLOC_CTX *mem_ctx, struct ctdb_dbid_map **dbmap);
222 struct ctdb_node_map;
224 int ctdb_ctrl_getnodemap(struct ctdb_context *ctdb,
225 struct timeval timeout, uint32_t destnode,
226 TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
228 int ctdb_ctrl_getnodemapv4(struct ctdb_context *ctdb,
229 struct timeval timeout, uint32_t destnode,
230 TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
232 int ctdb_ctrl_reload_nodes_file(struct ctdb_context *ctdb,
233 struct timeval timeout, uint32_t destnode);
235 struct ctdb_key_list {
239 struct ctdb_ltdb_header *headers;
243 int ctdb_ctrl_pulldb(
244 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
245 uint32_t lmaster, TALLOC_CTX *mem_ctx,
246 struct timeval timeout, TDB_DATA *outdata);
248 struct ctdb_client_control_state *ctdb_ctrl_pulldb_send(
249 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
250 uint32_t lmaster, TALLOC_CTX *mem_ctx, struct timeval timeout);
252 int ctdb_ctrl_pulldb_recv(
253 struct ctdb_context *ctdb,
254 TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state,
257 int ctdb_ctrl_pushdb(
258 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
260 struct timeval timeout, TDB_DATA indata);
262 struct ctdb_client_control_state *ctdb_ctrl_pushdb_send(
263 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
264 TALLOC_CTX *mem_ctx, struct timeval timeout,
267 int ctdb_ctrl_pushdb_recv(
268 struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
269 struct ctdb_client_control_state *state);
272 int ctdb_ctrl_copydb(struct ctdb_context *ctdb,
273 struct timeval timeout, uint32_t sourcenode,
274 uint32_t destnode, uint32_t dbid, uint32_t lmaster,
275 TALLOC_CTX *mem_ctx);
277 int ctdb_ctrl_getdbpath(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **path);
278 int ctdb_ctrl_getdbname(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **name);
279 int ctdb_ctrl_getdbhealth(struct ctdb_context *ctdb,
280 struct timeval timeout,
282 uint32_t dbid, TALLOC_CTX *mem_ctx,
283 const char **reason);
284 int ctdb_ctrl_createdb(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, const char *name, bool persistent);
286 int ctdb_ctrl_process_exists(struct ctdb_context *ctdb, uint32_t destnode, pid_t pid);
288 int ctdb_ctrl_ping(struct ctdb_context *ctdb, uint32_t destnode);
290 int ctdb_ctrl_get_config(struct ctdb_context *ctdb);
292 int ctdb_ctrl_get_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t *level);
293 int ctdb_ctrl_set_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t level);
296 change dmaster for all keys in the database to the new value
298 int ctdb_ctrl_setdmaster(struct ctdb_context *ctdb,
299 struct timeval timeout, uint32_t destnode,
300 TALLOC_CTX *mem_ctx, uint32_t dbid, uint32_t dmaster);
303 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)
305 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);
307 #define CTDB_RECOVERY_NORMAL 0
308 #define CTDB_RECOVERY_ACTIVE 1
311 get the recovery mode of a remote node
313 int ctdb_ctrl_getrecmode(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmode);
315 struct ctdb_client_control_state *ctdb_ctrl_getrecmode_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
317 int ctdb_ctrl_getrecmode_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmode);
321 set the recovery mode of a remote node
323 int ctdb_ctrl_setrecmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmode);
325 get the monitoring mode of a remote node
327 int ctdb_ctrl_getmonmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *monmode);
330 set the monitoring mode of a remote node to active
332 int ctdb_ctrl_enable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
335 set the monitoring mode of a remote node to disabled
337 int ctdb_ctrl_disable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
341 get the recovery master of a remote node
343 int ctdb_ctrl_getrecmaster(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmaster);
345 struct ctdb_client_control_state *ctdb_ctrl_getrecmaster_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
347 int ctdb_ctrl_getrecmaster_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmaster);
352 set the recovery master of a remote node
354 int ctdb_ctrl_setrecmaster(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmaster);
356 uint32_t *ctdb_get_connected_nodes(struct ctdb_context *ctdb,
357 struct timeval timeout,
359 uint32_t *num_nodes);
361 int ctdb_statistics_reset(struct ctdb_context *ctdb, uint32_t destnode);
363 int ctdb_set_logfile(struct ctdb_context *ctdb, const char *logfile, bool use_syslog);
365 typedef int (*ctdb_traverse_func)(struct ctdb_context *, TDB_DATA, TDB_DATA, void *);
366 int ctdb_traverse(struct ctdb_db_context *ctdb_db, ctdb_traverse_func fn, void *private_data);
368 int ctdb_dumpdb_record(struct ctdb_context *ctdb, TDB_DATA key, TDB_DATA data, void *p);
369 int ctdb_dump_db(struct ctdb_db_context *ctdb_db, FILE *f);
372 get the pid of a ctdb daemon
374 int ctdb_ctrl_getpid(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *pid);
376 int ctdb_ctrl_freeze(struct ctdb_context *ctdb, struct timeval timeout,
378 int ctdb_ctrl_freeze_priority(struct ctdb_context *ctdb, struct timeval timeout,
379 uint32_t destnode, uint32_t priority);
381 struct ctdb_client_control_state *
382 ctdb_ctrl_freeze_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
383 struct timeval timeout, uint32_t destnode,
386 int ctdb_ctrl_freeze_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
387 struct ctdb_client_control_state *state);
389 int ctdb_ctrl_thaw_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t priority);
390 int ctdb_ctrl_thaw(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
392 int ctdb_ctrl_getpnn(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
394 int ctdb_ctrl_get_tunable(struct ctdb_context *ctdb,
395 struct timeval timeout,
397 const char *name, uint32_t *value);
399 int ctdb_ctrl_set_tunable(struct ctdb_context *ctdb,
400 struct timeval timeout,
402 const char *name, uint32_t value);
404 int ctdb_ctrl_list_tunables(struct ctdb_context *ctdb,
405 struct timeval timeout,
408 const char ***list, uint32_t *count);
410 int ctdb_ctrl_modflags(struct ctdb_context *ctdb,
411 struct timeval timeout,
413 uint32_t set, uint32_t clear);
415 enum ctdb_server_id_type { SERVER_TYPE_SAMBA=1 };
417 struct ctdb_server_id {
418 enum ctdb_server_id_type type;
423 struct ctdb_server_id_list {
425 struct ctdb_server_id server_ids[1];
429 int ctdb_ctrl_register_server_id(struct ctdb_context *ctdb,
430 struct timeval timeout,
431 struct ctdb_server_id *id);
432 int ctdb_ctrl_unregister_server_id(struct ctdb_context *ctdb,
433 struct timeval timeout,
434 struct ctdb_server_id *id);
435 int ctdb_ctrl_check_server_id(struct ctdb_context *ctdb,
436 struct timeval timeout, uint32_t destnode,
437 struct ctdb_server_id *id, uint32_t *status);
438 int ctdb_ctrl_get_server_id_list(struct ctdb_context *ctdb,
440 struct timeval timeout, uint32_t destnode,
441 struct ctdb_server_id_list **svid_list);
444 struct timeval current_time;
445 struct timeval ctdbd_start_time;
446 struct timeval last_recovery_started;
447 struct timeval last_recovery_finished;
451 definitions for different socket structures
453 typedef struct sockaddr_in ctdb_addr_in;
454 typedef struct sockaddr_in6 ctdb_addr_in6;
462 struct for tcp_client control
463 this is an ipv4 only version of this structure used by samba
464 samba will later be migrated over to use the
465 ctdb_control_tcp_addr structure instead
467 struct ctdb_control_tcp {
468 struct sockaddr_in src; // samba uses this
469 struct sockaddr_in dest;// samba uses this
471 /* new style structure */
472 struct ctdb_control_tcp_addr {
477 int ctdb_socket_connect(struct ctdb_context *ctdb);
480 get the uptime of a remote node
482 int ctdb_ctrl_uptime(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, struct ctdb_uptime **uptime);
484 struct ctdb_client_control_state *ctdb_ctrl_uptime_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
486 int ctdb_ctrl_uptime_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, struct ctdb_uptime **uptime);
488 int ctdb_ctrl_end_recovery(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
490 int ctdb_ctrl_getreclock(struct ctdb_context *ctdb,
491 struct timeval timeout, uint32_t destnode,
492 TALLOC_CTX *mem_ctx, const char **reclock);
493 int ctdb_ctrl_setreclock(struct ctdb_context *ctdb,
494 struct timeval timeout, uint32_t destnode,
495 const char *reclock);
498 uint32_t *list_of_connected_nodes(struct ctdb_context *ctdb,
499 struct ctdb_node_map *node_map,
502 uint32_t *list_of_active_nodes(struct ctdb_context *ctdb,
503 struct ctdb_node_map *node_map,
506 uint32_t *list_of_vnnmap_nodes(struct ctdb_context *ctdb,
507 struct ctdb_vnn_map *vnn_map,
510 uint32_t *list_of_active_nodes_except_pnn(struct ctdb_context *ctdb,
511 struct ctdb_node_map *node_map,
515 int ctdb_read_pnn_lock(int fd, int32_t pnn);
518 get capabilities of a remote node
520 int ctdb_ctrl_getcapabilities(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *capabilities);
522 struct ctdb_client_control_state *ctdb_ctrl_getcapabilities_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
524 int ctdb_ctrl_getcapabilities_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *capabilities);
527 int32_t ctdb_ctrl_transaction_active(struct ctdb_context *ctdb,
531 struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx,
532 struct ctdb_marshall_buffer *m,
536 struct ctdb_ltdb_header *header,
538 TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m);
540 struct ctdb_transaction_handle *ctdb_transaction_start(struct ctdb_db_context *ctdb_db,
541 TALLOC_CTX *mem_ctx);
542 int ctdb_transaction_fetch(struct ctdb_transaction_handle *h,
544 TDB_DATA key, TDB_DATA *data);
545 int ctdb_transaction_store(struct ctdb_transaction_handle *h,
546 TDB_DATA key, TDB_DATA data);
547 int ctdb_transaction_commit(struct ctdb_transaction_handle *h);
549 int ctdb_ctrl_recd_ping(struct ctdb_context *ctdb);
551 int switch_from_server_to_client(struct ctdb_context *ctdb);
553 int ctdb_ctrl_getscriptstatus(struct ctdb_context *ctdb,
554 struct timeval timeout, uint32_t destnode,
555 TALLOC_CTX *mem_ctx, enum ctdb_eventscript_call type,
556 struct ctdb_scripts_wire **script_status);
559 struct debug_levels {
561 const char *description;
563 extern struct debug_levels debug_levels[];
565 const char *get_debug_by_level(int32_t level);
566 int32_t get_debug_by_desc(const char *desc);
568 int ctdb_ctrl_stop_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
569 int ctdb_ctrl_continue_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
571 int ctdb_ctrl_setnatgwstate(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t natgwstate);
572 int ctdb_ctrl_setlmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t lmasterrole);
573 int ctdb_ctrl_setrecmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmasterrole);
575 int ctdb_ctrl_enablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
576 int ctdb_ctrl_disablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
578 struct ctdb_ban_time {
583 int ctdb_ctrl_set_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_ban_time *bantime);
584 int ctdb_ctrl_get_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, struct ctdb_ban_time **bantime);
586 struct ctdb_db_priority {
591 int ctdb_ctrl_set_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_db_priority *db_prio);
592 int ctdb_ctrl_get_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t db_id, uint32_t *priority);
594 #endif /* _CTDB_CLIENT_H */