[lttng-tools.git] / src / bin / lttng / commands / add_context.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 <ctype.h>
#include <popt.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>

#include <urcu/list.h>

#include "../command.h"

#define PRINT_LINE_LEN	80

static char *opt_event_name;
static char *opt_channel_name;
static char *opt_session_name;
static int opt_kernel;
static int opt_userspace;
static char *opt_type;
#if 0
/* Not implemented yet */
static char *opt_cmd_name;
static pid_t opt_pid;
#endif

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

static struct lttng_handle *handle;

/*
 * Taken from the LTTng ABI
 */
enum context_type {
	CONTEXT_PID          = 0,
	CONTEXT_PERF_COUNTER = 1,
	CONTEXT_PROCNAME     = 2,
	CONTEXT_PRIO         = 3,
	CONTEXT_NICE         = 4,
	CONTEXT_VPID         = 5,
	CONTEXT_TID          = 6,
	CONTEXT_VTID         = 7,
	CONTEXT_PPID         = 8,
	CONTEXT_VPPID        = 9,
};

/*
 * Taken from the Perf ABI (all enum perf_*)
 */
enum perf_type {
	PERF_TYPE_HARDWARE = 0,
	PERF_TYPE_SOFTWARE = 1,
	PERF_TYPE_HW_CACHE = 3,
};

enum perf_count_hard {
	PERF_COUNT_HW_CPU_CYCLES		= 0,
	PERF_COUNT_HW_INSTRUCTIONS		= 1,
	PERF_COUNT_HW_CACHE_REFERENCES		= 2,
	PERF_COUNT_HW_CACHE_MISSES		= 3,
	PERF_COUNT_HW_BRANCH_INSTRUCTIONS	= 4,
	PERF_COUNT_HW_BRANCH_MISSES		= 5,
	PERF_COUNT_HW_BUS_CYCLES		= 6,
	PERF_COUNT_HW_STALLED_CYCLES_FRONTEND	= 7,
	PERF_COUNT_HW_STALLED_CYCLES_BACKEND	= 8,
};

enum perf_count_soft {
	PERF_COUNT_SW_CPU_CLOCK        = 0,
	PERF_COUNT_SW_TASK_CLOCK       = 1,
	PERF_COUNT_SW_PAGE_FAULTS      = 2,
	PERF_COUNT_SW_CONTEXT_SWITCHES = 3,
	PERF_COUNT_SW_CPU_MIGRATIONS   = 4,
	PERF_COUNT_SW_PAGE_FAULTS_MIN  = 5,
	PERF_COUNT_SW_PAGE_FAULTS_MAJ  = 6,
	PERF_COUNT_SW_ALIGNMENT_FAULTS = 7,
	PERF_COUNT_SW_EMULATION_FAULTS = 8,
};

/*
 * Generalized hardware cache events:
 *
 *       { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
 *       { read, write, prefetch } x
 *       { accesses, misses }
 */
enum perf_hw_cache_id {
	PERF_COUNT_HW_CACHE_L1D			= 0,
	PERF_COUNT_HW_CACHE_L1I			= 1,
	PERF_COUNT_HW_CACHE_LL			= 2,
	PERF_COUNT_HW_CACHE_DTLB		= 3,
	PERF_COUNT_HW_CACHE_ITLB		= 4,
	PERF_COUNT_HW_CACHE_BPU			= 5,

	PERF_COUNT_HW_CACHE_MAX,		/* non-ABI */
};

enum perf_hw_cache_op_id {
	PERF_COUNT_HW_CACHE_OP_READ		= 0,
	PERF_COUNT_HW_CACHE_OP_WRITE		= 1,
	PERF_COUNT_HW_CACHE_OP_PREFETCH		= 2,

	PERF_COUNT_HW_CACHE_OP_MAX,		/* non-ABI */
};

enum perf_hw_cache_op_result_id {
	PERF_COUNT_HW_CACHE_RESULT_ACCESS	= 0,
	PERF_COUNT_HW_CACHE_RESULT_MISS		= 1,

	PERF_COUNT_HW_CACHE_RESULT_MAX,		/* non-ABI */
};

