Fix: documented number of subbuffers is incorrect
[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 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
82a3637f
DG
6 * as published by the Free Software Foundation; only version 2
7 * of the License.
d36b8583
DG
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>
5a0de755 27#include <inttypes.h>
d36b8583 28
c399183f 29#include "../command.h"
d36b8583
DG
30
31static char *opt_channels;
5edd7e09 32static int opt_kernel;
5440dc42 33static char *opt_session_name;
d36b8583 34static int opt_userspace;
d78d6610
DG
35static struct lttng_channel chan;
36#if 0
37/* Not implemented yet */
eeac7d46 38static char *opt_cmd_name;
d36b8583 39static pid_t opt_pid;
d78d6610 40#endif
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,
d36b8583
DG
52};
53
cd80958d
DG
54static struct lttng_handle *handle;
55
d36b8583
DG
56static struct poptOption long_options[] = {
57 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
58 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42 59 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
d36b8583 60 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610
DG
61#if 0
62 /* Not implemented yet */
6caa2bcc 63 {"userspace", 'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
d36b8583 64 {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
d78d6610
DG
65#else
66 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
67#endif
7d29a247
DG
68 {"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
69 {"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
1b579521
DG
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},
679b4943 74 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
d36b8583
DG
75 {0, 0, 0, 0, 0, 0, 0}
76};
77
78/*
79 * usage
80 */
81static void usage(FILE *ofp)
82{
7d29a247 83 fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [options] [channel_options]\n");
d36b8583 84 fprintf(ofp, "\n");
7d29a247 85 fprintf(ofp, " -h, --help Show this help\n");
679b4943 86 fprintf(ofp, " --list-options Simple listing of options\n");
27221701
DG
87 fprintf(ofp, " -s, --session Apply to session name\n");
88 fprintf(ofp, " -k, --kernel Apply to the kernel tracer\n");
d78d6610 89#if 0
27221701 90 fprintf(ofp, " -u, --userspace [CMD] Apply to the user-space tracer\n");
e14f64a8
DG
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");
d78d6610 94#else
27221701 95 fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
d78d6610 96#endif
7d29a247
DG
97 fprintf(ofp, "\n");
98 fprintf(ofp, "Channel options:\n");
cabd9892
MD
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)" : "");
cc62c0c0 103 fprintf(ofp, " --subbuf-size SIZE Subbuffer size in bytes\n");
cabd9892
MD
104 fprintf(ofp, " (default: %u, kernel default: %u)\n",
105 DEFAULT_CHANNEL_SUBBUF_SIZE,
106 DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE);
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, " --num-subbuf NUM Number of subbufers\n");
9f778c9a
MD
110 fprintf(ofp, " (default: %u)\n",
111 DEFAULT_CHANNEL_SUBBUF_NUM);
93e6c8a0
MD
112 fprintf(ofp, " Needs to be a power of 2 for\n");
113 fprintf(ofp, " kernel and ust tracers\n");
cc62c0c0 114 fprintf(ofp, " --switch-timer USEC Switch timer interval in usec (default: %u)\n",
cabd9892 115 DEFAULT_CHANNEL_SWITCH_TIMER);
cc62c0c0 116 fprintf(ofp, " --read-timer USEC Read timer interval in usec (default: %u)\n",
cabd9892 117 DEFAULT_CHANNEL_READ_TIMER);
d36b8583
DG
118 fprintf(ofp, "\n");
119}
120
5edd7e09
DG
121/*
122 * Set default attributes depending on those already defined from the command
123 * line.
124 */
125static 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
d36b8583 152/*
0fdd1e2c 153 * Adding channel using the lttng API.
d36b8583 154 */
cd80958d 155static int enable_channel(char *session_name)
d36b8583 156{
ae856491 157 int ret = CMD_SUCCESS, warn = 0;
d36b8583 158 char *channel_name;
7d29a247 159 struct lttng_domain dom;
d36b8583 160
441c16a7
MD
161 memset(&dom, 0, sizeof(dom));
162
d78d6610 163 /* Create lttng domain */
7d29a247
DG
164 if (opt_kernel) {
165 dom.type = LTTNG_DOMAIN_KERNEL;
d78d6610 166 } else if (opt_userspace) {
f6a9efaa 167 dom.type = LTTNG_DOMAIN_UST;
0fdd1e2c 168 } else {
e14f64a8 169 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
d16c1a4c 170 ret = CMD_ERROR;
0fdd1e2c 171 goto error;
7d29a247
DG
172 }
173
5edd7e09
DG
174 set_default_attr(&dom);
175
cd80958d
DG
176 handle = lttng_create_handle(session_name, &dom);
177 if (handle == NULL) {
178 ret = -1;
179 goto error;
180 }
181
0fdd1e2c 182 /* Strip channel list (format: chan1,chan2,...) */
d36b8583
DG
183 channel_name = strtok(opt_channels, ",");
184 while (channel_name != NULL) {
0fdd1e2c
DG
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) {
ae856491
DG
193 ERR("Channel %s: %s (session %s)", channel_name,
194 lttng_strerror(ret), session_name);
195 warn = 1;
d36b8583 196 } else {
7885e399
DG
197 MSG("%s channel %s enabled for session %s",
198 opt_kernel ? "Kernel" : "UST", channel_name,
199 session_name);
d36b8583
DG
200 }
201
202 /* Next event */
203 channel_name = strtok(NULL, ",");
204 }
205
ae856491
DG
206 ret = CMD_SUCCESS;
207
d36b8583 208error:
ae856491
DG
209 if (warn) {
210 ret = CMD_WARNING;
211 }
212
cd80958d
DG
213 lttng_destroy_handle(handle);
214
d36b8583
DG
215 return ret;
216}
217
218/*
0fdd1e2c 219 * Default value for channel configuration.
7d29a247
DG
220 */
221static void init_channel_config(void)
222{
5edd7e09
DG
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));
7d29a247
DG
228}
229
230/*
0fdd1e2c 231 * Add channel to trace session
d36b8583
DG
232 */
233int cmd_enable_channels(int argc, const char **argv)
234{
ca1c3607 235 int opt, ret = CMD_SUCCESS;
d36b8583 236 static poptContext pc;
cd80958d 237 char *session_name = NULL;
d36b8583 238
7d29a247
DG
239 init_channel_config();
240
d36b8583
DG
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:
ca1c3607 247 usage(stdout);
d36b8583 248 goto end;
7d29a247
DG
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:
ca1c3607 258 /* TODO Replace atol with strtol and check for errors */
7d29a247 259 chan.attr.subbuf_size = atol(poptGetOptArg(pc));
5a0de755 260 DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
7d29a247
DG
261 break;
262 case OPT_NUM_SUBBUF:
ca1c3607 263 /* TODO Replace atoi with strtol and check for errors */
7d29a247 264 chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
5a0de755 265 DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
7d29a247
DG
266 break;
267 case OPT_SWITCH_TIMER:
ca1c3607 268 /* TODO Replace atoi with strtol and check for errors */
7d29a247
DG
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:
ca1c3607 273 /* TODO Replace atoi with strtol and check for errors */
7d29a247
DG
274 chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
275 DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
d36b8583 276 break;
eeac7d46
MD
277 case OPT_USERSPACE:
278 opt_userspace = 1;
eeac7d46 279 break;
679b4943
SM
280 case OPT_LIST_OPTIONS:
281 list_cmd_options(stdout, long_options);
679b4943 282 goto end;
d36b8583
DG
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) {
7d29a247 292 ERR("Missing channel name.\n");
d36b8583 293 usage(stderr);
ca1c3607 294 ret = CMD_ERROR;
d36b8583
DG
295 goto end;
296 }
297
cd80958d
DG
298 if (!opt_session_name) {
299 session_name = get_session_name();
300 if (session_name == NULL) {
ca1c3607 301 ret = CMD_ERROR;
cd80958d
DG
302 goto end;
303 }
304 } else {
305 session_name = opt_session_name;
306 }
307
308 ret = enable_channel(session_name);
d36b8583
DG
309
310end:
5853fd43
DG
311 if (!opt_session_name && session_name) {
312 free(session_name);
313 }
ca1c3607 314 poptFreeContext(pc);
d36b8583
DG
315 return ret;
316}
This page took 0.06386 seconds and 4 git commands to generate.