[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, version 2 only,
 * as published by the Free Software Foundation.
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#define _GNU_SOURCE
#define _LGPL_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 <assert.h>

#include <common/mi-lttng.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 mi_writer *writer;

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},
	{"syscall",        0,   POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
#endif
	{"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 [-k|-u] [OPTIONS]\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, "  -k, --kernel             Apply to the kernel tracer\n");
	fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Calibrate options:\n");
	fprintf(ofp, "    --function             Dynamic function entry/return probe (default)\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");
#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;

	memset(&dom, 0, sizeof(dom));
	memset(&calibrate, 0, sizeof(calibrate));

	/* Create lttng domain */
	if (opt_kernel) {
		dom.type = LTTNG_DOMAIN_KERNEL;
	} else if (opt_userspace) {
		dom.type = LTTNG_DOMAIN_UST;
	} else {
		print_missing_domain();
		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) {
			ERR("%s", lttng_strerror(ret));
			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;
	}

	if (lttng_opt_mi) {
		assert(writer);
		ret = mi_lttng_calibrate(writer, &calibrate);
		if (ret) {
			ret = CMD_ERROR;
			goto error;
		}
	}

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, command_ret = CMD_SUCCESS, success = 1;
	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;
		}
	}

	/* Mi check */
	if (lttng_opt_mi) {
		writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
		if (!writer) {
			ret = -LTTNG_ERR_NOMEM;
			goto end;
		}

		/* Open command element */
		ret = mi_lttng_writer_command_open(writer,
				mi_lttng_element_command_calibrate);
		if (ret) {
			ret = CMD_ERROR;
			goto end;
		}

		/* Open output element */
		ret = mi_lttng_writer_open_element(writer,
				mi_lttng_element_command_output);
		if (ret) {
			ret = CMD_ERROR;
			goto end;
		}
	}

	command_ret = calibrate_lttng();
	if (command_ret) {
		success = 0;
	}

	/* Mi closing */
	if (lttng_opt_mi) {
		/* Close  output element */
		ret = mi_lttng_writer_close_element(writer);
		if (ret) {
			ret = CMD_ERROR;
			goto end;
		}

		/* Success ? */
		ret = mi_lttng_writer_write_element_bool(writer,
				mi_lttng_element_command_success, success);
		if (ret) {
			ret = CMD_ERROR;
			goto end;
		}

		/* Command element close */
		ret = mi_lttng_writer_command_close(writer);
		if (ret) {
			ret = CMD_ERROR;
			goto end;
		}
	}

end:
	/* Mi clean-up */
	if (writer && mi_lttng_writer_destroy(writer)) {
		/* Preserve original error code */
		ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
	}

	/* Overwrite ret if an error occurred during calibrate_lttng() */
	ret = command_ret ? command_ret : ret;

	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	*
d14d33bf AM	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License, version 2 only,
	7	* as published by the Free Software Foundation.
d0254c7c MD	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	*
d14d33bf AM	14	* You should have received a copy of the GNU General Public License along
	15	* with this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
d0254c7c MD	17	*/
	18
	19	#define _GNU_SOURCE
6c1c0768	20	#define _LGPL_SOURCE
d0254c7c MD	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>
7e66b1b0 JRJ	30	#include <assert.h>
	31
	32	#include <common/mi-lttng.h>
d0254c7c	33
c399183f	34	#include "../command.h"
d0254c7c MD	35
	36	static int opt_event_type;
	37	static char *opt_kernel;