static struct poptOption long_options[] = {
	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	{"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	{"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
	{"channel",        'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
	{"event",          'e', POPT_ARG_STRING, &opt_event_name, 0, 0, 0},
	{"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
#if 0
	/* Not implemented yet */
	{"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	{"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
#else
	{"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
#endif
	{"type",           't', POPT_ARG_STRING, &opt_type, OPT_TYPE, 0, 0},
	{"list-options",   0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
	{0, 0, 0, 0, 0, 0, 0}
};

/*
 * Context options
 */
#define PERF_HW(opt, name)						\
	{								\
		"perf:" #opt, CONTEXT_PERF_COUNTER,			\
		.u.perf = { PERF_TYPE_HARDWARE, PERF_COUNT_HW_##name, },\
	}

#define PERF_SW(opt, name)						\
	{								\
		"perf:" #opt, CONTEXT_PERF_COUNTER,			\
		.u.perf = { PERF_TYPE_SOFTWARE, PERF_COUNT_SW_##name, },\
	}

#define _PERF_HW_CACHE(optstr, name, op, result)			\
	{								\
		"perf:" optstr, CONTEXT_PERF_COUNTER,			\
		.u.perf = {						\
			PERF_TYPE_HW_CACHE,				\
			(uint64_t) PERF_COUNT_HW_CACHE_##name		\
			| ((uint64_t) PERF_COUNT_HW_CACHE_OP_##op << 8)	\
			| ((uint64_t) PERF_COUNT_HW_CACHE_RESULT_##result << 16), \
		},							\
	}

#define PERF_HW_CACHE(opt, name)					\
	_PERF_HW_CACHE(#opt "-loads", name, READ, ACCESS),		\
	_PERF_HW_CACHE(#opt "-load-misses", name, READ, MISS),		\
	_PERF_HW_CACHE(#opt "-stores", name, WRITE, ACCESS),		\
	_PERF_HW_CACHE(#opt "-store-misses", name, WRITE, MISS),	\
	_PERF_HW_CACHE(#opt "-prefetches", name, PREFETCH, ACCESS),	\
	_PERF_HW_CACHE(#opt "-prefetch-misses", name, PREFETCH, MISS)	\

static
const struct ctx_opts {
	char *symbol;
	enum context_type ctx_type;
	union {
		struct {
			uint32_t type;
			uint64_t config;
		} perf;
	} u;
} ctx_opts[] = {
	{ "pid", CONTEXT_PID },
	{ "procname", CONTEXT_PROCNAME },
	{ "prio", CONTEXT_PRIO },
	{ "nice", CONTEXT_NICE },
	{ "vpid", CONTEXT_VPID },
	{ "tid", CONTEXT_TID },
	{ "vtid", CONTEXT_VTID },
	{ "ppid", CONTEXT_PPID },
	{ "vppid", CONTEXT_VPPID },
	/* Perf options */
	PERF_HW(cpu-cycles, CPU_CYCLES),
	PERF_HW(cycles, CPU_CYCLES),
	PERF_HW(stalled-cycles-frontend, STALLED_CYCLES_FRONTEND),
	PERF_HW(idle-cycles-frontend, STALLED_CYCLES_FRONTEND),
	PERF_HW(stalled-cycles-backend, STALLED_CYCLES_BACKEND),
	PERF_HW(idle-cycles-backend, STALLED_CYCLES_BACKEND),
	PERF_HW(instructions, INSTRUCTIONS),
	PERF_HW(cache-references, CACHE_REFERENCES),
	PERF_HW(cache-misses, CACHE_MISSES),
	PERF_HW(branch-instructions, BRANCH_INSTRUCTIONS),
	PERF_HW(branches, BRANCH_INSTRUCTIONS),
	PERF_HW(branch-misses, BRANCH_MISSES),
	PERF_HW(bus-cycles, BUS_CYCLES),

	PERF_HW_CACHE(L1-dcache, L1D),
	PERF_HW_CACHE(L1-icache, L1I),
	PERF_HW_CACHE(LLC, LL),
	PERF_HW_CACHE(dTLB, DTLB),
	_PERF_HW_CACHE("iTLB-loads", ITLB, READ, ACCESS),
	_PERF_HW_CACHE("iTLB-load-misses", ITLB, READ, MISS),
	_PERF_HW_CACHE("branch-loads", BPU, READ, ACCESS),
	_PERF_HW_CACHE("branch-load-misses", BPU, READ, MISS),


	PERF_SW(cpu-clock, CPU_CLOCK),
	PERF_SW(task-clock, TASK_CLOCK),
	PERF_SW(page-fault, PAGE_FAULTS),
	PERF_SW(faults, PAGE_FAULTS),
	PERF_SW(major-faults, PAGE_FAULTS_MAJ),
	PERF_SW(minor-faults, PAGE_FAULTS_MIN),
	PERF_SW(context-switches, CONTEXT_SWITCHES),
	PERF_SW(cs, CONTEXT_SWITCHES),
	PERF_SW(cpu-migrations, CPU_MIGRATIONS),
	PERF_SW(migrations, CPU_MIGRATIONS),
	PERF_SW(alignment-faults, ALIGNMENT_FAULTS),
	PERF_SW(emulation-faults, EMULATION_FAULTS),
	{ NULL, -1 },		/* Closure */
};

#undef PERF_SW
#undef PERF_HW

/*
 * Context type for command line option parsing.
 */
struct ctx_type {
	const struct ctx_opts *opt;
	struct cds_list_head list;
};

/*
 * List of context type. Use to enable multiple context on a single command
 * line entry.
 */
struct ctx_type_list {
	struct cds_list_head head;
} ctx_type_list = {
	.head = CDS_LIST_HEAD_INIT(ctx_type_list.head),
};

/*
 * Pretty print context type.
 */
static void print_ctx_type(FILE *ofp)
{
	const char *indent = "                               ";
	int indent_len = strlen(indent);
	int len, i = 0;

	fprintf(ofp, "%s", indent);
	len = indent_len;
	while (ctx_opts[i].symbol != NULL) {
		if (len > indent_len) {
			if (len + strlen(ctx_opts[i].symbol) + 2
					>= PRINT_LINE_LEN) {
				fprintf(ofp, ",\n");
				fprintf(ofp, "%s", indent);
				len = indent_len;
			} else {
				len += fprintf(ofp, ", ");
			}
		}
		len += fprintf(ofp, "%s", ctx_opts[i].symbol);
		i++;
	}
}

/*
 * usage
 */
static void usage(FILE *ofp)
{
	fprintf(ofp, "usage: lttng add-context -t TYPE\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "If no event name is given (-e), the context will be added to the channel\n");
	fprintf(ofp, "If no channel and no event is given (-c/-e), the context\n");
	fprintf(ofp, "will be added to all events and all channels.\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Options:\n");
	fprintf(ofp, "  -h, --help               Show this help\n");
	fprintf(ofp, "      --list-options       Simple listing of options\n");
	fprintf(ofp, "  -s, --session            Apply on session name\n");
	fprintf(ofp, "  -c, --channel NAME       Apply on channel\n");
	fprintf(ofp, "  -e, --event NAME         Apply on event\n");
	fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
#if 0
	fprintf(ofp, "  -u, --userspace [CMD]    Apply for the user-space tracer\n");
	fprintf(ofp, "                           If no CMD, the domain used is UST global\n");
	fprintf(ofp, "                           or else the domain is UST EXEC_NAME\n");
	fprintf(ofp, "  -p, --pid PID            If -u, apply to specific PID (domain: UST PID)\n");
#else
	fprintf(ofp, "  -u, --userspace          Apply for the user-space tracer\n");
#endif
	fprintf(ofp, "  -t, --type TYPE          Context type. You can repeat that option on\n");
	fprintf(ofp, "                           the command line.\n");
	fprintf(ofp, "                           TYPE can be one of the strings below:\n");
	print_ctx_type(ofp);
	fprintf(ofp, "\n");
	fprintf(ofp, "Example:\n");
	fprintf(ofp, "This command will add the context information 'prio' and two perf\n"
			"counters: hardware branch misses and cache misses, to all events\n"
			"in the trace data output:\n");
	fprintf(ofp, "# lttng add-context -k -t prio -t perf:branch-misses -t perf:cache-misses\n");
	fprintf(ofp, "\n");
}

/*
 * Find context numerical value from string.
 */
static int find_ctx_type_idx(const char *opt)
{
	int ret = -1, i = 0;

	while (ctx_opts[i].symbol != NULL) {
		if (strcmp(opt, ctx_opts[i].symbol) == 0) {
			ret = i;
			goto end;
		}
		i++;
	}

end:
	return ret;
}

/*
 * Add context to channel or event.
 */
static int add_context(char *session_name)
{
	int ret = CMD_SUCCESS;
	struct lttng_event_context context;
	struct lttng_domain dom;
	struct ctx_type *type;
	char *ptr;

	if (opt_kernel) {
		dom.type = LTTNG_DOMAIN_KERNEL;
	} else if (opt_userspace) {
		dom.type = LTTNG_DOMAIN_UST;
	} else {
		ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
		ret = CMD_UNDEFINED;
		goto error;
	}

	handle = lttng_create_handle(session_name, &dom);
	if (handle == NULL) {
		ret = -1;
		goto error;
	}

	/* Iterate over all context type given */
	cds_list_for_each_entry(type, &ctx_type_list.head, list) {
		context.ctx = type->opt->ctx_type;
		if (context.ctx == LTTNG_EVENT_CONTEXT_PERF_COUNTER) {
			context.u.perf_counter.type = type->opt->u.perf.type;
			context.u.perf_counter.config = type->opt->u.perf.config;
			strcpy(context.u.perf_counter.name, type->opt->symbol);
			/* Replace : and - by _ */
			while ((ptr = strchr(context.u.perf_counter.name, '-')) != NULL) {
				*ptr = '_';
			}
			while ((ptr = strchr(context.u.perf_counter.name, ':')) != NULL) {
				*ptr = '_';
			}
		}
		DBG("Adding context...");

		ret = lttng_add_context(handle, &context, opt_event_name,
				opt_channel_name);
		if (ret < 0) {
			fprintf(stderr, "%s: ", type->opt->symbol);
			continue;
		} else {
			MSG("%s context %s added to %s event in %s",
					opt_kernel ? "kernel" : "UST", type->opt->symbol,
					opt_event_name ? opt_event_name : "all",
					opt_channel_name ? opt_channel_name : "all channels");
		}
	}

error:
	lttng_destroy_handle(handle);

	return ret;
}

/*
 * Add context on channel or event.
 */
int cmd_add_context(int argc, const char **argv)
{
	int index, opt, ret = CMD_SUCCESS;
	static poptContext pc;
	struct ctx_type *type, *tmptype;
	char *session_name = NULL;

	if (argc < 2) {
		usage(stderr);
		goto end;
	}

	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	poptReadDefaultConfig(pc, 0);

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
		case OPT_HELP:
			usage(stderr);
			ret = CMD_SUCCESS;
			goto end;
		case OPT_TYPE:
			type = malloc(sizeof(struct ctx_type));
			if (type == NULL) {
				perror("malloc ctx_type");
				ret = -1;
				goto end;
			}
			index = find_ctx_type_idx(opt_type);
			if (index < 0) {
				ERR("Unknown context type %s", opt_type);
				goto end;
			}
			type->opt = &ctx_opts[index];
			if (type->opt->ctx_type == -1) {
				ERR("Unknown context type %s", opt_type);
			} else {
				cds_list_add(&type->list, &ctx_type_list.head);
			}
			break;
		case OPT_USERSPACE:
			opt_userspace = 1;
#if 0
			opt_cmd_name = poptGetOptArg(pc);
#endif
			break;
		case OPT_LIST_OPTIONS:
			list_cmd_options(stdout, long_options);
			ret = CMD_SUCCESS;
			goto end;
		default:
			usage(stderr);
			ret = CMD_UNDEFINED;
			goto end;
		}
	}

	if (!opt_session_name) {
		session_name = get_session_name();
		if (session_name == NULL) {
			ret = -1;
			goto end;
		}
	} else {
		session_name = opt_session_name;
	}

	ret = add_context(session_name);

	/* Cleanup allocated memory */
	cds_list_for_each_entry_safe(type, tmptype, &ctx_type_list.head, list) {
		free(type);
	}

end:
	return ret;
}
Commit	Line	Data
d65106b1 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.
d65106b1 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
90b9a268	20	#include <ctype.h>
d65106b1 DG	21	#include <popt.h>
	22	#include <stdio.h>
	23	#include <stdlib.h>
	24	#include <string.h>
	25	#include <sys/stat.h>
	26	#include <sys/types.h>
	27	#include <unistd.h>
	28
3301e740 DG	29	#include <urcu/list.h>
3301e740 DG	30
c399183f	31	#include "../command.h"
d65106b1	32
b13d56d7 MD	33	#define PRINT_LINE_LEN 80
b13d56d7 MD	34
d65106b1 DG	35	static char *opt_event_name;
d65106b1 DG	36	static char *opt_channel_name;
5440dc42	37	static char *opt_session_name;
55cc08a6	38	static int opt_kernel;
d65106b1	39	static int opt_userspace;
d78d6610 DG	40	static char *opt_type;
	41	#if 0
	42	/* Not implemented yet */
eeac7d46	43	static char *opt_cmd_name;
d65106b1	44	static pid_t opt_pid;
d78d6610	45	#endif
d65106b1 DG	46
	47	enum {
	48	OPT_HELP = 1,
	49	OPT_TYPE,
eeac7d46	50	OPT_USERSPACE,
679b4943	51	OPT_LIST_OPTIONS,
d65106b1 DG	52	};
d65106b1 DG	53
cd80958d DG	54	static struct lttng_handle *handle;
cd80958d DG	55
90b9a268 DG	56	/*
	57	* Taken from the LTTng ABI
	58	*/
	59	enum context_type {
	60	CONTEXT_PID = 0,
	61	CONTEXT_PERF_COUNTER = 1,
95da1297	62	CONTEXT_PROCNAME = 2,
90b9a268 DG	63	CONTEXT_PRIO = 3,
	64	CONTEXT_NICE = 4,
	65	CONTEXT_VPID = 5,
	66	CONTEXT_TID = 6,
	67	CONTEXT_VTID = 7,
	68	CONTEXT_PPID = 8,
	69	CONTEXT_VPPID = 9,
3301e740 DG	70	};
3301e740 DG	71
90b9a268 DG	72	/*
	73	* Taken from the Perf ABI (all enum perf_*)
	74	*/
	75	enum perf_type {
	76	PERF_TYPE_HARDWARE = 0,
	77	PERF_TYPE_SOFTWARE = 1,
b13d56d7	78	PERF_TYPE_HW_CACHE = 3,
3301e740 DG	79	};
3301e740 DG	80
90b9a268	81	enum perf_count_hard {
b13d56d7 MD	82	PERF_COUNT_HW_CPU_CYCLES = 0,
	83	PERF_COUNT_HW_INSTRUCTIONS = 1,
	84	PERF_COUNT_HW_CACHE_REFERENCES = 2,
	85	PERF_COUNT_HW_CACHE_MISSES = 3,
	86	PERF_COUNT_HW_BRANCH_INSTRUCTIONS = 4,
	87	PERF_COUNT_HW_BRANCH_MISSES = 5,
	88	PERF_COUNT_HW_BUS_CYCLES = 6,
	89	PERF_COUNT_HW_STALLED_CYCLES_FRONTEND = 7,
	90	PERF_COUNT_HW_STALLED_CYCLES_BACKEND = 8,
90b9a268 DG	91	};
	92
	93	enum perf_count_soft {
	94	PERF_COUNT_SW_CPU_CLOCK = 0,
	95	PERF_COUNT_SW_TASK_CLOCK = 1,
	96	PERF_COUNT_SW_PAGE_FAULTS = 2,
	97	PERF_COUNT_SW_CONTEXT_SWITCHES = 3,
	98	PERF_COUNT_SW_CPU_MIGRATIONS = 4,
	99	PERF_COUNT_SW_PAGE_FAULTS_MIN = 5,
	100	PERF_COUNT_SW_PAGE_FAULTS_MAJ = 6,
	101	PERF_COUNT_SW_ALIGNMENT_FAULTS = 7,
	102	PERF_COUNT_SW_EMULATION_FAULTS = 8,
3301e740 DG	103	};
3301e740 DG	104
b13d56d7 MD	105	/*
	106	* Generalized hardware cache events:
	107	*
	108	* { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
	109	* { read, write, prefetch } x
	110	* { accesses, misses }
	111	*/
	112	enum perf_hw_cache_id {
	113	PERF_COUNT_HW_CACHE_L1D = 0,
	114	PERF_COUNT_HW_CACHE_L1I = 1,
	115	PERF_COUNT_HW_CACHE_LL = 2,
	116	PERF_COUNT_HW_CACHE_DTLB = 3,
	117	PERF_COUNT_HW_CACHE_ITLB = 4,
	118	PERF_COUNT_HW_CACHE_BPU = 5,
	119
	120	PERF_COUNT_HW_CACHE_MAX, /* non-ABI */
	121	};
	122
	123	enum perf_hw_cache_op_id {
	124	PERF_COUNT_HW_CACHE_OP_READ = 0,
	125	PERF_COUNT_HW_CACHE_OP_WRITE = 1,
	126	PERF_COUNT_HW_CACHE_OP_PREFETCH = 2,
	127
	128	PERF_COUNT_HW_CACHE_OP_MAX, /* non-ABI */
	129	};
	130
	131	enum perf_hw_cache_op_result_id {
	132	PERF_COUNT_HW_CACHE_RESULT_ACCESS = 0,
	133	PERF_COUNT_HW_CACHE_RESULT_MISS = 1,
	134
	135	PERF_COUNT_HW_CACHE_RESULT_MAX, /* non-ABI */
	136	};
	137
d65106b1 DG	138	static struct poptOption long_options[] = {
	139	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	140	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42	141	{"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
d65106b1 DG	142	{"channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
	143	{"event", 'e', POPT_ARG_STRING, &opt_event_name, 0, 0, 0},
	144	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610 DG	145	#if 0
d78d6610 DG	146	/* Not implemented yet */
d65106b1	147	{"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
d78d6610 DG	148	{"userspace", 'u', POPT_ARG_STRING \| POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
	149	#else
	150	{"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
	151	#endif
6caa2bcc	152	{"type", 't', POPT_ARG_STRING, &opt_type, OPT_TYPE, 0, 0},
679b4943	153	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
d65106b1 DG	154	{0, 0, 0, 0, 0, 0, 0}
	155	};
	156
90b9a268	157	/*
b13d56d7	158	* Context options
90b9a268	159	*/
b13d56d7 MD	160	#define PERF_HW(opt, name) \
	161	{ \
	162	"perf:" #opt, CONTEXT_PERF_COUNTER, \
	163	.u.perf = { PERF_TYPE_HARDWARE, PERF_COUNT_HW_##name, },\
	164	}
90b9a268	165
b13d56d7 MD	166	#define PERF_SW(opt, name) \
	167	{ \
	168	"perf:" #opt, CONTEXT_PERF_COUNTER, \
	169	.u.perf = { PERF_TYPE_SOFTWARE, PERF_COUNT_SW_##name, },\
	170	}
90b9a268	171
b13d56d7 MD	172	#define _PERF_HW_CACHE(optstr, name, op, result) \
	173	{ \
	174	"perf:" optstr, CONTEXT_PERF_COUNTER, \
	175	.u.perf = { \
	176	PERF_TYPE_HW_CACHE, \
	177	(uint64_t) PERF_COUNT_HW_CACHE_##name \
18829107 MD	178	\| ((uint64_t) PERF_COUNT_HW_CACHE_OP_##op << 8) \
18829107 MD	179	\| ((uint64_t) PERF_COUNT_HW_CACHE_RESULT_##result << 16), \
b13d56d7 MD	180	}, \
	181	}
	182
	183	#define PERF_HW_CACHE(opt, name) \
	184	_PERF_HW_CACHE(#opt "-loads", name, READ, ACCESS), \
	185	_PERF_HW_CACHE(#opt "-load-misses", name, READ, MISS), \
	186	_PERF_HW_CACHE(#opt "-stores", name, WRITE, ACCESS), \
	187	_PERF_HW_CACHE(#opt "-store-misses", name, WRITE, MISS), \
	188	_PERF_HW_CACHE(#opt "-prefetches", name, PREFETCH, ACCESS), \
	189	_PERF_HW_CACHE(#opt "-prefetch-misses", name, PREFETCH, MISS) \
	190
	191	static
	192	const struct ctx_opts {
90b9a268	193	char *symbol;
b13d56d7 MD	194	enum context_type ctx_type;
	195	union {
	196	struct {
	197	uint32_t type;
	198	uint64_t config;
	199	} perf;
	200	} u;
	201	} ctx_opts[] = {
	202	{ "pid", CONTEXT_PID },
95da1297	203	{ "procname", CONTEXT_PROCNAME },
b13d56d7 MD	204	{ "prio", CONTEXT_PRIO },
	205	{ "nice", CONTEXT_NICE },
	206	{ "vpid", CONTEXT_VPID },
	207	{ "tid", CONTEXT_TID },
	208	{ "vtid", CONTEXT_VTID },
	209	{ "ppid", CONTEXT_PPID },
	210	{ "vppid", CONTEXT_VPPID },
	211	/* Perf options */
	212	PERF_HW(cpu-cycles, CPU_CYCLES),
	213	PERF_HW(cycles, CPU_CYCLES),
	214	PERF_HW(stalled-cycles-frontend, STALLED_CYCLES_FRONTEND),
	215	PERF_HW(idle-cycles-frontend, STALLED_CYCLES_FRONTEND),
	216	PERF_HW(stalled-cycles-backend, STALLED_CYCLES_BACKEND),
	217	PERF_HW(idle-cycles-backend, STALLED_CYCLES_BACKEND),
	218	PERF_HW(instructions, INSTRUCTIONS),
	219	PERF_HW(cache-references, CACHE_REFERENCES),
	220	PERF_HW(cache-misses, CACHE_MISSES),
	221	PERF_HW(branch-instructions, BRANCH_INSTRUCTIONS),
	222	PERF_HW(branches, BRANCH_INSTRUCTIONS),
	223	PERF_HW(branch-misses, BRANCH_MISSES),
	224	PERF_HW(bus-cycles, BUS_CYCLES),
	225
	226	PERF_HW_CACHE(L1-dcache, L1D),
	227	PERF_HW_CACHE(L1-icache, L1I),
	228	PERF_HW_CACHE(LLC, LL),
	229	PERF_HW_CACHE(dTLB, DTLB),
	230	_PERF_HW_CACHE("iTLB-loads", ITLB, READ, ACCESS),
	231	_PERF_HW_CACHE("iTLB-load-misses", ITLB, READ, MISS),
	232	_PERF_HW_CACHE("branch-loads", BPU, READ, ACCESS),
	233	_PERF_HW_CACHE("branch-load-misses", BPU, READ, MISS),
	234
	235
	236	PERF_SW(cpu-clock, CPU_CLOCK),
	237	PERF_SW(task-clock, TASK_CLOCK),
	238	PERF_SW(page-fault, PAGE_FAULTS),
	239	PERF_SW(faults, PAGE_FAULTS),
	240	PERF_SW(major-faults, PAGE_FAULTS_MAJ),
	241	PERF_SW(minor-faults, PAGE_FAULTS_MIN),
	242	PERF_SW(context-switches, CONTEXT_SWITCHES),
	243	PERF_SW(cs, CONTEXT_SWITCHES),
	244	PERF_SW(cpu-migrations, CPU_MIGRATIONS),
	245	PERF_SW(migrations, CPU_MIGRATIONS),
	246	PERF_SW(alignment-faults, ALIGNMENT_FAULTS),
	247	PERF_SW(emulation-faults, EMULATION_FAULTS),
	248	{ NULL, -1 }, /* Closure */
90b9a268 DG	249	};
90b9a268 DG	250
b13d56d7 MD	251	#undef PERF_SW
	252	#undef PERF_HW
	253
90b9a268	254	/*
b13d56d7	255	* Context type for command line option parsing.
90b9a268	256	*/
b13d56d7 MD	257	struct ctx_type {
	258	const struct ctx_opts *opt;
	259	struct cds_list_head list;
90b9a268 DG	260	};
	261
	262	/*
	263	* List of context type. Use to enable multiple context on a single command
	264	* line entry.
	265	*/
	266	struct ctx_type_list {
	267	struct cds_list_head head;
	268	} ctx_type_list = {
	269	.head = CDS_LIST_HEAD_INIT(ctx_type_list.head),
	270	};
	271
90b9a268 DG	272	/*
	273	* Pretty print context type.
	274	*/
	275	static void print_ctx_type(FILE *ofp)
	276	{
b13d56d7 MD	277	const char *indent = " ";
	278	int indent_len = strlen(indent);
	279	int len, i = 0;
90b9a268	280
76e3c5dd	281	fprintf(ofp, "%s", indent);
b13d56d7	282	len = indent_len;
90b9a268	283	while (ctx_opts[i].symbol != NULL) {
b13d56d7 MD	284	if (len > indent_len) {
	285	if (len + strlen(ctx_opts[i].symbol) + 2
	286	>= PRINT_LINE_LEN) {
	287	fprintf(ofp, ",\n");
76e3c5dd	288	fprintf(ofp, "%s", indent);
b13d56d7 MD	289	len = indent_len;
	290	} else {
	291	len += fprintf(ofp, ", ");
90b9a268 DG	292	}
90b9a268 DG	293	}
b13d56d7	294	len += fprintf(ofp, "%s", ctx_opts[i].symbol);
90b9a268 DG	295	i++;
90b9a268 DG	296	}
90b9a268 DG	297	}
90b9a268 DG	298
d65106b1 DG	299	/*
	300	* usage
	301	*/
	302	static void usage(FILE *ofp)
	303	{
b13d56d7	304	fprintf(ofp, "usage: lttng add-context -t TYPE\n");
d65106b1	305	fprintf(ofp, "\n");
55cc08a6	306	fprintf(ofp, "If no event name is given (-e), the context will be added to the channel\n");
b13d56d7	307	fprintf(ofp, "If no channel and no event is given (-c/-e), the context\n");
55cc08a6	308	fprintf(ofp, "will be added to all events and all channels.\n");
3301e740	309	fprintf(ofp, "\n");
d65106b1 DG	310	fprintf(ofp, "Options:\n");
d65106b1 DG	311	fprintf(ofp, " -h, --help Show this help\n");
679b4943	312	fprintf(ofp, " --list-options Simple listing of options\n");
5440dc42	313	fprintf(ofp, " -s, --session Apply on session name\n");
d65106b1 DG	314	fprintf(ofp, " -c, --channel NAME Apply on channel\n");
	315	fprintf(ofp, " -e, --event NAME Apply on event\n");
	316	fprintf(ofp, " -k, --kernel Apply for the kernel tracer\n");
d78d6610	317	#if 0
55cc08a6	318	fprintf(ofp, " -u, --userspace [CMD] Apply for the user-space tracer\n");
e14f64a8 DG	319	fprintf(ofp, " If no CMD, the domain used is UST global\n");
	320	fprintf(ofp, " or else the domain is UST EXEC_NAME\n");
	321	fprintf(ofp, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n");
d78d6610 DG	322	#else
	323	fprintf(ofp, " -u, --userspace Apply for the user-space tracer\n");
	324	#endif
b13d56d7 MD	325	fprintf(ofp, " -t, --type TYPE Context type. You can repeat that option on\n");
	326	fprintf(ofp, " the command line.\n");
	327	fprintf(ofp, " TYPE can be one of the strings below:\n");
90b9a268	328	print_ctx_type(ofp);
d65106b1	329	fprintf(ofp, "\n");
90b9a268	330	fprintf(ofp, "Example:\n");
b13d56d7	331	fprintf(ofp, "This command will add the context information 'prio' and two perf\n"
e0899ffa	332	"counters: hardware branch misses and cache misses, to all events\n"
b13d56d7 MD	333	"in the trace data output:\n");
b13d56d7 MD	334	fprintf(ofp, "# lttng add-context -k -t prio -t perf:branch-misses -t perf:cache-misses\n");
d65106b1 DG	335	fprintf(ofp, "\n");
	336	}
	337
90b9a268 DG	338	/*
	339	* Find context numerical value from string.
	340	*/
	341	static int find_ctx_type_idx(const char *opt)
	342	{
	343	int ret = -1, i = 0;
	344
	345	while (ctx_opts[i].symbol != NULL) {
	346	if (strcmp(opt, ctx_opts[i].symbol) == 0) {
	347	ret = i;
	348	goto end;
	349	}
	350	i++;
	351	}
	352
	353	end:
	354	return ret;
	355	}
	356
90b9a268 DG	357	/*
90b9a268 DG	358	* Add context to channel or event.
d65106b1	359	*/
cd80958d	360	static int add_context(char *session_name)
d65106b1	361	{
b13d56d7	362	int ret = CMD_SUCCESS;
7d29a247 DG	363	struct lttng_event_context context;
7d29a247 DG	364	struct lttng_domain dom;
3301e740	365	struct ctx_type *type;
b13d56d7	366	char *ptr;
d65106b1	367
cd80958d DG	368	if (opt_kernel) {
cd80958d DG	369	dom.type = LTTNG_DOMAIN_KERNEL;
d78d6610	370	} else if (opt_userspace) {
55cc08a6	371	dom.type = LTTNG_DOMAIN_UST;
55cc08a6	372	} else {
e14f64a8	373	ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
1ab1ea0b	374	ret = CMD_UNDEFINED;
55cc08a6	375	goto error;
cd80958d DG	376	}
	377
	378	handle = lttng_create_handle(session_name, &dom);
	379	if (handle == NULL) {
	380	ret = -1;
	381	goto error;
	382	}
	383
3301e740 DG	384	/* Iterate over all context type given */
3301e740 DG	385	cds_list_for_each_entry(type, &ctx_type_list.head, list) {
b13d56d7 MD	386	context.ctx = type->opt->ctx_type;
	387	if (context.ctx == LTTNG_EVENT_CONTEXT_PERF_COUNTER) {
	388	context.u.perf_counter.type = type->opt->u.perf.type;
	389	context.u.perf_counter.config = type->opt->u.perf.config;
d7b91b3c	390	strcpy(context.u.perf_counter.name, type->opt->symbol);
b13d56d7 MD	391	/* Replace : and - by _ */
	392	while ((ptr = strchr(context.u.perf_counter.name, '-')) != NULL) {
	393	*ptr = '_';
3301e740	394	}
b13d56d7 MD	395	while ((ptr = strchr(context.u.perf_counter.name, ':')) != NULL) {
b13d56d7 MD	396	*ptr = '_';
3301e740	397	}
3301e740	398	}
55cc08a6 DG	399	DBG("Adding context...");
	400
	401	ret = lttng_add_context(handle, &context, opt_event_name,
	402	opt_channel_name);
	403	if (ret < 0) {
	404	fprintf(stderr, "%s: ", type->opt->symbol);
	405	continue;
d65106b1	406	} else {
55cc08a6 DG	407	MSG("%s context %s added to %s event in %s",
	408	opt_kernel ? "kernel" : "UST", type->opt->symbol,
	409	opt_event_name ? opt_event_name : "all",
	410	opt_channel_name ? opt_channel_name : "all channels");
d65106b1	411	}
d65106b1 DG	412	}
	413
	414	error:
cd80958d DG	415	lttng_destroy_handle(handle);
cd80958d DG	416
d65106b1 DG	417	return ret;
	418	}
	419
	420	/*
90b9a268	421	* Add context on channel or event.
d65106b1 DG	422	*/
	423	int cmd_add_context(int argc, const char **argv)
	424	{
90b9a268	425	int index, opt, ret = CMD_SUCCESS;
d65106b1	426	static poptContext pc;
b13d56d7	427	struct ctx_type type, tmptype;
cd80958d	428	char *session_name = NULL;
d65106b1	429
636167b6 DG	430	if (argc < 2) {
	431	usage(stderr);
	432	goto end;
	433	}
	434
d65106b1 DG	435	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	436	poptReadDefaultConfig(pc, 0);
	437
	438	while ((opt = poptGetNextOpt(pc)) != -1) {
	439	switch (opt) {
	440	case OPT_HELP:
	441	usage(stderr);
	442	ret = CMD_SUCCESS;
	443	goto end;
	444	case OPT_TYPE:
3301e740 DG	445	type = malloc(sizeof(struct ctx_type));
	446	if (type == NULL) {
	447	perror("malloc ctx_type");
	448	ret = -1;
636167b6 DG	449	goto end;
636167b6 DG	450	}
6caa2bcc	451	index = find_ctx_type_idx(opt_type);
b13d56d7	452	if (index < 0) {
6caa2bcc	453	ERR("Unknown context type %s", opt_type);
b13d56d7	454	goto end;
90b9a268	455	}
b13d56d7 MD	456	type->opt = &ctx_opts[index];
b13d56d7 MD	457	if (type->opt->ctx_type == -1) {
6caa2bcc	458	ERR("Unknown context type %s", opt_type);
90b9a268 DG	459	} else {
	460	cds_list_add(&type->list, &ctx_type_list.head);
	461	}
d65106b1	462	break;
eeac7d46 MD	463	case OPT_USERSPACE:
eeac7d46 MD	464	opt_userspace = 1;
d78d6610	465	#if 0
eeac7d46	466	opt_cmd_name = poptGetOptArg(pc);
d78d6610	467	#endif
eeac7d46	468	break;
679b4943 SM	469	case OPT_LIST_OPTIONS:
	470	list_cmd_options(stdout, long_options);
	471	ret = CMD_SUCCESS;
	472	goto end;
d65106b1 DG	473	default:
	474	usage(stderr);
	475	ret = CMD_UNDEFINED;
	476	goto end;
	477	}
	478	}
	479
cd80958d DG	480	if (!opt_session_name) {
	481	session_name = get_session_name();
	482	if (session_name == NULL) {
	483	ret = -1;
	484	goto end;
	485	}
	486	} else {
	487	session_name = opt_session_name;
	488	}
	489
	490	ret = add_context(session_name);
3301e740 DG	491
3301e740 DG	492	/* Cleanup allocated memory */
b13d56d7	493	cds_list_for_each_entry_safe(type, tmptype, &ctx_type_list.head, list) {
3301e740 DG	494	free(type);
	495	}
	496
d65106b1 DG	497	end:
	498	return ret;
	499	}