X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fbin%2Flttng%2Fcommands%2Fenable_events.cpp;h=78cc0ea8b88f6ef8d31723312248fd7cefb0d1be;hb=27b5aa577cff515f5273f75320190877a85317e2;hp=4f50083b74a7cd1a46e85342710a19a83916a715;hpb=d512607fc0612c87ba071ccd3d59b98c9d488d6f;p=lttng-tools.git diff --git a/src/bin/lttng/commands/enable_events.cpp b/src/bin/lttng/commands/enable_events.cpp index 4f50083b7..78cc0ea8b 100644 --- a/src/bin/lttng/commands/enable_events.cpp +++ b/src/bin/lttng/commands/enable_events.cpp @@ -8,6 +8,8 @@ #define _LGPL_SOURCE #include #include +#include +#include #include #include #include @@ -15,11 +17,14 @@ #include #include #include +#include #include #include +#include #include #include #include +#include /* Mi dependancy */ #include "../command.hpp" @@ -36,6 +41,17 @@ #endif namespace { +void _mi_lttng_writer_deleter_func(mi_writer *writer) +{ + if (writer && mi_lttng_writer_destroy(writer)) { + LTTNG_THROW_ERROR("Failed to destroy mi_writer instance"); + } +} + +using mi_writer_uptr = std::unique_ptr< + mi_writer, + lttng::memory::create_deleter_class::deleter>; +using event_rule_patterns = std::vector; int opt_event_type; const char *opt_loglevel; @@ -54,6 +70,9 @@ char *opt_channel_name; char *opt_filter; char *opt_exclude; +struct lttng_handle *handle; +mi_writer_uptr writer; + #ifdef LTTNG_EMBED_HELP static const char help_msg[] = #include @@ -75,9 +94,6 @@ enum { OPT_EXCLUDE, }; -struct lttng_handle *handle; -struct mi_writer *writer; - struct poptOption long_options[] = { /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ { "help", 'h', POPT_ARG_NONE, nullptr, OPT_HELP, nullptr, nullptr }, @@ -212,7 +228,7 @@ int mi_print_exclusion(const struct lttng_dynamic_pointer_array *exclusions) goto end; } - ret = mi_lttng_writer_open_element(writer, config_element_exclusions); + ret = mi_lttng_writer_open_element(writer.get(), config_element_exclusions); if (ret) { goto end; } @@ -222,14 +238,14 @@ int mi_print_exclusion(const struct lttng_dynamic_pointer_array *exclusions) (const char *) lttng_dynamic_pointer_array_get_pointer(exclusions, i); ret = mi_lttng_writer_write_element_string( - writer, config_element_exclusion, exclusion); + writer.get(), config_element_exclusion, exclusion); if (ret) { goto end; } } /* Close exclusions element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(writer.get()); end: return ret; @@ -280,11 +296,11 @@ char *print_exclusions(const struct lttng_dynamic_pointer_array *exclusions) return ret; } -int check_exclusion_subsets(const char *event_name, const char *exclusion) +int check_exclusion_subsets(const char *pattern, const char *exclusion) { bool warn = false; int ret = 0; - const char *e = event_name; + const char *e = pattern; const char *x = exclusion; /* Scan both the excluder and the event letter by letter */ @@ -302,10 +318,7 @@ int check_exclusion_subsets(const char *event_name, const char *exclusion) if (*x == '*') { /* Event is a subset of the excluder */ - ERR("Event %s: %s excludes all events from %s", - event_name, - exclusion, - event_name); + ERR("Event %s: %s excludes all events from %s", pattern, exclusion, pattern); goto error; } @@ -335,15 +348,15 @@ error: end: if (warn) { WARN("Event %s: %s does not exclude any events from %s", - event_name, + pattern, exclusion, - event_name); + pattern); } return ret; } -int create_exclusion_list_and_validate(const char *event_name, +int create_exclusion_list_and_validate(const char *pattern, const char *exclusions_arg, struct lttng_dynamic_pointer_array *exclusions) { @@ -355,7 +368,7 @@ int create_exclusion_list_and_validate(const char *event_name, goto error; } - if (validate_exclusion_list(event_name, exclusions) != 0) { + if (validate_exclusion_list(pattern, exclusions) != 0) { goto error; } @@ -390,11 +403,11 @@ void warn_on_truncated_exclusion_names(const struct lttng_dynamic_pointer_array * Enabling event using the lttng API. * Note: in case of error only the last error code will be return. */ -int enable_events(char *session_name, char *event_list) +int enable_events(const std::string& session_name, const event_rule_patterns& patterns) { int ret = CMD_SUCCESS, command_ret = CMD_SUCCESS; int error_holder = CMD_SUCCESS, warn = 0, error = 0, success = 1; - char *event_name, *channel_name = nullptr; + char *channel_name = nullptr; struct lttng_event *ev; struct lttng_domain dom = {}; struct lttng_dynamic_pointer_array exclusions; @@ -483,7 +496,7 @@ int enable_events(char *session_name, char *event_list) channel_name = opt_channel_name; - handle = lttng_create_handle(session_name, &dom); + handle = lttng_create_handle(session_name.c_str(), &dom); if (handle == nullptr) { ret = -1; goto error; @@ -492,7 +505,7 @@ int enable_events(char *session_name, char *event_list) /* Prepare Mi */ if (lttng_opt_mi) { /* Open a events element */ - ret = mi_lttng_writer_open_element(writer, config_element_events); + ret = mi_lttng_writer_open_element(writer.get(), config_element_events); if (ret) { ret = CMD_ERROR; goto error; @@ -584,7 +597,7 @@ int enable_events(char *session_name, char *event_list) case LTTNG_ERR_KERN_EVENT_EXIST: WARN("Kernel events already enabled (channel %s, session %s)", print_channel_name(channel_name), - session_name); + session_name.c_str()); warn = 1; break; case LTTNG_ERR_TRACE_ALREADY_STARTED: @@ -594,7 +607,7 @@ int enable_events(char *session_name, char *event_list) ERR("Events: %s (channel %s, session %s)", msg, print_channel_name(channel_name), - session_name); + session_name.c_str()); error = 1; break; } @@ -604,7 +617,7 @@ int enable_events(char *session_name, char *event_list) ret == -LTTNG_ERR_NEED_CHANNEL_NAME ? print_raw_channel_name(channel_name) : print_channel_name(channel_name), - session_name); + session_name.c_str()); error = 1; break; } @@ -702,7 +715,7 @@ int enable_events(char *session_name, char *event_list) WARN("Filter on all events is already enabled" " (channel %s, session %s)", print_channel_name(channel_name), - session_name); + session_name.c_str()); warn = 1; break; case LTTNG_ERR_TRACE_ALREADY_STARTED: @@ -712,7 +725,7 @@ int enable_events(char *session_name, char *event_list) ERR("All events: %s (channel %s, session %s, filter \'%s\')", msg, print_channel_name(channel_name), - session_name, + session_name.c_str(), opt_filter); error = 1; break; @@ -723,7 +736,7 @@ int enable_events(char *session_name, char *event_list) command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME ? print_raw_channel_name(channel_name) : print_channel_name(channel_name), - session_name, + session_name.c_str(), opt_filter); error = 1; break; @@ -752,7 +765,7 @@ int enable_events(char *session_name, char *event_list) ev->enabled = 0; success = 0; } - ret = mi_lttng_event(writer, ev, 1, handle->domain.type); + ret = mi_lttng_event(writer.get(), ev, 1, handle->domain.type); if (ret) { ret = CMD_ERROR; goto error; @@ -767,14 +780,14 @@ int enable_events(char *session_name, char *event_list) /* Success ? */ ret = mi_lttng_writer_write_element_bool( - writer, mi_lttng_element_command_success, success); + writer.get(), mi_lttng_element_command_success, success); if (ret) { ret = CMD_ERROR; goto error; } /* Close event element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(writer.get()); if (ret) { ret = CMD_ERROR; goto error; @@ -785,18 +798,17 @@ int enable_events(char *session_name, char *event_list) } /* Strip event list */ - event_name = strtok(event_list, ","); - while (event_name != nullptr) { + for (const auto& pattern : patterns) { /* Copy name and type of the event */ - strncpy(ev->name, event_name, LTTNG_SYMBOL_NAME_LEN); + strncpy(ev->name, pattern.c_str(), LTTNG_SYMBOL_NAME_LEN); ev->name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0'; ev->type = (lttng_event_type) opt_event_type; /* Kernel tracer action */ if (opt_kernel) { - DBG("Enabling kernel event %s for channel %s", - event_name, - print_channel_name(channel_name)); + DBG_FMT("Enabling kernel event: pattern=`{}`, channel_name=`{}`", + pattern, + print_channel_name(channel_name)); switch (opt_event_type) { case LTTNG_EVENT_ALL: /* Enable tracepoints and syscalls */ @@ -866,7 +878,7 @@ int enable_events(char *session_name, char *event_list) ev->loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL; } else if (opt_userspace) { /* User-space tracer action */ DBG("Enabling UST event %s for channel %s, loglevel %s", - event_name, + pattern.c_str(), print_channel_name(channel_name), opt_loglevel ?: ""); @@ -876,7 +888,7 @@ int enable_events(char *session_name, char *event_list) case LTTNG_EVENT_TRACEPOINT: /* Copy name and type of the event */ ev->type = LTTNG_EVENT_TRACEPOINT; - strncpy(ev->name, event_name, LTTNG_SYMBOL_NAME_LEN); + strncpy(ev->name, pattern.c_str(), LTTNG_SYMBOL_NAME_LEN); ev->name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0'; break; case LTTNG_EVENT_PROBE: @@ -900,7 +912,7 @@ int enable_events(char *session_name, char *event_list) /* Free previously allocated items. */ lttng_dynamic_pointer_array_reset(&exclusions); ret = create_exclusion_list_and_validate( - event_name, opt_exclude, &exclusions); + pattern.c_str(), opt_exclude, &exclusions); if (ret) { ret = CMD_ERROR; goto error; @@ -973,7 +985,7 @@ int enable_events(char *session_name, char *event_list) } } ev->type = LTTNG_EVENT_TRACEPOINT; - strncpy(ev->name, event_name, LTTNG_SYMBOL_NAME_LEN); + strncpy(ev->name, pattern.c_str(), LTTNG_SYMBOL_NAME_LEN); ev->name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0'; } else { abort(); @@ -1000,10 +1012,10 @@ int enable_events(char *session_name, char *event_list) switch (-command_ret) { case LTTNG_ERR_KERN_EVENT_EXIST: WARN("Kernel event %s%s already enabled (channel %s, session %s)", - event_name, + pattern.c_str(), exclusion_string, print_channel_name(channel_name), - session_name); + session_name.c_str()); warn = 1; break; case LTTNG_ERR_TRACE_ALREADY_STARTED: @@ -1011,30 +1023,30 @@ int enable_events(char *session_name, char *event_list) const char *msg = "The command tried to enable an event in a new domain for a session that has already been started once."; ERR("Event %s%s: %s (channel %s, session %s)", - event_name, + pattern.c_str(), exclusion_string, msg, print_channel_name(channel_name), - session_name); + session_name.c_str()); error = 1; break; } case LTTNG_ERR_SDT_PROBE_SEMAPHORE: ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)", - event_name, + pattern.c_str(), print_channel_name(channel_name), - session_name); + session_name.c_str()); error = 1; break; default: ERR("Event %s%s: %s (channel %s, session %s)", - event_name, + pattern.c_str(), exclusion_string, lttng_strerror(command_ret), command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME ? print_raw_channel_name(channel_name) : print_channel_name(channel_name), - session_name); + session_name.c_str()); error = 1; break; } @@ -1045,7 +1057,7 @@ int enable_events(char *session_name, char *event_list) case LTTNG_DOMAIN_UST: MSG("%s event %s%s created in channel %s", lttng_domain_type_str(dom.type), - event_name, + pattern.c_str(), exclusion_string, print_channel_name(channel_name)); break; @@ -1058,7 +1070,7 @@ int enable_events(char *session_name, char *event_list) */ MSG("%s event %s%s enabled", lttng_domain_type_str(dom.type), - event_name, + pattern.c_str(), exclusion_string); break; default: @@ -1092,10 +1104,10 @@ int enable_events(char *session_name, char *event_list) case LTTNG_ERR_FILTER_EXIST: WARN("Filter on event %s%s is already enabled" " (channel %s, session %s)", - event_name, + pattern.c_str(), exclusion_string, print_channel_name(channel_name), - session_name); + session_name.c_str()); warn = 1; break; case LTTNG_ERR_TRACE_ALREADY_STARTED: @@ -1107,7 +1119,7 @@ int enable_events(char *session_name, char *event_list) exclusion_string, msg, print_channel_name(channel_name), - session_name, + session_name.c_str(), opt_filter); error = 1; break; @@ -1120,7 +1132,7 @@ int enable_events(char *session_name, char *event_list) command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME ? print_raw_channel_name(channel_name) : print_channel_name(channel_name), - session_name, + session_name.c_str(), opt_filter); error = 1; break; @@ -1129,7 +1141,7 @@ int enable_events(char *session_name, char *event_list) } else { MSG("Event %s%s: Filter '%s' successfully set", - event_name, + pattern.c_str(), exclusion_string, opt_filter); } @@ -1144,7 +1156,7 @@ int enable_events(char *session_name, char *event_list) ev->enabled = 1; } - ret = mi_lttng_event(writer, ev, 1, handle->domain.type); + ret = mi_lttng_event(writer.get(), ev, 1, handle->domain.type); if (ret) { ret = CMD_ERROR; goto error; @@ -1159,22 +1171,20 @@ int enable_events(char *session_name, char *event_list) /* Success ? */ ret = mi_lttng_writer_write_element_bool( - writer, mi_lttng_element_command_success, success); + writer.get(), mi_lttng_element_command_success, success); if (ret) { ret = CMD_ERROR; goto end; } /* Close event element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(writer.get()); if (ret) { ret = CMD_ERROR; goto end; } } - /* Next event */ - event_name = strtok(nullptr, ","); /* Reset warn, error and success */ success = 1; } @@ -1183,7 +1193,7 @@ end: /* Close Mi */ if (lttng_opt_mi) { /* Close events element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(writer.get()); if (ret) { ret = CMD_ERROR; goto error; @@ -1209,16 +1219,21 @@ error: return ret; } +void _poptContextFree_deleter_func(poptContext ctx) +{ + poptFreeContext(ctx); +} + } /* namespace */ -int validate_exclusion_list(const char *event_name, +int validate_exclusion_list(const char *pattern, const struct lttng_dynamic_pointer_array *exclusions) { int ret; /* Event name must be a valid globbing pattern to allow exclusions. */ - if (!strutils_is_star_glob_pattern(event_name)) { - ERR("Event %s: Exclusions can only be used with a globbing pattern", event_name); + if (!strutils_is_star_glob_pattern(pattern)) { + ERR("Event %s: Exclusions can only be used with a globbing pattern", pattern); goto error; } @@ -1227,7 +1242,7 @@ int validate_exclusion_list(const char *event_name, * then we can validate the individual exclusions. Otherwise * all exclusions are passed to the session daemon. */ - if (strutils_is_star_at_the_end_only_glob_pattern(event_name)) { + if (strutils_is_star_at_the_end_only_glob_pattern(pattern)) { size_t i, num_exclusions; num_exclusions = lttng_dynamic_pointer_array_get_count(exclusions); @@ -1239,7 +1254,7 @@ int validate_exclusion_list(const char *event_name, if (!strutils_is_star_glob_pattern(exclusion) || strutils_is_star_at_the_end_only_glob_pattern(exclusion)) { - ret = check_exclusion_subsets(event_name, exclusion); + ret = check_exclusion_subsets(pattern, exclusion); if (ret) { goto error; } @@ -1263,24 +1278,25 @@ end: int cmd_enable_events(int argc, const char **argv) { int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1; - static poptContext pc; - char *session_name = nullptr; - char *event_list = nullptr; + std::string session_name; const char *arg_event_list = nullptr; const char *leftover = nullptr; int event_type = -1; + event_rule_patterns patterns; + std::stringstream event_list_arg_stream(arg_event_list); - pc = poptGetContext(nullptr, argc, argv, long_options, 0); - poptReadDefaultConfig(pc, 0); + auto pc = lttng::make_unique_wrapper( + poptGetContext(nullptr, argc, argv, long_options, 0)); + poptReadDefaultConfig(pc.get(), 0); /* Default event type */ opt_event_type = LTTNG_EVENT_ALL; - while ((opt = poptGetNextOpt(pc)) != -1) { + while ((opt = poptGetNextOpt(pc.get())) != -1) { switch (opt) { case OPT_HELP: SHOW_HELP(); - goto end; + return CMD_SUCCESS; case OPT_TRACEPOINT: opt_event_type = LTTNG_EVENT_TRACEPOINT; break; @@ -1301,22 +1317,21 @@ int cmd_enable_events(int argc, const char **argv) break; case OPT_LOGLEVEL: opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_RANGE; - opt_loglevel = poptGetOptArg(pc); + opt_loglevel = poptGetOptArg(pc.get()); break; case OPT_LOGLEVEL_ONLY: opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_SINGLE; - opt_loglevel = poptGetOptArg(pc); + opt_loglevel = poptGetOptArg(pc.get()); break; case OPT_LIST_OPTIONS: list_cmd_options(stdout, long_options); - goto end; + return CMD_SUCCESS; case OPT_FILTER: break; case OPT_EXCLUDE: break; default: - ret = CMD_UNDEFINED; - goto end; + return CMD_UNDEFINED; } /* Validate event type. Multiple event type are not supported. */ @@ -1325,8 +1340,7 @@ int cmd_enable_events(int argc, const char **argv) } else { if (event_type != opt_event_type) { ERR("Multiple event type not supported."); - ret = CMD_ERROR; - goto end; + return CMD_ERROR; } } } @@ -1334,114 +1348,95 @@ int cmd_enable_events(int argc, const char **argv) ret = print_missing_or_multiple_domains( opt_kernel + opt_userspace + opt_jul + opt_log4j + opt_python, true); if (ret) { - ret = CMD_ERROR; - goto end; + return CMD_ERROR; } /* Mi check */ if (lttng_opt_mi) { - writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi); + writer = mi_writer_uptr(mi_lttng_writer_create(fileno(stdout), lttng_opt_mi)); if (!writer) { - ret = -LTTNG_ERR_NOMEM; - goto end; + LTTNG_THROW_ERROR(lttng::format( + "Failed to create MI writer: format_code={}", lttng_opt_mi)); } /* Open command element */ - ret = mi_lttng_writer_command_open(writer, mi_lttng_element_command_enable_event); + ret = mi_lttng_writer_command_open(writer.get(), + mi_lttng_element_command_enable_event); if (ret) { - ret = CMD_ERROR; - goto end; + LTTNG_THROW_ERROR(lttng::format( + "Failed to open MI command element: command_name=`{}`", + mi_lttng_element_command_enable_event)); } /* Open output element */ - ret = mi_lttng_writer_open_element(writer, mi_lttng_element_command_output); + ret = mi_lttng_writer_open_element(writer.get(), mi_lttng_element_command_output); if (ret) { - ret = CMD_ERROR; - goto end; + LTTNG_THROW_ERROR( + lttng::format("Failed to open MI element: element_name=`{}`", + mi_lttng_element_command_output)); } } - arg_event_list = poptGetArg(pc); + /* Close the MI command context when leaving the function, no matter the result. */ + const auto close_mi_on_exit = lttng::make_scope_exit([&success]() noexcept { + if (!lttng_opt_mi) { + return; + } + + /* Close output element. */ + if (mi_lttng_writer_close_element(writer.get())) { + ERR_FMT("Failed to close MI output element"); + return; + } + + if (mi_lttng_writer_write_element_bool( + writer.get(), mi_lttng_element_command_success, success)) { + ERR_FMT("Failed to write MI element: element_name=`{}`, value={}", + mi_lttng_element_command_success, + success); + return; + } + + /* Command element close. */ + if (mi_lttng_writer_command_close(writer.get())) { + ERR_FMT("Failed to close MI command element"); + return; + } + }); + + arg_event_list = poptGetArg(pc.get()); if (arg_event_list == nullptr && opt_enable_all == 0) { ERR("Missing event name(s)."); - ret = CMD_ERROR; - goto end; + return CMD_ERROR; } - if (opt_enable_all == 0) { - event_list = strdup(arg_event_list); - if (event_list == nullptr) { - PERROR("Failed to copy event name(s)"); - ret = CMD_ERROR; - goto end; - } + for (std::string line; std::getline(event_list_arg_stream, line, ',');) { + patterns.emplace_back(std::move(line)); } - leftover = poptGetArg(pc); + leftover = poptGetArg(pc.get()); if (leftover) { ERR("Unknown argument: %s", leftover); - ret = CMD_ERROR; - goto end; + return CMD_ERROR; } if (!opt_session_name) { - session_name = get_session_name(); - if (session_name == nullptr) { - command_ret = CMD_ERROR; - success = 0; - goto mi_closing; + const auto rc_file_session_name = + lttng::make_unique_wrapper(get_session_name()); + + if (!rc_file_session_name) { + return CMD_ERROR; } + + session_name = rc_file_session_name.get(); } else { session_name = opt_session_name; } - command_ret = enable_events(session_name, event_list); + command_ret = enable_events(session_name, patterns); if (command_ret) { - success = 0; - goto mi_closing; - } - -mi_closing: - /* Mi closing */ - if (lttng_opt_mi) { - /* Close output element */ - ret = mi_lttng_writer_close_element(writer); - if (ret) { - ret = CMD_ERROR; - goto end; - } - - ret = mi_lttng_writer_write_element_bool( - writer, mi_lttng_element_command_success, success); - if (ret) { - ret = CMD_ERROR; - goto end; - } - - /* Command element close */ - ret = mi_lttng_writer_command_close(writer); - if (ret) { - ret = CMD_ERROR; - goto end; - } + return CMD_ERROR; } -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 == nullptr) { - free(session_name); - } - - free(event_list); - - /* Overwrite ret if an error occurred in enable_events */ - ret = command_ret ? command_ret : ret; - - poptFreeContext(pc); - return ret; + return CMD_SUCCESS; }