* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#define _GNU_SOURCE
#define _LGPL_SOURCE
#include <inttypes.h>
#include <popt.h>
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.
*
}
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)
}
}
+/*
+ * 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;
+}
+
/*
* 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:
{
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 {
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 {
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:
/* 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)
goto end;
}
- /* Open pids element */
+ /* Open pids element element */
ret = mi_lttng_pids_open(writer);
if (ret) {
goto end;
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;
{
int i, size, ret = CMD_SUCCESS;
struct lttng_domain domain;
- struct lttng_handle *handle;
+ struct lttng_handle *handle = NULL;
struct lttng_event *event_list = NULL;
pid_t cur_pid = 0;
char *cmdline = NULL;
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);
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;
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) {
}
}
- /* Close pids, domain, domains */
+ /* Close pid, domain, domains */
ret = mi_lttng_close_multi_element(writer, 3);
end:
return ret;
}
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("");
}
} 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;
}
/*
*/
static int list_tracker_pids(void)
{
- int enabled, ret;
+ int ret = 0;
+ int enabled;
int *pids = NULL;
size_t nr_pids;
int i;
_MSG("PID tracker: [");
+ /* Mi tracker_pid element*/
+ if (writer) {
+ /* Open tracker_pid and targets elements */
+ ret = mi_lttng_pid_tracker_open(writer);
+ if (ret) {
+ goto end;
+ }
+ }
+
for (i = 0; i < nr_pids; i++) {
if (i) {
_MSG(",");
}
_MSG(" %d", pids[i]);
+
+ /* Mi */
+ if (writer) {
+ ret = mi_lttng_pid_target(writer, pids[i], 0);
+ if (ret) {
+ goto end;
+ }
+ }
}
_MSG(" ]\n\n");
+
+ /* Mi close tracker_pid and targets */
+ if (writer) {
+ ret = mi_lttng_close_multi_element(writer,2);
+ if (ret) {
+ goto end;
+ }
+ }
}
+end:
free(pids);
- return 0;
+ return ret;
+
+}
+
+/*
+ * List all tracker of a domain
+ */
+static int list_trackers(void)
+{
+ int ret;
+
+ /* Trackers listing */
+ if (lttng_opt_mi) {
+ ret = mi_lttng_trackers_open(writer);
+ if (ret) {
+ goto end;
+ }
+ }
+
+ /* pid tracker */
+ ret = list_tracker_pids();
+ if (ret) {
+ goto end;
+ }
+
+ if (lttng_opt_mi) {
+ /* Close trackers element */
+ ret = mi_lttng_writer_close_element(writer);
+ if (ret) {
+ goto end;
+ }
+ }
+
+end:
+ return ret;
+}
+
+/*
+ * 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;
}
/*
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);
}
- ret = list_tracker_pids();
+
+ /* Trackers */
+ ret = list_trackers();
if (ret) {
goto end;
}
+ /* Channels */
ret = list_channels(opt_channel);
if (ret) {
goto end;
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();
if (ret) {
goto end;
}
goto end;
}
+next_domain:
if (lttng_opt_mi) {
/* Close domain element */
ret = mi_lttng_writer_close_element(writer);