d0254c7c	38	static int opt_userspace;
d78d6610 DG	39	#if 0
d78d6610 DG	40	/* Not implemented yet */
eeac7d46	41	static char *opt_cmd_name;
d0254c7c	42	static pid_t opt_pid;
d78d6610	43	#endif
d0254c7c MD	44
	45	enum {
	46	OPT_HELP = 1,
d0254c7c MD	47	OPT_TRACEPOINT,
	48	OPT_MARKER,
	49	OPT_PROBE,
	50	OPT_FUNCTION,
	51	OPT_FUNCTION_ENTRY,
a54bd42d	52	OPT_SYSCALL,
eeac7d46	53	OPT_USERSPACE,
679b4943	54	OPT_LIST_OPTIONS,
d0254c7c MD	55	};
d0254c7c MD	56
cd80958d	57	static struct lttng_handle *handle;
7e66b1b0	58	static struct mi_writer *writer;
cd80958d	59
d0254c7c MD	60	static struct poptOption long_options[] = {
	61	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	62	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	63	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610 DG	64	#if 0
d78d6610 DG	65	/* Not implemented yet */
6caa2bcc	66	{"userspace", 'u', POPT_ARG_STRING \| POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
d0254c7c MD	67	{"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	68	{"tracepoint", 0, POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
	69	{"marker", 0, POPT_ARG_NONE, 0, OPT_MARKER, 0, 0},
	70	{"probe", 0, POPT_ARG_NONE, 0, OPT_PROBE, 0, 0},
4466912f DG	71	#else
4466912f DG	72	{"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
d0254c7c	73	{"function", 0, POPT_ARG_NONE, 0, OPT_FUNCTION, 0, 0},
4466912f	74	#endif
b213d387 MD	75	#if 0
	76	/*
	77	* Removed from options to discourage its use. Not in kernel
	78	* tracer anymore.
	79	*/
d0254c7c	80	{"function:entry", 0, POPT_ARG_NONE, 0, OPT_FUNCTION_ENTRY, 0, 0},
a54bd42d	81	{"syscall", 0, POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
5c6886fa	82	#endif
679b4943	83	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
d0254c7c MD	84	{0, 0, 0, 0, 0, 0, 0}
	85	};
	86
	87	/*
	88	* usage
	89	*/
	90	static void usage(FILE *ofp)
	91	{
32a6298d	92	fprintf(ofp, "usage: lttng calibrate [-k\|-u] [OPTIONS]\n");
d0254c7c	93	fprintf(ofp, "\n");
32a6298d	94	fprintf(ofp, "Options:\n");
d0254c7c	95	fprintf(ofp, " -h, --help Show this help\n");
679b4943	96	fprintf(ofp, " --list-options Simple listing of options\n");
af87c45a	97	fprintf(ofp, " -k, --kernel Apply to the kernel tracer\n");
af87c45a	98	fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
d0254c7c MD	99	fprintf(ofp, "\n");
d0254c7c MD	100	fprintf(ofp, "Calibrate options:\n");
32a6298d	101	fprintf(ofp, " --function Dynamic function entry/return probe (default)\n");
4466912f	102	#if 0
d0254c7c MD	103	fprintf(ofp, " --tracepoint Tracepoint event (default)\n");
	104	fprintf(ofp, " --probe\n");
	105	fprintf(ofp, " Dynamic probe.\n");
b213d387	106	#if 0
d0254c7c MD	107	fprintf(ofp, " --function:entry symbol\n");
d0254c7c MD	108	fprintf(ofp, " Function tracer event\n");
b213d387	109	#endif
a54bd42d	110	fprintf(ofp, " --syscall System call eventl\n");
d0254c7c	111	fprintf(ofp, " --marker User-space marker (deprecated)\n");
4466912f	112	#endif
d0254c7c MD	113	fprintf(ofp, "\n");
	114	}
	115
	116	/*
af87c45a	117	* Calibrate LTTng.
d0254c7c	118	*
af87c45a	119	* Returns a CMD_* error.
d0254c7c MD	120	*/
	121	static int calibrate_lttng(void)
	122	{
	123	int ret = CMD_SUCCESS;
	124	struct lttng_domain dom;
	125	struct lttng_calibrate calibrate;
	126
441c16a7 MD	127	memset(&dom, 0, sizeof(dom));
	128	memset(&calibrate, 0, sizeof(calibrate));
	129
d0254c7c MD	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 {
b9dfb167	136	print_missing_domain();
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) {
8f3f773f	159	ERR("%s", lttng_strerror(ret));
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
7e66b1b0 JRJ	175	if (lttng_opt_mi) {
	176	assert(writer);
	177	ret = mi_lttng_calibrate(writer, &calibrate);
	178	if (ret) {
	179	ret = CMD_ERROR;
	180	goto error;
	181	}
	182	}
af87c45a	183
4466912f	184	error:
cd80958d DG	185	lttng_destroy_handle(handle);
cd80958d DG	186
d0254c7c MD	187	return ret;
	188	}
	189
	190	/*
af87c45a	191	* Calibrate LTTng tracer.
1c8d13c8 TD	192	*
1c8d13c8 TD	193	* Returns a CMD_* error.
d0254c7c MD	194	*/
	195	int cmd_calibrate(int argc, const char **argv)
	196	{
7e66b1b0	197	int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1;
d0254c7c MD	198	static poptContext pc;
	199
	200	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	201	poptReadDefaultConfig(pc, 0);
	202
	203	/* Default event type */
4466912f	204	opt_event_type = LTTNG_EVENT_FUNCTION;
d0254c7c MD	205
	206	while ((opt = poptGetNextOpt(pc)) != -1) {
	207	switch (opt) {
	208	case OPT_HELP:
af87c45a	209	usage(stdout);
d0254c7c	210	goto end;
d0254c7c	211	case OPT_TRACEPOINT:
1ab1ea0b	212	ret = CMD_UNDEFINED;
4466912f	213	goto end;
d0254c7c	214	case OPT_MARKER:
1ab1ea0b	215	ret = CMD_UNDEFINED;
d0254c7c MD	216	goto end;
d0254c7c MD	217	case OPT_PROBE:
1ab1ea0b	218	ret = CMD_UNDEFINED;
d0254c7c MD	219	break;
	220	case OPT_FUNCTION:
	221	opt_event_type = LTTNG_EVENT_FUNCTION;
	222	break;
	223	case OPT_FUNCTION_ENTRY:
1ab1ea0b	224	ret = CMD_UNDEFINED;
4466912f	225	goto end;
a54bd42d	226	case OPT_SYSCALL:
1ab1ea0b	227	ret = CMD_UNDEFINED;
4466912f	228	goto end;
eeac7d46 MD	229	case OPT_USERSPACE:
eeac7d46 MD	230	opt_userspace = 1;
eeac7d46	231	break;
679b4943 SM	232	case OPT_LIST_OPTIONS:
679b4943 SM	233	list_cmd_options(stdout, long_options);
679b4943	234	goto end;
d0254c7c MD	235	default:
	236	usage(stderr);
	237	ret = CMD_UNDEFINED;
	238	goto end;
	239	}
	240	}
	241
7e66b1b0 JRJ	242	/* Mi check */
	243	if (lttng_opt_mi) {
	244	writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
	245	if (!writer) {
	246	ret = -LTTNG_ERR_NOMEM;
	247	goto end;
	248	}
	249
	250	/* Open command element */
	251	ret = mi_lttng_writer_command_open(writer,
	252	mi_lttng_element_command_calibrate);
	253	if (ret) {
	254	ret = CMD_ERROR;
	255	goto end;
	256	}
	257
	258	/* Open output element */
	259	ret = mi_lttng_writer_open_element(writer,
	260	mi_lttng_element_command_output);
	261	if (ret) {
	262	ret = CMD_ERROR;
	263	goto end;
	264	}
	265	}
	266
	267	command_ret = calibrate_lttng();
	268	if (command_ret) {
	269	success = 0;
	270	}
	271
	272	/* Mi closing */
	273	if (lttng_opt_mi) {
	274	/* Close output element */
	275	ret = mi_lttng_writer_close_element(writer);
	276	if (ret) {
	277	ret = CMD_ERROR;
	278	goto end;
	279	}
	280
	281	/* Success ? */
	282	ret = mi_lttng_writer_write_element_bool(writer,
	283	mi_lttng_element_command_success, success);
	284	if (ret) {
	285	ret = CMD_ERROR;
	286	goto end;
	287	}
	288
	289	/* Command element close */
	290	ret = mi_lttng_writer_command_close(writer);
	291	if (ret) {
	292	ret = CMD_ERROR;
	293	goto end;
	294	}
	295	}
d0254c7c MD	296
d0254c7c MD	297	end:
7e66b1b0 JRJ	298	/* Mi clean-up */
	299	if (writer && mi_lttng_writer_destroy(writer)) {
	300	/* Preserve original error code */
	301	ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
	302	}
	303
	304	/* Overwrite ret if an error occurred during calibrate_lttng() */
	305	ret = command_ret ? command_ret : ret;
	306
ca1c3607	307	poptFreeContext(pc);
d0254c7c MD	308	return ret;
d0254c7c MD	309	}