Fix: documented number of subbuffers is incorrect
[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)\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, "\n");
119 }
120
121 /*
122 * Set default attributes depending on those already defined from the command
123 * line.
124 */
125 static void set_default_attr(struct lttng_domain *dom)
126 {
127 struct lttng_channel_attr default_attr;
128
129 /* Set attributes */
130 lttng_channel_set_default_attr(dom, &default_attr);
131
132 if (chan.attr.overwrite == -1) {
133 chan.attr.overwrite = default_attr.overwrite;
134 }
135 if (chan.attr.subbuf_size == -1) {
136 chan.attr.subbuf_size = default_attr.subbuf_size;
137 }
138 if (chan.attr.num_subbuf == -1) {
139 chan.attr.num_subbuf = default_attr.num_subbuf;
140 }
141 if (chan.attr.switch_timer_interval == -1) {
142 chan.attr.switch_timer_interval = default_attr.switch_timer_interval;
143 }
144 if (chan.attr.read_timer_interval == -1) {
145 chan.attr.read_timer_interval = default_attr.read_timer_interval;
146 }
147 if (chan.attr.output == -1) {
148 chan.attr.output = default_attr.output;
149 }
150 }
151
152 /*
153 * Adding channel using the lttng API.
154 */
155 static int enable_channel(char *session_name)
156 {
157 int ret = CMD_SUCCESS, warn = 0;
158 char *channel_name;
159 struct lttng_domain dom;
160
161 memset(&dom, 0, sizeof(dom));
162
163 /* Create lttng domain */
164 if (opt_kernel) {
165 dom.type = LTTNG_DOMAIN_KERNEL;
166 } else if (opt_userspace) {
167 dom.type = LTTNG_DOMAIN_UST;
168 } else {
169 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
170 ret = CMD_ERROR;
171 goto error;
172 }
173
174 set_default_attr(&dom);
175
176 handle = lttng_create_handle(session_name, &dom);
177 if (handle == NULL) {
178 ret = -1;
179 goto error;
180 }
181
182 /* Strip channel list (format: chan1,chan2,...) */
183 channel_name = strtok(opt_channels, ",");
184 while (channel_name != NULL) {
185 /* Copy channel name and normalize it */
186 strncpy(chan.name, channel_name, NAME_MAX);
187 chan.name[NAME_MAX - 1] = '\0';
188
189 DBG("Enabling channel %s", channel_name);
190
191 ret = lttng_enable_channel(handle, &chan);
192 if (ret < 0) {
193 ERR("Channel %s: %s (session %s)", channel_name,
194 lttng_strerror(ret), session_name);
195 warn = 1;
196 } else {
197 MSG("%s channel %s enabled for session %s",
198 opt_kernel ? "Kernel" : "UST", channel_name,
199 session_name);
200 }
201
202 /* Next event */
203 channel_name = strtok(NULL, ",");
204 }
205
206 ret = CMD_SUCCESS;
207
208 error:
209 if (warn) {
210 ret = CMD_WARNING;
211 }
212
213 lttng_destroy_handle(handle);
214
215 return ret;
216 }
217
218 /*
219 * Default value for channel configuration.
220 */
221 static void init_channel_config(void)
222 {
223 /*
224 * Put -1 everywhere so we can identify those set by the command line and
225 * those needed to be set by the default values.
226 */
227 memset(&chan.attr, -1, sizeof(chan.attr));
228 }
229
230 /*
231 * Add channel to trace session
232 */
233 int cmd_enable_channels(int argc, const char **argv)
234 {
235 int opt, ret = CMD_SUCCESS;
236 static poptContext pc;
237 char *session_name = NULL;
238
239 init_channel_config();
240
241 pc = poptGetContext(NULL, argc, argv, long_options, 0);
242 poptReadDefaultConfig(pc, 0);
243
244 while ((opt = poptGetNextOpt(pc)) != -1) {
245 switch (opt) {
246 case OPT_HELP:
247 usage(stdout);
248 goto end;
249 case OPT_DISCARD:
250 chan.attr.overwrite = 0;
251 DBG("Channel set to discard");
252 break;
253 case OPT_OVERWRITE:
254 chan.attr.overwrite = 1;
255 DBG("Channel set to overwrite");
256 break;
257 case OPT_SUBBUF_SIZE:
258 /* TODO Replace atol with strtol and check for errors */
259 chan.attr.subbuf_size = atol(poptGetOptArg(pc));
260 DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
261 break;
262 case OPT_NUM_SUBBUF:
263 /* TODO Replace atoi with strtol and check for errors */
264 chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
265 DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
266 break;
267 case OPT_SWITCH_TIMER:
268 /* TODO Replace atoi with strtol and check for errors */
269 chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
270 DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
271 break;
272 case OPT_READ_TIMER:
273 /* TODO Replace atoi with strtol and check for errors */
274 chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
275 DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
276 break;
277 case OPT_USERSPACE:
278 opt_userspace = 1;
279 break;
280 case OPT_LIST_OPTIONS:
281 list_cmd_options(stdout, long_options);
282 goto end;
283 default:
284 usage(stderr);
285 ret = CMD_UNDEFINED;
286 goto end;
287 }
288 }
289
290 opt_channels = (char*) poptGetArg(pc);
291 if (opt_channels == NULL) {
292 ERR("Missing channel name.\n");
293 usage(stderr);
294 ret = CMD_ERROR;
295 goto end;
296 }
297
298 if (!opt_session_name) {
299 session_name = get_session_name();
300 if (session_name == NULL) {
301 ret = CMD_ERROR;
302 goto end;
303 }
304 } else {
305 session_name = opt_session_name;
306 }
307
308 ret = enable_channel(session_name);
309
310 end:
311 if (!opt_session_name && session_name) {
312 free(session_name);
313 }
314 poptFreeContext(pc);
315 return ret;
316 }
This page took 0.060213 seconds and 4 git commands to generate.