[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(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:
	{
		if (event->loglevel != -1) {
			MSG("%s%s (loglevel: %s (%d)) (type: tracepoint)%s",
				indent6,
				event->name,
				loglevel_string(event->loglevel),
				event->loglevel,
				enabled_string(event->enabled));
		} else {
			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("%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;
	} else if (count == 0) {
		MSG("Currently no available tracing session");
		goto end;
	}

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

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