9ce850468d96db65fbe228e78e682b19bcd20cef
[lttng-tools.git] / src / bin / lttng / commands / track-untrack.c
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
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 along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 */
18
19 #define _GNU_SOURCE
20 #define _LGPL_SOURCE
21 #include <ctype.h>
22 #include <popt.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <sys/stat.h>
27 #include <sys/types.h>
28 #include <unistd.h>
29
30 #include <urcu/list.h>
31
32 #include <common/mi-lttng.h>
33
34 #include "../command.h"
35
36 enum cmd_type {
37 CMD_TRACK,
38 CMD_UNTRACK,
39 };
40
41 static char *opt_session_name;
42 static int opt_kernel;
43 static int opt_userspace;
44 static int opt_all;
45 static char *opt_pid_string;
46 static int opt_pid;
47
48 enum {
49 OPT_HELP = 1,
50 OPT_LIST_OPTIONS,
51 OPT_SESSION,
52 OPT_PID,
53 };
54
55 static struct poptOption long_options[] = {
56 /* { longName, shortName, argInfo, argPtr, value, descrip, argDesc, } */
57 { "help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0, },
58 { "session", 's', POPT_ARG_STRING, &opt_session_name, OPT_SESSION, 0, 0, },
59 { "kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0, },
60 { "userspace", 'u', POPT_ARG_VAL, &opt_userspace, 1, 0, 0, },
61 { "pid", 'p', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_pid_string, OPT_PID, 0, 0, },
62 { "all", 'a', POPT_ARG_VAL, &opt_all, 1, 0, 0, },
63 { "list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, 0, 0, },
64 { 0, 0, 0, 0, 0, 0, 0, },
65 };
66
67 /*
68 * usage
69 */
70 static void usage(FILE *ofp, const char *cmd_str)
71 {
72 fprintf(ofp, "usage: lttng %s [-k|-u] [OPTIONS]\n", cmd_str);
73 fprintf(ofp, "\n");
74 fprintf(ofp, "If no session is given (-s), the context is added to\n");
75 fprintf(ofp, "the current sesssion. Exactly one domain (-k or -u)\n");
76 fprintf(ofp, "must be specified.\n");
77 fprintf(ofp, "\n");
78 fprintf(ofp, "Options:\n");
79 fprintf(ofp, " -h, --help Show this help.\n");
80 fprintf(ofp, " --list-options Simple listing of options.\n");
81 fprintf(ofp, " -s, --session NAME Apply to session name.\n");
82 fprintf(ofp, " -k, --kernel Apply to the kernel tracer.\n");
83 fprintf(ofp, " -u, --userspace Apply to the user-space tracer.\n");
84 fprintf(ofp, " -p, --pid [PID] Process ID tracker. Leave PID empty when used with --all.\n");
85 fprintf(ofp, " -a, --all All PIDs (use with --pid).\n");
86 fprintf(ofp, "\n");
87 }
88
89 static
90 int parse_pid_string(const char *_pid_string,
91 int all, int **_pid_list, int *nr_pids)
92 {
93 const char *one_pid_str;
94 char *iter;
95 int retval = CMD_SUCCESS;
96 int count = 0;
97 int *pid_list = NULL;
98 char *pid_string = NULL;
99 char *endptr;
100
101 if (all && _pid_string) {
102 ERR("An empty PID string is expected with --all");
103 retval = CMD_ERROR;
104 goto error;
105 }
106 if (!all && !_pid_string) {
107 ERR("Please specify --all with an empty PID string");
108 retval = CMD_ERROR;
109 goto error;
110 }
111 if (all) {
112 pid_list = zmalloc(sizeof(*_pid_list));
113 if (!pid_list) {
114 ERR("Out of memory");
115 retval = CMD_ERROR;
116 goto error;
117 }
118 /* Empty PID string means all PIDs */
119 count = 1;
120 pid_list[0] = -1;
121 goto assign;
122 }
123
124 pid_string = strdup(_pid_string);
125 if (!pid_string) {
126 ERR("Out of memory");
127 retval = CMD_ERROR;
128 goto error;
129 }
130
131 /* Count */
132 one_pid_str = strtok_r(pid_string, ",", &iter);
133 while (one_pid_str != NULL) {
134 unsigned long v;
135
136 errno = 0;
137 v = strtoul(one_pid_str, &endptr, 10);
138 if ((v == 0 && errno == EINVAL)
139 || (v == ULONG_MAX && errno == ERANGE)
140 || (*one_pid_str != '\0' && *endptr != '\0')){
141 ERR("Error parsing PID %s", one_pid_str);
142 retval = CMD_ERROR;
143 goto error;
144 }
145
146 if ((long) v > INT_MAX || (int) v < 0) {
147 ERR("Invalid PID value %ld", (long) v);
148 retval = CMD_ERROR;
149 goto error;
150 }
151 count++;
152
153 /* For next loop */
154 one_pid_str = strtok_r(NULL, ",", &iter);
155 }
156
157 free(pid_string);
158 /* Identity of delimiter has been lost in first pass. */
159 pid_string = strdup(_pid_string);
160 if (!pid_string) {
161 ERR("Out of memory");
162 retval = CMD_ERROR;
163 goto error;
164 }
165
166 /* Allocate */
167 pid_list = zmalloc(count * sizeof(*pid_list));
168 if (!pid_list) {
169 ERR("Out of memory");
170 retval = CMD_ERROR;
171 goto error;
172 }
173
174 /* Copy */
175 count = 0;
176 one_pid_str = strtok_r(pid_string, ",", &iter);
177 while (one_pid_str != NULL) {
178 unsigned long v;
179
180 v = strtoul(one_pid_str, NULL, 10);
181 pid_list[count++] = (int) v;
182
183 /* For next loop */
184 one_pid_str = strtok_r(NULL, ",", &iter);
185 }
186
187 assign:
188 *nr_pids = count;
189 *_pid_list = pid_list;
190 goto end; /* SUCCESS */
191
192 /* ERROR */
193 error:
194 free(pid_list);
195 end:
196 free(pid_string);
197 return retval;
198 }
199
200 static
201 enum cmd_error_code track_untrack_pid(enum cmd_type cmd_type, const char *cmd_str,
202 const char *session_name, const char *pid_string,
203 int all, struct mi_writer *writer)
204 {
205 int ret, success = 1 , i;
206 enum cmd_error_code retval = CMD_SUCCESS;
207 int *pid_list = NULL;
208 int nr_pids;
209 struct lttng_domain dom;
210 struct lttng_handle *handle = NULL;
211 int (*lib_func)(struct lttng_handle *handle, int pid);
212
213 switch (cmd_type) {
214 case CMD_TRACK:
215 lib_func = lttng_track_pid;
216 break;
217 case CMD_UNTRACK:
218 lib_func = lttng_untrack_pid;
219 break;
220 default:
221 ERR("Unknown command");
222 retval = CMD_ERROR;
223 goto end;
224 }
225
226 memset(&dom, 0, sizeof(dom));
227 if (opt_kernel) {
228 dom.type = LTTNG_DOMAIN_KERNEL;
229 } else if (opt_userspace) {
230 dom.type = LTTNG_DOMAIN_UST;
231 } else {
232 print_missing_domain();
233 ret = CMD_ERROR;
234 goto end;
235 }
236
237 ret = parse_pid_string(pid_string, all, &pid_list, &nr_pids);
238 if (ret != CMD_SUCCESS) {
239 ERR("Error parsing PID string");
240 usage(stderr, cmd_str);
241 retval = CMD_ERROR;
242 goto end;
243 }
244
245 handle = lttng_create_handle(session_name, &dom);
246 if (handle == NULL) {
247 retval = CMD_ERROR;
248 goto end;
249 }
250
251 if (writer) {
252 /* Open process element */
253 ret = mi_lttng_targets_open(writer);
254 if (ret) {
255 retval = CMD_ERROR;
256 goto end;
257 }
258 }
259
260 for (i = 0; i < nr_pids; i++) {
261 DBG("%s PID %d", cmd_str, pid_list[i]);
262 ret = lib_func(handle, pid_list[i]);
263 if (ret) {
264 success = 0;
265 retval = CMD_ERROR;
266 } else {
267 success = 1;
268 }
269
270 /* Mi */
271 if (writer) {
272 ret = mi_lttng_pid_target(writer, pid_list[i], 1);
273 if (ret) {
274 retval = CMD_ERROR;
275 goto end;
276 }
277
278 ret = mi_lttng_writer_write_element_bool(writer,
279 mi_lttng_element_success, success);
280 if (ret) {
281 retval = CMD_ERROR;
282 goto end;
283 }
284
285 ret = mi_lttng_writer_close_element(writer);
286 if (ret) {
287 retval = CMD_ERROR;
288 goto end;
289 }
290 }
291 }
292
293 if (writer) {
294 /* Close targets element */
295 ret = mi_lttng_writer_close_element(writer);
296 if (ret) {
297 retval = CMD_ERROR;
298 goto end;
299 }
300 }
301
302 end:
303 if (handle) {
304 lttng_destroy_handle(handle);
305 }
306 free(pid_list);
307 return retval;
308 }
309
310 static
311 const char *get_mi_element_command(enum cmd_type cmd_type)
312 {
313 switch (cmd_type) {
314 case CMD_TRACK:
315 return mi_lttng_element_command_track;
316 case CMD_UNTRACK:
317 return mi_lttng_element_command_untrack;
318 default:
319 return NULL;
320 }
321 }
322
323 /*
324 * Add/remove tracker to/from session.
325 */
326 static
327 int cmd_track_untrack(enum cmd_type cmd_type, const char *cmd_str,
328 int argc, const char **argv)
329 {
330 int opt, ret = 0;
331 enum cmd_error_code command_ret = CMD_SUCCESS;
332 int success = 1;
333 static poptContext pc;
334 char *session_name = NULL;
335 struct mi_writer *writer = NULL;
336
337 if (argc < 1) {
338 usage(stderr, cmd_str);
339 command_ret = CMD_ERROR;
340 goto end;
341 }
342
343 pc = poptGetContext(NULL, argc, argv, long_options, 0);
344 poptReadDefaultConfig(pc, 0);
345
346 while ((opt = poptGetNextOpt(pc)) != -1) {
347 switch (opt) {
348 case OPT_HELP:
349 usage(stdout, cmd_str);
350 goto end;
351 case OPT_LIST_OPTIONS:
352 list_cmd_options(stdout, long_options);
353 goto end;
354 case OPT_SESSION:
355 case OPT_PID:
356 opt_pid = 1;
357 break;
358 default:
359 usage(stderr, cmd_str);
360 command_ret = CMD_UNDEFINED;
361 goto end;
362 }
363 }
364
365 if (!(opt_userspace ^ opt_kernel)) {
366 ERR("Exactly one of -u or -k needs to be specified.");
367 usage(stderr, cmd_str);
368 command_ret = CMD_ERROR;
369 goto end;
370 }
371
372 if (!opt_session_name) {
373 session_name = get_session_name();
374 if (session_name == NULL) {
375 command_ret = CMD_ERROR;
376 goto end;
377 }
378 } else {
379 session_name = opt_session_name;
380 }
381
382 /* Currently only PID tracker is supported */
383 if (!opt_pid) {
384 ERR("Please specify at least one tracker with its expected arguments");
385 usage(stderr, cmd_str);
386 command_ret = CMD_ERROR;
387 goto end;
388 }
389
390 /* Mi check */
391 if (lttng_opt_mi) {
392 writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
393 if (!writer) {
394 command_ret = CMD_ERROR;
395 goto end;
396 }
397 }
398
399 if (writer) {
400 /* Open command element */
401 ret = mi_lttng_writer_command_open(writer,
402 get_mi_element_command(cmd_type));
403 if (ret) {
404 command_ret = CMD_ERROR;
405 goto end;
406 }
407
408 /* Open output element */
409 ret = mi_lttng_writer_open_element(writer,
410 mi_lttng_element_command_output);
411 if (ret) {
412 command_ret = CMD_ERROR;
413 goto end;
414 }
415 }
416
417 command_ret = track_untrack_pid(cmd_type,
418 cmd_str, session_name, opt_pid_string,
419 opt_all, writer);
420 if (command_ret != CMD_SUCCESS) {
421 success = 0;
422 }
423
424 /* Mi closing */
425 if (writer) {
426 /* Close output element */
427 ret = mi_lttng_writer_close_element(writer);
428 if (ret) {
429 command_ret = CMD_ERROR;
430 goto end;
431 }
432
433 /* Success ? */
434 ret = mi_lttng_writer_write_element_bool(writer,
435 mi_lttng_element_command_success, success);
436 if (ret) {
437 command_ret = CMD_ERROR;
438 goto end;
439 }
440
441 /* Command element close */
442 ret = mi_lttng_writer_command_close(writer);
443 if (ret) {
444 command_ret = CMD_ERROR;
445 goto end;
446 }
447 }
448
449 end:
450 if (!opt_session_name) {
451 free(session_name);
452 }
453
454 /* Mi clean-up */
455 if (writer && mi_lttng_writer_destroy(writer)) {
456 /* Preserve original error code */
457 command_ret = CMD_ERROR;
458 }
459
460 poptFreeContext(pc);
461 return (int) command_ret;
462 }
463
464 int cmd_track(int argc, const char **argv)
465 {
466 return cmd_track_untrack(CMD_TRACK, "track", argc, argv);
467 }
468
469 int cmd_untrack(int argc, const char **argv)
470 {
471 return cmd_track_untrack(CMD_UNTRACK, "untrack", argc, argv);
472 }
This page took 0.05895 seconds and 3 git commands to generate.