48e83df28a53039ad90f09d34f65ce74d03c3961
[lttng-tools.git] / 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 "../cmd.h"
30 #include "../conf.h"
31 #include "../utils.h"
32
33 static char *opt_channels;
34 static char *opt_kernel;
35 static char *opt_cmd_name;
36 static char *opt_session_name;
37 static int opt_pid_all;
38 static int opt_userspace;
39 static char *opt_cmd_name;
40 static pid_t opt_pid;
41 static struct lttng_channel chan;
42
43 enum {
44 OPT_HELP = 1,
45 OPT_DISCARD,
46 OPT_OVERWRITE,
47 OPT_SUBBUF_SIZE,
48 OPT_NUM_SUBBUF,
49 OPT_SWITCH_TIMER,
50 OPT_READ_TIMER,
51 OPT_USERSPACE,
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 {"userspace", 'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
62 {"all", 0, POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
63 {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
64 {"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0},
65 {"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0},
66 {"subbuf-size", 0, POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0},
67 {"num-subbuf", 0, POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0},
68 {"switch-timer", 0, POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0},
69 {"read-timer", 0, POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0},
70 {0, 0, 0, 0, 0, 0, 0}
71 };
72
73 /*
74 * usage
75 */
76 static void usage(FILE *ofp)
77 {
78 fprintf(ofp, "usage: lttng enable-channel NAME[,NAME2,...] [options] [channel_options]\n");
79 fprintf(ofp, "\n");
80 fprintf(ofp, " -h, --help Show this help\n");
81 fprintf(ofp, " -s, --session Apply on session name\n");
82 fprintf(ofp, " -k, --kernel Apply on the kernel tracer\n");
83 fprintf(ofp, " -u, --userspace [CMD] Apply on the user-space tracer\n");
84 fprintf(ofp, " --all If -u, apply on all traceable apps\n");
85 fprintf(ofp, " -p, --pid PID If -u, apply on a specific PID\n");
86 fprintf(ofp, "\n");
87 fprintf(ofp, "Channel options:\n");
88 fprintf(ofp, " --discard Discard event when buffers are full%s\n",
89 DEFAULT_CHANNEL_OVERWRITE ? "" : " (default)");
90 fprintf(ofp, " --overwrite Flight recorder mode%s\n",
91 DEFAULT_CHANNEL_OVERWRITE ? " (default)" : "");
92 fprintf(ofp, " --subbuf-size Subbuffer size in bytes\n");
93 fprintf(ofp, " (default: %u, kernel default: %u)\n",
94 DEFAULT_CHANNEL_SUBBUF_SIZE,
95 DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE);
96 fprintf(ofp, " --num-subbuf Number of subbufers\n");
97 fprintf(ofp, " (default: %u, kernel default: %u)\n",
98 DEFAULT_CHANNEL_SUBBUF_NUM,
99 DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM);
100 fprintf(ofp, " --switch-timer Switch timer interval in usec (default: %u)\n",
101 DEFAULT_CHANNEL_SWITCH_TIMER);
102 fprintf(ofp, " --read-timer Read timer interval in usec (default: %u)\n",
103 DEFAULT_CHANNEL_READ_TIMER);
104 fprintf(ofp, "\n");
105 }
106
107 /*
108 * Adding channel using the lttng API.
109 */
110 static int enable_channel(char *session_name)
111 {
112 int ret = CMD_SUCCESS;
113 char *channel_name;
114 struct lttng_domain dom;
115
116 if (opt_kernel) {
117 dom.type = LTTNG_DOMAIN_KERNEL;
118 } else if (opt_pid != 0) {
119 dom.type = LTTNG_DOMAIN_UST_PID;
120 dom.attr.pid = opt_pid;
121 DBG("PID %d set to lttng handle", opt_pid);
122 } else if (opt_userspace && opt_cmd_name == NULL) {
123 dom.type = LTTNG_DOMAIN_UST;
124 } else if (opt_userspace && opt_cmd_name != NULL) {
125 dom.type = LTTNG_DOMAIN_UST_EXEC_NAME;
126 strncpy(dom.attr.exec_name, opt_cmd_name, NAME_MAX);
127 } else {
128 ERR("Please specify a tracer (--kernel or --userspace)");
129 ret = CMD_NOT_IMPLEMENTED;
130 goto error;
131 }
132
133 handle = lttng_create_handle(session_name, &dom);
134 if (handle == NULL) {
135 ret = -1;
136 goto error;
137 }
138
139 /* Strip channel list (format: chan1,chan2,...) */
140 channel_name = strtok(opt_channels, ",");
141 while (channel_name != NULL) {
142 /* Copy channel name and normalize it */
143 strncpy(chan.name, channel_name, NAME_MAX);
144 chan.name[NAME_MAX - 1] = '\0';
145
146 DBG("Enabling channel %s", channel_name);
147
148 ret = lttng_enable_channel(handle, &chan);
149 if (ret < 0) {
150 goto error;
151 } else {
152 MSG("Channel enabled %s for session %s",
153 channel_name, session_name);
154 }
155
156 /* Next event */
157 channel_name = strtok(NULL, ",");
158 }
159
160 error:
161 lttng_destroy_handle(handle);
162
163 return ret;
164 }
165
166 /*
167 * Default value for channel configuration.
168 */
169 static void init_channel_config(void)
170 {
171 if (opt_kernel) {
172 /* kernel default */
173 chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
174 chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
175 chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
176
177 chan.attr.subbuf_size = DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE;
178 chan.attr.num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
179 chan.attr.output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
180 } else {
181 /* default behavior, used by UST. */
182 chan.attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
183 chan.attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
184 chan.attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
185
186 chan.attr.subbuf_size = DEFAULT_UST_CHANNEL_SUBBUF_SIZE;
187 chan.attr.num_subbuf = DEFAULT_UST_CHANNEL_SUBBUF_NUM;
188 chan.attr.output = DEFAULT_CHANNEL_OUTPUT;
189 }
190 }
191
192 /*
193 * Add channel to trace session
194 */
195 int cmd_enable_channels(int argc, const char **argv)
196 {
197 int opt, ret;
198 static poptContext pc;
199 char *session_name = NULL;
200
201 init_channel_config();
202
203 pc = poptGetContext(NULL, argc, argv, long_options, 0);
204 poptReadDefaultConfig(pc, 0);
205
206 while ((opt = poptGetNextOpt(pc)) != -1) {
207 switch (opt) {
208 case OPT_HELP:
209 usage(stderr);
210 ret = CMD_SUCCESS;
211 goto end;
212 case OPT_DISCARD:
213 chan.attr.overwrite = 0;
214 DBG("Channel set to discard");
215 break;
216 case OPT_OVERWRITE:
217 chan.attr.overwrite = 1;
218 DBG("Channel set to overwrite");
219 break;
220 case OPT_SUBBUF_SIZE:
221 chan.attr.subbuf_size = atol(poptGetOptArg(pc));
222 DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
223 break;
224 case OPT_NUM_SUBBUF:
225 chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
226 DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
227 break;
228 case OPT_SWITCH_TIMER:
229 chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
230 DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
231 break;
232 case OPT_READ_TIMER:
233 chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
234 DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
235 break;
236 case OPT_USERSPACE:
237 opt_userspace = 1;
238 break;
239 default:
240 usage(stderr);
241 ret = CMD_UNDEFINED;
242 goto end;
243 }
244 }
245
246 opt_channels = (char*) poptGetArg(pc);
247 if (opt_channels == NULL) {
248 ERR("Missing channel name.\n");
249 usage(stderr);
250 ret = CMD_SUCCESS;
251 goto end;
252 }
253
254 if (!opt_session_name) {
255 session_name = get_session_name();
256 if (session_name == NULL) {
257 ret = -1;
258 goto end;
259 }
260 } else {
261 session_name = opt_session_name;
262 }
263
264 ret = enable_channel(session_name);
265
266 end:
267 return ret;
268 }
This page took 0.052075 seconds and 4 git commands to generate.