Add lttng-error.h containing every API err. code
[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
DG
36static struct lttng_channel chan;
37#if 0
38/* Not implemented yet */
eeac7d46 39static char *opt_cmd_name;
d36b8583 40static pid_t opt_pid;
d78d6610 41#endif
d36b8583
DG
42
43enum {
44 OPT_HELP = 1,
7d29a247
DG
45 OPT_DISCARD,
46 OPT_OVERWRITE,
47 OPT_SUBBUF_SIZE,
48 OPT_NUM_SUBBUF,
49 OPT_SWITCH_TIMER,
50 OPT_READ_TIMER,
d36b8583 51 OPT_USERSPACE,
679b4943 52 OPT_LIST_OPTIONS,
d36b8583
DG
53};
54
cd80958d
DG
55static struct lttng_handle *handle;
56
d36b8583
DG
57static struct poptOption long_options[] = {
58 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
59 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42 60 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
d36b8583 61 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610
DG
62#if 0
63 /* Not implemented yet */
6caa2bcc 64 {"userspace", 'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
d36b8583 65 {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
d78d6610
DG
66#else
67 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
68#endif
7d29a247
DG
69 {"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
70 {"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
1b579521
DG
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},
679b4943 75 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
d36b8583
DG
76 {0, 0, 0, 0, 0, 0, 0}
77};
78
79/*
80 * usage
81 */
82static void usage(FILE *ofp)
83{
32a6298d 84 fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [-u|-k] [OPTIONS]\n");
d36b8583 85 fprintf(ofp, "\n");
32a6298d 86 fprintf(ofp, "Options:\n");
7d29a247 87 fprintf(ofp, " -h, --help Show this help\n");
679b4943 88 fprintf(ofp, " --list-options Simple listing of options\n");
32a6298d 89 fprintf(ofp, " -s, --session NAME Apply to session name\n");
27221701 90 fprintf(ofp, " -k, --kernel Apply to the kernel tracer\n");
27221701 91 fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
7d29a247
DG
92 fprintf(ofp, "\n");
93 fprintf(ofp, "Channel options:\n");
cabd9892
MD
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)" : "");
cc62c0c0 98 fprintf(ofp, " --subbuf-size SIZE Subbuffer size in bytes\n");
cabd9892
MD
99 fprintf(ofp, " (default: %u, kernel default: %u)\n",
100 DEFAULT_CHANNEL_SUBBUF_SIZE,
101 DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE);
93e6c8a0
MD
102 fprintf(ofp, " Needs to be a power of 2 for\n");
103 fprintf(ofp, " kernel and ust tracers\n");
cc62c0c0 104 fprintf(ofp, " --num-subbuf NUM Number of subbufers\n");
9f778c9a
MD
105 fprintf(ofp, " (default: %u)\n",
106 DEFAULT_CHANNEL_SUBBUF_NUM);
93e6c8a0
MD
107 fprintf(ofp, " Needs to be a power of 2 for\n");
108 fprintf(ofp, " kernel and ust tracers\n");
cc62c0c0 109 fprintf(ofp, " --switch-timer USEC Switch timer interval in usec (default: %u)\n",
cabd9892 110 DEFAULT_CHANNEL_SWITCH_TIMER);
cc62c0c0 111 fprintf(ofp, " --read-timer USEC Read timer interval in usec (default: %u)\n",
cabd9892 112 DEFAULT_CHANNEL_READ_TIMER);
d36b8583
DG
113 fprintf(ofp, "\n");
114}
115
5edd7e09
DG
116/*
117 * Set default attributes depending on those already defined from the command
118 * line.
119 */
120static void set_default_attr(struct lttng_domain *dom)
121{
122 struct lttng_channel_attr default_attr;
123
124 /* Set attributes */
125 lttng_channel_set_default_attr(dom, &default_attr);
126
127 if (chan.attr.overwrite == -1) {
128 chan.attr.overwrite = default_attr.overwrite;
129 }
130 if (chan.attr.subbuf_size == -1) {
131 chan.attr.subbuf_size = default_attr.subbuf_size;
132 }
133 if (chan.attr.num_subbuf == -1) {
134 chan.attr.num_subbuf = default_attr.num_subbuf;
135 }
136 if (chan.attr.switch_timer_interval == -1) {
137 chan.attr.switch_timer_interval = default_attr.switch_timer_interval;
138 }
139 if (chan.attr.read_timer_interval == -1) {
140 chan.attr.read_timer_interval = default_attr.read_timer_interval;
141 }
142 if (chan.attr.output == -1) {
143 chan.attr.output = default_attr.output;
144 }
145}
146
d36b8583 147/*
0fdd1e2c 148 * Adding channel using the lttng API.
d36b8583 149 */
cd80958d 150static int enable_channel(char *session_name)
d36b8583 151{
ae856491 152 int ret = CMD_SUCCESS, warn = 0;
d36b8583 153 char *channel_name;
7d29a247 154 struct lttng_domain dom;
d36b8583 155
441c16a7
MD
156 memset(&dom, 0, sizeof(dom));
157
d78d6610 158 /* Create lttng domain */
7d29a247
DG
159 if (opt_kernel) {
160 dom.type = LTTNG_DOMAIN_KERNEL;
d78d6610 161 } else if (opt_userspace) {
f6a9efaa 162 dom.type = LTTNG_DOMAIN_UST;
0fdd1e2c 163 } else {
e14f64a8 164 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
d16c1a4c 165 ret = CMD_ERROR;
0fdd1e2c 166 goto error;
7d29a247
DG
167 }
168
5edd7e09
DG
169 set_default_attr(&dom);
170
cd80958d
DG
171 handle = lttng_create_handle(session_name, &dom);
172 if (handle == NULL) {
173 ret = -1;
174 goto error;
175 }
176
0fdd1e2c 177 /* Strip channel list (format: chan1,chan2,...) */
d36b8583
DG
178 channel_name = strtok(opt_channels, ",");
179 while (channel_name != NULL) {
0fdd1e2c
DG
180 /* Copy channel name and normalize it */
181 strncpy(chan.name, channel_name, NAME_MAX);
182 chan.name[NAME_MAX - 1] = '\0';
183
184 DBG("Enabling channel %s", channel_name);
185
186 ret = lttng_enable_channel(handle, &chan);
187 if (ret < 0) {
42224349 188 switch (-ret) {
f73fabfd
DG
189 case LTTNG_ERR_KERN_CHAN_EXIST:
190 case LTTNG_ERR_UST_CHAN_EXIST:
42224349
DG
191 WARN("Channel %s: %s (session %s", channel_name,
192 lttng_strerror(ret), session_name);
193 goto error;
194 default:
195 ERR("Channel %s: %s (session %s)", channel_name,
196 lttng_strerror(ret), session_name);
197 break;
198 }
ae856491 199 warn = 1;
d36b8583 200 } else {
7885e399
DG
201 MSG("%s channel %s enabled for session %s",
202 opt_kernel ? "Kernel" : "UST", channel_name,
203 session_name);
d36b8583
DG
204 }
205
206 /* Next event */
207 channel_name = strtok(NULL, ",");
208 }
209
ae856491
DG
210 ret = CMD_SUCCESS;
211
d36b8583 212error:
ae856491
DG
213 if (warn) {
214 ret = CMD_WARNING;
215 }
216
cd80958d
DG
217 lttng_destroy_handle(handle);
218
d36b8583
DG
219 return ret;
220}
221
222/*
0fdd1e2c 223 * Default value for channel configuration.
7d29a247
DG
224 */
225static void init_channel_config(void)
226{
5edd7e09
DG
227 /*
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.
230 */
231 memset(&chan.attr, -1, sizeof(chan.attr));
7d29a247
DG
232}
233
234/*
0fdd1e2c 235 * Add channel to trace session
d36b8583
DG
236 */
237int cmd_enable_channels(int argc, const char **argv)
238{
ca1c3607 239 int opt, ret = CMD_SUCCESS;
d36b8583 240 static poptContext pc;
cd80958d 241 char *session_name = NULL;
d36b8583 242
7d29a247
DG
243 init_channel_config();
244
d36b8583
DG
245 pc = poptGetContext(NULL, argc, argv, long_options, 0);
246 poptReadDefaultConfig(pc, 0);
247
248 while ((opt = poptGetNextOpt(pc)) != -1) {
249 switch (opt) {
250 case OPT_HELP:
ca1c3607 251 usage(stdout);
d36b8583 252 goto end;
7d29a247
DG
253 case OPT_DISCARD:
254 chan.attr.overwrite = 0;
255 DBG("Channel set to discard");
256 break;
257 case OPT_OVERWRITE:
258 chan.attr.overwrite = 1;
259 DBG("Channel set to overwrite");
260 break;
261 case OPT_SUBBUF_SIZE:
ca1c3607 262 /* TODO Replace atol with strtol and check for errors */
7d29a247 263 chan.attr.subbuf_size = atol(poptGetOptArg(pc));
5a0de755 264 DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
7d29a247
DG
265 break;
266 case OPT_NUM_SUBBUF:
ca1c3607 267 /* TODO Replace atoi with strtol and check for errors */
7d29a247 268 chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
5a0de755 269 DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
7d29a247
DG
270 break;
271 case OPT_SWITCH_TIMER:
ca1c3607 272 /* TODO Replace atoi with strtol and check for errors */
7d29a247
DG
273 chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
274 DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
275 break;
276 case OPT_READ_TIMER:
ca1c3607 277 /* TODO Replace atoi with strtol and check for errors */
7d29a247
DG
278 chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
279 DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
d36b8583 280 break;
eeac7d46
MD
281 case OPT_USERSPACE:
282 opt_userspace = 1;
eeac7d46 283 break;
679b4943
SM
284 case OPT_LIST_OPTIONS:
285 list_cmd_options(stdout, long_options);
679b4943 286 goto end;
d36b8583
DG
287 default:
288 usage(stderr);
289 ret = CMD_UNDEFINED;
290 goto end;
291 }
292 }
293
294 opt_channels = (char*) poptGetArg(pc);
295 if (opt_channels == NULL) {
7d29a247 296 ERR("Missing channel name.\n");
d36b8583 297 usage(stderr);
ca1c3607 298 ret = CMD_ERROR;
d36b8583
DG
299 goto end;
300 }
301
cd80958d
DG
302 if (!opt_session_name) {
303 session_name = get_session_name();
304 if (session_name == NULL) {
ca1c3607 305 ret = CMD_ERROR;
cd80958d
DG
306 goto end;
307 }
308 } else {
309 session_name = opt_session_name;
310 }
311
312 ret = enable_channel(session_name);
d36b8583
DG
313
314end:
5853fd43
DG
315 if (!opt_session_name && session_name) {
316 free(session_name);
317 }
ca1c3607 318 poptFreeContext(pc);
d36b8583
DG
319 return ret;
320}
This page took 0.065112 seconds and 4 git commands to generate.