2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
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.
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.
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.
24 #include <sys/types.h>
30 #include <common/sessiond-comm/sessiond-comm.h>
31 #include <common/utils.h>
32 #include <common/mi-lttng.h>
34 #include "../command.h"
38 static char *opt_channels
;
39 static int opt_kernel
;
40 static char *opt_session_name
;
41 static int opt_userspace
;
42 static struct lttng_channel chan
;
43 static char *opt_output
;
44 static int opt_buffer_uid
;
45 static int opt_buffer_pid
;
46 static int opt_buffer_global
;
48 static struct mi_writer
*writer
;
64 static struct lttng_handle
*handle
;
66 const char *output_mmap
= "mmap";
67 const char *output_splice
= "splice";
69 static struct poptOption long_options
[] = {
70 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
71 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
72 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
73 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
74 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
75 {"discard", 0, POPT_ARG_NONE
, 0, OPT_DISCARD
, 0, 0},
76 {"overwrite", 0, POPT_ARG_NONE
, 0, OPT_OVERWRITE
, 0, 0},
77 {"subbuf-size", 0, POPT_ARG_STRING
, 0, OPT_SUBBUF_SIZE
, 0, 0},
78 {"num-subbuf", 0, POPT_ARG_INT
, 0, OPT_NUM_SUBBUF
, 0, 0},
79 {"switch-timer", 0, POPT_ARG_INT
, 0, OPT_SWITCH_TIMER
, 0, 0},
80 {"read-timer", 0, POPT_ARG_INT
, 0, OPT_READ_TIMER
, 0, 0},
81 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
82 {"output", 0, POPT_ARG_STRING
, &opt_output
, 0, 0, 0},
83 {"buffers-uid", 0, POPT_ARG_VAL
, &opt_buffer_uid
, 1, 0, 0},
84 {"buffers-pid", 0, POPT_ARG_VAL
, &opt_buffer_pid
, 1, 0, 0},
85 {"buffers-global", 0, POPT_ARG_VAL
, &opt_buffer_global
, 1, 0, 0},
86 {"tracefile-size", 'C', POPT_ARG_INT
, 0, OPT_TRACEFILE_SIZE
, 0, 0},
87 {"tracefile-count", 'W', POPT_ARG_INT
, 0, OPT_TRACEFILE_COUNT
, 0, 0},
94 static void usage(FILE *ofp
)
96 fprintf(ofp
, "usage: lttng enable-channel NAME[,NAME2,...] (-u | -k) [OPTIONS]\n");
98 fprintf(ofp
, "Options:\n");
99 fprintf(ofp
, " -h, --help Show this help\n");
100 fprintf(ofp
, " --list-options Simple listing of options\n");
101 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
102 fprintf(ofp
, " -k, --kernel Apply to the kernel tracer\n");
103 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
105 fprintf(ofp
, "Channel options:\n");
106 fprintf(ofp
, " --discard Discard event when buffers are full%s\n",
107 DEFAULT_CHANNEL_OVERWRITE
? "" : " (default)");
108 fprintf(ofp
, " --overwrite Flight recorder mode%s\n",
109 DEFAULT_CHANNEL_OVERWRITE
? " (default)" : "");
110 fprintf(ofp
, " --subbuf-size SIZE Subbuffer size in bytes {+k,+M,+G}\n");
111 fprintf(ofp
, " (default UST uid: %zu, UST pid: %zu, kernel: %zu, metadata: %zu)\n",
112 default_get_ust_uid_channel_subbuf_size(),
113 default_get_ust_pid_channel_subbuf_size(),
114 default_get_kernel_channel_subbuf_size(),
115 default_get_metadata_subbuf_size());
116 fprintf(ofp
, " Rounded up to the next power of 2.\n");
117 fprintf(ofp
, " --num-subbuf NUM Number of subbufers\n");
118 fprintf(ofp
, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
119 DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
, DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
,
120 DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
, DEFAULT_METADATA_SUBBUF_NUM
);
121 fprintf(ofp
, " Rounded up to the next power of 2.\n");
122 fprintf(ofp
, " --switch-timer USEC Switch 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_SWITCH_TIMER
, DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
,
125 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
, DEFAULT_METADATA_SWITCH_TIMER
);
126 fprintf(ofp
, " --read-timer USEC Read timer interval in usec.\n");
127 fprintf(ofp
, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
128 DEFAULT_UST_UID_CHANNEL_READ_TIMER
, DEFAULT_UST_UID_CHANNEL_READ_TIMER
,
129 DEFAULT_KERNEL_CHANNEL_READ_TIMER
, DEFAULT_METADATA_READ_TIMER
);
130 fprintf(ofp
, " --output TYPE Channel output type (Values: %s, %s)\n",
131 output_mmap
, output_splice
);
132 fprintf(ofp
, " (default UST uid: %s, UST pid: %s, kernel: %s, metadata: %s)\n",
133 DEFAULT_UST_UID_CHANNEL_OUTPUT
== LTTNG_EVENT_MMAP
? output_mmap
: output_splice
,
134 DEFAULT_UST_PID_CHANNEL_OUTPUT
== LTTNG_EVENT_MMAP
? output_mmap
: output_splice
,
135 DEFAULT_KERNEL_CHANNEL_OUTPUT
== LTTNG_EVENT_MMAP
? output_mmap
: output_splice
,
136 DEFAULT_METADATA_OUTPUT
== LTTNG_EVENT_MMAP
? output_mmap
: output_splice
);
137 fprintf(ofp
, " --buffers-uid Use per UID buffer (-u only)\n");
138 fprintf(ofp
, " --buffers-pid Use per PID buffer (-u only)\n");
139 fprintf(ofp
, " --buffers-global Use shared buffer for the whole system (-k only)\n");
140 fprintf(ofp
, " -C, --tracefile-size SIZE\n");
141 fprintf(ofp
, " Maximum size of each tracefile within a stream (in bytes). 0 means unlimited.\n");
142 fprintf(ofp
, " (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_SIZE
);
143 fprintf(ofp
, " Note: traces generated with this option may inaccurately report\n");
144 fprintf(ofp
, " discarded events as per CTF 1.8.\n");
145 fprintf(ofp
, " -W, --tracefile-count COUNT\n");
146 fprintf(ofp
, " Used in conjunction with -C option, this will limit the number\n");
147 fprintf(ofp
, " of files created to the specified count. 0 means unlimited.\n");
148 fprintf(ofp
, " (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_COUNT
);
153 * Set default attributes depending on those already defined from the command
156 static void set_default_attr(struct lttng_domain
*dom
)
158 struct lttng_channel_attr default_attr
;
161 lttng_channel_set_default_attr(dom
, &default_attr
);
163 if (chan
.attr
.overwrite
== -1) {
164 chan
.attr
.overwrite
= default_attr
.overwrite
;
166 if (chan
.attr
.subbuf_size
== -1) {
167 chan
.attr
.subbuf_size
= default_attr
.subbuf_size
;
169 if (chan
.attr
.num_subbuf
== -1) {
170 chan
.attr
.num_subbuf
= default_attr
.num_subbuf
;
172 if (chan
.attr
.switch_timer_interval
== -1) {
173 chan
.attr
.switch_timer_interval
= default_attr
.switch_timer_interval
;
175 if (chan
.attr
.read_timer_interval
== -1) {
176 chan
.attr
.read_timer_interval
= default_attr
.read_timer_interval
;
178 if ((int) chan
.attr
.output
== -1) {
179 chan
.attr
.output
= default_attr
.output
;
181 if (chan
.attr
.tracefile_count
== -1) {
182 chan
.attr
.tracefile_count
= default_attr
.tracefile_count
;
184 if (chan
.attr
.tracefile_size
== -1) {
185 chan
.attr
.tracefile_size
= default_attr
.tracefile_size
;
190 * Adding channel using the lttng API.
192 static int enable_channel(char *session_name
)
194 int ret
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 0;
196 struct lttng_domain dom
;
198 memset(&dom
, 0, sizeof(dom
));
200 /* Create lttng domain */
202 dom
.type
= LTTNG_DOMAIN_KERNEL
;
203 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
204 if (opt_buffer_uid
|| opt_buffer_pid
) {
205 ERR("Buffer type not supported for domain -k");
209 } else if (opt_userspace
) {
210 dom
.type
= LTTNG_DOMAIN_UST
;
211 if (opt_buffer_pid
) {
212 dom
.buf_type
= LTTNG_BUFFER_PER_PID
;
214 if (opt_buffer_global
) {
215 ERR("Buffer type not supported for domain -u");
219 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
222 /* Checked by the caller. */
226 set_default_attr(&dom
);
228 if (chan
.attr
.tracefile_size
== 0 && chan
.attr
.tracefile_count
) {
229 ERR("Missing option --tracefile-size. "
230 "A file count without a size won't do anything.");
235 if ((chan
.attr
.tracefile_size
> 0) &&
236 (chan
.attr
.tracefile_size
< chan
.attr
.subbuf_size
)) {
237 WARN("Tracefile size rounded up from (%" PRIu64
") to subbuffer size (%" PRIu64
")",
238 chan
.attr
.tracefile_size
, chan
.attr
.subbuf_size
);
239 chan
.attr
.tracefile_size
= chan
.attr
.subbuf_size
;
242 /* Setting channel output */
244 if (!strncmp(output_mmap
, opt_output
, strlen(output_mmap
))) {
245 chan
.attr
.output
= LTTNG_EVENT_MMAP
;
246 } else if (!strncmp(output_splice
, opt_output
, strlen(output_splice
))) {
247 chan
.attr
.output
= LTTNG_EVENT_SPLICE
;
249 ERR("Unknown output type %s. Possible values are: %s, %s\n",
250 opt_output
, output_mmap
, output_splice
);
257 handle
= lttng_create_handle(session_name
, &dom
);
258 if (handle
== NULL
) {
263 /* Mi open channels element */
266 ret
= mi_lttng_channels_open(writer
);
273 /* Strip channel list (format: chan1,chan2,...) */
274 channel_name
= strtok(opt_channels
, ",");
275 while (channel_name
!= NULL
) {
276 /* Validate channel name's length */
277 if (strlen(channel_name
) >= NAME_MAX
) {
278 ERR("Channel name is too long (max. %zu characters)",
279 sizeof(chan
.name
) - 1);
284 /* Copy channel name */
285 strcpy(chan
.name
, channel_name
);
287 DBG("Enabling channel %s", channel_name
);
289 ret
= lttng_enable_channel(handle
, &chan
);
293 case LTTNG_ERR_KERN_CHAN_EXIST
:
294 case LTTNG_ERR_UST_CHAN_EXIST
:
295 case LTTNG_ERR_CHAN_EXIST
:
296 WARN("Channel %s: %s (session %s)", channel_name
,
297 lttng_strerror(ret
), session_name
);
300 case LTTNG_ERR_INVALID_CHANNEL_NAME
:
301 ERR("Invalid channel name: \"%s\". "
302 "Channel names may not start with '.', and "
303 "may not contain '/'.", channel_name
);
307 ERR("Channel %s: %s (session %s)", channel_name
,
308 lttng_strerror(ret
), session_name
);
313 MSG("%s channel %s enabled for session %s",
314 get_domain_str(dom
.type
), channel_name
, session_name
);
320 /* Mi print the channel element and leave it open */
321 ret
= mi_lttng_channel(writer
, &chan
, 1);
327 /* Individual Success ? */
328 ret
= mi_lttng_writer_write_element_bool(writer
,
329 mi_lttng_element_command_success
, success
);
335 /* Close channel element */
336 ret
= mi_lttng_writer_close_element(writer
);
344 channel_name
= strtok(NULL
, ",");
348 /* Close channels element */
349 ret
= mi_lttng_writer_close_element(writer
);
359 /* If more important error happen bypass the warning */
363 /* If more important error happen bypass the warning */
368 lttng_destroy_handle(handle
);
374 * Default value for channel configuration.
376 static void init_channel_config(void)
379 * Put -1 everywhere so we can identify those set by the command line and
380 * those needed to be set by the default values.
382 memset(&chan
.attr
, -1, sizeof(chan
.attr
));
383 chan
.attr
.extended
.ptr
= NULL
;
387 * Add channel to trace session
389 int cmd_enable_channels(int argc
, const char **argv
)
391 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
392 static poptContext pc
;
393 char *session_name
= NULL
;
394 char *opt_arg
= NULL
;
396 init_channel_config();
398 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
399 poptReadDefaultConfig(pc
, 0);
401 while ((opt
= poptGetNextOpt(pc
)) != -1) {
407 chan
.attr
.overwrite
= 0;
408 DBG("Channel set to discard");
411 chan
.attr
.overwrite
= 1;
412 DBG("Channel set to overwrite");
414 case OPT_SUBBUF_SIZE
:
416 uint64_t rounded_size
;
420 opt_arg
= poptGetOptArg(pc
);
421 if (utils_parse_size_suffix(opt_arg
, &chan
.attr
.subbuf_size
) < 0 || !chan
.attr
.subbuf_size
) {
422 ERR("Wrong value in --subbuf-size parameter: %s", opt_arg
);
427 order
= get_count_order_u64(chan
.attr
.subbuf_size
);
429 rounded_size
= 1ULL << order
;
430 if (rounded_size
< chan
.attr
.subbuf_size
) {
431 ERR("The subbuf size (%" PRIu64
") is rounded and overflows!",
432 chan
.attr
.subbuf_size
);
437 if (rounded_size
!= chan
.attr
.subbuf_size
) {
438 WARN("The subbuf size (%" PRIu64
") is rounded to the next power of 2 (%" PRIu64
")",
439 chan
.attr
.subbuf_size
, rounded_size
);
440 chan
.attr
.subbuf_size
= rounded_size
;
443 /* Should now be power of 2 */
444 assert(!((chan
.attr
.subbuf_size
- 1) & chan
.attr
.subbuf_size
));
446 DBG("Channel subbuf size set to %" PRIu64
, chan
.attr
.subbuf_size
);
451 uint64_t rounded_size
;
455 opt_arg
= poptGetOptArg(pc
);
456 chan
.attr
.num_subbuf
= strtoull(opt_arg
, NULL
, 0);
457 if (errno
!= 0 || !chan
.attr
.num_subbuf
|| !isdigit(opt_arg
[0])) {
458 ERR("Wrong value in --num-subbuf parameter: %s", opt_arg
);
463 order
= get_count_order_u64(chan
.attr
.num_subbuf
);
465 rounded_size
= 1ULL << order
;
466 if (rounded_size
< chan
.attr
.num_subbuf
) {
467 ERR("The number of subbuffers (%" PRIu64
") is rounded and overflows!",
468 chan
.attr
.num_subbuf
);
473 if (rounded_size
!= chan
.attr
.num_subbuf
) {
474 WARN("The number of subbuffers (%" PRIu64
") is rounded to the next power of 2 (%" PRIu64
")",
475 chan
.attr
.num_subbuf
, rounded_size
);
476 chan
.attr
.num_subbuf
= rounded_size
;
479 /* Should now be power of 2 */
480 assert(!((chan
.attr
.num_subbuf
- 1) & chan
.attr
.num_subbuf
));
482 DBG("Channel subbuf num set to %" PRIu64
, chan
.attr
.num_subbuf
);
485 case OPT_SWITCH_TIMER
:
490 opt_arg
= poptGetOptArg(pc
);
491 v
= strtoul(opt_arg
, NULL
, 0);
492 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
493 ERR("Wrong value in --switch-timer parameter: %s", opt_arg
);
497 if (v
!= (uint32_t) v
) {
498 ERR("32-bit overflow in --switch-timer parameter: %s", opt_arg
);
502 chan
.attr
.switch_timer_interval
= (uint32_t) v
;
503 DBG("Channel switch timer interval set to %d", chan
.attr
.switch_timer_interval
);
511 opt_arg
= poptGetOptArg(pc
);
512 v
= strtoul(opt_arg
, NULL
, 0);
513 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
514 ERR("Wrong value in --read-timer parameter: %s", opt_arg
);
518 if (v
!= (uint32_t) v
) {
519 ERR("32-bit overflow in --read-timer parameter: %s", opt_arg
);
523 chan
.attr
.read_timer_interval
= (uint32_t) v
;
524 DBG("Channel read timer interval set to %d", chan
.attr
.read_timer_interval
);
530 case OPT_TRACEFILE_SIZE
:
531 opt_arg
= poptGetOptArg(pc
);
532 if (utils_parse_size_suffix(opt_arg
, &chan
.attr
.tracefile_size
) < 0) {
533 ERR("Wrong value in --tracefile-size parameter: %s", opt_arg
);
537 DBG("Maximum tracefile size set to %" PRIu64
,
538 chan
.attr
.tracefile_size
);
540 case OPT_TRACEFILE_COUNT
:
545 opt_arg
= poptGetOptArg(pc
);
546 v
= strtoul(opt_arg
, NULL
, 0);
547 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
548 ERR("Wrong value in --tracefile-count parameter: %s", opt_arg
);
552 if (v
!= (uint32_t) v
) {
553 ERR("32-bit overflow in --tracefile-count parameter: %s", opt_arg
);
557 chan
.attr
.tracefile_count
= (uint32_t) v
;
558 DBG("Maximum tracefile count set to %" PRIu64
,
559 chan
.attr
.tracefile_count
);
562 case OPT_LIST_OPTIONS
:
563 list_cmd_options(stdout
, long_options
);
572 ret
= print_missing_or_multiple_domains(opt_kernel
+ opt_userspace
);
580 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
582 ret
= -LTTNG_ERR_NOMEM
;
586 /* Open command element */
587 ret
= mi_lttng_writer_command_open(writer
,
588 mi_lttng_element_command_enable_channels
);
594 /* Open output element */
595 ret
= mi_lttng_writer_open_element(writer
,
596 mi_lttng_element_command_output
);
603 opt_channels
= (char*) poptGetArg(pc
);
604 if (opt_channels
== NULL
) {
605 ERR("Missing channel name.\n");
612 if (!opt_session_name
) {
613 session_name
= get_session_name();
614 if (session_name
== NULL
) {
615 command_ret
= CMD_ERROR
;
620 session_name
= opt_session_name
;
623 command_ret
= enable_channel(session_name
);
631 /* Close output element */
632 ret
= mi_lttng_writer_close_element(writer
);
638 ret
= mi_lttng_writer_write_element_bool(writer
,
639 mi_lttng_element_command_success
, success
);
644 /* Command element close */
645 ret
= mi_lttng_writer_command_close(writer
);
653 if (writer
&& mi_lttng_writer_destroy(writer
)) {
654 /* Preserve original error code */
655 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
658 if (!opt_session_name
&& session_name
) {
662 /* Overwrite ret if an error occurred when enable_channel */
663 ret
= command_ret
? command_ret
: ret
;