lttng/commands/add_context.c

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   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
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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
  28 #include "cmd.h"
  29 #include "conf.h"
  30 #include "utils.h"
  31
  32 static char *opt_event_name;
  33 static char *opt_channel_name;
  34 static char *opt_perf_name;
  35 static char *opt_session_name;
  36 static int *opt_kernel;
  37 static int opt_pid_all;
  38 static int opt_userspace;
  39 static int opt_perf_type;
  40 static int opt_perf_id;
  41 static pid_t opt_pid;
  42
  43 enum {
  44         OPT_HELP = 1,
  45         OPT_TYPE,
  46 };
  47
  48 static struct poptOption long_options[] = {
  49         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  50         {"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  51         {"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
  52         {"channel",        'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
  53         {"event",          'e', POPT_ARG_STRING, &opt_event_name, 0, 0, 0},
  54         {"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
  55         {"userspace",      'u', POPT_ARG_VAL, &opt_userspace, 1, 0, 0},
  56         {"all",            0,   POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
  57         {"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
  58         {"type",           't', POPT_ARG_INT, 0, OPT_TYPE, 0, 0},
  59         {"perf-name",      0,   POPT_ARG_STRING, &opt_perf_name, 0, 0, 0},
  60         {"perf-type",      0,   POPT_ARG_INT, &opt_perf_type, 0, 0, 0},
  61         {"perf-id",        0,   POPT_ARG_INT, &opt_perf_id, 0, 0, 0},
  62         {0, 0, 0, 0, 0, 0, 0}
  63 };
  64
  65 /*
  66  * usage
  67  */
  68 static void usage(FILE *ofp)
  69 {
  70         fprintf(ofp, "usage: lttng add-context [options] [context_options]\n");
  71         fprintf(ofp, "\n");
  72         fprintf(ofp, "Options:\n");
  73         fprintf(ofp, "  -h, --help               Show this help\n");
  74         fprintf(ofp, "  -s, --session            Apply on session name\n");
  75         fprintf(ofp, "  -c, --channel NAME       Apply on channel\n");
  76         fprintf(ofp, "  -e, --event NAME         Apply on event\n");
  77         fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
  78         fprintf(ofp, "  -u, --userspace          Apply for the user-space tracer\n");
  79         fprintf(ofp, "      --all                If -u, apply on all traceable apps\n");
  80         fprintf(ofp, "  -p, --pid PID            If -u, apply on a specific PID\n");
  81         fprintf(ofp, "  -t, --type TYPE          Context type. TYPE must be a numerical value:\n");
  82         fprintf(ofp, "                             KERNEL_CONTEXT_PID = 0\n");
  83         fprintf(ofp, "                             KERNEL_CONTEXT_PERF_COUNTER = 1\n");
  84         fprintf(ofp, "                             KERNEL_CONTEXT_COMM = 2\n");
  85         fprintf(ofp, "                             KERNEL_CONTEXT_PRIO = 3\n");
  86         fprintf(ofp, "                             KERNEL_CONTEXT_NICE = 4\n");
  87         fprintf(ofp, "                             KERNEL_CONTEXT_VPID = 5\n");
  88         fprintf(ofp, "                             KERNEL_CONTEXT_TID = 6\n");
  89         fprintf(ofp, "                             KERNEL_CONTEXT_VTID = 7\n");
  90         fprintf(ofp, "                             KERNEL_CONTEXT_PPID = 8\n");
  91         fprintf(ofp, "                             KERNEL_CONTEXT_VPPID = 9\n");
  92         fprintf(ofp, "\n");
  93         fprintf(ofp, "Context options:\n");
  94         fprintf(ofp, "      --perf-name NAME     Perf event name\n");
  95         fprintf(ofp, "      --perf-type TYPE     Perf event type. TYPE must be a numeric value:\n");
  96         fprintf(ofp, "                             PERF_TYPE_HARDWARE = 0\n");
  97         fprintf(ofp, "                             PERF_TYPE_SOFTWARE = 1\n");
  98         fprintf(ofp, "      --perf-id ID         Perf event id. ID must be a numeric value:\n");
  99         fprintf(ofp, "                           Hardware IDs (0):\n");
 100         fprintf(ofp, "                             PERF_COUNT_HW_CPU_CYCLES = 0\n");
 101         fprintf(ofp, "                             PERF_COUNT_HW_INSTRUCTIONS = 1\n");
 102         fprintf(ofp, "                             PERF_COUNT_HW_CACHE_REFERENCES = 2\n");
 103         fprintf(ofp, "                             PERF_COUNT_HW_CACHE_MISSES = 3\n");
 104         fprintf(ofp, "                             PERF_COUNT_HW_BRANCH_INSTRUCTIONS = 4\n");
 105         fprintf(ofp, "                             PERF_COUNT_HW_BRANCH_MISSES = 5\n");
 106         fprintf(ofp, "                             PERF_COUNT_HW_BUS_CYCLES = 6\n");
 107         fprintf(ofp, "                           Software IDs (1):\n");
 108         fprintf(ofp, "                             PERF_COUNT_SW_CPU_CLOCK = 0\n");
 109         fprintf(ofp, "                             PERF_COUNT_SW_TASK_CLOCK = 1\n");
 110         fprintf(ofp, "                             PERF_COUNT_SW_PAGE_FAULTS = 2\n");
 111         fprintf(ofp, "                             PERF_COUNT_SW_CONTEXT_SWITCHES = 3\n");
 112         fprintf(ofp, "                             PERF_COUNT_SW_CPU_MIGRATIONS = 4\n");
 113         fprintf(ofp, "                             PERF_COUNT_SW_PAGE_FAULTS_MIN = 5\n");
 114         fprintf(ofp, "                             PERF_COUNT_SW_PAGE_FAULTS_MAJ = 6\n");
 115         fprintf(ofp, "\n");
 116 }
 117
 118 /*
 119  *  add_context
 120  *
 121  *  Add context to channel or event.
 122  */
 123 static int add_context(int type)
 124 {
 125         int ret = CMD_SUCCESS;
 126         struct lttng_kernel_context context;
 127
 128         if (set_session_name(opt_session_name) < 0) {
 129                 ret = CMD_ERROR;
 130                 goto error;
 131         }
 132
 133         context.ctx = type;
 134         if (type == LTTNG_KERNEL_CONTEXT_PERF_COUNTER) {
 135                 context.u.perf_counter.type = opt_perf_type;
 136                 context.u.perf_counter.config = opt_perf_id;
 137                 strncpy(context.u.perf_counter.name, opt_perf_name,
 138                                 LTTNG_SYMBOL_NAME_LEN);
 139         }
 140
 141         if (opt_kernel) {
 142                 DBG("Adding kernel context");
 143                 ret = lttng_kernel_add_context(&context, opt_event_name, opt_channel_name);
 144                 if (ret < 0) {
 145                         goto error;
 146                 } else {
 147                         MSG("Kernel context added");
 148                 }
 149         } else if (opt_userspace) {             /* User-space tracer action */
 150                 /*
 151                  * TODO: Waiting on lttng UST 2.0
 152                  */
 153                 if (opt_pid_all) {
 154                 } else if (opt_pid != 0) {
 155                 }
 156                 ret = CMD_NOT_IMPLEMENTED;
 157                 goto error;
 158         } else {
 159                 ERR("Please specify a tracer (kernel or user-space)");
 160                 goto error;
 161         }
 162
 163 error:
 164         return ret;
 165 }
 166
 167 /*
 168  *  cmd_add_context
 169  *
 170  *  Add context on channel or event.
 171  */
 172 int cmd_add_context(int argc, const char **argv)
 173 {
 174         int opt, ret = CMD_SUCCESS;
 175         char *tmp;
 176         static poptContext pc;
 177
 178         if (argc < 2) {
 179                 usage(stderr);
 180                 goto end;
 181         }
 182
 183         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 184         poptReadDefaultConfig(pc, 0);
 185
 186         while ((opt = poptGetNextOpt(pc)) != -1) {
 187                 switch (opt) {
 188                 case OPT_HELP:
 189                         usage(stderr);
 190                         ret = CMD_SUCCESS;
 191                         goto end;
 192                 case OPT_TYPE:
 193                         /* Mandatory field */
 194                         tmp = poptGetOptArg(pc);
 195                         if (tmp == NULL) {
 196                                 usage(stderr);
 197                                 ret = CMD_ERROR;
 198                                 free(tmp);
 199                                 goto end;
 200                         }
 201                         ret = add_context(atoi(tmp));
 202                         if (ret < 0) {
 203                                 free(tmp);
 204                                 goto end;
 205                         }
 206                         free(tmp);
 207                         break;
 208                 default:
 209                         usage(stderr);
 210                         ret = CMD_UNDEFINED;
 211                         goto end;
 212                 }
 213         }
 214
 215 end:
 216         return ret;
 217 }