Commit | Line | Data |
---|---|---|
ccf10263 MD |
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; | |
44c1a903 | 99 | char *endptr; |
ccf10263 MD |
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 | ||
44c1a903 JR |
136 | errno = 0; |
137 | v = strtoul(one_pid_str, &endptr, 10); | |
ccf10263 | 138 | if ((v == 0 && errno == EINVAL) |
44c1a903 JR |
139 | || (v == ULONG_MAX && errno == ERANGE) |
140 | || (*one_pid_str != '\0' && *endptr != '\0')){ | |
ccf10263 MD |
141 | ERR("Error parsing PID %s", one_pid_str); |
142 | retval = CMD_ERROR; | |
143 | goto error; | |
144 | } | |
44c1a903 | 145 | |
ccf10263 MD |
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 | |
c51da673 | 201 | enum cmd_error_code track_untrack_pid(enum cmd_type cmd_type, const char *cmd_str, |
ccf10263 MD |
202 | const char *session_name, const char *pid_string, |
203 | int all, struct mi_writer *writer) | |
204 | { | |
c51da673 JG |
205 | int ret, success = 1 , i; |
206 | enum cmd_error_code retval = CMD_SUCCESS; | |
ccf10263 MD |
207 | int *pid_list = NULL; |
208 | int nr_pids; | |
209 | struct lttng_domain dom; | |
210 | struct lttng_handle *handle = NULL; | |
669d25b6 | 211 | int (*cmd_func)(struct lttng_handle *handle, int pid); |
ccf10263 MD |
212 | |
213 | switch (cmd_type) { | |
214 | case CMD_TRACK: | |
669d25b6 | 215 | cmd_func = lttng_track_pid; |
ccf10263 MD |
216 | break; |
217 | case CMD_UNTRACK: | |
669d25b6 | 218 | cmd_func = lttng_untrack_pid; |
ccf10263 MD |
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) { | |
ebbf5ab7 JR |
252 | /* Open process element */ |
253 | ret = mi_lttng_targets_open(writer); | |
ccf10263 MD |
254 | if (ret) { |
255 | retval = CMD_ERROR; | |
256 | goto end; | |
257 | } | |
258 | } | |
259 | ||
ccf10263 MD |
260 | for (i = 0; i < nr_pids; i++) { |
261 | DBG("%s PID %d", cmd_str, pid_list[i]); | |
669d25b6 | 262 | ret = cmd_func(handle, pid_list[i]); |
ccf10263 | 263 | if (ret) { |
b93a4a13 MJ |
264 | switch (-ret) { |
265 | case LTTNG_ERR_PID_TRACKED: | |
266 | WARN("PID %i already tracked in session %s", | |
267 | pid_list[i], session_name); | |
268 | success = 1; | |
269 | retval = CMD_SUCCESS; | |
270 | break; | |
271 | case LTTNG_ERR_PID_NOT_TRACKED: | |
272 | WARN("PID %i not tracked in session %s", | |
273 | pid_list[i], session_name); | |
274 | success = 1; | |
275 | retval = CMD_SUCCESS; | |
276 | break; | |
277 | default: | |
278 | ERR("%s", lttng_strerror(ret)); | |
279 | success = 0; | |
280 | retval = CMD_ERROR; | |
281 | break; | |
282 | } | |
ebbf5ab7 | 283 | } else { |
b93a4a13 MJ |
284 | MSG("PID %i %sed in session %s", |
285 | pid_list[i], cmd_str, session_name); | |
ebbf5ab7 JR |
286 | success = 1; |
287 | } | |
288 | ||
289 | /* Mi */ | |
290 | if (writer) { | |
291 | ret = mi_lttng_pid_target(writer, pid_list[i], 1); | |
292 | if (ret) { | |
293 | retval = CMD_ERROR; | |
294 | goto end; | |
295 | } | |
296 | ||
297 | ret = mi_lttng_writer_write_element_bool(writer, | |
298 | mi_lttng_element_success, success); | |
299 | if (ret) { | |
300 | retval = CMD_ERROR; | |
301 | goto end; | |
302 | } | |
303 | ||
304 | ret = mi_lttng_writer_close_element(writer); | |
305 | if (ret) { | |
306 | retval = CMD_ERROR; | |
307 | goto end; | |
308 | } | |
ccf10263 MD |
309 | } |
310 | } | |
311 | ||
312 | if (writer) { | |
ebbf5ab7 | 313 | /* Close targets element */ |
ccf10263 MD |
314 | ret = mi_lttng_writer_close_element(writer); |
315 | if (ret) { | |
316 | retval = CMD_ERROR; | |
317 | goto end; | |
318 | } | |
319 | } | |
320 | ||
ccf10263 MD |
321 | end: |
322 | if (handle) { | |
323 | lttng_destroy_handle(handle); | |
324 | } | |
325 | free(pid_list); | |
326 | return retval; | |
327 | } | |
328 | ||
329 | static | |
330 | const char *get_mi_element_command(enum cmd_type cmd_type) | |
331 | { | |
332 | switch (cmd_type) { | |
333 | case CMD_TRACK: | |
334 | return mi_lttng_element_command_track; | |
335 | case CMD_UNTRACK: | |
336 | return mi_lttng_element_command_untrack; | |
337 | default: | |
338 | return NULL; | |
339 | } | |
340 | } | |
341 | ||
342 | /* | |
343 | * Add/remove tracker to/from session. | |
344 | */ | |
345 | static | |
346 | int cmd_track_untrack(enum cmd_type cmd_type, const char *cmd_str, | |
347 | int argc, const char **argv) | |
348 | { | |
c51da673 JG |
349 | int opt, ret = 0; |
350 | enum cmd_error_code command_ret = CMD_SUCCESS; | |
ccf10263 MD |
351 | int success = 1; |
352 | static poptContext pc; | |
353 | char *session_name = NULL; | |
354 | struct mi_writer *writer = NULL; | |
355 | ||
356 | if (argc < 1) { | |
357 | usage(stderr, cmd_str); | |
c51da673 | 358 | command_ret = CMD_ERROR; |
ccf10263 MD |
359 | goto end; |
360 | } | |
361 | ||
362 | pc = poptGetContext(NULL, argc, argv, long_options, 0); | |
363 | poptReadDefaultConfig(pc, 0); | |
364 | ||
365 | while ((opt = poptGetNextOpt(pc)) != -1) { | |
366 | switch (opt) { | |
367 | case OPT_HELP: | |
368 | usage(stdout, cmd_str); | |
369 | goto end; | |
370 | case OPT_LIST_OPTIONS: | |
371 | list_cmd_options(stdout, long_options); | |
372 | goto end; | |
373 | case OPT_SESSION: | |
374 | case OPT_PID: | |
375 | opt_pid = 1; | |
376 | break; | |
377 | default: | |
378 | usage(stderr, cmd_str); | |
c51da673 | 379 | command_ret = CMD_UNDEFINED; |
ccf10263 MD |
380 | goto end; |
381 | } | |
382 | } | |
383 | ||
384 | if (!(opt_userspace ^ opt_kernel)) { | |
385 | ERR("Exactly one of -u or -k needs to be specified."); | |
386 | usage(stderr, cmd_str); | |
c51da673 | 387 | command_ret = CMD_ERROR; |
ccf10263 MD |
388 | goto end; |
389 | } | |
390 | ||
391 | if (!opt_session_name) { | |
392 | session_name = get_session_name(); | |
393 | if (session_name == NULL) { | |
c51da673 | 394 | command_ret = CMD_ERROR; |
ccf10263 MD |
395 | goto end; |
396 | } | |
397 | } else { | |
398 | session_name = opt_session_name; | |
399 | } | |
400 | ||
401 | /* Currently only PID tracker is supported */ | |
402 | if (!opt_pid) { | |
403 | ERR("Please specify at least one tracker with its expected arguments"); | |
404 | usage(stderr, cmd_str); | |
c51da673 | 405 | command_ret = CMD_ERROR; |
ccf10263 MD |
406 | goto end; |
407 | } | |
408 | ||
409 | /* Mi check */ | |
410 | if (lttng_opt_mi) { | |
411 | writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi); | |
412 | if (!writer) { | |
c51da673 | 413 | command_ret = CMD_ERROR; |
ccf10263 MD |
414 | goto end; |
415 | } | |
416 | } | |
417 | ||
418 | if (writer) { | |
419 | /* Open command element */ | |
420 | ret = mi_lttng_writer_command_open(writer, | |
421 | get_mi_element_command(cmd_type)); | |
422 | if (ret) { | |
c51da673 | 423 | command_ret = CMD_ERROR; |
ccf10263 MD |
424 | goto end; |
425 | } | |
426 | ||
427 | /* Open output element */ | |
428 | ret = mi_lttng_writer_open_element(writer, | |
429 | mi_lttng_element_command_output); | |
430 | if (ret) { | |
c51da673 | 431 | command_ret = CMD_ERROR; |
ccf10263 MD |
432 | goto end; |
433 | } | |
434 | } | |
435 | ||
436 | command_ret = track_untrack_pid(cmd_type, | |
437 | cmd_str, session_name, opt_pid_string, | |
438 | opt_all, writer); | |
c51da673 | 439 | if (command_ret != CMD_SUCCESS) { |
ccf10263 MD |
440 | success = 0; |
441 | } | |
442 | ||
443 | /* Mi closing */ | |
444 | if (writer) { | |
445 | /* Close output element */ | |
446 | ret = mi_lttng_writer_close_element(writer); | |
447 | if (ret) { | |
c51da673 | 448 | command_ret = CMD_ERROR; |
ccf10263 MD |
449 | goto end; |
450 | } | |
451 | ||
452 | /* Success ? */ | |
453 | ret = mi_lttng_writer_write_element_bool(writer, | |
454 | mi_lttng_element_command_success, success); | |
455 | if (ret) { | |
c51da673 | 456 | command_ret = CMD_ERROR; |
ccf10263 MD |
457 | goto end; |
458 | } | |
459 | ||
460 | /* Command element close */ | |
461 | ret = mi_lttng_writer_command_close(writer); | |
462 | if (ret) { | |
c51da673 | 463 | command_ret = CMD_ERROR; |
ccf10263 MD |
464 | goto end; |
465 | } | |
466 | } | |
467 | ||
468 | end: | |
469 | if (!opt_session_name) { | |
470 | free(session_name); | |
471 | } | |
472 | ||
473 | /* Mi clean-up */ | |
474 | if (writer && mi_lttng_writer_destroy(writer)) { | |
475 | /* Preserve original error code */ | |
c51da673 | 476 | command_ret = CMD_ERROR; |
ccf10263 MD |
477 | } |
478 | ||
ccf10263 | 479 | poptFreeContext(pc); |
c51da673 | 480 | return (int) command_ret; |
ccf10263 MD |
481 | } |
482 | ||
483 | int cmd_track(int argc, const char **argv) | |
484 | { | |
485 | return cmd_track_untrack(CMD_TRACK, "track", argc, argv); | |
486 | } | |
487 | ||
488 | int cmd_untrack(int argc, const char **argv) | |
489 | { | |
490 | return cmd_track_untrack(CMD_UNTRACK, "untrack", argc, argv); | |
491 | } |