2 ctdb_control protocol code
4 Copyright (C) Andrew Tridgell 2007
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 #include "lib/events/events.h"
21 #include "lib/tdb/include/tdb.h"
22 #include "system/network.h"
23 #include "system/filesys.h"
24 #include "system/wait.h"
25 #include "../include/ctdb_private.h"
26 #include "lib/util/dlinklist.h"
30 struct ctdb_control_state {
31 struct ctdb_context *ctdb;
33 ctdb_control_callback_fn_t callback;
40 dump talloc memory hierarchy, returning it as a blob to the client
42 int32_t ctdb_dump_memory(struct ctdb_context *ctdb, TDB_DATA *outdata)
44 /* dump to a file, then send the file as a blob */
49 DEBUG(DEBUG_ERR,(__location__ " Unable to open tmpfile - %s\n", strerror(errno)));
52 talloc_report_full(NULL, f);
55 outdata->dptr = talloc_size(outdata, fsize);
56 CTDB_NO_MEMORY(ctdb, outdata->dptr);
57 outdata->dsize = fread(outdata->dptr, 1, fsize, f);
59 if (outdata->dsize != fsize) {
60 DEBUG(DEBUG_ERR,(__location__ " Unable to read tmpfile\n"));
68 process a control request
70 static int32_t ctdb_control_dispatch(struct ctdb_context *ctdb,
71 struct ctdb_req_control *c,
73 TDB_DATA *outdata, uint32_t srcnode,
74 const char **errormsg,
77 uint32_t opcode = c->opcode;
78 uint64_t srvid = c->srvid;
79 uint32_t client_id = c->client_id;
82 case CTDB_CONTROL_PROCESS_EXISTS: {
83 CHECK_CONTROL_DATA_SIZE(sizeof(pid_t));
84 return kill(*(pid_t *)indata.dptr, 0);
87 case CTDB_CONTROL_SET_DEBUG: {
88 CHECK_CONTROL_DATA_SIZE(sizeof(int32_t));
89 LogLevel = *(int32_t *)indata.dptr;
93 case CTDB_CONTROL_GET_DEBUG: {
94 CHECK_CONTROL_DATA_SIZE(0);
95 outdata->dptr = (uint8_t *)&LogLevel;
96 outdata->dsize = sizeof(LogLevel);
100 case CTDB_CONTROL_STATISTICS: {
101 CHECK_CONTROL_DATA_SIZE(0);
102 ctdb->statistics.memory_used = talloc_total_size(NULL);
103 ctdb->statistics.frozen = (ctdb->freeze_mode == CTDB_FREEZE_FROZEN);
104 ctdb->statistics.recovering = (ctdb->recovery_mode == CTDB_RECOVERY_ACTIVE);
105 outdata->dptr = (uint8_t *)&ctdb->statistics;
106 outdata->dsize = sizeof(ctdb->statistics);
110 case CTDB_CONTROL_GET_ALL_TUNABLES: {
111 CHECK_CONTROL_DATA_SIZE(0);
112 outdata->dptr = (uint8_t *)&ctdb->tunable;
113 outdata->dsize = sizeof(ctdb->tunable);
117 case CTDB_CONTROL_DUMP_MEMORY: {
118 CHECK_CONTROL_DATA_SIZE(0);
119 return ctdb_dump_memory(ctdb, outdata);
122 case CTDB_CONTROL_STATISTICS_RESET: {
123 CHECK_CONTROL_DATA_SIZE(0);
124 ZERO_STRUCT(ctdb->statistics);
128 case CTDB_CONTROL_GETVNNMAP:
129 return ctdb_control_getvnnmap(ctdb, opcode, indata, outdata);
131 case CTDB_CONTROL_GET_DBMAP:
132 return ctdb_control_getdbmap(ctdb, opcode, indata, outdata);
134 case CTDB_CONTROL_GET_NODEMAP:
135 return ctdb_control_getnodemap(ctdb, opcode, indata, outdata);
137 case CTDB_CONTROL_RELOAD_NODES_FILE:
138 CHECK_CONTROL_DATA_SIZE(0);
139 return ctdb_control_reload_nodes_file(ctdb, opcode);
141 case CTDB_CONTROL_SETVNNMAP:
142 return ctdb_control_setvnnmap(ctdb, opcode, indata, outdata);
144 case CTDB_CONTROL_PULL_DB:
145 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_pulldb));
146 return ctdb_control_pull_db(ctdb, indata, outdata);
148 case CTDB_CONTROL_SET_DMASTER:
149 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_set_dmaster));
150 return ctdb_control_set_dmaster(ctdb, indata);
152 case CTDB_CONTROL_PUSH_DB:
153 return ctdb_control_push_db(ctdb, indata);
155 case CTDB_CONTROL_GET_RECMODE: {
156 return ctdb->recovery_mode;
159 case CTDB_CONTROL_SET_RECMASTER: {
160 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
161 if (ctdb->freeze_mode != CTDB_FREEZE_FROZEN) {
162 DEBUG(DEBUG_NOTICE,("Attempt to set recmaster when not frozen\n"));
165 ctdb->recovery_master = ((uint32_t *)(&indata.dptr[0]))[0];
169 case CTDB_CONTROL_GET_RECMASTER:
170 return ctdb->recovery_master;
172 case CTDB_CONTROL_GET_PID:
175 case CTDB_CONTROL_GET_PNN:
178 case CTDB_CONTROL_PING:
179 CHECK_CONTROL_DATA_SIZE(0);
180 return ctdb->statistics.num_clients;
182 case CTDB_CONTROL_GET_DBNAME: {
184 struct ctdb_db_context *ctdb_db;
186 CHECK_CONTROL_DATA_SIZE(sizeof(db_id));
187 db_id = *(uint32_t *)indata.dptr;
188 ctdb_db = find_ctdb_db(ctdb, db_id);
189 if (ctdb_db == NULL) return -1;
190 outdata->dptr = discard_const(ctdb_db->db_name);
191 outdata->dsize = strlen(ctdb_db->db_name)+1;
195 case CTDB_CONTROL_GETDBPATH: {
197 struct ctdb_db_context *ctdb_db;
199 CHECK_CONTROL_DATA_SIZE(sizeof(db_id));
200 db_id = *(uint32_t *)indata.dptr;
201 ctdb_db = find_ctdb_db(ctdb, db_id);
202 if (ctdb_db == NULL) return -1;
203 outdata->dptr = discard_const(ctdb_db->db_path);
204 outdata->dsize = strlen(ctdb_db->db_path)+1;
208 case CTDB_CONTROL_DB_ATTACH:
209 return ctdb_control_db_attach(ctdb, indata, outdata, false);
211 case CTDB_CONTROL_DB_ATTACH_PERSISTENT:
212 return ctdb_control_db_attach(ctdb, indata, outdata, true);
214 case CTDB_CONTROL_SET_CALL: {
215 struct ctdb_control_set_call *sc =
216 (struct ctdb_control_set_call *)indata.dptr;
217 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_set_call));
218 return ctdb_daemon_set_call(ctdb, sc->db_id, sc->fn, sc->id);
221 case CTDB_CONTROL_TRAVERSE_START:
222 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_traverse_start));
223 return ctdb_control_traverse_start(ctdb, indata, outdata, srcnode);
225 case CTDB_CONTROL_TRAVERSE_ALL:
226 return ctdb_control_traverse_all(ctdb, indata, outdata);
228 case CTDB_CONTROL_TRAVERSE_DATA:
229 return ctdb_control_traverse_data(ctdb, indata, outdata);
231 case CTDB_CONTROL_REGISTER_SRVID:
232 return daemon_register_message_handler(ctdb, client_id, srvid);
234 case CTDB_CONTROL_DEREGISTER_SRVID:
235 return daemon_deregister_message_handler(ctdb, client_id, srvid);
237 case CTDB_CONTROL_ENABLE_SEQNUM:
238 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
239 return ctdb_ltdb_enable_seqnum(ctdb, *(uint32_t *)indata.dptr);
241 case CTDB_CONTROL_UPDATE_SEQNUM:
242 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
243 return ctdb_ltdb_update_seqnum(ctdb, *(uint32_t *)indata.dptr, srcnode);
245 case CTDB_CONTROL_FREEZE:
246 CHECK_CONTROL_DATA_SIZE(0);
247 return ctdb_control_freeze(ctdb, c, async_reply);
249 case CTDB_CONTROL_THAW:
250 CHECK_CONTROL_DATA_SIZE(0);
251 return ctdb_control_thaw(ctdb);
253 case CTDB_CONTROL_SET_RECMODE:
254 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
255 return ctdb_control_set_recmode(ctdb, c, indata, async_reply, errormsg);
257 case CTDB_CONTROL_GET_MONMODE:
258 CHECK_CONTROL_DATA_SIZE(0);
259 return ctdb_monitoring_mode(ctdb);
261 case CTDB_CONTROL_ENABLE_MONITOR:
262 CHECK_CONTROL_DATA_SIZE(0);
263 ctdb_enable_monitoring(ctdb);
266 case CTDB_CONTROL_RUN_EVENTSCRIPTS:
267 return ctdb_run_eventscripts(ctdb, c, indata, async_reply);
269 case CTDB_CONTROL_DISABLE_MONITOR:
270 CHECK_CONTROL_DATA_SIZE(0);
271 ctdb_disable_monitoring(ctdb);
274 case CTDB_CONTROL_SHUTDOWN:
275 ctdb_stop_recoverd(ctdb);
276 ctdb_stop_keepalive(ctdb);
277 ctdb_stop_monitoring(ctdb);
278 ctdb_release_all_ips(ctdb);
279 ctdb->methods->shutdown(ctdb);
280 ctdb_event_script(ctdb, "shutdown");
281 DEBUG(DEBUG_NOTICE,("Received SHUTDOWN command. Stopping CTDB daemon.\n"));
284 case CTDB_CONTROL_TAKEOVER_IP:
285 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_public_ip));
286 return ctdb_control_takeover_ip(ctdb, c, indata, async_reply);
288 case CTDB_CONTROL_RELEASE_IP:
289 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_public_ip));
290 return ctdb_control_release_ip(ctdb, c, indata, async_reply);
292 case CTDB_CONTROL_GET_PUBLIC_IPS:
293 CHECK_CONTROL_DATA_SIZE(0);
294 return ctdb_control_get_public_ips(ctdb, c, outdata);
296 case CTDB_CONTROL_TCP_CLIENT:
297 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_tcp));
298 return ctdb_control_tcp_client(ctdb, client_id, indata);
300 case CTDB_CONTROL_STARTUP:
301 CHECK_CONTROL_DATA_SIZE(0);
302 return ctdb_control_startup(ctdb, srcnode);
304 case CTDB_CONTROL_TCP_ADD:
305 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_tcp_vnn));
306 return ctdb_control_tcp_add(ctdb, indata);
308 case CTDB_CONTROL_SET_TUNABLE:
309 return ctdb_control_set_tunable(ctdb, indata);
311 case CTDB_CONTROL_GET_TUNABLE:
312 return ctdb_control_get_tunable(ctdb, indata, outdata);
314 case CTDB_CONTROL_LIST_TUNABLES:
315 return ctdb_control_list_tunables(ctdb, outdata);
317 case CTDB_CONTROL_MODIFY_FLAGS:
318 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_node_modflags));
319 return ctdb_control_modflags(ctdb, indata);
321 case CTDB_CONTROL_KILL_TCP:
322 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_killtcp));
323 return ctdb_control_kill_tcp(ctdb, indata);
325 case CTDB_CONTROL_GET_TCP_TICKLE_LIST:
326 CHECK_CONTROL_DATA_SIZE(sizeof(struct sockaddr_in));
327 return ctdb_control_get_tcp_tickle_list(ctdb, indata, outdata);
329 case CTDB_CONTROL_SET_TCP_TICKLE_LIST:
330 /* data size is verified in the called function */
331 return ctdb_control_set_tcp_tickle_list(ctdb, indata);
333 case CTDB_CONTROL_REGISTER_SERVER_ID:
334 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_server_id));
335 return ctdb_control_register_server_id(ctdb, client_id, indata);
337 case CTDB_CONTROL_UNREGISTER_SERVER_ID:
338 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_server_id));
339 return ctdb_control_unregister_server_id(ctdb, indata);
341 case CTDB_CONTROL_CHECK_SERVER_ID:
342 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_server_id));
343 return ctdb_control_check_server_id(ctdb, indata);
345 case CTDB_CONTROL_GET_SERVER_ID_LIST:
346 CHECK_CONTROL_DATA_SIZE(0);
347 return ctdb_control_get_server_id_list(ctdb, outdata);
349 case CTDB_CONTROL_PERSISTENT_STORE:
350 return ctdb_control_persistent_store(ctdb, c, indata, async_reply);
352 case CTDB_CONTROL_UPDATE_RECORD:
353 return ctdb_control_update_record(ctdb, c, indata, async_reply);
355 case CTDB_CONTROL_SEND_GRATIOUS_ARP:
356 return ctdb_control_send_gratious_arp(ctdb, indata);
358 case CTDB_CONTROL_TRANSACTION_START:
359 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
360 return ctdb_control_transaction_start(ctdb, *(uint32_t *)indata.dptr);
362 case CTDB_CONTROL_TRANSACTION_COMMIT:
363 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
364 return ctdb_control_transaction_commit(ctdb, *(uint32_t *)indata.dptr);
366 case CTDB_CONTROL_WIPE_DATABASE:
367 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_wipe_database));
368 return ctdb_control_wipe_database(ctdb, indata);
370 case CTDB_CONTROL_UPTIME:
371 return ctdb_control_uptime(ctdb, outdata);
373 case CTDB_CONTROL_START_RECOVERY:
374 return ctdb_control_start_recovery(ctdb, c, async_reply);
376 case CTDB_CONTROL_END_RECOVERY:
377 return ctdb_control_end_recovery(ctdb, c, async_reply);
379 case CTDB_CONTROL_GET_RECLOCK_FILE:
380 CHECK_CONTROL_DATA_SIZE(0);
381 return ctdb_control_get_reclock_file(ctdb, outdata);
383 case CTDB_CONTROL_TRY_DELETE_RECORDS:
384 return ctdb_control_try_delete_records(ctdb, indata, outdata);
386 case CTDB_CONTROL_ADD_PUBLIC_IP:
387 return ctdb_control_add_public_address(ctdb, indata);
389 case CTDB_CONTROL_DEL_PUBLIC_IP:
390 return ctdb_control_del_public_address(ctdb, indata);
392 case CTDB_CONTROL_GET_CAPABILITIES:
393 return ctdb->capabilities;
396 DEBUG(DEBUG_CRIT,(__location__ " Unknown CTDB control opcode %u\n", opcode));
403 send a reply for a ctdb control
405 void ctdb_request_control_reply(struct ctdb_context *ctdb, struct ctdb_req_control *c,
406 TDB_DATA *outdata, int32_t status, const char *errormsg)
408 struct ctdb_reply_control *r;
411 /* some controls send no reply */
412 if (c->flags & CTDB_CTRL_FLAG_NOREPLY) {
416 len = offsetof(struct ctdb_reply_control, data) + (outdata?outdata->dsize:0);
418 len += strlen(errormsg);
420 r = ctdb_transport_allocate(ctdb, ctdb, CTDB_REPLY_CONTROL, len, struct ctdb_reply_control);
421 CTDB_NO_MEMORY_VOID(ctdb, r);
423 r->hdr.destnode = c->hdr.srcnode;
424 r->hdr.reqid = c->hdr.reqid;
426 r->datalen = outdata?outdata->dsize:0;
427 if (outdata && outdata->dsize) {
428 memcpy(&r->data[0], outdata->dptr, outdata->dsize);
431 r->errorlen = strlen(errormsg);
432 memcpy(&r->data[r->datalen], errormsg, r->errorlen);
435 ctdb_queue_packet(ctdb, &r->hdr);
441 called when a CTDB_REQ_CONTROL packet comes in
443 void ctdb_request_control(struct ctdb_context *ctdb, struct ctdb_req_header *hdr)
445 struct ctdb_req_control *c = (struct ctdb_req_control *)hdr;
446 TDB_DATA data, *outdata;
448 bool async_reply = False;
449 const char *errormsg = NULL;
451 data.dptr = &c->data[0];
452 data.dsize = c->datalen;
454 outdata = talloc_zero(c, TDB_DATA);
456 status = ctdb_control_dispatch(ctdb, c, data, outdata, hdr->srcnode,
457 &errormsg, &async_reply);
460 ctdb_request_control_reply(ctdb, c, outdata, status, errormsg);
465 called when a CTDB_REPLY_CONTROL packet comes in
467 void ctdb_reply_control(struct ctdb_context *ctdb, struct ctdb_req_header *hdr)
469 struct ctdb_reply_control *c = (struct ctdb_reply_control *)hdr;
471 struct ctdb_control_state *state;
472 const char *errormsg = NULL;
474 state = ctdb_reqid_find(ctdb, hdr->reqid, struct ctdb_control_state);
476 DEBUG(DEBUG_ERR,("pnn %u Invalid reqid %u in ctdb_reply_control\n",
477 ctdb->pnn, hdr->reqid));
481 if (hdr->reqid != state->reqid) {
482 /* we found a record but it was the wrong one */
483 DEBUG(DEBUG_ERR, ("Dropped orphaned control reply with reqid:%u\n", hdr->reqid));
487 data.dptr = &c->data[0];
488 data.dsize = c->datalen;
490 errormsg = talloc_strndup(state,
491 (char *)&c->data[c->datalen], c->errorlen);
494 /* make state a child of the packet, so it goes away when the packet
496 talloc_steal(hdr, state);
498 state->callback(ctdb, c->status, data, errormsg, state->private_data);
501 static int ctdb_control_destructor(struct ctdb_control_state *state)
503 ctdb_reqid_remove(state->ctdb, state->reqid);
508 handle a timeout of a control
510 static void ctdb_control_timeout(struct event_context *ev, struct timed_event *te,
511 struct timeval t, void *private_data)
513 struct ctdb_control_state *state = talloc_get_type(private_data, struct ctdb_control_state);
514 TALLOC_CTX *tmp_ctx = talloc_new(ev);
516 state->ctdb->statistics.timeouts.control++;
518 talloc_steal(tmp_ctx, state);
520 state->callback(state->ctdb, -1, tdb_null,
521 "ctdb_control timed out",
522 state->private_data);
523 talloc_free(tmp_ctx);
528 send a control message to a node
530 int ctdb_daemon_send_control(struct ctdb_context *ctdb, uint32_t destnode,
531 uint64_t srvid, uint32_t opcode, uint32_t client_id,
534 ctdb_control_callback_fn_t callback,
537 struct ctdb_req_control *c;
538 struct ctdb_control_state *state;
541 if (((destnode == CTDB_BROADCAST_VNNMAP) ||
542 (destnode == CTDB_BROADCAST_ALL) ||
543 (destnode == CTDB_BROADCAST_CONNECTED)) &&
544 !(flags & CTDB_CTRL_FLAG_NOREPLY)) {
545 DEBUG(DEBUG_CRIT,("Attempt to broadcast control without NOREPLY\n"));
549 if (destnode != CTDB_BROADCAST_VNNMAP &&
550 destnode != CTDB_BROADCAST_ALL &&
551 destnode != CTDB_BROADCAST_CONNECTED &&
552 (!ctdb_validate_pnn(ctdb, destnode) ||
553 (ctdb->nodes[destnode]->flags & NODE_FLAGS_DISCONNECTED))) {
554 if (!(flags & CTDB_CTRL_FLAG_NOREPLY)) {
555 callback(ctdb, -1, tdb_null, "ctdb_control to disconnected node", private_data);
560 /* the state is made a child of private_data if possible. This means any reply
561 will be discarded if the private_data goes away */
562 state = talloc(private_data?private_data:ctdb, struct ctdb_control_state);
563 CTDB_NO_MEMORY(ctdb, state);
565 state->reqid = ctdb_reqid_new(ctdb, state);
566 state->callback = callback;
567 state->private_data = private_data;
569 state->flags = flags;
571 talloc_set_destructor(state, ctdb_control_destructor);
573 len = offsetof(struct ctdb_req_control, data) + data.dsize;
574 c = ctdb_transport_allocate(ctdb, state, CTDB_REQ_CONTROL, len,
575 struct ctdb_req_control);
576 CTDB_NO_MEMORY(ctdb, c);
577 talloc_set_name_const(c, "ctdb_req_control packet");
579 c->hdr.destnode = destnode;
580 c->hdr.reqid = state->reqid;
582 c->client_id = client_id;
585 c->datalen = data.dsize;
587 memcpy(&c->data[0], data.dptr, data.dsize);
590 ctdb_queue_packet(ctdb, &c->hdr);
592 if (flags & CTDB_CTRL_FLAG_NOREPLY) {
597 if (ctdb->tunable.control_timeout) {
598 event_add_timed(ctdb->ev, state,
599 timeval_current_ofs(ctdb->tunable.control_timeout, 0),
600 ctdb_control_timeout, state);