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_NODEMAPv4:
135 return ctdb_control_getnodemapv4(ctdb, opcode, indata, outdata);
137 case CTDB_CONTROL_GET_NODEMAP:
138 return ctdb_control_getnodemap(ctdb, opcode, indata, outdata);
140 case CTDB_CONTROL_RELOAD_NODES_FILE:
141 CHECK_CONTROL_DATA_SIZE(0);
142 return ctdb_control_reload_nodes_file(ctdb, opcode);
144 case CTDB_CONTROL_SETVNNMAP:
145 return ctdb_control_setvnnmap(ctdb, opcode, indata, outdata);
147 case CTDB_CONTROL_PULL_DB:
148 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_pulldb));
149 return ctdb_control_pull_db(ctdb, indata, outdata);
151 case CTDB_CONTROL_SET_DMASTER:
152 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_set_dmaster));
153 return ctdb_control_set_dmaster(ctdb, indata);
155 case CTDB_CONTROL_PUSH_DB:
156 return ctdb_control_push_db(ctdb, indata);
158 case CTDB_CONTROL_GET_RECMODE: {
159 return ctdb->recovery_mode;
162 case CTDB_CONTROL_SET_RECMASTER: {
163 return ctdb_control_set_recmaster(ctdb, opcode, indata);
166 case CTDB_CONTROL_GET_RECMASTER:
167 return ctdb->recovery_master;
169 case CTDB_CONTROL_GET_PID:
172 case CTDB_CONTROL_GET_PNN:
175 case CTDB_CONTROL_PING:
176 CHECK_CONTROL_DATA_SIZE(0);
177 return ctdb->statistics.num_clients;
179 case CTDB_CONTROL_GET_DBNAME: {
181 struct ctdb_db_context *ctdb_db;
183 CHECK_CONTROL_DATA_SIZE(sizeof(db_id));
184 db_id = *(uint32_t *)indata.dptr;
185 ctdb_db = find_ctdb_db(ctdb, db_id);
186 if (ctdb_db == NULL) return -1;
187 outdata->dptr = discard_const(ctdb_db->db_name);
188 outdata->dsize = strlen(ctdb_db->db_name)+1;
192 case CTDB_CONTROL_GETDBPATH: {
194 struct ctdb_db_context *ctdb_db;
196 CHECK_CONTROL_DATA_SIZE(sizeof(db_id));
197 db_id = *(uint32_t *)indata.dptr;
198 ctdb_db = find_ctdb_db(ctdb, db_id);
199 if (ctdb_db == NULL) return -1;
200 outdata->dptr = discard_const(ctdb_db->db_path);
201 outdata->dsize = strlen(ctdb_db->db_path)+1;
205 case CTDB_CONTROL_DB_ATTACH:
206 return ctdb_control_db_attach(ctdb, indata, outdata, srvid, false);
208 case CTDB_CONTROL_DB_ATTACH_PERSISTENT:
209 return ctdb_control_db_attach(ctdb, indata, outdata, srvid, true);
211 case CTDB_CONTROL_SET_CALL: {
212 struct ctdb_control_set_call *sc =
213 (struct ctdb_control_set_call *)indata.dptr;
214 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_set_call));
215 return ctdb_daemon_set_call(ctdb, sc->db_id, sc->fn, sc->id);
218 case CTDB_CONTROL_TRAVERSE_START:
219 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_traverse_start));
220 return ctdb_control_traverse_start(ctdb, indata, outdata, srcnode);
222 case CTDB_CONTROL_TRAVERSE_ALL:
223 return ctdb_control_traverse_all(ctdb, indata, outdata);
225 case CTDB_CONTROL_TRAVERSE_DATA:
226 return ctdb_control_traverse_data(ctdb, indata, outdata);
228 case CTDB_CONTROL_REGISTER_SRVID:
229 return daemon_register_message_handler(ctdb, client_id, srvid);
231 case CTDB_CONTROL_DEREGISTER_SRVID:
232 return daemon_deregister_message_handler(ctdb, client_id, srvid);
234 case CTDB_CONTROL_ENABLE_SEQNUM:
235 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
236 return ctdb_ltdb_enable_seqnum(ctdb, *(uint32_t *)indata.dptr);
238 case CTDB_CONTROL_UPDATE_SEQNUM:
239 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
240 return ctdb_ltdb_update_seqnum(ctdb, *(uint32_t *)indata.dptr, srcnode);
242 case CTDB_CONTROL_FREEZE:
243 CHECK_CONTROL_DATA_SIZE(0);
244 return ctdb_control_freeze(ctdb, c, async_reply);
246 case CTDB_CONTROL_THAW:
247 CHECK_CONTROL_DATA_SIZE(0);
248 return ctdb_control_thaw(ctdb);
250 case CTDB_CONTROL_SET_RECMODE:
251 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
252 return ctdb_control_set_recmode(ctdb, c, indata, async_reply, errormsg);
254 case CTDB_CONTROL_GET_MONMODE:
255 CHECK_CONTROL_DATA_SIZE(0);
256 return ctdb_monitoring_mode(ctdb);
258 case CTDB_CONTROL_ENABLE_MONITOR:
259 CHECK_CONTROL_DATA_SIZE(0);
260 ctdb_enable_monitoring(ctdb);
263 case CTDB_CONTROL_RUN_EVENTSCRIPTS:
264 return ctdb_run_eventscripts(ctdb, c, indata, async_reply);
266 case CTDB_CONTROL_DISABLE_MONITOR:
267 CHECK_CONTROL_DATA_SIZE(0);
268 ctdb_disable_monitoring(ctdb);
271 case CTDB_CONTROL_SHUTDOWN:
272 ctdb_stop_recoverd(ctdb);
273 ctdb_stop_keepalive(ctdb);
274 ctdb_stop_monitoring(ctdb);
275 ctdb_release_all_ips(ctdb);
276 if (ctdb->methods != NULL) {
277 ctdb->methods->shutdown(ctdb);
279 ctdb_event_script(ctdb, "shutdown");
280 DEBUG(DEBUG_NOTICE,("Received SHUTDOWN command. Stopping CTDB daemon.\n"));
283 case CTDB_CONTROL_TAKEOVER_IPv4:
284 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_public_ipv4));
285 return ctdb_control_takeover_ipv4(ctdb, c, indata, async_reply);
287 case CTDB_CONTROL_TAKEOVER_IP:
288 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_public_ip));
289 return ctdb_control_takeover_ip(ctdb, c, indata, async_reply);
291 case CTDB_CONTROL_RELEASE_IPv4:
292 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_public_ipv4));
293 return ctdb_control_release_ipv4(ctdb, c, indata, async_reply);
295 case CTDB_CONTROL_RELEASE_IP:
296 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_public_ip));
297 return ctdb_control_release_ip(ctdb, c, indata, async_reply);
299 case CTDB_CONTROL_GET_PUBLIC_IPSv4:
300 CHECK_CONTROL_DATA_SIZE(0);
301 return ctdb_control_get_public_ipsv4(ctdb, c, outdata);
303 case CTDB_CONTROL_GET_PUBLIC_IPS:
304 CHECK_CONTROL_DATA_SIZE(0);
305 return ctdb_control_get_public_ips(ctdb, c, outdata);
307 case CTDB_CONTROL_TCP_CLIENT:
308 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_tcp));
309 return ctdb_control_tcp_client(ctdb, client_id, indata);
311 case CTDB_CONTROL_STARTUP:
312 CHECK_CONTROL_DATA_SIZE(0);
313 return ctdb_control_startup(ctdb, srcnode);
315 case CTDB_CONTROL_TCP_ADD:
316 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_tcp_vnn));
317 return ctdb_control_tcp_add(ctdb, indata);
319 case CTDB_CONTROL_SET_TUNABLE:
320 return ctdb_control_set_tunable(ctdb, indata);
322 case CTDB_CONTROL_GET_TUNABLE:
323 return ctdb_control_get_tunable(ctdb, indata, outdata);
325 case CTDB_CONTROL_LIST_TUNABLES:
326 return ctdb_control_list_tunables(ctdb, outdata);
328 case CTDB_CONTROL_MODIFY_FLAGS:
329 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_node_flag_change));
330 return ctdb_control_modflags(ctdb, indata);
332 case CTDB_CONTROL_KILL_TCP:
333 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_killtcp));
334 return ctdb_control_kill_tcp(ctdb, indata);
336 case CTDB_CONTROL_GET_TCP_TICKLE_LIST:
337 CHECK_CONTROL_DATA_SIZE(sizeof(ctdb_sock_addr));
338 return ctdb_control_get_tcp_tickle_list(ctdb, indata, outdata);
340 case CTDB_CONTROL_SET_TCP_TICKLE_LIST:
341 /* data size is verified in the called function */
342 return ctdb_control_set_tcp_tickle_list(ctdb, indata);
344 case CTDB_CONTROL_REGISTER_SERVER_ID:
345 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_server_id));
346 return ctdb_control_register_server_id(ctdb, client_id, indata);
348 case CTDB_CONTROL_UNREGISTER_SERVER_ID:
349 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_server_id));
350 return ctdb_control_unregister_server_id(ctdb, indata);
352 case CTDB_CONTROL_CHECK_SERVER_ID:
353 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_server_id));
354 return ctdb_control_check_server_id(ctdb, indata);
356 case CTDB_CONTROL_GET_SERVER_ID_LIST:
357 CHECK_CONTROL_DATA_SIZE(0);
358 return ctdb_control_get_server_id_list(ctdb, outdata);
360 case CTDB_CONTROL_PERSISTENT_STORE:
361 return ctdb_control_persistent_store(ctdb, c, indata, async_reply);
363 case CTDB_CONTROL_UPDATE_RECORD:
364 return ctdb_control_update_record(ctdb, c, indata, async_reply);
366 case CTDB_CONTROL_SEND_GRATIOUS_ARP:
367 return ctdb_control_send_gratious_arp(ctdb, indata);
369 case CTDB_CONTROL_TRANSACTION_START:
370 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
371 return ctdb_control_transaction_start(ctdb, *(uint32_t *)indata.dptr);
373 case CTDB_CONTROL_TRANSACTION_COMMIT:
374 CHECK_CONTROL_DATA_SIZE(sizeof(uint32_t));
375 return ctdb_control_transaction_commit(ctdb, *(uint32_t *)indata.dptr);
377 case CTDB_CONTROL_WIPE_DATABASE:
378 CHECK_CONTROL_DATA_SIZE(sizeof(struct ctdb_control_wipe_database));
379 return ctdb_control_wipe_database(ctdb, indata);
381 case CTDB_CONTROL_UPTIME:
382 return ctdb_control_uptime(ctdb, outdata);
384 case CTDB_CONTROL_START_RECOVERY:
385 return ctdb_control_start_recovery(ctdb, c, async_reply);
387 case CTDB_CONTROL_END_RECOVERY:
388 return ctdb_control_end_recovery(ctdb, c, async_reply);
390 case CTDB_CONTROL_TRY_DELETE_RECORDS:
391 return ctdb_control_try_delete_records(ctdb, indata, outdata);
393 case CTDB_CONTROL_ADD_PUBLIC_IP:
394 return ctdb_control_add_public_address(ctdb, indata);
396 case CTDB_CONTROL_DEL_PUBLIC_IP:
397 return ctdb_control_del_public_address(ctdb, indata);
399 case CTDB_CONTROL_GET_CAPABILITIES:
400 return ctdb_control_get_capabilities(ctdb, outdata);
402 case CTDB_CONTROL_START_PERSISTENT_UPDATE:
403 return ctdb_control_start_persistent_update(ctdb, c, indata);
405 case CTDB_CONTROL_CANCEL_PERSISTENT_UPDATE:
406 return ctdb_control_cancel_persistent_update(ctdb, c, indata);
408 case CTDB_CONTROL_TRANS2_COMMIT:
409 case CTDB_CONTROL_TRANS2_COMMIT_RETRY:
410 return ctdb_control_trans2_commit(ctdb, c, indata, async_reply);
412 case CTDB_CONTROL_TRANS2_ERROR:
413 return ctdb_control_trans2_error(ctdb, c);
415 case CTDB_CONTROL_TRANS2_FINISHED:
416 return ctdb_control_trans2_finished(ctdb, c);
418 case CTDB_CONTROL_RECD_PING:
419 CHECK_CONTROL_DATA_SIZE(0);
420 return ctdb_control_recd_ping(ctdb);
423 DEBUG(DEBUG_CRIT,(__location__ " Unknown CTDB control opcode %u\n", opcode));
429 send a reply for a ctdb control
431 void ctdb_request_control_reply(struct ctdb_context *ctdb, struct ctdb_req_control *c,
432 TDB_DATA *outdata, int32_t status, const char *errormsg)
434 struct ctdb_reply_control *r;
437 /* some controls send no reply */
438 if (c->flags & CTDB_CTRL_FLAG_NOREPLY) {
442 len = offsetof(struct ctdb_reply_control, data) + (outdata?outdata->dsize:0);
444 len += strlen(errormsg);
446 r = ctdb_transport_allocate(ctdb, ctdb, CTDB_REPLY_CONTROL, len, struct ctdb_reply_control);
447 CTDB_NO_MEMORY_VOID(ctdb, r);
449 r->hdr.destnode = c->hdr.srcnode;
450 r->hdr.reqid = c->hdr.reqid;
452 r->datalen = outdata?outdata->dsize:0;
453 if (outdata && outdata->dsize) {
454 memcpy(&r->data[0], outdata->dptr, outdata->dsize);
457 r->errorlen = strlen(errormsg);
458 memcpy(&r->data[r->datalen], errormsg, r->errorlen);
461 ctdb_queue_packet_opcode(ctdb, &r->hdr, c->opcode);
467 called when a CTDB_REQ_CONTROL packet comes in
469 void ctdb_request_control(struct ctdb_context *ctdb, struct ctdb_req_header *hdr)
471 struct ctdb_req_control *c = (struct ctdb_req_control *)hdr;
472 TDB_DATA data, *outdata;
474 bool async_reply = False;
475 const char *errormsg = NULL;
477 data.dptr = &c->data[0];
478 data.dsize = c->datalen;
480 outdata = talloc_zero(c, TDB_DATA);
482 status = ctdb_control_dispatch(ctdb, c, data, outdata, hdr->srcnode,
483 &errormsg, &async_reply);
486 ctdb_request_control_reply(ctdb, c, outdata, status, errormsg);
491 called when a CTDB_REPLY_CONTROL packet comes in
493 void ctdb_reply_control(struct ctdb_context *ctdb, struct ctdb_req_header *hdr)
495 struct ctdb_reply_control *c = (struct ctdb_reply_control *)hdr;
497 struct ctdb_control_state *state;
498 const char *errormsg = NULL;
500 state = ctdb_reqid_find(ctdb, hdr->reqid, struct ctdb_control_state);
502 DEBUG(DEBUG_ERR,("pnn %u Invalid reqid %u in ctdb_reply_control\n",
503 ctdb->pnn, hdr->reqid));
507 if (hdr->reqid != state->reqid) {
508 /* we found a record but it was the wrong one */
509 DEBUG(DEBUG_ERR, ("Dropped orphaned control reply with reqid:%u\n", hdr->reqid));
513 data.dptr = &c->data[0];
514 data.dsize = c->datalen;
516 errormsg = talloc_strndup(state,
517 (char *)&c->data[c->datalen], c->errorlen);
520 /* make state a child of the packet, so it goes away when the packet
522 talloc_steal(hdr, state);
524 state->callback(ctdb, c->status, data, errormsg, state->private_data);
527 static int ctdb_control_destructor(struct ctdb_control_state *state)
529 ctdb_reqid_remove(state->ctdb, state->reqid);
534 handle a timeout of a control
536 static void ctdb_control_timeout(struct event_context *ev, struct timed_event *te,
537 struct timeval t, void *private_data)
539 struct ctdb_control_state *state = talloc_get_type(private_data, struct ctdb_control_state);
540 TALLOC_CTX *tmp_ctx = talloc_new(ev);
542 state->ctdb->statistics.timeouts.control++;
544 talloc_steal(tmp_ctx, state);
546 state->callback(state->ctdb, -1, tdb_null,
547 "ctdb_control timed out",
548 state->private_data);
549 talloc_free(tmp_ctx);
554 send a control message to a node
556 int ctdb_daemon_send_control(struct ctdb_context *ctdb, uint32_t destnode,
557 uint64_t srvid, uint32_t opcode, uint32_t client_id,
560 ctdb_control_callback_fn_t callback,
563 struct ctdb_req_control *c;
564 struct ctdb_control_state *state;
567 if (((destnode == CTDB_BROADCAST_VNNMAP) ||
568 (destnode == CTDB_BROADCAST_ALL) ||
569 (destnode == CTDB_BROADCAST_CONNECTED)) &&
570 !(flags & CTDB_CTRL_FLAG_NOREPLY)) {
571 DEBUG(DEBUG_CRIT,("Attempt to broadcast control without NOREPLY\n"));
575 if (destnode != CTDB_BROADCAST_VNNMAP &&
576 destnode != CTDB_BROADCAST_ALL &&
577 destnode != CTDB_BROADCAST_CONNECTED &&
578 (!ctdb_validate_pnn(ctdb, destnode) ||
579 (ctdb->nodes[destnode]->flags & NODE_FLAGS_DISCONNECTED))) {
580 if (!(flags & CTDB_CTRL_FLAG_NOREPLY)) {
581 callback(ctdb, -1, tdb_null, "ctdb_control to disconnected node", private_data);
586 /* the state is made a child of private_data if possible. This means any reply
587 will be discarded if the private_data goes away */
588 state = talloc(private_data?private_data:ctdb, struct ctdb_control_state);
589 CTDB_NO_MEMORY(ctdb, state);
591 state->reqid = ctdb_reqid_new(ctdb, state);
592 state->callback = callback;
593 state->private_data = private_data;
595 state->flags = flags;
597 talloc_set_destructor(state, ctdb_control_destructor);
599 len = offsetof(struct ctdb_req_control, data) + data.dsize;
600 c = ctdb_transport_allocate(ctdb, state, CTDB_REQ_CONTROL, len,
601 struct ctdb_req_control);
602 CTDB_NO_MEMORY(ctdb, c);
603 talloc_set_name_const(c, "ctdb_req_control packet");
605 c->hdr.destnode = destnode;
606 c->hdr.reqid = state->reqid;
608 c->client_id = client_id;
611 c->datalen = data.dsize;
613 memcpy(&c->data[0], data.dptr, data.dsize);
616 ctdb_queue_packet(ctdb, &c->hdr);
618 if (flags & CTDB_CTRL_FLAG_NOREPLY) {
623 if (ctdb->tunable.control_timeout) {
624 event_add_timed(ctdb->ev, state,
625 timeval_current_ofs(ctdb->tunable.control_timeout, 0),
626 ctdb_control_timeout, state);