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