* 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 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 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
#include <unistd.h>
#include <inttypes.h>
#include <ctype.h>
+#include <assert.h>
+
+#include <common/mi-lttng.h>
#include "../command.h"
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 */
/* 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},
-#else
- {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
-#endif
{"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},
+#endif
+ {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
{0, 0, 0, 0, 0, 0, 0}
};
*/
static void usage(FILE *ofp)
{
- fprintf(ofp, "usage: lttng calibrate [options] [calibrate_options]\n");
+ 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, " -k, --kernel Apply for the kernel tracer\n");
-#if 0
- fprintf(ofp, " -u, --userspace [CMD] Apply for the user-space tracer\n");
- fprintf(ofp, " If no CMD, the domain used is UST global\n");
- fprintf(ofp, " or else the domain is UST EXEC_NAME\n");
- fprintf(ofp, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n");
-#else
- fprintf(ofp, " -u, --userspace Apply for the user-space tracer\n");
-#endif
+ fprintf(ofp, " --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");
- fprintf(ofp, " --function\n");
- fprintf(ofp, " Dynamic function entry/return 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
+ * Calibrate LTTng.
*
- * Calibrate LTTng.
+ * Returns a CMD_* error.
*/
static int calibrate_lttng(void)
{
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 = -1;
- goto end;
+ ret = CMD_ERROR;
+ goto error;
}
- /* Kernel tracer action */
- if (opt_kernel) {
- 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);
- 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 end;
+ 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;
}
- } else if (opt_userspace) { /* User-space tracer action */
+ 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 end;
- } else {
- ERR("Please specify a tracer (--kernel or --userspace)");
- goto end;
+ goto error;
}
-end:
+
+ 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;
}
/*
- * cmd_calibrate
+ * Calibrate LTTng tracer.
*
- * Calibrate LTTng tracer.
+ * Returns a CMD_* error.
*/
int cmd_calibrate(int argc, const char **argv)
{
- int opt, ret;
+ 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_TRACEPOINT;
+ opt_event_type = LTTNG_EVENT_FUNCTION;
while ((opt = poptGetNextOpt(pc)) != -1) {
switch (opt) {
case OPT_HELP:
- usage(stderr);
- ret = CMD_SUCCESS;
+ usage(stdout);
goto end;
case OPT_TRACEPOINT:
ret = CMD_UNDEFINED;
- break;
+ goto end;
case OPT_MARKER:
ret = CMD_UNDEFINED;
goto end;
break;
case OPT_FUNCTION_ENTRY:
ret = CMD_UNDEFINED;
- break;
+ goto end;
case OPT_SYSCALL:
ret = CMD_UNDEFINED;
- break;
+ 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;
}
}
- ret = calibrate_lttng();
+ /* 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;
}