2 CTDB event daemon utility code
4 Copyright (C) Amitay Isaacs 2018
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/>.
21 #include "system/filesys.h"
22 #include "system/time.h"
28 #include "lib/util/debug.h"
30 #include "common/cmdline.h"
31 #include "common/logging.h"
32 #include "common/path.h"
33 #include "common/event_script.h"
35 #include "event/event_protocol_api.h"
36 #include "event/event.h"
37 #include "event/event_tool.h"
39 struct event_tool_context
{
40 struct cmdline_context
*cmdline
;
41 struct tevent_context
*ev
;
42 struct ctdb_event_context
*eclient
;
45 static int compact_args(TALLOC_CTX
*mem_ctx
,
59 arg_str
= talloc_strdup(mem_ctx
, argv
[from
]);
60 if (arg_str
== NULL
) {
64 for (i
= from
+1; i
< argc
; i
++) {
65 arg_str
= talloc_asprintf_append(arg_str
, " %s", argv
[i
]);
66 if (arg_str
== NULL
) {
75 static int event_command_run(TALLOC_CTX
*mem_ctx
,
80 struct event_tool_context
*ctx
= talloc_get_type_abort(
81 private_data
, struct event_tool_context
);
82 struct tevent_req
*req
;
83 struct ctdb_event_request_run request_run
;
84 const char *arg_str
= NULL
;
86 int timeout
, ret
= 0, result
= 0;
90 cmdline_usage(ctx
->cmdline
, "run");
94 ret
= ctdb_event_init(ctx
, ctx
->ev
, &ctx
->eclient
);
96 D_ERR("Failed to initialize event client, ret=%d\n", ret
);
100 timeout
= atoi(argv
[0]);
105 ret
= compact_args(mem_ctx
, argv
, argc
, 3, &arg_str
);
107 D_ERR("Memory allocation error\n");
111 request_run
.component
= argv
[1];
112 request_run
.event
= argv
[2];
113 request_run
.args
= arg_str
;
114 request_run
.timeout
= timeout
;
115 request_run
.flags
= 0;
117 t
= getenv("CTDB_TEST_MODE");
119 t
= getenv("CTDB_EVENT_RUN_ALL");
121 request_run
.flags
= CTDB_EVENT_RUN_ALL
;
125 req
= ctdb_event_run_send(mem_ctx
,
130 D_ERR("Memory allocation error\n");
134 tevent_req_poll(req
, ctx
->ev
);
136 ok
= ctdb_event_run_recv(req
, &ret
, &result
);
138 D_ERR("Failed to run event %s in %s, ret=%d\n",
145 D_NOTICE("Command run finished with result=%d\n", result
);
147 if (result
== ENOENT
) {
148 printf("Event dir for %s does not exist\n", argv
[1]);
149 } else if (result
== ETIMEDOUT
) {
150 printf("Event %s in %s timed out\n", argv
[2], argv
[1]);
151 } else if (result
== ECANCELED
) {
152 printf("Event %s in %s got cancelled\n", argv
[2], argv
[1]);
153 } else if (result
== ENOEXEC
) {
154 printf("Event %s in %s failed\n", argv
[2], argv
[1]);
155 } else if (result
!= 0) {
156 printf("Failed to run event %s in %s, result=%d\n",
162 ret
= (result
< 0) ? -result
: result
;
166 static double timeval_delta(struct timeval
*tv2
, struct timeval
*tv
)
168 return (tv2
->tv_sec
- tv
->tv_sec
) +
169 (tv2
->tv_usec
- tv
->tv_usec
) * 1.0e-6;
172 static void print_status_one(struct ctdb_event_script
*script
)
174 if (script
->result
== -ETIMEDOUT
) {
175 printf("%-20s %-10s %s",
178 ctime(&script
->begin
.tv_sec
));
179 } else if (script
->result
== -ENOEXEC
) {
180 printf("%-20s %-10s\n", script
->name
, "DISABLED");
181 } else if (script
->result
< 0) {
182 printf("%-20s %-10s (%s)\n",
185 strerror(-script
->result
));
186 } else if (script
->result
== 0) {
187 printf("%-20s %-10s %.3lf %s",
190 timeval_delta(&script
->end
, &script
->begin
),
191 ctime(&script
->begin
.tv_sec
));
193 printf("%-20s %-10s %.3lf %s",
196 timeval_delta(&script
->end
, &script
->begin
),
197 ctime(&script
->begin
.tv_sec
));
200 if (script
->result
!= 0 && script
->result
!= -ENOEXEC
) {
201 printf(" OUTPUT: %s\n",
202 script
->output
== NULL
? "" : script
->output
);
206 static void print_status(const char *component
,
209 struct ctdb_event_reply_status
*status
)
214 if (result
== ENOENT
) {
215 printf("Event dir for %s does not exist\n", component
);
216 } else if (result
== EINVAL
) {
217 printf("Event %s has never run in %s\n",
221 printf("Unknown error (%d) for event %s in %s\n",
229 for (i
=0; i
<status
->script_list
->num_scripts
; i
++) {
230 print_status_one(&status
->script_list
->script
[i
]);
234 static int event_command_status(TALLOC_CTX
*mem_ctx
,
239 struct event_tool_context
*ctx
= talloc_get_type_abort(
240 private_data
, struct event_tool_context
);
241 struct tevent_req
*req
;
242 struct ctdb_event_request_status request_status
;
243 struct ctdb_event_reply_status
*reply_status
;
244 int ret
= 0, result
= 0;
248 cmdline_usage(ctx
->cmdline
, "status");
252 ret
= ctdb_event_init(ctx
, ctx
->ev
, &ctx
->eclient
);
254 D_ERR("Failed to initialize event client, ret=%d\n", ret
);
258 request_status
.component
= argv
[0];
259 request_status
.event
= argv
[1];
261 req
= ctdb_event_status_send(mem_ctx
,
266 D_ERR("Memory allocation error\n");
270 tevent_req_poll(req
, ctx
->ev
);
272 ok
= ctdb_event_status_recv(req
,
278 D_ERR("Failed to get status for event %s in %s, ret=%d\n",
285 D_NOTICE("Command status finished with result=%d\n", result
);
287 print_status(argv
[0], argv
[1], result
, reply_status
);
289 if (reply_status
== NULL
) {
292 ret
= reply_status
->summary
;
293 ret
= (ret
< 0) ? -ret
: ret
;
298 #define EVENT_SCRIPT_DISABLED ' '
299 #define EVENT_SCRIPT_ENABLED '*'
301 static int event_command_script_list(TALLOC_CTX
*mem_ctx
,
306 struct event_tool_context
*ctx
= talloc_get_type_abort(
307 private_data
, struct event_tool_context
);
309 char *data_dir
= NULL
;
310 char *etc_dir
= NULL
;
312 struct event_script_list
*data_list
= NULL
;
313 struct event_script_list
*etc_list
= NULL
;
314 unsigned int i
, j
, matched
;
318 cmdline_usage(ctx
->cmdline
, "script list");
322 subdir
= talloc_asprintf(mem_ctx
, "events/%s", argv
[0]);
323 if (subdir
== NULL
) {
327 data_dir
= path_datadir_append(mem_ctx
, subdir
);
328 if (data_dir
== NULL
) {
332 t
= talloc_size(mem_ctx
, PATH_MAX
);
337 data_dir
= realpath(data_dir
, t
);
338 if (data_dir
== NULL
) {
339 if (errno
!= ENOENT
) {
342 D_ERR("Command script list finished with result=%d\n", ENOENT
);
346 etc_dir
= path_etcdir_append(mem_ctx
, subdir
);
347 if (etc_dir
== NULL
) {
352 * Ignore error on ENOENT for cut down (e.g. fixed/embedded)
353 * installs that don't use symlinks but just populate etc_dir
356 ret
= event_script_get_list(mem_ctx
, data_dir
, &data_list
);
357 if (ret
!= 0 && ret
!= ENOENT
) {
358 D_ERR("Command script list finished with result=%d\n", ret
);
362 ret
= event_script_get_list(mem_ctx
, etc_dir
, &etc_list
);
364 D_ERR("Command script list finished with result=%d\n", ret
);
368 D_NOTICE("Command script list finished with result=%d\n", ret
);
370 if (data_list
== NULL
) {
371 goto list_enabled_only
;
375 * First list scripts provided by CTDB. Flag those that are
376 * enabled via a symlink and arrange for them to be excluded
377 * from the subsequent list of local scripts.
379 * Both lists are sorted, so walk the list of enabled scripts
380 * only once in this pass.
384 for (i
= 0; i
< data_list
->num_scripts
; i
++) {
385 struct event_script
*d
= data_list
->script
[i
];
386 char flag
= EVENT_SCRIPT_DISABLED
;
390 /* Check to see if this script is enabled */
391 while (j
< etc_list
->num_scripts
) {
392 struct event_script
*e
= etc_list
->script
[j
];
394 ret
= strcmp(e
->name
, d
->name
);
398 * Enabled name is greater, so needs
399 * to be considered later: done
405 /* Enabled name is less: next */
410 len
= readlink(e
->path
, buf
, sizeof(buf
));
411 if (len
== -1 || (size_t)len
>= sizeof(buf
)) {
413 * Not a link? Disappeared? Invalid
414 * link target? Something else?
416 * Doesn't match provided script: next, done
422 /* readlink() does not NUL-terminate */
425 ret
= strcmp(buf
, d
->path
);
427 /* Enabled link doesn't match: next, done */
433 * Enabled script's symlink matches our
434 * script: flag our script as enabled
436 * Also clear the enabled script so it can be
437 * trivially skipped in the next pass
439 flag
= EVENT_SCRIPT_ENABLED
;
440 TALLOC_FREE(etc_list
->script
[j
]);
446 printf("%c %s\n", flag
, d
->name
);
449 /* Print blank line if both provided and local lists are being printed */
450 if (data_list
->num_scripts
> 0 && matched
!= etc_list
->num_scripts
) {
456 /* Now print details of local scripts, after a blank line */
457 for (j
= 0; j
< etc_list
->num_scripts
; j
++) {
458 struct event_script
*e
= etc_list
->script
[j
];
459 char flag
= EVENT_SCRIPT_DISABLED
;
462 /* Matched in previous pass: next */
466 /* Script is local: if executable then flag as enabled */
468 flag
= EVENT_SCRIPT_ENABLED
;
471 printf("%c %s\n", flag
, e
->name
);
478 talloc_free(data_dir
);
479 talloc_free(etc_dir
);
480 talloc_free(data_list
);
481 talloc_free(etc_list
);
486 static int event_command_script(TALLOC_CTX
*mem_ctx
,
487 struct event_tool_context
*ctx
,
488 const char *component
,
492 char *subdir
, *etc_dir
;
495 subdir
= talloc_asprintf(mem_ctx
, "events/%s", component
);
496 if (subdir
== NULL
) {
500 etc_dir
= path_etcdir_append(mem_ctx
, subdir
);
501 if (etc_dir
== NULL
) {
506 result
= event_script_chmod(etc_dir
, script
, true);
508 result
= event_script_chmod(etc_dir
, script
, false);
512 talloc_free(etc_dir
);
514 D_NOTICE("Command script finished with result=%d\n", result
);
516 if (result
== EINVAL
) {
517 printf("Script %s is invalid in %s\n", script
, component
);
518 } else if (result
== ENOENT
) {
519 printf("Script %s does not exist in %s\n", script
, component
);
525 static int event_command_script_enable(TALLOC_CTX
*mem_ctx
,
530 struct event_tool_context
*ctx
= talloc_get_type_abort(
531 private_data
, struct event_tool_context
);
533 char *script
, *etc_script
;
537 cmdline_usage(ctx
->cmdline
, "script enable");
541 script
= talloc_asprintf(mem_ctx
, "events/%s/%s.script", argv
[0], argv
[1]);
542 if (script
== NULL
) {
546 etc_script
= path_etcdir_append(mem_ctx
, script
);
547 if (etc_script
== NULL
) {
551 ret
= lstat(etc_script
, &statbuf
);
553 if (S_ISLNK(statbuf
.st_mode
)) {
554 /* Link already exists */
556 } else if (S_ISREG(statbuf
.st_mode
)) {
557 return event_command_script(mem_ctx
,
564 printf("Script %s is not a file or a link\n", etc_script
);
567 if (errno
== ENOENT
) {
571 data_script
= path_datadir_append(mem_ctx
, script
);
572 if (data_script
== NULL
) {
576 t
= talloc_size(mem_ctx
, PATH_MAX
);
581 data_script
= realpath(data_script
, t
);
582 if (data_script
== NULL
) {
583 if (errno
!= ENOENT
) {
586 printf("Script %s does not exist in %s\n",
592 ret
= stat(data_script
, &statbuf
);
594 printf("Script %s does not exist in %s\n",
599 ret
= symlink(data_script
, etc_script
);
601 printf("Failed to create symlink %s\n",
609 printf("Script %s does not exist\n", etc_script
);
614 static int event_command_script_disable(TALLOC_CTX
*mem_ctx
,
619 struct event_tool_context
*ctx
= talloc_get_type_abort(
620 private_data
, struct event_tool_context
);
622 char *script
, *etc_script
;
627 cmdline_usage(ctx
->cmdline
, "script disable");
631 script
= talloc_asprintf(mem_ctx
, "events/%s/%s.script", argv
[0], argv
[1]);
632 if (script
== NULL
) {
636 etc_script
= path_etcdir_append(mem_ctx
, script
);
637 if (etc_script
== NULL
) {
641 ret
= lstat(etc_script
, &statbuf
);
643 if (S_ISLNK(statbuf
.st_mode
)) {
645 ret
= unlink(etc_script
);
647 printf("Failed to remove symlink %s\n",
653 } else if (S_ISREG(statbuf
.st_mode
)) {
654 return event_command_script(mem_ctx
,
661 printf("Script %s is not a file or a link\n", etc_script
);
668 struct cmdline_command event_commands
[] = {
669 { "run", event_command_run
,
670 "Run an event", "<timeout> <component> <event> <args>" },
671 { "status", event_command_status
,
672 "Get status of an event", "<component> <event>" },
673 { "script list", event_command_script_list
,
674 "List event scripts", "<component>" },
675 { "script enable", event_command_script_enable
,
676 "Enable an event script", "<component> <script>" },
677 { "script disable", event_command_script_disable
,
678 "Disable an event script", "<component> <script>" },
682 int event_tool_init(TALLOC_CTX
*mem_ctx
,
684 struct poptOption
*options
,
688 struct event_tool_context
**result
)
690 struct event_tool_context
*ctx
;
693 ctx
= talloc_zero(mem_ctx
, struct event_tool_context
);
695 D_ERR("Memory allocation error\n");
699 ret
= cmdline_init(mem_ctx
,
706 D_ERR("Failed to initialize cmdline, ret=%d\n", ret
);
711 ret
= cmdline_parse(ctx
->cmdline
, argc
, argv
, parse_options
);
713 cmdline_usage(ctx
->cmdline
, NULL
);
722 int event_tool_run(struct event_tool_context
*ctx
, int *result
)
726 ctx
->ev
= tevent_context_init(ctx
);
727 if (ctx
->ev
== NULL
) {
728 D_ERR("Failed to initialize tevent\n");
732 ret
= cmdline_run(ctx
->cmdline
, ctx
, result
);
736 #ifdef CTDB_EVENT_TOOL
744 struct poptOption event_options
[] = {
745 { "debug", 'd', POPT_ARG_STRING
, &event_data
.debug
, 0,
746 "debug level", "ERROR|WARNING|NOTICE|INFO|DEBUG" },
750 int main(int argc
, const char **argv
)
753 struct event_tool_context
*ctx
;
758 mem_ctx
= talloc_new(NULL
);
759 if (mem_ctx
== NULL
) {
760 fprintf(stderr
, "Memory allocation error\n");
764 ret
= event_tool_init(mem_ctx
,
772 talloc_free(mem_ctx
);
776 setup_logging("ctdb-event", DEBUG_STDERR
);
777 ok
= debug_level_parse(event_data
.debug
, &level
);
781 debuglevel_set(level
);
783 ret
= event_tool_run(ctx
, &result
);
788 talloc_free(mem_ctx
);
792 #endif /* CTDB_EVENT_TOOL */