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 modify
   6  * it under the terms of the GNU General Public License, version 2 only,
   7  * as published by the Free Software Foundation.
   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  *
  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.
  17  */
  18
  19 #define _GNU_SOURCE
  20 #include <popt.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <sys/stat.h>
  25 #include <sys/types.h>
  26 #include <unistd.h>
  27 #include <inttypes.h>
  28 #include <ctype.h>
  29
  30 #include "../command.h"
  31
  32 static int opt_event_type;
  33 static char *opt_kernel;
  34 static int opt_userspace;
  35 #if 0
  36 /* Not implemented yet */
  37 static char *opt_cmd_name;
  38 static pid_t opt_pid;
  39 #endif
  40
  41 enum {
  42         OPT_HELP = 1,
  43         OPT_TRACEPOINT,
  44         OPT_MARKER,
  45         OPT_PROBE,
  46         OPT_FUNCTION,
  47         OPT_FUNCTION_ENTRY,
  48         OPT_SYSCALL,
  49         OPT_USERSPACE,
  50         OPT_LIST_OPTIONS,
  51 };
  52
  53 static struct lttng_handle *handle;
  54
  55 static struct poptOption long_options[] = {
  56         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  57         {"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  58         {"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
  59 #if 0
  60         /* Not implemented yet */
  61         {"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
  62         {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
  63         {"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
  64         {"marker",         0,   POPT_ARG_NONE, 0, OPT_MARKER, 0, 0},
  65         {"probe",          0,   POPT_ARG_NONE, 0, OPT_PROBE, 0, 0},
  66 #else
  67         {"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
  68         {"function",       0,   POPT_ARG_NONE, 0, OPT_FUNCTION, 0, 0},
  69 #endif
  70 #if 0
  71         /*
  72          * Removed from options to discourage its use. Not in kernel
  73          * tracer anymore.
  74          */
  75         {"function:entry", 0,   POPT_ARG_NONE, 0, OPT_FUNCTION_ENTRY, 0, 0},
  76 #endif
  77         {"syscall",        0,   POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
  78         {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
  79         {0, 0, 0, 0, 0, 0, 0}
  80 };
  81
  82 /*
  83  * usage
  84  */
  85 static void usage(FILE *ofp)
  86 {
  87         fprintf(ofp, "usage: lttng calibrate [options] [calibrate_options]\n");
  88         fprintf(ofp, "\n");
  89         fprintf(ofp, "  -h, --help               Show this help\n");
  90         fprintf(ofp, "      --list-options       Simple listing of options\n");
  91         fprintf(ofp, "  -k, --kernel             Apply to the kernel tracer\n");
  92 #if 0
  93         fprintf(ofp, "  -u, --userspace [CMD]    Apply to the user-space tracer (domain: UST\n");
  94         fprintf(ofp, "                           EXEC_NAME). If no CMD, the domain is UST global.\n";
  95         fprintf(ofp, "                           (-k preempts -u)\n");
  96         fprintf(ofp, "  -p, --pid PID            If -u, apply to specific PID (domain: UST PID)\n");
  97 #else
  98         fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\n");
  99 #endif
 100         fprintf(ofp, "\n");
 101         fprintf(ofp, "Calibrate options:\n");
 102 #if 0
 103         fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
 104         fprintf(ofp, "    --probe\n");
 105         fprintf(ofp, "                           Dynamic probe.\n");
 106 #if 0
 107         fprintf(ofp, "    --function:entry symbol\n");
 108         fprintf(ofp, "                           Function tracer event\n");
 109 #endif
 110         fprintf(ofp, "    --syscall              System call eventl\n");
 111         fprintf(ofp, "    --marker               User-space marker (deprecated)\n");
 112 #else
 113         fprintf(ofp, "    --function             Dynamic function entry/return probe (default)\n");
 114 #endif
 115         fprintf(ofp, "\n");
 116 }
 117
 118 /*
 119  * Calibrate LTTng.
 120  *
 121  * Returns a CMD_* error.
 122  */
 123 static int calibrate_lttng(void)
 124 {
 125         int ret = CMD_SUCCESS;
 126         struct lttng_domain dom;
 127         struct lttng_calibrate calibrate;
 128
 129         memset(&dom, 0, sizeof(dom));
 130         memset(&calibrate, 0, sizeof(calibrate));
 131
 132         /* Create lttng domain */
 133         if (opt_kernel) {
 134                 dom.type = LTTNG_DOMAIN_KERNEL;
 135         } else if (opt_userspace) {
 136                 dom.type = LTTNG_DOMAIN_UST;
 137         } else {
 138                 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
 139                 ret = CMD_ERROR;
 140                 goto error;
 141         }
 142
 143         handle = lttng_create_handle(NULL, &dom);
 144         if (handle == NULL) {
 145                 ret = CMD_ERROR;
 146                 goto error;
 147         }
 148
 149         switch (opt_event_type) {
 150         case LTTNG_EVENT_TRACEPOINT:
 151                 DBG("Calibrating kernel tracepoints");
 152                 break;
 153         case LTTNG_EVENT_PROBE:
 154                 DBG("Calibrating kernel probes");
 155                 break;
 156         case LTTNG_EVENT_FUNCTION:
 157                 DBG("Calibrating kernel functions");
 158                 calibrate.type = LTTNG_CALIBRATE_FUNCTION;
 159                 ret = lttng_calibrate(handle, &calibrate);
 160                 if (ret < 0) {
 161                         goto error;
 162                 }
 163                 MSG("%s calibration done", opt_kernel ? "Kernel" : "UST");
 164                 break;
 165         case LTTNG_EVENT_FUNCTION_ENTRY:
 166                 DBG("Calibrating kernel function entry");
 167                 break;
 168         case LTTNG_EVENT_SYSCALL:
 169                 DBG("Calibrating kernel syscall");
 170                 break;
 171         default:
 172                 ret = CMD_UNDEFINED;
 173                 goto error;
 174         }
 175
 176         ret = CMD_SUCCESS;
 177
 178 error:
 179         lttng_destroy_handle(handle);
 180
 181         return ret;
 182 }
 183
 184 /*
 185  * Calibrate LTTng tracer.
 186  *
 187  * Returns a CMD_* error.
 188  */
 189 int cmd_calibrate(int argc, const char **argv)
 190 {
 191         int opt, ret = CMD_SUCCESS;
 192         static poptContext pc;
 193
 194         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 195         poptReadDefaultConfig(pc, 0);
 196
 197         /* Default event type */
 198         opt_event_type = LTTNG_EVENT_FUNCTION;
 199
 200         while ((opt = poptGetNextOpt(pc)) != -1) {
 201                 switch (opt) {
 202                 case OPT_HELP:
 203                         usage(stdout);
 204                         goto end;
 205                 case OPT_TRACEPOINT:
 206                         ret = CMD_UNDEFINED;
 207                         goto end;
 208                 case OPT_MARKER:
 209                         ret = CMD_UNDEFINED;
 210                         goto end;
 211                 case OPT_PROBE:
 212                         ret = CMD_UNDEFINED;
 213                         break;
 214                 case OPT_FUNCTION:
 215                         opt_event_type = LTTNG_EVENT_FUNCTION;
 216                         break;
 217                 case OPT_FUNCTION_ENTRY:
 218                         ret = CMD_UNDEFINED;
 219                         goto end;
 220                 case OPT_SYSCALL:
 221                         ret = CMD_UNDEFINED;
 222                         goto end;
 223                 case OPT_USERSPACE:
 224                         opt_userspace = 1;
 225                         break;
 226                 case OPT_LIST_OPTIONS:
 227                         list_cmd_options(stdout, long_options);
 228                         goto end;
 229                 default:
 230                         usage(stderr);
 231                         ret = CMD_UNDEFINED;
 232                         goto end;
 233                 }
 234         }
 235
 236         ret = calibrate_lttng();
 237
 238 end:
 239         poptFreeContext(pc);
 240         return ret;
 241 }