[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 [[-k] [-u] [-p PID] [SESSION [<options>]]]\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "With no arguments, list available tracing session(s)\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "With -k alone, list available kernel events\n");
	fprintf(ofp, "With -u alone, list 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, "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(const char *loglevel)
{
	if (loglevel[0] == '\0') {
		return "";
	} else {
		return " (loglevel: ";
	}
}

static
const char *loglevel_string_post(const char *loglevel)
{
	if (loglevel[0] == '\0') {
		return "";
	} else {
		return ")";
	}
}

/*
 * Pretty print single event.
 */
static void print_events(struct lttng_event *event)
{
	switch (event->type) {
	case LTTNG_EVENT_TRACEPOINT:
	{
		char ll_value[LTTNG_SYMBOL_NAME_LEN] = "";

		if (event->loglevel[0] != '\0') {
			int ret;

			ret = snprintf(ll_value, LTTNG_SYMBOL_NAME_LEN,
				" (%lld)", (long long) event->loglevel_value);
			if (ret < 0)
				ERR("snprintf error");
		}
		MSG("%s%s%s%s%s%s (type: tracepoint)%s", indent6,
				event->name,
				loglevel_string_pre(event->loglevel),
				event->loglevel,
				ll_value,
				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_TRACEPOINT_LOGLEVEL:
		MSG("%s%s (type: tracepoint loglevel)%s", indent6,
			event->name,
			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;
	} else if (count == 0) {
		MSG("No channel found");
		goto end;
	}

	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) {
		MSG("Channel %s not found", channel_name);
	}

end:
	free(channels);
	ret = CMD_SUCCESS;

error:
	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) {
		MSG("Session %s not found", session_name);
	}

	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);
		goto end;
	}

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

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
		case OPT_HELP:
			usage(stderr);
			goto end;
		case OPT_USERSPACE:
			opt_userspace = 1;
			break;
		case OPT_LIST_OPTIONS:
			list_cmd_options(stdout, long_options);
			ret = CMD_SUCCESS;
			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) {
		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) {
					goto end;
				}

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

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

	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	{
9f19cc17 DG	73	fprintf(ofp, "usage: lttng list [[-k] [-u] [-p PID] [SESSION [<options>]]]\n");
	74	fprintf(ofp, "\n");
	75	fprintf(ofp, "With no arguments, list available tracing session(s)\n");
	76	fprintf(ofp, "\n");
	77	fprintf(ofp, "With -k alone, list available kernel events\n");
	78	fprintf(ofp, "With -u alone, list available userspace events\n");
	79	fprintf(ofp, "\n");
	80	fprintf(ofp, " -h, --help Show this help\n");
679b4943	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");
9f19cc17 DG	88	fprintf(ofp, "Options:\n");
	89	fprintf(ofp, " -c, --channel NAME List details of a channel\n");
	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 MD	147	static
	148	const char loglevel_string_pre(const char loglevel)
	149	{
e4baff1e	150	if (loglevel[0] == '\0') {
81afa345	151	return "";
e4baff1e	152	} else {
81afa345	153	return " (loglevel: ";
e4baff1e	154	}
81afa345 MD	155	}
	156
	157	static
	158	const char loglevel_string_post(const char loglevel)
	159	{
e4baff1e	160	if (loglevel[0] == '\0') {
81afa345	161	return "";
e4baff1e	162	} else {
81afa345	163	return ")";
e4baff1e	164	}
81afa345 MD	165	}
81afa345 MD	166
b551a063 DG	167	/*
	168	* Pretty print single event.
	169	*/
	170	static void print_events(struct lttng_event *event)
	171	{
	172	switch (event->type) {
	173	case LTTNG_EVENT_TRACEPOINT:
e4baff1e MD	174	{
	175	char ll_value[LTTNG_SYMBOL_NAME_LEN] = "";
	176
	177	if (event->loglevel[0] != '\0') {
	178	int ret;
	179
	180	ret = snprintf(ll_value, LTTNG_SYMBOL_NAME_LEN,
4dbd54a1	181	" (%lld)", (long long) event->loglevel_value);
e4baff1e MD	182	if (ret < 0)
	183	ERR("snprintf error");
	184	}
	185	MSG("%s%s%s%s%s%s (type: tracepoint)%s", indent6,
81afa345 MD	186	event->name,
	187	loglevel_string_pre(event->loglevel),
	188	event->loglevel,
e4baff1e	189	ll_value,
81afa345 MD	190	loglevel_string_post(event->loglevel),
81afa345 MD	191	enabled_string(event->enabled));
b551a063	192	break;
e4baff1e	193	}
b551a063	194	case LTTNG_EVENT_PROBE:
464dd62d MD	195	MSG("%s%s (type: probe)%s", indent6,
464dd62d MD	196	event->name, enabled_string(event->enabled));
b551a063 DG	197	if (event->attr.probe.addr != 0) {
	198	MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
	199	} else {
	200	MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
	201	MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
	202	}
	203	break;
	204	case LTTNG_EVENT_FUNCTION:
	205	case LTTNG_EVENT_FUNCTION_ENTRY:
464dd62d MD	206	MSG("%s%s (type: function)%s", indent6,
464dd62d MD	207	event->name, enabled_string(event->enabled));
b551a063 DG	208	MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
	209	break;
	210	case LTTNG_EVENT_SYSCALL:
464dd62d MD	211	MSG("%s (type: syscall)%s", indent6,
464dd62d MD	212	enabled_string(event->enabled));
b551a063 DG	213	break;
b551a063 DG	214	case LTTNG_EVENT_NOOP:
464dd62d MD	215	MSG("%s (type: noop)%s", indent6,
464dd62d MD	216	enabled_string(event->enabled));
b551a063	217	break;
81afa345 MD	218	case LTTNG_EVENT_TRACEPOINT_LOGLEVEL:
81afa345 MD	219	MSG("%s%s (type: tracepoint loglevel)%s", indent6,
e4baff1e MD	220	event->name,
e4baff1e MD	221	enabled_string(event->enabled));
81afa345	222	break;
b551a063 DG	223	case LTTNG_EVENT_ALL:
	224	/* We should never have "all" events in list. */
	225	assert(0);
	226	break;
	227	}
	228	}
	229
	230	/*
	231	* Ask session daemon for all user space tracepoints available.
	232	*/
	233	static int list_ust_events(void)
	234	{
	235	int i, size;
	236	struct lttng_domain domain;
	237	struct lttng_handle *handle;
	238	struct lttng_event *event_list;
	239	pid_t cur_pid = 0;
	240
	241	DBG("Getting UST tracing events");
	242
	243	domain.type = LTTNG_DOMAIN_UST;
	244
	245	handle = lttng_create_handle(NULL, &domain);
	246	if (handle == NULL) {
	247	goto error;
	248	}
	249
	250	size = lttng_list_tracepoints(handle, &event_list);
	251	if (size < 0) {
	252	ERR("Unable to list UST events");
	253	return size;
	254	}
	255
	256	MSG("UST events:\n-------------");
	257
	258	if (size == 0) {
	259	MSG("None");
	260	}
	261
	262	for (i = 0; i < size; i++) {
	263	if (cur_pid != event_list[i].pid) {
	264	cur_pid = event_list[i].pid;
	265	MSG("\nPID: %d - Name: %s", cur_pid, get_cmdline_by_pid(cur_pid));
	266	}
	267	print_events(&event_list[i]);
	268	}
	269
	270	MSG("");
	271
	272	free(event_list);
	273
	274	return CMD_SUCCESS;
	275
	276	error:
	277	return -1;
	278	}
f3ed775e DG	279
f3ed775e DG	280	/*
9f19cc17	281	* Ask for all trace events in the kernel and pretty print them.
f3ed775e	282	*/
9f19cc17	283	static int list_kernel_events(void)
f3ed775e	284	{
9f19cc17	285	int i, size;
b551a063 DG	286	struct lttng_domain domain;
b551a063 DG	287	struct lttng_handle *handle;
9f19cc17	288	struct lttng_event *event_list;
f3ed775e	289
b551a063 DG	290	DBG("Getting kernel tracing events");
	291
	292	domain.type = LTTNG_DOMAIN_KERNEL;
	293
	294	handle = lttng_create_handle(NULL, &domain);
	295	if (handle == NULL) {
	296	goto error;
	297	}
f3ed775e	298
cd80958d	299	size = lttng_list_tracepoints(handle, &event_list);
9f19cc17 DG	300	if (size < 0) {
	301	ERR("Unable to list kernel events");
	302	return size;
f3ed775e DG	303	}
f3ed775e DG	304
9f19cc17	305	MSG("Kernel events:\n-------------");
f3ed775e	306
9f19cc17	307	for (i = 0; i < size; i++) {
b551a063	308	print_events(&event_list[i]);
f3ed775e DG	309	}
f3ed775e DG	310
b551a063 DG	311	MSG("");
b551a063 DG	312
f3ed775e DG	313	free(event_list);
	314
	315	return CMD_SUCCESS;
b551a063 DG	316
	317	error:
	318	return -1;
f3ed775e DG	319	}
	320
	321	/*
9f19cc17	322	* List events of channel of session and domain.
f3ed775e	323	*/
cd80958d	324	static int list_events(const char *channel_name)
f3ed775e DG	325	{
f3ed775e DG	326	int ret, count, i;
9f19cc17	327	struct lttng_event *events = NULL;
f3ed775e	328
cd80958d	329	count = lttng_list_events(handle, channel_name, &events);
f3ed775e DG	330	if (count < 0) {
	331	ret = count;
	332	goto error;
	333	}
	334
9f19cc17 DG	335	MSG("\n%sEvents:", indent4);
9f19cc17 DG	336	if (count == 0) {
5edd7e09	337	MSG("%sNone\n", indent6);
9f19cc17 DG	338	goto end;
	339	}
	340
f3ed775e	341	for (i = 0; i < count; i++) {
b551a063	342	print_events(&events[i]);
f3ed775e DG	343	}
f3ed775e DG	344
9f19cc17	345	MSG("");
f3ed775e	346
9f19cc17 DG	347	end:
	348	if (events) {
	349	free(events);
	350	}
	351	ret = CMD_SUCCESS;
f3ed775e DG	352
	353	error:
	354	return ret;
	355	}
	356
	357	/*
9f19cc17 DG	358	* Pretty print channel
	359	*/
	360	static void print_channel(struct lttng_channel *channel)
	361	{
464dd62d	362	MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
9f19cc17 DG	363
	364	MSG("%sAttributes:", indent4);
	365	MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
	366	MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
	367	MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
	368	MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
	369	MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
	370	switch (channel->attr.output) {
	371	case LTTNG_EVENT_SPLICE:
	372	MSG("%soutput: splice()", indent6);
	373	break;
	374	case LTTNG_EVENT_MMAP:
	375	MSG("%soutput: mmap()", indent6);
	376	break;
	377	}
	378	}
	379
	380	/*
	381	* List channel(s) of session and domain.
f3ed775e	382	*
9f19cc17	383	* If channel_name is NULL, all channels are listed.
f3ed775e	384	*/
cd80958d	385	static int list_channels(const char *channel_name)
f3ed775e	386	{
9f19cc17 DG	387	int count, i, ret = CMD_SUCCESS;
	388	unsigned int chan_found = 0;
	389	struct lttng_channel *channels = NULL;
f3ed775e	390
3e25cb20	391	DBG("Listing channel(s) (%s)", channel_name ? : "<all>");
9f19cc17	392
cd80958d	393	count = lttng_list_channels(handle, &channels);
f3ed775e DG	394	if (count < 0) {
	395	ret = count;
	396	goto error;
9f19cc17 DG	397	} else if (count == 0) {
	398	MSG("No channel found");
	399	goto end;
f3ed775e DG	400	}
f3ed775e DG	401
9f19cc17 DG	402	if (channel_name == NULL) {
	403	MSG("Channels:\n-------------");
	404	}
	405
	406	for (i = 0; i < count; i++) {
	407	if (channel_name != NULL) {
	408	if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
	409	chan_found = 1;
	410	} else {
	411	continue;
	412	}
	413	}
	414	print_channel(&channels[i]);
	415
	416	/* Listing events per channel */
cd80958d	417	ret = list_events(channels[i].name);
9f19cc17	418	if (ret < 0) {
9a745bc7	419	MSG("%s", lttng_strerror(ret));
9f19cc17 DG	420	}
	421
	422	if (chan_found) {
	423	break;
f3ed775e	424	}
f3ed775e DG	425	}
f3ed775e DG	426
9f19cc17 DG	427	if (!chan_found && channel_name != NULL) {
	428	MSG("Channel %s not found", channel_name);
	429	}
f3ed775e	430
9f19cc17 DG	431	end:
	432	free(channels);
	433	ret = CMD_SUCCESS;
f3ed775e DG	434
	435	error:
	436	return ret;
	437	}
	438
	439	/*
9f19cc17	440	* List available tracing session. List only basic information.
f3ed775e	441	*
9f19cc17	442	* If session_name is NULL, all sessions are listed.
f3ed775e	443	*/
9f19cc17	444	static int list_sessions(const char *session_name)
f3ed775e	445	{
9f19cc17 DG	446	int ret, count, i;
	447	unsigned int session_found = 0;
	448	struct lttng_session *sessions;
	449
	450	count = lttng_list_sessions(&sessions);
	451	DBG("Session count %d", count);
	452	if (count < 0) {
	453	ret = count;
	454	goto error;
	455	}
	456
	457	if (session_name == NULL) {
	458	MSG("Available tracing sessions:");
	459	}
	460
	461	for (i = 0; i < count; i++) {
	462	if (session_name != NULL) {
	463	if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
	464	session_found = 1;
464dd62d	465	MSG("Tracing session %s:%s", session_name, active_string(sessions[i].enabled));
9f19cc17 DG	466	MSG("%sTrace path: %s\n", indent4, sessions[i].path);
	467	break;
	468	}
cd80958d	469	continue;
9f19cc17 DG	470	}
9f19cc17 DG	471
464dd62d	472	MSG(" %d) %s (%s)%s", i + 1, sessions[i].name, sessions[i].path, active_string(sessions[i].enabled));
9f19cc17 DG	473
	474	if (session_found) {
	475	break;
	476	}
	477	}
	478
	479	free(sessions);
	480
	481	if (!session_found && session_name != NULL) {
	482	MSG("Session %s not found", session_name);
	483	}
	484
	485	if (session_name == NULL) {
6e0de39b	486	MSG("\nUse lttng list <session_name> for more details");
9f19cc17	487	}
f3ed775e DG	488
	489	return CMD_SUCCESS;
	490
	491	error:
	492	return ret;
	493	}
