Fix: Mismatch of field name between ust and tools
[lttng-tools.git] / src / bin / lttng / commands / list.c
index 4b8a07c48fc6aa29dc316711f8cf0774c6fbe334..0467cc6ba32d6afc828bcaeec34e31c0b58ed416 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
@@ -30,6 +29,7 @@ static int opt_userspace;
 static int opt_kernel;
 static char *opt_channel;
 static int opt_domain;
+static int opt_fields;
 #if 0
 /* Not implemented yet */
 static char *opt_cmd_name;
@@ -61,6 +61,7 @@ static struct poptOption long_options[] = {
 #endif
        {"channel",   'c', POPT_ARG_STRING, &opt_channel, 0, 0, 0},
        {"domain",    'd', POPT_ARG_VAL, &opt_domain, 1, 0, 0},
+       {"fields",    'f', POPT_ARG_VAL, &opt_fields, 1, 0, 0},
        {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
        {0, 0, 0, 0, 0, 0, 0}
 };
@@ -70,22 +71,23 @@ static struct poptOption long_options[] = {
  */
 static void usage(FILE *ofp)
 {
-       fprintf(ofp, "usage: lttng list [SESSION [<OPTIONS>]]\n");
+       fprintf(ofp, "usage: lttng list [OPTIONS] [SESSION [<OPTIONS>]]\n");
        fprintf(ofp, "\n");
        fprintf(ofp, "With no arguments, list available tracing session(s)\n");
        fprintf(ofp, "\n");
-       fprintf(ofp, "With -k alone, list available kernel events\n");
-       fprintf(ofp, "With -u alone, list available userspace events\n");
+       fprintf(ofp, "Without a session, -k lists available kernel events\n");
+       fprintf(ofp, "Without a session, -u lists available userspace events\n");
        fprintf(ofp, "\n");
        fprintf(ofp, "  -h, --help              Show this help\n");
-       fprintf(ofp, "      --list-options       Simple listing of options\n");
+       fprintf(ofp, "      --list-options      Simple listing of options\n");
        fprintf(ofp, "  -k, --kernel            Select kernel domain\n");
        fprintf(ofp, "  -u, --userspace         Select user-space domain.\n");
+       fprintf(ofp, "  -f, --fields            List event fields.\n");
 #if 0
        fprintf(ofp, "  -p, --pid PID           List user-space events by PID\n");
 #endif
        fprintf(ofp, "\n");
-       fprintf(ofp, "Options:\n");
+       fprintf(ofp, "Session Options:\n");
        fprintf(ofp, "  -c, --channel NAME      List details of a channel\n");
        fprintf(ofp, "  -d, --domain            List available domain(s)\n");
        fprintf(ofp, "\n");
@@ -145,22 +147,51 @@ const char *enabled_string(int value)
 }
 
 static
-const char *loglevel_string_pre(const char *loglevel)
+const char *filter_string(int value)
 {
-       if (loglevel[0] == '\0') {
-               return "";
-       } else {
-               return " (loglevel: ";
+       switch (value) {
+       case 1: return " [with filter]";
+       default: return "";
        }
 }
 
-static
-const char *loglevel_string_post(const char *loglevel)
+static const char *loglevel_string(int value)
 {
-       if (loglevel[0] == '\0') {
+       switch (value) {
+       case -1:
                return "";
-       } else {
-               return ")";
+       case LTTNG_LOGLEVEL_EMERG:
+               return "TRACE_EMERG";
+       case LTTNG_LOGLEVEL_ALERT:
+               return "TRACE_ALERT";
+       case LTTNG_LOGLEVEL_CRIT:
+               return "TRACE_CRIT";
+       case LTTNG_LOGLEVEL_ERR:
+               return "TRACE_ERR";
+       case LTTNG_LOGLEVEL_WARNING:
+               return "TRACE_WARNING";
+       case LTTNG_LOGLEVEL_NOTICE:
+               return "TRACE_NOTICE";
+       case LTTNG_LOGLEVEL_INFO:
+               return "TRACE_INFO";
+       case LTTNG_LOGLEVEL_DEBUG_SYSTEM:
+               return "TRACE_DEBUG_SYSTEM";
+       case LTTNG_LOGLEVEL_DEBUG_PROGRAM:
+               return "TRACE_DEBUG_PROGRAM";
+       case LTTNG_LOGLEVEL_DEBUG_PROCESS:
+               return "TRACE_DEBUG_PROCESS";
+       case LTTNG_LOGLEVEL_DEBUG_MODULE:
+               return "TRACE_DEBUG_MODULE";
+       case LTTNG_LOGLEVEL_DEBUG_UNIT:
+               return "TRACE_DEBUG_UNIT";
+       case LTTNG_LOGLEVEL_DEBUG_FUNCTION:
+               return "TRACE_DEBUG_FUNCTION";
+       case LTTNG_LOGLEVEL_DEBUG_LINE:
+               return "TRACE_DEBUG_LINE";
+       case LTTNG_LOGLEVEL_DEBUG:
+               return "TRACE_DEBUG";
+       default:
+               return "<<UNKNOWN>>";
        }
 }
 
@@ -172,29 +203,27 @@ static void print_events(struct lttng_event *event)
        switch (event->type) {
        case LTTNG_EVENT_TRACEPOINT:
        {
-               char ll_value[LTTNG_SYMBOL_NAME_LEN] = "";
-
-               if (event->loglevel[0] != '\0') {
-                       int ret;
-
-                       ret = snprintf(ll_value, LTTNG_SYMBOL_NAME_LEN,
-                               " (%lld)", (long long) event->loglevel_value);
-                       if (ret < 0) {
-                               ERR("snprintf error");
-                       }
-               }
-               MSG("%s%s%s%s%s%s (type: tracepoint)%s", indent6,
+               if (event->loglevel != -1) {
+                       MSG("%s%s (loglevel: %s (%d)) (type: tracepoint)%s%s",
+                               indent6,
                                event->name,
-                               loglevel_string_pre(event->loglevel),
+                               loglevel_string(event->loglevel),
                                event->loglevel,
-                               ll_value,
-                               loglevel_string_post(event->loglevel),
-                               enabled_string(event->enabled));
+                               enabled_string(event->enabled),
+                               filter_string(event->filter));
+               } else {
+                       MSG("%s%s (type: tracepoint)%s%s",
+                               indent6,
+                               event->name,
+                               enabled_string(event->enabled),
+                               filter_string(event->filter));
+               }
                break;
        }
        case LTTNG_EVENT_PROBE:
-               MSG("%s%s (type: probe)%s", indent6,
-                               event->name, enabled_string(event->enabled));
+               MSG("%s%s (type: probe)%s%s", indent6,
+                               event->name, enabled_string(event->enabled),
+                               filter_string(event->filter));
                if (event->attr.probe.addr != 0) {
                        MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
                } else {
@@ -204,17 +233,20 @@ static void print_events(struct lttng_event *event)
                break;
        case LTTNG_EVENT_FUNCTION:
        case LTTNG_EVENT_FUNCTION_ENTRY:
-               MSG("%s%s (type: function)%s", indent6,
-                               event->name, enabled_string(event->enabled));
+               MSG("%s%s (type: function)%s%s", indent6,
+                               event->name, enabled_string(event->enabled),
+                               filter_string(event->filter));
                MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
                break;
        case LTTNG_EVENT_SYSCALL:
-               MSG("%s (type: syscall)%s", indent6,
-                               enabled_string(event->enabled));
+               MSG("%ssyscalls (type: syscall)%s%s", indent6,
+                               enabled_string(event->enabled),
+                               filter_string(event->filter));
                break;
        case LTTNG_EVENT_NOOP:
-               MSG("%s (type: noop)%s", indent6,
-                               enabled_string(event->enabled));
+               MSG("%s (type: noop)%s%s", indent6,
+                               enabled_string(event->enabled),
+                               filter_string(event->filter));
                break;
        case LTTNG_EVENT_ALL:
                /* We should never have "all" events in list. */
@@ -223,6 +255,35 @@ static void print_events(struct lttng_event *event)
        }
 }
 
+static const char *field_type(struct lttng_event_field *field)
+{
+       switch(field->type) {
+       case LTTNG_EVENT_FIELD_INTEGER:
+               return "integer";
+       case LTTNG_EVENT_FIELD_ENUM:
+               return "enum";
+       case LTTNG_EVENT_FIELD_FLOAT:
+               return "float";
+       case LTTNG_EVENT_FIELD_STRING:
+               return "string";
+       case LTTNG_EVENT_FIELD_OTHER:
+       default:        /* fall-through */
+               return "unknown";
+       }
+}
+
+/*
+ * Pretty print single event fields.
+ */
+static void print_event_field(struct lttng_event_field *field)
+{
+       if (!field->field_name[0]) {
+               return;
+       }
+       MSG("%sfield: %s (%s)%s", indent8, field->field_name,
+               field_type(field), field->nowrite ? "" : " [no write]");
+}
+
 /*
  * Ask session daemon for all user space tracepoints available.
  */
@@ -234,6 +295,8 @@ static int list_ust_events(void)
        struct lttng_event *event_list;
        pid_t cur_pid = 0;
 
+       memset(&domain, 0, sizeof(domain));
+
        DBG("Getting UST tracing events");
 
        domain.type = LTTNG_DOMAIN_UST;
@@ -246,6 +309,7 @@ static int list_ust_events(void)
        size = lttng_list_tracepoints(handle, &event_list);
        if (size < 0) {
                ERR("Unable to list UST events");
+               lttng_destroy_handle(handle);
                return size;
        }
 
@@ -266,10 +330,74 @@ static int list_ust_events(void)
        MSG("");
 
        free(event_list);
+       lttng_destroy_handle(handle);
 
        return CMD_SUCCESS;
 
 error:
+       lttng_destroy_handle(handle);
+       return -1;
+}
+
+/*
+ * Ask session daemon for all user space tracepoint fields available.
+ */
+static int list_ust_event_fields(void)
+{
+       int i, size;
+       struct lttng_domain domain;
+       struct lttng_handle *handle;
+       struct lttng_event_field *event_field_list;
+       pid_t cur_pid = 0;
+       struct lttng_event cur_event;
+
+       memset(&domain, 0, sizeof(domain));
+       memset(&cur_event, 0, sizeof(cur_event));
+
+       DBG("Getting UST tracing event fields");
+
+       domain.type = LTTNG_DOMAIN_UST;
+
+       handle = lttng_create_handle(NULL, &domain);
+       if (handle == NULL) {
+               goto error;
+       }
+
+       size = lttng_list_tracepoint_fields(handle, &event_field_list);
+       if (size < 0) {
+               ERR("Unable to list UST event fields");
+               lttng_destroy_handle(handle);
+               return size;
+       }
+
+       MSG("UST events:\n-------------");
+
+       if (size == 0) {
+               MSG("None");
+       }
+
+       for (i = 0; i < size; i++) {
+               if (cur_pid != event_field_list[i].event.pid) {
+                       cur_pid = event_field_list[i].event.pid;
+                       MSG("\nPID: %d - Name: %s", cur_pid, get_cmdline_by_pid(cur_pid));
+               }
+               if (strcmp(cur_event.name, event_field_list[i].event.name) != 0) {
+                       print_events(&event_field_list[i].event);
+                       memcpy(&cur_event, &event_field_list[i].event,
+                               sizeof(cur_event));
+               }
+               print_event_field(&event_field_list[i]);
+       }
+
+       MSG("");
+
+       free(event_field_list);
+       lttng_destroy_handle(handle);
+
+       return CMD_SUCCESS;
+
+error:
+       lttng_destroy_handle(handle);
        return -1;
 }
 
@@ -283,6 +411,8 @@ static int list_kernel_events(void)
        struct lttng_handle *handle;
        struct lttng_event *event_list;
 
+       memset(&domain, 0, sizeof(domain));
+
        DBG("Getting kernel tracing events");
 
        domain.type = LTTNG_DOMAIN_KERNEL;
@@ -295,6 +425,7 @@ static int list_kernel_events(void)
        size = lttng_list_tracepoints(handle, &event_list);
        if (size < 0) {
                ERR("Unable to list kernel events");
+               lttng_destroy_handle(handle);
                return size;
        }
 
@@ -308,9 +439,11 @@ static int list_kernel_events(void)
 
        free(event_list);
 
+       lttng_destroy_handle(handle);
        return CMD_SUCCESS;
 
 error:
+       lttng_destroy_handle(handle);
        return -1;
 }
 
@@ -389,10 +522,10 @@ static int list_channels(const char *channel_name)
        count = lttng_list_channels(handle, &channels);
        if (count < 0) {
                ret = count;
-               goto error;
+               goto error_channels;
        } else if (count == 0) {
-               MSG("No channel found");
-               goto end;
+               ERR("Channel %s not found", channel_name);
+               goto error;
        }
 
        if (channel_name == NULL) {
@@ -421,14 +554,16 @@ static int list_channels(const char *channel_name)
        }
 
        if (!chan_found && channel_name != NULL) {
-               MSG("Channel %s not found", channel_name);
+               ERR("Channel %s not found", channel_name);
+               goto error;
        }
 
-end:
-       free(channels);
        ret = CMD_SUCCESS;
 
 error:
+       free(channels);
+
+error_channels:
        return ret;
 }
 
@@ -448,6 +583,9 @@ static int list_sessions(const char *session_name)
        if (count < 0) {
                ret = count;
                goto error;
+       } else if (count == 0) {
+               MSG("Currently no available tracing session");
+               goto end;
        }
 
        if (session_name == NULL) {
@@ -465,7 +603,8 @@ static int list_sessions(const char *session_name)
                        continue;
                }
 
-               MSG("  %d) %s (%s)%s", i + 1, sessions[i].name, sessions[i].path, active_string(sessions[i].enabled));
+               MSG("  %d) %s (%s)%s", i + 1, sessions[i].name, sessions[i].path,
+                               active_string(sessions[i].enabled));
 
                if (session_found) {
                        break;
@@ -475,13 +614,16 @@ static int list_sessions(const char *session_name)
        free(sessions);
 
        if (!session_found && session_name != NULL) {
-               MSG("Session %s not found", session_name);
+               ERR("Session '%s' not found", session_name);
+               ret = CMD_ERROR;
+               goto error;
        }
 
        if (session_name == NULL) {
                MSG("\nUse lttng list <session_name> for more details");
        }
 
+end:
        return CMD_SUCCESS;
 
 error:
@@ -539,8 +681,11 @@ int cmd_list(int argc, const char **argv)
        struct lttng_domain domain;
        struct lttng_domain *domains = NULL;
 
+       memset(&domain, 0, sizeof(domain));
+
        if (argc < 1) {
                usage(stderr);
+               ret = CMD_ERROR;
                goto end;
        }
 
@@ -550,14 +695,13 @@ int cmd_list(int argc, const char **argv)
        while ((opt = poptGetNextOpt(pc)) != -1) {
                switch (opt) {
                case OPT_HELP:
-                       usage(stderr);
+                       usage(stdout);
                        goto end;
                case OPT_USERSPACE:
                        opt_userspace = 1;
                        break;
                case OPT_LIST_OPTIONS:
                        list_cmd_options(stdout, long_options);
-                       ret = CMD_SUCCESS;
                        goto end;
                default:
                        usage(stderr);
@@ -577,15 +721,18 @@ int cmd_list(int argc, const char **argv)
                domain.type = LTTNG_DOMAIN_UST;
        }
 
-       handle = lttng_create_handle(session_name, &domain);
-       if (handle == NULL) {
-               goto end;
+       if (opt_kernel || opt_userspace) {
+               handle = lttng_create_handle(session_name, &domain);
+               if (handle == NULL) {
+                       ret = CMD_FATAL;
+                       goto end;
+               }
        }
 
        if (session_name == NULL) {
                if (!opt_kernel && !opt_userspace) {
                        ret = list_sessions(NULL);
-                       if (ret < 0) {
+                       if (ret != 0) {
                                goto end;
                        }
                }
@@ -596,7 +743,11 @@ int cmd_list(int argc, const char **argv)
                        }
                }
                if (opt_userspace) {
-                       ret = list_ust_events();
+                       if (opt_fields) {
+                               ret = list_ust_event_fields();
+                       } else {
+                               ret = list_ust_events();
+                       }
                        if (ret < 0) {
                                goto end;
                        }
@@ -604,7 +755,7 @@ int cmd_list(int argc, const char **argv)
        } else {
                /* List session attributes */
                ret = list_sessions(session_name);
-               if (ret < 0) {
+               if (ret != 0) {
                        goto end;
                }
 
@@ -642,10 +793,13 @@ int cmd_list(int argc, const char **argv)
                                }
 
                                /* Clean handle before creating a new one */
-                               lttng_destroy_handle(handle);
+                               if (handle) {
+                                       lttng_destroy_handle(handle);
+                               }
 
                                handle = lttng_create_handle(session_name, &domains[i]);
                                if (handle == NULL) {
+                                       ret = CMD_FATAL;
                                        goto end;
                                }
 
@@ -661,7 +815,10 @@ end:
        if (domains) {
                free(domains);
        }
-       lttng_destroy_handle(handle);
+       if (handle) {
+               lttng_destroy_handle(handle);
+       }
 
+       poptFreeContext(pc);
        return ret;
 }
This page took 0.029294 seconds and 4 git commands to generate.