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
23 #include "common/srvid.h"
24 #include "ctdb_protocol.h"
26 enum control_state {CTDB_CONTROL_WAIT, CTDB_CONTROL_DONE, CTDB_CONTROL_ERROR, CTDB_CONTROL_TIMEOUT};
28 struct ctdb_client_control_state {
29 struct ctdb_context *ctdb;
33 enum control_state state;
35 struct ctdb_req_control *c;
37 /* if we have a callback registered for the completion (or failure) of
39 if a callback is used, it MUST talloc_free the cb_data passed to it
42 void (*fn)(struct ctdb_client_control_state *);
47 struct ctdb_client_notify_register {
50 uint8_t notify_data[1];
53 struct ctdb_client_notify_deregister {
57 struct tevent_context;
60 initialise ctdb subsystem
62 struct ctdb_context *ctdb_init(struct tevent_context *ev);
67 int ctdb_set_transport(struct ctdb_context *ctdb, const char *transport);
72 void ctdb_set_flags(struct ctdb_context *ctdb, unsigned flags);
75 tell ctdb what address to listen on, in transport specific format
77 int ctdb_set_address(struct ctdb_context *ctdb, const char *address);
79 int ctdb_set_socketname(struct ctdb_context *ctdb, const char *socketname);
80 const char *ctdb_get_socketname(struct ctdb_context *ctdb);
83 Check that a specific ip address exists in the node list and returns
84 the id for the node or -1
86 int ctdb_ip_to_nodeid(struct ctdb_context *ctdb, const ctdb_sock_addr *nodeip);
89 attach to a ctdb database
91 struct ctdb_db_context *ctdb_attach(struct ctdb_context *ctdb,
92 struct timeval timeout,
97 int ctdb_detach(struct ctdb_context *ctdb, uint32_t db_id);
99 /* a ctdb call function */
100 typedef int (*ctdb_fn_t)(struct ctdb_call_info *);
103 setup a ctdb call function
105 int ctdb_set_call(struct ctdb_db_context *ctdb_db, ctdb_fn_t fn, uint32_t id);
110 make a ctdb call. The associated ctdb call function will be called on the DMASTER
113 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
115 /* return pnn of this node */
116 uint32_t ctdb_get_pnn(struct ctdb_context *ctdb);
118 /* setup a handler for ctdb messages */
119 typedef void (*ctdb_msg_fn_t)(struct ctdb_context *, uint64_t srvid,
120 TDB_DATA data, void *);
121 int ctdb_client_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid,
122 srvid_handler_fn handler,
124 int ctdb_client_remove_message_handler(struct ctdb_context *ctdb,
125 uint64_t srvid, void *private_data);
126 int ctdb_client_check_message_handlers(struct ctdb_context *ctdb,
127 uint64_t *ids, uint32_t num,
130 int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
131 struct ctdb_client_call_state *ctdb_call_send(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
132 int ctdb_call_recv(struct ctdb_client_call_state *state, struct ctdb_call *call);
134 /* send a ctdb message */
135 int ctdb_client_send_message(struct ctdb_context *ctdb, uint32_t pnn,
136 uint64_t srvid, TDB_DATA data);
140 Fetch a ctdb record from a remote node
141 . Underneath this will force the
142 dmaster for the record to be moved to the local node.
144 struct ctdb_record_handle *ctdb_fetch_lock(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
145 TDB_DATA key, TDB_DATA *data);
147 struct ctdb_record_handle *ctdb_fetch_readonly_lock(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx, TDB_DATA key, TDB_DATA *data, int read_only);
149 int ctdb_record_store(struct ctdb_record_handle *h, TDB_DATA data);
151 int ctdb_fetch(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx,
152 TDB_DATA key, TDB_DATA *data);
155 struct ctdb_statistics;
156 int ctdb_ctrl_statistics(struct ctdb_context *ctdb, uint32_t destnode, struct ctdb_statistics *status);
157 int ctdb_ctrl_dbstatistics(struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
158 TALLOC_CTX *mem_ctx, struct ctdb_db_statistics **dbstat);
160 int ctdb_ctrl_shutdown(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
163 int ctdb_ctrl_getvnnmap(struct ctdb_context *ctdb,
164 struct timeval timeout, uint32_t destnode,
165 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map **vnnmap);
166 int ctdb_ctrl_setvnnmap(struct ctdb_context *ctdb,
167 struct timeval timeout, uint32_t destnode,
168 TALLOC_CTX *mem_ctx, struct ctdb_vnn_map *vnnmap);
170 /* table that contains a list of all dbids on a node
172 struct ctdb_dbid_map {
176 #define CTDB_DB_FLAGS_PERSISTENT 0x01
177 #define CTDB_DB_FLAGS_READONLY 0x02
178 #define CTDB_DB_FLAGS_STICKY 0x04
182 int ctdb_ctrl_getdbmap(struct ctdb_context *ctdb,
183 struct timeval timeout, uint32_t destnode,
184 TALLOC_CTX *mem_ctx, struct ctdb_dbid_map **dbmap);
187 struct ctdb_node_map;
189 int ctdb_ctrl_getnodemap(struct ctdb_context *ctdb,
190 struct timeval timeout, uint32_t destnode,
191 TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
193 int ctdb_ctrl_getnodesfile(struct ctdb_context *ctdb,
194 struct timeval timeout, uint32_t destnode,
195 TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
197 int ctdb_ctrl_reload_nodes_file(struct ctdb_context *ctdb,
198 struct timeval timeout, uint32_t destnode);
200 struct ctdb_key_list {
204 struct ctdb_ltdb_header *headers;
208 int ctdb_ctrl_pulldb(
209 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
210 uint32_t lmaster, TALLOC_CTX *mem_ctx,
211 struct timeval timeout, TDB_DATA *outdata);
213 struct ctdb_client_control_state *ctdb_ctrl_pulldb_send(
214 struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
215 uint32_t lmaster, TALLOC_CTX *mem_ctx, struct timeval timeout);
217 int ctdb_ctrl_pulldb_recv(
218 struct ctdb_context *ctdb,
219 TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state,
222 int ctdb_ctrl_getdbpath(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **path);
223 int ctdb_ctrl_getdbname(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **name);
224 int ctdb_ctrl_getdbhealth(struct ctdb_context *ctdb,
225 struct timeval timeout,
227 uint32_t dbid, TALLOC_CTX *mem_ctx,
228 const char **reason);
229 int ctdb_ctrl_getdbseqnum(struct ctdb_context *ctdb, struct timeval timeout,
230 uint32_t destnode, uint32_t dbid, uint64_t *seqnum);
231 int ctdb_ctrl_createdb(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, const char *name, bool persistent);
233 int ctdb_ctrl_process_exists(struct ctdb_context *ctdb, uint32_t destnode, pid_t pid);
235 int ctdb_ctrl_ping(struct ctdb_context *ctdb, uint32_t destnode);
237 int ctdb_ctrl_get_runstate(struct ctdb_context *ctdb,
238 struct timeval timeout,
242 int ctdb_ctrl_get_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t *level);
243 int ctdb_ctrl_set_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t level);
246 change dmaster for all keys in the database to the new value
248 int ctdb_ctrl_setdmaster(struct ctdb_context *ctdb,
249 struct timeval timeout, uint32_t destnode,
250 TALLOC_CTX *mem_ctx, uint32_t dbid, uint32_t dmaster);
252 #define CTDB_RECOVERY_NORMAL 0
253 #define CTDB_RECOVERY_ACTIVE 1
256 get the recovery mode of a remote node
258 int ctdb_ctrl_getrecmode(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmode);
260 struct ctdb_client_control_state *ctdb_ctrl_getrecmode_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
262 int ctdb_ctrl_getrecmode_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmode);
266 set the recovery mode of a remote node
268 int ctdb_ctrl_setrecmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmode);
270 get the monitoring mode of a remote node
272 int ctdb_ctrl_getmonmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *monmode);
275 set the monitoring mode of a remote node to active
277 int ctdb_ctrl_enable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
280 set the monitoring mode of a remote node to disabled
282 int ctdb_ctrl_disable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
286 get the recovery master of a remote node
288 int ctdb_ctrl_getrecmaster(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmaster);
290 struct ctdb_client_control_state *ctdb_ctrl_getrecmaster_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
292 int ctdb_ctrl_getrecmaster_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmaster);
297 set the recovery master of a remote node
299 int ctdb_ctrl_setrecmaster(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmaster);
301 uint32_t *ctdb_get_connected_nodes(struct ctdb_context *ctdb,
302 struct timeval timeout,
304 uint32_t *num_nodes);
306 int ctdb_statistics_reset(struct ctdb_context *ctdb, uint32_t destnode);
308 typedef int (*ctdb_traverse_func)(TDB_DATA, TDB_DATA, void *);
309 int ctdb_traverse(struct ctdb_db_context *ctdb_db, ctdb_traverse_func fn, void *private_data);
311 struct ctdb_dump_db_context {
312 struct ctdb_context *ctdb;
314 bool printemptyrecords;
318 bool printrecordflags;
321 int ctdb_dumpdb_record(TDB_DATA key, TDB_DATA data, void *p);
322 int ctdb_dump_db(struct ctdb_db_context *ctdb_db,
323 struct ctdb_dump_db_context *ctx);
326 get the pid of a ctdb daemon
328 int ctdb_ctrl_getpid(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *pid);
330 int ctdb_ctrl_freeze(struct ctdb_context *ctdb, struct timeval timeout,
332 int ctdb_ctrl_freeze_priority(struct ctdb_context *ctdb, struct timeval timeout,
333 uint32_t destnode, uint32_t priority);
335 struct ctdb_client_control_state *
336 ctdb_ctrl_freeze_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
337 struct timeval timeout, uint32_t destnode,
340 int ctdb_ctrl_freeze_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
341 struct ctdb_client_control_state *state);
343 int ctdb_ctrl_thaw_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t priority);
344 int ctdb_ctrl_thaw(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
346 int ctdb_ctrl_getpnn(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
348 int ctdb_ctrl_get_tunable(struct ctdb_context *ctdb,
349 struct timeval timeout,
351 const char *name, uint32_t *value);
353 int ctdb_ctrl_set_tunable(struct ctdb_context *ctdb,
354 struct timeval timeout,
356 const char *name, uint32_t value);
358 int ctdb_ctrl_list_tunables(struct ctdb_context *ctdb,
359 struct timeval timeout,
362 const char ***list, uint32_t *count);
364 int ctdb_ctrl_modflags(struct ctdb_context *ctdb,
365 struct timeval timeout,
367 uint32_t set, uint32_t clear);
369 enum ctdb_server_id_type {
375 struct ctdb_server_id {
376 enum ctdb_server_id_type type;
381 struct ctdb_server_id_list {
383 struct ctdb_server_id server_ids[1];
387 int ctdb_ctrl_register_server_id(struct ctdb_context *ctdb,
388 struct timeval timeout,
389 struct ctdb_server_id *id);
390 int ctdb_ctrl_unregister_server_id(struct ctdb_context *ctdb,
391 struct timeval timeout,
392 struct ctdb_server_id *id);
393 int ctdb_ctrl_check_server_id(struct ctdb_context *ctdb,
394 struct timeval timeout, uint32_t destnode,
395 struct ctdb_server_id *id, uint32_t *status);
396 int ctdb_ctrl_get_server_id_list(struct ctdb_context *ctdb,
398 struct timeval timeout, uint32_t destnode,
399 struct ctdb_server_id_list **svid_list);
402 struct timeval current_time;
403 struct timeval ctdbd_start_time;
404 struct timeval last_recovery_started;
405 struct timeval last_recovery_finished;
408 struct ctdb_control_tcp_addr {
413 int ctdb_socket_connect(struct ctdb_context *ctdb);
416 get the uptime of a remote node
418 int ctdb_ctrl_uptime(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, struct ctdb_uptime **uptime);
420 struct ctdb_client_control_state *ctdb_ctrl_uptime_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
422 int ctdb_ctrl_uptime_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, struct ctdb_uptime **uptime);
424 int ctdb_ctrl_end_recovery(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
426 int ctdb_ctrl_getreclock(struct ctdb_context *ctdb,
427 struct timeval timeout, uint32_t destnode,
428 TALLOC_CTX *mem_ctx, const char **reclock);
429 int ctdb_ctrl_setreclock(struct ctdb_context *ctdb,
430 struct timeval timeout, uint32_t destnode,
431 const char *reclock);
433 struct ctdb_node_capabilities {
435 uint32_t capabilities;
438 /* Retrieve capabilities for all connected nodes. The length of the
439 * returned array can be calculated using talloc_array_length(). */
440 struct ctdb_node_capabilities *
441 ctdb_get_capabilities(struct ctdb_context *ctdb,
443 struct timeval timeout,
444 struct ctdb_node_map *nodemap);
446 /* Get capabilities for specified node, NULL if not found */
448 ctdb_get_node_capabilities(struct ctdb_node_capabilities *caps,
451 /* True if the given node has all of the required capabilities */
452 bool ctdb_node_has_capabilities(struct ctdb_node_capabilities *caps,
454 uint32_t capabilities_required);
456 uint32_t *list_of_nodes(struct ctdb_context *ctdb,
457 struct ctdb_node_map *node_map,
461 uint32_t *list_of_connected_nodes(struct ctdb_context *ctdb,
462 struct ctdb_node_map *node_map,
465 uint32_t *list_of_active_nodes(struct ctdb_context *ctdb,
466 struct ctdb_node_map *node_map,
469 uint32_t *list_of_vnnmap_nodes(struct ctdb_context *ctdb,
470 struct ctdb_vnn_map *vnn_map,
474 int ctdb_read_pnn_lock(int fd, int32_t pnn);
477 get capabilities of a remote node
479 int ctdb_ctrl_getcapabilities(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *capabilities);
481 struct ctdb_client_control_state *ctdb_ctrl_getcapabilities_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
483 int ctdb_ctrl_getcapabilities_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *capabilities);
485 struct ctdb_transaction_handle *ctdb_transaction_start(struct ctdb_db_context *ctdb_db,
486 TALLOC_CTX *mem_ctx);
487 int ctdb_transaction_fetch(struct ctdb_transaction_handle *h,
489 TDB_DATA key, TDB_DATA *data);
490 int ctdb_transaction_store(struct ctdb_transaction_handle *h,
491 TDB_DATA key, TDB_DATA data);
492 int ctdb_transaction_commit(struct ctdb_transaction_handle *h);
493 int ctdb_transaction_cancel(struct ctdb_transaction_handle *h);
495 int ctdb_ctrl_recd_ping(struct ctdb_context *ctdb);
497 int switch_from_server_to_client(struct ctdb_context *ctdb, const char *fmt,
500 int ctdb_ctrl_getscriptstatus(struct ctdb_context *ctdb,
501 struct timeval timeout, uint32_t destnode,
502 TALLOC_CTX *mem_ctx, enum ctdb_eventscript_call type,
503 struct ctdb_scripts_wire **script_status);
506 int ctdb_ctrl_stop_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
507 int ctdb_ctrl_continue_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
509 int ctdb_ctrl_setnatgwstate(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t natgwstate);
510 int ctdb_ctrl_setlmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t lmasterrole);
511 int ctdb_ctrl_setrecmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmasterrole);
513 int ctdb_ctrl_enablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
514 int ctdb_ctrl_disablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
516 struct ctdb_ban_time {
521 int ctdb_ctrl_set_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_ban_time *bantime);
522 int ctdb_ctrl_get_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, struct ctdb_ban_time **bantime);
524 struct ctdb_db_priority {
529 int ctdb_ctrl_set_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_db_priority *db_prio);
530 int ctdb_ctrl_get_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t db_id, uint32_t *priority);
532 int ctdb_ctrl_getstathistory(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, struct ctdb_statistics_wire **stats);
536 struct ctdb_client_control_state *
537 ctdb_ctrl_updaterecord_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, struct ctdb_db_context *ctdb_db, TDB_DATA key, struct ctdb_ltdb_header *header, TDB_DATA data);
539 int ctdb_ctrl_updaterecord_recv(struct ctdb_context *ctdb, struct ctdb_client_control_state *state);
542 ctdb_ctrl_updaterecord(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, struct ctdb_db_context *ctdb_db, TDB_DATA key, struct ctdb_ltdb_header *header, TDB_DATA data);
545 struct ctdb_client_control_state *
546 ctdb_ctrl_set_db_readonly_send(struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid);
547 int ctdb_ctrl_set_db_readonly_recv(struct ctdb_context *ctdb, struct ctdb_client_control_state *state);
548 int ctdb_ctrl_set_db_readonly(struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid);
550 struct ctdb_client_control_state *
551 ctdb_ctrl_set_db_sticky_send(struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid);
552 int ctdb_ctrl_set_db_sticky_recv(struct ctdb_context *ctdb, struct ctdb_client_control_state *state);
553 int ctdb_ctrl_set_db_sticky(struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid);
555 #endif /* _CTDB_CLIENT_H */