Commit | Line | Data |
---|---|---|
d36b8583 DG |
1 | /* |
2 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
3 | * | |
d14d33bf AM |
4 | * This program is free software; you can redistribute it and/or modify |
5 | * it under the terms of the GNU General Public License, version 2 only, | |
6 | * as published by the Free Software Foundation. | |
d36b8583 DG |
7 | * |
8 | * This program is distributed in the hope that it will be useful, | |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
11 | * GNU General Public License for more details. | |
12 | * | |
d14d33bf AM |
13 | * You should have received a copy of the GNU General Public License along |
14 | * with this program; if not, write to the Free Software Foundation, Inc., | |
15 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
d36b8583 DG |
16 | */ |
17 | ||
18 | #define _GNU_SOURCE | |
19 | #include <popt.h> | |
20 | #include <stdio.h> | |
21 | #include <stdlib.h> | |
22 | #include <string.h> | |
23 | #include <sys/stat.h> | |
24 | #include <sys/types.h> | |
25 | #include <unistd.h> | |
5a0de755 | 26 | #include <inttypes.h> |
d36b8583 | 27 | |
c399183f | 28 | #include "../command.h" |
d36b8583 DG |
29 | |
30 | static char *opt_channels; | |
5edd7e09 | 31 | static int opt_kernel; |
5440dc42 | 32 | static char *opt_session_name; |
d36b8583 | 33 | static int opt_userspace; |
d78d6610 DG |
34 | static struct lttng_channel chan; |
35 | #if 0 | |
36 | /* Not implemented yet */ | |
eeac7d46 | 37 | static char *opt_cmd_name; |
d36b8583 | 38 | static pid_t opt_pid; |
d78d6610 | 39 | #endif |
d36b8583 DG |
40 | |
41 | enum { | |
42 | OPT_HELP = 1, | |
7d29a247 DG |
43 | OPT_DISCARD, |
44 | OPT_OVERWRITE, | |
45 | OPT_SUBBUF_SIZE, | |
46 | OPT_NUM_SUBBUF, | |
47 | OPT_SWITCH_TIMER, | |
48 | OPT_READ_TIMER, | |
d36b8583 | 49 | OPT_USERSPACE, |
679b4943 | 50 | OPT_LIST_OPTIONS, |
d36b8583 DG |
51 | }; |
52 | ||
cd80958d DG |
53 | static struct lttng_handle *handle; |
54 | ||
d36b8583 DG |
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}, | |
5440dc42 | 58 | {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0}, |
d36b8583 | 59 | {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0}, |
d78d6610 DG |
60 | #if 0 |
61 | /* Not implemented yet */ | |
6caa2bcc | 62 | {"userspace", 'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0}, |
d36b8583 | 63 | {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0}, |
d78d6610 DG |
64 | #else |
65 | {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0}, | |
66 | #endif | |
7d29a247 DG |
67 | {"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0}, |
68 | {"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0}, | |
1b579521 DG |
69 | {"subbuf-size", 0, POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0}, |
70 | {"num-subbuf", 0, POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0}, | |
71 | {"switch-timer", 0, POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0}, | |
72 | {"read-timer", 0, POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0}, | |
679b4943 | 73 | {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL}, |
d36b8583 DG |
74 | {0, 0, 0, 0, 0, 0, 0} |
75 | }; | |
76 | ||
77 | /* | |
78 | * usage | |
79 | */ | |
80 | static void usage(FILE *ofp) | |
81 | { | |
7d29a247 | 82 | fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [options] [channel_options]\n"); |
d36b8583 | 83 | fprintf(ofp, "\n"); |
7d29a247 | 84 | fprintf(ofp, " -h, --help Show this help\n"); |
679b4943 | 85 | fprintf(ofp, " --list-options Simple listing of options\n"); |
27221701 DG |
86 | fprintf(ofp, " -s, --session Apply to session name\n"); |
87 | fprintf(ofp, " -k, --kernel Apply to the kernel tracer\n"); | |
d78d6610 | 88 | #if 0 |
27221701 | 89 | fprintf(ofp, " -u, --userspace [CMD] Apply to the user-space tracer\n"); |
e14f64a8 DG |
90 | fprintf(ofp, " If no CMD, the domain used is UST global\n"); |
91 | fprintf(ofp, " or else the domain is UST EXEC_NAME\n"); | |
92 | fprintf(ofp, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n"); | |
d78d6610 | 93 | #else |
27221701 | 94 | fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n"); |
d78d6610 | 95 | #endif |
7d29a247 DG |
96 | fprintf(ofp, "\n"); |
97 | fprintf(ofp, "Channel options:\n"); | |
cabd9892 MD |
98 | fprintf(ofp, " --discard Discard event when buffers are full%s\n", |
99 | DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)"); | |
100 | fprintf(ofp, " --overwrite Flight recorder mode%s\n", | |
101 | DEFAULT_CHANNEL_OVERWRITE ? " (default)" : ""); | |
cc62c0c0 | 102 | fprintf(ofp, " --subbuf-size SIZE Subbuffer size in bytes\n"); |
cabd9892 MD |
103 | fprintf(ofp, " (default: %u, kernel default: %u)\n", |
104 | DEFAULT_CHANNEL_SUBBUF_SIZE, | |
105 | DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE); | |
93e6c8a0 MD |
106 | fprintf(ofp, " Needs to be a power of 2 for\n"); |
107 | fprintf(ofp, " kernel and ust tracers\n"); | |
cc62c0c0 | 108 | fprintf(ofp, " --num-subbuf NUM Number of subbufers\n"); |
9f778c9a MD |
109 | fprintf(ofp, " (default: %u)\n", |
110 | DEFAULT_CHANNEL_SUBBUF_NUM); | |
93e6c8a0 MD |
111 | fprintf(ofp, " Needs to be a power of 2 for\n"); |
112 | fprintf(ofp, " kernel and ust tracers\n"); | |
cc62c0c0 | 113 | fprintf(ofp, " --switch-timer USEC Switch timer interval in usec (default: %u)\n", |
cabd9892 | 114 | DEFAULT_CHANNEL_SWITCH_TIMER); |
cc62c0c0 | 115 | fprintf(ofp, " --read-timer USEC Read timer interval in usec (default: %u)\n", |
cabd9892 | 116 | DEFAULT_CHANNEL_READ_TIMER); |
d36b8583 DG |
117 | fprintf(ofp, "\n"); |
118 | } | |
119 | ||
5edd7e09 DG |
120 | /* |
121 | * Set default attributes depending on those already defined from the command | |
122 | * line. | |
123 | */ | |
124 | static void set_default_attr(struct lttng_domain *dom) | |
125 | { | |
126 | struct lttng_channel_attr default_attr; | |
127 | ||
128 | /* Set attributes */ | |
129 | lttng_channel_set_default_attr(dom, &default_attr); | |
130 | ||
131 | if (chan.attr.overwrite == -1) { | |
132 | chan.attr.overwrite = default_attr.overwrite; | |
133 | } | |
134 | if (chan.attr.subbuf_size == -1) { | |
135 | chan.attr.subbuf_size = default_attr.subbuf_size; | |
136 | } | |
137 | if (chan.attr.num_subbuf == -1) { | |
138 | chan.attr.num_subbuf = default_attr.num_subbuf; | |
139 | } | |
140 | if (chan.attr.switch_timer_interval == -1) { | |
141 | chan.attr.switch_timer_interval = default_attr.switch_timer_interval; | |
142 | } | |
143 | if (chan.attr.read_timer_interval == -1) { | |
144 | chan.attr.read_timer_interval = default_attr.read_timer_interval; | |
145 | } | |
146 | if (chan.attr.output == -1) { | |
147 | chan.attr.output = default_attr.output; | |
148 | } | |
149 | } | |
150 | ||
d36b8583 | 151 | /* |
0fdd1e2c | 152 | * Adding channel using the lttng API. |
d36b8583 | 153 | */ |
cd80958d | 154 | static int enable_channel(char *session_name) |
d36b8583 | 155 | { |
ae856491 | 156 | int ret = CMD_SUCCESS, warn = 0; |
d36b8583 | 157 | char *channel_name; |
7d29a247 | 158 | struct lttng_domain dom; |
d36b8583 | 159 | |
441c16a7 MD |
160 | memset(&dom, 0, sizeof(dom)); |
161 | ||
d78d6610 | 162 | /* Create lttng domain */ |
7d29a247 DG |
163 | if (opt_kernel) { |
164 | dom.type = LTTNG_DOMAIN_KERNEL; | |
d78d6610 | 165 | } else if (opt_userspace) { |
f6a9efaa | 166 | dom.type = LTTNG_DOMAIN_UST; |
0fdd1e2c | 167 | } else { |
e14f64a8 | 168 | ERR("Please specify a tracer (-k/--kernel or -u/--userspace)"); |
d16c1a4c | 169 | ret = CMD_ERROR; |
0fdd1e2c | 170 | goto error; |
7d29a247 DG |
171 | } |
172 | ||
5edd7e09 DG |
173 | set_default_attr(&dom); |
174 | ||
cd80958d DG |
175 | handle = lttng_create_handle(session_name, &dom); |
176 | if (handle == NULL) { | |
177 | ret = -1; | |
178 | goto error; | |
179 | } | |
180 | ||
0fdd1e2c | 181 | /* Strip channel list (format: chan1,chan2,...) */ |
d36b8583 DG |
182 | channel_name = strtok(opt_channels, ","); |
183 | while (channel_name != NULL) { | |
0fdd1e2c DG |
184 | /* Copy channel name and normalize it */ |
185 | strncpy(chan.name, channel_name, NAME_MAX); | |
186 | chan.name[NAME_MAX - 1] = '\0'; | |
187 | ||
188 | DBG("Enabling channel %s", channel_name); | |
189 | ||
190 | ret = lttng_enable_channel(handle, &chan); | |
191 | if (ret < 0) { | |
ae856491 DG |
192 | ERR("Channel %s: %s (session %s)", channel_name, |
193 | lttng_strerror(ret), session_name); | |
194 | warn = 1; | |
d36b8583 | 195 | } else { |
7885e399 DG |
196 | MSG("%s channel %s enabled for session %s", |
197 | opt_kernel ? "Kernel" : "UST", channel_name, | |
198 | session_name); | |
d36b8583 DG |
199 | } |
200 | ||
201 | /* Next event */ | |
202 | channel_name = strtok(NULL, ","); | |
203 | } | |
204 | ||
ae856491 DG |
205 | ret = CMD_SUCCESS; |
206 | ||
d36b8583 | 207 | error: |
ae856491 DG |
208 | if (warn) { |
209 | ret = CMD_WARNING; | |
210 | } | |
211 | ||
cd80958d DG |
212 | lttng_destroy_handle(handle); |
213 | ||
d36b8583 DG |
214 | return ret; |
215 | } | |
216 | ||
217 | /* | |
0fdd1e2c | 218 | * Default value for channel configuration. |
7d29a247 DG |
219 | */ |
220 | static void init_channel_config(void) | |
221 | { | |
5edd7e09 DG |
222 | /* |
223 | * Put -1 everywhere so we can identify those set by the command line and | |
224 | * those needed to be set by the default values. | |
225 | */ | |
226 | memset(&chan.attr, -1, sizeof(chan.attr)); | |
7d29a247 DG |
227 | } |
228 | ||
229 | /* | |
0fdd1e2c | 230 | * Add channel to trace session |
d36b8583 DG |
231 | */ |
232 | int cmd_enable_channels(int argc, const char **argv) | |
233 | { | |
ca1c3607 | 234 | int opt, ret = CMD_SUCCESS; |
d36b8583 | 235 | static poptContext pc; |
cd80958d | 236 | char *session_name = NULL; |
d36b8583 | 237 | |
7d29a247 DG |
238 | init_channel_config(); |
239 | ||
d36b8583 DG |
240 | pc = poptGetContext(NULL, argc, argv, long_options, 0); |
241 | poptReadDefaultConfig(pc, 0); | |
242 | ||
243 | while ((opt = poptGetNextOpt(pc)) != -1) { | |
244 | switch (opt) { | |
245 | case OPT_HELP: | |
ca1c3607 | 246 | usage(stdout); |
d36b8583 | 247 | goto end; |
7d29a247 DG |
248 | case OPT_DISCARD: |
249 | chan.attr.overwrite = 0; | |
250 | DBG("Channel set to discard"); | |
251 | break; | |
252 | case OPT_OVERWRITE: | |
253 | chan.attr.overwrite = 1; | |
254 | DBG("Channel set to overwrite"); | |
255 | break; | |
256 | case OPT_SUBBUF_SIZE: | |
ca1c3607 | 257 | /* TODO Replace atol with strtol and check for errors */ |
7d29a247 | 258 | chan.attr.subbuf_size = atol(poptGetOptArg(pc)); |
5a0de755 | 259 | DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size); |
7d29a247 DG |
260 | break; |
261 | case OPT_NUM_SUBBUF: | |
ca1c3607 | 262 | /* TODO Replace atoi with strtol and check for errors */ |
7d29a247 | 263 | chan.attr.num_subbuf = atoi(poptGetOptArg(pc)); |
5a0de755 | 264 | DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf); |
7d29a247 DG |
265 | break; |
266 | case OPT_SWITCH_TIMER: | |
ca1c3607 | 267 | /* TODO Replace atoi with strtol and check for errors */ |
7d29a247 DG |
268 | chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc)); |
269 | DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval); | |
270 | break; | |
271 | case OPT_READ_TIMER: | |
ca1c3607 | 272 | /* TODO Replace atoi with strtol and check for errors */ |
7d29a247 DG |
273 | chan.attr.read_timer_interval = atoi(poptGetOptArg(pc)); |
274 | DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval); | |
d36b8583 | 275 | break; |
eeac7d46 MD |
276 | case OPT_USERSPACE: |
277 | opt_userspace = 1; | |
eeac7d46 | 278 | break; |
679b4943 SM |
279 | case OPT_LIST_OPTIONS: |
280 | list_cmd_options(stdout, long_options); | |
679b4943 | 281 | goto end; |
d36b8583 DG |
282 | default: |
283 | usage(stderr); | |
284 | ret = CMD_UNDEFINED; | |
285 | goto end; | |
286 | } | |
287 | } | |
288 | ||
289 | opt_channels = (char*) poptGetArg(pc); | |
290 | if (opt_channels == NULL) { | |
7d29a247 | 291 | ERR("Missing channel name.\n"); |
d36b8583 | 292 | usage(stderr); |
ca1c3607 | 293 | ret = CMD_ERROR; |
d36b8583 DG |
294 | goto end; |
295 | } | |
296 | ||
cd80958d DG |
297 | if (!opt_session_name) { |
298 | session_name = get_session_name(); | |
299 | if (session_name == NULL) { | |
ca1c3607 | 300 | ret = CMD_ERROR; |
cd80958d DG |
301 | goto end; |
302 | } | |
303 | } else { | |
304 | session_name = opt_session_name; | |
305 | } | |
306 | ||
307 | ret = enable_channel(session_name); | |
d36b8583 DG |
308 | |
309 | end: | |
5853fd43 DG |
310 | if (!opt_session_name && session_name) { |
311 | free(session_name); | |
312 | } | |
ca1c3607 | 313 | poptFreeContext(pc); |
d36b8583 DG |
314 | return ret; |
315 | } |