Fix: split UST per UID/PID default values
[lttng-tools.git] / src / bin / lttng / commands / enable_channels.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 modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
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 *
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.
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>
26 #include <inttypes.h>
27 #include <assert.h>
28 #include <ctype.h>
29
30 #include "../command.h"
31 #include "../utils.h"
32
33 #include <src/common/sessiond-comm/sessiond-comm.h>
34 #include <src/common/utils.h>
35
36 static char *opt_channels;
37 static int opt_kernel;
38 static char *opt_session_name;
39 static int opt_userspace;
40 static struct lttng_channel chan;
41 static char *opt_output;
42 static int opt_buffer_uid;
43 static int opt_buffer_pid;
44 static int opt_buffer_global;
45
46 enum {
47 OPT_HELP = 1,
48 OPT_DISCARD,
49 OPT_OVERWRITE,
50 OPT_SUBBUF_SIZE,
51 OPT_NUM_SUBBUF,
52 OPT_SWITCH_TIMER,
53 OPT_READ_TIMER,
54 OPT_USERSPACE,
55 OPT_LIST_OPTIONS,
56 OPT_TRACEFILE_SIZE,
57 OPT_TRACEFILE_COUNT,
58 };
59
60 static struct lttng_handle *handle;
61
62 const char *output_mmap = "mmap";
63 const char *output_splice = "splice";
64
65 static struct poptOption long_options[] = {
66 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
67 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
68 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
69 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
70 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
71 {"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
72 {"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
73 {"subbuf-size", 0, POPT_ARG_STRING, 0, OPT_SUBBUF_SIZE, 0, 0},
74 {"num-subbuf", 0, POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
75 {"switch-timer", 0, POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
76 {"read-timer", 0, POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
77 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
78 {"output", 0, POPT_ARG_STRING, &opt_output, 0, 0, 0},
79 {"buffers-uid", 0, POPT_ARG_VAL, &opt_buffer_uid, 1, 0, 0},
80 {"buffers-pid", 0, POPT_ARG_VAL, &opt_buffer_pid, 1, 0, 0},
81 {"buffers-global", 0, POPT_ARG_VAL, &opt_buffer_global, 1, 0, 0},
82 {"tracefile-size", 'C', POPT_ARG_INT, 0, OPT_TRACEFILE_SIZE, 0, 0},
83 {"tracefile-count", 'W', POPT_ARG_INT, 0, OPT_TRACEFILE_COUNT, 0, 0},
84 {0, 0, 0, 0, 0, 0, 0}
85 };
86
87 /*
88 * usage
89 */
90 static void usage(FILE *ofp)
91 {
92 fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [-u|-k] [OPTIONS]\n");
93 fprintf(ofp, "\n");
94 fprintf(ofp, "Options:\n");
95 fprintf(ofp, " -h, --help Show this help\n");
96 fprintf(ofp, " --list-options Simple listing of options\n");
97 fprintf(ofp, " -s, --session NAME Apply to session name\n");
98 fprintf(ofp, " -k, --kernel Apply to the kernel tracer\n");
99 fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
100 fprintf(ofp, "\n");
101 fprintf(ofp, "Channel options:\n");
102 fprintf(ofp, " --discard Discard event when buffers are full%s\n",
103 DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)");
104 fprintf(ofp, " --overwrite Flight recorder mode%s\n",
105 DEFAULT_CHANNEL_OVERWRITE ? " (default)" : "");
106 fprintf(ofp, " --subbuf-size SIZE Subbuffer size in bytes {+k,+M,+G}\n");
107 fprintf(ofp, " (default UST uid: %zu, UST pid: %zu, kernel: %zu, metadata: %zu)\n",
108 default_get_ust_uid_channel_subbuf_size(),
109 default_get_ust_pid_channel_subbuf_size(),
110 default_get_kernel_channel_subbuf_size(),
111 default_get_metadata_subbuf_size());
112 fprintf(ofp, " Rounded up to the next power of 2.\n");
113 fprintf(ofp, " --num-subbuf NUM Number of subbufers\n");
114 fprintf(ofp, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
115 DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM, DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM,
116 DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM, DEFAULT_METADATA_SUBBUF_NUM);
117 fprintf(ofp, " Rounded up to the next power of 2.\n");
118 fprintf(ofp, " --switch-timer USEC Switch timer interval in usec\n");
119 fprintf(ofp, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
120 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER, DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER,
121 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER, DEFAULT_METADATA_SWITCH_TIMER);
122 fprintf(ofp, " --read-timer USEC Read timer interval in usec.\n");
123 fprintf(ofp, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
124 DEFAULT_UST_UID_CHANNEL_READ_TIMER, DEFAULT_UST_UID_CHANNEL_READ_TIMER,
125 DEFAULT_KERNEL_CHANNEL_READ_TIMER, DEFAULT_METADATA_READ_TIMER);
126 fprintf(ofp, " --output TYPE Channel output type (Values: %s, %s)\n",
127 output_mmap, output_splice);
128 fprintf(ofp, " (default UST uid: %s, UST pid: %s, kernel: %s, metadata: %s)\n",
129 DEFAULT_UST_UID_CHANNEL_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice,
130 DEFAULT_UST_PID_CHANNEL_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice,
131 DEFAULT_KERNEL_CHANNEL_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice,
132 DEFAULT_METADATA_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice);
133 fprintf(ofp, " --buffers-uid Use per UID buffer (-u only)\n");
134 fprintf(ofp, " --buffers-pid Use per PID buffer (-u only)\n");
135 fprintf(ofp, " --buffers-global Use shared buffer for the whole system (-k only)\n");
136 fprintf(ofp, " -C, --tracefile-size SIZE\n");
137 fprintf(ofp, " Maximum size of each tracefile within a stream (in bytes). 0 means unlimited.\n");
138 fprintf(ofp, " (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_SIZE);
139 fprintf(ofp, " -W, --tracefile-count COUNT\n");
140 fprintf(ofp, " Used in conjunction with -C option, this will limit the number\n");
141 fprintf(ofp, " of files created to the specified count. 0 means unlimited.\n");
142 fprintf(ofp, " (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_COUNT);
143 fprintf(ofp, "\n");
144 }
145
146 /*
147 * Set default attributes depending on those already defined from the command
148 * line.
149 */
150 static void set_default_attr(struct lttng_domain *dom)
151 {
152 struct lttng_channel_attr default_attr;
153
154 /* Set attributes */
155 lttng_channel_set_default_attr(dom, &default_attr);
156
157 if (chan.attr.overwrite == -1) {
158 chan.attr.overwrite = default_attr.overwrite;
159 }
160 if (chan.attr.subbuf_size == -1) {
161 chan.attr.subbuf_size = default_attr.subbuf_size;
162 }
163 if (chan.attr.num_subbuf == -1) {
164 chan.attr.num_subbuf = default_attr.num_subbuf;
165 }
166 if (chan.attr.switch_timer_interval == -1) {
167 chan.attr.switch_timer_interval = default_attr.switch_timer_interval;
168 }
169 if (chan.attr.read_timer_interval == -1) {
170 chan.attr.read_timer_interval = default_attr.read_timer_interval;
171 }
172 if (chan.attr.output == -1) {
173 chan.attr.output = default_attr.output;
174 }
175 if (chan.attr.tracefile_count == -1) {
176 chan.attr.tracefile_count = default_attr.tracefile_count;
177 }
178 if (chan.attr.tracefile_size == -1) {
179 chan.attr.tracefile_size = default_attr.tracefile_size;
180 }
181 }
182
183 /*
184 * Adding channel using the lttng API.
185 */
186 static int enable_channel(char *session_name)
187 {
188 int ret = CMD_SUCCESS, warn = 0;
189 char *channel_name;
190 struct lttng_domain dom;
191
192 memset(&dom, 0, sizeof(dom));
193
194 /* Create lttng domain */
195 if (opt_kernel) {
196 dom.type = LTTNG_DOMAIN_KERNEL;
197 dom.buf_type = LTTNG_BUFFER_GLOBAL;
198 if (opt_buffer_uid || opt_buffer_pid) {
199 ERR("Buffer type not supported for domain -k");
200 ret = CMD_ERROR;
201 goto error;
202 }
203 } else if (opt_userspace) {
204 dom.type = LTTNG_DOMAIN_UST;
205 if (opt_buffer_uid) {
206 dom.buf_type = LTTNG_BUFFER_PER_UID;
207 } else {
208 if (opt_buffer_global) {
209 ERR("Buffer type not supported for domain -u");
210 ret = CMD_ERROR;
211 goto error;
212 }
213 dom.buf_type = LTTNG_BUFFER_PER_PID;
214 }
215 } else {
216 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
217 ret = CMD_ERROR;
218 goto error;
219 }
220
221 set_default_attr(&dom);
222
223 if ((chan.attr.tracefile_size > 0) &&
224 (chan.attr.tracefile_size < chan.attr.subbuf_size)) {
225 WARN("Tracefile size rounded up from (%" PRIu64 ") to subbuffer size (%" PRIu64 ")",
226 chan.attr.tracefile_size, chan.attr.subbuf_size);
227 chan.attr.tracefile_size = chan.attr.subbuf_size;
228 }
229
230 /* Setting channel output */
231 if (opt_output) {
232 if (!strncmp(output_mmap, opt_output, strlen(output_mmap))) {
233 chan.attr.output = LTTNG_EVENT_MMAP;
234 } else if (!strncmp(output_splice, opt_output, strlen(output_splice))) {
235 chan.attr.output = LTTNG_EVENT_SPLICE;
236 } else {
237 ERR("Unknown output type %s. Possible values are: %s, %s\n",
238 opt_output, output_mmap, output_splice);
239 usage(stderr);
240 ret = CMD_ERROR;
241 goto error;
242 }
243 }
244
245 handle = lttng_create_handle(session_name, &dom);
246 if (handle == NULL) {
247 ret = -1;
248 goto error;
249 }
250
251 /* Strip channel list (format: chan1,chan2,...) */
252 channel_name = strtok(opt_channels, ",");
253 while (channel_name != NULL) {
254 /* Copy channel name and normalize it */
255 strncpy(chan.name, channel_name, NAME_MAX);
256 chan.name[NAME_MAX - 1] = '\0';
257
258 DBG("Enabling channel %s", channel_name);
259
260 ret = lttng_enable_channel(handle, &chan);
261 if (ret < 0) {
262 switch (-ret) {
263 case LTTNG_ERR_KERN_CHAN_EXIST:
264 case LTTNG_ERR_UST_CHAN_EXIST:
265 WARN("Channel %s: %s (session %s)", channel_name,
266 lttng_strerror(ret), session_name);
267 goto error;
268 default:
269 ERR("Channel %s: %s (session %s)", channel_name,
270 lttng_strerror(ret), session_name);
271 break;
272 }
273 warn = 1;
274 } else {
275 MSG("%s channel %s enabled for session %s",
276 opt_kernel ? "Kernel" : "UST", channel_name,
277 session_name);
278 }
279
280 /* Next event */
281 channel_name = strtok(NULL, ",");
282 }
283
284 ret = CMD_SUCCESS;
285
286 error:
287 if (warn) {
288 ret = CMD_WARNING;
289 }
290
291 lttng_destroy_handle(handle);
292
293 return ret;
294 }
295
296 /*
297 * Default value for channel configuration.
298 */
299 static void init_channel_config(void)
300 {
301 /*
302 * Put -1 everywhere so we can identify those set by the command line and
303 * those needed to be set by the default values.
304 */
305 memset(&chan.attr, -1, sizeof(chan.attr));
306 }
307
308 /*
309 * Add channel to trace session
310 */
311 int cmd_enable_channels(int argc, const char **argv)
312 {
313 int opt, ret = CMD_SUCCESS;
314 static poptContext pc;
315 char *session_name = NULL;
316 char *opt_arg = NULL;
317
318 init_channel_config();
319
320 pc = poptGetContext(NULL, argc, argv, long_options, 0);
321 poptReadDefaultConfig(pc, 0);
322
323 while ((opt = poptGetNextOpt(pc)) != -1) {
324 switch (opt) {
325 case OPT_HELP:
326 usage(stdout);
327 goto end;
328 case OPT_DISCARD:
329 chan.attr.overwrite = 0;
330 DBG("Channel set to discard");
331 break;
332 case OPT_OVERWRITE:
333 chan.attr.overwrite = 1;
334 DBG("Channel set to overwrite");
335 break;
336 case OPT_SUBBUF_SIZE:
337 {
338 uint64_t rounded_size;
339 int order;
340
341 /* Parse the size */
342 opt_arg = poptGetOptArg(pc);
343 if (utils_parse_size_suffix(opt_arg, &chan.attr.subbuf_size) < 0 || !chan.attr.subbuf_size) {
344 ERR("Wrong value in --subbuf-size parameter: %s", opt_arg);
345 ret = CMD_ERROR;
346 goto end;
347 }
348
349 order = get_count_order_u64(chan.attr.subbuf_size);
350 assert(order >= 0);
351 rounded_size = 1ULL << order;
352 if (rounded_size != chan.attr.subbuf_size) {
353 WARN("The subbuf size (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")",
354 chan.attr.subbuf_size, rounded_size);
355 chan.attr.subbuf_size = rounded_size;
356 }
357
358 /* Should now be power of 2 */
359 assert(!((chan.attr.subbuf_size - 1) & chan.attr.subbuf_size));
360
361 DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
362 break;
363 }
364 case OPT_NUM_SUBBUF:
365 {
366 uint64_t rounded_size;
367 int order;
368
369 errno = 0;
370 opt_arg = poptGetOptArg(pc);
371 chan.attr.num_subbuf = strtoull(opt_arg, NULL, 0);
372 if (errno != 0 || !chan.attr.num_subbuf || !isdigit(opt_arg[0])) {
373 ERR("Wrong value in --num-subbuf parameter: %s", opt_arg);
374 ret = CMD_ERROR;
375 goto end;
376 }
377
378 order = get_count_order_u64(chan.attr.num_subbuf);
379 assert(order >= 0);
380 rounded_size = 1ULL << order;
381 if (rounded_size != chan.attr.num_subbuf) {
382 WARN("The number of subbuffers (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")",
383 chan.attr.num_subbuf, rounded_size);
384 chan.attr.num_subbuf = rounded_size;
385 }
386
387 /* Should now be power of 2 */
388 assert(!((chan.attr.num_subbuf - 1) & chan.attr.num_subbuf));
389
390 DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
391 break;
392 }
393 case OPT_SWITCH_TIMER:
394 {
395 unsigned long v;
396
397 errno = 0;
398 opt_arg = poptGetOptArg(pc);
399 v = strtoul(opt_arg, NULL, 0);
400 if (errno != 0 || !isdigit(opt_arg[0])) {
401 ERR("Wrong value in --switch-timer parameter: %s", opt_arg);
402 ret = CMD_ERROR;
403 goto end;
404 }
405 if (v != (uint32_t) v) {
406 ERR("32-bit overflow in --switch-timer parameter: %s", opt_arg);
407 ret = CMD_ERROR;
408 goto end;
409 }
410 chan.attr.switch_timer_interval = (uint32_t) v;
411 DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
412 break;
413 }
414 case OPT_READ_TIMER:
415 {
416 unsigned long v;
417
418 errno = 0;
419 opt_arg = poptGetOptArg(pc);
420 v = strtoul(opt_arg, NULL, 0);
421 if (errno != 0 || !isdigit(opt_arg[0])) {
422 ERR("Wrong value in --read-timer parameter: %s", opt_arg);
423 ret = CMD_ERROR;
424 goto end;
425 }
426 if (v != (uint32_t) v) {
427 ERR("32-bit overflow in --read-timer parameter: %s", opt_arg);
428 ret = CMD_ERROR;
429 goto end;
430 }
431 chan.attr.read_timer_interval = (uint32_t) v;
432 DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
433 break;
434 }
435 case OPT_USERSPACE:
436 opt_userspace = 1;
437 break;
438 case OPT_TRACEFILE_SIZE:
439 opt_arg = poptGetOptArg(pc);
440 if (utils_parse_size_suffix(opt_arg, &chan.attr.tracefile_size) < 0) {
441 ERR("Wrong value in --tracefile-size parameter: %s", opt_arg);
442 ret = CMD_ERROR;
443 goto end;
444 }
445 DBG("Maximum tracefile size set to %" PRIu64,
446 chan.attr.tracefile_size);
447 break;
448 case OPT_TRACEFILE_COUNT:
449 {
450 unsigned long v;
451
452 errno = 0;
453 opt_arg = poptGetOptArg(pc);
454 v = strtoul(opt_arg, NULL, 0);
455 if (errno != 0 || !isdigit(opt_arg[0])) {
456 ERR("Wrong value in --tracefile-count parameter: %s", opt_arg);
457 ret = CMD_ERROR;
458 goto end;
459 }
460 if (v != (uint32_t) v) {
461 ERR("32-bit overflow in --tracefile-count parameter: %s", opt_arg);
462 ret = CMD_ERROR;
463 goto end;
464 }
465 chan.attr.tracefile_count = (uint32_t) v;
466 DBG("Maximum tracefile count set to %" PRIu64,
467 chan.attr.tracefile_count);
468 break;
469 }
470 case OPT_LIST_OPTIONS:
471 list_cmd_options(stdout, long_options);
472 goto end;
473 default:
474 usage(stderr);
475 ret = CMD_UNDEFINED;
476 goto end;
477 }
478 }
479
480 opt_channels = (char*) poptGetArg(pc);
481 if (opt_channels == NULL) {
482 ERR("Missing channel name.\n");
483 usage(stderr);
484 ret = CMD_ERROR;
485 goto end;
486 }
487
488 if (!opt_session_name) {
489 session_name = get_session_name();
490 if (session_name == NULL) {
491 ret = CMD_ERROR;
492 goto end;
493 }
494 } else {
495 session_name = opt_session_name;
496 }
497
498 ret = enable_channel(session_name);
499
500 end:
501 if (!opt_session_name && session_name) {
502 free(session_name);
503 }
504 poptFreeContext(pc);
505 return ret;
506 }
This page took 0.067275 seconds and 4 git commands to generate.