server/eventscript.c

   1 /*
   2    event script handling
   3
   4    Copyright (C) Andrew Tridgell  2007
   5
   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.
  10
  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.
  15
  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/>.
  18 */
  19
  20 #include "includes.h"
  21 #include <time.h>
  22 #include "system/filesys.h"
  23 #include "system/wait.h"
  24 #include "system/dir.h"
  25 #include "system/locale.h"
  26 #include "../include/ctdb_private.h"
  27 #include "lib/events/events.h"
  28 #include "../common/rb_tree.h"
  29
  30 static struct {
  31         struct timeval start;
  32         const char *script_running;
  33 } child_state;
  34
  35 static const char *call_names[] = {
  36         "startup",
  37         "startrecovery",
  38         "recovered",
  39         "takeip",
  40         "releaseip",
  41         "stopped",
  42         "monitor",
  43         "status",
  44         "shutdown",
  45         "reload"
  46 };
  47
  48 static void ctdb_event_script_timeout(struct event_context *ev, struct timed_event *te, struct timeval t, void *p);
  49
  50 /*
  51   ctdbd sends us a SIGTERM when we should time out the current script
  52  */
  53 static void sigterm(int sig)
  54 {
  55         char tbuf[100], buf[200];
  56         time_t t;
  57
  58         DEBUG(DEBUG_ERR,("Timed out running script '%s' after %.1f seconds pid :%d\n",
  59                  child_state.script_running, timeval_elapsed(&child_state.start), getpid()));
  60
  61         t = time(NULL);
  62
  63         strftime(tbuf, sizeof(tbuf)-1, "%Y%m%d%H%M%S",  localtime(&t));
  64         sprintf(buf, "pstree -p >/tmp/ctdb.event.%s.%d", tbuf, getpid());
  65         system(buf);
  66
  67         DEBUG(DEBUG_ERR,("Logged timedout eventscript : %s\n", buf));
  68
  69         /* all the child processes will be running in the same process group */
  70         kill(-getpgrp(), SIGKILL);
  71         _exit(1);
  72 }
  73
  74 struct ctdb_event_script_state {
  75         struct ctdb_context *ctdb;
  76         pid_t child;
  77         /* Warning: this can free us! */
  78         void (*callback)(struct ctdb_context *, int, void *);
  79         int cb_status;
  80         int fd[2];
  81         void *private_data;
  82         enum ctdb_eventscript_call call;
  83         const char *options;
  84         struct timeval timeout;
  85 };
  86
  87
  88 struct ctdb_monitor_script_status {
  89         struct ctdb_monitor_script_status *next;
  90         const char *name;
  91         struct timeval start;
  92         struct timeval finished;
  93         int32_t disabled;
  94         int32_t status;
  95         int32_t timedout;
  96         char *output;
  97 };
  98
  99 struct ctdb_monitor_script_status_ctx {
 100         struct ctdb_monitor_script_status *scripts;
 101 };
 102
 103 /* called from ctdb_logging when we have received output on STDERR from
 104  * one of the eventscripts
 105  */
 106 int ctdb_log_event_script_output(struct ctdb_context *ctdb, char *str, uint16_t len)
 107 {
 108         struct ctdb_monitor_script_status *script;
 109
 110         if (ctdb->current_monitor_status_ctx == NULL) {
 111                 return -1;
 112         }
 113
 114         script = ctdb->current_monitor_status_ctx->scripts;
 115         if (script == NULL) {
 116                 return -1;
 117         }
 118
 119         if (script->output == NULL) {
 120                 script->output = talloc_asprintf(script, "%*.*s", len, len, str);
 121         } else {
 122                 script->output = talloc_asprintf_append(script->output, "%*.*s", len, len, str);
 123         }
 124
 125         return 0;
 126 }
 127
 128 /* called from the event script child process when we are starting a new
 129  * monitor event
 130  */
 131 int32_t ctdb_control_event_script_init(struct ctdb_context *ctdb)
 132 {
 133         DEBUG(DEBUG_INFO, ("event script init called\n"));
 134
 135         if (ctdb->current_monitor_status_ctx == NULL) {
 136                 DEBUG(DEBUG_ERR,(__location__ " current_monitor_status_ctx is NULL when initing script\n"));
 137                 return -1;
 138         }
 139
 140         return 0;
 141 }
 142
 143
 144 /* called from the event script child process when we are star running
 145  * an eventscript
 146  */
 147 int32_t ctdb_control_event_script_start(struct ctdb_context *ctdb, TDB_DATA indata)
 148 {
 149         const char *name = (const char *)indata.dptr;
 150         struct ctdb_monitor_script_status *script;
 151
 152         DEBUG(DEBUG_INFO, ("event script start called : %s\n", name));
 153
 154         if (ctdb->current_monitor_status_ctx == NULL) {
 155                 DEBUG(DEBUG_ERR,(__location__ " current_monitor_status_ctx is NULL when starting script\n"));
 156                 return -1;
 157         }
 158
 159         script = talloc_zero(ctdb->current_monitor_status_ctx, struct ctdb_monitor_script_status);
 160         if (script == NULL) {
 161                 DEBUG(DEBUG_ERR,(__location__ " Failed to talloc ctdb_monitor_script_status for script %s\n", name));
 162                 return -1;
 163         }
 164
 165         script->next  = ctdb->current_monitor_status_ctx->scripts;
 166         script->name  = talloc_strdup(script, name);
 167         CTDB_NO_MEMORY(ctdb, script->name);
 168         script->start = timeval_current();
 169         ctdb->current_monitor_status_ctx->scripts = script;
 170
 171         return 0;
 172 }
 173
 174 /* called from the event script child process when we have finished running
 175  * an eventscript
 176  */
 177 int32_t ctdb_control_event_script_stop(struct ctdb_context *ctdb, TDB_DATA indata)
 178 {
 179         int32_t res = *((int32_t *)indata.dptr);
 180         struct ctdb_monitor_script_status *script;
 181
 182         if (ctdb->current_monitor_status_ctx == NULL) {
 183                 DEBUG(DEBUG_ERR,(__location__ " current_monitor_status_ctx is NULL when script finished\n"));
 184                 return -1;
 185         }
 186
 187         script = ctdb->current_monitor_status_ctx->scripts;
 188         if (script == NULL) {
 189                 DEBUG(DEBUG_ERR,(__location__ " script is NULL when the script had finished\n"));
 190                 return -1;
 191         }
 192
 193         script->finished = timeval_current();
 194         script->status   = res;
 195
 196         DEBUG(DEBUG_INFO, ("event script stop called for script:%s duration:%.1f status:%d\n", script->name, timeval_elapsed(&script->start), (int)res));
 197
 198         return 0;
 199 }
 200
 201 /* called from the event script child process when we have a disabled script
 202  */
 203 int32_t ctdb_control_event_script_disabled(struct ctdb_context *ctdb, TDB_DATA indata)
 204 {
 205         const char *name = (const char *)indata.dptr;
 206         struct ctdb_monitor_script_status *script;
 207
 208         DEBUG(DEBUG_INFO, ("event script disabed called for script %s\n", name));
 209
 210         if (ctdb->current_monitor_status_ctx == NULL) {
 211                 DEBUG(DEBUG_ERR,(__location__ " current_monitor_status_ctx is NULL when script finished\n"));
 212                 return -1;
 213         }
 214
 215         script = ctdb->current_monitor_status_ctx->scripts;
 216         if (script == NULL) {
 217                 DEBUG(DEBUG_ERR,(__location__ " script is NULL when the script had finished\n"));
 218                 return -1;
 219         }
 220
 221         script->finished = timeval_current();
 222         script->status   = 0;
 223         script->disabled = 1;
 224
 225         return 0;
 226 }
 227
 228 /* called from the event script child process when we have completed a
 229  * monitor event
 230  */
 231 int32_t ctdb_control_event_script_finished(struct ctdb_context *ctdb)
 232 {
 233         DEBUG(DEBUG_INFO, ("event script finished called\n"));
 234
 235         if (ctdb->current_monitor_status_ctx == NULL) {
 236                 DEBUG(DEBUG_ERR,(__location__ " script_status is NULL when monitoring event finished\n"));
 237                 return -1;
 238         }
 239
 240         if (ctdb->last_monitor_status_ctx) {
 241                 talloc_free(ctdb->last_monitor_status_ctx);
 242                 ctdb->last_monitor_status_ctx = NULL;
 243         }
 244         ctdb->last_monitor_status_ctx = ctdb->current_monitor_status_ctx;
 245         ctdb->current_monitor_status_ctx = NULL;
 246
 247         return 0;
 248 }
 249
 250 static struct ctdb_monitoring_wire *marshall_monitoring_scripts(TALLOC_CTX *mem_ctx, struct ctdb_monitoring_wire *monitoring_scripts, struct ctdb_monitor_script_status *script)
 251 {
 252         struct ctdb_monitoring_script_wire script_wire;
 253         size_t size;
 254
 255         if (script == NULL) {
 256                 return monitoring_scripts;
 257         }
 258         monitoring_scripts = marshall_monitoring_scripts(mem_ctx, monitoring_scripts, script->next);
 259         if (monitoring_scripts == NULL) {
 260                 return NULL;
 261         }
 262
 263         bzero(&script_wire, sizeof(struct ctdb_monitoring_script_wire));
 264         strncpy(script_wire.name, script->name, MAX_SCRIPT_NAME);
 265         script_wire.start    = script->start;
 266         script_wire.finished = script->finished;
 267         script_wire.disabled = script->disabled;
 268         script_wire.status   = script->status;
 269         script_wire.timedout = script->timedout;
 270         if (script->output != NULL) {
 271                 strncpy(script_wire.output, script->output, MAX_SCRIPT_OUTPUT);
 272         }
 273
 274         size = talloc_get_size(monitoring_scripts);
 275         monitoring_scripts = talloc_realloc_size(mem_ctx, monitoring_scripts, size + sizeof(struct ctdb_monitoring_script_wire));
 276         if (monitoring_scripts == NULL) {
 277                 DEBUG(DEBUG_ERR,(__location__ " Failed to talloc_resize monitoring_scripts blob\n"));
 278                 return NULL;
 279         }
 280
 281         memcpy(&monitoring_scripts->scripts[monitoring_scripts->num_scripts], &script_wire, sizeof(script_wire));
 282         monitoring_scripts->num_scripts++;
 283
 284         return monitoring_scripts;
 285 }
 286
 287 int32_t ctdb_control_get_event_script_status(struct ctdb_context *ctdb, TDB_DATA *outdata)
 288 {
 289         struct ctdb_monitor_script_status_ctx *script_status = talloc_get_type(ctdb->last_monitor_status_ctx, struct ctdb_monitor_script_status_ctx);
 290         struct ctdb_monitoring_wire *monitoring_scripts;
 291
 292         if (script_status == NULL) {
 293                 DEBUG(DEBUG_ERR,(__location__ " last_monitor_status_ctx is NULL when reading status\n"));
 294                 return -1;
 295         }
 296
 297         monitoring_scripts = talloc_size(outdata, offsetof(struct ctdb_monitoring_wire, scripts));
 298         if (monitoring_scripts == NULL) {
 299                 DEBUG(DEBUG_ERR,(__location__ " failed to talloc monitoring_scripts structure\n"));
 300                 return -1;
 301         }
 302
 303         monitoring_scripts->num_scripts = 0;
 304         monitoring_scripts = marshall_monitoring_scripts(outdata, monitoring_scripts, script_status->scripts);
 305         if (monitoring_scripts == NULL) {
 306                 DEBUG(DEBUG_ERR,(__location__ " Monitoring scritps is NULL. can not return data to client\n"));
 307                 return -1;
 308         }
 309
 310         outdata->dsize = talloc_get_size(monitoring_scripts);
 311         outdata->dptr  = (uint8_t *)monitoring_scripts;
 312
 313         return 0;
 314 }
 315
 316 struct ctdb_script_tree_item {
 317         const char *name;
 318         int32_t is_enabled;
 319 };
 320
 321 struct ctdb_script_list {
 322         struct ctdb_script_list *next;
 323         const char *name;
 324         int32_t is_enabled;
 325 };
 326
 327 static struct ctdb_script_list *ctdb_get_script_list(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx)
 328 {
 329         DIR *dir;
 330         struct dirent *de;
 331         struct stat st;
 332         trbt_tree_t *tree;
 333         struct ctdb_script_list *head, *tail, *new_item;
 334         TALLOC_CTX *tmp_ctx = talloc_new(ctdb);
 335         struct ctdb_script_tree_item *tree_item;
 336         int count;
 337
 338         /*
 339           the service specific event scripts
 340         */
 341         if (stat(ctdb->event_script_dir, &st) != 0 &&
 342             errno == ENOENT) {
 343                 DEBUG(DEBUG_CRIT,("No event script directory found at '%s'\n", ctdb->event_script_dir));
 344                 talloc_free(tmp_ctx);
 345                 return NULL;
 346         }
 347
 348         /* create a tree to store all the script names in */
 349         tree = trbt_create(tmp_ctx, 0);
 350
 351         /* scan all directory entries and insert all valid scripts into the
 352            tree
 353         */
 354         dir = opendir(ctdb->event_script_dir);
 355         if (dir == NULL) {
 356                 DEBUG(DEBUG_CRIT,("Failed to open event script directory '%s'\n", ctdb->event_script_dir));
 357                 talloc_free(tmp_ctx);
 358                 return NULL;
 359         }
 360
 361         count = 0;
 362         while ((de=readdir(dir)) != NULL) {
 363                 int namlen;
 364                 unsigned num;
 365                 char *str;
 366
 367                 namlen = strlen(de->d_name);
 368
 369                 if (namlen < 3) {
 370                         continue;
 371                 }
 372
 373                 if (de->d_name[namlen-1] == '~') {
 374                         /* skip files emacs left behind */
 375                         continue;
 376                 }
 377
 378                 if (de->d_name[2] != '.') {
 379                         continue;
 380                 }
 381
 382                 if (sscanf(de->d_name, "%02u.", &num) != 1) {
 383                         continue;
 384                 }
 385
 386                 /* Make sure the event script is executable */
 387                 str = talloc_asprintf(tree, "%s/%s", ctdb->event_script_dir, de->d_name);
 388                 if (stat(str, &st) != 0) {
 389                         DEBUG(DEBUG_ERR,("Could not stat event script %s. Ignoring this event script\n", str));
 390                         continue;
 391                 }
 392
 393
 394                 tree_item = talloc(tree, struct ctdb_script_tree_item);
 395                 if (tree_item == NULL) {
 396                         DEBUG(DEBUG_ERR, (__location__ " Failed to allocate new tree item\n"));
 397                         talloc_free(tmp_ctx);
 398                         return NULL;
 399                 }
 400
 401                 tree_item->is_enabled = 1;
 402                 if (!(st.st_mode & S_IXUSR)) {
 403                         DEBUG(DEBUG_INFO,("Event script %s is not executable. Ignoring this event script\n", str));
 404                         tree_item->is_enabled = 0;
 405                 }
 406
 407                 tree_item->name = talloc_strdup(tree_item, de->d_name);
 408                 if (tree_item->name == NULL) {
 409                         DEBUG(DEBUG_ERR,(__location__ " Failed to allocate script name.\n"));
 410                         talloc_free(tmp_ctx);
 411                         return NULL;
 412                 }
 413
 414                 /* store the event script in the tree */
 415                 trbt_insert32(tree, (num<<16)|count++, tree_item);
 416         }
 417         closedir(dir);
 418
 419
 420         head = NULL;
 421         tail = NULL;
 422
 423         /* fetch the scripts from the tree one by one and add them to the linked
 424            list
 425          */
 426         while ((tree_item=trbt_findfirstarray32(tree, 1)) != NULL) {
 427
 428                 new_item = talloc(tmp_ctx, struct ctdb_script_list);
 429                 if (new_item == NULL) {
 430                         DEBUG(DEBUG_ERR, (__location__ " Failed to allocate new list item\n"));
 431                         talloc_free(tmp_ctx);
 432                         return NULL;
 433                 }
 434
 435                 new_item->next = NULL;
 436                 new_item->name = talloc_steal(new_item, tree_item->name);
 437                 new_item->is_enabled = tree_item->is_enabled;
 438
 439                 if (head == NULL) {
 440                         head = new_item;
 441                         tail = new_item;
 442                 } else {
 443                         tail->next = new_item;
 444                         tail = new_item;
 445                 }
 446
 447                 talloc_steal(mem_ctx, new_item);
 448
 449                 /* remove this script from the tree */
 450                 talloc_free(tree_item);
 451         }
 452
 453         talloc_free(tmp_ctx);
 454         return head;
 455 }
 456
 457
 458
 459 /*
 460   Actually run the event script
 461   this function is called and run in the context of a forked child
 462   which allows it to do blocking calls such as system()
 463  */
 464 static int ctdb_run_event_script(struct ctdb_context *ctdb,
 465                                  bool from_user,
 466                                  enum ctdb_eventscript_call call,
 467                                  const char *options)
 468 {
 469         char *cmdstr;
 470         int ret;
 471         TALLOC_CTX *tmp_ctx = talloc_new(ctdb);
 472         struct ctdb_script_list *scripts, *current;
 473
 474         if (!from_user && call == CTDB_EVENT_MONITOR) {
 475                 /* This is running in the forked child process. At this stage
 476                  * we want to switch from being a ctdb daemon into being a
 477                  * client and connect to the real local daemon.
 478                  */
 479                 if (switch_from_server_to_client(ctdb) != 0) {
 480                         DEBUG(DEBUG_CRIT, (__location__ "ERROR: failed to switch eventscript child into client mode. shutting down.\n"));
 481                         _exit(1);
 482                 }
 483
 484                 if (ctdb_ctrl_event_script_init(ctdb) != 0) {
 485                         DEBUG(DEBUG_ERR,(__location__ " Failed to init event script monitoring\n"));
 486                         talloc_free(tmp_ctx);
 487                         return -1;
 488                 }
 489         }
 490
 491         if (ctdb->recovery_mode != CTDB_RECOVERY_NORMAL) {
 492                 /* we guarantee that only some specifically allowed event scripts are run
 493                    while in recovery */
 494                 const enum ctdb_eventscript_call allowed_calls[] = {
 495                         CTDB_EVENT_START_RECOVERY, CTDB_EVENT_SHUTDOWN, CTDB_EVENT_RELEASE_IP, CTDB_EVENT_STOPPED };
 496                 int i;
 497                 for (i=0;i<ARRAY_SIZE(allowed_calls);i++) {
 498                         if (call == allowed_calls[i]) break;
 499                 }
 500                 if (i == ARRAY_SIZE(allowed_calls)) {
 501                         DEBUG(DEBUG_ERR,("Refusing to run event scripts call '%s' while in recovery\n",
 502                                  call_names[call]));
 503                         talloc_free(tmp_ctx);
 504                         return -1;
 505                 }
 506         }
 507
 508         if (setpgid(0,0) != 0) {
 509                 DEBUG(DEBUG_ERR,("Failed to create process group for event scripts - %s\n",
 510                          strerror(errno)));
 511                 talloc_free(tmp_ctx);
 512                 return -1;
 513         }
 514
 515         signal(SIGTERM, sigterm);
 516
 517         child_state.start = timeval_current();
 518         child_state.script_running = "startup";
 519
 520         scripts = ctdb_get_script_list(ctdb, tmp_ctx);
 521
 522         /* fetch the scripts from the tree one by one and execute
 523            them
 524          */
 525         for (current=scripts; current; current=current->next) {
 526                 const char *str = from_user ? "CTDB_CALLED_BY_USER=1 " : "";
 527
 528                 /* Allow a setting where we run the actual monitor event
 529                    from an external source and replace it with
 530                    a "status" event that just picks up the actual
 531                    status of the event asynchronously.
 532                 */
 533                 if ((ctdb->tunable.use_status_events_for_monitoring != 0)
 534                 &&  (call == CTDB_EVENT_MONITOR)
 535                 &&  !from_user) {
 536                         cmdstr = talloc_asprintf(tmp_ctx, "%s%s/%s %s",
 537                                         str,
 538                                         ctdb->event_script_dir,
 539                                         current->name, "status");
 540                 } else {
 541                         cmdstr = talloc_asprintf(tmp_ctx, "%s%s/%s %s %s",
 542                                         str,
 543                                         ctdb->event_script_dir,
 544                                         current->name, call_names[call], options);
 545                 }
 546                 CTDB_NO_MEMORY(ctdb, cmdstr);
 547
 548                 DEBUG(DEBUG_INFO,("Executing event script %s\n",cmdstr));
 549
 550                 child_state.start = timeval_current();
 551                 child_state.script_running = cmdstr;
 552
 553                 if (!from_user && call == CTDB_EVENT_MONITOR) {
 554                         if (ctdb_ctrl_event_script_start(ctdb, current->name) != 0) {
 555                                 DEBUG(DEBUG_ERR,(__location__ " Failed to start event script monitoring\n"));
 556                                 talloc_free(tmp_ctx);
 557                                 return -1;
 558                         }
 559
 560                         if (!current->is_enabled) {
 561                                 if (ctdb_ctrl_event_script_disabled(ctdb, current->name) != 0) {
 562                                         DEBUG(DEBUG_ERR,(__location__ " Failed to report disabled eventscript\n"));
 563                                         talloc_free(tmp_ctx);
 564                                         return -1;
 565                                 }
 566                         }
 567
 568                 }
 569
 570                 if (!current->is_enabled) {
 571                         continue;
 572                 }
 573
 574                 ret = system(cmdstr);
 575                 /* if the system() call was successful, translate ret into the
 576                    return code from the command
 577                 */
 578                 if (ret != -1) {
 579                         ret = WEXITSTATUS(ret);
 580                 }
 581                 if (ret == 127) {
 582                         ret = 0;
 583                         DEBUG(DEBUG_ERR,("Script %s returned status 127. Someone just deleted it?\n", cmdstr));
 584                 }
 585
 586                 if (!from_user && call == CTDB_EVENT_MONITOR) {
 587                         if (ctdb_ctrl_event_script_stop(ctdb, ret) != 0) {
 588                                 DEBUG(DEBUG_ERR,(__location__ " Failed to stop event script monitoring\n"));
 589                                 talloc_free(tmp_ctx);
 590                                 return -1;
 591                         }
 592                 }
 593
 594                 /* return an error if the script failed */
 595                 if (ret != 0) {
 596                         DEBUG(DEBUG_ERR,("Event script %s failed with error %d\n", cmdstr, ret));
 597                         if (!from_user && call == CTDB_EVENT_MONITOR) {
 598                                 if (ctdb_ctrl_event_script_finished(ctdb) != 0) {
 599                                         DEBUG(DEBUG_ERR,(__location__ " Failed to finish event script monitoring\n"));
 600                                         talloc_free(tmp_ctx);
 601                                         return -1;
 602                                 }
 603                         }
 604
 605                         talloc_free(tmp_ctx);
 606                         return ret;
 607                 }
 608         }
 609
 610         child_state.start = timeval_current();
 611         child_state.script_running = "finished";
 612
 613         if (!from_user && call == CTDB_EVENT_MONITOR) {
 614                 if (ctdb_ctrl_event_script_finished(ctdb) != 0) {
 615                         DEBUG(DEBUG_ERR,(__location__ " Failed to finish event script monitoring\n"));
 616                         talloc_free(tmp_ctx);
 617                         return -1;
 618                 }
 619         }
 620
 621         talloc_free(tmp_ctx);
 622         return 0;
 623 }
 624
 625 /* called when child is finished */
 626 static void ctdb_event_script_handler(struct event_context *ev, struct fd_event *fde,
 627                                       uint16_t flags, void *p)
 628 {
 629         struct ctdb_event_script_state *state =
 630                 talloc_get_type(p, struct ctdb_event_script_state);
 631         struct ctdb_context *ctdb = state->ctdb;
 632
 633         if (read(state->fd[0], &state->cb_status, sizeof(state->cb_status)) !=
 634             sizeof(state->cb_status)) {
 635                 state->cb_status = -2;
 636         }
 637
 638         DEBUG(DEBUG_INFO,(__location__ " Eventscript %s %s finished with state %d\n",
 639                           call_names[state->call], state->options, state->cb_status));
 640
 641         state->child = 0;
 642         ctdb->event_script_timeouts = 0;
 643         talloc_free(state);
 644 }
 645
 646 static void ctdb_ban_self(struct ctdb_context *ctdb, uint32_t ban_period)
 647 {
 648         TDB_DATA data;
 649         struct ctdb_ban_time bantime;
 650
 651         bantime.pnn  = ctdb->pnn;
 652         bantime.time = ban_period;
 653
 654         data.dsize = sizeof(bantime);
 655         data.dptr  = (uint8_t *)&bantime;
 656
 657         ctdb_control_set_ban_state(ctdb, data);
 658 }
 659
 660
 661 /* called when child times out */
 662 static void ctdb_event_script_timeout(struct event_context *ev, struct timed_event *te,
 663                                       struct timeval t, void *p)
 664 {
 665         struct ctdb_event_script_state *state = talloc_get_type(p, struct ctdb_event_script_state);
 666         struct ctdb_context *ctdb = state->ctdb;
 667
 668         DEBUG(DEBUG_ERR,("Event script timed out : %s %s count : %u  pid : %d\n",
 669                          call_names[state->call], state->options, ctdb->event_script_timeouts, state->child));
 670
 671         if (kill(state->child, 0) != 0) {
 672                 DEBUG(DEBUG_ERR,("Event script child process already dead, errno %s(%d)\n", strerror(errno), errno));
 673                 state->child = 0;
 674                 talloc_free(state);
 675                 return;
 676         }
 677
 678         if (state->call == CTDB_EVENT_MONITOR) {
 679                 /* if it is a monitor event, we allow it to "hang" a few times
 680                    before we declare it a failure and ban ourself (and make
 681                    ourself unhealthy)
 682                 */
 683                 DEBUG(DEBUG_ERR, (__location__ " eventscript for monitor event timedout.\n"));
 684
 685                 ctdb->event_script_timeouts++;
 686
 687                 if (ctdb->event_script_timeouts > ctdb->tunable.script_ban_count) {
 688                         DEBUG(DEBUG_ERR, ("Maximum timeout count %u reached for eventscript. Making node unhealthy\n", ctdb->tunable.script_ban_count));
 689                         state->cb_status = -ETIME;
 690                 } else {
 691                         state->cb_status = 0;
 692                 }
 693         } else if (state->call == CTDB_EVENT_STARTUP) {
 694                 DEBUG(DEBUG_ERR, (__location__ " eventscript for startup event timedout.\n"));
 695                 state->cb_status = -1;
 696         } else {
 697                 /* if it is not a monitor or a startup event we ban ourself
 698                    immediately
 699                 */
 700                 DEBUG(DEBUG_ERR, (__location__ " eventscript for NON-monitor/NON-startup event timedout. Immediately banning ourself for %d seconds\n", ctdb->tunable.recovery_ban_period));
 701
 702                 ctdb_ban_self(ctdb, ctdb->tunable.recovery_ban_period);
 703
 704                 state->cb_status = -1;
 705         }
 706
 707         if (state->call == CTDB_EVENT_MONITOR || state->call == CTDB_EVENT_STATUS) {
 708                 struct ctdb_monitor_script_status *script;
 709
 710                 if (ctdb->current_monitor_status_ctx == NULL) {
 711                         talloc_free(state);
 712                         return;
 713                 }
 714
 715                 script = ctdb->current_monitor_status_ctx->scripts;
 716                 if (script != NULL) {
 717                         script->timedout = 1;
 718                 }
 719
 720                 ctdb_control_event_script_finished(ctdb);
 721         }
 722
 723         talloc_free(state);
 724 }
 725
 726 /*
 727   destroy an event script: kill it if ->child != 0.
 728  */
 729 static int event_script_destructor(struct ctdb_event_script_state *state)
 730 {
 731         if (state->child) {
 732                 DEBUG(DEBUG_ERR,(__location__ " Sending SIGTERM to child pid:%d\n", state->child));
 733
 734                 if (kill(state->child, SIGTERM) != 0) {
 735                         DEBUG(DEBUG_ERR,("Failed to kill child process for eventscript, errno %s(%d)\n", strerror(errno), errno));
 736                 }
 737         }
 738
 739         /* This is allowed to free us; talloc will prevent double free anyway,
 740          * but beware if you call this outside the destructor! */
 741         if (state->callback) {
 742                 state->callback(state->ctdb, state->cb_status, state->private_data);
 743         }
 744
 745         return 0;
 746 }
 747
 748 static unsigned int count_words(const char *options)
 749 {
 750         unsigned int words = 0;
 751
 752         options += strspn(options, " \t");
 753         while (*options) {
 754                 words++;
 755                 options += strcspn(options, " \t");
 756                 options += strspn(options, " \t");
 757         }
 758         return words;
 759 }
 760
 761 static bool check_options(enum ctdb_eventscript_call call, const char *options)
 762 {
 763         switch (call) {
 764         /* These all take no arguments. */
 765         case CTDB_EVENT_STARTUP:
 766         case CTDB_EVENT_START_RECOVERY:
 767         case CTDB_EVENT_RECOVERED:
 768         case CTDB_EVENT_STOPPED:
 769         case CTDB_EVENT_MONITOR:
 770         case CTDB_EVENT_STATUS:
 771         case CTDB_EVENT_SHUTDOWN:
 772         case CTDB_EVENT_RELOAD:
 773                 return count_words(options) == 0;
 774
 775         case CTDB_EVENT_TAKE_IP: /* interface, IP address, netmask bits. */
 776         case CTDB_EVENT_RELEASE_IP:
 777                 return count_words(options) == 3;
 778
 779         default:
 780                 DEBUG(DEBUG_ERR,(__location__ "Unknown ctdb_eventscript_call %u\n", call));
 781                 return false;
 782         }
 783 }
 784
 785 /*
 786   run the event script in the background, calling the callback when
 787   finished
 788  */
 789 static int ctdb_event_script_callback_v(struct ctdb_context *ctdb,
 790                                         void (*callback)(struct ctdb_context *, int, void *),
 791                                         void *private_data,
 792                                         bool from_user,
 793                                         enum ctdb_eventscript_call call,
 794                                         const char *fmt, va_list ap)
 795 {
 796         TALLOC_CTX *mem_ctx;
 797         struct ctdb_event_script_state *state;
 798         int ret;
 799
 800         if (!from_user && (call == CTDB_EVENT_MONITOR || call == CTDB_EVENT_STATUS)) {
 801                 /* if this was a "monitor" or a status event, we recycle the
 802                    context to start a new monitor event
 803                 */
 804                 if (ctdb->monitor_event_script_ctx != NULL) {
 805                         talloc_free(ctdb->monitor_event_script_ctx);
 806                         ctdb->monitor_event_script_ctx = NULL;
 807                 }
 808                 ctdb->monitor_event_script_ctx = talloc_new(ctdb);
 809                 mem_ctx = ctdb->monitor_event_script_ctx;
 810
 811                 if (ctdb->current_monitor_status_ctx != NULL) {
 812                         talloc_free(ctdb->current_monitor_status_ctx);
 813                         ctdb->current_monitor_status_ctx = NULL;
 814                 }
 815
 816                 ctdb->current_monitor_status_ctx = talloc(ctdb, struct ctdb_monitor_script_status_ctx);
 817                 CTDB_NO_MEMORY(ctdb, ctdb->current_monitor_status_ctx);
 818                 ctdb->current_monitor_status_ctx->scripts = NULL;
 819         } else {
 820                 /* any other script will first terminate any monitor event */
 821                 if (ctdb->monitor_event_script_ctx != NULL) {
 822                         talloc_free(ctdb->monitor_event_script_ctx);
 823                         ctdb->monitor_event_script_ctx = NULL;
 824                 }
 825                 /* and then use a context common for all non-monitor events */
 826                 if (ctdb->other_event_script_ctx == NULL) {
 827                         ctdb->other_event_script_ctx = talloc_new(ctdb);
 828                 }
 829                 mem_ctx = ctdb->other_event_script_ctx;
 830         }
 831
 832         state = talloc(mem_ctx, struct ctdb_event_script_state);
 833         CTDB_NO_MEMORY(ctdb, state);
 834
 835         state->ctdb = ctdb;
 836         state->callback = callback;
 837         state->private_data = private_data;
 838         state->call = call;
 839         state->options = talloc_vasprintf(state, fmt, ap);
 840         state->timeout = timeval_set(ctdb->tunable.script_timeout, 0);
 841         if (state->options == NULL) {
 842                 DEBUG(DEBUG_ERR, (__location__ " could not allocate state->options\n"));
 843                 talloc_free(state);
 844                 return -1;
 845         }
 846         if (!check_options(state->call, state->options)) {
 847                 DEBUG(DEBUG_ERR, ("Bad eventscript options '%s' for %s\n",
 848                                   call_names[state->call], state->options));
 849                 talloc_free(state);
 850                 return -1;
 851         }
 852
 853         DEBUG(DEBUG_INFO,(__location__ " Starting eventscript %s %s\n",
 854                           call_names[state->call], state->options));
 855
 856         ret = pipe(state->fd);
 857         if (ret != 0) {
 858                 talloc_free(state);
 859                 return -1;
 860         }
 861
 862         state->child = fork();
 863
 864         if (state->child == (pid_t)-1) {
 865                 close(state->fd[0]);
 866                 close(state->fd[1]);
 867                 talloc_free(state);
 868                 return -1;
 869         }
 870
 871         if (state->child == 0) {
 872                 int rt;
 873
 874                 close(state->fd[0]);
 875                 set_close_on_exec(state->fd[1]);
 876
 877                 rt = ctdb_run_event_script(ctdb, from_user, state->call, state->options);
 878                 /* We must be able to write PIPEBUF bytes at least; if this
 879                    somehow fails, the read above will be short. */
 880                 write(state->fd[1], &rt, sizeof(rt));
 881                 close(state->fd[1]);
 882                 _exit(rt);
 883         }
 884
 885         close(state->fd[1]);
 886         set_close_on_exec(state->fd[0]);
 887         talloc_set_destructor(state, event_script_destructor);
 888
 889         DEBUG(DEBUG_DEBUG, (__location__ " Created PIPE FD:%d to child eventscript process\n", state->fd[0]));
 890
 891         event_add_fd(ctdb->ev, state, state->fd[0], EVENT_FD_READ|EVENT_FD_AUTOCLOSE,
 892                      ctdb_event_script_handler, state);
 893
 894         if (!timeval_is_zero(&state->timeout)) {
 895                 event_add_timed(ctdb->ev, state, timeval_current_ofs(state->timeout.tv_sec, state->timeout.tv_usec), ctdb_event_script_timeout, state);
 896         } else {
 897                 DEBUG(DEBUG_ERR, (__location__ " eventscript %s %s called with no timeout\n",
 898                                   call_names[state->call], state->options));
 899         }
 900
 901         return 0;
 902 }
 903
 904
 905 /*
 906   run the event script in the background, calling the callback when
 907   finished
 908  */
 909 int ctdb_event_script_callback(struct ctdb_context *ctdb,
 910                                TALLOC_CTX *mem_ctx,
 911                                void (*callback)(struct ctdb_context *, int, void *),
 912                                void *private_data,
 913                                bool from_user,
 914                                enum ctdb_eventscript_call call,
 915                                const char *fmt, ...)
 916 {
 917         va_list ap;
 918         int ret;
 919
 920         va_start(ap, fmt);
 921         ret = ctdb_event_script_callback_v(ctdb, callback, private_data, from_user, call, fmt, ap);
 922         va_end(ap);
 923
 924         return ret;
 925 }
 926
 927
 928 struct callback_status {
 929         bool done;
 930         int status;
 931 };
 932
 933 /*
 934   called when ctdb_event_script() finishes
 935  */
 936 static void event_script_callback(struct ctdb_context *ctdb, int status, void *private_data)
 937 {
 938         struct callback_status *s = (struct callback_status *)private_data;
 939         s->done = true;
 940         s->status = status;
 941 }
 942
 943 /*
 944   run the event script, waiting for it to complete. Used when the caller
 945   doesn't want to continue till the event script has finished.
 946  */
 947 int ctdb_event_script_args(struct ctdb_context *ctdb, enum ctdb_eventscript_call call,
 948                            const char *fmt, ...)
 949 {
 950         va_list ap;
 951         int ret;
 952         struct callback_status status;
 953
 954         va_start(ap, fmt);
 955         ret = ctdb_event_script_callback_v(ctdb,
 956                         event_script_callback, &status, false, call, fmt, ap);
 957         if (ret != 0) {
 958                 return ret;
 959         }
 960         va_end(ap);
 961
 962         status.status = -1;
 963         status.done = false;
 964
 965         while (status.done == false && event_loop_once(ctdb->ev) == 0) /* noop */;
 966
 967         return status.status;
 968 }
 969
 970 int ctdb_event_script(struct ctdb_context *ctdb, enum ctdb_eventscript_call call)
 971 {
 972         /* GCC complains about empty format string, so use %s and "". */
 973         return ctdb_event_script_args(ctdb, call, "%s", "");
 974 }
 975
 976 struct eventscript_callback_state {
 977         struct ctdb_req_control *c;
 978 };
 979
 980 /*
 981   called when a forced eventscript run has finished
 982  */
 983 static void run_eventscripts_callback(struct ctdb_context *ctdb, int status,
 984                                  void *private_data)
 985 {
 986         struct eventscript_callback_state *state =
 987                 talloc_get_type(private_data, struct eventscript_callback_state);
 988
 989         ctdb_enable_monitoring(ctdb);
 990
 991         if (status != 0) {
 992                 DEBUG(DEBUG_ERR,(__location__ " Failed to forcibly run eventscripts\n"));
 993         }
 994
 995         ctdb_request_control_reply(ctdb, state->c, NULL, status, NULL);
 996         /* This will free the struct ctdb_event_script_state we are in! */
 997         talloc_free(state);
 998         return;
 999 }
