[lttng-tools.git] / 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 "../cmd.h"

static int opt_pid;
static int opt_userspace;
static char *opt_cmd_name;
static int opt_kernel;
static char *opt_channel;
static int opt_domain;

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

enum {
	OPT_HELP = 1,
	OPT_USERSPACE,
};

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},
	{"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},
	{"channel",   'c', POPT_ARG_STRING, &opt_channel, 0, 0, 0},
	{"domain",    'd', POPT_ARG_VAL, &opt_domain, 1, 0, 0},
	{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, "  -k, --kernel            Select kernel domain\n");
	fprintf(ofp, "  -u, --userspace         Select user-space domain.\n");
	fprintf(ofp, "  -p, --pid PID           List user-space events by PID\n");
	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;
	}
}

/*
 * Pretty print single event.
 */
static void print_events(struct lttng_event *event)
{
	switch (event->type) {
	case LTTNG_EVENT_TRACEPOINT:
		MSG("%s%s (type: tracepoint)%s", indent6,
				event->name, 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", 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);

	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(void)
{
	int i, count, ret = CMD_SUCCESS;
	struct lttng_domain *domains = NULL;

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

	count = lttng_list_domains(handle, &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;
	unsigned 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;
		default:
			usage(stderr);
			ret = CMD_UNDEFINED;
			goto end;
		}
	}

	if (opt_pid != 0) {
		MSG("*** Userspace tracing not implemented for PID ***\n");
	}

	/* 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();
			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(handle, &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
6e2d116c	27	#include "../cmd.h"
f3ed775e DG	28
f3ed775e DG	29	static int opt_pid;
9f19cc17	30	static int opt_userspace;
eeac7d46	31	static char *opt_cmd_name;
9f19cc17 DG	32	static int opt_kernel;
	33	static char *opt_channel;
	34	static int opt_domain;
	35
	36	const char *indent4 = " ";
	37	const char *indent6 = " ";
	38	const char *indent8 = " ";
f3ed775e DG	39
	40	enum {
	41	OPT_HELP = 1,
eeac7d46	42	OPT_USERSPACE,
f3ed775e DG	43	};
f3ed775e DG	44
cd80958d DG	45	static struct lttng_handle *handle;
cd80958d DG	46
f3ed775e DG	47	static struct poptOption long_options[] = {
	48	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	49	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
9f19cc17	50	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
6caa2bcc	51	{"userspace", 'u', POPT_ARG_STRING \| POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
9f19cc17 DG	52	{"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	53	{"channel", 'c', POPT_ARG_STRING, &opt_channel, 0, 0, 0},
	54	{"domain", 'd', POPT_ARG_VAL, &opt_domain, 1, 0, 0},
f3ed775e DG	55	{0, 0, 0, 0, 0, 0, 0}
	56	};
	57
	58	/*
	59	* usage
	60	*/
	61	static void usage(FILE *ofp)
	62	{
9f19cc17 DG	63	fprintf(ofp, "usage: lttng list [[-k] [-u] [-p PID] [SESSION [<options>]]]\n");
	64	fprintf(ofp, "\n");
	65	fprintf(ofp, "With no arguments, list available tracing session(s)\n");
	66	fprintf(ofp, "\n");
	67	fprintf(ofp, "With -k alone, list available kernel events\n");
	68	fprintf(ofp, "With -u alone, list available userspace events\n");
	69	fprintf(ofp, "\n");
	70	fprintf(ofp, " -h, --help Show this help\n");
	71	fprintf(ofp, " -k, --kernel Select kernel domain\n");
	72	fprintf(ofp, " -u, --userspace Select user-space domain.\n");
	73	fprintf(ofp, " -p, --pid PID List user-space events by PID\n");
f3ed775e	74	fprintf(ofp, "\n");
9f19cc17 DG	75	fprintf(ofp, "Options:\n");
	76	fprintf(ofp, " -c, --channel NAME List details of a channel\n");
	77	fprintf(ofp, " -d, --domain List available domain(s)\n");
f3ed775e DG	78	fprintf(ofp, "\n");
	79	}
	80
	81	/*
9f19cc17	82	* Get command line from /proc for a specific pid.
f3ed775e	83	*
9f19cc17 DG	84	* On success, return an allocated string pointer to the proc cmdline.
9f19cc17 DG	85	* On error, return NULL.
f3ed775e DG	86	*/
	87	static char *get_cmdline_by_pid(pid_t pid)
	88	{
	89	int ret;
	90	FILE *fp;
	91	char *cmdline = NULL;
	92	char path[24]; /* Can't go bigger than /proc/65535/cmdline */
	93
	94	snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
	95	fp = fopen(path, "r");
	96	if (fp == NULL) {
	97	goto end;
	98	}
	99
	100	/* Caller must free() cmdline /
	101	cmdline = malloc(PATH_MAX);
	102	ret = fread(cmdline, 1, PATH_MAX, fp);
f40799e8 DG	103	if (ret < 0) {
	104	perror("fread proc list");
	105	}
f3ed775e DG	106	fclose(fp);
	107
	108	end:
	109	return cmdline;
	110	}
b551a063	111
464dd62d MD	112	static
	113	const char *active_string(int value)
	114	{
	115	switch (value) {
b09f0429 MD	116	case 0: return " [inactive]";
b09f0429 MD	117	case 1: return " [active]";
464dd62d MD	118	case -1: return "";
	119	default: return NULL;
	120	}
	121	}
	122
	123	static
	124	const char *enabled_string(int value)
	125	{
	126	switch (value) {
b09f0429 MD	127	case 0: return " [disabled]";
b09f0429 MD	128	case 1: return " [enabled]";
464dd62d MD	129	case -1: return "";
	130	default: return NULL;
	131	}
	132	}
	133
b551a063 DG	134	/*
	135	* Pretty print single event.
	136	*/
	137	static void print_events(struct lttng_event *event)
	138	{
	139	switch (event->type) {
	140	case LTTNG_EVENT_TRACEPOINT:
464dd62d MD	141	MSG("%s%s (type: tracepoint)%s", indent6,
464dd62d MD	142	event->name, enabled_string(event->enabled));
b551a063 DG	143	break;
b551a063 DG	144	case LTTNG_EVENT_PROBE:
464dd62d MD	145	MSG("%s%s (type: probe)%s", indent6,
464dd62d MD	146	event->name, enabled_string(event->enabled));
b551a063 DG	147	if (event->attr.probe.addr != 0) {
	148	MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
	149	} else {
	150	MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
	151	MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
	152	}
	153	break;
	154	case LTTNG_EVENT_FUNCTION:
	155	case LTTNG_EVENT_FUNCTION_ENTRY:
464dd62d MD	156	MSG("%s%s (type: function)%s", indent6,
464dd62d MD	157	event->name, enabled_string(event->enabled));
b551a063 DG	158	MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
	159	break;
	160	case LTTNG_EVENT_SYSCALL:
464dd62d MD	161	MSG("%s (type: syscall)%s", indent6,
464dd62d MD	162	enabled_string(event->enabled));
b551a063 DG	163	break;
b551a063 DG	164	case LTTNG_EVENT_NOOP:
464dd62d MD	165	MSG("%s (type: noop)%s", indent6,
464dd62d MD	166	enabled_string(event->enabled));
b551a063 DG	167	break;
	168	case LTTNG_EVENT_ALL:
	169	/* We should never have "all" events in list. */
	170	assert(0);
	171	break;
	172	}
	173	}
	174
	175	/*
	176	* Ask session daemon for all user space tracepoints available.
	177	*/
	178	static int list_ust_events(void)
	179	{
	180	int i, size;
	181	struct lttng_domain domain;
	182	struct lttng_handle *handle;
	183	struct lttng_event *event_list;
	184	pid_t cur_pid = 0;
	185
	186	DBG("Getting UST tracing events");
	187
	188	domain.type = LTTNG_DOMAIN_UST;
	189
	190	handle = lttng_create_handle(NULL, &domain);
	191	if (handle == NULL) {
	192	goto error;
	193	}
	194
	195	size = lttng_list_tracepoints(handle, &event_list);
	196	if (size < 0) {
	197	ERR("Unable to list UST events");
	198	return size;
	199	}
	200
	201	MSG("UST events:\n-------------");
	202
	203	if (size == 0) {
	204	MSG("None");
	205	}
	206
	207	for (i = 0; i < size; i++) {
	208	if (cur_pid != event_list[i].pid) {
	209	cur_pid = event_list[i].pid;
	210	MSG("\nPID: %d - Name: %s", cur_pid, get_cmdline_by_pid(cur_pid));
	211	}
	212	print_events(&event_list[i]);
	213	}
	214
	215	MSG("");
	216
	217	free(event_list);
	218
	219	return CMD_SUCCESS;
	220
	221	error:
	222	return -1;
	223	}
f3ed775e DG	224
f3ed775e DG	225	/*
9f19cc17	226	* Ask for all trace events in the kernel and pretty print them.
f3ed775e	227	*/
9f19cc17	228	static int list_kernel_events(void)
f3ed775e	229	{
9f19cc17	230	int i, size;
b551a063 DG	231	struct lttng_domain domain;
b551a063 DG	232	struct lttng_handle *handle;
9f19cc17	233	struct lttng_event *event_list;
f3ed775e	234
b551a063 DG	235	DBG("Getting kernel tracing events");
	236
	237	domain.type = LTTNG_DOMAIN_KERNEL;
	238
	239	handle = lttng_create_handle(NULL, &domain);
	240	if (handle == NULL) {
	241	goto error;
	242	}
f3ed775e	243
cd80958d	244	size = lttng_list_tracepoints(handle, &event_list);
9f19cc17 DG	245	if (size < 0) {
	246	ERR("Unable to list kernel events");
	247	return size;
f3ed775e DG	248	}
f3ed775e DG	249
9f19cc17	250	MSG("Kernel events:\n-------------");
f3ed775e	251
9f19cc17	252	for (i = 0; i < size; i++) {
b551a063	253	print_events(&event_list[i]);
f3ed775e DG	254	}
f3ed775e DG	255
b551a063 DG	256	MSG("");
b551a063 DG	257
f3ed775e DG	258	free(event_list);
	259
	260	return CMD_SUCCESS;
b551a063 DG	261
	262	error:
	263	return -1;
f3ed775e DG	264	}
	265
	266	/*
9f19cc17	267	* List events of channel of session and domain.
f3ed775e	268	*/
cd80958d	269	static int list_events(const char *channel_name)
f3ed775e DG	270	{
f3ed775e DG	271	int ret, count, i;
9f19cc17	272	struct lttng_event *events = NULL;
f3ed775e	273
cd80958d	274	count = lttng_list_events(handle, channel_name, &events);
f3ed775e DG	275	if (count < 0) {
	276	ret = count;
	277	goto error;
	278	}
	279
9f19cc17 DG	280	MSG("\n%sEvents:", indent4);
	281	if (count == 0) {
	282	MSG("%sNone", indent6);
	283	goto end;
	284	}
	285
f3ed775e	286	for (i = 0; i < count; i++) {
b551a063	287	print_events(&events[i]);
f3ed775e DG	288	}
f3ed775e DG	289
9f19cc17	290	MSG("");
f3ed775e	291
9f19cc17 DG	292	end:
	293	if (events) {
	294	free(events);
	295	}
	296	ret = CMD_SUCCESS;
f3ed775e DG	297
	298	error:
	299	return ret;
	300	}
	301
	302	/*
9f19cc17 DG	303	* Pretty print channel
	304	*/
	305	static void print_channel(struct lttng_channel *channel)
	306	{
464dd62d	307	MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
9f19cc17 DG	308
	309	MSG("%sAttributes:", indent4);
	310	MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
	311	MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
	312	MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
	313	MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
	314	MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
	315	switch (channel->attr.output) {
	316	case LTTNG_EVENT_SPLICE:
	317	MSG("%soutput: splice()", indent6);
	318	break;
	319	case LTTNG_EVENT_MMAP:
	320	MSG("%soutput: mmap()", indent6);
	321	break;
	322	}
	323	}
	324
	325	/*
	326	* List channel(s) of session and domain.
f3ed775e	327	*
9f19cc17	328	* If channel_name is NULL, all channels are listed.
f3ed775e	329	*/
cd80958d	330	static int list_channels(const char *channel_name)
f3ed775e	331	{
9f19cc17 DG	332	int count, i, ret = CMD_SUCCESS;
	333	unsigned int chan_found = 0;
	334	struct lttng_channel *channels = NULL;
f3ed775e	335
9f19cc17 DG	336	DBG("Listing channel(s) (%s)", channel_name);
9f19cc17 DG	337
cd80958d	338	count = lttng_list_channels(handle, &channels);
f3ed775e DG	339	if (count < 0) {
	340	ret = count;
	341	goto error;
9f19cc17 DG	342	} else if (count == 0) {
	343	MSG("No channel found");
	344	goto end;
f3ed775e DG	345	}
f3ed775e DG	346
9f19cc17 DG	347	if (channel_name == NULL) {
	348	MSG("Channels:\n-------------");
	349	}
	350
	351	for (i = 0; i < count; i++) {
	352	if (channel_name != NULL) {
	353	if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
	354	chan_found = 1;
	355	} else {
	356	continue;
	357	}
	358	}
	359	print_channel(&channels[i]);
	360
	361	/* Listing events per channel */
cd80958d	362	ret = list_events(channels[i].name);
9f19cc17	363	if (ret < 0) {
9a745bc7	364	MSG("%s", lttng_strerror(ret));
9f19cc17 DG	365	}
	366
	367	if (chan_found) {
	368	break;
f3ed775e	369	}
f3ed775e DG	370	}
f3ed775e DG	371
9f19cc17 DG	372	if (!chan_found && channel_name != NULL) {
	373	MSG("Channel %s not found", channel_name);
	374	}
f3ed775e	375
9f19cc17 DG	376	end:
	377	free(channels);
	378	ret = CMD_SUCCESS;
f3ed775e DG	379
	380	error:
	381	return ret;
	382	}
	383
	384	/*
9f19cc17	385	* List available tracing session. List only basic information.
f3ed775e	386	*
9f19cc17	387	* If session_name is NULL, all sessions are listed.
f3ed775e	388	*/
9f19cc17	389	static int list_sessions(const char *session_name)
f3ed775e	390	{
9f19cc17 DG	391	int ret, count, i;
	392	unsigned int session_found = 0;
	393	struct lttng_session *sessions;
	394
	395	count = lttng_list_sessions(&sessions);
	396	DBG("Session count %d", count);
	397	if (count < 0) {
	398	ret = count;
	399	goto error;
	400	}
	401
	402	if (session_name == NULL) {
	403	MSG("Available tracing sessions:");
	404	}
	405
	406	for (i = 0; i < count; i++) {
	407	if (session_name != NULL) {
	408	if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
	409	session_found = 1;
464dd62d	410	MSG("Tracing session %s:%s", session_name, active_string(sessions[i].enabled));
9f19cc17 DG	411	MSG("%sTrace path: %s\n", indent4, sessions[i].path);
	412	break;
	413	}
cd80958d	414	continue;
9f19cc17 DG	415	}
9f19cc17 DG	416
464dd62d	417	MSG(" %d) %s (%s)%s", i + 1, sessions[i].name, sessions[i].path, active_string(sessions[i].enabled));
9f19cc17 DG	418
	419	if (session_found) {
	420	break;
	421	}
	422	}
	423
	424	free(sessions);
	425
	426	if (!session_found && session_name != NULL) {
	427	MSG("Session %s not found", session_name);
	428	}
	429
	430	if (session_name == NULL) {
6e0de39b	431	MSG("\nUse lttng list <session_name> for more details");
9f19cc17	432	}
f3ed775e DG	433
	434	return CMD_SUCCESS;
	435
	436	error:
	437	return ret;
	438	}
f3ed775e DG	439
f3ed775e DG	440	/*
9f19cc17	441	* List available domain(s) for a session.
f3ed775e	442	*/
cd80958d	443	static int list_domains(void)
f3ed775e	444	{
9f19cc17 DG	445	int i, count, ret = CMD_SUCCESS;
	446	struct lttng_domain *domains = NULL;
	447
	448	MSG("Domains:\n-------------");
	449
cd80958d	450	count = lttng_list_domains(handle, &domains);
9f19cc17 DG	451	if (count < 0) {
	452	ret = count;
	453	goto error;
	454	} else if (count == 0) {
	455	MSG(" None");
	456	goto end;
	457	}
	458
	459	for (i = 0; i < count; i++) {
	460	switch (domains[i].type) {
	461	case LTTNG_DOMAIN_KERNEL:
	462	MSG(" - Kernel");
b551a063 DG	463	break;
	464	case LTTNG_DOMAIN_UST:
	465	MSG(" - UST global");
	466	break;
9f19cc17 DG	467	default:
	468	break;
	469	}
	470	}
	471
	472	end:
	473	free(domains);
	474
	475	error:
	476	return ret;
f3ed775e	477	}
f3ed775e DG	478
f3ed775e DG	479	/*
9f19cc17	480	* The 'list <options>' first level command
f3ed775e DG	481	*/
	482	int cmd_list(int argc, const char **argv)
	483	{
9f19cc17	484	int opt, i, ret = CMD_SUCCESS;
b551a063	485	unsigned int nb_domain;
9f19cc17	486	const char *session_name;
f3ed775e	487	static poptContext pc;
9f19cc17 DG	488	struct lttng_domain domain;
9f19cc17 DG	489	struct lttng_domain *domains = NULL;
f3ed775e	490
9f19cc17	491	if (argc < 1) {
f3ed775e DG	492	usage(stderr);
	493	goto end;
	494	}
	495
	496	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	497	poptReadDefaultConfig(pc, 0);
	498
	499	while ((opt = poptGetNextOpt(pc)) != -1) {
	500	switch (opt) {
	501	case OPT_HELP:
	502	usage(stderr);
	503	goto end;
eeac7d46 MD	504	case OPT_USERSPACE:
eeac7d46 MD	505	opt_userspace = 1;
eeac7d46	506	break;
f3ed775e DG	507	default:
	508	usage(stderr);
	509	ret = CMD_UNDEFINED;
	510	goto end;
	511	}
	512	}
	513
b551a063 DG	514	if (opt_pid != 0) {
b551a063 DG	515	MSG("* Userspace tracing not implemented for PID *\n");
f3ed775e DG	516	}
f3ed775e DG	517
9f19cc17 DG	518	/* Get session name (trailing argument) */
9f19cc17 DG	519	session_name = poptGetArg(pc);
b551a063	520	DBG2("Session name: %s", session_name);
9f19cc17	521
cd80958d DG	522	if (opt_kernel) {
cd80958d DG	523	domain.type = LTTNG_DOMAIN_KERNEL;
b551a063 DG	524	} else if (opt_userspace) {
	525	DBG2("Listing userspace global domain");
	526	domain.type = LTTNG_DOMAIN_UST;
cd80958d DG	527	}
	528
	529	handle = lttng_create_handle(session_name, &domain);
	530	if (handle == NULL) {
	531	goto end;
	532	}
	533
9f19cc17	534	if (session_name == NULL) {
b551a063 DG	535	if (!opt_kernel && !opt_userspace) {
	536	ret = list_sessions(NULL);
	537	if (ret < 0) {
	538	goto end;
	539	}
	540	}
9f19cc17 DG	541	if (opt_kernel) {
	542	ret = list_kernel_events();
	543	if (ret < 0) {
	544	goto end;
	545	}
b551a063 DG	546	}
	547	if (opt_userspace) {
	548	ret = list_ust_events();
9f19cc17 DG	549	if (ret < 0) {
	550	goto end;
	551	}
	552	}
	553	} else {
	554	/* List session attributes */
	555	ret = list_sessions(session_name);
	556	if (ret < 0) {
	557	goto end;
	558	}
	559
	560	/* Domain listing */
	561	if (opt_domain) {
cd80958d	562	ret = list_domains();
9f19cc17 DG	563	goto end;
	564	}
	565
	566	if (opt_kernel) {
9f19cc17	567	/* Channel listing */
cd80958d	568	ret = list_channels(opt_channel);
9f19cc17 DG	569	if (ret < 0) {
	570	goto end;
	571	}
9f19cc17 DG	572	} else {
9f19cc17 DG	573	/* We want all domain(s) */
b551a063 DG	574	nb_domain = lttng_list_domains(handle, &domains);
	575	if (nb_domain < 0) {
	576	ret = nb_domain;
9f19cc17 DG	577	goto end;
	578	}
	579
b551a063	580	for (i = 0; i < nb_domain; i++) {
9f19cc17 DG	581	switch (domains[i].type) {
	582	case LTTNG_DOMAIN_KERNEL:
	583	MSG("=== Domain: Kernel ===\n");
	584	break;
b551a063 DG	585	case LTTNG_DOMAIN_UST:
	586	MSG("=== Domain: UST global ===\n");
	587	break;
9f19cc17 DG	588	default:
	589	MSG("=== Domain: Unimplemented ===\n");
	590	break;
	591	}
	592
cd80958d DG	593	/* Clean handle before creating a new one */
	594	lttng_destroy_handle(handle);
	595
	596	handle = lttng_create_handle(session_name, &domains[i]);
	597	if (handle == NULL) {
	598	goto end;
	599	}
	600
	601	ret = list_channels(opt_channel);
9f19cc17 DG	602	if (ret < 0) {
	603	goto end;
	604	}
	605	}
	606	}
f3ed775e DG	607	}
	608
	609	end:
9f19cc17 DG	610	if (domains) {
	611	free(domains);
	612	}
cd80958d DG	613	lttng_destroy_handle(handle);
cd80958d DG	614
f3ed775e DG	615	return ret;
f3ed775e DG	616	}