Backported to glibc 2.8
[lttng-tools.git] / src / bin / lttng / commands / add_context.c
index 95fefa50c831486772eca28475a2612c0c10ed2d..6483c9891d83038e929b3a1b96fd3f5cd6ab07c4 100644 (file)
@@ -1,19 +1,18 @@
 /*
  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
  *
- * 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.
+ * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * 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 _GNU_SOURCE
@@ -32,7 +31,6 @@
 
 #define PRINT_LINE_LEN 80
 
-static char *opt_event_name;
 static char *opt_channel_name;
 static char *opt_session_name;
 static int opt_kernel;
@@ -48,6 +46,7 @@ enum {
        OPT_HELP = 1,
        OPT_TYPE,
        OPT_USERSPACE,
+       OPT_LIST_OPTIONS,
 };
 
 static struct lttng_handle *handle;
@@ -66,6 +65,9 @@ enum context_type {
        CONTEXT_VTID         = 7,
        CONTEXT_PPID         = 8,
        CONTEXT_VPPID        = 9,
+       CONTEXT_PTHREAD_ID   = 10,
+       CONTEXT_HOSTNAME     = 11,
+       CONTEXT_IP           = 12,
 };
 
 /*
@@ -139,16 +141,10 @@ static struct poptOption long_options[] = {
        {"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
        {"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
        {"channel",        'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
-       {"event",          'e', POPT_ARG_STRING, &opt_event_name, 0, 0, 0},
        {"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
-#if 0
-       /* Not implemented yet */
-       {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
-       {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
-#else
        {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
-#endif
        {"type",           't', POPT_ARG_STRING, &opt_type, OPT_TYPE, 0, 0},
+       {"list-options",   0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
        {0, 0, 0, 0, 0, 0, 0}
 };
 
@@ -203,9 +199,12 @@ const struct ctx_opts {
        { "nice", CONTEXT_NICE },
        { "vpid", CONTEXT_VPID },
        { "tid", CONTEXT_TID },
+       { "pthread_id", CONTEXT_PTHREAD_ID },
        { "vtid", CONTEXT_VTID },
        { "ppid", CONTEXT_PPID },
        { "vppid", CONTEXT_VPPID },
+       { "hostname", CONTEXT_HOSTNAME },
+       { "ip", CONTEXT_IP },
        /* Perf options */
        PERF_HW(cpu-cycles, CPU_CYCLES),
        PERF_HW(cycles, CPU_CYCLES),
@@ -299,34 +298,33 @@ static void print_ctx_type(FILE *ofp)
  */
 static void usage(FILE *ofp)
 {
-       fprintf(ofp, "usage: lttng add-context -t TYPE\n");
+       fprintf(ofp, "usage: lttng add-context -t TYPE [-k|-u] [OPTIONS]\n");
+       fprintf(ofp, "\n");
+       fprintf(ofp, "If no channel is given (-c), the context is added to\n");
+       fprintf(ofp, "all channels.\n");
        fprintf(ofp, "\n");
-       fprintf(ofp, "If no event name is given (-e), the context will be added to the channel\n");
-       fprintf(ofp, "If no channel and no event is given (-c/-e), the context\n");
-       fprintf(ofp, "will be added to all events and all channels.\n");
+       fprintf(ofp, "Otherwise the context is added only to the channel (-c).\n");
+       fprintf(ofp, "\n");
+       fprintf(ofp, "Exactly one domain (-k or -u) must be specified.\n");
        fprintf(ofp, "\n");
        fprintf(ofp, "Options:\n");
        fprintf(ofp, "  -h, --help               Show this help\n");
-       fprintf(ofp, "  -s, --session            Apply on session name\n");
-       fprintf(ofp, "  -c, --channel NAME       Apply on channel\n");
-       fprintf(ofp, "  -e, --event NAME         Apply on event\n");
-       fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
-#if 0
-       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");
-#else
-       fprintf(ofp, "  -u, --userspace          Apply for the user-space tracer\n");
-#endif
+       fprintf(ofp, "      --list-options       Simple listing of options\n");
+       fprintf(ofp, "  -s, --session NAME       Apply to session name\n");
+       fprintf(ofp, "  -c, --channel NAME       Apply to channel\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, "Context:\n");
        fprintf(ofp, "  -t, --type TYPE          Context type. You can repeat that option on\n");
-       fprintf(ofp, "                           the command line.\n");
+       fprintf(ofp, "                           the command line to specify multiple contexts at once.\n");
+       fprintf(ofp, "                           (--kernel preempts --userspace)\n");
        fprintf(ofp, "                           TYPE can be one of the strings below:\n");
        print_ctx_type(ofp);
        fprintf(ofp, "\n");
        fprintf(ofp, "Example:\n");
        fprintf(ofp, "This command will add the context information 'prio' and two perf\n"
-                       "counters: hardware branch misses and cache misses, to all events\n"
+                       "counters (hardware branch misses and cache misses), to all channels\n"
                        "in the trace data output:\n");
        fprintf(ofp, "# lttng add-context -k -t prio -t perf:branch-misses -t perf:cache-misses\n");
        fprintf(ofp, "\n");
@@ -356,35 +354,40 @@ end:
  */
 static int add_context(char *session_name)
 {
-       int ret = CMD_SUCCESS;
+       int ret = CMD_SUCCESS, warn = 0;
        struct lttng_event_context context;
        struct lttng_domain dom;
        struct ctx_type *type;
        char *ptr;
 
+       memset(&context, 0, sizeof(context));
+       memset(&dom, 0, sizeof(dom));
+
        if (opt_kernel) {
                dom.type = LTTNG_DOMAIN_KERNEL;
        } else if (opt_userspace) {
                dom.type = LTTNG_DOMAIN_UST;
        } else {
-               ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
-               ret = CMD_NOT_IMPLEMENTED;
+               print_missing_domain();
+               ret = CMD_ERROR;
                goto error;
        }
 
        handle = lttng_create_handle(session_name, &dom);
        if (handle == NULL) {
-               ret = -1;
+               ret = CMD_ERROR;
                goto error;
        }
 
-       /* Iterate over all context type given */
+       /* Iterate over all the context types given */
        cds_list_for_each_entry(type, &ctx_type_list.head, list) {
-               context.ctx = type->opt->ctx_type;
+               context.ctx = (enum lttng_event_context_type) type->opt->ctx_type;
                if (context.ctx == LTTNG_EVENT_CONTEXT_PERF_COUNTER) {
                        context.u.perf_counter.type = type->opt->u.perf.type;
                        context.u.perf_counter.config = type->opt->u.perf.config;
-                       strcpy(context.u.perf_counter.name, type->opt->symbol);
+                       strncpy(context.u.perf_counter.name, type->opt->symbol,
+                               LTTNG_SYMBOL_NAME_LEN);
+                       context.u.perf_counter.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
                        /* Replace : and - by _ */
                        while ((ptr = strchr(context.u.perf_counter.name, '-')) != NULL) {
                                *ptr = '_';
@@ -395,27 +398,40 @@ static int add_context(char *session_name)
                }
                DBG("Adding context...");
 
-               ret = lttng_add_context(handle, &context, opt_event_name,
-                               opt_channel_name);
+               ret = lttng_add_context(handle, &context, NULL, opt_channel_name);
                if (ret < 0) {
-                       fprintf(stderr, "%s: ", type->opt->symbol);
+                       ERR("%s: %s", type->opt->symbol, lttng_strerror(ret));
+                       warn = 1;
                        continue;
                } else {
-                       MSG("%s context %s added to %s event in %s",
-                                       opt_kernel ? "kernel" : "UST", type->opt->symbol,
-                                       opt_event_name ? opt_event_name : "all",
-                                       opt_channel_name ? opt_channel_name : "all channels");
+                       if (opt_channel_name) {
+                               MSG("%s context %s added to channel %s",
+                                               opt_kernel ? "kernel" : "UST", type->opt->symbol,
+                                               opt_channel_name);
+                       } else {
+                               MSG("%s context %s added to all channels",
+                                               opt_kernel ? "kernel" : "UST", type->opt->symbol)
+                       }
                }
        }
 
+       ret = CMD_SUCCESS;
+
 error:
        lttng_destroy_handle(handle);
 
+       /*
+        * This means that at least one add_context failed and tells the user to
+        * look on stderr for error(s).
+        */
+       if (warn) {
+               ret = CMD_WARNING;
+       }
        return ret;
 }
 
 /*
- * Add context on channel or event.
+ * Add context to channel or event.
  */
 int cmd_add_context(int argc, const char **argv)
 {
@@ -426,6 +442,7 @@ int cmd_add_context(int argc, const char **argv)
 
        if (argc < 2) {
                usage(stderr);
+               ret = CMD_ERROR;
                goto end;
        }
 
@@ -435,26 +452,35 @@ int cmd_add_context(int argc, const char **argv)
        while ((opt = poptGetNextOpt(pc)) != -1) {
                switch (opt) {
                case OPT_HELP:
-                       usage(stderr);
-                       ret = CMD_SUCCESS;
+                       usage(stdout);
                        goto end;
                case OPT_TYPE:
-                       type = malloc(sizeof(struct ctx_type));
-                       if (type == NULL) {
-                               perror("malloc ctx_type");
-                               ret = -1;
-                               goto end;
-                       }
+                       /*
+                        * Look up the index of opt_type in ctx_opts[] first, so we don't
+                        * have to free(type) on failure.
+                        */
                        index = find_ctx_type_idx(opt_type);
                        if (index < 0) {
                                ERR("Unknown context type %s", opt_type);
+                               ret = CMD_ERROR;
                                goto end;
                        }
+
+                       type = malloc(sizeof(struct ctx_type));
+                       if (type == NULL) {
+                               perror("malloc ctx_type");
+                               ret = CMD_FATAL;
+                               goto end;
+                       }
+
                        type->opt = &ctx_opts[index];
-                       if (type->opt->ctx_type == -1) {
+                       if (type->opt->symbol == NULL) {
                                ERR("Unknown context type %s", opt_type);
+                               free(type);
+                               ret = CMD_ERROR;
+                               goto end;
                        } else {
-                               cds_list_add(&type->list, &ctx_type_list.head);
+                               cds_list_add_tail(&type->list, &ctx_type_list.head);
                        }
                        break;
                case OPT_USERSPACE:
@@ -463,6 +489,9 @@ int cmd_add_context(int argc, const char **argv)
                        opt_cmd_name = poptGetOptArg(pc);
 #endif
                        break;
+               case OPT_LIST_OPTIONS:
+                       list_cmd_options(stdout, long_options);
+                       goto end;
                default:
                        usage(stderr);
                        ret = CMD_UNDEFINED;
@@ -470,10 +499,17 @@ int cmd_add_context(int argc, const char **argv)
                }
        }
 
+       if (!opt_type) {
+               ERR("Missing mandatory -t TYPE");
+               usage(stderr);
+               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 {
@@ -482,11 +518,16 @@ int cmd_add_context(int argc, const char **argv)
 
        ret = add_context(session_name);
 
+       if (!opt_session_name) {
+               free(session_name);
+       }
+
+end:
        /* Cleanup allocated memory */
        cds_list_for_each_entry_safe(type, tmptype, &ctx_type_list.head, list) {
                free(type);
        }
 
-end:
+       poptFreeContext(pc);
        return ret;
 }
This page took 0.028106 seconds and 4 git commands to generate.