X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng%2Fcommands%2Fsnapshot.c;h=d8a6b81486939fdb945ca91b96bc19a6be4c6ce3;hp=465d864de1d15c977b53f3497bd6945ce28524c2;hb=4fc83d948cea6b10484e65f004a6c167e71ac440;hpb=890d8fe47755c3bad936389cf48ffa141cff41c9 diff --git a/src/bin/lttng/commands/snapshot.c b/src/bin/lttng/commands/snapshot.c index 465d864de..d8a6b8148 100644 --- a/src/bin/lttng/commands/snapshot.c +++ b/src/bin/lttng/commands/snapshot.c @@ -48,6 +48,12 @@ static int cmd_record(int argc, const char **argv); static const char *indent4 = " "; +#ifdef LTTNG_EMBED_HELP +static const char help_msg[] = +#include +; +#endif + enum { OPT_HELP = 1, OPT_LIST_OPTIONS, @@ -78,41 +84,6 @@ static struct cmd_struct actions[] = { { NULL, NULL } /* Array closure */ }; -/* - * usage - */ -static void usage(FILE *ofp) -{ - fprintf(ofp, "usage: lttng snapshot [OPTION] ACTION\n"); - fprintf(ofp, "\n"); - fprintf(ofp, "Actions:\n"); - fprintf(ofp, " add-output [-m ] [-s ] [-n ] | -C -D \n"); - fprintf(ofp, " Setup and add an snapshot output for a session.\n"); - fprintf(ofp, "\n"); - fprintf(ofp, " del-output ID | NAME [-s ]\n"); - fprintf(ofp, " Delete an output for a session using the ID.\n"); - fprintf(ofp, "\n"); - fprintf(ofp, " list-output [-s ]\n"); - fprintf(ofp, " List the output of a session.\n"); - fprintf(ofp, "\n"); - fprintf(ofp, " record [-m ] [-s ] [-n ] [ | -C -D ]\n"); - fprintf(ofp, " Snapshot a session's buffer(s) for all domains. If an URL is\n"); - fprintf(ofp, " specified, it is used instead of a previously added output.\n"); - fprintf(ofp, " Specifying only a name or/a size will override the current output value.\n"); - fprintf(ofp, " For instance, you can record a snapshot with a custom maximum size\n"); - fprintf(ofp, " or with a different name.\n"); - fprintf(ofp, "\n"); - fprintf(ofp, "Options:\n"); - fprintf(ofp, " -h, --help Show this help\n"); - fprintf(ofp, " --list-options Simple listing of options\n"); - fprintf(ofp, " -s, --session NAME Apply to session name\n"); - fprintf(ofp, " -n, --name NAME Name of the output or snapshot\n"); - fprintf(ofp, " -m, --max-size SIZE Maximum bytes size of the snapshot {+k,+M,+G}\n"); - fprintf(ofp, " -C, --ctrl-url URL Set control path URL. (Must use -D also)\n"); - fprintf(ofp, " -D, --data-url URL Set data path URL. (Must use -C also)\n"); - fprintf(ofp, "\n"); -} - /* * Count and return the number of arguments in argv. */ @@ -185,65 +156,28 @@ error_create: return NULL; } -static int mi_list_output(void) +static int list_output(void) { - int ret; + int ret, output_seen = 0; struct lttng_snapshot_output *s_iter; struct lttng_snapshot_output_list *list; - assert(writer); - ret = lttng_snapshot_list_output(current_session_name, &list); if (ret < 0) { goto error; } - ret = mi_lttng_snapshot_output_session_name(writer, current_session_name); - if (ret) { - ret = CMD_ERROR; - goto end; - } + MSG("Snapshot output list for session %s", current_session_name); - while ((s_iter = lttng_snapshot_output_list_get_next(list)) != NULL) { - ret = mi_lttng_snapshot_list_output(writer, s_iter); + if (lttng_opt_mi) { + ret = mi_lttng_snapshot_output_session_name(writer, + current_session_name); if (ret) { ret = CMD_ERROR; goto end; } } - - /* Close snapshot snapshots element */ - ret = mi_lttng_writer_close_element(writer); - if (ret) { - ret = CMD_ERROR; - goto end; - } - - /* Close snapshot session element */ - ret = mi_lttng_writer_close_element(writer); - if (ret) { - ret = CMD_ERROR; - } -end: - lttng_snapshot_output_list_destroy(list); -error: - return ret; -} - -static int list_output(void) -{ - int ret, output_seen = 0; - struct lttng_snapshot_output *s_iter; - struct lttng_snapshot_output_list *list; - - ret = lttng_snapshot_list_output(current_session_name, &list); - if (ret < 0) { - goto error; - } - - MSG("Snapshot output list for session %s", current_session_name); - while ((s_iter = lttng_snapshot_output_list_get_next(list)) != NULL) { MSG("%s[%" PRIu32 "] %s: %s (max-size: %" PRId64 ")", indent4, lttng_snapshot_output_get_id(s_iter), @@ -251,8 +185,30 @@ static int list_output(void) lttng_snapshot_output_get_ctrl_url(s_iter), lttng_snapshot_output_get_maxsize(s_iter)); output_seen = 1; + if (lttng_opt_mi) { + ret = mi_lttng_snapshot_list_output(writer, s_iter); + if (ret) { + ret = CMD_ERROR; + goto end; + } + } } + if (lttng_opt_mi) { + /* Close snapshot snapshots element */ + ret = mi_lttng_writer_close_element(writer); + if (ret) { + ret = CMD_ERROR; + goto end; + } + + /* Close snapshot session element */ + ret = mi_lttng_writer_close_element(writer); + if (ret) { + ret = CMD_ERROR; + } + } +end: lttng_snapshot_output_list_destroy(list); if (!output_seen) { @@ -263,50 +219,6 @@ error: return ret; } -/* - * Delete output by ID (machine interface version). - */ -static int mi_del_output(uint32_t id, const char *name) -{ - int ret; - struct lttng_snapshot_output *output = NULL; - - assert(writer); - - output = lttng_snapshot_output_create(); - if (!output) { - ret = CMD_FATAL; - goto error; - } - - if (name) { - ret = lttng_snapshot_output_set_name(name, output); - } else if (id != UINT32_MAX) { - ret = lttng_snapshot_output_set_id(id, output); - } else { - ret = CMD_ERROR; - goto error; - } - if (ret < 0) { - ret = CMD_FATAL; - goto error; - } - - ret = lttng_snapshot_del_output(current_session_name, output); - if (ret < 0) { - goto error; - } - - ret = mi_lttng_snapshot_del_output(writer, id, name, current_session_name); - if (ret) { - ret = CMD_ERROR; - } - -error: - lttng_snapshot_output_destroy(output); - return ret; -} - /* * Delete output by ID. */ @@ -347,53 +259,12 @@ static int del_output(uint32_t id, const char *name) name, current_session_name); } -error: - lttng_snapshot_output_destroy(output); - return ret; -} - -/* - * Add output from the user URL (machine interface). - */ -static int mi_add_output(const char *url) -{ - int ret; - struct lttng_snapshot_output *output = NULL; - char name[NAME_MAX]; - const char *n_ptr; - - if (!url && (!opt_data_url || !opt_ctrl_url)) { - ret = CMD_ERROR; - goto error; - } - - output = create_output_from_args(url); - if (!output) { - ret = CMD_FATAL; - goto error; - } - - /* This call, if successful, populates the id of the output object. */ - ret = lttng_snapshot_add_output(current_session_name, output); - if (ret < 0) { - goto error; - } - - n_ptr = lttng_snapshot_output_get_name(output); - if (*n_ptr == '\0') { - int pret; - pret = snprintf(name, sizeof(name), DEFAULT_SNAPSHOT_NAME "-%" PRIu32, - lttng_snapshot_output_get_id(output)); - if (pret < 0) { - PERROR("snprintf add output name"); + if (lttng_opt_mi) { + ret = mi_lttng_snapshot_del_output(writer, id, name, + current_session_name); + if (ret) { + ret = CMD_ERROR; } - n_ptr = name; - } - - ret = mi_lttng_snapshot_add_output(writer, current_session_name, n_ptr, - output); - if (ret) { - ret = CMD_ERROR; } error: @@ -445,6 +316,13 @@ static int add_output(const char *url) lttng_snapshot_output_get_id(output), n_ptr, lttng_snapshot_output_get_ctrl_url(output), lttng_snapshot_output_get_maxsize(output)); + if (lttng_opt_mi) { + ret = mi_lttng_snapshot_add_output(writer, current_session_name, + n_ptr, output); + if (ret) { + ret = CMD_ERROR; + } + } error: lttng_snapshot_output_destroy(output); return ret; @@ -455,16 +333,11 @@ static int cmd_add_output(int argc, const char **argv) int ret; if (argc < 2 && (!opt_data_url || !opt_ctrl_url)) { - usage(stderr); ret = CMD_ERROR; goto end; } - if (lttng_opt_mi) { - ret = mi_add_output(argv[1]); - } else { - ret = add_output(argv[1]); - } + ret = add_output(argv[1]); end: return ret; @@ -477,25 +350,16 @@ static int cmd_del_output(int argc, const char **argv) long id; if (argc < 2) { - usage(stderr); ret = CMD_ERROR; goto end; } errno = 0; id = strtol(argv[1], &name, 10); - if (id == 0 && errno == 0) { - if (lttng_opt_mi) { - ret = mi_del_output(UINT32_MAX, name); - } else { - ret = del_output(UINT32_MAX, name); - } + if (id == 0 && (errno == 0 || errno == EINVAL)) { + ret = del_output(UINT32_MAX, name); } else if (errno == 0 && *name == '\0') { - if (lttng_opt_mi) { - ret = mi_del_output(id, NULL); - } else { - ret = del_output(id, NULL); - } + ret = del_output(id, NULL); } else { ERR("Argument %s not recognized", argv[1]); ret = -1; @@ -510,46 +374,11 @@ static int cmd_list_output(int argc, const char **argv) { int ret; - if (lttng_opt_mi) { - ret = mi_list_output(); - } else { - ret = list_output(); - } + ret = list_output(); return ret; } -/* - * Do a snapshot record with the URL if one is given (machine interface). - */ -static int mi_record(const char *url) -{ - int ret; - struct lttng_snapshot_output *output = NULL; - - output = create_output_from_args(url); - if (!output) { - ret = CMD_FATAL; - goto error; - } - - ret = lttng_snapshot_record(current_session_name, output, 0); - if (ret < 0) { - ret = CMD_ERROR; - goto error; - } - - ret = mi_lttng_snapshot_record(writer, current_session_name, url, - opt_ctrl_url, opt_data_url); - if (ret) { - ret = CMD_ERROR; - } - -error: - lttng_snapshot_output_destroy(output); - return ret; -} - /* * Do a snapshot record with the URL if one is given. */ @@ -581,6 +410,14 @@ static int record(const char *url) opt_data_url); } + if (lttng_opt_mi) { + ret = mi_lttng_snapshot_record(writer, current_session_name, url, + opt_ctrl_url, opt_data_url); + if (ret) { + ret = CMD_ERROR; + } + } + error: lttng_snapshot_output_destroy(output); return ret; @@ -591,18 +428,9 @@ static int cmd_record(int argc, const char **argv) int ret; if (argc == 2) { - /* With a given URL */ - if (lttng_opt_mi) { - ret = mi_record(argv[1]); - } else { - ret = record(argv[1]); - } + ret = record(argv[1]); } else { - if (lttng_opt_mi) { - ret = mi_record(NULL); - } else { - ret = record(NULL); - } + ret = record(NULL); } return ret; @@ -615,7 +443,6 @@ static int handle_command(const char **argv) if (argv == NULL || (!opt_ctrl_url && opt_data_url) || (opt_ctrl_url && !opt_data_url)) { - usage(stderr); command_ret = CMD_ERROR; goto end; } @@ -715,7 +542,7 @@ int cmd_snapshot(int argc, const char **argv) while ((opt = poptGetNextOpt(pc)) != -1) { switch (opt) { case OPT_HELP: - usage(stdout); + SHOW_HELP(); goto end; case OPT_LIST_OPTIONS: list_cmd_options(stdout, snapshot_opts); @@ -739,7 +566,6 @@ int cmd_snapshot(int argc, const char **argv) break; } default: - usage(stderr); ret = CMD_UNDEFINED; goto end; } @@ -759,11 +585,17 @@ int cmd_snapshot(int argc, const char **argv) command_ret = handle_command(poptGetArgs(pc)); if (command_ret) { switch (-command_ret) { - case LTTNG_ERR_EPERM: - ERR("The session needs to be set in no output mode (--no-output)"); - break; case LTTNG_ERR_SNAPSHOT_NODATA: WARN("%s", lttng_strerror(command_ret)); + + /* A warning is fine since the user has no control on + * whether or not applications (or the kernel) have + * produced any event between the start of the tracing + * session and the recording of the snapshot. MI wise + * the command is not a success since nothing was + * recorded. + */ + command_ret = 0; break; default: ERR("%s", lttng_strerror(command_ret)); @@ -807,7 +639,7 @@ end: free(session_name); } - /* Overwrite ret if an error occured during handle_command */ + /* Overwrite ret if an error occurred during handle_command */ ret = command_ret ? command_ret : ret; poptFreeContext(pc); return ret;