f3ed775e DG	494
f3ed775e DG	495	/*
9f19cc17	496	* List available domain(s) for a session.
f3ed775e	497	*/
330be774	498	static int list_domains(const char *session_name)
f3ed775e	499	{
9f19cc17 DG	500	int i, count, ret = CMD_SUCCESS;
	501	struct lttng_domain *domains = NULL;
	502
	503	MSG("Domains:\n-------------");
	504
330be774	505	count = lttng_list_domains(session_name, &domains);
9f19cc17 DG	506	if (count < 0) {
	507	ret = count;
	508	goto error;
	509	} else if (count == 0) {
	510	MSG(" None");
	511	goto end;
	512	}
	513
	514	for (i = 0; i < count; i++) {
	515	switch (domains[i].type) {
	516	case LTTNG_DOMAIN_KERNEL:
	517	MSG(" - Kernel");
b551a063 DG	518	break;
	519	case LTTNG_DOMAIN_UST:
	520	MSG(" - UST global");
	521	break;
9f19cc17 DG	522	default:
	523	break;
	524	}
	525	}
	526
	527	end:
	528	free(domains);
	529
	530	error:
	531	return ret;
f3ed775e	532	}
f3ed775e DG	533
f3ed775e DG	534	/*
9f19cc17	535	* The 'list <options>' first level command
f3ed775e DG	536	*/
	537	int cmd_list(int argc, const char **argv)
	538	{
9f19cc17	539	int opt, i, ret = CMD_SUCCESS;
c3919711	540	int nb_domain;
9f19cc17	541	const char *session_name;
f3ed775e	542	static poptContext pc;
9f19cc17 DG	543	struct lttng_domain domain;
9f19cc17 DG	544	struct lttng_domain *domains = NULL;
f3ed775e	545
9f19cc17	546	if (argc < 1) {
f3ed775e DG	547	usage(stderr);
	548	goto end;
	549	}
	550
	551	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	552	poptReadDefaultConfig(pc, 0);
	553
	554	while ((opt = poptGetNextOpt(pc)) != -1) {
	555	switch (opt) {
	556	case OPT_HELP:
	557	usage(stderr);
	558	goto end;
eeac7d46 MD	559	case OPT_USERSPACE:
eeac7d46 MD	560	opt_userspace = 1;
eeac7d46	561	break;
679b4943 SM	562	case OPT_LIST_OPTIONS:
	563	list_cmd_options(stdout, long_options);
	564	ret = CMD_SUCCESS;
	565	goto end;
f3ed775e DG	566	default:
	567	usage(stderr);
	568	ret = CMD_UNDEFINED;
	569	goto end;
	570	}
	571	}
	572
9f19cc17 DG	573	/* Get session name (trailing argument) */
9f19cc17 DG	574	session_name = poptGetArg(pc);
b551a063	575	DBG2("Session name: %s", session_name);
9f19cc17	576
cd80958d DG	577	if (opt_kernel) {
cd80958d DG	578	domain.type = LTTNG_DOMAIN_KERNEL;
b551a063 DG	579	} else if (opt_userspace) {
	580	DBG2("Listing userspace global domain");
	581	domain.type = LTTNG_DOMAIN_UST;
cd80958d DG	582	}
	583
	584	handle = lttng_create_handle(session_name, &domain);
	585	if (handle == NULL) {
	586	goto end;
	587	}
	588
9f19cc17	589	if (session_name == NULL) {
b551a063 DG	590	if (!opt_kernel && !opt_userspace) {
	591	ret = list_sessions(NULL);
	592	if (ret < 0) {
	593	goto end;
	594	}
	595	}
9f19cc17 DG	596	if (opt_kernel) {
	597	ret = list_kernel_events();
	598	if (ret < 0) {
	599	goto end;
	600	}
b551a063 DG	601	}
	602	if (opt_userspace) {
	603	ret = list_ust_events();
9f19cc17 DG	604	if (ret < 0) {
	605	goto end;
	606	}
	607	}
	608	} else {
	609	/* List session attributes */
	610	ret = list_sessions(session_name);
	611	if (ret < 0) {
	612	goto end;
	613	}
	614
	615	/* Domain listing */
	616	if (opt_domain) {
330be774	617	ret = list_domains(session_name);
9f19cc17 DG	618	goto end;
	619	}
	620
	621	if (opt_kernel) {
9f19cc17	622	/* Channel listing */
cd80958d	623	ret = list_channels(opt_channel);
9f19cc17 DG	624	if (ret < 0) {
	625	goto end;
	626	}
9f19cc17 DG	627	} else {
9f19cc17 DG	628	/* We want all domain(s) */
330be774	629	nb_domain = lttng_list_domains(session_name, &domains);
b551a063 DG	630	if (nb_domain < 0) {
b551a063 DG	631	ret = nb_domain;
9f19cc17 DG	632	goto end;
	633	}
	634
b551a063	635	for (i = 0; i < nb_domain; i++) {
9f19cc17 DG	636	switch (domains[i].type) {
	637	case LTTNG_DOMAIN_KERNEL:
	638	MSG("=== Domain: Kernel ===\n");
	639	break;
b551a063 DG	640	case LTTNG_DOMAIN_UST:
	641	MSG("=== Domain: UST global ===\n");
	642	break;
9f19cc17 DG	643	default:
	644	MSG("=== Domain: Unimplemented ===\n");
	645	break;
	646	}
	647
cd80958d DG	648	/* Clean handle before creating a new one */
	649	lttng_destroy_handle(handle);
	650
	651	handle = lttng_create_handle(session_name, &domains[i]);
	652	if (handle == NULL) {
	653	goto end;
	654	}
	655
	656	ret = list_channels(opt_channel);
9f19cc17 DG	657	if (ret < 0) {
	658	goto end;
	659	}
	660	}
	661	}
f3ed775e DG	662	}
	663
	664	end:
9f19cc17 DG	665	if (domains) {
	666	free(domains);
	667	}
cd80958d DG	668	lttng_destroy_handle(handle);
cd80958d DG	669
f3ed775e DG	670	return ret;
f3ed775e DG	671	}