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>
28 #include "../command.h"
30 #include <src/common/sessiond-comm/sessiond-comm.h>
32 static char *opt_channels
;
33 static int opt_kernel
;
34 static char *opt_session_name
;
35 static int opt_userspace
;
36 static struct lttng_channel chan
;
37 static char *opt_output
;
39 /* Not implemented yet */
40 static char *opt_cmd_name
;
56 static struct lttng_handle
*handle
;
58 const char *output_mmap
= "mmap";
59 const char *output_splice
= "splice";
61 static struct poptOption long_options
[] = {
62 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
63 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
64 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
65 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
67 /* Not implemented yet */
68 {"userspace", 'u', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_cmd_name
, OPT_USERSPACE
, 0, 0},
69 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
71 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
73 {"discard", 0, POPT_ARG_NONE
, 0, OPT_DISCARD
, 0, 0},
74 {"overwrite", 0, POPT_ARG_NONE
, 0, OPT_OVERWRITE
, 0, 0},
75 {"subbuf-size", 0, POPT_ARG_DOUBLE
, 0, OPT_SUBBUF_SIZE
, 0, 0},
76 {"num-subbuf", 0, POPT_ARG_INT
, 0, OPT_NUM_SUBBUF
, 0, 0},
77 {"switch-timer", 0, POPT_ARG_INT
, 0, OPT_SWITCH_TIMER
, 0, 0},
78 {"read-timer", 0, POPT_ARG_INT
, 0, OPT_READ_TIMER
, 0, 0},
79 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
80 {"output", 0, POPT_ARG_STRING
, &opt_output
, 0, 0, 0},
87 static void usage(FILE *ofp
)
89 fprintf(ofp
, "usage: lttng enable-channel NAME[,NAME2,...] [-u|-k] [OPTIONS]\n");
91 fprintf(ofp
, "Options:\n");
92 fprintf(ofp
, " -h, --help Show this help\n");
93 fprintf(ofp
, " --list-options Simple listing of options\n");
94 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
95 fprintf(ofp
, " -k, --kernel Apply to the kernel tracer\n");
96 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
98 fprintf(ofp
, "Channel options:\n");
99 fprintf(ofp
, " --discard Discard event when buffers are full%s\n",
100 DEFAULT_CHANNEL_OVERWRITE
? "" : " (default)");
101 fprintf(ofp
, " --overwrite Flight recorder mode%s\n",
102 DEFAULT_CHANNEL_OVERWRITE
? " (default)" : "");
103 fprintf(ofp
, " --subbuf-size SIZE Subbuffer size in bytes\n");
104 fprintf(ofp
, " (default: %u, kernel default: %u)\n",
105 DEFAULT_CHANNEL_SUBBUF_SIZE
,
106 DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
);
107 fprintf(ofp
, " Needs to be a power of 2 for\n");
108 fprintf(ofp
, " kernel and ust tracers\n");
109 fprintf(ofp
, " --num-subbuf NUM Number of subbufers\n");
110 fprintf(ofp
, " (default: %u)\n",
111 DEFAULT_CHANNEL_SUBBUF_NUM
);
112 fprintf(ofp
, " Needs to be a power of 2 for\n");
113 fprintf(ofp
, " kernel and ust tracers\n");
114 fprintf(ofp
, " --switch-timer USEC Switch timer interval in usec (default: %u)\n",
115 DEFAULT_CHANNEL_SWITCH_TIMER
);
116 fprintf(ofp
, " --read-timer USEC Read timer interval in usec (default: %u)\n",
117 DEFAULT_CHANNEL_READ_TIMER
);
118 fprintf(ofp
, " --output TYPE Channel output type (Values: %s, %s)\n",
119 output_mmap
, output_splice
);
124 * Set default attributes depending on those already defined from the command
127 static void set_default_attr(struct lttng_domain
*dom
)
129 struct lttng_channel_attr default_attr
;
132 lttng_channel_set_default_attr(dom
, &default_attr
);
134 if (chan
.attr
.overwrite
== -1) {
135 chan
.attr
.overwrite
= default_attr
.overwrite
;
137 if (chan
.attr
.subbuf_size
== -1) {
138 chan
.attr
.subbuf_size
= default_attr
.subbuf_size
;
140 if (chan
.attr
.num_subbuf
== -1) {
141 chan
.attr
.num_subbuf
= default_attr
.num_subbuf
;
143 if (chan
.attr
.switch_timer_interval
== -1) {
144 chan
.attr
.switch_timer_interval
= default_attr
.switch_timer_interval
;
146 if (chan
.attr
.read_timer_interval
== -1) {
147 chan
.attr
.read_timer_interval
= default_attr
.read_timer_interval
;
149 if (chan
.attr
.output
== -1) {
150 chan
.attr
.output
= default_attr
.output
;
155 * Adding channel using the lttng API.
157 static int enable_channel(char *session_name
)
159 int ret
= CMD_SUCCESS
, warn
= 0;
161 struct lttng_domain dom
;
163 memset(&dom
, 0, sizeof(dom
));
165 /* Create lttng domain */
167 dom
.type
= LTTNG_DOMAIN_KERNEL
;
168 } else if (opt_userspace
) {
169 dom
.type
= LTTNG_DOMAIN_UST
;
171 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
176 set_default_attr(&dom
);
178 /* Setting channel output */
180 if (!strncmp(output_mmap
, opt_output
, strlen(output_mmap
))) {
181 chan
.attr
.output
= LTTNG_EVENT_MMAP
;
182 } else if (!strncmp(output_splice
, opt_output
, strlen(output_splice
))) {
183 chan
.attr
.output
= LTTNG_EVENT_SPLICE
;
185 ERR("Unknown output type %s. Possible values are: %s, %s\n",
186 opt_output
, output_mmap
, output_splice
);
193 handle
= lttng_create_handle(session_name
, &dom
);
194 if (handle
== NULL
) {
199 /* Strip channel list (format: chan1,chan2,...) */
200 channel_name
= strtok(opt_channels
, ",");
201 while (channel_name
!= NULL
) {
202 /* Copy channel name and normalize it */
203 strncpy(chan
.name
, channel_name
, NAME_MAX
);
204 chan
.name
[NAME_MAX
- 1] = '\0';
206 DBG("Enabling channel %s", channel_name
);
208 ret
= lttng_enable_channel(handle
, &chan
);
211 case LTTNG_ERR_KERN_CHAN_EXIST
:
212 case LTTNG_ERR_UST_CHAN_EXIST
:
213 WARN("Channel %s: %s (session %s", channel_name
,
214 lttng_strerror(ret
), session_name
);
217 ERR("Channel %s: %s (session %s)", channel_name
,
218 lttng_strerror(ret
), session_name
);
223 MSG("%s channel %s enabled for session %s",
224 opt_kernel
? "Kernel" : "UST", channel_name
,
229 channel_name
= strtok(NULL
, ",");
239 lttng_destroy_handle(handle
);
245 * Default value for channel configuration.
247 static void init_channel_config(void)
250 * Put -1 everywhere so we can identify those set by the command line and
251 * those needed to be set by the default values.
253 memset(&chan
.attr
, -1, sizeof(chan
.attr
));
257 * Add channel to trace session
259 int cmd_enable_channels(int argc
, const char **argv
)
261 int opt
, ret
= CMD_SUCCESS
;
262 static poptContext pc
;
263 char *session_name
= NULL
;
265 init_channel_config();
267 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
268 poptReadDefaultConfig(pc
, 0);
270 while ((opt
= poptGetNextOpt(pc
)) != -1) {
276 chan
.attr
.overwrite
= 0;
277 DBG("Channel set to discard");
280 chan
.attr
.overwrite
= 1;
281 DBG("Channel set to overwrite");
283 case OPT_SUBBUF_SIZE
:
284 /* TODO Replace atol with strtol and check for errors */
285 chan
.attr
.subbuf_size
= atol(poptGetOptArg(pc
));
286 DBG("Channel subbuf size set to %" PRIu64
, chan
.attr
.subbuf_size
);
289 /* TODO Replace atoi with strtol and check for errors */
290 chan
.attr
.num_subbuf
= atoi(poptGetOptArg(pc
));
291 DBG("Channel subbuf num set to %" PRIu64
, chan
.attr
.num_subbuf
);
293 case OPT_SWITCH_TIMER
:
294 /* TODO Replace atoi with strtol and check for errors */
295 chan
.attr
.switch_timer_interval
= atoi(poptGetOptArg(pc
));
296 DBG("Channel switch timer interval set to %d", chan
.attr
.switch_timer_interval
);
299 /* TODO Replace atoi with strtol and check for errors */
300 chan
.attr
.read_timer_interval
= atoi(poptGetOptArg(pc
));
301 DBG("Channel read timer interval set to %d", chan
.attr
.read_timer_interval
);
306 case OPT_LIST_OPTIONS
:
307 list_cmd_options(stdout
, long_options
);
316 opt_channels
= (char*) poptGetArg(pc
);
317 if (opt_channels
== NULL
) {
318 ERR("Missing channel name.\n");
324 if (!opt_session_name
) {
325 session_name
= get_session_name();
326 if (session_name
== NULL
) {
331 session_name
= opt_session_name
;
334 ret
= enable_channel(session_name
);
337 if (!opt_session_name
&& session_name
) {