X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng%2Fcommands%2Flist.c;h=334d4daf1f6bf02d8d77084e10d8ccbdacddfc53;hp=1eac93487a12604edb9095edb42e3ee53f08cf65;hb=ac41e67e39946acd97752ce52b964976890c5e87;hpb=fae9a062a468c47fc71ef7aa96374bf9d87d137e diff --git a/src/bin/lttng/commands/list.c b/src/bin/lttng/commands/list.c index 1eac93487..334d4daf1 100644 --- a/src/bin/lttng/commands/list.c +++ b/src/bin/lttng/commands/list.c @@ -1,21 +1,10 @@ /* - * Copyright (C) 2011 - David Goulet + * Copyright (C) 2011 David Goulet * - * 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 #define _LGPL_SOURCE #include #include @@ -25,7 +14,9 @@ #include #include +#include #include +#include #include "../command.h" @@ -43,6 +34,12 @@ 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, @@ -52,6 +49,9 @@ 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}, @@ -68,34 +68,6 @@ static struct poptOption long_options[] = { {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, " -p, --python Apply for Python application using logging\n"); - fprintf(ofp, " -f, --fields List event fields.\n"); - fprintf(ofp, " --syscall List available system calls.\n"); - 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. * @@ -167,21 +139,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) @@ -213,11 +173,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: { @@ -229,22 +358,22 @@ static void print_events(struct lttng_event *event) 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 { @@ -255,7 +384,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 { @@ -263,28 +392,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) @@ -340,7 +478,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; @@ -349,7 +487,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; @@ -408,8 +546,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; @@ -421,6 +559,10 @@ static int list_agent_events(void) 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); @@ -489,7 +631,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; @@ -561,6 +703,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) { @@ -583,7 +727,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) { @@ -981,11 +1124,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, - handle->domain.type)); + 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(""); @@ -1049,7 +1224,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; @@ -1067,29 +1242,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 (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; } /* @@ -1234,34 +1503,362 @@ error_channels: return ret; } +static const char *get_tracker_str(enum lttng_tracker_type tracker_type) +{ + switch (tracker_type) { + case LTTNG_TRACKER_PID: + return "PID"; + case LTTNG_TRACKER_VPID: + return "VPID"; + case LTTNG_TRACKER_UID: + return "UID"; + case LTTNG_TRACKER_VUID: + return "VUID"; + case LTTNG_TRACKER_GID: + return "GID"; + case LTTNG_TRACKER_VGID: + return "VGID"; + } + return NULL; +} + /* - * List tracker PID(s) of session and domain. + * List tracker ID(s) of session and domain. */ -static int list_tracker_pids(void) +static int list_tracker_ids(enum lttng_tracker_type tracker_type) { - int enabled, ret; - int *pids = NULL; - size_t nr_pids; - - ret = lttng_list_tracker_pids(handle, - &enabled, &pids, &nr_pids); + int ret = 0; + int enabled = 1; + struct lttng_tracker_ids *ids = NULL; + unsigned int nr_ids, i; + const struct lttng_tracker_id *id; + enum lttng_tracker_id_status status; + + ret = lttng_list_tracker_ids(handle, tracker_type, &ids); if (ret) { return ret; } + + status = lttng_tracker_ids_get_count(ids, &nr_ids); + if (status != LTTNG_TRACKER_ID_STATUS_OK) { + ret = CMD_ERROR; + goto end; + } + + if (nr_ids == 1) { + id = lttng_tracker_ids_get_at_index(ids, 0); + if (id && lttng_tracker_id_get_type(id) == LTTNG_ID_ALL) { + enabled = 0; + } + } + if (enabled) { - int i; - _MSG("PID tracker: ["); + _MSG("%s tracker: [", get_tracker_str(tracker_type)); + + /* Mi tracker_id element */ + if (writer) { + /* Open tracker_id and targets elements */ + ret = mi_lttng_id_tracker_open(writer, tracker_type); + if (ret) { + goto end; + } + } + + for (i = 0; i < nr_ids; i++) { + enum lttng_tracker_id_status status = + LTTNG_TRACKER_ID_STATUS_OK; + int value; + const char *value_string; + + id = lttng_tracker_ids_get_at_index(ids, i); + if (!id) { + ret = CMD_ERROR; + goto end; + } + + switch (lttng_tracker_id_get_type(id)) { + case LTTNG_ID_ALL: + break; + case LTTNG_ID_VALUE: + status = lttng_tracker_id_get_value(id, &value); + break; + case LTTNG_ID_STRING: + status = lttng_tracker_id_get_string( + id, &value_string); + break; + case LTTNG_ID_UNKNOWN: + ret = CMD_ERROR; + goto end; + } + + if (status != LTTNG_TRACKER_ID_STATUS_OK) { + ERR("Invalid state for tracker id"); + ret = CMD_ERROR; + goto end; + } - for (i = 0; i < nr_pids; i++) { if (i) { _MSG(","); } - _MSG(" %d", pids[i]); + switch (lttng_tracker_id_get_type(id)) { + case LTTNG_ID_ALL: + _MSG(" *"); + break; + case LTTNG_ID_VALUE: + _MSG(" %d", value); + break; + case LTTNG_ID_STRING: + _MSG(" %s", value_string); + break; + case LTTNG_ID_UNKNOWN: + ERR("Invalid state for tracker id"); + ret = CMD_ERROR; + goto end; + } + + /* Mi */ + if (writer) { + ret = mi_lttng_id_target( + writer, tracker_type, id, 0); + if (ret) { + goto end; + } + } } _MSG(" ]\n\n"); + + /* Mi close tracker_id and targets */ + if (writer) { + ret = mi_lttng_close_multi_element(writer, 2); + if (ret) { + goto end; + } + } } - free(pids); - return 0; +end: + lttng_tracker_ids_destroy(ids); + return ret; +} + +/* + * List all trackers of a domain + */ +static int list_trackers(const struct lttng_domain *domain) +{ + int ret = 0; + + /* Trackers listing */ + if (lttng_opt_mi) { + ret = mi_lttng_trackers_open(writer); + if (ret) { + goto end; + } + } + + switch (domain->type) { + case LTTNG_DOMAIN_KERNEL: + /* pid tracker */ + ret = list_tracker_ids(LTTNG_TRACKER_PID); + if (ret) { + goto end; + } + /* vpid tracker */ + ret = list_tracker_ids(LTTNG_TRACKER_VPID); + if (ret) { + goto end; + } + /* uid tracker */ + ret = list_tracker_ids(LTTNG_TRACKER_UID); + if (ret) { + goto end; + } + /* vuid tracker */ + ret = list_tracker_ids(LTTNG_TRACKER_VUID); + if (ret) { + goto end; + } + /* gid tracker */ + ret = list_tracker_ids(LTTNG_TRACKER_GID); + if (ret) { + goto end; + } + /* vgid tracker */ + ret = list_tracker_ids(LTTNG_TRACKER_VGID); + if (ret) { + goto end; + } + break; + case LTTNG_DOMAIN_UST: + /* vpid tracker */ + ret = list_tracker_ids(LTTNG_TRACKER_VPID); + if (ret) { + goto end; + } + /* vuid tracker */ + ret = list_tracker_ids(LTTNG_TRACKER_VUID); + if (ret) { + goto end; + } + /* vgid tracker */ + ret = list_tracker_ids(LTTNG_TRACKER_VGID); + if (ret) { + goto end; + } + break; + default: + break; + } + 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, 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(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; } /* @@ -1345,7 +1942,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); @@ -1358,7 +1955,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 */ @@ -1366,7 +1963,7 @@ static int list_sessions(const char *session_name) } if (ret) { ret = CMD_ERROR; - goto error; + goto end; } } else { /* Pretty print */ @@ -1379,7 +1976,6 @@ static int list_sessions(const char *session_name) MSG("Available tracing sessions:"); } - for (i = 0; i < count; i++) { if (session_name != NULL) { if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) { @@ -1387,18 +1983,25 @@ static int list_sessions(const char *session_name) MSG("Tracing 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(&listed_session, &sessions[i], + sizeof(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); + if (*sessions[i].path) { + MSG("%sTrace output: %s", indent4, sessions[i].path); + } if (sessions[i].live_timer_interval != 0) { - MSG("%sLive timer interval (usec): %u", indent4, - sessions[i].live_timer_interval); + MSG("%sLive timer interval: %u %s", indent4, + sessions[i].live_timer_interval, + USEC_UNIT); } MSG(""); } @@ -1407,7 +2010,7 @@ static int list_sessions(const char *session_name) if (!session_found && session_name != NULL) { ERR("Session '%s' not found", session_name); ret = CMD_ERROR; - goto error; + goto end; } if (session_name == NULL) { @@ -1415,9 +2018,8 @@ static int list_sessions(const char *session_name) } } -error: - free(sessions); end: + free(sessions); return ret; } @@ -1518,7 +2120,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; @@ -1526,7 +2128,6 @@ int cmd_list(int argc, const char **argv) memset(&domain, 0, sizeof(domain)); if (argc < 1) { - usage(stderr); ret = CMD_ERROR; goto end; } @@ -1537,7 +2138,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; @@ -1546,7 +2147,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; } @@ -1581,6 +2181,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) { @@ -1662,6 +2269,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); @@ -1688,11 +2300,14 @@ int cmd_list(int argc, const char **argv) } - ret = list_tracker_pids(); + + /* Trackers */ + ret = list_trackers(&domain); if (ret) { goto end; } + /* Channels */ ret = list_channels(opt_channel); if (ret) { goto end; @@ -1729,22 +2344,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 (Logging for Java) ===\n"); + MSG("=== Domain: log4j ===\n"); break; case LTTNG_DOMAIN_PYTHON: - MSG("=== Domain: Python (logging) ===\n"); + MSG("=== Domain: Python logging ===\n"); break; default: MSG("=== Domain: Unimplemented ===\n"); @@ -1777,13 +2392,14 @@ int cmd_list(int argc, const char **argv) if (ret) { goto end; } - continue; + + goto next_domain; } switch (domains[i].type) { case LTTNG_DOMAIN_KERNEL: case LTTNG_DOMAIN_UST: - ret = list_tracker_pids(); + ret = list_trackers(&domains[i]); if (ret) { goto end; } @@ -1797,6 +2413,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);