[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 [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_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);
		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) {
				ret = CMD_ERROR;
				goto end;
			}
		}
		if (opt_kernel) {
			ret = list_kernel_events();
			if (ret < 0) {
				ret = CMD_ERROR;
				goto end;
			}
		}
		if (opt_userspace) {
			ret = list_ust_events();
			if (ret < 0) {
				ret = CMD_ERROR;
				goto end;
			}
		}
	} else {
		/* List session attributes */
		ret = list_sessions(session_name);
		if (ret < 0) {
			ret = CMD_ERROR;
			goto end;
		}

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

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