From: Jonathan Rajotte Date: Mon, 11 Feb 2019 16:26:05 +0000 (-0500) Subject: lttng: Implement lttng clear session command X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=commitdiff_plain;h=511ed4e25eeb6821dc4f4b6c573fbbdc07c17053;ds=sidebyside lttng: Implement lttng clear session command Signed-off-by: Jonathan Rajotte Change-Id: Ia51a2bf7aa7d764431eff9a45a91d5348bc9a7e5 Signed-off-by: Jérémie Galarneau --- diff --git a/configure.ac b/configure.ac index c60e96715..e1c7554bc 100644 --- a/configure.ac +++ b/configure.ac @@ -389,6 +389,7 @@ _AC_DEFINE_AND_SUBST([DEFAULT_ROTATE_PENDING_TIMER], [500000]) # Command short descriptions _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_ADD_CONTEXT], [Add context fields to a channel]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_CREATE], [Create a tracing session]) +_AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_CLEAR], [Clear a tracing session]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DESTROY], [Tear down tracing sessions]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DISABLE_CHANNEL], [Disable tracing channels]) _AC_DEFINE_QUOTED_AND_SUBST([CMD_DESCR_DISABLE_EVENT], [Disable event rules]) diff --git a/src/bin/lttng/Makefile.am b/src/bin/lttng/Makefile.am index 62ae05937..c75601f21 100644 --- a/src/bin/lttng/Makefile.am +++ b/src/bin/lttng/Makefile.am @@ -26,6 +26,7 @@ lttng_SOURCES = command.h conf.c conf.h commands/start.c \ commands/rotate.c \ commands/enable_rotation.c \ commands/disable_rotation.c \ + commands/clear.c \ utils.c utils.h lttng.c lttng_CFLAGS = $(AM_CFLAGS) $(POPT_CFLAGS) diff --git a/src/bin/lttng/command.h b/src/bin/lttng/command.h index 6b20847f2..b4444b34f 100644 --- a/src/bin/lttng/command.h +++ b/src/bin/lttng/command.h @@ -86,6 +86,7 @@ DECL_COMMAND(regenerate); DECL_COMMAND(rotate); DECL_COMMAND(enable_rotation); DECL_COMMAND(disable_rotation); +DECL_COMMAND(clear); extern int cmd_help(int argc, const char **argv, const struct cmd_struct commands[]); diff --git a/src/bin/lttng/commands/clear.c b/src/bin/lttng/commands/clear.c new file mode 100644 index 000000000..353c855c6 --- /dev/null +++ b/src/bin/lttng/commands/clear.c @@ -0,0 +1,333 @@ +/* + * Copyright (C) 2019 - Jonathan Rajotte-Julien + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License, version 2 only, + * as published by the Free Software Foundation. + * + * 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., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#define _LGPL_SOURCE +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "../command.h" + +#include +#include +#include + +static int opt_clear_all; + +#ifdef LTTNG_EMBED_HELP +static const char help_msg[] = +#include +; +#endif + +/* Mi writer */ +static struct mi_writer *writer; + +enum { + OPT_HELP = 1, + OPT_LIST_OPTIONS, +}; + +static struct poptOption long_options[] = { + /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ + {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0}, + {"all", 'a', POPT_ARG_VAL, &opt_clear_all, 1, 0, 0}, + {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL}, + {0, 0, 0, 0, 0, 0, 0} +}; + +/* + * clear session + */ +static int clear_session(struct lttng_session *session) +{ + enum lttng_clear_handle_status status = + LTTNG_CLEAR_HANDLE_STATUS_OK; + struct lttng_clear_handle *handle = NULL; + enum lttng_error_code ret_code; + bool printed_wait_msg = false; + char *session_name = NULL; + int ret; + + ret = lttng_clear_session(session->name, &handle); + if (ret < 0) { + ERR("%s", lttng_strerror(ret)); + goto error; + } + + do { + status = lttng_clear_handle_wait_for_completion(handle, + DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US / USEC_PER_MSEC); + switch (status) { + case LTTNG_CLEAR_HANDLE_STATUS_TIMEOUT: + if (!printed_wait_msg) { + _MSG("Waiting for clear of session \"%s\"", + session->name); + printed_wait_msg = true; + } + _MSG("."); + fflush(stdout); + break; + case LTTNG_CLEAR_HANDLE_STATUS_COMPLETED: + break; + default: + ERR("Failed to wait for the completion of clear for session \"%s\"", + session->name); + ret = -1; + goto error; + } + } while (status == LTTNG_CLEAR_HANDLE_STATUS_TIMEOUT); + + status = lttng_clear_handle_get_result(handle, &ret_code); + if (status != LTTNG_CLEAR_HANDLE_STATUS_OK) { + ERR("Failed to get the result of session clear"); + ret = -1; + goto error; + } + if (ret_code != LTTNG_OK) { + ret = -ret_code; + goto error; + } + + MSG("%sSession \"%s\" cleared", printed_wait_msg ? "\n" : "", + session->name); + printed_wait_msg = false; + + if (lttng_opt_mi) { + ret = mi_lttng_session(writer, session, 0); + if (ret) { + ret = CMD_ERROR; + goto error; + } + } + + ret = CMD_SUCCESS; +error: + if (printed_wait_msg) { + MSG(""); + } + lttng_clear_handle_destroy(handle); + free(session_name); + return ret; +} + +/* + * clear all sessions + * + * Call clear_session for each registered sessions + */ +static int clear_all_sessions(struct lttng_session *sessions, int count) +{ + int i, ret = CMD_SUCCESS; + + if (count == 0) { + MSG("No session found, nothing to do."); + } else if (count < 0) { + ERR("%s", lttng_strerror(ret)); + goto error; + } + + for (i = 0; i < count; i++) { + ret = clear_session(&sessions[i]); + if (ret < 0) { + goto error; + } + } +error: + return ret; +} + +/* + * The 'clear ' first level command + */ +int cmd_clear(int argc, const char **argv) +{ + int opt; + int ret = CMD_SUCCESS , i, command_ret = CMD_SUCCESS, success = 1; + static poptContext pc; + char *session_name = NULL; + const char *leftover = NULL; + + struct lttng_session *sessions = NULL; + int count; + int found; + + pc = poptGetContext(NULL, argc, argv, long_options, 0); + poptReadDefaultConfig(pc, 0); + + while ((opt = poptGetNextOpt(pc)) != -1) { + switch (opt) { + case OPT_HELP: + SHOW_HELP(); + break; + case OPT_LIST_OPTIONS: + list_cmd_options(stdout, long_options); + break; + default: + ret = CMD_UNDEFINED; + break; + } + goto end; + } + + /* Mi preparation */ + 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_clear); + 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; + } + + /* For validation and semantic purpose we open a sessions element */ + ret = mi_lttng_sessions_open(writer); + if (ret) { + ret = CMD_ERROR; + goto end; + } + } + + if (!opt_clear_all) { + /* + * popt expects us to free this even if it returns a const char *. + * See https://www.mail-archive.com/popt-devel@rpm5.org/msg00193.html + * Force cast to char * allowing later freeing if necessary. + */ + session_name = (char *) poptGetArg(pc); + + if (!session_name) { + /* No session name specified, lookup default */ + session_name = get_session_name(); + if (session_name == NULL) { + command_ret = CMD_ERROR; + success = 0; + goto mi_closing; + } + } + } else { + session_name = NULL; + } + + leftover = poptGetArg(pc); + if (leftover) { + ERR("Unknown argument: %s", leftover); + ret = CMD_ERROR; + success = 0; + goto mi_closing; + } + + /* Recuperate all sessions for further operation */ + count = lttng_list_sessions(&sessions); + if (count < 0) { + ERR("%s", lttng_strerror(count)); + command_ret = CMD_ERROR; + success = 0; + goto mi_closing; + } + + /* Ignore session name in case all sessions are to be cleaned */ + if (opt_clear_all) { + command_ret = clear_all_sessions(sessions, count); + if (command_ret) { + ERR("%s", lttng_strerror(command_ret)); + success = 0; + } + } else { + /* Find the corresponding lttng_session struct */ + found = 0; + for (i = 0; i < count; i++) { + if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) { + found = 1; + command_ret = clear_session(&sessions[i]); + if (command_ret) { + ERR("%s", lttng_strerror(command_ret)); + success = 0; + } + } + } + + if (!found) { + ERR("Session name %s not found", session_name); + command_ret = LTTNG_ERR_SESS_NOT_FOUND; + success = 0; + goto mi_closing; + } + } + +mi_closing: + /* Mi closing */ + if (lttng_opt_mi) { + /* Close sessions and output element element */ + ret = mi_lttng_close_multi_element(writer, 2); + if (ret) { + ret = CMD_ERROR; + goto end; + } + + /* Success ? */ + 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: + /* Mi clean-up */ + if (writer && mi_lttng_writer_destroy(writer)) { + /* Preserve original error code */ + ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL; + } + + free(sessions); + free(session_name); + + /* Overwrite ret if an error occurred during clear_session/all */ + ret = command_ret ? command_ret : ret; + + poptFreeContext(pc); + return ret; +} diff --git a/src/bin/lttng/lttng.c b/src/bin/lttng/lttng.c index 17ab16dc6..36a4fbed9 100644 --- a/src/bin/lttng/lttng.c +++ b/src/bin/lttng/lttng.c @@ -76,6 +76,7 @@ static struct option long_options[] = { static struct cmd_struct commands[] = { { "add-context", cmd_add_context}, { "create", cmd_create}, + { "clear", cmd_clear}, { "destroy", cmd_destroy}, { "disable-channel", cmd_disable_channels}, { "disable-event", cmd_disable_events}, @@ -280,6 +281,7 @@ static void show_basic_help(void) puts(""); puts("Tracing sessions:"); puts(" create " CONFIG_CMD_DESCR_CREATE); + puts(" clear " CONFIG_CMD_DESCR_CLEAR); puts(" destroy " CONFIG_CMD_DESCR_DESTROY); puts(" load " CONFIG_CMD_DESCR_LOAD); puts(" regenerate " CONFIG_CMD_DESCR_REGENERATE); diff --git a/src/common/mi-lttng-3.0.xsd b/src/common/mi-lttng-3.0.xsd index b15491a6e..1dee284de 100644 --- a/src/common/mi-lttng-3.0.xsd +++ b/src/common/mi-lttng-3.0.xsd @@ -722,6 +722,7 @@ THE SOFTWARE. + diff --git a/src/common/mi-lttng.c b/src/common/mi-lttng.c index c4bda37bb..d95d38ffb 100644 --- a/src/common/mi-lttng.c +++ b/src/common/mi-lttng.c @@ -77,6 +77,7 @@ const char * const mi_lttng_element_command_version = "version"; LTTNG_HIDDEN const char * const mi_lttng_element_command_rotate = "rotate"; LTTNG_HIDDEN const char * const mi_lttng_element_command_enable_rotation = "enable-rotation"; LTTNG_HIDDEN const char * const mi_lttng_element_command_disable_rotation = "disable-rotation"; +LTTNG_HIDDEN const char * const mi_lttng_element_command_clear = "clear"; /* Strings related to version command */ const char * const mi_lttng_element_version = "version"; diff --git a/src/common/mi-lttng.h b/src/common/mi-lttng.h index 0540a5ba9..7f7e8b9f8 100644 --- a/src/common/mi-lttng.h +++ b/src/common/mi-lttng.h @@ -83,6 +83,7 @@ extern const char * const mi_lttng_element_command_version; extern const char * const mi_lttng_element_command_rotate; extern const char * const mi_lttng_element_command_enable_rotation; extern const char * const mi_lttng_element_command_disable_rotation; +extern const char * const mi_lttng_element_command_clear; /* Strings related to version command */ extern const char * const mi_lttng_element_version;