4e56b3ca5f38b2ad87dec90291a8dc9438d9f3f2
[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
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; only version 2
7 * of the License.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 */
18
19 #define _GNU_SOURCE
20 #include <popt.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <sys/stat.h>
25 #include <sys/types.h>
26 #include <unistd.h>
27 #include <inttypes.h>
28
29 #include "../command.h"
30
31 static char *opt_channels;
32 static int opt_kernel;
33 static char *opt_session_name;
34 static int opt_userspace;
35 static struct lttng_channel chan;
36 #if 0
37 /* Not implemented yet */
38 static char *opt_cmd_name;
39 static pid_t opt_pid;
40 #endif
41
42 enum {
43 OPT_HELP = 1,
44 OPT_DISCARD,
45 OPT_OVERWRITE,
46 OPT_SUBBUF_SIZE,
47 OPT_NUM_SUBBUF,
48 OPT_SWITCH_TIMER,
49 OPT_READ_TIMER,
50 OPT_USERSPACE,
51 OPT_LIST_OPTIONS,
52 };
53
54 static struct lttng_handle *handle;
55
56 static struct poptOption long_options[] = {
57 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
58 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
59 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
60 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
61 #if 0
62 /* Not implemented yet */
63 {"userspace", 'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
64 {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
65 #else
66 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
67 #endif
68 {"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
69 {"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
70 {"subbuf-size", 0, POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0},
71 {"num-subbuf", 0, POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
72 {"switch-timer", 0, POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
73 {"read-timer", 0, POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
74 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
75 {0, 0, 0, 0, 0, 0, 0}
76 };
77
78 /*
79 * usage
80 */
81 static void usage(FILE *ofp)
82 {
83 fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [options] [channel_options]\n");
84 fprintf(ofp, "\n");
85 fprintf(ofp, " -h, --help Show this help\n");
86 fprintf(ofp, " --list-options Simple listing of options\n");
87 fprintf(ofp, " -s, --session Apply to session name\n");
88 fprintf(ofp, " -k, --kernel Apply to the kernel tracer\n");
89 #if 0
90 fprintf(ofp, " -u, --userspace [CMD] Apply to the user-space tracer\n");
91 fprintf(ofp, " If no CMD, the domain used is UST global\n");
92 fprintf(ofp, " or else the domain is UST EXEC_NAME\n");
93 fprintf(ofp, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n");
94 #else
95 fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
96 #endif
97 fprintf(ofp, "\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, kernel default: %u)\n",
111 DEFAULT_CHANNEL_SUBBUF_NUM,
112 DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM);
113 fprintf(ofp, " Needs to be a power of 2 for\n");
114 fprintf(ofp, " kernel and ust tracers\n");
115 fprintf(ofp, " --switch-timer USEC Switch timer interval in usec (default: %u)\n",
116 DEFAULT_CHANNEL_SWITCH_TIMER);
117 fprintf(ofp, " --read-timer USEC Read timer interval in usec (default: %u)\n",
118 DEFAULT_CHANNEL_READ_TIMER);
119 fprintf(ofp, "\n");
120 }
121
122 /*
123 * Set default attributes depending on those already defined from the command
124 * line.
125 */
126 static void set_default_attr(struct lttng_domain *dom)
127 {
128 struct lttng_channel_attr default_attr;
129
130 /* Set attributes */
131 lttng_channel_set_default_attr(dom, &default_attr);
132
133 if (chan.attr.overwrite == -1) {
134 chan.attr.overwrite = default_attr.overwrite;
135 }
136 if (chan.attr.subbuf_size == -1) {
137 chan.attr.subbuf_size = default_attr.subbuf_size;
138 }
139 if (chan.attr.num_subbuf == -1) {
140 chan.attr.num_subbuf = default_attr.num_subbuf;
141 }
142 if (chan.attr.switch_timer_interval == -1) {
143 chan.attr.switch_timer_interval = default_attr.switch_timer_interval;
144 }
145 if (chan.attr.read_timer_interval == -1) {
146 chan.attr.read_timer_interval = default_attr.read_timer_interval;
147 }
148 if (chan.attr.output == -1) {
149 chan.attr.output = default_attr.output;
150 }
151 }
152
153 /*
154 * Adding channel using the lttng API.
155 */
156 static int enable_channel(char *session_name)
157 {
158 int ret = CMD_SUCCESS, warn = 0;
159 char *channel_name;
160 struct lttng_domain dom;
161
162 memset(&dom, 0, sizeof(dom));
163
164 /* Create lttng domain */
165 if (opt_kernel) {
166 dom.type = LTTNG_DOMAIN_KERNEL;
167 } else if (opt_userspace) {
168 dom.type = LTTNG_DOMAIN_UST;
169 } else {
170 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
171 ret = CMD_ERROR;
172 goto error;
173 }
174
175 set_default_attr(&dom);
176
177 handle = lttng_create_handle(session_name, &dom);
178 if (handle == NULL) {
179 ret = -1;
180 goto error;
181 }
182
183 /* Strip channel list (format: chan1,chan2,...) */
184 channel_name = strtok(opt_channels, ",");
185 while (channel_name != NULL) {
186 /* Copy channel name and normalize it */
187 strncpy(chan.name, channel_name, NAME_MAX);
188 chan.name[NAME_MAX - 1] = '\0';
189
190 DBG("Enabling channel %s", channel_name);
191
192 ret = lttng_enable_channel(handle, &chan);
193 if (ret < 0) {
194 ERR("Channel %s: %s (session %s)", channel_name,
195 lttng_strerror(ret), session_name);
196 warn = 1;
197 } else {
198 MSG("%s channel %s enabled for session %s",
199 opt_kernel ? "Kernel" : "UST", channel_name,
200 session_name);
201 }
202
203 /* Next event */
204 channel_name = strtok(NULL, ",");
205 }
206
207 ret = CMD_SUCCESS;
208
209 error:
210 if (warn) {
211 ret = CMD_WARNING;
212 }
213
214 lttng_destroy_handle(handle);
215
216 return ret;
217 }
218
219 /*
220 * Default value for channel configuration.
221 */
222 static void init_channel_config(void)
223 {
224 /*
225 * Put -1 everywhere so we can identify those set by the command line and
226 * those needed to be set by the default values.
227 */
228 memset(&chan.attr, -1, sizeof(chan.attr));
229 }
230
231 /*
232 * Add channel to trace session
233 */
234 int cmd_enable_channels(int argc, const char **argv)
235 {
236 int opt, ret = CMD_SUCCESS;
237 static poptContext pc;
238 char *session_name = NULL;
239
240 init_channel_config();
241
242 pc = poptGetContext(NULL, argc, argv, long_options, 0);
243 poptReadDefaultConfig(pc, 0);
244
245 while ((opt = poptGetNextOpt(pc)) != -1) {
246 switch (opt) {
247 case OPT_HELP:
248 usage(stdout);
249 goto end;
250 case OPT_DISCARD:
251 chan.attr.overwrite = 0;
252 DBG("Channel set to discard");
253 break;
254 case OPT_OVERWRITE:
255 chan.attr.overwrite = 1;
256 DBG("Channel set to overwrite");
257 break;
258 case OPT_SUBBUF_SIZE:
259 /* TODO Replace atol with strtol and check for errors */
260 chan.attr.subbuf_size = atol(poptGetOptArg(pc));
261 DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
262 break;
263 case OPT_NUM_SUBBUF:
264 /* TODO Replace atoi with strtol and check for errors */
265 chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
266 DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
267 break;
268 case OPT_SWITCH_TIMER:
269 /* TODO Replace atoi with strtol and check for errors */
270 chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
271 DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
272 break;
273 case OPT_READ_TIMER:
274 /* TODO Replace atoi with strtol and check for errors */
275 chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
276 DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
277 break;
278 case OPT_USERSPACE:
279 opt_userspace = 1;
280 break;
281 case OPT_LIST_OPTIONS:
282 list_cmd_options(stdout, long_options);
283 goto end;
284 default:
285 usage(stderr);
286 ret = CMD_UNDEFINED;
287 goto end;
288 }
289 }
290
291 opt_channels = (char*) poptGetArg(pc);
292 if (opt_channels == NULL) {
293 ERR("Missing channel name.\n");
294 usage(stderr);
295 ret = CMD_ERROR;
296 goto end;
297 }
298
299 if (!opt_session_name) {
300 session_name = get_session_name();
301 if (session_name == NULL) {
302 ret = CMD_ERROR;
303 goto end;
304 }
305 } else {
306 session_name = opt_session_name;
307 }
308
309 ret = enable_channel(session_name);
310
311 end:
312 if (!opt_session_name && session_name) {
313 free(session_name);
314 }
315 poptFreeContext(pc);
316 return ret;
317 }
This page took 0.055448 seconds and 3 git commands to generate.