CLI: Implement lttng clear session command
authorJonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Mon, 11 Feb 2019 16:26:05 +0000 (11:26 -0500)
committerJonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Wed, 10 Apr 2019 20:20:10 +0000 (16:20 -0400)
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
configure.ac
src/bin/lttng/Makefile.am
src/bin/lttng/command.h
src/bin/lttng/commands/clear.c [new file with mode: 0644]
src/bin/lttng/lttng.c
src/common/mi-lttng-3.0.xsd
src/common/mi-lttng.c
src/common/mi-lttng.h

index ac72a885ba15f03335c5a24814728b92b979e782..2aa86de7ac759284d1ddb54e3b05abf9798b1bcf 100644 (file)
@@ -378,6 +378,7 @@ _AC_DEFINE_QUOTED_AND_SUBST([DEFAULT_NETWORK_VIEWER_BIND_ADDRESS], [localhost])
 # 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])
index 1a6977eb5fb38e4b6aebd40ba60f4575e79d7935..b13e11816de369ca071b8c6bafd25be6096e2cc6 100644 (file)
@@ -23,6 +23,7 @@ lttng_SOURCES = command.h conf.c conf.h commands/start.c \
                                commands/metadata.c \
                                commands/regenerate.c \
                                commands/help.c \
+                               commands/clear.c \
                                utils.c utils.h lttng.c
 
 lttng_LDADD = $(top_builddir)/src/lib/lttng-ctl/liblttng-ctl.la \
index bda6ef937d3b4c4ce0498fce49b771e52ddec45c..8838932f5889fc08bd3e09b8a28286e8c1432957 100644 (file)
@@ -83,6 +83,7 @@ DECL_COMMAND(track);
 DECL_COMMAND(untrack);
 DECL_COMMAND(metadata);
 DECL_COMMAND(regenerate);
+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 (file)
index 0000000..a0a44ba
--- /dev/null
@@ -0,0 +1,285 @@
+/*
+ * Copyright (C) 2019 - Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
+ *
+ * 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 <popt.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <unistd.h>
+#include <stdbool.h>
+
+#include "../command.h"
+
+#include <common/mi-lttng.h>
+#include <common/sessiond-comm/sessiond-comm.h>
+#include <common/utils.h>
+
+static char *opt_session_name;
+static int opt_clear_all;
+
+#ifdef LTTNG_EMBED_HELP
+static const char help_msg[] =
+#include <lttng-clear.1.h>
+;
+#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)
+{
+       int ret;
+       char *session_name = NULL;
+
+       ret = lttng_clear_session(session->name);
+       if (ret < 0) {
+               ERR("%s", lttng_strerror(ret));
+               goto error;
+       }
+
+       MSG("Session %s cleared", session->name);
+
+       if (lttng_opt_mi) {
+               ret = mi_lttng_session(writer, session, 0);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+       }
+
+       ret = CMD_SUCCESS;
+error:
+       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 <options>' 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;
+       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) {
+               opt_session_name = (char *) poptGetArg(pc);
+
+               if (!opt_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 = opt_session_name;
+               }
+       } 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) {
+                       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) {
+                                       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;
+       }
+
+       if (opt_session_name == NULL) {
+               free(session_name);
+       }
+
+       /* Overwrite ret if an error occurred during clear_session/all */
+       ret = command_ret ? command_ret : ret;
+
+       poptFreeContext(pc);
+       return ret;
+}
index bf2128ca35896dbbc998ecadf125e7eb4774ed6d..ce03bb21d49aa0d2065f81c8f3cd6745b6b7b85b 100644 (file)
@@ -75,6 +75,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},
@@ -258,6 +259,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);
index ae00ee80eec146d6a3891d425aa7050165998994..645199e81a361228248412b910b227e7f84d6e56 100644 (file)
@@ -606,6 +606,7 @@ THE SOFTWARE.
                        <xs:enumeration value="untrack" />
                        <xs:enumeration value="metadata" />
                        <xs:enumeration value="regenerate" />
+                       <xs:enumeration value="clear" />
                </xs:restriction>
        </xs:simpleType>
 
index f0244d9fdd46d012dee437f335b495a6a8b188cf..1b34a034ca22ab0e9dbe1c833c3623b9dd090652 100644 (file)
@@ -74,6 +74,7 @@ const char * const mi_lttng_element_command_success = "success";
 const char * const mi_lttng_element_command_track = "track";
 const char * const mi_lttng_element_command_untrack = "untrack";
 const char * const mi_lttng_element_command_version = "version";
+const char * const mi_lttng_element_command_clear = "clear";
 
 /* Strings related to version command */
 const char * const mi_lttng_element_version = "version";
index e7cf8af92ff37b840e01ebbcddbfc60c484510ac..c6f13eb62db23418973218ee0a1f1d953b7dc330 100644 (file)
@@ -80,6 +80,7 @@ extern const char * const mi_lttng_element_command_success;
 extern const char * const mi_lttng_element_command_track;
 extern const char * const mi_lttng_element_command_untrack;
 extern const char * const mi_lttng_element_command_version;
+extern const char * const mi_lttng_element_command_clear;
 
 /* Strings related to version command */
 extern const char * const mi_lttng_element_version;
This page took 0.031785 seconds and 5 git commands to generate.