Add a '--list-options' option to each command.
[lttng-tools.git] / src / bin / lttng / commands / disable_events.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
28 #include "../command.h"
29
30 static char *opt_event_list;
31 static int opt_kernel;
32 static char *opt_channel_name;
33 static char *opt_session_name;
34 static int opt_userspace;
35 static int opt_disable_all;
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_USERSPACE,
45 OPT_LIST_OPTIONS,
46 };
47
48 static struct lttng_handle *handle;
49
50 static struct poptOption long_options[] = {
51 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
52 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
53 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
54 {"all-events", 'a', POPT_ARG_VAL, &opt_disable_all, 1, 0, 0},
55 {"channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
56 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
57 #if 0
58 /* Not implemented yet */
59 {"userspace", 'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
60 {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
61 #else
62 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
63 #endif
64 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
65 {0, 0, 0, 0, 0, 0, 0}
66 };
67
68 /*
69 * usage
70 */
71 static void usage(FILE *ofp)
72 {
73 fprintf(ofp, "usage: lttng disable-event NAME[,NAME2,...] [options]\n");
74 fprintf(ofp, "\n");
75 fprintf(ofp, " -h, --help Show this help\n");
76 fprintf(ofp, " --list-options Simple listing of options\n");
77 fprintf(ofp, " -s, --session Apply on session name\n");
78 fprintf(ofp, " -c, --channel Apply on this channel\n");
79 fprintf(ofp, " -a, --all-events Disable all tracepoints\n");
80 fprintf(ofp, " -k, --kernel Apply for the kernel tracer\n");
81 #if 0
82 fprintf(ofp, " -u, --userspace [CMD] Apply for the user-space tracer\n");
83 fprintf(ofp, " If no CMD, the domain used is UST global\n");
84 fprintf(ofp, " or else the domain is UST EXEC_NAME\n");
85 fprintf(ofp, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n");
86 #else
87 fprintf(ofp, " -u, --userspace Apply for the user-space tracer\n");
88 #endif
89 fprintf(ofp, "\n");
90 }
91
92 /*
93 * disable_events
94 *
95 * Disabling event using the lttng API.
96 */
97 static int disable_events(char *session_name)
98 {
99 int err, ret = CMD_SUCCESS;
100 char *event_name, *channel_name = NULL;
101 struct lttng_domain dom;
102
103 if (opt_channel_name == NULL) {
104 err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME);
105 if (err < 0) {
106 ret = CMD_FATAL;
107 goto error;
108 }
109 } else {
110 channel_name = opt_channel_name;
111 }
112
113 if (opt_kernel && opt_userspace) {
114 ERR("Can't use -k/--kernel and -u/--userspace together");
115 ret = CMD_FATAL;
116 goto error;
117 }
118
119 /* Create lttng domain */
120 if (opt_kernel) {
121 dom.type = LTTNG_DOMAIN_KERNEL;
122 } else if (opt_userspace) {
123 dom.type = LTTNG_DOMAIN_UST;
124 } else {
125 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
126 ret = CMD_UNDEFINED;
127 goto error;
128 }
129
130 handle = lttng_create_handle(session_name, &dom);
131 if (handle == NULL) {
132 ret = -1;
133 goto error;
134 }
135
136 if (opt_disable_all) {
137 ret = lttng_disable_event(handle, NULL, channel_name);
138 if (ret < 0) {
139 goto error;
140 }
141
142 MSG("All %s events are disabled in channel %s",
143 opt_kernel ? "kernel" : "UST", channel_name);
144 goto end;
145 }
146
147 /* Strip event list */
148 event_name = strtok(opt_event_list, ",");
149 while (event_name != NULL) {
150 /* Kernel tracer action */
151 if (opt_kernel) {
152 DBG("Disabling kernel event %s in channel %s",
153 event_name, channel_name);
154 } else if (opt_userspace) { /* User-space tracer action */
155 #if 0
156 if (opt_cmd_name != NULL || opt_pid) {
157 MSG("Only supporting tracing all UST processes (-u) for now.");
158 ret = CMD_UNDEFINED;
159 goto error;
160 }
161 #endif
162 DBG("Disabling UST event %s in channel %s",
163 event_name, channel_name);
164 } else {
165 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
166 goto error;
167 }
168
169 ret = lttng_disable_event(handle, event_name, channel_name);
170 if (ret < 0) {
171 MSG("Unable to disable %s event %s in channel %s",
172 opt_kernel ? "kernel" : "UST", event_name,
173 channel_name);
174 } else {
175 MSG("%s event %s disabled in channel %s",
176 opt_kernel ? "kernel" : "UST", event_name,
177 channel_name);
178 }
179
180 /* Next event */
181 event_name = strtok(NULL, ",");
182 }
183
184 end:
185 error:
186 if (opt_channel_name == NULL) {
187 free(channel_name);
188 }
189 lttng_destroy_handle(handle);
190
191 return ret;
192 }
193
194 /*
195 * cmd_disable_events
196 *
197 * Disable event to trace session
198 */
199 int cmd_disable_events(int argc, const char **argv)
200 {
201 int opt, ret;
202 static poptContext pc;
203 char *session_name = NULL;
204
205 pc = poptGetContext(NULL, argc, argv, long_options, 0);
206 poptReadDefaultConfig(pc, 0);
207
208 while ((opt = poptGetNextOpt(pc)) != -1) {
209 switch (opt) {
210 case OPT_HELP:
211 usage(stderr);
212 ret = CMD_SUCCESS;
213 goto end;
214 case OPT_USERSPACE:
215 opt_userspace = 1;
216 break;
217 case OPT_LIST_OPTIONS:
218 list_cmd_options(stdout, long_options);
219 ret = CMD_SUCCESS;
220 goto end;
221 default:
222 usage(stderr);
223 ret = CMD_UNDEFINED;
224 goto end;
225 }
226 }
227
228 opt_event_list = (char*) poptGetArg(pc);
229 if (opt_event_list == NULL && opt_disable_all == 0) {
230 ERR("Missing event name(s).\n");
231 usage(stderr);
232 ret = CMD_SUCCESS;
233 goto end;
234 }
235
236 if (!opt_session_name) {
237 session_name = get_session_name();
238 if (session_name == NULL) {
239 ret = -1;
240 goto end;
241 }
242 } else {
243 session_name = opt_session_name;
244 }
245
246 ret = disable_events(session_name);
247
248 end:
249 return ret;
250 }
This page took 0.050035 seconds and 5 git commands to generate.