Mi calibrate command: support and validation
[lttng-tools.git] / src / bin / lttng / commands / calibrate.c
index a0e852f8b03984836717c4d5c5317c08d7cbb696..567f4a5fa560b6b031ca02b505e4e8b286a84760 100644 (file)
@@ -2,19 +2,18 @@
  * 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
@@ -27,6 +26,9 @@
 #include <unistd.h>
 #include <inttypes.h>
 #include <ctype.h>
+#include <assert.h>
+
+#include <common/mi-lttng.h>
 
 #include "../command.h"
 
@@ -48,9 +50,11 @@ enum {
        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 */
@@ -73,8 +77,9 @@ static struct poptOption long_options[] = {
         * 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}
 };
 
@@ -83,20 +88,16 @@ static struct poptOption long_options[] = {
  */
 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");
@@ -107,16 +108,14 @@ static void usage(FILE *ofp)
 #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
+ * Calibrate LTTng.
  *
- *  Calibrate LTTng.
+ * Returns a CMD_* error.
  */
 static int calibrate_lttng(void)
 {
@@ -124,20 +123,23 @@ 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 {
-               ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
-               ret = CMD_UNDEFINED;
+               print_missing_domain();
+               ret = CMD_ERROR;
                goto error;
        }
 
        handle = lttng_create_handle(NULL, &dom);
        if (handle == NULL) {
-               ret = -1;
+               ret = CMD_ERROR;
                goto error;
        }
 
@@ -153,6 +155,7 @@ static int calibrate_lttng(void)
                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");
@@ -168,6 +171,15 @@ static int calibrate_lttng(void)
                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);
 
@@ -175,13 +187,13 @@ error:
 }
 
 /*
- *  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);
@@ -193,8 +205,7 @@ int cmd_calibrate(int argc, const char **argv)
        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;
@@ -217,6 +228,9 @@ int cmd_calibrate(int argc, const char **argv)
                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;
@@ -224,8 +238,71 @@ int cmd_calibrate(int argc, const char **argv)
                }
        }
 
-       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;
 }
This page took 0.026336 seconds and 4 git commands to generate.