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.
25 #include <sys/types.h>
31 #include <common/sessiond-comm/sessiond-comm.h>
32 #include <common/utils.h>
33 #include <common/mi-lttng.h>
35 #include "../command.h"
39 static char *opt_channels
;
40 static int opt_kernel
;
41 static char *opt_session_name
;
42 static int opt_userspace
;
43 static struct lttng_channel chan
;
44 static char *opt_output
;
45 static int opt_buffer_uid
;
46 static int opt_buffer_pid
;
47 static int opt_buffer_global
;
49 static struct mi_writer
*writer
;
65 static struct lttng_handle
*handle
;
67 const char *output_mmap
= "mmap";
68 const char *output_splice
= "splice";
70 static struct poptOption long_options
[] = {
71 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
72 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
73 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
74 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
75 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
76 {"discard", 0, POPT_ARG_NONE
, 0, OPT_DISCARD
, 0, 0},
77 {"overwrite", 0, POPT_ARG_NONE
, 0, OPT_OVERWRITE
, 0, 0},
78 {"subbuf-size", 0, POPT_ARG_STRING
, 0, OPT_SUBBUF_SIZE
, 0, 0},
79 {"num-subbuf", 0, POPT_ARG_INT
, 0, OPT_NUM_SUBBUF
, 0, 0},
80 {"switch-timer", 0, POPT_ARG_INT
, 0, OPT_SWITCH_TIMER
, 0, 0},
81 {"read-timer", 0, POPT_ARG_INT
, 0, OPT_READ_TIMER
, 0, 0},
82 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
83 {"output", 0, POPT_ARG_STRING
, &opt_output
, 0, 0, 0},
84 {"buffers-uid", 0, POPT_ARG_VAL
, &opt_buffer_uid
, 1, 0, 0},
85 {"buffers-pid", 0, POPT_ARG_VAL
, &opt_buffer_pid
, 1, 0, 0},
86 {"buffers-global", 0, POPT_ARG_VAL
, &opt_buffer_global
, 1, 0, 0},
87 {"tracefile-size", 'C', POPT_ARG_INT
, 0, OPT_TRACEFILE_SIZE
, 0, 0},
88 {"tracefile-count", 'W', POPT_ARG_INT
, 0, OPT_TRACEFILE_COUNT
, 0, 0},
95 static void usage(FILE *ofp
)
97 fprintf(ofp
, "usage: lttng enable-channel NAME[,NAME2,...] (-u | -k) [OPTIONS]\n");
99 fprintf(ofp
, "Options:\n");
100 fprintf(ofp
, " -h, --help Show this help\n");
101 fprintf(ofp
, " --list-options Simple listing of options\n");
102 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
103 fprintf(ofp
, " -k, --kernel Apply to the kernel tracer\n");
104 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
106 fprintf(ofp
, "Channel options:\n");
107 fprintf(ofp
, " --discard Discard event when buffers are full%s\n",
108 DEFAULT_CHANNEL_OVERWRITE
? "" : " (default)");
109 fprintf(ofp
, " --overwrite Flight recorder mode%s\n",
110 DEFAULT_CHANNEL_OVERWRITE
? " (default)" : "");
111 fprintf(ofp
, " --subbuf-size SIZE Subbuffer size in bytes {+k,+M,+G}\n");
112 fprintf(ofp
, " (default UST uid: %zu, UST pid: %zu, kernel: %zu, metadata: %zu)\n",
113 default_get_ust_uid_channel_subbuf_size(),
114 default_get_ust_pid_channel_subbuf_size(),
115 default_get_kernel_channel_subbuf_size(),
116 default_get_metadata_subbuf_size());
117 fprintf(ofp
, " Rounded up to the next power of 2.\n");
118 fprintf(ofp
, " --num-subbuf NUM Number of subbufers\n");
119 fprintf(ofp
, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
120 DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
, DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
,
121 DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
, DEFAULT_METADATA_SUBBUF_NUM
);
122 fprintf(ofp
, " Rounded up to the next power of 2.\n");
123 fprintf(ofp
, " --switch-timer USEC Switch timer interval in usec\n");
124 fprintf(ofp
, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
125 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
, DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
,
126 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
, DEFAULT_METADATA_SWITCH_TIMER
);
127 fprintf(ofp
, " --read-timer USEC Read timer interval in usec.\n");
128 fprintf(ofp
, " (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
129 DEFAULT_UST_UID_CHANNEL_READ_TIMER
, DEFAULT_UST_UID_CHANNEL_READ_TIMER
,
130 DEFAULT_KERNEL_CHANNEL_READ_TIMER
, DEFAULT_METADATA_READ_TIMER
);
131 fprintf(ofp
, " --output TYPE Channel output type (Values: %s, %s)\n",
132 output_mmap
, output_splice
);
133 fprintf(ofp
, " (default UST uid: %s, UST pid: %s, kernel: %s, metadata: %s)\n",
134 DEFAULT_UST_UID_CHANNEL_OUTPUT
== LTTNG_EVENT_MMAP
? output_mmap
: output_splice
,
135 DEFAULT_UST_PID_CHANNEL_OUTPUT
== LTTNG_EVENT_MMAP
? output_mmap
: output_splice
,
136 DEFAULT_KERNEL_CHANNEL_OUTPUT
== LTTNG_EVENT_MMAP
? output_mmap
: output_splice
,
137 DEFAULT_METADATA_OUTPUT
== LTTNG_EVENT_MMAP
? output_mmap
: output_splice
);
138 fprintf(ofp
, " --buffers-uid Use per UID buffer (-u only)\n");
139 fprintf(ofp
, " --buffers-pid Use per PID buffer (-u only)\n");
140 fprintf(ofp
, " --buffers-global Use shared buffer for the whole system (-k only)\n");
141 fprintf(ofp
, " -C, --tracefile-size SIZE\n");
142 fprintf(ofp
, " Maximum size of each tracefile within a stream (in bytes). 0 means unlimited.\n");
143 fprintf(ofp
, " (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_SIZE
);
144 fprintf(ofp
, " Note: traces generated with this option may inaccurately report\n");
145 fprintf(ofp
, " discarded events as per CTF 1.8.\n");
146 fprintf(ofp
, " -W, --tracefile-count COUNT\n");
147 fprintf(ofp
, " Used in conjunction with -C option, this will limit the number\n");
148 fprintf(ofp
, " of files created to the specified count. 0 means unlimited.\n");
149 fprintf(ofp
, " (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_COUNT
);
154 * Set default attributes depending on those already defined from the command
157 static void set_default_attr(struct lttng_domain
*dom
)
159 struct lttng_channel_attr default_attr
;
162 lttng_channel_set_default_attr(dom
, &default_attr
);
164 if (chan
.attr
.overwrite
== -1) {
165 chan
.attr
.overwrite
= default_attr
.overwrite
;
167 if (chan
.attr
.subbuf_size
== -1) {
168 chan
.attr
.subbuf_size
= default_attr
.subbuf_size
;
170 if (chan
.attr
.num_subbuf
== -1) {
171 chan
.attr
.num_subbuf
= default_attr
.num_subbuf
;
173 if (chan
.attr
.switch_timer_interval
== -1) {
174 chan
.attr
.switch_timer_interval
= default_attr
.switch_timer_interval
;
176 if (chan
.attr
.read_timer_interval
== -1) {
177 chan
.attr
.read_timer_interval
= default_attr
.read_timer_interval
;
179 if ((int) chan
.attr
.output
== -1) {
180 chan
.attr
.output
= default_attr
.output
;
182 if (chan
.attr
.tracefile_count
== -1) {
183 chan
.attr
.tracefile_count
= default_attr
.tracefile_count
;
185 if (chan
.attr
.tracefile_size
== -1) {
186 chan
.attr
.tracefile_size
= default_attr
.tracefile_size
;
191 * Adding channel using the lttng API.
193 static int enable_channel(char *session_name
)
195 int ret
= CMD_SUCCESS
, warn
= 0, error
= 0, success
= 0;
197 struct lttng_domain dom
;
199 memset(&dom
, 0, sizeof(dom
));
201 /* Create lttng domain */
203 dom
.type
= LTTNG_DOMAIN_KERNEL
;
204 dom
.buf_type
= LTTNG_BUFFER_GLOBAL
;
205 if (opt_buffer_uid
|| opt_buffer_pid
) {
206 ERR("Buffer type not supported for domain -k");
210 } else if (opt_userspace
) {
211 dom
.type
= LTTNG_DOMAIN_UST
;
212 if (opt_buffer_pid
) {
213 dom
.buf_type
= LTTNG_BUFFER_PER_PID
;
215 if (opt_buffer_global
) {
216 ERR("Buffer type not supported for domain -u");
220 dom
.buf_type
= LTTNG_BUFFER_PER_UID
;
223 print_missing_domain();
228 set_default_attr(&dom
);
230 if (chan
.attr
.tracefile_size
== 0 && chan
.attr
.tracefile_count
) {
231 ERR("Missing option --tracefile-size. "
232 "A file count without a size won't do anything.");
237 if ((chan
.attr
.tracefile_size
> 0) &&
238 (chan
.attr
.tracefile_size
< chan
.attr
.subbuf_size
)) {
239 WARN("Tracefile size rounded up from (%" PRIu64
") to subbuffer size (%" PRIu64
")",
240 chan
.attr
.tracefile_size
, chan
.attr
.subbuf_size
);
241 chan
.attr
.tracefile_size
= chan
.attr
.subbuf_size
;
244 /* Setting channel output */
246 if (!strncmp(output_mmap
, opt_output
, strlen(output_mmap
))) {
247 chan
.attr
.output
= LTTNG_EVENT_MMAP
;
248 } else if (!strncmp(output_splice
, opt_output
, strlen(output_splice
))) {
249 chan
.attr
.output
= LTTNG_EVENT_SPLICE
;
251 ERR("Unknown output type %s. Possible values are: %s, %s\n",
252 opt_output
, output_mmap
, output_splice
);
259 handle
= lttng_create_handle(session_name
, &dom
);
260 if (handle
== NULL
) {
265 /* Mi open channels element */
268 ret
= mi_lttng_channels_open(writer
);
275 /* Strip channel list (format: chan1,chan2,...) */
276 channel_name
= strtok(opt_channels
, ",");
277 while (channel_name
!= NULL
) {
278 /* Validate channel name's length */
279 if (strlen(channel_name
) >= NAME_MAX
) {
280 ERR("Channel name is too long (max. %zu characters)",
281 sizeof(chan
.name
) - 1);
286 /* Copy channel name */
287 strcpy(chan
.name
, channel_name
);
289 DBG("Enabling channel %s", channel_name
);
291 ret
= lttng_enable_channel(handle
, &chan
);
295 case LTTNG_ERR_KERN_CHAN_EXIST
:
296 case LTTNG_ERR_UST_CHAN_EXIST
:
297 case LTTNG_ERR_CHAN_EXIST
:
298 WARN("Channel %s: %s (session %s)", channel_name
,
299 lttng_strerror(ret
), session_name
);
302 case LTTNG_ERR_INVALID_CHANNEL_NAME
:
303 ERR("Invalid channel name: \"%s\". "
304 "Channel names may not start with '.', and "
305 "may not contain '/'.", channel_name
);
309 ERR("Channel %s: %s (session %s)", channel_name
,
310 lttng_strerror(ret
), session_name
);
315 MSG("%s channel %s enabled for session %s",
316 get_domain_str(dom
.type
), channel_name
, session_name
);
322 /* Mi print the channel element and leave it open */
323 ret
= mi_lttng_channel(writer
, &chan
, 1);
329 /* Individual Success ? */
330 ret
= mi_lttng_writer_write_element_bool(writer
,
331 mi_lttng_element_command_success
, success
);
337 /* Close channel element */
338 ret
= mi_lttng_writer_close_element(writer
);
346 channel_name
= strtok(NULL
, ",");
350 /* Close channels element */
351 ret
= mi_lttng_writer_close_element(writer
);
361 /* If more important error happen bypass the warning */
365 /* If more important error happen bypass the warning */
370 lttng_destroy_handle(handle
);
376 * Default value for channel configuration.
378 static void init_channel_config(void)
381 * Put -1 everywhere so we can identify those set by the command line and
382 * those needed to be set by the default values.
384 memset(&chan
.attr
, -1, sizeof(chan
.attr
));
388 * Add channel to trace session
390 int cmd_enable_channels(int argc
, const char **argv
)
392 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
393 static poptContext pc
;
394 char *session_name
= NULL
;
395 char *opt_arg
= NULL
;
397 init_channel_config();
399 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
400 poptReadDefaultConfig(pc
, 0);
402 while ((opt
= poptGetNextOpt(pc
)) != -1) {
408 chan
.attr
.overwrite
= 0;
409 DBG("Channel set to discard");
412 chan
.attr
.overwrite
= 1;
413 DBG("Channel set to overwrite");
415 case OPT_SUBBUF_SIZE
:
417 uint64_t rounded_size
;
421 opt_arg
= poptGetOptArg(pc
);
422 if (utils_parse_size_suffix(opt_arg
, &chan
.attr
.subbuf_size
) < 0 || !chan
.attr
.subbuf_size
) {
423 ERR("Wrong value in --subbuf-size parameter: %s", opt_arg
);
428 order
= get_count_order_u64(chan
.attr
.subbuf_size
);
430 rounded_size
= 1ULL << order
;
431 if (rounded_size
< chan
.attr
.subbuf_size
) {
432 ERR("The subbuf size (%" PRIu64
") is rounded and overflows!",
433 chan
.attr
.subbuf_size
);
438 if (rounded_size
!= chan
.attr
.subbuf_size
) {
439 WARN("The subbuf size (%" PRIu64
") is rounded to the next power of 2 (%" PRIu64
")",
440 chan
.attr
.subbuf_size
, rounded_size
);
441 chan
.attr
.subbuf_size
= rounded_size
;
444 /* Should now be power of 2 */
445 assert(!((chan
.attr
.subbuf_size
- 1) & chan
.attr
.subbuf_size
));
447 DBG("Channel subbuf size set to %" PRIu64
, chan
.attr
.subbuf_size
);
452 uint64_t rounded_size
;
456 opt_arg
= poptGetOptArg(pc
);
457 chan
.attr
.num_subbuf
= strtoull(opt_arg
, NULL
, 0);
458 if (errno
!= 0 || !chan
.attr
.num_subbuf
|| !isdigit(opt_arg
[0])) {
459 ERR("Wrong value in --num-subbuf parameter: %s", opt_arg
);
464 order
= get_count_order_u64(chan
.attr
.num_subbuf
);
466 rounded_size
= 1ULL << order
;
467 if (rounded_size
< chan
.attr
.num_subbuf
) {
468 ERR("The number of subbuffers (%" PRIu64
") is rounded and overflows!",
469 chan
.attr
.num_subbuf
);
474 if (rounded_size
!= chan
.attr
.num_subbuf
) {
475 WARN("The number of subbuffers (%" PRIu64
") is rounded to the next power of 2 (%" PRIu64
")",
476 chan
.attr
.num_subbuf
, rounded_size
);
477 chan
.attr
.num_subbuf
= rounded_size
;
480 /* Should now be power of 2 */
481 assert(!((chan
.attr
.num_subbuf
- 1) & chan
.attr
.num_subbuf
));
483 DBG("Channel subbuf num set to %" PRIu64
, chan
.attr
.num_subbuf
);
486 case OPT_SWITCH_TIMER
:
491 opt_arg
= poptGetOptArg(pc
);
492 v
= strtoul(opt_arg
, NULL
, 0);
493 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
494 ERR("Wrong value in --switch-timer parameter: %s", opt_arg
);
498 if (v
!= (uint32_t) v
) {
499 ERR("32-bit overflow in --switch-timer parameter: %s", opt_arg
);
503 chan
.attr
.switch_timer_interval
= (uint32_t) v
;
504 DBG("Channel switch timer interval set to %d", chan
.attr
.switch_timer_interval
);
512 opt_arg
= poptGetOptArg(pc
);
513 v
= strtoul(opt_arg
, NULL
, 0);
514 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
515 ERR("Wrong value in --read-timer parameter: %s", opt_arg
);
519 if (v
!= (uint32_t) v
) {
520 ERR("32-bit overflow in --read-timer parameter: %s", opt_arg
);
524 chan
.attr
.read_timer_interval
= (uint32_t) v
;
525 DBG("Channel read timer interval set to %d", chan
.attr
.read_timer_interval
);
531 case OPT_TRACEFILE_SIZE
:
532 opt_arg
= poptGetOptArg(pc
);
533 if (utils_parse_size_suffix(opt_arg
, &chan
.attr
.tracefile_size
) < 0) {
534 ERR("Wrong value in --tracefile-size parameter: %s", opt_arg
);
538 DBG("Maximum tracefile size set to %" PRIu64
,
539 chan
.attr
.tracefile_size
);
541 case OPT_TRACEFILE_COUNT
:
546 opt_arg
= poptGetOptArg(pc
);
547 v
= strtoul(opt_arg
, NULL
, 0);
548 if (errno
!= 0 || !isdigit(opt_arg
[0])) {
549 ERR("Wrong value in --tracefile-count parameter: %s", opt_arg
);
553 if (v
!= (uint32_t) v
) {
554 ERR("32-bit overflow in --tracefile-count parameter: %s", opt_arg
);
558 chan
.attr
.tracefile_count
= (uint32_t) v
;
559 DBG("Maximum tracefile count set to %" PRIu64
,
560 chan
.attr
.tracefile_count
);
563 case OPT_LIST_OPTIONS
:
564 list_cmd_options(stdout
, long_options
);
575 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
577 ret
= -LTTNG_ERR_NOMEM
;
581 /* Open command element */
582 ret
= mi_lttng_writer_command_open(writer
,
583 mi_lttng_element_command_enable_channels
);
589 /* Open output element */
590 ret
= mi_lttng_writer_open_element(writer
,
591 mi_lttng_element_command_output
);
598 opt_channels
= (char*) poptGetArg(pc
);
599 if (opt_channels
== NULL
) {
600 ERR("Missing channel name.\n");
607 if (!opt_session_name
) {
608 session_name
= get_session_name();
609 if (session_name
== NULL
) {
610 command_ret
= CMD_ERROR
;
615 session_name
= opt_session_name
;
618 command_ret
= enable_channel(session_name
);
626 /* Close output element */
627 ret
= mi_lttng_writer_close_element(writer
);
633 ret
= mi_lttng_writer_write_element_bool(writer
,
634 mi_lttng_element_command_success
, success
);
639 /* Command element close */
640 ret
= mi_lttng_writer_command_close(writer
);
648 if (writer
&& mi_lttng_writer_destroy(writer
)) {
649 /* Preserve original error code */
650 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
653 if (!opt_session_name
&& session_name
) {
657 /* Overwrite ret if an error occurred when enable_channel */
658 ret
= command_ret
? command_ret
: ret
;