Fix: validate buffer type for UST channel creation
[lttng-tools.git] / src / bin / lttng / commands / enable_channels.c
CommitLineData
d36b8583
DG
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
d14d33bf
AM
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.
d36b8583
DG
7 *
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.
12 *
d14d33bf
AM
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.
d36b8583
DG
16 */
17
18#define _GNU_SOURCE
19#include <popt.h>
20#include <stdio.h>
21#include <stdlib.h>
22#include <string.h>
23#include <sys/stat.h>
24#include <sys/types.h>
25#include <unistd.h>
5a0de755 26#include <inttypes.h>
d36b8583 27
c399183f 28#include "../command.h"
d36b8583 29
42224349
DG
30#include <src/common/sessiond-comm/sessiond-comm.h>
31
d36b8583 32static char *opt_channels;
5edd7e09 33static int opt_kernel;
5440dc42 34static char *opt_session_name;
d36b8583 35static int opt_userspace;
d78d6610 36static struct lttng_channel chan;
a79d84dd 37static char *opt_output;
7972aab2
DG
38static int opt_buffer_uid;
39static int opt_buffer_pid;
40static int opt_buffer_global;
d36b8583
DG
41
42enum {
43 OPT_HELP = 1,
7d29a247
DG
44 OPT_DISCARD,
45 OPT_OVERWRITE,
46 OPT_SUBBUF_SIZE,
47 OPT_NUM_SUBBUF,
48 OPT_SWITCH_TIMER,
49 OPT_READ_TIMER,
d36b8583 50 OPT_USERSPACE,
679b4943 51 OPT_LIST_OPTIONS,
1624d5b7
JD
52 OPT_TRACEFILE_SIZE,
53 OPT_TRACEFILE_COUNT,
d36b8583
DG
54};
55
cd80958d
DG
56static struct lttng_handle *handle;
57
a79d84dd
DG
58const char *output_mmap = "mmap";
59const char *output_splice = "splice";
60
d36b8583
DG
61static struct poptOption long_options[] = {
62 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
63 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42 64 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
d36b8583 65 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610 66 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
7d29a247
DG
67 {"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
68 {"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
1b579521
DG
69 {"subbuf-size", 0, POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0},
70 {"num-subbuf", 0, POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
71 {"switch-timer", 0, POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
72 {"read-timer", 0, POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
679b4943 73 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
a79d84dd 74 {"output", 0, POPT_ARG_STRING, &opt_output, 0, 0, 0},
7972aab2
DG
75 {"buffers-uid", 0, POPT_ARG_VAL, &opt_buffer_uid, 1, 0, 0},
76 {"buffers-pid", 0, POPT_ARG_VAL, &opt_buffer_pid, 1, 0, 0},
77 {"buffers-global", 0, POPT_ARG_VAL, &opt_buffer_global, 1, 0, 0},
1624d5b7
JD
78 {"tracefile-size", 'C', POPT_ARG_INT, 0, OPT_TRACEFILE_SIZE, 0, 0},
79 {"tracefile-count", 'W', POPT_ARG_INT, 0, OPT_TRACEFILE_COUNT, 0, 0},
d36b8583
DG
80 {0, 0, 0, 0, 0, 0, 0}
81};
82
83/*
84 * usage
85 */
86static void usage(FILE *ofp)
87{
32a6298d 88 fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [-u|-k] [OPTIONS]\n");
d36b8583 89 fprintf(ofp, "\n");
32a6298d 90 fprintf(ofp, "Options:\n");
7d29a247 91 fprintf(ofp, " -h, --help Show this help\n");
679b4943 92 fprintf(ofp, " --list-options Simple listing of options\n");
32a6298d 93 fprintf(ofp, " -s, --session NAME Apply to session name\n");
27221701 94 fprintf(ofp, " -k, --kernel Apply to the kernel tracer\n");
27221701 95 fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
7d29a247
DG
96 fprintf(ofp, "\n");
97 fprintf(ofp, "Channel options:\n");
cabd9892
MD
98 fprintf(ofp, " --discard Discard event when buffers are full%s\n",
99 DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)");
100 fprintf(ofp, " --overwrite Flight recorder mode%s\n",
101 DEFAULT_CHANNEL_OVERWRITE ? " (default)" : "");
cc62c0c0 102 fprintf(ofp, " --subbuf-size SIZE Subbuffer size in bytes\n");
3e230f92
SM
103 fprintf(ofp, " (default: %zu, kernel default: %zu)\n",
104 default_get_channel_subbuf_size(),
105 default_get_kernel_channel_subbuf_size());
93e6c8a0
MD
106 fprintf(ofp, " Needs to be a power of 2 for\n");
107 fprintf(ofp, " kernel and ust tracers\n");
cc62c0c0 108 fprintf(ofp, " --num-subbuf NUM Number of subbufers\n");
9f778c9a
MD
109 fprintf(ofp, " (default: %u)\n",
110 DEFAULT_CHANNEL_SUBBUF_NUM);
93e6c8a0
MD
111 fprintf(ofp, " Needs to be a power of 2 for\n");
112 fprintf(ofp, " kernel and ust tracers\n");
cc62c0c0 113 fprintf(ofp, " --switch-timer USEC Switch timer interval in usec (default: %u)\n",
cabd9892 114 DEFAULT_CHANNEL_SWITCH_TIMER);
cc62c0c0 115 fprintf(ofp, " --read-timer USEC Read timer interval in usec (default: %u)\n",
cabd9892 116 DEFAULT_CHANNEL_READ_TIMER);
a79d84dd
DG
117 fprintf(ofp, " --output TYPE Channel output type (Values: %s, %s)\n",
118 output_mmap, output_splice);
7972aab2
DG
119 fprintf(ofp, " --buffers-uid Use per UID buffer (-u only)\n");
120 fprintf(ofp, " --buffers-pid Use per PID buffer (-u only)\n");
121 fprintf(ofp, " --buffers-global Use shared buffer for the whole system (-k only)\n");
1624d5b7
JD
122 fprintf(ofp, " -C, --tracefile-size SIZE\n");
123 fprintf(ofp, " Maximum size of of each tracefile within a stream (in bytes).\n");
124 fprintf(ofp, " -W, --tracefile-count COUNT\n");
125 fprintf(ofp, " Used in conjunction with -C option, this will limit the number\n");
126 fprintf(ofp, " of files created to the specified count.\n");
d36b8583
DG
127 fprintf(ofp, "\n");
128}
129
5edd7e09
DG
130/*
131 * Set default attributes depending on those already defined from the command
132 * line.
133 */
134static void set_default_attr(struct lttng_domain *dom)
135{
136 struct lttng_channel_attr default_attr;
137
138 /* Set attributes */
139 lttng_channel_set_default_attr(dom, &default_attr);
140
141 if (chan.attr.overwrite == -1) {
142 chan.attr.overwrite = default_attr.overwrite;
143 }
144 if (chan.attr.subbuf_size == -1) {
145 chan.attr.subbuf_size = default_attr.subbuf_size;
146 }
147 if (chan.attr.num_subbuf == -1) {
148 chan.attr.num_subbuf = default_attr.num_subbuf;
149 }
150 if (chan.attr.switch_timer_interval == -1) {
151 chan.attr.switch_timer_interval = default_attr.switch_timer_interval;
152 }
153 if (chan.attr.read_timer_interval == -1) {
154 chan.attr.read_timer_interval = default_attr.read_timer_interval;
155 }
156 if (chan.attr.output == -1) {
157 chan.attr.output = default_attr.output;
158 }
1624d5b7
JD
159 if (chan.attr.tracefile_count == -1) {
160 chan.attr.tracefile_count = default_attr.tracefile_count;
161 }
162 if (chan.attr.tracefile_size == -1) {
163 chan.attr.tracefile_size = default_attr.tracefile_size;
164 }
5edd7e09
DG
165}
166
d36b8583 167/*
0fdd1e2c 168 * Adding channel using the lttng API.
d36b8583 169 */
cd80958d 170static int enable_channel(char *session_name)
d36b8583 171{
ae856491 172 int ret = CMD_SUCCESS, warn = 0;
d36b8583 173 char *channel_name;
7d29a247 174 struct lttng_domain dom;
d36b8583 175
441c16a7
MD
176 memset(&dom, 0, sizeof(dom));
177
d78d6610 178 /* Create lttng domain */
7d29a247
DG
179 if (opt_kernel) {
180 dom.type = LTTNG_DOMAIN_KERNEL;
7972aab2 181 dom.buf_type = LTTNG_BUFFER_GLOBAL;
d78d6610 182 } else if (opt_userspace) {
f6a9efaa 183 dom.type = LTTNG_DOMAIN_UST;
7972aab2
DG
184 if (opt_buffer_uid) {
185 dom.buf_type = LTTNG_BUFFER_PER_UID;
186 } else {
187 dom.buf_type = LTTNG_BUFFER_PER_PID;
188 }
0fdd1e2c 189 } else {
e14f64a8 190 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
d16c1a4c 191 ret = CMD_ERROR;
0fdd1e2c 192 goto error;
7d29a247
DG
193 }
194
5edd7e09
DG
195 set_default_attr(&dom);
196
1624d5b7
JD
197 if ((chan.attr.tracefile_size > 0) &&
198 (chan.attr.tracefile_size < chan.attr.subbuf_size)) {
199 ERR("Tracefile_size must be greater than or equal to subbuf_size "
200 "(%" PRIu64 " < %" PRIu64 ")",
201 chan.attr.tracefile_size, chan.attr.subbuf_size);
202 ret = CMD_ERROR;
203 goto error;
204 }
205
a79d84dd
DG
206 /* Setting channel output */
207 if (opt_output) {
208 if (!strncmp(output_mmap, opt_output, strlen(output_mmap))) {
209 chan.attr.output = LTTNG_EVENT_MMAP;
210 } else if (!strncmp(output_splice, opt_output, strlen(output_splice))) {
211 chan.attr.output = LTTNG_EVENT_SPLICE;
212 } else {
213 ERR("Unknown output type %s. Possible values are: %s, %s\n",
214 opt_output, output_mmap, output_splice);
215 usage(stderr);
216 ret = CMD_ERROR;
217 goto error;
218 }
219 }
220
cd80958d
DG
221 handle = lttng_create_handle(session_name, &dom);
222 if (handle == NULL) {
223 ret = -1;
224 goto error;
225 }
226
0fdd1e2c 227 /* Strip channel list (format: chan1,chan2,...) */
d36b8583
DG
228 channel_name = strtok(opt_channels, ",");
229 while (channel_name != NULL) {
0fdd1e2c
DG
230 /* Copy channel name and normalize it */
231 strncpy(chan.name, channel_name, NAME_MAX);
232 chan.name[NAME_MAX - 1] = '\0';
233
234 DBG("Enabling channel %s", channel_name);
235
236 ret = lttng_enable_channel(handle, &chan);
237 if (ret < 0) {
42224349 238 switch (-ret) {
f73fabfd
DG
239 case LTTNG_ERR_KERN_CHAN_EXIST:
240 case LTTNG_ERR_UST_CHAN_EXIST:
42224349
DG
241 WARN("Channel %s: %s (session %s", channel_name,
242 lttng_strerror(ret), session_name);
243 goto error;
244 default:
245 ERR("Channel %s: %s (session %s)", channel_name,
246 lttng_strerror(ret), session_name);
247 break;
248 }
ae856491 249 warn = 1;
d36b8583 250 } else {
7885e399
DG
251 MSG("%s channel %s enabled for session %s",
252 opt_kernel ? "Kernel" : "UST", channel_name,
253 session_name);
d36b8583
DG
254 }
255
256 /* Next event */
257 channel_name = strtok(NULL, ",");
258 }
259
ae856491
DG
260 ret = CMD_SUCCESS;
261
d36b8583 262error:
ae856491
DG
263 if (warn) {
264 ret = CMD_WARNING;
265 }
266
cd80958d
DG
267 lttng_destroy_handle(handle);
268
d36b8583
DG
269 return ret;
270}
271
272/*
0fdd1e2c 273 * Default value for channel configuration.
7d29a247
DG
274 */
275static void init_channel_config(void)
276{
5edd7e09
DG
277 /*
278 * Put -1 everywhere so we can identify those set by the command line and
279 * those needed to be set by the default values.
280 */
281 memset(&chan.attr, -1, sizeof(chan.attr));
7d29a247
DG
282}
283
284/*
0fdd1e2c 285 * Add channel to trace session
d36b8583
DG
286 */
287int cmd_enable_channels(int argc, const char **argv)
288{
ca1c3607 289 int opt, ret = CMD_SUCCESS;
d36b8583 290 static poptContext pc;
cd80958d 291 char *session_name = NULL;
d36b8583 292
7d29a247
DG
293 init_channel_config();
294
d36b8583
DG
295 pc = poptGetContext(NULL, argc, argv, long_options, 0);
296 poptReadDefaultConfig(pc, 0);
297
298 while ((opt = poptGetNextOpt(pc)) != -1) {
299 switch (opt) {
300 case OPT_HELP:
ca1c3607 301 usage(stdout);
d36b8583 302 goto end;
7d29a247
DG
303 case OPT_DISCARD:
304 chan.attr.overwrite = 0;
305 DBG("Channel set to discard");
306 break;
307 case OPT_OVERWRITE:
308 chan.attr.overwrite = 1;
309 DBG("Channel set to overwrite");
310 break;
311 case OPT_SUBBUF_SIZE:
ca1c3607 312 /* TODO Replace atol with strtol and check for errors */
7d29a247 313 chan.attr.subbuf_size = atol(poptGetOptArg(pc));
5a0de755 314 DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
7d29a247
DG
315 break;
316 case OPT_NUM_SUBBUF:
ca1c3607 317 /* TODO Replace atoi with strtol and check for errors */
7d29a247 318 chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
5a0de755 319 DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
7d29a247
DG
320 break;
321 case OPT_SWITCH_TIMER:
ca1c3607 322 /* TODO Replace atoi with strtol and check for errors */
7d29a247
DG
323 chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
324 DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
325 break;
326 case OPT_READ_TIMER:
ca1c3607 327 /* TODO Replace atoi with strtol and check for errors */
7d29a247
DG
328 chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
329 DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
d36b8583 330 break;
eeac7d46
MD
331 case OPT_USERSPACE:
332 opt_userspace = 1;
eeac7d46 333 break;
1624d5b7
JD
334 case OPT_TRACEFILE_SIZE:
335 chan.attr.tracefile_size = atoll(poptGetOptArg(pc));
336 DBG("Maximum tracefile size set to %" PRIu64,
337 chan.attr.tracefile_size);
338 break;
339 case OPT_TRACEFILE_COUNT:
340 chan.attr.tracefile_count = atoll(poptGetOptArg(pc));
341 DBG("Maximum tracefile count set to %" PRIu64,
342 chan.attr.tracefile_count);
343 break;
679b4943
SM
344 case OPT_LIST_OPTIONS:
345 list_cmd_options(stdout, long_options);
679b4943 346 goto end;
d36b8583
DG
347 default:
348 usage(stderr);
349 ret = CMD_UNDEFINED;
350 goto end;
351 }
352 }
353
354 opt_channels = (char*) poptGetArg(pc);
355 if (opt_channels == NULL) {
7d29a247 356 ERR("Missing channel name.\n");
d36b8583 357 usage(stderr);
ca1c3607 358 ret = CMD_ERROR;
d36b8583
DG
359 goto end;
360 }
361
cd80958d
DG
362 if (!opt_session_name) {
363 session_name = get_session_name();
364 if (session_name == NULL) {
ca1c3607 365 ret = CMD_ERROR;
cd80958d
DG
366 goto end;
367 }
368 } else {
369 session_name = opt_session_name;
370 }
371
372 ret = enable_channel(session_name);
d36b8583
DG
373
374end:
5853fd43
DG
375 if (!opt_session_name && session_name) {
376 free(session_name);
377 }
ca1c3607 378 poptFreeContext(pc);
d36b8583
DG
379 return ret;
380}
This page took 0.054491 seconds and 5 git commands to generate.