[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,
	CONTEXT_PTHREAD_ID   = 10,
};

/*
 * 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 },
	{ "pthread_id", CONTEXT_PTHREAD_ID },
	{ "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 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, "Otherwise the context will be added only to the channel (-c)\n");
	fprintf(ofp, "and/or event (-e) indicated.\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 NAME       Apply to session name\n");
	fprintf(ofp, "  -c, --channel NAME       Apply to channel\n");
	fprintf(ofp, "  -e, --event NAME         Apply to event\n");
	fprintf(ofp, "  -k, --kernel             Apply to the kernel tracer\n");
#if 0
	fprintf(ofp, "  -u, --userspace [CMD]    Apply to the user-space tracer\n");
	fprintf(ofp, "                           If no CMD, the domain used is UST global\n");
	fprintf(ofp, "                           otherwise 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 to 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 to specify multiple contexts at once.\n");
	fprintf(ofp, "                           (--kernel preempts --userspace)\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, warn = 0;
	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_ERROR;
		goto error;
	}

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

	/* Iterate over all the context types 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) {
			ERR("%s: %s", type->opt->symbol, lttng_strerror(ret));
			warn = 1;
			continue;
		} else {
			if (opt_channel_name && opt_event_name) {
				MSG("%s context %s added to event %s channel %s",
						opt_kernel ? "kernel" : "UST", type->opt->symbol,
						opt_channel_name, opt_event_name);
			} else if (opt_channel_name && !opt_event_name) {
				MSG("%s context %s added to channel %s",
						opt_kernel ? "kernel" : "UST", type->opt->symbol,
						opt_channel_name);
			} else if (!opt_channel_name && opt_event_name) {
				MSG("%s context %s added to event %s",
						opt_kernel ? "kernel" : "UST", type->opt->symbol,
						opt_event_name);
			} else {
				MSG("%s context %s added to all channels",
						opt_kernel ? "kernel" : "UST", type->opt->symbol)
			}
		}
	}

	ret = CMD_SUCCESS;

error:
	lttng_destroy_handle(handle);

	/*
	 * This means that at least one add_context failed and tells the user to
	 * look on stderr for error(s).
	 */
	if (warn) {
		ret = CMD_WARNING;
	}
	return ret;
}

/*
 * Add context to 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);
		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_TYPE:
			/*
			 * Look up the index of opt_type in ctx_opts[] first, so we don't
			 * have to free(type) on failure.
			 */
			index = find_ctx_type_idx(opt_type);
			if (index < 0) {
				ERR("Unknown context type %s", opt_type);
				ret = CMD_ERROR;
				goto end;
			}

			type = malloc(sizeof(struct ctx_type));
			if (type == NULL) {
				perror("malloc ctx_type");
				ret = CMD_FATAL;
				goto end;
			}

			type->opt = &ctx_opts[index];
			if (type->opt->ctx_type == -1) {
				ERR("Unknown context type %s", opt_type);
				free(type);
				ret = CMD_ERROR;
				goto end;
			} 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);
			goto end;
		default:
			usage(stderr);
			ret = CMD_UNDEFINED;
			goto end;
		}
	}

	if (!opt_type) {
		ERR("Missing mandatory -t TYPE");
		usage(stderr);
		ret = CMD_ERROR;
		goto end;
	}

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

	ret = add_context(session_name);

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

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