Update version to v2.1.0-rc6
[lttng-tools.git] / 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 [-k|-u] [OPTIONS]\n");
88 fprintf(ofp, "\n");
89 fprintf(ofp, "Options:\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 fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
94 fprintf(ofp, "\n");
95 fprintf(ofp, "Calibrate options:\n");
96 fprintf(ofp, " --function Dynamic function entry/return probe (default)\n");
97 #if 0
98 fprintf(ofp, " --tracepoint Tracepoint event (default)\n");
99 fprintf(ofp, " --probe\n");
100 fprintf(ofp, " Dynamic probe.\n");
101 #if 0
102 fprintf(ofp, " --function:entry symbol\n");
103 fprintf(ofp, " Function tracer event\n");
104 #endif
105 fprintf(ofp, " --syscall System call eventl\n");
106 fprintf(ofp, " --marker User-space marker (deprecated)\n");
107 #endif
108 fprintf(ofp, "\n");
109 }
110
111 /*
112 * Calibrate LTTng.
113 *
114 * Returns a CMD_* error.
115 */
116 static int calibrate_lttng(void)
117 {
118 int ret = CMD_SUCCESS;
119 struct lttng_domain dom;
120 struct lttng_calibrate calibrate;
121
122 memset(&dom, 0, sizeof(dom));
123 memset(&calibrate, 0, sizeof(calibrate));
124
125 /* Create lttng domain */
126 if (opt_kernel) {
127 dom.type = LTTNG_DOMAIN_KERNEL;
128 } else if (opt_userspace) {
129 dom.type = LTTNG_DOMAIN_UST;
130 } else {
131 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
132 ret = CMD_ERROR;
133 goto error;
134 }
135
136 handle = lttng_create_handle(NULL, &dom);
137 if (handle == NULL) {
138 ret = CMD_ERROR;
139 goto error;
140 }
141
142 switch (opt_event_type) {
143 case LTTNG_EVENT_TRACEPOINT:
144 DBG("Calibrating kernel tracepoints");
145 break;
146 case LTTNG_EVENT_PROBE:
147 DBG("Calibrating kernel probes");
148 break;
149 case LTTNG_EVENT_FUNCTION:
150 DBG("Calibrating kernel functions");
151 calibrate.type = LTTNG_CALIBRATE_FUNCTION;
152 ret = lttng_calibrate(handle, &calibrate);
153 if (ret < 0) {
154 goto error;
155 }
156 MSG("%s calibration done", opt_kernel ? "Kernel" : "UST");
157 break;
158 case LTTNG_EVENT_FUNCTION_ENTRY:
159 DBG("Calibrating kernel function entry");
160 break;
161 case LTTNG_EVENT_SYSCALL:
162 DBG("Calibrating kernel syscall");
163 break;
164 default:
165 ret = CMD_UNDEFINED;
166 goto error;
167 }
168
169 ret = CMD_SUCCESS;
170
171 error:
172 lttng_destroy_handle(handle);
173
174 return ret;
175 }
176
177 /*
178 * Calibrate LTTng tracer.
179 *
180 * Returns a CMD_* error.
181 */
182 int cmd_calibrate(int argc, const char **argv)
183 {
184 int opt, ret = CMD_SUCCESS;
185 static poptContext pc;
186
187 pc = poptGetContext(NULL, argc, argv, long_options, 0);
188 poptReadDefaultConfig(pc, 0);
189
190 /* Default event type */
191 opt_event_type = LTTNG_EVENT_FUNCTION;
192
193 while ((opt = poptGetNextOpt(pc)) != -1) {
194 switch (opt) {
195 case OPT_HELP:
196 usage(stdout);
197 goto end;
198 case OPT_TRACEPOINT:
199 ret = CMD_UNDEFINED;
200 goto end;
201 case OPT_MARKER:
202 ret = CMD_UNDEFINED;
203 goto end;
204 case OPT_PROBE:
205 ret = CMD_UNDEFINED;
206 break;
207 case OPT_FUNCTION:
208 opt_event_type = LTTNG_EVENT_FUNCTION;
209 break;
210 case OPT_FUNCTION_ENTRY:
211 ret = CMD_UNDEFINED;
212 goto end;
213 case OPT_SYSCALL:
214 ret = CMD_UNDEFINED;
215 goto end;
216 case OPT_USERSPACE:
217 opt_userspace = 1;
218 break;
219 case OPT_LIST_OPTIONS:
220 list_cmd_options(stdout, long_options);
221 goto end;
222 default:
223 usage(stderr);
224 ret = CMD_UNDEFINED;
225 goto end;
226 }
227 }
228
229 ret = calibrate_lttng();
230
231 end:
232 poptFreeContext(pc);
233 return ret;
234 }
This page took 0.034252 seconds and 4 git commands to generate.