[lttng-tools.git] / src / bin / lttng / commands / calibrate.c

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 * Copyright (C) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * 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 <popt.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <inttypes.h>
#include <ctype.h>

#include "../command.h"

static int opt_event_type;
static char *opt_kernel;
static int opt_userspace;
#if 0
/* Not implemented yet */
static char *opt_cmd_name;
static pid_t opt_pid;
#endif

enum {
	OPT_HELP = 1,
	OPT_TRACEPOINT,
	OPT_MARKER,
	OPT_PROBE,
	OPT_FUNCTION,
	OPT_FUNCTION_ENTRY,
	OPT_SYSCALL,
	OPT_USERSPACE,
	OPT_LIST_OPTIONS,
};

static struct lttng_handle *handle;

static struct poptOption long_options[] = {
	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	{"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	{"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
#if 0
	/* Not implemented yet */
	{"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
	{"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	{"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
	{"marker",         0,   POPT_ARG_NONE, 0, OPT_MARKER, 0, 0},
	{"probe",          0,   POPT_ARG_NONE, 0, OPT_PROBE, 0, 0},
#else
	{"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
	{"function",       0,   POPT_ARG_NONE, 0, OPT_FUNCTION, 0, 0},
#endif
#if 0
	/*
	 * Removed from options to discourage its use. Not in kernel
	 * tracer anymore.
	 */
	{"function:entry", 0,   POPT_ARG_NONE, 0, OPT_FUNCTION_ENTRY, 0, 0},
#endif
	{"syscall",        0,   POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
	{0, 0, 0, 0, 0, 0, 0}
};

/*
 * usage
 */
static void usage(FILE *ofp)
{
	fprintf(ofp, "usage: lttng calibrate [options] [calibrate_options]\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "  -h, --help               Show this help\n");
	fprintf(ofp, "      --list-options       Simple listing of options\n");
	fprintf(ofp, "  -k, --kernel             Apply to the kernel tracer\n");
#if 0
	fprintf(ofp, "  -u, --userspace [CMD]    Apply to the user-space tracer (domain: UST\n");
	fprintf(ofp, "                           EXEC_NAME). If no CMD, the domain is UST global.\n";
	fprintf(ofp, "                           (-k preempts -u)\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, "\n");
	fprintf(ofp, "Calibrate options:\n");
#if 0
	fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
	fprintf(ofp, "    --probe\n");
	fprintf(ofp, "                           Dynamic probe.\n");
#if 0
	fprintf(ofp, "    --function:entry symbol\n");
	fprintf(ofp, "                           Function tracer event\n");
#endif
	fprintf(ofp, "    --syscall              System call eventl\n");
	fprintf(ofp, "    --marker               User-space marker (deprecated)\n");
#else
	fprintf(ofp, "    --function             Dynamic function entry/return probe (default)\n");
#endif
	fprintf(ofp, "\n");
}

/*
 * Calibrate LTTng.
 *
 * Returns a CMD_* error.
 */
static int calibrate_lttng(void)
{
	int ret = CMD_SUCCESS;
	struct lttng_domain dom;
	struct lttng_calibrate calibrate;

	/* Create lttng domain */
	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(NULL, &dom);
	if (handle == NULL) {
		ret = CMD_ERROR;
		goto error;
	}

	switch (opt_event_type) {
	case LTTNG_EVENT_TRACEPOINT:
		DBG("Calibrating kernel tracepoints");
		break;
	case LTTNG_EVENT_PROBE:
		DBG("Calibrating kernel probes");
		break;
	case LTTNG_EVENT_FUNCTION:
		DBG("Calibrating kernel functions");
		calibrate.type = LTTNG_CALIBRATE_FUNCTION;
		ret = lttng_calibrate(handle, &calibrate);
		if (ret < 0) {
			ret = CMD_ERROR;
			goto error;
		}
		MSG("%s calibration done", opt_kernel ? "Kernel" : "UST");
		break;
	case LTTNG_EVENT_FUNCTION_ENTRY:
		DBG("Calibrating kernel function entry");
		break;
	case LTTNG_EVENT_SYSCALL:
		DBG("Calibrating kernel syscall");
		break;
	default:
		ret = CMD_UNDEFINED;
		goto error;
	}

	ret = CMD_SUCCESS;

error:
	lttng_destroy_handle(handle);

	return ret;
}

/*
 * Calibrate LTTng tracer.
 *
 * Returns a CMD_* error.
 */
int cmd_calibrate(int argc, const char **argv)
{
	int opt, ret = CMD_SUCCESS;
	static poptContext pc;

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

	/* Default event type */
	opt_event_type = LTTNG_EVENT_FUNCTION;

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
		case OPT_HELP:
			usage(stdout);
			goto end;
		case OPT_TRACEPOINT:
			ret = CMD_UNDEFINED;
			goto end;
		case OPT_MARKER:
			ret = CMD_UNDEFINED;
			goto end;
		case OPT_PROBE:
			ret = CMD_UNDEFINED;
			break;
		case OPT_FUNCTION:
			opt_event_type = LTTNG_EVENT_FUNCTION;
			break;
		case OPT_FUNCTION_ENTRY:
			ret = CMD_UNDEFINED;
			goto end;
		case OPT_SYSCALL:
			ret = CMD_UNDEFINED;
			goto end;
		case OPT_USERSPACE:
			opt_userspace = 1;
			break;
		case OPT_LIST_OPTIONS:
			list_cmd_options(stdout, long_options);
			goto end;
		default:
			usage(stderr);
			ret = CMD_UNDEFINED;
			goto end;
		}
	}

	ret = calibrate_lttng();

end:
	poptFreeContext(pc);
	return ret;
}
Commit	Line	Data
d0254c7c MD	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	* Copyright (C) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	*
	5	* This program is free software; you can redistribute it and/or
	6	* modify it under the terms of the GNU General Public License
	7	* as published by the Free Software Foundation; only version 2
	8	* of the License.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write to the Free Software
	17	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	18	*/
	19
	20	#define _GNU_SOURCE
	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	#include <inttypes.h>
	29	#include <ctype.h>
	30
c399183f	31	#include "../command.h"
d0254c7c MD	32
	33	static int opt_event_type;
	34	static char *opt_kernel;
d0254c7c	35	static int opt_userspace;
d78d6610 DG	36	#if 0
d78d6610 DG	37	/* Not implemented yet */
eeac7d46	38	static char *opt_cmd_name;
d0254c7c	39	static pid_t opt_pid;
d78d6610	40	#endif
d0254c7c MD	41
	42	enum {
	43	OPT_HELP = 1,
d0254c7c MD	44	OPT_TRACEPOINT,
	45	OPT_MARKER,
	46	OPT_PROBE,
	47	OPT_FUNCTION,
	48	OPT_FUNCTION_ENTRY,
a54bd42d	49	OPT_SYSCALL,
eeac7d46	50	OPT_USERSPACE,
679b4943	51	OPT_LIST_OPTIONS,
d0254c7c MD	52	};
d0254c7c MD	53
cd80958d DG	54	static struct lttng_handle *handle;
cd80958d DG	55
d0254c7c MD	56	static struct poptOption long_options[] = {
	57	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	58	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	59	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610 DG	60	#if 0
d78d6610 DG	61	/* Not implemented yet */
6caa2bcc	62	{"userspace", 'u', POPT_ARG_STRING \| POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
d0254c7c MD	63	{"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	64	{"tracepoint", 0, POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
	65	{"marker", 0, POPT_ARG_NONE, 0, OPT_MARKER, 0, 0},
	66	{"probe", 0, POPT_ARG_NONE, 0, OPT_PROBE, 0, 0},
4466912f DG	67	#else
4466912f DG	68	{"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
d0254c7c	69	{"function", 0, POPT_ARG_NONE, 0, OPT_FUNCTION, 0, 0},
4466912f	70	#endif
b213d387 MD	71	#if 0
	72	/*
	73	* Removed from options to discourage its use. Not in kernel
	74	* tracer anymore.
	75	*/
d0254c7c	76	{"function:entry", 0, POPT_ARG_NONE, 0, OPT_FUNCTION_ENTRY, 0, 0},
b213d387	77	#endif
a54bd42d	78	{"syscall", 0, POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
679b4943	79	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
d0254c7c MD	80	{0, 0, 0, 0, 0, 0, 0}
	81	};
	82
	83	/*
	84	* usage
	85	*/
	86	static void usage(FILE *ofp)
	87	{
	88	fprintf(ofp, "usage: lttng calibrate [options] [calibrate_options]\n");
	89	fprintf(ofp, "\n");
	90	fprintf(ofp, " -h, --help Show this help\n");
679b4943	91	fprintf(ofp, " --list-options Simple listing of options\n");
af87c45a	92	fprintf(ofp, " -k, --kernel Apply to the kernel tracer\n");
d78d6610	93	#if 0
af87c45a DG	94	fprintf(ofp, " -u, --userspace [CMD] Apply to the user-space tracer (domain: UST\n");
	95	fprintf(ofp, " EXEC_NAME). If no CMD, the domain is UST global.\n";
	96	fprintf(ofp, " (-k preempts -u)\n");
d78d6610 DG	97	fprintf(ofp, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n");
d78d6610 DG	98	#else
af87c45a	99	fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
d78d6610	100	#endif
d0254c7c MD	101	fprintf(ofp, "\n");
d0254c7c MD	102	fprintf(ofp, "Calibrate options:\n");
4466912f	103	#if 0
d0254c7c MD	104	fprintf(ofp, " --tracepoint Tracepoint event (default)\n");
	105	fprintf(ofp, " --probe\n");
	106	fprintf(ofp, " Dynamic probe.\n");
b213d387	107	#if 0
d0254c7c MD	108	fprintf(ofp, " --function:entry symbol\n");
d0254c7c MD	109	fprintf(ofp, " Function tracer event\n");
b213d387	110	#endif
a54bd42d	111	fprintf(ofp, " --syscall System call eventl\n");
d0254c7c	112	fprintf(ofp, " --marker User-space marker (deprecated)\n");
4466912f DG	113	#else
	114	fprintf(ofp, " --function Dynamic function entry/return probe (default)\n");
	115	#endif
d0254c7c MD	116	fprintf(ofp, "\n");
	117	}
	118
	119	/*
af87c45a	120	* Calibrate LTTng.
d0254c7c	121	*
af87c45a	122	* Returns a CMD_* error.
d0254c7c MD	123	*/
	124	static int calibrate_lttng(void)
	125	{
	126	int ret = CMD_SUCCESS;
	127	struct lttng_domain dom;
	128	struct lttng_calibrate calibrate;
	129
	130	/* Create lttng domain */
	131	if (opt_kernel) {
	132	dom.type = LTTNG_DOMAIN_KERNEL;
4466912f DG	133	} else if (opt_userspace) {
	134	dom.type = LTTNG_DOMAIN_UST;
	135	} else {
	136	ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
d16c1a4c	137	ret = CMD_ERROR;
4466912f	138	goto error;
d0254c7c MD	139	}
d0254c7c MD	140
cd80958d DG	141	handle = lttng_create_handle(NULL, &dom);
cd80958d DG	142	if (handle == NULL) {
af87c45a	143	ret = CMD_ERROR;
4466912f	144	goto error;
cd80958d DG	145	}
cd80958d DG	146
4466912f DG	147	switch (opt_event_type) {
	148	case LTTNG_EVENT_TRACEPOINT:
	149	DBG("Calibrating kernel tracepoints");
	150	break;
	151	case LTTNG_EVENT_PROBE:
	152	DBG("Calibrating kernel probes");
	153	break;
	154	case LTTNG_EVENT_FUNCTION:
	155	DBG("Calibrating kernel functions");
	156	calibrate.type = LTTNG_CALIBRATE_FUNCTION;
	157	ret = lttng_calibrate(handle, &calibrate);
	158	if (ret < 0) {
af87c45a	159	ret = CMD_ERROR;
4466912f	160	goto error;
d0254c7c	161	}
4466912f DG	162	MSG("%s calibration done", opt_kernel ? "Kernel" : "UST");
	163	break;
	164	case LTTNG_EVENT_FUNCTION_ENTRY:
	165	DBG("Calibrating kernel function entry");
	166	break;
	167	case LTTNG_EVENT_SYSCALL:
	168	DBG("Calibrating kernel syscall");
	169	break;
	170	default:
1ab1ea0b	171	ret = CMD_UNDEFINED;
4466912f	172	goto error;
d0254c7c	173	}
4466912f	174
af87c45a DG	175	ret = CMD_SUCCESS;
af87c45a DG	176
4466912f	177	error:
cd80958d DG	178	lttng_destroy_handle(handle);
cd80958d DG	179
d0254c7c MD	180	return ret;
	181	}
	182
	183	/*
af87c45a	184	* Calibrate LTTng tracer.
1c8d13c8 TD	185	*
1c8d13c8 TD	186	* Returns a CMD_* error.
d0254c7c MD	187	*/
	188	int cmd_calibrate(int argc, const char **argv)
	189	{
ca1c3607	190	int opt, ret = CMD_SUCCESS;
d0254c7c MD	191	static poptContext pc;
	192
	193	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	194	poptReadDefaultConfig(pc, 0);
	195
	196	/* Default event type */
4466912f	197	opt_event_type = LTTNG_EVENT_FUNCTION;
d0254c7c MD	198
	199	while ((opt = poptGetNextOpt(pc)) != -1) {
	200	switch (opt) {
	201	case OPT_HELP:
af87c45a	202	usage(stdout);
d0254c7c	203	goto end;
d0254c7c	204	case OPT_TRACEPOINT:
1ab1ea0b	205	ret = CMD_UNDEFINED;
4466912f	206	goto end;
d0254c7c	207	case OPT_MARKER:
1ab1ea0b	208	ret = CMD_UNDEFINED;
d0254c7c MD	209	goto end;
d0254c7c MD	210	case OPT_PROBE:
1ab1ea0b	211	ret = CMD_UNDEFINED;
d0254c7c MD	212	break;
	213	case OPT_FUNCTION:
	214	opt_event_type = LTTNG_EVENT_FUNCTION;
	215	break;
	216	case OPT_FUNCTION_ENTRY:
1ab1ea0b	217	ret = CMD_UNDEFINED;
4466912f	218	goto end;
a54bd42d	219	case OPT_SYSCALL:
1ab1ea0b	220	ret = CMD_UNDEFINED;
4466912f	221	goto end;
eeac7d46 MD	222	case OPT_USERSPACE:
eeac7d46 MD	223	opt_userspace = 1;
eeac7d46	224	break;
679b4943 SM	225	case OPT_LIST_OPTIONS:
679b4943 SM	226	list_cmd_options(stdout, long_options);
679b4943	227	goto end;
d0254c7c MD	228	default:
	229	usage(stderr);
	230	ret = CMD_UNDEFINED;
	231	goto end;
	232	}
	233	}
	234
	235	ret = calibrate_lttng();
	236
	237	end:
ca1c3607	238	poptFreeContext(pc);
d0254c7c MD	239	return ret;
d0254c7c MD	240	}