X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng%2Fcommands%2Fenable_channels.c;h=9a990030d5023ff38f0b984f1329f32e5feb849f;hp=4185b19a716cde04b47ba2c47209a54bfb3b0f69;hb=38b4ef1b199ddb15db78774a39e9c524ca7e2d24;hpb=8692d4e5805da0104c690972bb96b60b8cb52685 diff --git a/src/bin/lttng/commands/enable_channels.c b/src/bin/lttng/commands/enable_channels.c index 4185b19a7..9a990030d 100644 --- a/src/bin/lttng/commands/enable_channels.c +++ b/src/bin/lttng/commands/enable_channels.c @@ -15,7 +15,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ -#define _GNU_SOURCE +#define _LGPL_SOURCE #include #include #include @@ -27,11 +27,13 @@ #include #include +#include +#include +#include + #include "../command.h" #include "../utils.h" -#include -#include static char *opt_channels; static int opt_kernel; @@ -43,6 +45,8 @@ static int opt_buffer_uid; static int opt_buffer_pid; static int opt_buffer_global; +static struct mi_writer *writer; + enum { OPT_HELP = 1, OPT_DISCARD, @@ -84,65 +88,6 @@ static struct poptOption long_options[] = { {0, 0, 0, 0, 0, 0, 0} }; -/* - * usage - */ -static void usage(FILE *ofp) -{ - fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [-u|-k] [OPTIONS]\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, " -k, --kernel Apply to the kernel tracer\n"); - fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n"); - fprintf(ofp, "\n"); - fprintf(ofp, "Channel options:\n"); - fprintf(ofp, " --discard Discard event when buffers are full%s\n", - DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)"); - fprintf(ofp, " --overwrite Flight recorder mode%s\n", - DEFAULT_CHANNEL_OVERWRITE ? " (default)" : ""); - fprintf(ofp, " --subbuf-size SIZE Subbuffer size in bytes {+k,+M,+G}\n"); - fprintf(ofp, " (default UST uid: %zu, UST pid: %zu, kernel: %zu, metadata: %zu)\n", - default_get_ust_uid_channel_subbuf_size(), - default_get_ust_pid_channel_subbuf_size(), - default_get_kernel_channel_subbuf_size(), - default_get_metadata_subbuf_size()); - fprintf(ofp, " Rounded up to the next power of 2.\n"); - fprintf(ofp, " --num-subbuf NUM Number of subbufers\n"); - fprintf(ofp, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n", - DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM, DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM, - DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM, DEFAULT_METADATA_SUBBUF_NUM); - fprintf(ofp, " Rounded up to the next power of 2.\n"); - fprintf(ofp, " --switch-timer USEC Switch timer interval in usec\n"); - fprintf(ofp, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n", - DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER, DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER, - DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER, DEFAULT_METADATA_SWITCH_TIMER); - fprintf(ofp, " --read-timer USEC Read timer interval in usec.\n"); - fprintf(ofp, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n", - DEFAULT_UST_UID_CHANNEL_READ_TIMER, DEFAULT_UST_UID_CHANNEL_READ_TIMER, - DEFAULT_KERNEL_CHANNEL_READ_TIMER, DEFAULT_METADATA_READ_TIMER); - fprintf(ofp, " --output TYPE Channel output type (Values: %s, %s)\n", - output_mmap, output_splice); - fprintf(ofp, " (default UST uid: %s, UST pid: %s, kernel: %s, metadata: %s)\n", - DEFAULT_UST_UID_CHANNEL_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice, - DEFAULT_UST_PID_CHANNEL_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice, - DEFAULT_KERNEL_CHANNEL_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice, - DEFAULT_METADATA_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice); - fprintf(ofp, " --buffers-uid Use per UID buffer (-u only)\n"); - fprintf(ofp, " --buffers-pid Use per PID buffer (-u only)\n"); - fprintf(ofp, " --buffers-global Use shared buffer for the whole system (-k only)\n"); - fprintf(ofp, " -C, --tracefile-size SIZE\n"); - fprintf(ofp, " Maximum size of each tracefile within a stream (in bytes). 0 means unlimited.\n"); - fprintf(ofp, " (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_SIZE); - fprintf(ofp, " -W, --tracefile-count COUNT\n"); - fprintf(ofp, " Used in conjunction with -C option, this will limit the number\n"); - fprintf(ofp, " of files created to the specified count. 0 means unlimited.\n"); - fprintf(ofp, " (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_COUNT); - fprintf(ofp, "\n"); -} - /* * Set default attributes depending on those already defined from the command * line. @@ -169,7 +114,7 @@ static void set_default_attr(struct lttng_domain *dom) if (chan.attr.read_timer_interval == -1) { chan.attr.read_timer_interval = default_attr.read_timer_interval; } - if (chan.attr.output == -1) { + if ((int) chan.attr.output == -1) { chan.attr.output = default_attr.output; } if (chan.attr.tracefile_count == -1) { @@ -185,7 +130,7 @@ static void set_default_attr(struct lttng_domain *dom) */ static int enable_channel(char *session_name) { - int ret = CMD_SUCCESS, warn = 0; + int ret = CMD_SUCCESS, warn = 0, error = 0, success = 0; char *channel_name; struct lttng_domain dom; @@ -213,9 +158,8 @@ static int enable_channel(char *session_name) dom.buf_type = LTTNG_BUFFER_PER_UID; } } else { - ERR("Please specify a tracer (-k/--kernel or -u/--userspace)"); - ret = CMD_ERROR; - goto error; + /* Checked by the caller. */ + assert(0); } set_default_attr(&dom); @@ -243,7 +187,6 @@ static int enable_channel(char *session_name) } else { ERR("Unknown output type %s. Possible values are: %s, %s\n", opt_output, output_mmap, output_splice); - usage(stderr); ret = CMD_ERROR; goto error; } @@ -255,45 +198,110 @@ static int enable_channel(char *session_name) goto error; } + /* Mi open channels element */ + if (lttng_opt_mi) { + assert(writer); + ret = mi_lttng_channels_open(writer); + if (ret) { + ret = CMD_ERROR; + goto error; + } + } + /* Strip channel list (format: chan1,chan2,...) */ channel_name = strtok(opt_channels, ","); while (channel_name != NULL) { - /* Copy channel name and normalize it */ - strncpy(chan.name, channel_name, NAME_MAX); - chan.name[NAME_MAX - 1] = '\0'; + /* Validate channel name's length */ + if (strlen(channel_name) >= NAME_MAX) { + ERR("Channel name is too long (max. %zu characters)", + sizeof(chan.name) - 1); + error = 1; + goto skip_enable; + } + + /* Copy channel name */ + strcpy(chan.name, channel_name); DBG("Enabling channel %s", channel_name); ret = lttng_enable_channel(handle, &chan); if (ret < 0) { + success = 0; switch (-ret) { case LTTNG_ERR_KERN_CHAN_EXIST: case LTTNG_ERR_UST_CHAN_EXIST: + case LTTNG_ERR_CHAN_EXIST: WARN("Channel %s: %s (session %s)", channel_name, lttng_strerror(ret), session_name); - goto error; + warn = 1; + break; + case LTTNG_ERR_INVALID_CHANNEL_NAME: + ERR("Invalid channel name: \"%s\". " + "Channel names may not start with '.', and " + "may not contain '/'.", channel_name); + error = 1; + break; default: ERR("Channel %s: %s (session %s)", channel_name, lttng_strerror(ret), session_name); + error = 1; break; } - warn = 1; } else { MSG("%s channel %s enabled for session %s", - opt_kernel ? "Kernel" : "UST", channel_name, - session_name); + get_domain_str(dom.type), channel_name, session_name); + success = 1; + } + +skip_enable: + if (lttng_opt_mi) { + /* Mi print the channel element and leave it open */ + ret = mi_lttng_channel(writer, &chan, 1); + if (ret) { + ret = CMD_ERROR; + goto error; + } + + /* Individual Success ? */ + ret = mi_lttng_writer_write_element_bool(writer, + mi_lttng_element_command_success, success); + if (ret) { + ret = CMD_ERROR; + goto error; + } + + /* Close channel element */ + ret = mi_lttng_writer_close_element(writer); + if (ret) { + ret = CMD_ERROR; + goto error; + } } - /* Next event */ + /* Next channel */ channel_name = strtok(NULL, ","); } + if (lttng_opt_mi) { + /* Close channels element */ + ret = mi_lttng_writer_close_element(writer); + if (ret) { + ret = CMD_ERROR; + goto error; + } + } + ret = CMD_SUCCESS; error: - if (warn) { + /* If more important error happen bypass the warning */ + if (!ret && warn) { ret = CMD_WARNING; } + /* If more important error happen bypass the warning */ + if (!ret && error) { + ret = CMD_ERROR; + } lttng_destroy_handle(handle); @@ -310,6 +318,7 @@ static void init_channel_config(void) * those needed to be set by the default values. */ memset(&chan.attr, -1, sizeof(chan.attr)); + chan.attr.extended.ptr = NULL; } /* @@ -317,7 +326,7 @@ static void init_channel_config(void) */ int cmd_enable_channels(int argc, const char **argv) { - int opt, ret = CMD_SUCCESS; + int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1; static poptContext pc; char *session_name = NULL; char *opt_arg = NULL; @@ -330,7 +339,7 @@ int cmd_enable_channels(int argc, const char **argv) while ((opt = poptGetNextOpt(pc)) != -1) { switch (opt) { case OPT_HELP: - usage(stdout); + SHOW_HELP(); goto end; case OPT_DISCARD: chan.attr.overwrite = 0; @@ -356,6 +365,13 @@ int cmd_enable_channels(int argc, const char **argv) order = get_count_order_u64(chan.attr.subbuf_size); assert(order >= 0); rounded_size = 1ULL << order; + if (rounded_size < chan.attr.subbuf_size) { + ERR("The subbuf size (%" PRIu64 ") is rounded and overflows!", + chan.attr.subbuf_size); + ret = CMD_ERROR; + goto end; + } + if (rounded_size != chan.attr.subbuf_size) { WARN("The subbuf size (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")", chan.attr.subbuf_size, rounded_size); @@ -385,6 +401,13 @@ int cmd_enable_channels(int argc, const char **argv) order = get_count_order_u64(chan.attr.num_subbuf); assert(order >= 0); rounded_size = 1ULL << order; + if (rounded_size < chan.attr.num_subbuf) { + ERR("The number of subbuffers (%" PRIu64 ") is rounded and overflows!", + chan.attr.num_subbuf); + ret = CMD_ERROR; + goto end; + } + if (rounded_size != chan.attr.num_subbuf) { WARN("The number of subbuffers (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")", chan.attr.num_subbuf, rounded_size); @@ -478,36 +501,102 @@ int cmd_enable_channels(int argc, const char **argv) list_cmd_options(stdout, long_options); goto end; default: - usage(stderr); ret = CMD_UNDEFINED; goto end; } } + ret = print_missing_or_multiple_domains(opt_kernel + opt_userspace); + if (ret) { + ret = CMD_ERROR; + goto end; + } + + /* Mi check */ + if (lttng_opt_mi) { + writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi); + if (!writer) { + ret = -LTTNG_ERR_NOMEM; + goto end; + } + + /* Open command element */ + ret = mi_lttng_writer_command_open(writer, + mi_lttng_element_command_enable_channels); + if (ret) { + ret = CMD_ERROR; + goto end; + } + + /* Open output element */ + ret = mi_lttng_writer_open_element(writer, + mi_lttng_element_command_output); + if (ret) { + ret = CMD_ERROR; + goto end; + } + } + opt_channels = (char*) poptGetArg(pc); if (opt_channels == NULL) { ERR("Missing channel name.\n"); - usage(stderr); ret = CMD_ERROR; - goto end; + success = 0; + goto mi_closing; } if (!opt_session_name) { session_name = get_session_name(); if (session_name == NULL) { - ret = CMD_ERROR; - goto end; + command_ret = CMD_ERROR; + success = 0; + goto mi_closing; } } else { session_name = opt_session_name; } - ret = enable_channel(session_name); + command_ret = enable_channel(session_name); + if (command_ret) { + success = 0; + } + +mi_closing: + /* Mi closing */ + if (lttng_opt_mi) { + /* Close output element */ + ret = mi_lttng_writer_close_element(writer); + if (ret) { + goto end; + } + + /* Success ? */ + ret = mi_lttng_writer_write_element_bool(writer, + mi_lttng_element_command_success, success); + if (ret) { + goto end; + } + + /* Command element close */ + ret = mi_lttng_writer_command_close(writer); + if (ret) { + goto end; + } + } end: + /* Mi clean-up */ + if (writer && mi_lttng_writer_destroy(writer)) { + /* Preserve original error code */ + ret = ret ? ret : LTTNG_ERR_MI_IO_FAIL; + } + if (!opt_session_name && session_name) { free(session_name); } + + /* Overwrite ret if an error occurred when enable_channel */ + ret = command_ret ? command_ret : ret; poptFreeContext(pc); return ret; }