src/bin/lttng/commands/calibrate.c

   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
  31 #include "../command.h"
  32
  33 static int opt_event_type;
  34 static char *opt_kernel;
  35 static int opt_userspace;
  36 #if 0
  37 /* Not implemented yet */
  38 static char *opt_cmd_name;
  39 static pid_t opt_pid;
  40 #endif
  41
  42 enum {
  43         OPT_HELP = 1,
  44         OPT_TRACEPOINT,
  45         OPT_MARKER,
  46         OPT_PROBE,
  47         OPT_FUNCTION,
  48         OPT_FUNCTION_ENTRY,
  49         OPT_SYSCALL,
  50         OPT_USERSPACE,
  51         OPT_LIST_OPTIONS,
  52 };
  53
  54 static struct lttng_handle *handle;
  55
  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},
  60 #if 0
  61         /* Not implemented yet */
  62         {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
  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},
  67 #else
  68         {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
  69         {"function",       0,   POPT_ARG_NONE, 0, OPT_FUNCTION, 0, 0},
  70 #endif
  71 #if 0
  72         /*
  73          * Removed from options to discourage its use. Not in kernel
  74          * tracer anymore.
  75          */
  76         {"function:entry", 0,   POPT_ARG_NONE, 0, OPT_FUNCTION_ENTRY, 0, 0},
  77 #endif
  78         {"syscall",        0,   POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
  79         {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
  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");
  91         fprintf(ofp, "      --list-options       Simple listing of options\n");
  92         fprintf(ofp, "  -k, --kernel             Apply to the kernel tracer\n");
  93 #if 0
  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");
  97         fprintf(ofp, "  -p, --pid PID            If -u, apply to specific PID (domain: UST PID)\n");
  98 #else
  99         fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\n");
 100 #endif
 101         fprintf(ofp, "\n");
 102         fprintf(ofp, "Calibrate options:\n");
 103 #if 0
 104         fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
 105         fprintf(ofp, "    --probe\n");
 106         fprintf(ofp, "                           Dynamic probe.\n");
 107 #if 0
 108         fprintf(ofp, "    --function:entry symbol\n");
 109         fprintf(ofp, "                           Function tracer event\n");
 110 #endif
 111         fprintf(ofp, "    --syscall              System call eventl\n");
 112         fprintf(ofp, "    --marker               User-space marker (deprecated)\n");
 113 #else
 114         fprintf(ofp, "    --function             Dynamic function entry/return probe (default)\n");
 115 #endif
 116         fprintf(ofp, "\n");
 117 }
 118
 119 /*
 120  * Calibrate LTTng.
 121  *
 122  * Returns a CMD_* error.
 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;
 133         } else if (opt_userspace) {
 134                 dom.type = LTTNG_DOMAIN_UST;
 135         } else {
 136                 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
 137                 ret = CMD_ERROR;
 138                 goto error;
 139         }
 140
 141         handle = lttng_create_handle(NULL, &dom);
 142         if (handle == NULL) {
 143                 ret = CMD_ERROR;
 144                 goto error;
 145         }
 146
 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) {
 159                         goto error;
 160                 }
 161                 MSG("%s calibration done", opt_kernel ? "Kernel" : "UST");
 162                 break;
 163         case LTTNG_EVENT_FUNCTION_ENTRY:
 164                 DBG("Calibrating kernel function entry");
 165                 break;
 166         case LTTNG_EVENT_SYSCALL:
 167                 DBG("Calibrating kernel syscall");
 168                 break;
 169         default:
 170                 ret = CMD_UNDEFINED;
 171                 goto error;
 172         }
 173
 174         ret = CMD_SUCCESS;
 175
 176 error:
 177         lttng_destroy_handle(handle);
 178
 179         return ret;
 180 }
 181
 182 /*
 183  * Calibrate LTTng tracer.
 184  *
 185  * Returns a CMD_* error.
 186  */
 187 int cmd_calibrate(int argc, const char **argv)
 188 {
 189         int opt, ret = CMD_SUCCESS;
 190         static poptContext pc;
 191
 192         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 193         poptReadDefaultConfig(pc, 0);
 194
 195         /* Default event type */
 196         opt_event_type = LTTNG_EVENT_FUNCTION;
 197
 198         while ((opt = poptGetNextOpt(pc)) != -1) {
 199                 switch (opt) {
 200                 case OPT_HELP:
 201                         usage(stdout);
 202                         goto end;
 203                 case OPT_TRACEPOINT:
 204                         ret = CMD_UNDEFINED;
 205                         goto end;
 206                 case OPT_MARKER:
 207                         ret = CMD_UNDEFINED;
 208                         goto end;
 209                 case OPT_PROBE:
 210                         ret = CMD_UNDEFINED;
 211                         break;
 212                 case OPT_FUNCTION:
 213                         opt_event_type = LTTNG_EVENT_FUNCTION;
 214                         break;
 215                 case OPT_FUNCTION_ENTRY:
 216                         ret = CMD_UNDEFINED;
 217                         goto end;
 218                 case OPT_SYSCALL:
 219                         ret = CMD_UNDEFINED;
 220                         goto end;
 221                 case OPT_USERSPACE:
 222                         opt_userspace = 1;
 223                         break;
 224                 case OPT_LIST_OPTIONS:
 225                         list_cmd_options(stdout, long_options);
 226                         goto end;
 227                 default:
 228                         usage(stderr);
 229                         ret = CMD_UNDEFINED;
 230                         goto end;
 231                 }
 232         }
 233
 234         ret = calibrate_lttng();
 235
 236 end:
 237         poptFreeContext(pc);
 238         return ret;
 239 }