[lttng-tools.git] / src / bin / lttng / commands / list.c

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; only version 2
 * of the License.
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#define _GNU_SOURCE
#include <inttypes.h>
#include <popt.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>

#include "../command.h"

static int opt_userspace;
static int opt_kernel;
static char *opt_channel;
static int opt_domain;
#if 0
/* Not implemented yet */
static char *opt_cmd_name;
static pid_t opt_pid;
#endif

const char *indent4 = "    ";
const char *indent6 = "      ";
const char *indent8 = "        ";

enum {
	OPT_HELP = 1,
	OPT_USERSPACE,
	OPT_LIST_OPTIONS,
};

static struct lttng_handle *handle;

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},
#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},
	{"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 [<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");
#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.
 *
 * On success, return an allocated string pointer to the proc cmdline.
 * On error, return NULL.
 */
static char *get_cmdline_by_pid(pid_t pid)
{
	int ret;
	FILE *fp;
	char *cmdline = NULL;
	char path[24];	/* Can't go bigger than /proc/65535/cmdline */

	snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
	fp = fopen(path, "r");
	if (fp == NULL) {
		goto end;
	}

	/* Caller must free() *cmdline */
	cmdline = malloc(PATH_MAX);
	ret = fread(cmdline, 1, PATH_MAX, fp);
	if (ret < 0) {
		perror("fread proc list");
	}
	fclose(fp);

end:
	return cmdline;
}

static
const char *active_string(int value)
{
	switch (value) {
	case 0:	return " [inactive]";
	case 1: return " [active]";
	case -1: return "";
	default: return NULL;
	}
}

static
const char *enabled_string(int value)
{
	switch (value) {
	case 0:	return " [disabled]";
	case 1: return " [enabled]";
	case -1: return "";
	default: return NULL;
	}
}

static
const char *loglevel_string_pre(int loglevel)
{
	if (loglevel == -1) {
		return "";
	} else {
		return " (loglevel: ";
	}
}

static
const char *loglevel_string_post(int loglevel)
{
	if (loglevel == -1) {
		return "";
	} else {
		return ")";
	}
}

static const char *loglevel_string(int value)
{
	switch (value) {
	case -1: return "";
	case 0: return "TRACE_EMERG";
	case 1: return "TRACE_ALERT";
	case 2: return "TRACE_CRIT";
	case 3: return "TRACE_ERR";
	case 4: return "TRACE_WARNING";
	case 5: return "TRACE_NOTICE";
	case 6: return "TRACE_INFO";
	case 7: return "TRACE_SYSTEM";
	case 8: return "TRACE_PROGRAM";
	case 9: return "TRACE_PROCESS";
	case 10: return "TRACE_MODULE";
	case 11: return "TRACE_UNIT";
	case 12: return "TRACE_FUNCTION";
	case 13: return "TRACE_DEFAULT";
	case 14: return "TRACE_VERBOSE";
	case 15: return "TRACE_DEBUG";
	default: return "<<UNKNOWN>>";
	}
}

/*
 * Pretty print single event.
 */
static void print_events(struct lttng_event *event)
{
	switch (event->type) {
	case LTTNG_EVENT_TRACEPOINT:
	{
		MSG("%s%s%s%s%s (type: tracepoint)%s", indent6,
				event->name,
				loglevel_string_pre(event->loglevel),
				loglevel_string(event->loglevel),
				loglevel_string_post(event->loglevel),
				enabled_string(event->enabled));
		break;
	}
	case LTTNG_EVENT_PROBE:
		MSG("%s%s (type: probe)%s", indent6,
				event->name, enabled_string(event->enabled));
		if (event->attr.probe.addr != 0) {
			MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
		} else {
			MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
			MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
		}
		break;
	case LTTNG_EVENT_FUNCTION:
	case LTTNG_EVENT_FUNCTION_ENTRY:
		MSG("%s%s (type: function)%s", indent6,
				event->name, enabled_string(event->enabled));
		MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
		break;
	case LTTNG_EVENT_SYSCALL:
		MSG("%s (type: syscall)%s", indent6,
				enabled_string(event->enabled));
		break;
	case LTTNG_EVENT_NOOP:
		MSG("%s (type: noop)%s", indent6,
				enabled_string(event->enabled));
		break;
	case LTTNG_EVENT_ALL:
		/* We should never have "all" events in list. */
		assert(0);
		break;
	}
}

/*
 * Ask session daemon for all user space tracepoints available.
 */