1000
1001
1002 /* Returns rest of string, or NULL if no match. */
1003 static const char *get_call(const char *p, enum ctdb_eventscript_call *call)
1004 {
1005         unsigned int len;
1006
1007         /* Skip any initial whitespace. */
1008         p += strspn(p, " \t");
1009
1010         /* See if we match any. */
1011         for (*call = 0; *call < ARRAY_SIZE(call_names); (*call)++) {
1012                 len = strlen(call_names[*call]);
1013                 if (strncmp(p, call_names[*call], len) == 0) {
1014                         /* If end of string or whitespace, we're done. */
1015                         if (strcspn(p + len, " \t") == 0) {
1016                                 return p + len;
1017                         }
1018                 }
1019         }
1020         return NULL;
1021 }
1022
1023 /*
1024   A control to force running of the eventscripts from the ctdb client tool
1025 */
1026 int32_t ctdb_run_eventscripts(struct ctdb_context *ctdb,
1027                 struct ctdb_req_control *c,
1028                 TDB_DATA indata, bool *async_reply)
1029 {
1030         int ret;
1031         struct eventscript_callback_state *state;
1032         const char *options;
1033         enum ctdb_eventscript_call call;
1034
1035         /* Figure out what call they want. */
1036         options = get_call((const char *)indata.dptr, &call);
1037         if (!options) {
1038                 DEBUG(DEBUG_ERR, (__location__ " Invalid forced \"%s\"\n", (const char *)indata.dptr));
1039                 return -1;
1040         }
1041
1042         if (ctdb->recovery_mode != CTDB_RECOVERY_NORMAL) {
1043                 DEBUG(DEBUG_ERR, (__location__ " Aborted running eventscript \"%s\" while in RECOVERY mode\n", indata.dptr));
1044                 return -1;
1045         }
1046
1047         state = talloc(ctdb->other_event_script_ctx, struct eventscript_callback_state);
1048         CTDB_NO_MEMORY(ctdb, state);
1049
1050         state->c = talloc_steal(state, c);
1051
1052         DEBUG(DEBUG_NOTICE,("Forced running of eventscripts with arguments %s\n", indata.dptr));
1053
1054         ctdb_disable_monitoring(ctdb);
1055
1056         ret = ctdb_event_script_callback(ctdb,
1057                          state, run_eventscripts_callback, state,
1058                          true, call, "%s", options);
1059
1060         if (ret != 0) {
1061                 ctdb_enable_monitoring(ctdb);
1062                 DEBUG(DEBUG_ERR,(__location__ " Failed to run eventscripts with arguments %s\n", indata.dptr));
1063                 talloc_free(state);
1064                 return -1;
1065         }
1066
1067         /* tell ctdb_control.c that we will be replying asynchronously */
1068         *async_reply = true;
1069
1070         return 0;
1071 }
1072
1073
1074
1075 int32_t ctdb_control_enable_script(struct ctdb_context *ctdb, TDB_DATA indata)
1076 {
1077         const char *script;
1078         struct stat st;
1079         char *filename;
1080         TALLOC_CTX *tmp_ctx = talloc_new(ctdb);
1081
1082         script = (char *)indata.dptr;
1083         if (indata.dsize == 0) {
1084                 DEBUG(DEBUG_ERR,(__location__ " No script specified.\n"));
1085                 talloc_free(tmp_ctx);
1086                 return -1;
1087         }
1088         if (indata.dptr[indata.dsize - 1] != '\0') {
1089                 DEBUG(DEBUG_ERR,(__location__ " String is not null terminated.\n"));
1090                 talloc_free(tmp_ctx);
1091                 return -1;
1092         }
1093         if (index(script,'/') != NULL) {
1094                 DEBUG(DEBUG_ERR,(__location__ " Script name contains '/'. Failed to enable script %s\n", script));
1095                 talloc_free(tmp_ctx);
1096                 return -1;
1097         }
1098
1099
1100         if (stat(ctdb->event_script_dir, &st) != 0 &&
1101             errno == ENOENT) {
1102                 DEBUG(DEBUG_CRIT,("No event script directory found at '%s'\n", ctdb->event_script_dir));
1103                 talloc_free(tmp_ctx);
1104                 return -1;
1105         }
1106
1107
1108         filename = talloc_asprintf(tmp_ctx, "%s/%s", ctdb->event_script_dir, script);
1109         if (filename == NULL) {
1110                 DEBUG(DEBUG_ERR,(__location__ " Failed to create script path\n"));
1111                 talloc_free(tmp_ctx);
1112                 return -1;
1113         }
1114
1115         if (stat(filename, &st) != 0) {
1116                 DEBUG(DEBUG_ERR,("Could not stat event script %s. Failed to enable script.\n", filename));
1117                 talloc_free(tmp_ctx);
1118                 return -1;
1119         }
1120
1121         if (chmod(filename, st.st_mode | S_IXUSR) == -1) {
1122                 DEBUG(DEBUG_ERR,("Could not chmod %s. Failed to enable script.\n", filename));
1123                 talloc_free(tmp_ctx);
1124                 return -1;
1125         }
1126
1127         talloc_free(tmp_ctx);
1128         return 0;
1129 }
1130
1131 int32_t ctdb_control_disable_script(struct ctdb_context *ctdb, TDB_DATA indata)
1132 {
1133         const char *script;
1134         struct stat st;
1135         char *filename;
1136         TALLOC_CTX *tmp_ctx = talloc_new(ctdb);
1137
1138         script = (char *)indata.dptr;
1139         if (indata.dsize == 0) {
1140                 DEBUG(DEBUG_ERR,(__location__ " No script specified.\n"));
1141                 talloc_free(tmp_ctx);
1142                 return -1;
1143         }
1144         if (indata.dptr[indata.dsize - 1] != '\0') {
1145                 DEBUG(DEBUG_ERR,(__location__ " String is not null terminated.\n"));
1146                 talloc_free(tmp_ctx);
1147                 return -1;
1148         }
1149         if (index(script,'/') != NULL) {
1150                 DEBUG(DEBUG_ERR,(__location__ " Script name contains '/'. Failed to disable script %s\n", script));
1151                 talloc_free(tmp_ctx);
1152                 return -1;
1153         }
1154
1155
1156         if (stat(ctdb->event_script_dir, &st) != 0 &&
1157             errno == ENOENT) {
1158                 DEBUG(DEBUG_CRIT,("No event script directory found at '%s'\n", ctdb->event_script_dir));
1159                 talloc_free(tmp_ctx);
1160                 return -1;
1161         }
1162
1163
1164         filename = talloc_asprintf(tmp_ctx, "%s/%s", ctdb->event_script_dir, script);
1165         if (filename == NULL) {
1166                 DEBUG(DEBUG_ERR,(__location__ " Failed to create script path\n"));
1167                 talloc_free(tmp_ctx);
1168                 return -1;
1169         }
1170
1171         if (stat(filename, &st) != 0) {
1172                 DEBUG(DEBUG_ERR,("Could not stat event script %s. Failed to disable script.\n", filename));
1173                 talloc_free(tmp_ctx);
1174                 return -1;
1175         }
1176
1177         if (chmod(filename, st.st_mode & ~(S_IXUSR|S_IXGRP|S_IXOTH)) == -1) {
1178                 DEBUG(DEBUG_ERR,("Could not chmod %s. Failed to disable script.\n", filename));
1179                 talloc_free(tmp_ctx);
1180                 return -1;
1181         }
1182
1183         talloc_free(tmp_ctx);
1184         return 0;
1185 }