[lttng-tools.git] / 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 "../cmd.h"
#include "../conf.h"
#include "../utils.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_pid_all;
static int opt_userspace;
static char *opt_cmd_name;
static pid_t opt_pid;
static char *opt_type;

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

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