X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng%2Fcommands%2Fdisable_events.c;h=501c3cf3aa7bc31caecf8792a68a5966c4086594;hp=0e53b4228fb1439b67685b16a0be17199c2e16a3;hb=1831ae68b70dece8e9b847081526495adbbf05e5;hpb=c399183f4b3257c43915f3d81f44befd23165ad9 diff --git a/src/bin/lttng/commands/disable_events.c b/src/bin/lttng/commands/disable_events.c index 0e53b4228..501c3cf3a 100644 --- a/src/bin/lttng/commands/disable_events.c +++ b/src/bin/lttng/commands/disable_events.c @@ -1,22 +1,11 @@ /* - * Copyright (C) 2011 - David Goulet + * Copyright (C) 2011 David Goulet * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; only version 2 - * of the License. + * SPDX-License-Identifier: GPL-2.0-only * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -#define _GNU_SOURCE +#define _LGPL_SOURCE #include #include #include @@ -24,6 +13,9 @@ #include #include #include +#include + +#include #include "../command.h" @@ -32,16 +24,30 @@ static int opt_kernel; static char *opt_channel_name; static char *opt_session_name; static int opt_userspace; -static char *opt_cmd_name; static int opt_disable_all; -static pid_t opt_pid; +static int opt_jul; +static int opt_log4j; +static int opt_python; +static int opt_event_type; + +#ifdef LTTNG_EMBED_HELP +static const char help_msg[] = +#include +; +#endif enum { OPT_HELP = 1, - OPT_USERSPACE, + OPT_TYPE_SYSCALL, + OPT_TYPE_TRACEPOINT, + OPT_TYPE_PROBE, + OPT_TYPE_FUNCTION, + OPT_TYPE_ALL, + OPT_LIST_OPTIONS, }; static struct lttng_handle *handle; +static struct mi_writer *writer; static struct poptOption long_options[] = { /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ @@ -49,29 +55,95 @@ static struct poptOption long_options[] = { {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0}, {"all-events", 'a', POPT_ARG_VAL, &opt_disable_all, 1, 0, 0}, {"channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0}, + {"jul", 'j', POPT_ARG_VAL, &opt_jul, 1, 0, 0}, + {"log4j", 'l', POPT_ARG_VAL, &opt_log4j, 1, 0, 0}, + {"python", 'p', POPT_ARG_VAL, &opt_python, 1, 0, 0}, {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0}, - {"userspace", 'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0}, - {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0}, + {"userspace", 'u', POPT_ARG_VAL, &opt_userspace, 1, 0, 0}, + {"syscall", 0, POPT_ARG_NONE, 0, OPT_TYPE_SYSCALL, 0, 0}, + {"probe", 0, POPT_ARG_NONE, 0, OPT_TYPE_PROBE, 0, 0}, + {"tracepoint", 0, POPT_ARG_NONE, 0, OPT_TYPE_TRACEPOINT, 0, 0}, + {"function", 0, POPT_ARG_NONE, 0, OPT_TYPE_FUNCTION, 0, 0}, + {"all", 0, POPT_ARG_NONE, 0, OPT_TYPE_ALL, 0, 0}, + {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL}, {0, 0, 0, 0, 0, 0, 0} }; -/* - * usage +static +const char *print_channel_name(const char *name) +{ + return name ? : DEFAULT_CHANNEL_NAME; +} + +static +const char *print_raw_channel_name(const char *name) +{ + return name ? : ""; +} + +static +const char *print_event_type(const enum lttng_event_type ev_type) +{ + switch (ev_type) { + case LTTNG_EVENT_ALL: + return "any"; + case LTTNG_EVENT_TRACEPOINT: + return "tracepoint"; + case LTTNG_EVENT_PROBE: + return "probe"; + case LTTNG_EVENT_FUNCTION: + return "function"; + case LTTNG_EVENT_FUNCTION_ENTRY: + return "function entry"; + case LTTNG_EVENT_SYSCALL: + return "syscall"; + default: + return ""; + } +} + +/* Mi print a partial event. + * enabled is 0 or 1 + * success is 0 or 1 */ -static void usage(FILE *ofp) +static int mi_print_event(const char *event_name, int enabled, int success) { - fprintf(ofp, "usage: lttng disable-event NAME[,NAME2,...] [options]\n"); - fprintf(ofp, "\n"); - fprintf(ofp, " -h, --help Show this help\n"); - fprintf(ofp, " -s, --session Apply on session name\n"); - fprintf(ofp, " -c, --channel Apply on this channel\n"); - fprintf(ofp, " -a, --all-events Disable all tracepoints\n"); - fprintf(ofp, " -k, --kernel Apply for the kernel tracer\n"); - fprintf(ofp, " -u, --userspace [CMD] Apply for the user-space tracer\n"); - fprintf(ofp, " If no CMD, the domain used is UST global\n"); - fprintf(ofp, " or else the domain is UST EXEC_NAME\n"); - fprintf(ofp, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n"); - fprintf(ofp, "\n"); + int ret; + + assert(writer); + assert(event_name); + + /* Open event element */ + ret = mi_lttng_writer_open_element(writer, config_element_event); + if (ret) { + goto end; + } + + /* Print the name of event */ + ret = mi_lttng_writer_write_element_string(writer, + config_element_name, event_name); + if (ret) { + goto end; + } + + /* Print enabled ? */ + ret = mi_lttng_writer_write_element_bool(writer, + config_element_enabled, enabled); + if (ret) { + goto end; + } + + /* Success ? */ + ret = mi_lttng_writer_write_element_bool(writer, + mi_lttng_element_command_success, success); + if (ret) { + goto end; + } + + /* Close event element */ + ret = mi_lttng_writer_close_element(writer); +end: + return ret; } /* @@ -81,104 +153,158 @@ static void usage(FILE *ofp) */ static int disable_events(char *session_name) { - int err, ret = CMD_SUCCESS; + int ret = CMD_SUCCESS, warn = 0, command_ret = CMD_SUCCESS; + int enabled = 1, success = 1; char *event_name, *channel_name = NULL; struct lttng_domain dom; + struct lttng_event event; - if (opt_channel_name == NULL) { - err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME); - if (err < 0) { - ret = CMD_FATAL; - goto error; - } - } else { - channel_name = opt_channel_name; - } - - if (opt_kernel && opt_userspace) { - ERR("Can't use -k/--kernel and -u/--userspace together"); - ret = CMD_FATAL; - goto error; - } + memset(&dom, 0, sizeof(dom)); + /* Create lttng domain */ if (opt_kernel) { dom.type = LTTNG_DOMAIN_KERNEL; - } else if (opt_pid != 0) { - dom.type = LTTNG_DOMAIN_UST_PID; - dom.attr.pid = opt_pid; - DBG("PID %d set to lttng handle", opt_pid); - } else if (opt_userspace && opt_cmd_name == NULL) { + } else if (opt_userspace) { dom.type = LTTNG_DOMAIN_UST; - DBG("UST global domain selected"); - } else if (opt_userspace && opt_cmd_name != NULL) { - dom.type = LTTNG_DOMAIN_UST_EXEC_NAME; - strncpy(dom.attr.exec_name, opt_cmd_name, NAME_MAX); - dom.attr.exec_name[NAME_MAX - 1] = '\0'; + } else if (opt_jul) { + dom.type = LTTNG_DOMAIN_JUL; + } else if (opt_log4j) { + dom.type = LTTNG_DOMAIN_LOG4J; + } else if (opt_python) { + dom.type = LTTNG_DOMAIN_PYTHON; } else { - ERR("Please specify a tracer (-k/--kernel or -u/--userspace)"); - ret = CMD_NOT_IMPLEMENTED; - goto error; + /* Checked by the caller. */ + assert(0); } + channel_name = opt_channel_name; + handle = lttng_create_handle(session_name, &dom); if (handle == NULL) { ret = -1; goto error; } - if (opt_disable_all) { - ret = lttng_disable_event(handle, NULL, channel_name); - if (ret < 0) { - goto error; + /* Mi print the channel and open the events element */ + if (lttng_opt_mi) { + ret = mi_lttng_writer_open_element(writer, config_element_channel); + if (ret) { + ret = CMD_ERROR; + goto end; } - MSG("All %s events are disabled in channel %s", - opt_kernel ? "kernel" : "UST", channel_name); - goto end; + ret = mi_lttng_writer_write_element_string(writer, + config_element_name, print_channel_name(channel_name)); + if (ret) { + ret = CMD_ERROR; + goto end; + } + + /* Open events element */ + ret = mi_lttng_writer_open_element(writer, config_element_events); + if (ret) { + ret = CMD_ERROR; + goto end; + } } - /* Strip event list */ - event_name = strtok(opt_event_list, ","); - while (event_name != NULL) { - /* Kernel tracer action */ - if (opt_kernel) { - DBG("Disabling kernel event %s in channel %s", - event_name, channel_name); - } else if (opt_userspace) { /* User-space tracer action */ - if (opt_cmd_name != NULL || opt_pid) { - MSG("Only supporting tracing all UST processes (-u) for now."); - ret = CMD_NOT_IMPLEMENTED; - goto error; - } - DBG("Disabling UST event %s in channel %s", - event_name, channel_name); + memset(&event, 0, sizeof(event)); + /* Set default loglevel to any/unknown */ + event.loglevel = -1; + + /* opt_event_type contain the event type to disable at this point */ + event.type = opt_event_type; + + if (opt_disable_all) { + command_ret = lttng_disable_event_ext(handle, &event, channel_name, NULL); + if (command_ret < 0) { + ERR("%s", lttng_strerror(command_ret)); + enabled = 1; + success = 0; + } else { - ERR("Please specify a tracer (-k/--kernel or -u/--userspace)"); - goto error; + enabled = 0; + success = 1; + MSG("All %s events of type %s are disabled in channel %s", + get_domain_str(dom.type), + print_event_type(opt_event_type), + print_channel_name(channel_name)); } - ret = lttng_disable_event(handle, event_name, channel_name); - if (ret < 0) { - MSG("Unable to disable %s event %s in channel %s", - opt_kernel ? "kernel" : "UST", event_name, - channel_name); - } else { - MSG("%s event %s disabled in channel %s", - opt_kernel ? "kernel" : "UST", event_name, - channel_name); + if (lttng_opt_mi) { + ret = mi_print_event("*", enabled, success); + if (ret) { + ret = CMD_ERROR; + goto error; + } } + } else { + /* Strip event list */ + event_name = strtok(opt_event_list, ","); + while (event_name != NULL) { + DBG("Disabling event %s", event_name); - /* Next event */ - event_name = strtok(NULL, ","); + strncpy(event.name, event_name, sizeof(event.name)); + event.name[sizeof(event.name) - 1] = '\0'; + command_ret = lttng_disable_event_ext(handle, &event, channel_name, NULL); + if (command_ret < 0) { + ERR("%s of type %s : %s (channel %s, session %s)", + event_name, + print_event_type(opt_event_type), + lttng_strerror(command_ret), + command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME + ? print_raw_channel_name(channel_name) + : print_channel_name(channel_name), + session_name); + warn = 1; + success = 0; + /* + * If an error occurred we assume that the event is still + * enabled. + */ + enabled = 1; + } else { + MSG("%s %s of type %s disabled in channel %s for session %s", + get_domain_str(dom.type), + event_name, + print_event_type(opt_event_type), + print_channel_name(channel_name), + session_name); + success = 1; + enabled = 0; + } + + if (lttng_opt_mi) { + ret = mi_print_event(event_name, enabled, success); + if (ret) { + ret = CMD_ERROR; + goto error; + } + } + + /* Next event */ + event_name = strtok(NULL, ","); + } } end: + if (lttng_opt_mi) { + /* Close events element and channel element */ + ret = mi_lttng_close_multi_element(writer, 2); + if (ret) { + ret = CMD_ERROR; + } + } error: - if (opt_channel_name == NULL) { - free(channel_name); + /* if there is already an error preserve it */ + if (warn && !ret) { + ret = CMD_WARNING; } - lttng_destroy_handle(handle); + /* Overwrite ret if an error occurred */ + ret = command_ret ? command_ret : ret; + + lttng_destroy_handle(handle); return ret; } @@ -189,49 +315,165 @@ error: */ int cmd_disable_events(int argc, const char **argv) { - int opt, ret; + int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1; static poptContext pc; char *session_name = NULL; + const char *leftover = NULL; + int event_type = -1; pc = poptGetContext(NULL, argc, argv, long_options, 0); poptReadDefaultConfig(pc, 0); + /* Default event type */ + opt_event_type = LTTNG_EVENT_ALL; + while ((opt = poptGetNextOpt(pc)) != -1) { switch (opt) { case OPT_HELP: - usage(stderr); - ret = CMD_SUCCESS; + SHOW_HELP(); goto end; - case OPT_USERSPACE: - opt_userspace = 1; + case OPT_TYPE_SYSCALL: + opt_event_type = LTTNG_EVENT_SYSCALL; + break; + case OPT_TYPE_TRACEPOINT: + opt_event_type = LTTNG_EVENT_TRACEPOINT; + break; + case OPT_TYPE_PROBE: + opt_event_type = LTTNG_EVENT_PROBE; + break; + case OPT_TYPE_FUNCTION: + opt_event_type = LTTNG_EVENT_FUNCTION; break; + case OPT_TYPE_ALL: + opt_event_type = LTTNG_EVENT_ALL; + break; + case OPT_LIST_OPTIONS: + list_cmd_options(stdout, long_options); + goto end; default: - usage(stderr); ret = CMD_UNDEFINED; goto end; } + + /* Validate event type. Multiple event type are not supported. */ + if (event_type == -1) { + event_type = opt_event_type; + } else { + if (event_type != opt_event_type) { + ERR("Multiple event type not supported."); + ret = CMD_ERROR; + goto end; + } + } + } + + ret = print_missing_or_multiple_domains( + opt_kernel + opt_userspace + opt_jul + opt_log4j + opt_python); + if (ret) { + ret = CMD_ERROR; + goto end; + } + + /* Ust and agent only support ALL event type */ + if ((opt_userspace || opt_jul || opt_log4j || opt_python) + && opt_event_type != LTTNG_EVENT_ALL) { + ERR("Disabling userspace and agent (-j | -l | -p) event(s) based on instrumentation type is not supported.\n"); + ret = CMD_ERROR; + goto end; } opt_event_list = (char*) poptGetArg(pc); if (opt_event_list == NULL && opt_disable_all == 0) { ERR("Missing event name(s).\n"); - usage(stderr); - ret = CMD_SUCCESS; + ret = CMD_ERROR; + goto end; + } + + leftover = poptGetArg(pc); + if (leftover) { + ERR("Unknown argument: %s", leftover); + ret = CMD_ERROR; goto end; } if (!opt_session_name) { session_name = get_session_name(); if (session_name == NULL) { - ret = -1; + ret = CMD_ERROR; goto end; } } else { session_name = opt_session_name; } - ret = disable_events(session_name); + /* 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_disable_event); + 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; + } + } + + command_ret = disable_events(session_name); + if (command_ret) { + success = 0; + } + + /* 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; + } + } end: + if (!opt_session_name && session_name) { + free(session_name); + } + + /* Mi clean-up */ + if (writer && mi_lttng_writer_destroy(writer)) { + /* Preserve original error code */ + ret = ret ? ret : LTTNG_ERR_MI_IO_FAIL; + } + + /* Overwrite ret if an error occurred in disable_events */ + ret = command_ret ? command_ret : ret; + + poptFreeContext(pc); return ret; }