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

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; only version 2
 * of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

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

#include "../command.h"

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

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

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

static struct lttng_handle *handle;

static struct poptOption long_options[] = {
	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	{"help",      'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	{"kernel",    'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
#if 0
	/* Not implemented yet */
	{"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
	{"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
#else
	{"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
#endif
	{"channel",   'c', POPT_ARG_STRING, &opt_channel, 0, 0, 0},
	{"domain",    'd', POPT_ARG_VAL, &opt_domain, 1, 0, 0},
	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
	{0, 0, 0, 0, 0, 0, 0}
};

/*
 * usage
 */
static void usage(FILE *ofp)
{
	fprintf(ofp, "usage: lttng list [OPTIONS] [SESSION [<OPTIONS>]]\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "With no arguments, list available tracing session(s)\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Without a session, -k lists available kernel events\n");
	fprintf(ofp, "Without a session, -u lists available userspace events\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "  -h, --help              Show this help\n");
	fprintf(ofp, "      --list-options      Simple listing of options\n");
	fprintf(ofp, "  -k, --kernel            Select kernel domain\n");
	fprintf(ofp, "  -u, --userspace         Select user-space domain.\n");
#if 0
	fprintf(ofp, "  -p, --pid PID           List user-space events by PID\n");
#endif
	fprintf(ofp, "\n");
	fprintf(ofp, "Session Options:\n");
	fprintf(ofp, "  -c, --channel NAME      List details of a channel\n");
	fprintf(ofp, "  -d, --domain            List available domain(s)\n");
	fprintf(ofp, "\n");
}

/*
 * Get command line from /proc for a specific pid.
 *
 * On success, return an allocated string pointer to the proc cmdline.
 * On error, return NULL.
 */
static char *get_cmdline_by_pid(pid_t pid)
{
	int ret;
	FILE *fp;
	char *cmdline = NULL;
	char path[24];	/* Can't go bigger than /proc/65535/cmdline */

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

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

end:
	return cmdline;
}

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

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

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

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

static const char *loglevel_string(int value)
{
	switch (value) {
	case -1: return "";
	case 0: return "TRACE_EMERG";
	case 1: return "TRACE_ALERT";
	case 2: return "TRACE_CRIT";
	case 3: return "TRACE_ERR";
	case 4: return "TRACE_WARNING";
	case 5: return "TRACE_NOTICE";
	case 6: return "TRACE_INFO";
	case 7: return "TRACE_DEBUG_SYSTEM";
	case 8: return "TRACE_DEBUG_PROGRAM";
	case 9: return "TRACE_DEBUG_PROCESS";
	case 10: return "TRACE_DEBUG_MODULE";
	case 11: return "TRACE_DEBUG_UNIT";
	case 12: return "TRACE_DEBUG_FUNCTION";
	case 13: return "TRACE_DEBUG_LINE";
	case 14: return "TRACE_DEBUG";
	default: return "<<UNKNOWN>>";
	}
}

/*
 * Pretty print single event.
 */
static void print_events(struct lttng_event *event)
{
	switch (event->type) {
	case LTTNG_EVENT_TRACEPOINT:
	{
		MSG("%s%s%s%s%s (type: tracepoint)%s", indent6,
				event->name,
				loglevel_string_pre(event->loglevel),
				loglevel_string(event->loglevel),
				loglevel_string_post(event->loglevel),
				enabled_string(event->enabled));
		break;
	}
	case LTTNG_EVENT_PROBE:
		MSG("%s%s (type: probe)%s", indent6,
				event->name, enabled_string(event->enabled));
		if (event->attr.probe.addr != 0) {
			MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
		} else {
			MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
			MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
		}
		break;
	case LTTNG_EVENT_FUNCTION:
	case LTTNG_EVENT_FUNCTION_ENTRY:
		MSG("%s%s (type: function)%s", indent6,
				event->name, enabled_string(event->enabled));
		MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
		break;
	case LTTNG_EVENT_SYSCALL:
		MSG("%ssyscalls (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;

	memset(&domain, 0, sizeof(domain));

	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");
		lttng_destroy_handle(handle);
		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);
	lttng_destroy_handle(handle);

	return CMD_SUCCESS;

error:
	lttng_destroy_handle(handle);
	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;

	memset(&domain, 0, sizeof(domain));

	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");
		lttng_destroy_handle(handle);
		return size;
	}

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

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

	MSG("");

	free(event_list);

	lttng_destroy_handle(handle);
	return CMD_SUCCESS;

error:
	lttng_destroy_handle(handle);
	return -1;
}

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

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

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

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

	MSG("");

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

error:
	return ret;
}

/*
 * Pretty print channel
 */
static void print_channel(struct lttng_channel *channel)
{
	MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));

	MSG("%sAttributes:", indent4);
	MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
	MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
	MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
	MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
	MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
	switch (channel->attr.output) {
		case LTTNG_EVENT_SPLICE:
			MSG("%soutput: splice()", indent6);
			break;
		case LTTNG_EVENT_MMAP:
			MSG("%soutput: mmap()", indent6);
			break;
	}
}

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

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

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

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

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

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

		if (chan_found) {
			break;
		}
	}

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

	ret = CMD_SUCCESS;

error:
	free(channels);

error_channels:
	return ret;
}

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

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

	if (session_name == NULL) {
		MSG("Available tracing sessions:");
	}

	for (i = 0; i < count; i++) {
		if (session_name != NULL) {
			if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
				session_found = 1;
				MSG("Tracing session %s:%s", session_name, active_string(sessions[i].enabled));
				MSG("%sTrace path: %s\n", indent4, sessions[i].path);
				break;
			}
			continue;
		}

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

		if (session_found) {
			break;
		}
	}

	free(sessions);

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

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

	return CMD_SUCCESS;

error:
	return ret;
}

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

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

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

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

end:
	free(domains);

error:
	return ret;
}

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

	memset(&domain, 0, sizeof(domain));

	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;
	}

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

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

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

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

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

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

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

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

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

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