X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng%2Fcommands%2Flist.c;h=34a9c8aa0d612e7dc49ea78d9f0dbfa9d762230e;hp=2dd0dc8a331d0a34e09764ce1b3217c9d6e1bcf7;hb=1004b7191b421c7c07acf964d0110d93bb022699;hpb=fb14d0d8da366c09452d1f8c43268e46dfb7da40 diff --git a/src/bin/lttng/commands/list.c b/src/bin/lttng/commands/list.c index 2dd0dc8a3..34a9c8aa0 100644 --- a/src/bin/lttng/commands/list.c +++ b/src/bin/lttng/commands/list.c @@ -1,21 +1,13 @@ /* - * Copyright (C) 2011 - David Goulet + * Copyright (C) 2011 David Goulet + * Copyright (C) 2020 Jérémie Galarneau * - * 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. + * SPDX-License-Identifier: GPL-2.0-only * - * 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 _GNU_SOURCE +#include +#define _LGPL_SOURCE #include #include #include @@ -24,81 +16,61 @@ #include #include +#include +#include +#include +#include #include "../command.h" 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; -#if 0 -/* Not implemented yet */ -static char *opt_cmd_name; -static pid_t opt_pid; -#endif +static int opt_syscall; const char *indent4 = " "; const char *indent6 = " "; const char *indent8 = " "; +#ifdef LTTNG_EMBED_HELP +static const char help_msg[] = +#include +; +#endif + enum { OPT_HELP = 1, OPT_USERSPACE, OPT_LIST_OPTIONS, }; -static struct lttng_handle *handle; -static struct mi_writer *writer; +static struct lttng_handle *the_handle; +static struct mi_writer *the_writer; + +/* Only set when listing a single session. */ +static struct lttng_session the_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}, -#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}, + {"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, " -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, "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. * @@ -108,9 +80,10 @@ static void usage(FILE *ofp) static char *get_cmdline_by_pid(pid_t pid) { int ret; - FILE *fp; + 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"); @@ -119,18 +92,20 @@ 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"); } - fclose(fp); end: + if (fp) { + fclose(fp); + } return cmdline; } @@ -167,62 +142,185 @@ 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 ""; - } + return str ? str : ""; } -static -const char *exclusion_string(int value) +static const char *logleveltype_string(enum lttng_loglevel_type value) { switch (value) { - case 1: return " [has exclusions]"; - default: return ""; + case LTTNG_EVENT_LOGLEVEL_ALL: + return ":"; + case LTTNG_EVENT_LOGLEVEL_RANGE: + return " <="; + case LTTNG_EVENT_LOGLEVEL_SINGLE: + return " =="; + default: + return " <>"; } } -static const char *loglevel_jul_string(int value) +static const char *bitness_event(enum lttng_event_flag flags) { - switch (value) { - case -1: + if (flags & LTTNG_EVENT_FLAG_SYSCALL_32) { + if (flags & LTTNG_EVENT_FLAG_SYSCALL_64) { + return " [32/64-bit]"; + } else { + return " [32-bit]"; + } + } else if (flags & LTTNG_EVENT_FLAG_SYSCALL_64) { + return " [64-bit]"; + } else { return ""; - case LTTNG_LOGLEVEL_JUL_OFF: - return "JUL_OFF"; - case LTTNG_LOGLEVEL_JUL_SEVERE: - return "JUL_SEVERE"; - case LTTNG_LOGLEVEL_JUL_WARNING: - return "JUL_WARNING"; - case LTTNG_LOGLEVEL_JUL_INFO: - return "JUL_INFO"; - case LTTNG_LOGLEVEL_JUL_CONFIG: - return "JUL_CONFIG"; - case LTTNG_LOGLEVEL_JUL_FINE: - return "JUL_FINE"; - case LTTNG_LOGLEVEL_JUL_FINER: - return "JUL_FINER"; - case LTTNG_LOGLEVEL_JUL_FINEST: - return "JUL_FINEST"; - case LTTNG_LOGLEVEL_JUL_ALL: - return "JUL_ALL"; - default: - return "<>"; } } -static const char *logleveltype_string(enum lttng_loglevel_type value) +/* + * 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) { - switch (value) { - case LTTNG_EVENT_LOGLEVEL_ALL: - return ":"; - case LTTNG_EVENT_LOGLEVEL_RANGE: - return " <="; - case LTTNG_EVENT_LOGLEVEL_SINGLE: - return " =="; + 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; + 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; + } + + free(binary_path); + break; + } + case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT: + { + const char *probe_name, *provider_name; + 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; + } + + free(binary_path); + break; + } default: - return " <>"; + ERR("Invalid probe type encountered"); } } @@ -231,33 +329,60 @@ static const char *logleveltype_string(enum lttng_loglevel_type value) */ 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: { if (event->loglevel != -1) { MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s", - indent6, - event->name, - logleveltype_string(event->loglevel_type), - mi_lttng_loglevel_string(event->loglevel), - event->loglevel, - enabled_string(event->enabled), - exclusion_string(event->exclusion), - filter_string(event->filter)); + indent6, event->name, + logleveltype_string( + event->loglevel_type), + mi_lttng_loglevel_string( + event->loglevel, + the_handle->domain.type), + event->loglevel, + enabled_string(event->enabled), + 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 { @@ -268,7 +393,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 { @@ -276,27 +401,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("%ssyscalls (type: syscall)%s%s", indent6, + MSG("%s%s%s%s%s%s", indent6, event->name, + (opt_syscall ? "" : " (type:syscall)"), enabled_string(event->enabled), - filter_string(event->filter)); + 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) @@ -332,7 +467,7 @@ static void print_event_field(struct lttng_event_field *field) * Machine interface * Jul and ust event listing */ -static int mi_list_jul_ust_events(struct lttng_event *events, int count, +static int mi_list_agent_ust_events(struct lttng_event *events, int count, struct lttng_domain *domain) { int ret, i; @@ -341,19 +476,19 @@ static int mi_list_jul_ust_events(struct lttng_event *events, int count, int pid_element_open = 0; /* Open domains element */ - ret = mi_lttng_domains_open(writer); + ret = mi_lttng_domains_open(the_writer); if (ret) { goto end; } /* Write domain */ - ret = mi_lttng_domain(writer, domain, 1); + ret = mi_lttng_domain(the_writer, domain, 1); if (ret) { goto end; } - /* Open pids element */ - ret = mi_lttng_pids_open(writer); + /* Open pids element element */ + ret = mi_lttng_pids_open(the_writer); if (ret) { goto end; } @@ -361,8 +496,9 @@ static int mi_list_jul_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 */ - ret = mi_lttng_close_multi_element(writer, 2); + /* Close the previous events and pid element */ + ret = mi_lttng_close_multi_element( + the_writer, 2); if (ret) { goto end; } @@ -378,13 +514,14 @@ static int mi_list_jul_ust_events(struct lttng_event *events, int count, if (!pid_element_open) { /* Open and write a pid element */ - ret = mi_lttng_pid(writer, cur_pid, cmdline, 1); + ret = mi_lttng_pid(the_writer, cur_pid, cmdline, + 1); if (ret) { goto error; } /* Open events element */ - ret = mi_lttng_events_open(writer); + ret = mi_lttng_events_open(the_writer); if (ret) { goto error; } @@ -395,20 +532,21 @@ static int mi_list_jul_ust_events(struct lttng_event *events, int count, } /* Write an event */ - ret = mi_lttng_event(writer, &events[i], 0); + ret = mi_lttng_event(the_writer, &events[i], 0, + the_handle->domain.type); if (ret) { goto end; } } /* Close pids */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(the_writer); if (ret) { goto end; } /* Close domain, domains */ - ret = mi_lttng_close_multi_element(writer, 2); + ret = mi_lttng_close_multi_element(the_writer, 2); end: return ret; error: @@ -416,19 +554,32 @@ error: return ret; } -static int list_jul_events(void) +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; - - DBG("Getting JUL tracing events"); + const char *agent_domain_str; memset(&domain, 0, sizeof(domain)); - domain.type = LTTNG_DOMAIN_JUL; + if (opt_jul) { + 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 = lttng_domain_type_str(domain.type); + + DBG("Getting %s tracing events", agent_domain_str); handle = lttng_create_handle(NULL, &domain); if (handle == NULL) { @@ -438,21 +589,23 @@ static int list_jul_events(void) size = lttng_list_tracepoints(handle, &event_list); if (size < 0) { - ERR("Unable to list JUL events: %s", lttng_strerror(size)); + ERR("Unable to list %s events: %s", agent_domain_str, + lttng_strerror(size)); ret = CMD_ERROR; goto end; } if (lttng_opt_mi) { /* Mi print */ - ret = mi_list_jul_ust_events(event_list, size, &domain); + ret = mi_list_agent_ust_events(event_list, size, &domain); if (ret) { ret = CMD_ERROR; goto error; } } else { /* Pretty print */ - MSG("JUL events (Logger name):\n-------------------------"); + MSG("%s events (Logger name):\n-------------------------", + agent_domain_str); if (size == 0) { MSG("None"); @@ -490,7 +643,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; @@ -515,7 +668,7 @@ static int list_ust_events(void) if (lttng_opt_mi) { /* Mi print */ - ret = mi_list_jul_ust_events(event_list, size, &domain); + ret = mi_list_agent_ust_events(event_list, size, &domain); } else { /* Pretty print */ MSG("UST events:\n-------------"); @@ -562,20 +715,22 @@ 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); + ret = mi_lttng_domains_open(the_writer); if (ret) { goto end; } /* Write domain */ - ret = mi_lttng_domain(writer, domain, 1); + ret = mi_lttng_domain(the_writer, domain, 1); if (ret) { goto end; } /* Open pids element */ - ret = mi_lttng_pids_open(writer); + ret = mi_lttng_pids_open(the_writer); if (ret) { goto end; } @@ -584,18 +739,17 @@ 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 fields element - * and the previous event - */ - ret = mi_lttng_close_multi_element(writer, 2); + /* Close the previous field element and event. */ + ret = mi_lttng_close_multi_element( + the_writer, 2); if (ret) { goto end; } event_element_open = 0; } /* Close the previous events, pid element */ - ret = mi_lttng_close_multi_element(writer, 2); + ret = mi_lttng_close_multi_element( + the_writer, 2); if (ret) { goto end; } @@ -606,13 +760,14 @@ static int mi_list_ust_event_fields(struct lttng_event_field *fields, int count, cmdline = get_cmdline_by_pid(cur_pid); if (!pid_element_open) { /* Open and write a pid element */ - ret = mi_lttng_pid(writer, cur_pid, cmdline, 1); + ret = mi_lttng_pid(the_writer, cur_pid, cmdline, + 1); if (ret) { goto error; } /* Open events element */ - ret = mi_lttng_events_open(writer); + ret = mi_lttng_events_open(the_writer); if (ret) { goto error; } @@ -626,7 +781,8 @@ static int mi_list_ust_event_fields(struct lttng_event_field *fields, int count, if (strcmp(cur_event.name, fields[i].event.name) != 0) { if (event_element_open) { /* Close the previous fields element and the previous event */ - ret = mi_lttng_close_multi_element(writer, 2); + ret = mi_lttng_close_multi_element( + the_writer, 2); if (ret) { goto end; } @@ -638,13 +794,14 @@ 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(the_writer, &cur_event, 1, + the_handle->domain.type); if (ret) { goto end; } /* Open a fields element */ - ret = mi_lttng_event_fields_open(writer); + ret = mi_lttng_event_fields_open(the_writer); if (ret) { goto end; } @@ -653,14 +810,14 @@ static int mi_list_ust_event_fields(struct lttng_event_field *fields, int count, } /* Print the event_field */ - ret = mi_lttng_event_field(writer, &fields[i]); + ret = mi_lttng_event_field(the_writer, &fields[i]); if (ret) { goto end; } } /* Close pids, domain, domains */ - ret = mi_lttng_close_multi_element(writer, 3); + ret = mi_lttng_close_multi_element(the_writer, 3); end: return ret; error: @@ -758,32 +915,33 @@ static int mi_list_kernel_events(struct lttng_event *events, int count, int ret, i; /* Open domains element */ - ret = mi_lttng_domains_open(writer); + ret = mi_lttng_domains_open(the_writer); if (ret) { goto end; } /* Write domain */ - ret = mi_lttng_domain(writer, domain, 1); + ret = mi_lttng_domain(the_writer, domain, 1); if (ret) { goto end; } /* Open events */ - ret = mi_lttng_events_open(writer); + ret = mi_lttng_events_open(the_writer); if (ret) { goto end; } for (i = 0; i < count; i++) { - mi_lttng_event(writer, &events[i], 0); + ret = mi_lttng_event(the_writer, &events[i], 0, + the_handle->domain.type); if (ret) { goto end; } } /* close events, domain and domains */ - ret = mi_lttng_close_multi_element(writer, 3); + ret = mi_lttng_close_multi_element(the_writer, 3); if (ret) { goto end; } @@ -849,45 +1007,120 @@ error: return ret; } +/* + * Machine interface + * Print a list of system calls. + */ +static int mi_list_syscalls(struct lttng_event *events, int count) +{ + int ret, i; + + /* Open events */ + ret = mi_lttng_events_open(the_writer); + if (ret) { + goto end; + } + + for (i = 0; i < count; i++) { + ret = mi_lttng_event(the_writer, &events[i], 0, + the_handle->domain.type); + if (ret) { + goto end; + } + } + + /* Close events. */ + ret = mi_lttng_writer_close_element(the_writer); + if (ret) { + goto end; + } + +end: + return ret; +} + +/* + * Ask for kernel system calls. + */ +static int list_syscalls(void) +{ + int i, size, ret = CMD_SUCCESS; + struct lttng_event *event_list; + + DBG("Getting kernel system call events"); + + size = lttng_list_syscalls(&event_list); + if (size < 0) { + ERR("Unable to list system calls: %s", lttng_strerror(size)); + ret = CMD_ERROR; + goto error; + } + + if (lttng_opt_mi) { + /* Mi print */ + ret = mi_list_syscalls(event_list, size); + if (ret) { + ret = CMD_ERROR; + goto end; + } + } else { + MSG("System calls:\n-------------"); + + for (i = 0; i < size; i++) { + print_events(&event_list[i]); + } + + MSG(""); + } + +end: + free(event_list); + return ret; + +error: + return ret; +} + /* * Machine Interface - * Print a list of jul events + * Print a list of agent events */ -static int mi_list_session_jul_events(struct lttng_event *events, int count) +static int mi_list_session_agent_events(struct lttng_event *events, int count) { int ret, i; /* Open events element */ - ret = mi_lttng_events_open(writer); + ret = mi_lttng_events_open(the_writer); if (ret) { goto end; } for (i = 0; i < count; i++) { - ret = mi_lttng_event(writer, &events[i], 0); + ret = mi_lttng_event(the_writer, &events[i], 0, + the_handle->domain.type); if (ret) { goto end; } } /* Close events element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(the_writer); end: return ret; } /* - * List JUL events for a specific session using the handle. + * List agent events for a specific session using the handle. * * Return CMD_SUCCESS on success else a negative value. */ -static int list_session_jul_events(void) +static int list_session_agent_events(void) { int ret = CMD_SUCCESS, count, i; struct lttng_event *events = NULL; - count = lttng_list_events(handle, "", &events); + count = lttng_list_events(the_handle, "", &events); if (count < 0) { ret = CMD_ERROR; ERR("%s", lttng_strerror(count)); @@ -896,7 +1129,7 @@ static int list_session_jul_events(void) if (lttng_opt_mi) { /* Mi print */ - ret = mi_list_session_jul_events(events, count); + ret = mi_list_session_agent_events(events, count); if (ret) { ret = CMD_ERROR; goto end; @@ -910,10 +1143,44 @@ static int list_session_jul_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), - loglevel_jul_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, + the_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(""); @@ -934,20 +1201,21 @@ static int mi_list_events(struct lttng_event *events, int count) int ret, i; /* Open events element */ - ret = mi_lttng_events_open(writer); + ret = mi_lttng_events_open(the_writer); if (ret) { goto end; } for (i = 0; i < count; i++) { - ret = mi_lttng_event(writer, &events[i], 0); + ret = mi_lttng_event(the_writer, &events[i], 0, + the_handle->domain.type); if (ret) { goto end; } } /* Close events element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(the_writer); end: return ret; @@ -961,7 +1229,7 @@ static int list_events(const char *channel_name) int ret = CMD_SUCCESS, count, i; struct lttng_event *events = NULL; - count = lttng_list_events(handle, channel_name, &events); + count = lttng_list_events(the_handle, channel_name, &events); if (count < 0) { ret = CMD_ERROR; ERR("%s", lttng_strerror(count)); @@ -977,7 +1245,7 @@ static int list_events(const char *channel_name) } } else { /* Pretty print */ - MSG("\n%sEvents:", indent4); + MSG("\n%sRecording event rules:", indent4); if (count == 0) { MSG("%sNone\n", indent6); goto end; @@ -995,29 +1263,123 @@ 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, USEC_UNIT); + } 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, USEC_UNIT); + } + } + + 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 (the_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; } /* @@ -1032,7 +1394,7 @@ static int mi_list_channels(struct lttng_channel *channels, int count, unsigned int chan_found = 0; /* Open channels element */ - ret = mi_lttng_channels_open(writer); + ret = mi_lttng_channels_open(the_writer); if (ret) { goto error; } @@ -1047,7 +1409,7 @@ static int mi_list_channels(struct lttng_channel *channels, int count, } /* Write channel element and leave it open */ - ret = mi_lttng_channel(writer, &channels[i], 1); + ret = mi_lttng_channel(the_writer, &channels[i], 1); if (ret) { goto error; } @@ -1059,7 +1421,7 @@ static int mi_list_channels(struct lttng_channel *channels, int count, } /* Closing the channel element we opened earlier */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(the_writer); if (ret) { goto error; } @@ -1070,7 +1432,7 @@ static int mi_list_channels(struct lttng_channel *channels, int count, } /* Close channels element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(the_writer); if (ret) { goto error; } @@ -1092,7 +1454,7 @@ static int list_channels(const char *channel_name) DBG("Listing channel(s) (%s)", channel_name ? : ""); - count = lttng_list_channels(handle, &channels); + count = lttng_list_channels(the_handle, &channels); if (count < 0) { switch (-count) { case LTTNG_ERR_KERN_CHAN_NOT_FOUND: @@ -1102,7 +1464,6 @@ static int list_channels(const char *channel_name) count = 0; } else { ret = CMD_SUCCESS; - WARN("No kernel channel"); goto error_channels; } break; @@ -1124,7 +1485,7 @@ static int list_channels(const char *channel_name) } } else { /* Pretty print */ - if (channel_name == NULL) { + if (count) { MSG("Channels:\n-------------"); } @@ -1162,37 +1523,536 @@ error_channels: return ret; } -/* - * Machine interface - * Find the session with session_name as name - * and print his informations. - */ -static int mi_list_session(const char *session_name, - struct lttng_session *sessions, int count) +static const char *get_capitalized_process_attr_str(enum lttng_process_attr process_attr) { - int ret, i; - unsigned int session_found = 0; - - if (session_name == NULL) { - ret = -LTTNG_ERR_SESS_NOT_FOUND; - goto end; + switch (process_attr) { + case LTTNG_PROCESS_ATTR_PROCESS_ID: + return "Process ID"; + case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID: + return "Virtual process ID"; + case LTTNG_PROCESS_ATTR_USER_ID: + return "User ID"; + case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID: + return "Virtual user ID"; + case LTTNG_PROCESS_ATTR_GROUP_ID: + return "Group ID"; + case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID: + return "Virtual group ID"; + default: + return "Unknown"; } + return NULL; +} - for (i = 0; i < count; i++) { - if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) { - /* We need to leave it open to append other informations - * like domain, channel, events etc.*/ - session_found = 1; - ret = mi_lttng_session(writer, &sessions[i], 1); - if (ret) { - goto end; - } - break; - } - } +static int handle_process_attr_status(enum lttng_process_attr process_attr, + enum lttng_process_attr_tracker_handle_status status) +{ + int ret = CMD_SUCCESS; - if (!session_found) { - ERR("Session '%s' not found", session_name); + switch (status) { + case LTTNG_PROCESS_ATTR_TRACKER_HANDLE_STATUS_INVALID_TRACKING_POLICY: + case LTTNG_PROCESS_ATTR_TRACKER_HANDLE_STATUS_OK: + /* Carry on. */ + break; + case LTTNG_PROCESS_ATTR_TRACKER_HANDLE_STATUS_COMMUNICATION_ERROR: + ERR("Communication occurred while fetching %s tracker", + lttng_process_attr_to_string(process_attr)); + ret = CMD_ERROR; + break; + case LTTNG_PROCESS_ATTR_TRACKER_HANDLE_STATUS_SESSION_DOES_NOT_EXIST: + ERR("Failed to get the inclusion set of the %s tracker: session `%s` no longer exists", + lttng_process_attr_to_string(process_attr), + the_handle->session_name); + ret = CMD_ERROR; + break; + default: + ERR("Unknown error occurred while fetching the inclusion set of the %s tracker", + lttng_process_attr_to_string(process_attr)); + ret = CMD_ERROR; + break; + } + + return ret; +} + +static int mi_output_empty_tracker(enum lttng_process_attr process_attr) +{ + int ret; + + ret = mi_lttng_process_attribute_tracker_open(the_writer, process_attr); + if (ret) { + goto end; + } + + ret = mi_lttng_close_multi_element(the_writer, 2); +end: + return ret; +} + +static inline bool is_value_type_name( + enum lttng_process_attr_value_type value_type) +{ + return value_type == LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME || + value_type == LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME; +} + +/* + * List a process attribute tracker for a session and domain tuple. + */ +static int list_process_attr_tracker(enum lttng_process_attr process_attr) +{ + int ret = 0; + unsigned int count, i; + enum lttng_tracking_policy policy; + enum lttng_error_code ret_code; + enum lttng_process_attr_tracker_handle_status handle_status; + enum lttng_process_attr_values_status values_status; + const struct lttng_process_attr_values *values; + struct lttng_process_attr_tracker_handle *tracker_handle = NULL; + + ret_code = lttng_session_get_tracker_handle(the_handle->session_name, + the_handle->domain.type, process_attr, &tracker_handle); + if (ret_code != LTTNG_OK) { + ERR("Failed to get process attribute tracker handle: %s", + lttng_strerror(ret_code)); + ret = CMD_ERROR; + goto end; + } + + handle_status = lttng_process_attr_tracker_handle_get_inclusion_set( + tracker_handle, &values); + ret = handle_process_attr_status(process_attr, handle_status); + if (ret != CMD_SUCCESS) { + goto end; + } + + handle_status = lttng_process_attr_tracker_handle_get_tracking_policy( + tracker_handle, &policy); + ret = handle_process_attr_status(process_attr, handle_status); + if (ret != CMD_SUCCESS) { + goto end; + } + + { + char *process_attr_name; + const int print_ret = asprintf(&process_attr_name, "%ss:", + get_capitalized_process_attr_str(process_attr)); + + if (print_ret == -1) { + ret = CMD_FATAL; + goto end; + } + _MSG(" %-22s", process_attr_name); + free(process_attr_name); + } + switch (policy) { + case LTTNG_TRACKING_POLICY_INCLUDE_SET: + break; + case LTTNG_TRACKING_POLICY_EXCLUDE_ALL: + if (the_writer) { + mi_output_empty_tracker(process_attr); + } + MSG("none"); + ret = CMD_SUCCESS; + goto end; + case LTTNG_TRACKING_POLICY_INCLUDE_ALL: + MSG("all"); + ret = CMD_SUCCESS; + goto end; + default: + ERR("Unknown tracking policy encoutered while listing the %s process attribute tracker of session `%s`", + lttng_process_attr_to_string(process_attr), + the_handle->session_name); + ret = CMD_FATAL; + goto end; + } + + values_status = lttng_process_attr_values_get_count(values, &count); + if (values_status != LTTNG_PROCESS_ATTR_VALUES_STATUS_OK) { + ERR("Failed to get the count of values in the inclusion set of the %s process attribute tracker of session `%s`", + lttng_process_attr_to_string(process_attr), + the_handle->session_name); + ret = CMD_FATAL; + goto end; + } + + if (count == 0) { + /* Functionally equivalent to the 'exclude all' policy. */ + if (the_writer) { + mi_output_empty_tracker(process_attr); + } + MSG("none"); + ret = CMD_SUCCESS; + goto end; + } + + /* Mi tracker_id element */ + if (the_writer) { + /* Open tracker_id and targets elements */ + ret = mi_lttng_process_attribute_tracker_open( + the_writer, process_attr); + if (ret) { + goto end; + } + } + + for (i = 0; i < count; i++) { + const enum lttng_process_attr_value_type value_type = + lttng_process_attr_values_get_type_at_index( + values, i); + int64_t integral_value = INT64_MAX; + const char *name = "error"; + + if (i >= 1) { + _MSG(", "); + } + switch (value_type) { + case LTTNG_PROCESS_ATTR_VALUE_TYPE_PID: + { + pid_t pid; + + values_status = lttng_process_attr_values_get_pid_at_index( + values, i, &pid); + integral_value = (int64_t) pid; + break; + } + case LTTNG_PROCESS_ATTR_VALUE_TYPE_UID: + { + uid_t uid; + + values_status = lttng_process_attr_values_get_uid_at_index( + values, i, &uid); + integral_value = (int64_t) uid; + break; + } + case LTTNG_PROCESS_ATTR_VALUE_TYPE_GID: + { + gid_t gid; + + values_status = lttng_process_attr_values_get_gid_at_index( + values, i, &gid); + integral_value = (int64_t) gid; + break; + } + case LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME: + values_status = lttng_process_attr_values_get_user_name_at_index( + values, i, &name); + break; + case LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME: + values_status = lttng_process_attr_values_get_group_name_at_index( + values, i, &name); + break; + default: + ret = CMD_ERROR; + goto end; + } + + if (values_status != LTTNG_PROCESS_ATTR_VALUES_STATUS_OK) { + /* + * Not possible given the current liblttng-ctl + * implementation. + */ + ERR("Unknown error occurred while fetching process attribute value in inclusion list"); + ret = CMD_FATAL; + goto end; + } + + if (is_value_type_name(value_type)) { + _MSG("`%s`", name); + } else { + _MSG("%" PRIi64, integral_value); + } + + /* Mi */ + if (the_writer) { + ret = is_value_type_name(value_type) ? + mi_lttng_string_process_attribute_value( + the_writer, + process_attr, name, + false) : + mi_lttng_integral_process_attribute_value( + the_writer, + process_attr, + integral_value, false); + if (ret) { + goto end; + } + } + } + MSG(""); + + /* Mi close tracker_id and targets */ + if (the_writer) { + ret = mi_lttng_close_multi_element(the_writer, 2); + if (ret) { + goto end; + } + } +end: + lttng_process_attr_tracker_handle_destroy(tracker_handle); + return ret; +} + +/* + * List all trackers of a domain + */ +static int list_trackers(const struct lttng_domain *domain) +{ + int ret = 0; + + MSG("Tracked process attributes"); + /* Trackers listing */ + if (lttng_opt_mi) { + ret = mi_lttng_trackers_open(the_writer); + if (ret) { + goto end; + } + } + + switch (domain->type) { + case LTTNG_DOMAIN_KERNEL: + /* pid tracker */ + ret = list_process_attr_tracker(LTTNG_PROCESS_ATTR_PROCESS_ID); + if (ret) { + goto end; + } + /* vpid tracker */ + ret = list_process_attr_tracker( + LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID); + if (ret) { + goto end; + } + /* uid tracker */ + ret = list_process_attr_tracker(LTTNG_PROCESS_ATTR_USER_ID); + if (ret) { + goto end; + } + /* vuid tracker */ + ret = list_process_attr_tracker( + LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID); + if (ret) { + goto end; + } + /* gid tracker */ + ret = list_process_attr_tracker(LTTNG_PROCESS_ATTR_GROUP_ID); + if (ret) { + goto end; + } + /* vgid tracker */ + ret = list_process_attr_tracker( + LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID); + if (ret) { + goto end; + } + break; + case LTTNG_DOMAIN_UST: + /* vpid tracker */ + ret = list_process_attr_tracker( + LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID); + if (ret) { + goto end; + } + /* vuid tracker */ + ret = list_process_attr_tracker( + LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID); + if (ret) { + goto end; + } + /* vgid tracker */ + ret = list_process_attr_tracker( + LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID); + if (ret) { + goto end; + } + break; + default: + break; + } + MSG(); + if (lttng_opt_mi) { + /* Close trackers element */ + ret = mi_lttng_writer_close_element(the_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, USEC_UNIT); + 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(the_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(the_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(the_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 + * and print his informations. + */ +static int mi_list_session(const char *session_name, + struct lttng_session *sessions, int count) +{ + int ret, i; + unsigned int session_found = 0; + + if (session_name == NULL) { + ret = -LTTNG_ERR_SESS_NOT_FOUND; + goto end; + } + + for (i = 0; i < count; i++) { + if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) { + /* We need to leave it open to append other informations + * like domain, channel, events etc.*/ + session_found = 1; + ret = mi_lttng_session(the_writer, &sessions[i], 1); + if (ret) { + goto end; + } + break; + } + } + + if (!session_found) { + ERR("Session '%s' not found", session_name); ret = -LTTNG_ERR_SESS_NOT_FOUND; goto end; } @@ -1210,21 +2070,21 @@ static int mi_list_sessions(struct lttng_session *sessions, int count) int ret, i; /* Opening sessions element */ - ret = mi_lttng_sessions_open(writer); + ret = mi_lttng_sessions_open(the_writer); if (ret) { goto end; } /* Listing sessions */ for (i = 0; i < count; i++) { - ret = mi_lttng_session(writer, &sessions[i], 0); + ret = mi_lttng_session(the_writer, &sessions[i], 0); if (ret) { goto end; } } /* Closing sessions element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(the_writer); if (ret) { goto end; } @@ -1243,7 +2103,7 @@ static int list_sessions(const char *session_name) int ret = CMD_SUCCESS; int count, i; unsigned int session_found = 0; - struct lttng_session *sessions; + struct lttng_session *sessions = NULL; count = lttng_list_sessions(&sessions); DBG("Session count %d", count); @@ -1256,7 +2116,7 @@ static int list_sessions(const char *session_name) if (lttng_opt_mi) { /* Mi */ if (session_name == NULL) { - /* List all session */ + /* List all sessions */ ret = mi_list_sessions(sessions, count); } else { /* Note : this return an open session element */ @@ -1264,47 +2124,55 @@ static int list_sessions(const char *session_name) } if (ret) { ret = CMD_ERROR; - goto error; + goto end; } } else { /* Pretty print */ if (count == 0) { - MSG("Currently no available tracing session"); - ret = CMD_ERROR; + MSG("Currently no available recording session"); goto end; } if (session_name == NULL) { - MSG("Available tracing sessions:"); + MSG("Available recording sessions:"); } - for (i = 0; i < count; i++) { if (session_name != NULL) { if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) { session_found = 1; - MSG("Tracing session %s: [%s%s]", session_name, + MSG("Recording session %s: [%s%s]", session_name, active_string(sessions[i].enabled), snapshot_string(sessions[i].snapshot_mode)); - MSG("%sTrace path: %s\n", indent4, sessions[i].path); + if (*sessions[i].path) { + MSG("%sTrace output: %s\n", indent4, sessions[i].path); + } + memcpy(&the_listed_session, + &sessions[i], + sizeof(the_listed_session)); break; } } else { - MSG(" %d) %s (%s) [%s%s]", i + 1, - sessions[i].name, sessions[i].path, + MSG(" %d) %s [%s%s]", i + 1, + sessions[i].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); - break; + if (*sessions[i].path) { + MSG("%sTrace output: %s", indent4, sessions[i].path); + } + if (sessions[i].live_timer_interval != 0) { + MSG("%sLive timer interval: %u %s", indent4, + sessions[i].live_timer_interval, + USEC_UNIT); + } + MSG(""); } } if (!session_found && session_name != NULL) { ERR("Session '%s' not found", session_name); ret = CMD_ERROR; - goto error; + goto end; } if (session_name == NULL) { @@ -1312,9 +2180,8 @@ static int list_sessions(const char *session_name) } } -error: - free(sessions); end: + free(sessions); return ret; } @@ -1327,20 +2194,20 @@ static int mi_list_domains(struct lttng_domain *domains, int count) { int i, ret; /* Open domains element */ - ret = mi_lttng_domains_open(writer); + ret = mi_lttng_domains_open(the_writer); if (ret) { goto end; } for (i = 0; i < count; i++) { - ret = mi_lttng_domain(writer, &domains[i] , 0); + ret = mi_lttng_domain(the_writer, &domains[i], 0); if (ret) { goto end; } } /* Closing domains element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(the_writer); if (ret) { goto end; } @@ -1390,6 +2257,12 @@ static int list_domains(const char *session_name) case LTTNG_DOMAIN_JUL: MSG(" - JUL (Java Util Logging)"); break; + case LTTNG_DOMAIN_LOG4J: + MSG(" - LOG4j (Logging for Java)"); + break; + case LTTNG_DOMAIN_PYTHON: + MSG(" - Python (logging)"); + break; default: break; } @@ -1409,7 +2282,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; @@ -1417,7 +2290,6 @@ int cmd_list(int argc, const char **argv) memset(&domain, 0, sizeof(domain)); if (argc < 1) { - usage(stderr); ret = CMD_ERROR; goto end; } @@ -1428,7 +2300,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; @@ -1437,7 +2309,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; } @@ -1445,23 +2316,24 @@ int cmd_list(int argc, const char **argv) /* Mi check */ if (lttng_opt_mi) { - writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi); - if (!writer) { + the_writer = mi_lttng_writer_create( + fileno(stdout), lttng_opt_mi); + if (!the_writer) { ret = CMD_ERROR; goto end; } /* Open command element */ - ret = mi_lttng_writer_command_open(writer, - mi_lttng_element_command_list); + ret = mi_lttng_writer_command_open( + the_writer, mi_lttng_element_command_list); if (ret) { ret = CMD_ERROR; goto end; } /* Open output element */ - ret = mi_lttng_writer_open_element(writer, - mi_lttng_element_command_output); + ret = mi_lttng_writer_open_element( + the_writer, mi_lttng_element_command_output); if (ret) { ret = CMD_ERROR; goto end; @@ -1472,6 +2344,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) { @@ -1480,27 +2359,45 @@ int cmd_list(int argc, const char **argv) } else if (opt_jul) { DBG2("Listing JUL domain"); 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_userspace || opt_jul) { - handle = lttng_create_handle(session_name, &domain); - if (handle == NULL) { + if (!opt_kernel && opt_syscall) { + WARN("--syscall will only work with the Kernel domain (-k)"); + ret = CMD_ERROR; + goto end; + } + + if (opt_kernel || opt_userspace || opt_jul || opt_log4j || opt_python) { + the_handle = lttng_create_handle(session_name, &domain); + if (the_handle == NULL) { ret = CMD_FATAL; goto end; } } if (session_name == NULL) { - if (!opt_kernel && !opt_userspace && !opt_jul) { + if (!opt_kernel && !opt_userspace && !opt_jul && !opt_log4j + && !opt_python) { ret = list_sessions(NULL); if (ret) { goto end; } } if (opt_kernel) { - ret = list_kernel_events(); - if (ret) { - goto end; + if (opt_syscall) { + ret = list_syscalls(); + if (ret) { + goto end; + } + } else { + ret = list_kernel_events(); + if (ret) { + goto end; + } } } if (opt_userspace) { @@ -1513,8 +2410,8 @@ int cmd_list(int argc, const char **argv) goto end; } } - if (opt_jul) { - ret = list_jul_events(); + if (opt_jul || opt_log4j || opt_python) { + ret = list_agent_events(); if (ret) { goto end; } @@ -1524,7 +2421,7 @@ int cmd_list(int argc, const char **argv) if (lttng_opt_mi) { /* Open element sessions * Present for xml consistency */ - ret = mi_lttng_sessions_open(writer); + ret = mi_lttng_sessions_open(the_writer); if (ret) { goto end; } @@ -1535,6 +2432,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); @@ -1547,20 +2449,28 @@ int cmd_list(int argc, const char **argv) /* Add of domains and domain element for xml * consistency and validation */ - ret = mi_lttng_domains_open(writer); + ret = mi_lttng_domains_open(the_writer); if (ret) { goto end; } /* Open domain and leave it open for * nested channels printing */ - ret = mi_lttng_domain(writer, &domain, 1); + ret = mi_lttng_domain(the_writer, &domain, 1); if (ret) { goto end; } } + + /* Trackers */ + ret = list_trackers(&domain); + if (ret) { + goto end; + } + + /* Channels */ ret = list_channels(opt_channel); if (ret) { goto end; @@ -1568,7 +2478,8 @@ int cmd_list(int argc, const char **argv) if (lttng_opt_mi) { /* Close domain and domain element */ - ret = mi_lttng_close_multi_element(writer, 2); + ret = mi_lttng_close_multi_element( + the_writer, 2); } if (ret) { goto end; @@ -1587,7 +2498,7 @@ int cmd_list(int argc, const char **argv) } if (lttng_opt_mi) { - ret = mi_lttng_domains_open(writer); + ret = mi_lttng_domains_open(the_writer); if (ret) { ret = CMD_ERROR; goto end; @@ -1597,16 +2508,22 @@ int cmd_list(int argc, const char **argv) for (i = 0; i < nb_domain; i++) { switch (domains[i].type) { case LTTNG_DOMAIN_KERNEL: - MSG("=== Domain: Kernel ===\n"); + MSG("=== Domain: Linux kernel ===\n"); break; case LTTNG_DOMAIN_UST: - MSG("=== Domain: UST global ===\n"); - MSG("Buffer type: %s\n", + MSG("=== Domain: User space ===\n"); + MSG("Buffering scheme: %s\n", domains[i].buf_type == - LTTNG_BUFFER_PER_PID ? "per PID" : "per UID"); + LTTNG_BUFFER_PER_PID ? "per-process" : "per-user"); break; case LTTNG_DOMAIN_JUL: - MSG("=== Domain: JUL (Java Util Logging) ===\n"); + MSG("=== Domain: java.util.logging (JUL) ===\n"); + break; + case LTTNG_DOMAIN_LOG4J: + MSG("=== Domain: log4j ===\n"); + break; + case LTTNG_DOMAIN_PYTHON: + MSG("=== Domain: Python logging ===\n"); break; default: MSG("=== Domain: Unimplemented ===\n"); @@ -1614,7 +2531,8 @@ int cmd_list(int argc, const char **argv) } if (lttng_opt_mi) { - ret = mi_lttng_domain(writer, &domains[i], 1); + ret = mi_lttng_domain(the_writer, + &domains[i], 1); if (ret) { ret = CMD_ERROR; goto end; @@ -1622,22 +2540,38 @@ int cmd_list(int argc, const char **argv) } /* Clean handle before creating a new one */ - if (handle) { - lttng_destroy_handle(handle); + if (the_handle) { + lttng_destroy_handle(the_handle); } - handle = lttng_create_handle(session_name, &domains[i]); - if (handle == NULL) { + the_handle = lttng_create_handle( + session_name, &domains[i]); + if (the_handle == NULL) { ret = CMD_FATAL; goto end; } - if (domains[i].type == LTTNG_DOMAIN_JUL) { - ret = list_session_jul_events(); + if (domains[i].type == LTTNG_DOMAIN_JUL || + 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(&domains[i]); + if (ret) { + goto end; + } + break; + default: + break; } ret = list_channels(opt_channel); @@ -1645,9 +2579,11 @@ 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); + ret = mi_lttng_writer_close_element( + the_writer); if (ret) { ret = CMD_ERROR; goto end; @@ -1657,7 +2593,8 @@ int cmd_list(int argc, const char **argv) } if (lttng_opt_mi) { /* Close the domains, session and sessions element */ - ret = mi_lttng_close_multi_element(writer, 3); + ret = mi_lttng_close_multi_element( + the_writer, 3); if (ret) { ret = CMD_ERROR; goto end; @@ -1669,14 +2606,14 @@ int cmd_list(int argc, const char **argv) /* Mi closing */ if (lttng_opt_mi) { /* Close output element */ - ret = mi_lttng_writer_close_element(writer); + ret = mi_lttng_writer_close_element(the_writer); if (ret) { ret = CMD_ERROR; goto end; } /* Command element close */ - ret = mi_lttng_writer_command_close(writer); + ret = mi_lttng_writer_command_close(the_writer); if (ret) { ret = CMD_ERROR; goto end; @@ -1684,14 +2621,14 @@ int cmd_list(int argc, const char **argv) } end: /* Mi clean-up */ - if (writer && mi_lttng_writer_destroy(writer)) { + if (the_writer && mi_lttng_writer_destroy(the_writer)) { /* Preserve original error code */ ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL; } free(domains); - if (handle) { - lttng_destroy_handle(handle); + if (the_handle) { + lttng_destroy_handle(the_handle); } poptFreeContext(pc);