static int list_ust_events(void)
{
	int i, size;
	struct lttng_domain domain;
	struct lttng_handle *handle;
	struct lttng_event *event_list;
	pid_t cur_pid = 0;

	DBG("Getting UST tracing events");

	domain.type = LTTNG_DOMAIN_UST;

	handle = lttng_create_handle(NULL, &domain);
	if (handle == NULL) {
		goto error;
	}

	size = lttng_list_tracepoints(handle, &event_list);
	if (size < 0) {
		ERR("Unable to list UST events");
		return size;
	}

	MSG("UST events:\n-------------");

	if (size == 0) {
		MSG("None");
	}

	for (i = 0; i < size; i++) {
		if (cur_pid != event_list[i].pid) {
			cur_pid = event_list[i].pid;
			MSG("\nPID: %d - Name: %s", cur_pid, get_cmdline_by_pid(cur_pid));
		}
		print_events(&event_list[i]);
	}

	MSG("");

	free(event_list);

	return CMD_SUCCESS;

error:
	return -1;
}

/*
 * Ask for all trace events in the kernel and pretty print them.
 */
static int list_kernel_events(void)
{
	int i, size;
	struct lttng_domain domain;
	struct lttng_handle *handle;
	struct lttng_event *event_list;

	DBG("Getting kernel tracing events");

	domain.type = LTTNG_DOMAIN_KERNEL;

	handle = lttng_create_handle(NULL, &domain);
	if (handle == NULL) {
		goto error;
	}

	size = lttng_list_tracepoints(handle, &event_list);
	if (size < 0) {
		ERR("Unable to list kernel events");
		return size;
	}

	MSG("Kernel events:\n-------------");

	for (i = 0; i < size; i++) {
		print_events(&event_list[i]);
	}

	MSG("");

	free(event_list);

	return CMD_SUCCESS;

error:
	return -1;
}

/*
 * List events of channel of session and domain.
 */
static int list_events(const char *channel_name)
{
	int ret, count, i;
	struct lttng_event *events = NULL;

	count = lttng_list_events(handle, channel_name, &events);
	if (count < 0) {
		ret = count;
		goto error;
	}

	MSG("\n%sEvents:", indent4);
	if (count == 0) {
		MSG("%sNone\n", indent6);
		goto end;
	}

	for (i = 0; i < count; i++) {
		print_events(&events[i]);
	}

	MSG("");

end:
	if (events) {
		free(events);
	}
	ret = CMD_SUCCESS;

error:
	return ret;
}

/*
 * Pretty print channel
 */
static void print_channel(struct lttng_channel *channel)
{
	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);
	switch (channel->attr.output) {
		case LTTNG_EVENT_SPLICE:
			MSG("%soutput: splice()", indent6);
			break;
		case LTTNG_EVENT_MMAP:
			MSG("%soutput: mmap()", indent6);
			break;
	}
}

/*
 * List channel(s) of session and domain.
 *
 * If channel_name is NULL, all channels are listed.
 */
static int list_channels(const char *channel_name)
{
	int count, i, ret = CMD_SUCCESS;
	unsigned int chan_found = 0;
	struct lttng_channel *channels = NULL;

	DBG("Listing channel(s) (%s)", channel_name ? : "<all>");

	count = lttng_list_channels(handle, &channels);
	if (count < 0) {
		ret = count;
		goto error_channels;
	} else if (count == 0) {
		ERR("Channel %s not found", channel_name);
		goto error;
	}

	if (channel_name == NULL) {
		MSG("Channels:\n-------------");
	}

	for (i = 0; i < count; i++) {
		if (channel_name != NULL) {
			if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
				chan_found = 1;
			} else {
				continue;
			}
		}
		print_channel(&channels[i]);

		/* Listing events per channel */
		ret = list_events(channels[i].name);
		if (ret < 0) {
			MSG("%s", lttng_strerror(ret));
		}

		if (chan_found) {
			break;
		}
	}

	if (!chan_found && channel_name != NULL) {
		ERR("Channel %s not found", channel_name);
		goto error;
	}

	ret = CMD_SUCCESS;

error:
	free(channels);

error_channels:
	return ret;
}

/*
 * List available tracing session. List only basic information.
 *
 * If session_name is NULL, all sessions are listed.
 */
static int list_sessions(const char *session_name)
{
	int ret, count, i;
	unsigned int session_found = 0;
	struct lttng_session *sessions;

	count = lttng_list_sessions(&sessions);
	DBG("Session count %d", count);
	if (count < 0) {
		ret = count;
		goto error;
	}

	if (session_name == NULL) {
		MSG("Available tracing 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", session_name, active_string(sessions[i].enabled));
				MSG("%sTrace path: %s\n", indent4, sessions[i].path);
				break;
			}
			continue;
		}

		MSG("  %d) %s (%s)%s", i + 1, sessions[i].name, sessions[i].path,
				active_string(sessions[i].enabled));

		if (session_found) {
			break;
		}
	}

	free(sessions);

	if (!session_found && session_name != NULL) {
		ERR("Session '%s' not found", session_name);
		ret = CMD_ERROR;
		goto error;
	}

	if (session_name == NULL) {
		MSG("\nUse lttng list <session_name> for more details");
	}

	return CMD_SUCCESS;

