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
;
38 /* Not implemented yet */
39 static char *opt_cmd_name
;
55 static struct lttng_handle
*handle
;
57 static struct poptOption long_options
[] = {
58 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
59 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
60 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
61 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
63 /* Not implemented yet */
64 {"userspace", 'u', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_cmd_name
, OPT_USERSPACE
, 0, 0},
65 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
67 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
69 {"discard", 0, POPT_ARG_NONE
, 0, OPT_DISCARD
, 0, 0},
70 {"overwrite", 0, POPT_ARG_NONE
, 0, OPT_OVERWRITE
, 0, 0},
71 {"subbuf-size", 0, POPT_ARG_DOUBLE
, 0, OPT_SUBBUF_SIZE
, 0, 0},
72 {"num-subbuf", 0, POPT_ARG_INT
, 0, OPT_NUM_SUBBUF
, 0, 0},
73 {"switch-timer", 0, POPT_ARG_INT
, 0, OPT_SWITCH_TIMER
, 0, 0},
74 {"read-timer", 0, POPT_ARG_INT
, 0, OPT_READ_TIMER
, 0, 0},
75 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
82 static void usage(FILE *ofp
)
84 fprintf(ofp
, "usage: lttng enable-channel NAME[,NAME2,...] [-u|-k] [OPTIONS]\n");
86 fprintf(ofp
, "Options:\n");
87 fprintf(ofp
, " -h, --help Show this help\n");
88 fprintf(ofp
, " --list-options Simple listing of options\n");
89 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
90 fprintf(ofp
, " -k, --kernel Apply to the kernel tracer\n");
91 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
93 fprintf(ofp
, "Channel options:\n");
94 fprintf(ofp
, " --discard Discard event when buffers are full%s\n",
95 DEFAULT_CHANNEL_OVERWRITE
? "" : " (default)");
96 fprintf(ofp
, " --overwrite Flight recorder mode%s\n",
97 DEFAULT_CHANNEL_OVERWRITE
? " (default)" : "");
98 fprintf(ofp
, " --subbuf-size SIZE Subbuffer size in bytes\n");
99 fprintf(ofp
, " (default: %u, kernel default: %u)\n",
100 DEFAULT_CHANNEL_SUBBUF_SIZE
,
101 DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE
);
102 fprintf(ofp
, " Needs to be a power of 2 for\n");
103 fprintf(ofp
, " kernel and ust tracers\n");
104 fprintf(ofp
, " --num-subbuf NUM Number of subbufers\n");
105 fprintf(ofp
, " (default: %u)\n",
106 DEFAULT_CHANNEL_SUBBUF_NUM
);
107 fprintf(ofp
, " Needs to be a power of 2 for\n");
108 fprintf(ofp
, " kernel and ust tracers\n");
109 fprintf(ofp
, " --switch-timer USEC Switch timer interval in usec (default: %u)\n",
110 DEFAULT_CHANNEL_SWITCH_TIMER
);
111 fprintf(ofp
, " --read-timer USEC Read timer interval in usec (default: %u)\n",
112 DEFAULT_CHANNEL_READ_TIMER
);
117 * Set default attributes depending on those already defined from the command
120 static void set_default_attr(struct lttng_domain
*dom
)
122 struct lttng_channel_attr default_attr
;
125 lttng_channel_set_default_attr(dom
, &default_attr
);
127 if (chan
.attr
.overwrite
== -1) {
128 chan
.attr
.overwrite
= default_attr
.overwrite
;
130 if (chan
.attr
.subbuf_size
== -1) {
131 chan
.attr
.subbuf_size
= default_attr
.subbuf_size
;
133 if (chan
.attr
.num_subbuf
== -1) {
134 chan
.attr
.num_subbuf
= default_attr
.num_subbuf
;
136 if (chan
.attr
.switch_timer_interval
== -1) {
137 chan
.attr
.switch_timer_interval
= default_attr
.switch_timer_interval
;
139 if (chan
.attr
.read_timer_interval
== -1) {
140 chan
.attr
.read_timer_interval
= default_attr
.read_timer_interval
;
142 if (chan
.attr
.output
== -1) {
143 chan
.attr
.output
= default_attr
.output
;
148 * Adding channel using the lttng API.
150 static int enable_channel(char *session_name
)
152 int ret
= CMD_SUCCESS
, warn
= 0;
154 struct lttng_domain dom
;
156 memset(&dom
, 0, sizeof(dom
));
158 /* Create lttng domain */
160 dom
.type
= LTTNG_DOMAIN_KERNEL
;
161 } else if (opt_userspace
) {
162 dom
.type
= LTTNG_DOMAIN_UST
;
164 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
169 set_default_attr(&dom
);
171 handle
= lttng_create_handle(session_name
, &dom
);
172 if (handle
== NULL
) {
177 /* Strip channel list (format: chan1,chan2,...) */
178 channel_name
= strtok(opt_channels
, ",");
179 while (channel_name
!= NULL
) {
180 /* Copy channel name and normalize it */
181 strncpy(chan
.name
, channel_name
, NAME_MAX
);
182 chan
.name
[NAME_MAX
- 1] = '\0';
184 DBG("Enabling channel %s", channel_name
);
186 ret
= lttng_enable_channel(handle
, &chan
);
189 case LTTNG_ERR_KERN_CHAN_EXIST
:
190 case LTTNG_ERR_UST_CHAN_EXIST
:
191 WARN("Channel %s: %s (session %s", channel_name
,
192 lttng_strerror(ret
), session_name
);
195 ERR("Channel %s: %s (session %s)", channel_name
,
196 lttng_strerror(ret
), session_name
);
201 MSG("%s channel %s enabled for session %s",
202 opt_kernel
? "Kernel" : "UST", channel_name
,
207 channel_name
= strtok(NULL
, ",");
217 lttng_destroy_handle(handle
);
223 * Default value for channel configuration.
225 static void init_channel_config(void)
228 * Put -1 everywhere so we can identify those set by the command line and
229 * those needed to be set by the default values.
231 memset(&chan
.attr
, -1, sizeof(chan
.attr
));
235 * Add channel to trace session
237 int cmd_enable_channels(int argc
, const char **argv
)
239 int opt
, ret
= CMD_SUCCESS
;
240 static poptContext pc
;
241 char *session_name
= NULL
;
243 init_channel_config();
245 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
246 poptReadDefaultConfig(pc
, 0);
248 while ((opt
= poptGetNextOpt(pc
)) != -1) {
254 chan
.attr
.overwrite
= 0;
255 DBG("Channel set to discard");
258 chan
.attr
.overwrite
= 1;
259 DBG("Channel set to overwrite");
261 case OPT_SUBBUF_SIZE
:
262 /* TODO Replace atol with strtol and check for errors */
263 chan
.attr
.subbuf_size
= atol(poptGetOptArg(pc
));
264 DBG("Channel subbuf size set to %" PRIu64
, chan
.attr
.subbuf_size
);
267 /* TODO Replace atoi with strtol and check for errors */
268 chan
.attr
.num_subbuf
= atoi(poptGetOptArg(pc
));
269 DBG("Channel subbuf num set to %" PRIu64
, chan
.attr
.num_subbuf
);
271 case OPT_SWITCH_TIMER
:
272 /* TODO Replace atoi with strtol and check for errors */
273 chan
.attr
.switch_timer_interval
= atoi(poptGetOptArg(pc
));
274 DBG("Channel switch timer interval set to %d", chan
.attr
.switch_timer_interval
);
277 /* TODO Replace atoi with strtol and check for errors */
278 chan
.attr
.read_timer_interval
= atoi(poptGetOptArg(pc
));
279 DBG("Channel read timer interval set to %d", chan
.attr
.read_timer_interval
);
284 case OPT_LIST_OPTIONS
:
285 list_cmd_options(stdout
, long_options
);
294 opt_channels
= (char*) poptGetArg(pc
);
295 if (opt_channels
== NULL
) {
296 ERR("Missing channel name.\n");
302 if (!opt_session_name
) {
303 session_name
= get_session_name();
304 if (session_name
== NULL
) {
309 session_name
= opt_session_name
;
312 ret
= enable_channel(session_name
);
315 if (!opt_session_name
&& session_name
) {