const char *indent6 = " ";
const char *indent8 = " ";
+#ifdef LTTNG_EMBED_HELP
+static const char help_msg[] =
+#include <lttng-list.1.h>
+;
+#endif
+
enum {
OPT_HELP = 1,
OPT_USERSPACE,
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},
{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.
*
int exclusion_count;
char *exclusion_msg = NULL;
char *at;
- int count;
size_t i;
const char * const exclusion_fmt = " [exclusions: ";
const size_t exclusion_fmt_len = strlen(exclusion_fmt);
}
/* Append exclusion name */
- count = sprintf(at, "%s", name);
- at += count;
+ at += sprintf(at, "%s", name);
}
/* This also puts a final '\0' at the end of exclusion_msg */
char *filter_msg = NULL;
char *exclusion_msg = NULL;
- ret = lttng_event_get_filter_string(event, &filter_str);
+ ret = lttng_event_get_filter_expression(event, &filter_str);
if (ret) {
filter_msg = strdup(" [failed to retrieve filter]");
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,
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) {
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) {
char *filter_msg = NULL;
struct lttng_event *event = &events[i];
- ret = lttng_event_get_filter_string(event, &filter_str);
+ ret = lttng_event_get_filter_expression(event,
+ &filter_str);
if (ret) {
filter_msg = strdup(" [failed to retrieve filter]");
} else if (filter_str) {
filter_msg = malloc(strlen(filter_str) +
strlen(filter_fmt) + 1);
if (filter_msg) {
- sprintf(filter_msg, " [filter: '%s']",
- filter_str);
+ sprintf(filter_msg, filter_fmt,
+ filter_str);
}
}
}
} else {
/* Pretty print */
- MSG("\n%sEvents:", indent4);
+ MSG("\n%sEvent rules:", indent4);
if (count == 0) {
MSG("%sNone\n", indent6);
goto end;
return ret;
}
+static
+void print_timer(const char *timer_name, uint32_t space_count, int64_t value)
+{
+ uint32_t i;
+
+ _MSG("%s%s:", indent6, timer_name);
+ for (i = 0; i < space_count; i++) {
+ _MSG(" ");
+ }
+
+ if (value) {
+ MSG("%" PRId64 " µs", value);
+ } else {
+ MSG("inactive");
+ }
+}
+
/*
* Pretty print channel
*/
static void print_channel(struct lttng_channel *channel)
{
- MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
+ int ret;
+ uint64_t discarded_events, lost_packets, monitor_timer_interval;
+ int64_t blocking_timeout;
+
+ ret = lttng_channel_get_discarded_event_count(channel,
+ &discarded_events);
+ if (ret) {
+ ERR("Failed to retrieve discarded event count of channel");
+ return;
+ }
+
+ ret = lttng_channel_get_lost_packet_count(channel,
+ &lost_packets);
+ if (ret) {
+ ERR("Failed to retrieve lost packet count of channel");
+ return;
+ }
+
+ ret = lttng_channel_get_monitor_timer_interval(channel,
+ &monitor_timer_interval);
+ if (ret) {
+ ERR("Failed to retrieve monitor interval of channel");
+ return;
+ }
+
+ ret = lttng_channel_get_blocking_timeout(channel,
+ &blocking_timeout);
+ if (ret) {
+ ERR("Failed to retrieve blocking timeout of channel");
+ return;
+ }
+ MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
MSG("%sAttributes:", indent4);
- MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
- MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
- MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
- MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
- MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
- MSG("%strace file count: %" PRIu64, indent6, channel->attr.tracefile_count);
- MSG("%strace file size (bytes): %" PRIu64, indent6, channel->attr.tracefile_size);
+ MSG("%sEvent-loss mode: %s", indent6, channel->attr.overwrite ? "overwrite" : "discard");
+ MSG("%sSub-buffer size: %" PRIu64 " bytes", indent6, channel->attr.subbuf_size);
+ MSG("%sSub-buffer count: %" PRIu64, indent6, channel->attr.num_subbuf);
+
+ print_timer("Switch timer", 5, channel->attr.switch_timer_interval);
+ print_timer("Read timer", 7, channel->attr.read_timer_interval);
+ print_timer("Monitor timer", 4, monitor_timer_interval);
+
+ if (!channel->attr.overwrite) {
+ if (blocking_timeout == -1) {
+ MSG("%sBlocking timeout: infinite", indent6);
+ } else {
+ MSG("%sBlocking timeout: %" PRId64 " µs", indent6, blocking_timeout);
+ }
+ }
+
+ MSG("%sTrace file count: %" PRIu64 " per stream", indent6,
+ channel->attr.tracefile_count == 0 ?
+ 1 : channel->attr.tracefile_count);
+ if (channel->attr.tracefile_size != 0 ) {
+ MSG("%sTrace file size: %" PRIu64 " bytes", indent6,
+ channel->attr.tracefile_size);
+ } else {
+ MSG("%sTrace file size: %s", indent6, "unlimited");
+ }
switch (channel->attr.output) {
case LTTNG_EVENT_SPLICE:
- MSG("%soutput: splice()", indent6);
+ MSG("%sOutput mode: splice", indent6);
break;
case LTTNG_EVENT_MMAP:
- MSG("%soutput: mmap()", indent6);
+ MSG("%sOutput mode: mmap", indent6);
break;
}
+
+ MSG("\n%sStatistics:", indent4);
+ if (listed_session.snapshot_mode) {
+ /*
+ * The lost packet count is omitted for sessions in snapshot
+ * mode as it is misleading: it would indicate the number of
+ * packets that the consumer could not extract during the
+ * course of recording the snapshot. It does not have the
+ * same meaning as the "regular" lost packet count that
+ * would result from the consumer not keeping up with
+ * event production in an overwrite-mode channel.
+ *
+ * A more interesting statistic would be the number of
+ * packets lost between the first and last extracted
+ * packets of a given snapshot (which prevents most analyses).
+ */
+ MSG("%sNone", indent6);
+ goto skip_stats_printing;
+ }
+
+ if (!channel->attr.overwrite) {
+ MSG("%sDiscarded events: %" PRIu64, indent6, discarded_events);
+ } else {
+ MSG("%sLost packets: %" PRIu64, indent6, lost_packets);
+ }
+skip_stats_printing:
+ return;
}
/*
return ret;
}
+/*
+ * List the rotate settings (timer/size if any).
+ */
+static int list_rotate_settings(const char *session_name)
+{
+ int ret;
+ uint64_t size, timer;
+
+ ret = lttng_rotation_schedule_get_timer_period(session_name, &timer);
+ if (ret) {
+ goto end;
+ }
+
+ ret = lttng_rotation_schedule_get_size(session_name, &size);
+ if (ret) {
+ goto end;
+ }
+
+ if (!timer && !size) {
+ ret = 0;
+ goto end;
+ }
+
+ _MSG("Automatic rotation schedule settings:\n");
+
+ if (timer) {
+ _MSG(" timer period: %" PRIu64" µs\n", timer);
+ if (lttng_opt_mi) {
+ ret = mi_lttng_writer_write_element_unsigned_int(writer,
+ config_element_rotation_timer_interval, timer);
+ if (ret) {
+ goto end;
+ }
+ }
+ }
+ if (size) {
+ _MSG(" size threshold: %" PRIu64" bytes\n", size);
+ if (lttng_opt_mi) {
+ ret = mi_lttng_writer_write_element_unsigned_int(writer,
+ config_element_rotation_size, size);
+ if (ret) {
+ goto end;
+ }
+ }
+ }
+ _MSG("\n");
+
+end:
+ return ret;
+}
+
/*
* Machine interface
* Find the session with session_name as name
active_string(sessions[i].enabled),
snapshot_string(sessions[i].snapshot_mode));
MSG("%sTrace path: %s\n", indent4, sessions[i].path);
+ memcpy(&listed_session, &sessions[i],
+ sizeof(listed_session));
break;
}
} else {
snapshot_string(sessions[i].snapshot_mode));
MSG("%sTrace path: %s", indent4, sessions[i].path);
if (sessions[i].live_timer_interval != 0) {
- MSG("%sLive timer interval (usec): %u", indent4,
+ MSG("%sLive timer interval: %u µs", indent4,
sessions[i].live_timer_interval);
}
MSG("");
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;
memset(&domain, 0, sizeof(domain));
if (argc < 1) {
- usage(stderr);
ret = CMD_ERROR;
goto end;
}
while ((opt = poptGetNextOpt(pc)) != -1) {
switch (opt) {
case OPT_HELP:
- usage(stdout);
+ SHOW_HELP();
goto end;
case OPT_USERSPACE:
opt_userspace = 1;
list_cmd_options(stdout, long_options);
goto end;
default:
- usage(stderr);
ret = CMD_UNDEFINED;
goto end;
}
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) {
goto end;
}
+ ret = list_rotate_settings(session_name);
+ if (ret) {
+ goto end;
+ }
+
/* Domain listing */
if (opt_domain) {
ret = list_domains(session_name);