Fix: userspace probe accessors are not const-correct
[lttng-tools.git] / src / bin / lttng / commands / list.c
index a26ec064197c123356c24c0be07db2f9cc6f6d54..eabeb8132ecd36c6e15fb996cb8bdba96b61249d 100644 (file)
@@ -15,7 +15,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#define _GNU_SOURCE
+#define _LGPL_SOURCE
 #include <inttypes.h>
 #include <popt.h>
 #include <stdio.h>
@@ -24,6 +24,7 @@
 #include <assert.h>
 
 #include <common/mi-lttng.h>
+#include <lttng/constant.h>
 
 #include "../command.h"
 
@@ -31,20 +32,22 @@ static int opt_userspace;
 static int opt_kernel;
 static int opt_jul;
 static int opt_log4j;
+static int opt_python;
 static char *opt_channel;
 static int opt_domain;
 static int opt_fields;
 static int opt_syscall;
-#if 0
-/* Not implemented yet */
-static char *opt_cmd_name;
-static pid_t opt_pid;
-#endif
 
 const char *indent4 = "    ";
 const char *indent6 = "      ";
 const char *indent8 = "        ";
 
+#ifdef LTTNG_EMBED_HELP
+static const char help_msg[] =
+#include <lttng-list.1.h>
+;
+#endif
+
 enum {
        OPT_HELP = 1,
        OPT_USERSPACE,
@@ -54,57 +57,25 @@ enum {
 static struct lttng_handle *handle;
 static struct mi_writer *writer;
 
+/* Only set when listing a single session. */
+static struct lttng_session listed_session;
+
 static struct poptOption long_options[] = {
        /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
-       {"help",      'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
-       {"kernel",    'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
-       {"jul",       'j', POPT_ARG_VAL, &opt_jul, 1, 0, 0},
-       {"log4j",     'l', POPT_ARG_VAL, &opt_log4j, 1, 0, 0},
-#if 0
-       /* Not implemented yet */
-       {"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},
-#else
-       {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
-#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},
-       {"syscall",   'S', POPT_ARG_VAL, &opt_syscall, 1, 0, 0},
+       {"help",        'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
+       {"kernel",      'k', POPT_ARG_VAL, &opt_kernel, 1, 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},
+       {"userspace",   'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
+       {"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},
+       {"syscall",     'S', POPT_ARG_VAL, &opt_syscall, 1, 0, 0},
        {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
        {0, 0, 0, 0, 0, 0, 0}
 };
 
-/*
- * usage
- */
-static void usage(FILE *ofp)
-{
-       fprintf(ofp, "usage: lttng list [OPTIONS] [SESSION [SESSION OPTIONS]]\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "With no arguments, list available tracing session(s)\n");
-       fprintf(ofp, "\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, "  -k, --kernel            Select kernel domain\n");
-       fprintf(ofp, "  -u, --userspace         Select user-space domain.\n");
-       fprintf(ofp, "  -j, --jul               Apply for Java application using JUL\n");
-       fprintf(ofp, "  -l, --log4j             Apply for Java application using LOG4J\n");
-       fprintf(ofp, "  -f, --fields            List event fields.\n");
-       fprintf(ofp, "      --syscall           List available system calls.\n");
-#if 0
-       fprintf(ofp, "  -p, --pid PID           List user-space events by PID\n");
-#endif
-       fprintf(ofp, "\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");
-}
-
 /*
  * Get command line from /proc for a specific pid.
  *
@@ -116,7 +87,8 @@ static char *get_cmdline_by_pid(pid_t pid)
        int ret;
        FILE *fp = NULL;
        char *cmdline = NULL;
-       char path[20];  /* Can't go bigger than /proc/65535/cmdline */
+       /* Can't go bigger than /proc/LTTNG_MAX_PID/cmdline */
+       char path[sizeof("/proc//cmdline") + sizeof(LTTNG_MAX_PID_STR) - 1];
 
        snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
        fp = fopen(path, "r");
@@ -125,14 +97,14 @@ static char *get_cmdline_by_pid(pid_t pid)
        }
 
        /* Caller must free() *cmdline */
-       cmdline = malloc(PATH_MAX);
+       cmdline = zmalloc(PATH_MAX);
        if (!cmdline) {
-               perror("malloc cmdline");
+               PERROR("malloc cmdline");
                goto end;
        }
        ret = fread(cmdline, 1, PATH_MAX, fp);
        if (ret < 0) {
-               perror("fread proc list");
+               PERROR("fread proc list");
        }
 
 end:
@@ -175,21 +147,9 @@ const char *enabled_string(int value)
 }
 
 static
-const char *filter_string(int value)
+const char *safe_string(const char *str)
 {
-       switch (value) {
-       case 1: return " [with filter]";
-       default: return "";
-       }
-}
-
-static
-const char *exclusion_string(int value)
-{
-       switch (value) {
-       case 1: return " [has exclusions]";
-       default: return "";
-       }
+       return str ? str : "";
 }
 
 static const char *logleveltype_string(enum lttng_loglevel_type value)
@@ -221,11 +181,180 @@ static const char *bitness_event(enum lttng_event_flag flags)
        }
 }
 
+/*
+ * Get exclusion names message for a single event.
+ *
+ * Returned pointer must be freed by caller. Returns NULL on error.
+ */
+static char *get_exclusion_names_msg(struct lttng_event *event)
+{
+       int ret;
+       int exclusion_count;
+       char *exclusion_msg = NULL;
+       char *at;
+       size_t i;
+       const char * const exclusion_fmt = " [exclusions: ";
+       const size_t exclusion_fmt_len = strlen(exclusion_fmt);
+
+       exclusion_count = lttng_event_get_exclusion_name_count(event);
+       if (exclusion_count < 0) {
+               goto end;
+       } else if (exclusion_count == 0) {
+               /*
+                * No exclusions: return copy of empty string so that
+                * it can be freed by caller.
+                */
+               exclusion_msg = strdup("");
+               goto end;
+       }
+
+       /*
+        * exclusion_msg's size is bounded by the exclusion_fmt string,
+        * a comma per entry, the entry count (fixed-size), a closing
+        * bracket, and a trailing \0.
+        */
+       exclusion_msg = malloc(exclusion_count +
+                       exclusion_count * LTTNG_SYMBOL_NAME_LEN +
+                       exclusion_fmt_len + 1);
+       if (!exclusion_msg) {
+               goto end;
+       }
+
+       at = strcpy(exclusion_msg, exclusion_fmt) + exclusion_fmt_len;
+       for (i = 0; i < exclusion_count; ++i) {
+               const char *name;
+
+               /* Append comma between exclusion names */
+               if (i > 0) {
+                       *at = ',';
+                       at++;
+               }
+
+               ret = lttng_event_get_exclusion_name(event, i, &name);
+               if (ret) {
+                       /* Prints '?' on local error; should never happen */
+                       *at = '?';
+                       at++;
+                       continue;
+               }
+
+               /* Append exclusion name */
+               at += sprintf(at, "%s", name);
+       }
+
+       /* This also puts a final '\0' at the end of exclusion_msg */
+       strcpy(at, "]");
+
+end:
+       return exclusion_msg;
+}
+
+static void print_userspace_probe_location(struct lttng_event *event)
+{
+       const struct lttng_userspace_probe_location *location;
+       const struct lttng_userspace_probe_location_lookup_method *lookup_method;
+       enum lttng_userspace_probe_location_lookup_method_type lookup_type;
+
+       location = lttng_event_get_userspace_probe_location(event);
+       if (!location) {
+               MSG("Event has no userspace probe location");
+               return;
+       }
+
+       lookup_method = lttng_userspace_probe_location_get_lookup_method(location);
+       if (!lookup_method) {
+               MSG("Event has no userspace probe location lookup method");
+               return;
+       }
+
+       MSG("%s%s (type: userspace-probe)%s", indent6, event->name, enabled_string(event->enabled));
+
+       lookup_type = lttng_userspace_probe_location_lookup_method_get_type(lookup_method);
+
+       switch (lttng_userspace_probe_location_get_type(location)) {
+       case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_UNKNOWN:
+               MSG("%sType: Unknown", indent8);
+               break;
+       case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION:
+       {
+               const char *function_name;
+               const char *binary_path;
+
+               MSG("%sType: Function", indent8);
+               function_name = lttng_userspace_probe_location_function_get_function_name(location);
+               binary_path = realpath(lttng_userspace_probe_location_function_get_binary_path(location), NULL);
+
+               MSG("%sBinary path:   %s", indent8, binary_path ? binary_path : "NULL");
+               MSG("%sFunction:      %s()", indent8, function_name ? function_name : "NULL");
+               switch (lookup_type) {
+               case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF:
+                       MSG("%sLookup method: ELF", indent8);
+                       break;
+               case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_DEFAULT:
+                       MSG("%sLookup method: default", indent8);
+                       break;
+               default:
+                       MSG("%sLookup method: INVALID LOOKUP TYPE ENCOUNTERED", indent8);
+                       break;
+               }
+               break;
+       }
+       case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT:
+       {
+               const char *probe_name, *provider_name;
+               const char *binary_path;
+
+               MSG("%sType: Tracepoint", indent8);
+               probe_name = lttng_userspace_probe_location_tracepoint_get_probe_name(location);
+               provider_name = lttng_userspace_probe_location_tracepoint_get_provider_name(location);
+               binary_path = realpath(lttng_userspace_probe_location_tracepoint_get_binary_path(location), NULL);
+               MSG("%sBinary path:   %s", indent8, binary_path ? binary_path : "NULL");
+               MSG("%sTracepoint:    %s:%s", indent8, provider_name ? provider_name : "NULL", probe_name ? probe_name : "NULL");
+               switch (lookup_type) {
+               case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_TRACEPOINT_SDT:
+                       MSG("%sLookup method: SDT", indent8);
+                       break;
+               default:
+                       MSG("%sLookup method: INVALID LOOKUP TYPE ENCOUNTERED", indent8);
+                       break;
+               }
+               break;
+       }
+       default:
+               ERR("Invalid probe type encountered");
+       }
+}
+
 /*
  * Pretty print single event.
  */
 static void print_events(struct lttng_event *event)
 {
+       int ret;
+       const char *filter_str;
+       char *filter_msg = NULL;
+       char *exclusion_msg = NULL;
+
+       ret = lttng_event_get_filter_expression(event, &filter_str);
+
+       if (ret) {
+               filter_msg = strdup(" [failed to retrieve filter]");
+       } else if (filter_str) {
+               const char * const filter_fmt = " [filter: '%s']";
+
+               filter_msg = malloc(strlen(filter_str) +
+                               strlen(filter_fmt) + 1);
+               if (filter_msg) {
+                       sprintf(filter_msg, filter_fmt,
+                                       filter_str);
+               }
+       }
+
+       exclusion_msg = get_exclusion_names_msg(event);
+       if (!exclusion_msg) {
+               exclusion_msg = strdup(" [failed to retrieve exclusions]");
+       }
+
        switch (event->type) {
        case LTTNG_EVENT_TRACEPOINT:
        {
@@ -234,25 +363,25 @@ static void print_events(struct lttng_event *event)
                                indent6,
                                event->name,
                                logleveltype_string(event->loglevel_type),
-                               mi_lttng_loglevel_string(event->loglevel),
+                               mi_lttng_loglevel_string(event->loglevel, handle->domain.type),
                                event->loglevel,
                                enabled_string(event->enabled),
-                               exclusion_string(event->exclusion),
-                               filter_string(event->filter));
+                               safe_string(exclusion_msg),
+                               safe_string(filter_msg));
                } else {
                        MSG("%s%s (type: tracepoint)%s%s%s",
                                indent6,
                                event->name,
                                enabled_string(event->enabled),
-                               exclusion_string(event->exclusion),
-                               filter_string(event->filter));
+                               safe_string(exclusion_msg),
+                               safe_string(filter_msg));
                }
                break;
        }
        case LTTNG_EVENT_FUNCTION:
                MSG("%s%s (type: function)%s%s", indent6,
                                event->name, enabled_string(event->enabled),
-                               filter_string(event->filter));
+                               safe_string(filter_msg));
                if (event->attr.probe.addr != 0) {
                        MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
                } else {
@@ -263,7 +392,7 @@ static void print_events(struct lttng_event *event)
        case LTTNG_EVENT_PROBE:
                MSG("%s%s (type: probe)%s%s", indent6,
                                event->name, enabled_string(event->enabled),
-                               filter_string(event->filter));
+                               safe_string(filter_msg));
                if (event->attr.probe.addr != 0) {
                        MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
                } else {
@@ -271,28 +400,37 @@ static void print_events(struct lttng_event *event)
                        MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
                }
                break;
+       case LTTNG_EVENT_USERSPACE_PROBE:
+               print_userspace_probe_location(event);
+               break;
        case LTTNG_EVENT_FUNCTION_ENTRY:
                MSG("%s%s (type: function)%s%s", indent6,
                                event->name, enabled_string(event->enabled),
-                               filter_string(event->filter));
+                               safe_string(filter_msg));
                MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
                break;
        case LTTNG_EVENT_SYSCALL:
-               MSG("%s%s%s%s%s", indent6, event->name,
+               MSG("%s%s%s%s%s%s", indent6, event->name,
                                (opt_syscall ? "" : " (type:syscall)"),
                                enabled_string(event->enabled),
-                               bitness_event(event->flags));
+                               bitness_event(event->flags),
+                               safe_string(filter_msg));
                break;
        case LTTNG_EVENT_NOOP:
                MSG("%s (type: noop)%s%s", indent6,
                                enabled_string(event->enabled),
-                               filter_string(event->filter));
+                               safe_string(filter_msg));
                break;
        case LTTNG_EVENT_ALL:
+               /* Fall-through. */
+       default:
                /* We should never have "all" events in list. */
                assert(0);
                break;
        }
+
+       free(filter_msg);
+       free(exclusion_msg);
 }
 
 static const char *field_type(struct lttng_event_field *field)
@@ -348,7 +486,7 @@ static int mi_list_agent_ust_events(struct lttng_event *events, int count,
                goto end;
        }
 
-       /* Open pids element */
+       /* Open pids element element */
        ret = mi_lttng_pids_open(writer);
        if (ret) {
                goto end;
@@ -357,7 +495,7 @@ static int mi_list_agent_ust_events(struct lttng_event *events, int count,
        for (i = 0; i < count; i++) {
                if (cur_pid != events[i].pid) {
                        if (pid_element_open) {
-                               /* Close the previous events and  pid element */
+                               /* Close the previous events and pid element */
                                ret = mi_lttng_close_multi_element(writer, 2);
                                if (ret) {
                                        goto end;
@@ -391,7 +529,7 @@ static int mi_list_agent_ust_events(struct lttng_event *events, int count,
                }
 
                /* Write an event */
-               ret = mi_lttng_event(writer, &events[i], 0);
+               ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
                if (ret) {
                        goto end;
                }
@@ -416,8 +554,8 @@ static int list_agent_events(void)
 {
        int i, size, ret = CMD_SUCCESS;
        struct lttng_domain domain;
-       struct lttng_handle *handle;
-       struct lttng_event *event_list;
+       struct lttng_handle *handle = NULL;
+       struct lttng_event *event_list = NULL;
        pid_t cur_pid = 0;
        char *cmdline = NULL;
        const char *agent_domain_str;
@@ -427,6 +565,12 @@ static int list_agent_events(void)
                domain.type = LTTNG_DOMAIN_JUL;
        } else if (opt_log4j) {
                domain.type = LTTNG_DOMAIN_LOG4J;
+       } else if (opt_python) {
+               domain.type = LTTNG_DOMAIN_PYTHON;
+       } else {
+               ERR("Invalid agent domain selected.");
+               ret = CMD_ERROR;
+               goto error;
        }
 
        agent_domain_str = get_domain_str(domain.type);
@@ -495,7 +639,7 @@ static int list_ust_events(void)
        int i, size, ret = CMD_SUCCESS;
        struct lttng_domain domain;
        struct lttng_handle *handle;
-       struct lttng_event *event_list;
+       struct lttng_event *event_list = NULL;
        pid_t cur_pid = 0;
        char *cmdline = NULL;
 
@@ -567,6 +711,8 @@ static int mi_list_ust_event_fields(struct lttng_event_field *fields, int count,
        int event_element_open = 0;
        struct lttng_event cur_event;
 
+       memset(&cur_event, 0, sizeof(cur_event));
+
        /* Open domains element */
        ret = mi_lttng_domains_open(writer);
        if (ret) {
@@ -589,7 +735,6 @@ static int mi_list_ust_event_fields(struct lttng_event_field *fields, int count,
                if (cur_pid != fields[i].event.pid) {
                        if (pid_element_open) {
                                if (event_element_open) {
-
                                        /* Close the previous field element and event. */
                                        ret = mi_lttng_close_multi_element(writer, 2);
                                        if (ret) {
@@ -641,7 +786,8 @@ static int mi_list_ust_event_fields(struct lttng_event_field *fields, int count,
 
                        if (!event_element_open) {
                                /* Open and write the event */
-                               ret = mi_lttng_event(writer, &cur_event, 1);
+                               ret = mi_lttng_event(writer, &cur_event, 1,
+                                               handle->domain.type);
                                if (ret) {
                                        goto end;
                                }
@@ -662,7 +808,7 @@ static int mi_list_ust_event_fields(struct lttng_event_field *fields, int count,
                }
        }
 
-       /* Close pids, domain, domains */
+       /* Close pid, domain, domains */
        ret = mi_lttng_close_multi_element(writer, 3);
 end:
        return ret;
@@ -779,7 +925,7 @@ static int mi_list_kernel_events(struct lttng_event *events, int count,
        }
 
        for (i = 0; i < count; i++) {
-               ret = mi_lttng_event(writer, &events[i], 0);
+               ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
                if (ret) {
                        goto end;
                }
@@ -867,7 +1013,7 @@ static int mi_list_syscalls(struct lttng_event *events, int count)
        }
 
        for (i = 0; i < count; i++) {
-               ret = mi_lttng_event(writer, &events[i], 0);
+               ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
                if (ret) {
                        goto end;
                }
@@ -940,7 +1086,7 @@ static int mi_list_session_agent_events(struct lttng_event *events, int count)
        }
 
        for (i = 0; i < count; i++) {
-               ret = mi_lttng_event(writer, &events[i], 0);
+               ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
                if (ret) {
                        goto end;
                }
@@ -986,10 +1132,43 @@ static int list_session_agent_events(void)
                }
 
                for (i = 0; i < count; i++) {
-                       MSG("%s- %s%s (loglevel%s %s)", indent4, events[i].name,
-                                       enabled_string(events[i].enabled),
-                                       logleveltype_string(events[i].loglevel_type),
-                                       mi_lttng_loglevel_string(events[i].loglevel));
+                       const char *filter_str;
+                       char *filter_msg = NULL;
+                       struct lttng_event *event = &events[i];
+
+                       ret = lttng_event_get_filter_expression(event,
+                                       &filter_str);
+                       if (ret) {
+                               filter_msg = strdup(" [failed to retrieve filter]");
+                       } else if (filter_str) {
+                               const char * const filter_fmt =
+                                               " [filter: '%s']";
+
+                               filter_msg = malloc(strlen(filter_str) +
+                                               strlen(filter_fmt) + 1);
+                               if (filter_msg) {
+                                       sprintf(filter_msg, filter_fmt,
+                                                       filter_str);
+                               }
+                       }
+
+                       if (event->loglevel_type !=
+                                       LTTNG_EVENT_LOGLEVEL_ALL) {
+                               MSG("%s- %s%s (loglevel%s %s)%s", indent4,
+                                               event->name,
+                                               enabled_string(event->enabled),
+                                               logleveltype_string(
+                                                       event->loglevel_type),
+                                               mi_lttng_loglevel_string(
+                                                       event->loglevel,
+                                                       handle->domain.type),
+                                               safe_string(filter_msg));
+                       } else {
+                               MSG("%s- %s%s%s", indent4, event->name,
+                                               enabled_string(event->enabled),
+                                               safe_string(filter_msg));
+                       }
+                       free(filter_msg);
                }
 
                MSG("");
@@ -1016,7 +1195,7 @@ static int mi_list_events(struct lttng_event *events, int count)
        }
 
        for (i = 0; i < count; i++) {
-               ret = mi_lttng_event(writer, &events[i], 0);
+               ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
                if (ret) {
                        goto end;
                }
@@ -1053,7 +1232,7 @@ static int list_events(const char *channel_name)
                }
        } else {
                /* Pretty print */
-               MSG("\n%sEvents:", indent4);
+               MSG("\n%sEvent rules:", indent4);
                if (count == 0) {
                        MSG("%sNone\n", indent6);
                        goto end;
@@ -1071,29 +1250,122 @@ error:
        return ret;
 }
 
+static
+void print_timer(const char *timer_name, uint32_t space_count, int64_t value)
+{
+       uint32_t i;
+
+       _MSG("%s%s:", indent6, timer_name);
+       for (i = 0; i < space_count; i++) {
+               _MSG(" ");
+       }
+
+       if (value) {
+               MSG("%" PRId64 " µs", value);
+       } else {
+               MSG("inactive");
+       }
+}
+
 /*
  * Pretty print channel
  */
 static void print_channel(struct lttng_channel *channel)
 {
-       MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
+       int ret;
+       uint64_t discarded_events, lost_packets, monitor_timer_interval;
+       int64_t blocking_timeout;
+
+       ret = lttng_channel_get_discarded_event_count(channel,
+                       &discarded_events);
+       if (ret) {
+               ERR("Failed to retrieve discarded event count of channel");
+               return;
+       }
+
+       ret = lttng_channel_get_lost_packet_count(channel,
+                       &lost_packets);
+       if (ret) {
+               ERR("Failed to retrieve lost packet count of channel");
+               return;
+       }
 
+       ret = lttng_channel_get_monitor_timer_interval(channel,
+                       &monitor_timer_interval);
+       if (ret) {
+               ERR("Failed to retrieve monitor interval of channel");
+               return;
+       }
+
+       ret = lttng_channel_get_blocking_timeout(channel,
+                       &blocking_timeout);
+       if (ret) {
+               ERR("Failed to retrieve blocking timeout of channel");
+               return;
+       }
+
+       MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
        MSG("%sAttributes:", indent4);
-       MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
-       MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
-       MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
-       MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
-       MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
-       MSG("%strace file count: %" PRIu64, indent6, channel->attr.tracefile_count);
-       MSG("%strace file size (bytes): %" PRIu64, indent6, channel->attr.tracefile_size);
+       MSG("%sEvent-loss mode:  %s", indent6, channel->attr.overwrite ? "overwrite" : "discard");
+       MSG("%sSub-buffer size:  %" PRIu64 " bytes", indent6, channel->attr.subbuf_size);
+       MSG("%sSub-buffer count: %" PRIu64, indent6, channel->attr.num_subbuf);
+
+       print_timer("Switch timer", 5, channel->attr.switch_timer_interval);
+       print_timer("Read timer",  7, channel->attr.read_timer_interval);
+       print_timer("Monitor timer", 4, monitor_timer_interval);
+
+       if (!channel->attr.overwrite) {
+               if (blocking_timeout == -1) {
+                       MSG("%sBlocking timeout: infinite", indent6);
+               } else {
+                       MSG("%sBlocking timeout: %" PRId64 " µs", indent6, blocking_timeout);
+               }
+       }
+
+       MSG("%sTrace file count: %" PRIu64 " per stream", indent6,
+                       channel->attr.tracefile_count == 0 ?
+                               1 : channel->attr.tracefile_count);
+       if (channel->attr.tracefile_size != 0 ) {
+               MSG("%sTrace file size:  %" PRIu64 " bytes", indent6,
+                               channel->attr.tracefile_size);
+       } else {
+               MSG("%sTrace file size:  %s", indent6, "unlimited");
+       }
        switch (channel->attr.output) {
                case LTTNG_EVENT_SPLICE:
-                       MSG("%soutput: splice()", indent6);
+                       MSG("%sOutput mode:      splice", indent6);
                        break;
                case LTTNG_EVENT_MMAP:
-                       MSG("%soutput: mmap()", indent6);
+                       MSG("%sOutput mode:      mmap", indent6);
                        break;
        }
+
+       MSG("\n%sStatistics:", indent4);
+       if (listed_session.snapshot_mode) {
+               /*
+                * The lost packet count is omitted for sessions in snapshot
+                * mode as it is misleading: it would indicate the number of
+                * packets that the consumer could not extract during the
+                * course of recording the snapshot. It does not have the
+                * same meaning as the "regular" lost packet count that
+                * would result from the consumer not keeping up with
+                * event production in an overwrite-mode channel.
+                *
+                * A more interesting statistic would be the number of
+                * packets lost between the first and last extracted
+                * packets of a given snapshot (which prevents most analyses).
+                */
+               MSG("%sNone", indent6);
+               goto skip_stats_printing;
+       }
+
+       if (!channel->attr.overwrite) {
+               MSG("%sDiscarded events: %" PRIu64, indent6, discarded_events);
+       } else {
+               MSG("%sLost packets:     %" PRIu64, indent6, lost_packets);
+       }
+skip_stats_printing:
+       return;
 }
 
 /*
@@ -1200,7 +1472,7 @@ static int list_channels(const char *channel_name)
                }
        } else {
                /* Pretty print */
-               if (channel_name == NULL) {
+               if (count) {
                        MSG("Channels:\n-------------");
                }
 
@@ -1238,6 +1510,238 @@ error_channels:
        return ret;
 }
 
+/*
+ * List tracker PID(s) of session and domain.
+ */
+static int list_tracker_pids(void)
+{
+       int ret = 0;
+       int enabled;
+       int *pids = NULL;
+       size_t nr_pids;
+
+       ret = lttng_list_tracker_pids(handle,
+               &enabled, &pids, &nr_pids);
+       if (ret) {
+               return ret;
+       }
+       if (enabled) {
+               int i;
+               _MSG("PID tracker: [");
+
+               /* Mi tracker_pid element*/
+               if (writer) {
+                       /* Open tracker_pid and targets elements */
+                       ret = mi_lttng_pid_tracker_open(writer);
+                       if (ret) {
+                               goto end;
+                       }
+               }
+
+               for (i = 0; i < nr_pids; i++) {
+                       if (i) {
+                               _MSG(",");
+                       }
+                       _MSG(" %d", pids[i]);
+
+                       /* Mi */
+                       if (writer) {
+                               ret = mi_lttng_pid_target(writer, pids[i], 0);
+                               if (ret) {
+                                       goto end;
+                               }
+                       }
+               }
+               _MSG(" ]\n\n");
+
+               /* Mi close tracker_pid and targets */
+               if (writer) {
+                       ret = mi_lttng_close_multi_element(writer,2);
+                       if (ret) {
+                               goto end;
+                       }
+               }
+       }
+end:
+       free(pids);
+       return ret;
+
+}
+
+/*
+ * List all tracker of a domain
+ */
+static int list_trackers(void)
+{
+       int ret;
+
+       /* Trackers listing */
+       if (lttng_opt_mi) {
+               ret = mi_lttng_trackers_open(writer);
+               if (ret) {
+                       goto end;
+               }
+       }
+
+       /* pid tracker */
+       ret = list_tracker_pids();
+       if (ret) {
+               goto end;
+       }
+
+       if (lttng_opt_mi) {
+               /* Close trackers element */
+               ret = mi_lttng_writer_close_element(writer);
+               if (ret) {
+                       goto end;
+               }
+       }
+
+end:
+       return ret;
+}
+
+static enum cmd_error_code print_periodic_rotation_schedule(
+               const struct lttng_rotation_schedule *schedule)
+{
+       enum cmd_error_code ret;
+       enum lttng_rotation_status status;
+       uint64_t value;
+
+       status = lttng_rotation_schedule_periodic_get_period(schedule,
+                       &value);
+       if (status != LTTNG_ROTATION_STATUS_OK) {
+               ERR("Failed to retrieve period parameter from periodic rotation schedule.");
+               ret = CMD_ERROR;
+               goto end;
+       }
+
+       MSG("    timer period: %" PRIu64" µs", value);
+       ret = CMD_SUCCESS;
+end:
+       return ret;
+}
+
+static enum cmd_error_code print_size_threshold_rotation_schedule(
+               const struct lttng_rotation_schedule *schedule)
+{
+       enum cmd_error_code ret;
+       enum lttng_rotation_status status;
+       uint64_t value;
+
+       status = lttng_rotation_schedule_size_threshold_get_threshold(schedule,
+                       &value);
+       if (status != LTTNG_ROTATION_STATUS_OK) {
+               ERR("Failed to retrieve size parameter from size-based rotation schedule.");
+               ret = CMD_ERROR;
+               goto end;
+       }
+
+       MSG("    size threshold: %" PRIu64" bytes", value);
+       ret = CMD_SUCCESS;
+end:
+       return ret;
+}
+
+static enum cmd_error_code print_rotation_schedule(
+               const struct lttng_rotation_schedule *schedule)
+{
+       enum cmd_error_code ret;
+
+       switch (lttng_rotation_schedule_get_type(schedule)) {
+       case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD:
+               ret = print_size_threshold_rotation_schedule(schedule);
+               break;
+       case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC:
+               ret = print_periodic_rotation_schedule(schedule);
+               break;
+       default:
+               ret = CMD_ERROR;
+       }
+       return ret;
+}
+
+/*
+ * List the automatic rotation settings.
+ */
+static enum cmd_error_code list_rotate_settings(const char *session_name)
+{
+       int ret;
+       enum cmd_error_code cmd_ret = CMD_SUCCESS;
+       unsigned int count, i;
+       struct lttng_rotation_schedules *schedules = NULL;
+       enum lttng_rotation_status status;
+
+       ret = lttng_session_list_rotation_schedules(session_name, &schedules);
+       if (ret != LTTNG_OK) {
+               ERR("Failed to list session rotation schedules: %s", lttng_strerror(ret));
+               cmd_ret = CMD_ERROR;
+               goto end;
+       }
+
+       status = lttng_rotation_schedules_get_count(schedules, &count);
+       if (status != LTTNG_ROTATION_STATUS_OK) {
+               ERR("Failed to retrieve the number of session rotation schedules.");
+               cmd_ret = CMD_ERROR;
+               goto end;
+       }
+
+       if (count == 0) {
+               cmd_ret = CMD_SUCCESS;
+               goto end;
+       }
+
+       MSG("Automatic rotation schedules:");
+       if (lttng_opt_mi) {
+               ret = mi_lttng_writer_open_element(writer,
+                               mi_lttng_element_rotation_schedules);
+               if (ret) {
+                       cmd_ret = CMD_ERROR;
+                       goto end;
+               }
+       }
+
+       for (i = 0; i < count; i++) {
+               enum cmd_error_code tmp_ret = CMD_SUCCESS;
+               const struct lttng_rotation_schedule *schedule;
+
+               schedule = lttng_rotation_schedules_get_at_index(schedules, i);
+               if (!schedule) {
+                       ERR("Failed to retrieve session rotation schedule.");
+                       cmd_ret = CMD_ERROR;
+                       goto end;
+               }
+
+               if (lttng_opt_mi) {
+                       ret = mi_lttng_rotation_schedule(writer, schedule);
+                       if (ret) {
+                               tmp_ret = CMD_ERROR;
+                       }
+               } else {
+                       tmp_ret = print_rotation_schedule(schedule);
+               }
+
+               /*
+                * Report an error if the serialization of any of the
+                * descriptors failed.
+                */
+               cmd_ret = cmd_ret ? cmd_ret : tmp_ret;
+       }
+
+       _MSG("\n");
+       if (lttng_opt_mi) {
+               /* Close the rotation_schedules element. */
+               ret = mi_lttng_writer_close_element(writer);
+               if (ret) {
+                       cmd_ret = CMD_ERROR;
+                       goto end;
+               }
+       }
+end:
+       lttng_rotation_schedules_destroy(schedules);
+       return cmd_ret;
+}
+
 /*
  * Machine interface
  * Find the session with session_name as name
@@ -1362,6 +1866,8 @@ static int list_sessions(const char *session_name)
                                                        active_string(sessions[i].enabled),
                                                        snapshot_string(sessions[i].snapshot_mode));
                                        MSG("%sTrace path: %s\n", indent4, sessions[i].path);
+                                       memcpy(&listed_session, &sessions[i],
+                                                       sizeof(listed_session));
                                        break;
                                }
                        } else {
@@ -1370,8 +1876,11 @@ static int list_sessions(const char *session_name)
                                                active_string(sessions[i].enabled),
                                                snapshot_string(sessions[i].snapshot_mode));
                                MSG("%sTrace path: %s", indent4, sessions[i].path);
-                               MSG("%sLive timer interval (usec): %u\n", indent4,
-                                               sessions[i].live_timer_interval);
+                               if (sessions[i].live_timer_interval != 0) {
+                                       MSG("%sLive timer interval: %u µs", indent4,
+                                                       sessions[i].live_timer_interval);
+                               }
+                               MSG("");
                        }
                }
 
@@ -1467,6 +1976,9 @@ static int list_domains(const char *session_name)
                        case LTTNG_DOMAIN_LOG4J:
                                MSG("  - LOG4j (Logging for Java)");
                                break;
+                       case LTTNG_DOMAIN_PYTHON:
+                               MSG("  - Python (logging)");
+                               break;
                        default:
                                break;
                        }
@@ -1486,7 +1998,7 @@ end:
 int cmd_list(int argc, const char **argv)
 {
        int opt, ret = CMD_SUCCESS;
-       const char *session_name;
+       const char *session_name, *leftover = NULL;
        static poptContext pc;
        struct lttng_domain domain;
        struct lttng_domain *domains = NULL;
@@ -1494,7 +2006,6 @@ int cmd_list(int argc, const char **argv)
        memset(&domain, 0, sizeof(domain));
 
        if (argc < 1) {
-               usage(stderr);
                ret = CMD_ERROR;
                goto end;
        }
@@ -1505,7 +2016,7 @@ int cmd_list(int argc, const char **argv)
        while ((opt = poptGetNextOpt(pc)) != -1) {
                switch (opt) {
                case OPT_HELP:
-                       usage(stdout);
+                       SHOW_HELP();
                        goto end;
                case OPT_USERSPACE:
                        opt_userspace = 1;
@@ -1514,7 +2025,6 @@ int cmd_list(int argc, const char **argv)
                        list_cmd_options(stdout, long_options);
                        goto end;
                default:
-                       usage(stderr);
                        ret = CMD_UNDEFINED;
                        goto end;
                }
@@ -1549,6 +2059,13 @@ int cmd_list(int argc, const char **argv)
        session_name = poptGetArg(pc);
        DBG2("Session name: %s", session_name);
 
+       leftover = poptGetArg(pc);
+       if (leftover) {
+               ERR("Unknown argument: %s", leftover);
+               ret = CMD_ERROR;
+               goto end;
+       }
+
        if (opt_kernel) {
                domain.type = LTTNG_DOMAIN_KERNEL;
        } else if (opt_userspace) {
@@ -1559,6 +2076,8 @@ int cmd_list(int argc, const char **argv)
                domain.type = LTTNG_DOMAIN_JUL;
        } else if (opt_log4j) {
                domain.type = LTTNG_DOMAIN_LOG4J;
+       } else if (opt_python) {
+               domain.type = LTTNG_DOMAIN_PYTHON;
        }
 
        if (!opt_kernel && opt_syscall) {
@@ -1567,7 +2086,7 @@ int cmd_list(int argc, const char **argv)
                goto end;
        }
 
-       if (opt_kernel || opt_userspace || opt_jul || opt_log4j) {
+       if (opt_kernel || opt_userspace || opt_jul || opt_log4j || opt_python) {
                handle = lttng_create_handle(session_name, &domain);
                if (handle == NULL) {
                        ret = CMD_FATAL;
@@ -1576,7 +2095,8 @@ int cmd_list(int argc, const char **argv)
        }
 
        if (session_name == NULL) {
-               if (!opt_kernel && !opt_userspace && !opt_jul && !opt_log4j) {
+               if (!opt_kernel && !opt_userspace && !opt_jul && !opt_log4j
+                               && !opt_python) {
                        ret = list_sessions(NULL);
                        if (ret) {
                                goto end;
@@ -1605,7 +2125,7 @@ int cmd_list(int argc, const char **argv)
                                goto end;
                        }
                }
-               if (opt_jul || opt_log4j) {
+               if (opt_jul || opt_log4j || opt_python) {
                        ret = list_agent_events();
                        if (ret) {
                                goto end;
@@ -1627,6 +2147,11 @@ int cmd_list(int argc, const char **argv)
                        goto end;
                }
 
+               ret = list_rotate_settings(session_name);
+               if (ret) {
+                       goto end;
+               }
+
                /* Domain listing */
                if (opt_domain) {
                        ret = list_domains(session_name);
@@ -1653,6 +2178,14 @@ int cmd_list(int argc, const char **argv)
 
                        }
 
+
+                       /* Trackers */
+                       ret = list_trackers();
+                       if (ret) {
+                               goto end;
+                       }
+
+                       /* Channels */
                        ret = list_channels(opt_channel);
                        if (ret) {
                                goto end;
@@ -1703,6 +2236,9 @@ int cmd_list(int argc, const char **argv)
                                case LTTNG_DOMAIN_LOG4J:
                                        MSG("=== Domain: LOG4j (Logging for Java) ===\n");
                                        break;
+                               case LTTNG_DOMAIN_PYTHON:
+                                       MSG("=== Domain: Python (logging) ===\n");
+                                       break;
                                default:
                                        MSG("=== Domain: Unimplemented ===\n");
                                        break;
@@ -1728,12 +2264,26 @@ int cmd_list(int argc, const char **argv)
                                }
 
                                if (domains[i].type == LTTNG_DOMAIN_JUL ||
-                                               domains[i].type == LTTNG_DOMAIN_LOG4J) {
+                                               domains[i].type == LTTNG_DOMAIN_LOG4J ||
+                                               domains[i].type == LTTNG_DOMAIN_PYTHON) {
                                        ret = list_session_agent_events();
                                        if (ret) {
                                                goto end;
                                        }
-                                       continue;
+
+                                       goto next_domain;
+                               }
+
+                               switch (domains[i].type) {
+                               case LTTNG_DOMAIN_KERNEL:
+                               case LTTNG_DOMAIN_UST:
+                                       ret = list_trackers();
+                                       if (ret) {
+                                               goto end;
+                                       }
+                                       break;
+                               default:
+                                       break;
                                }
 
                                ret = list_channels(opt_channel);
@@ -1741,6 +2291,7 @@ int cmd_list(int argc, const char **argv)
                                        goto end;
                                }
 
+next_domain:
                                if (lttng_opt_mi) {
                                        /* Close domain element */
                                        ret = mi_lttng_writer_close_element(writer);
This page took 0.037115 seconds and 4 git commands to generate.