error:
	return ret;
}

/*
 * List available domain(s) for a session.
 */
static int list_domains(const char *session_name)
{
	int i, count, ret = CMD_SUCCESS;
	struct lttng_domain *domains = NULL;

	MSG("Domains:\n-------------");

	count = lttng_list_domains(session_name, &domains);
	if (count < 0) {
		ret = count;
		goto error;
	} else if (count == 0) {
		MSG("  None");
		goto end;
	}

	for (i = 0; i < count; i++) {
		switch (domains[i].type) {
		case LTTNG_DOMAIN_KERNEL:
			MSG("  - Kernel");
			break;
		case LTTNG_DOMAIN_UST:
			MSG("  - UST global");
			break;
		default:
			break;
		}
	}

end:
	free(domains);

error:
	return ret;
}

/*
 * The 'list <options>' first level command
 */
int cmd_list(int argc, const char **argv)
{
	int opt, i, ret = CMD_SUCCESS;
	int nb_domain;
	const char *session_name;
	static poptContext pc;
	struct lttng_domain domain;
	struct lttng_domain *domains = NULL;

	if (argc < 1) {
		usage(stderr);
		ret = CMD_ERROR;
		goto end;
	}

	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	poptReadDefaultConfig(pc, 0);

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
		case OPT_HELP:
			usage(stdout);
			goto end;
		case OPT_USERSPACE:
			opt_userspace = 1;
			break;
		case OPT_LIST_OPTIONS:
			list_cmd_options(stdout, long_options);
			goto end;
		default:
			usage(stderr);
			ret = CMD_UNDEFINED;
			goto end;
		}
	}

	/* Get session name (trailing argument) */
	session_name = poptGetArg(pc);
	DBG2("Session name: %s", session_name);

	if (opt_kernel) {
		domain.type = LTTNG_DOMAIN_KERNEL;
	} else if (opt_userspace) {
		DBG2("Listing userspace global domain");
		domain.type = LTTNG_DOMAIN_UST;
	}

	handle = lttng_create_handle(session_name, &domain);
	if (handle == NULL) {
		ret = CMD_FATAL;
		goto end;
	}

	if (session_name == NULL) {
		if (!opt_kernel && !opt_userspace) {
			ret = list_sessions(NULL);
			if (ret != 0) {
				goto end;
			}
		}
		if (opt_kernel) {
			ret = list_kernel_events();
			if (ret < 0) {
				goto end;
			}
		}
		if (opt_userspace) {
			ret = list_ust_events();
			if (ret < 0) {
				goto end;
			}
		}
	} else {
		/* List session attributes */
		ret = list_sessions(session_name);
		if (ret != 0) {
			goto end;
		}

		/* Domain listing */
		if (opt_domain) {
			ret = list_domains(session_name);
			goto end;
		}

		if (opt_kernel) {
			/* Channel listing */
			ret = list_channels(opt_channel);
			if (ret < 0) {
				goto end;
			}
		} else {
			/* We want all domain(s) */
			nb_domain = lttng_list_domains(session_name, &domains);
			if (nb_domain < 0) {
				ret = nb_domain;
				goto end;
			}

			for (i = 0; i < nb_domain; i++) {
				switch (domains[i].type) {
				case LTTNG_DOMAIN_KERNEL:
					MSG("=== Domain: Kernel ===\n");
					break;
				case LTTNG_DOMAIN_UST:
					MSG("=== Domain: UST global ===\n");
					break;
				default:
					MSG("=== Domain: Unimplemented ===\n");
					break;
				}

				/* Clean handle before creating a new one */
				lttng_destroy_handle(handle);

				handle = lttng_create_handle(session_name, &domains[i]);
				if (handle == NULL) {
					ret = CMD_FATAL;
					goto end;
				}

				ret = list_channels(opt_channel);
				if (ret < 0) {
					goto end;
				}
			}
		}
	}

end:
	if (domains) {
		free(domains);
	}
	lttng_destroy_handle(handle);

	poptFreeContext(pc);
	return ret;
}
Commit	Line	Data
f3ed775e DG	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License
82a3637f DG	6	* as published by the Free Software Foundation; only version 2
82a3637f DG	7	* of the License.
f3ed775e DG	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	17	*/
	18
	19	#define _GNU_SOURCE
9f19cc17	20	#include <inttypes.h>
f3ed775e DG	21	#include <popt.h>
	22	#include <stdio.h>
	23	#include <stdlib.h>
	24	#include <string.h>
7a3d1328	25	#include <assert.h>
f3ed775e	26
c399183f	27	#include "../command.h"
f3ed775e	28
9f19cc17 DG	29	static int opt_userspace;
	30	static int opt_kernel;
	31	static char *opt_channel;
	32	static int opt_domain;
d78d6610 DG	33	#if 0
	34	/* Not implemented yet */
	35	static char *opt_cmd_name;
	36	static pid_t opt_pid;
	37	#endif
9f19cc17 DG	38
	39	const char *indent4 = " ";
	40	const char *indent6 = " ";
	41	const char *indent8 = " ";
f3ed775e DG	42
	43	enum {
	44	OPT_HELP = 1,
eeac7d46	45	OPT_USERSPACE,
679b4943	46	OPT_LIST_OPTIONS,
f3ed775e DG	47	};
f3ed775e DG	48
cd80958d DG	49	static struct lttng_handle *handle;
cd80958d DG	50
f3ed775e DG	51	static struct poptOption long_options[] = {
	52	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	53	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
9f19cc17	54	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610 DG	55	#if 0
	56	/* Not implemented yet */
	57	{"userspace", 'u', POPT_ARG_STRING \| POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
	58	{"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	59	#else
	60	{"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
	61	#endif
9f19cc17 DG	62	{"channel", 'c', POPT_ARG_STRING, &opt_channel, 0, 0, 0},
9f19cc17 DG	63	{"domain", 'd', POPT_ARG_VAL, &opt_domain, 1, 0, 0},
679b4943	64	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
f3ed775e DG	65	{0, 0, 0, 0, 0, 0, 0}
	66	};
	67
	68	/*
	69	* usage
	70	*/
	71	static void usage(FILE *ofp)
	72	{
27221701	73	fprintf(ofp, "usage: lttng list [OPTIONS] [SESSION [<OPTIONS>]]\n");
9f19cc17 DG	74	fprintf(ofp, "\n");
	75	fprintf(ofp, "With no arguments, list available tracing session(s)\n");
	76	fprintf(ofp, "\n");
27221701 DG	77	fprintf(ofp, "Without a session, -k lists available kernel events\n");
27221701 DG	78	fprintf(ofp, "Without a session, -u lists available userspace events\n");
9f19cc17 DG	79	fprintf(ofp, "\n");
9f19cc17 DG	80	fprintf(ofp, " -h, --help Show this help\n");
27221701	81	fprintf(ofp, " --list-options Simple listing of options\n");
9f19cc17 DG	82	fprintf(ofp, " -k, --kernel Select kernel domain\n");
9f19cc17 DG	83	fprintf(ofp, " -u, --userspace Select user-space domain.\n");
d78d6610	84	#if 0
9f19cc17	85	fprintf(ofp, " -p, --pid PID List user-space events by PID\n");
d78d6610	86	#endif
f3ed775e	87	fprintf(ofp, "\n");
27221701	88	fprintf(ofp, "Session Options:\n");
9f19cc17 DG	89	fprintf(ofp, " -c, --channel NAME List details of a channel\n");
9f19cc17 DG	90	fprintf(ofp, " -d, --domain List available domain(s)\n");
f3ed775e DG	91	fprintf(ofp, "\n");
	92	}
	93
	94	/*
9f19cc17	95	* Get command line from /proc for a specific pid.
f3ed775e	96	*
9f19cc17 DG	97	* On success, return an allocated string pointer to the proc cmdline.
9f19cc17 DG	98	* On error, return NULL.
f3ed775e DG	99	*/
	100	static char *get_cmdline_by_pid(pid_t pid)
	101	{
	102	int ret;
	103	FILE *fp;
	104	char *cmdline = NULL;
	105	char path[24]; /* Can't go bigger than /proc/65535/cmdline */
	106
	107	snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
	108	fp = fopen(path, "r");
	109	if (fp == NULL) {
	110	goto end;
	111	}
	112
	113	/* Caller must free() cmdline /
	114	cmdline = malloc(PATH_MAX);
	115	ret = fread(cmdline, 1, PATH_MAX, fp);
f40799e8 DG	116	if (ret < 0) {
	117	perror("fread proc list");
	118	}
f3ed775e DG	119	fclose(fp);
	120
	121	end:
	122	return cmdline;
	123	}
b551a063	124
464dd62d MD	125	static
	126	const char *active_string(int value)
	127	{
	128	switch (value) {
b09f0429 MD	129	case 0: return " [inactive]";
b09f0429 MD	130	case 1: return " [active]";
464dd62d MD	131	case -1: return "";
	132	default: return NULL;
	133	}
	134	}
	135
	136	static
	137	const char *enabled_string(int value)
	138	{
	139	switch (value) {
b09f0429 MD	140	case 0: return " [disabled]";
b09f0429 MD	141	case 1: return " [enabled]";
464dd62d MD	142	case -1: return "";
	143	default: return NULL;
	144	}
	145	}
	146
81afa345	147	static
8005f29a	148	const char *loglevel_string_pre(int loglevel)
81afa345	149	{
8005f29a	150	if (loglevel == -1) {
81afa345	151	return "";
e4baff1e	152	} else {
81afa345	153	return " (loglevel: ";
e4baff1e	154	}
81afa345 MD	155	}
	156
	157	static
8005f29a	158	const char *loglevel_string_post(int loglevel)
81afa345	159	{
8005f29a	160	if (loglevel == -1) {
81afa345	161	return "";
e4baff1e	162	} else {
81afa345	163	return ")";
e4baff1e	164	}
81afa345 MD	165	}
81afa345 MD	166
8005f29a MD	167	static const char *loglevel_string(int value)
	168	{
	169	switch (value) {
	170	case -1: return "";
	171	case 0: return "TRACE_EMERG";
	172	case 1: return "TRACE_ALERT";
	173	case 2: return "TRACE_CRIT";
	174	case 3: return "TRACE_ERR";
	175	case 4: return "TRACE_WARNING";
	176	case 5: return "TRACE_NOTICE";
	177	case 6: return "TRACE_INFO";
	178	case 7: return "TRACE_SYSTEM";
0c8477c8 MD	179	case 8: return "TRACE_PROGRAM";
	180	case 9: return "TRACE_PROCESS";
	181	case 10: return "TRACE_MODULE";
	182	case 11: return "TRACE_UNIT";
	183	case 12: return "TRACE_FUNCTION";
	184	case 13: return "TRACE_DEFAULT";
	185	case 14: return "TRACE_VERBOSE";
8005f29a MD	186	case 15: return "TRACE_DEBUG";
	187	default: return "<<UNKNOWN>>";
	188	}
	189	}
	190
b551a063 DG	191	/*
	192	* Pretty print single event.
	193	*/
	194	static void print_events(struct lttng_event *event)
	195	{
	196	switch (event->type) {
	197	case LTTNG_EVENT_TRACEPOINT:
e4baff1e	198	{
401d092f	199	MSG("%s%s%s%s%s (type: tracepoint)%s", indent6,
81afa345 MD	200	event->name,
81afa345 MD	201	loglevel_string_pre(event->loglevel),
8005f29a	202	loglevel_string(event->loglevel),
81afa345 MD	203	loglevel_string_post(event->loglevel),
81afa345 MD	204	enabled_string(event->enabled));
b551a063	205	break;
e4baff1e	206	}
b551a063	207	case LTTNG_EVENT_PROBE:
464dd62d MD	208	MSG("%s%s (type: probe)%s", indent6,
464dd62d MD	209	event->name, enabled_string(event->enabled));
b551a063 DG	210	if (event->attr.probe.addr != 0) {
	211	MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
	212	} else {
	213	MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
	214	MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
	215	}
	216	break;
	217	case LTTNG_EVENT_FUNCTION:
	218	case LTTNG_EVENT_FUNCTION_ENTRY:
464dd62d MD	219	MSG("%s%s (type: function)%s", indent6,
464dd62d MD	220	event->name, enabled_string(event->enabled));
b551a063 DG	221	MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
	222	break;
	223	case LTTNG_EVENT_SYSCALL:
464dd62d MD	224	MSG("%s (type: syscall)%s", indent6,
464dd62d MD	225	enabled_string(event->enabled));
b551a063 DG	226	break;
b551a063 DG	227	case LTTNG_EVENT_NOOP:
464dd62d MD	228	MSG("%s (type: noop)%s", indent6,
464dd62d MD	229	enabled_string(event->enabled));
b551a063 DG	230	break;
	231	case LTTNG_EVENT_ALL:
	232	/* We should never have "all" events in list. */
	233	assert(0);
	234	break;
	235	}
	236	}
	237
	238	/*
	239	* Ask session daemon for all user space tracepoints available.
	240	*/
	241	static int list_ust_events(void)
	242	{
	243	int i, size;
	244	struct lttng_domain domain;
	245	struct lttng_handle *handle;
	246	struct lttng_event *event_list;
	247	pid_t cur_pid = 0;
	248
	249	DBG("Getting UST tracing events");
	250
	251	domain.type = LTTNG_DOMAIN_UST;
	252
	253	handle = lttng_create_handle(NULL, &domain);
	254	if (handle == NULL) {
	255	goto error;
	256	}
	257
	258	size = lttng_list_tracepoints(handle, &event_list);
	259	if (size < 0) {
	260	ERR("Unable to list UST events");
	261	return size;
	262	}
	263
	264	MSG("UST events:\n-------------");
	265
	266	if (size == 0) {
	267	MSG("None");
	268	}
	269
	270	for (i = 0; i < size; i++) {
	271	if (cur_pid != event_list[i].pid) {
	272	cur_pid = event_list[i].pid;
	273	MSG("\nPID: %d - Name: %s", cur_pid, get_cmdline_by_pid(cur_pid));
	274	}
	275	print_events(&event_list[i]);
	276	}
	277
	278	MSG("");
	279
	280	free(event_list);
	281
	282	return CMD_SUCCESS;
	283
	284	error:
	285	return -1;
	286	}
f3ed775e DG	287
f3ed775e DG	288	/*
9f19cc17	289	* Ask for all trace events in the kernel and pretty print them.
f3ed775e	290	*/
9f19cc17	291	static int list_kernel_events(void)
f3ed775e	292	{
9f19cc17	293	int i, size;
b551a063 DG	294	struct lttng_domain domain;
b551a063 DG	295	struct lttng_handle *handle;
9f19cc17	296	struct lttng_event *event_list;
f3ed775e	297
b551a063 DG	298	DBG("Getting kernel tracing events");
	299
	300	domain.type = LTTNG_DOMAIN_KERNEL;
	301
	302	handle = lttng_create_handle(NULL, &domain);
	303	if (handle == NULL) {
	304	goto error;
	305	}
f3ed775e	306
cd80958d	307	size = lttng_list_tracepoints(handle, &event_list);
9f19cc17 DG	308	if (size < 0) {
	309	ERR("Unable to list kernel events");
	310	return size;
f3ed775e DG	311	}
f3ed775e DG	312
9f19cc17	313	MSG("Kernel events:\n-------------");
f3ed775e	314
9f19cc17	315	for (i = 0; i < size; i++) {
b551a063	316	print_events(&event_list[i]);
f3ed775e DG	317	}
f3ed775e DG	318
b551a063 DG	319	MSG("");
b551a063 DG	320
f3ed775e DG	321	free(event_list);
	322
	323	return CMD_SUCCESS;
b551a063 DG	324
	325	error:
	326	return -1;
f3ed775e DG	327	}
	328
	329	/*
9f19cc17	330	* List events of channel of session and domain.
f3ed775e	331	*/
cd80958d	332	static int list_events(const char *channel_name)
f3ed775e DG	333	{
f3ed775e DG	334	int ret, count, i;
9f19cc17	335	struct lttng_event *events = NULL;
f3ed775e	336
cd80958d	337	count = lttng_list_events(handle, channel_name, &events);
f3ed775e DG	338	if (count < 0) {
	339	ret = count;
	340	goto error;
	341	}
	342
9f19cc17 DG	343	MSG("\n%sEvents:", indent4);
9f19cc17 DG	344	if (count == 0) {
5edd7e09	345	MSG("%sNone\n", indent6);
9f19cc17 DG	346	goto end;
	347	}
	348
f3ed775e	349	for (i = 0; i < count; i++) {
b551a063	350	print_events(&events[i]);
f3ed775e DG	351	}
f3ed775e DG	352
9f19cc17	353	MSG("");
f3ed775e	354
9f19cc17 DG	355	end:
	356	if (events) {
	357	free(events);
	358	}
	359	ret = CMD_SUCCESS;
f3ed775e DG	360
	361	error:
	362	return ret;
	363	}
	364
	365	/*
9f19cc17 DG	366	* Pretty print channel
	367	*/
	368	static void print_channel(struct lttng_channel *channel)
	369	{
464dd62d	370	MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
9f19cc17 DG	371
	372	MSG("%sAttributes:", indent4);
	373	MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
	374	MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
	375	MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
	376	MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
	377	MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
	378	switch (channel->attr.output) {
	379	case LTTNG_EVENT_SPLICE:
	380	MSG("%soutput: splice()", indent6);
	381	break;
	382	case LTTNG_EVENT_MMAP:
	383	MSG("%soutput: mmap()", indent6);
	384	break;
	385	}
	386	}
	387
	388	/*
	389	* List channel(s) of session and domain.
f3ed775e	390	*
9f19cc17	391	* If channel_name is NULL, all channels are listed.
f3ed775e	392	*/
cd80958d	393	static int list_channels(const char *channel_name)
f3ed775e	394	{
9f19cc17 DG	395	int count, i, ret = CMD_SUCCESS;
	396	unsigned int chan_found = 0;
	397	struct lttng_channel *channels = NULL;
f3ed775e	398
3e25cb20	399	DBG("Listing channel(s) (%s)", channel_name ? : "<all>");
9f19cc17	400
cd80958d	401	count = lttng_list_channels(handle, &channels);
f3ed775e DG	402	if (count < 0) {
f3ed775e DG	403	ret = count;
ae856491	404	goto error_channels;
9f19cc17	405	} else if (count == 0) {
ae856491 DG	406	ERR("Channel %s not found", channel_name);
ae856491 DG	407	goto error;
f3ed775e DG	408	}
f3ed775e DG	409
9f19cc17 DG	410	if (channel_name == NULL) {
	411	MSG("Channels:\n-------------");
	412	}
	413
	414	for (i = 0; i < count; i++) {
	415	if (channel_name != NULL) {
	416	if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
	417	chan_found = 1;
	418	} else {
	419	continue;
	420	}
	421	}
	422	print_channel(&channels[i]);
	423
	424	/* Listing events per channel */
cd80958d	425	ret = list_events(channels[i].name);
9f19cc17	426	if (ret < 0) {
9a745bc7	427	MSG("%s", lttng_strerror(ret));
9f19cc17 DG	428	}
	429
	430	if (chan_found) {
	431	break;
f3ed775e	432	}
f3ed775e DG	433	}
f3ed775e DG	434
9f19cc17	435	if (!chan_found && channel_name != NULL) {
ae856491 DG	436	ERR("Channel %s not found", channel_name);
ae856491 DG	437	goto error;
9f19cc17	438	}
f3ed775e	439
9f19cc17	440	ret = CMD_SUCCESS;
f3ed775e DG	441
f3ed775e DG	442	error:
ae856491 DG	443	free(channels);
	444
	445	error_channels:
f3ed775e DG	446	return ret;
	447	}
	448
	449	/*
9f19cc17	450	* List available tracing session. List only basic information.
f3ed775e	451	*
9f19cc17	452	* If session_name is NULL, all sessions are listed.
f3ed775e	453	*/
9f19cc17	454	static int list_sessions(const char *session_name)
f3ed775e	455	{
9f19cc17 DG	456	int ret, count, i;
	457	unsigned int session_found = 0;
	458	struct lttng_session *sessions;
	459
	460	count = lttng_list_sessions(&sessions);
	461	DBG("Session count %d", count);
	462	if (count < 0) {
	463	ret = count;
	464	goto error;
	465	}
	466
	467	if (session_name == NULL) {
	468	MSG("Available tracing sessions:");
	469	}
	470
	471	for (i = 0; i < count; i++) {
	472	if (session_name != NULL) {
	473	if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
	474	session_found = 1;
464dd62d	475	MSG("Tracing session %s:%s", session_name, active_string(sessions[i].enabled));
9f19cc17 DG	476	MSG("%sTrace path: %s\n", indent4, sessions[i].path);
	477	break;
	478	}
cd80958d	479	continue;
9f19cc17 DG	480	}
9f19cc17 DG	481
b6913340 DG	482	MSG(" %d) %s (%s)%s", i + 1, sessions[i].name, sessions[i].path,
b6913340 DG	483	active_string(sessions[i].enabled));
9f19cc17 DG	484
	485	if (session_found) {
	486	break;
	487	}
	488	}
	489
	490	free(sessions);
	491
	492	if (!session_found && session_name != NULL) {
b6913340 DG	493	ERR("Session '%s' not found", session_name);
	494	ret = CMD_ERROR;
	495	goto error;
9f19cc17 DG	496	}
	497
	498	if (session_name == NULL) {
6e0de39b	499	MSG("\nUse lttng list <session_name> for more details");
9f19cc17	500	}
f3ed775e DG	501
	502	return CMD_SUCCESS;
	503
	504	error:
	505	return ret;
	506	}
f3ed775e DG	507
f3ed775e DG	508	/*
9f19cc17	509	* List available domain(s) for a session.
f3ed775e	510	*/
330be774	511	static int list_domains(const char *session_name)
f3ed775e	512	{
9f19cc17 DG	513	int i, count, ret = CMD_SUCCESS;
	514	struct lttng_domain *domains = NULL;
	515
	516	MSG("Domains:\n-------------");
	517
330be774	518	count = lttng_list_domains(session_name, &domains);
9f19cc17 DG	519	if (count < 0) {
	520	ret = count;
	521	goto error;
	522	} else if (count == 0) {
	523	MSG(" None");
	524	goto end;
	525	}
	526
	527	for (i = 0; i < count; i++) {
	528	switch (domains[i].type) {
	529	case LTTNG_DOMAIN_KERNEL:
	530	MSG(" - Kernel");
b551a063 DG	531	break;
	532	case LTTNG_DOMAIN_UST:
	533	MSG(" - UST global");
	534	break;
9f19cc17 DG	535	default:
	536	break;
	537	}
	538	}
	539
	540	end:
	541	free(domains);
	542
	543	error:
	544	return ret;
f3ed775e	545	}
f3ed775e DG	546
f3ed775e DG	547	/*
9f19cc17	548	* The 'list <options>' first level command
f3ed775e DG	549	*/
	550	int cmd_list(int argc, const char **argv)
	551	{
9f19cc17	552	int opt, i, ret = CMD_SUCCESS;
c3919711	553	int nb_domain;
9f19cc17	554	const char *session_name;
f3ed775e	555	static poptContext pc;
9f19cc17 DG	556	struct lttng_domain domain;
9f19cc17 DG	557	struct lttng_domain *domains = NULL;
f3ed775e	558
9f19cc17	559	if (argc < 1) {
f3ed775e	560	usage(stderr);
ca1c3607	561	ret = CMD_ERROR;
f3ed775e DG	562	goto end;
	563	}
	564
	565	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	566	poptReadDefaultConfig(pc, 0);
	567
	568	while ((opt = poptGetNextOpt(pc)) != -1) {
	569	switch (opt) {
	570	case OPT_HELP:
ca1c3607	571	usage(stdout);
f3ed775e	572	goto end;
eeac7d46 MD	573	case OPT_USERSPACE:
eeac7d46 MD	574	opt_userspace = 1;
eeac7d46	575	break;
679b4943 SM	576	case OPT_LIST_OPTIONS:
679b4943 SM	577	list_cmd_options(stdout, long_options);
679b4943	578	goto end;
f3ed775e DG	579	default:
	580	usage(stderr);
	581	ret = CMD_UNDEFINED;
	582	goto end;
	583	}
	584	}
	585
9f19cc17 DG	586	/* Get session name (trailing argument) */
9f19cc17 DG	587	session_name = poptGetArg(pc);
b551a063	588	DBG2("Session name: %s", session_name);
9f19cc17	589
cd80958d DG	590	if (opt_kernel) {
cd80958d DG	591	domain.type = LTTNG_DOMAIN_KERNEL;
b551a063 DG	592	} else if (opt_userspace) {
	593	DBG2("Listing userspace global domain");
	594	domain.type = LTTNG_DOMAIN_UST;
cd80958d DG	595	}
	596
	597	handle = lttng_create_handle(session_name, &domain);
	598	if (handle == NULL) {
ca1c3607	599	ret = CMD_FATAL;
cd80958d DG	600	goto end;
	601	}
	602
9f19cc17	603	if (session_name == NULL) {
b551a063 DG	604	if (!opt_kernel && !opt_userspace) {
b551a063 DG	605	ret = list_sessions(NULL);
b6913340	606	if (ret != 0) {
b551a063 DG	607	goto end;
	608	}
	609	}
9f19cc17 DG	610	if (opt_kernel) {
	611	ret = list_kernel_events();
	612	if (ret < 0) {
	613	goto end;
	614	}
b551a063 DG	615	}
	616	if (opt_userspace) {
	617	ret = list_ust_events();
9f19cc17 DG	618	if (ret < 0) {
	619	goto end;
	620	}
	621	}
	622	} else {
	623	/* List session attributes */
	624	ret = list_sessions(session_name);
b6913340	625	if (ret != 0) {
9f19cc17 DG	626	goto end;
	627	}
	628
	629	/* Domain listing */
	630	if (opt_domain) {
330be774	631	ret = list_domains(session_name);
9f19cc17 DG	632	goto end;
	633	}
	634
	635	if (opt_kernel) {
9f19cc17	636	/* Channel listing */
cd80958d	637	ret = list_channels(opt_channel);
9f19cc17 DG	638	if (ret < 0) {
	639	goto end;
	640	}
9f19cc17 DG	641	} else {
9f19cc17 DG	642	/* We want all domain(s) */
330be774	643	nb_domain = lttng_list_domains(session_name, &domains);
b551a063	644	if (nb_domain < 0) {
67635185	645	ret = nb_domain;
9f19cc17 DG	646	goto end;
	647	}
	648
b551a063	649	for (i = 0; i < nb_domain; i++) {
9f19cc17 DG	650	switch (domains[i].type) {
	651	case LTTNG_DOMAIN_KERNEL:
	652	MSG("=== Domain: Kernel ===\n");
	653	break;
b551a063 DG	654	case LTTNG_DOMAIN_UST:
	655	MSG("=== Domain: UST global ===\n");
	656	break;
9f19cc17 DG	657	default:
	658	MSG("=== Domain: Unimplemented ===\n");
	659	break;
	660	}
	661
cd80958d DG	662	/* Clean handle before creating a new one */
	663	lttng_destroy_handle(handle);
	664
	665	handle = lttng_create_handle(session_name, &domains[i]);
	666	if (handle == NULL) {
ca1c3607	667	ret = CMD_FATAL;
cd80958d DG	668	goto end;
	669	}
	670
	671	ret = list_channels(opt_channel);
9f19cc17 DG	672	if (ret < 0) {
	673	goto end;
	674	}
	675	}
	676	}
f3ed775e DG	677	}
	678
	679	end:
9f19cc17 DG	680	if (domains) {
	681	free(domains);
	682	}
cd80958d DG	683	lttng_destroy_handle(handle);
cd80958d DG	684
ca1c3607	685	poptFreeContext(pc);
f3ed775e DG	686	return ret;
f3ed775e DG	687	}