2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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.
26 #include <sys/types.h>
30 #include <urcu/list.h>
32 #include <common/mi-lttng.h>
34 #include "../command.h"
41 enum tracker_type_state
{
59 struct lttng_tracker_id
*array
;
62 static char *opt_session_name
;
63 static int opt_kernel
;
64 static int opt_userspace
;
66 static struct opt_type opt_pid
, opt_vpid
, opt_uid
, opt_vuid
, opt_gid
, opt_vgid
;
68 static enum tracker_type_state type_state
;
83 static struct poptOption long_options
[] = {
84 /* { longName, shortName, argInfo, argPtr, value, descrip, argDesc, } */
85 { "help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0, },
86 { "session", 's', POPT_ARG_STRING
, &opt_session_name
, OPT_SESSION
, 0, 0, },
87 { "kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0, },
88 { "userspace", 'u', POPT_ARG_VAL
, &opt_userspace
, 1, 0, 0, },
89 { "pid", 'p', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_pid
.string
, OPT_PID
, 0, 0, },
90 { "vpid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_vpid
.string
, OPT_VPID
, 0, 0, },
91 { "uid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_uid
.string
, OPT_UID
, 0, 0, },
92 { "vuid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_vuid
.string
, OPT_VUID
, 0, 0, },
93 { "gid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_gid
.string
, OPT_GID
, 0, 0, },
94 { "vgid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_vgid
.string
, OPT_VGID
, 0, 0, },
95 { "all", 'a', POPT_ARG_NONE
, 0, OPT_ALL
, 0, 0, },
96 { "list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, 0, 0, },
97 { 0, 0, 0, 0, 0, 0, 0, },
100 static struct id_list
*alloc_id_list(size_t nr_items
)
102 struct id_list
*id_list
;
103 struct lttng_tracker_id
*items
;
105 id_list
= zmalloc(sizeof(*id_list
));
109 items
= zmalloc(nr_items
* sizeof(*items
));
113 id_list
->nr
= nr_items
;
114 id_list
->array
= items
;
121 static void free_id_list(struct id_list
*list
)
130 for (i
= 0; i
< nr_items
; i
++) {
131 struct lttng_tracker_id
*item
= &list
->array
[i
];
138 static int parse_id_string(
139 const char *_id_string
, int all
, struct id_list
**_id_list
)
141 const char *one_id_str
;
143 int retval
= CMD_SUCCESS
;
145 struct id_list
*id_list
= NULL
;
146 char *id_string
= NULL
;
149 if (all
&& _id_string
) {
150 ERR("An empty ID string is expected with --all");
154 if (!all
&& !_id_string
) {
155 ERR("An ID string is expected");
160 /* Empty ID string means all IDs */
161 id_list
= alloc_id_list(1);
163 ERR("Out of memory");
167 id_list
->array
[0].type
= LTTNG_ID_ALL
;
171 id_string
= strdup(_id_string
);
173 ERR("Out of memory");
179 one_id_str
= strtok_r(id_string
, ",", &iter
);
180 while (one_id_str
!= NULL
) {
183 if (isdigit(one_id_str
[0])) {
185 v
= strtoul(one_id_str
, &endptr
, 10);
186 if ((v
== 0 && errno
== EINVAL
) ||
187 (v
== ULONG_MAX
&& errno
== ERANGE
) ||
188 (*one_id_str
!= '\0' &&
190 ERR("Error parsing ID %s", one_id_str
);
195 if ((long) v
> INT_MAX
|| (int) v
< 0) {
196 ERR("Invalid ID value %ld", (long) v
);
204 one_id_str
= strtok_r(NULL
, ",", &iter
);
207 ERR("Fatal error occurred when parsing pid string");
213 /* Identity of delimiter has been lost in first pass. */
214 id_string
= strdup(_id_string
);
216 ERR("Out of memory");
222 id_list
= alloc_id_list(count
);
224 ERR("Out of memory");
229 /* Reparse string and populate the id list. */
231 one_id_str
= strtok_r(id_string
, ",", &iter
);
232 while (one_id_str
!= NULL
) {
233 struct lttng_tracker_id
*item
;
235 item
= &id_list
->array
[count
++];
236 if (isdigit(one_id_str
[0])) {
239 v
= strtoul(one_id_str
, NULL
, 10);
240 item
->type
= LTTNG_ID_VALUE
;
241 item
->value
= (int) v
;
243 item
->type
= LTTNG_ID_STRING
;
244 item
->string
= strdup(one_id_str
);
246 PERROR("Failed to allocate ID string");
253 one_id_str
= strtok_r(NULL
, ",", &iter
);
258 goto end
; /* SUCCESS */
262 free_id_list(id_list
);
268 static const char *get_tracker_str(enum lttng_tracker_type tracker_type
)
270 switch (tracker_type
) {
271 case LTTNG_TRACKER_PID
:
273 case LTTNG_TRACKER_VPID
:
275 case LTTNG_TRACKER_UID
:
277 case LTTNG_TRACKER_VUID
:
279 case LTTNG_TRACKER_GID
:
281 case LTTNG_TRACKER_VGID
:
289 static enum cmd_error_code
track_untrack_id(enum cmd_type cmd_type
,
291 const char *session_name
,
292 const char *id_string
,
294 struct mi_writer
*writer
,
295 enum lttng_tracker_type tracker_type
)
297 int ret
, success
= 1 , i
;
298 enum cmd_error_code retval
= CMD_SUCCESS
;
299 struct id_list
*id_list
= NULL
;
300 struct lttng_domain dom
;
301 struct lttng_handle
*handle
= NULL
;
302 int (*cmd_func
)(struct lttng_handle
*handle
,
303 enum lttng_tracker_type tracker_type
,
304 const struct lttng_tracker_id
*id
);
305 const char *tracker_str
;
309 cmd_func
= lttng_track_id
;
312 cmd_func
= lttng_untrack_id
;
315 ERR("Unknown command");
319 memset(&dom
, 0, sizeof(dom
));
321 dom
.type
= LTTNG_DOMAIN_KERNEL
;
322 } else if (opt_userspace
) {
323 dom
.type
= LTTNG_DOMAIN_UST
;
324 if (tracker_type
== LTTNG_TRACKER_PID
) {
325 tracker_type
= LTTNG_TRACKER_VPID
;
328 /* Checked by the caller. */
331 tracker_str
= get_tracker_str(tracker_type
);
333 ERR("Unknown tracker type");
337 ret
= parse_id_string(id_string
, all
, &id_list
);
338 if (ret
!= CMD_SUCCESS
) {
339 ERR("Error parsing %s string", tracker_str
);
344 handle
= lttng_create_handle(session_name
, &dom
);
345 if (handle
== NULL
) {
351 /* Open tracker_id and targets elements */
352 ret
= mi_lttng_id_tracker_open(writer
, tracker_type
);
358 for (i
= 0; i
< id_list
->nr
; i
++) {
359 struct lttng_tracker_id
*item
= &id_list
->array
[i
];
361 switch (item
->type
) {
363 DBG("%s all IDs", cmd_str
);
366 DBG("%s ID %d", cmd_str
, item
->value
);
368 case LTTNG_ID_STRING
:
369 DBG("%s ID '%s'", cmd_str
, item
->string
);
375 ret
= cmd_func(handle
, tracker_type
, item
);
380 case LTTNG_ERR_ID_TRACKED
:
381 msg
= "already tracked";
383 retval
= CMD_SUCCESS
;
385 case LTTNG_ERR_ID_NOT_TRACKED
:
386 msg
= "already not tracked";
388 retval
= CMD_SUCCESS
;
391 ERR("%s", lttng_strerror(ret
));
397 switch (item
->type
) {
399 WARN("All %ss %s in session %s",
404 WARN("%s %i %s in session %s",
409 case LTTNG_ID_STRING
:
410 WARN("%s '%s' %s in session %s",
421 switch (item
->type
) {
423 MSG("All %ss %sed in session %s", tracker_str
,
424 cmd_str
, session_name
);
427 MSG("%s %i %sed in session %s", tracker_str
,
428 item
->value
, cmd_str
,
431 case LTTNG_ID_STRING
:
432 MSG("%s '%s' %sed in session %s", tracker_str
,
433 item
->string
, cmd_str
,
445 ret
= mi_lttng_id_target(writer
, tracker_type
, item
, 1);
451 ret
= mi_lttng_writer_write_element_bool(writer
,
452 mi_lttng_element_success
, success
);
458 ret
= mi_lttng_writer_close_element(writer
);
467 /* Close targets and tracker_id elements */
468 ret
= mi_lttng_close_multi_element(writer
, 2);
477 lttng_destroy_handle(handle
);
479 free_id_list(id_list
);
484 const char *get_mi_element_command(enum cmd_type cmd_type
)
488 return mi_lttng_element_command_track
;
490 return mi_lttng_element_command_untrack
;
496 static void print_err_duplicate(const char *type
)
498 ERR("The --%s option can only be used once. A list of comma-separated values can be specified.",
503 * Add/remove tracker to/from session.
506 int cmd_track_untrack(enum cmd_type cmd_type
, const char *cmd_str
,
507 int argc
, const char **argv
, const char *help_msg
)
510 enum cmd_error_code command_ret
= CMD_SUCCESS
;
512 static poptContext pc
;
513 char *session_name
= NULL
;
514 struct mi_writer
*writer
= NULL
;
517 command_ret
= CMD_ERROR
;
521 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
522 poptReadDefaultConfig(pc
, 0);
524 while ((opt
= poptGetNextOpt(pc
)) != -1) {
529 case OPT_LIST_OPTIONS
:
530 list_cmd_options(stdout
, long_options
);
536 print_err_duplicate("pid");
537 command_ret
= CMD_ERROR
;
541 type_state
= STATE_PID
;
545 print_err_duplicate("vpid");
546 command_ret
= CMD_ERROR
;
550 type_state
= STATE_VPID
;
554 print_err_duplicate("uid");
555 command_ret
= CMD_ERROR
;
559 type_state
= STATE_UID
;
563 print_err_duplicate("vuid");
564 command_ret
= CMD_ERROR
;
568 type_state
= STATE_VUID
;
572 print_err_duplicate("gid");
573 command_ret
= CMD_ERROR
;
577 type_state
= STATE_GID
;
581 print_err_duplicate("vgid");
582 command_ret
= CMD_ERROR
;
586 type_state
= STATE_VGID
;
589 switch (type_state
) {
609 command_ret
= CMD_ERROR
;
614 command_ret
= CMD_UNDEFINED
;
619 ret
= print_missing_or_multiple_domains(opt_kernel
+ opt_userspace
);
621 command_ret
= CMD_ERROR
;
625 if (!opt_session_name
) {
626 session_name
= get_session_name();
627 if (session_name
== NULL
) {
628 command_ret
= CMD_ERROR
;
632 session_name
= opt_session_name
;
637 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
639 command_ret
= CMD_ERROR
;
645 /* Open command element */
646 ret
= mi_lttng_writer_command_open(writer
,
647 get_mi_element_command(cmd_type
));
649 command_ret
= CMD_ERROR
;
653 /* Open output element */
654 ret
= mi_lttng_writer_open_element(writer
,
655 mi_lttng_element_command_output
);
657 command_ret
= CMD_ERROR
;
661 ret
= mi_lttng_trackers_open(writer
);
668 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
669 opt_pid
.string
, opt_pid
.all
, writer
,
671 if (command_ret
!= CMD_SUCCESS
) {
676 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
677 opt_vpid
.string
, opt_vpid
.all
, writer
,
679 if (command_ret
!= CMD_SUCCESS
) {
684 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
685 opt_uid
.string
, opt_uid
.all
, writer
,
687 if (command_ret
!= CMD_SUCCESS
) {
692 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
693 opt_vuid
.string
, opt_vuid
.all
, writer
,
695 if (command_ret
!= CMD_SUCCESS
) {
700 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
701 opt_gid
.string
, opt_gid
.all
, writer
,
703 if (command_ret
!= CMD_SUCCESS
) {
708 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
709 opt_vgid
.string
, opt_vgid
.all
, writer
,
711 if (command_ret
!= CMD_SUCCESS
) {
718 /* Close trackers and output elements */
719 ret
= mi_lttng_close_multi_element(writer
, 2);
721 command_ret
= CMD_ERROR
;
726 ret
= mi_lttng_writer_write_element_bool(writer
,
727 mi_lttng_element_command_success
, success
);
729 command_ret
= CMD_ERROR
;
733 /* Command element close */
734 ret
= mi_lttng_writer_command_close(writer
);
736 command_ret
= CMD_ERROR
;
742 if (!opt_session_name
) {
747 if (writer
&& mi_lttng_writer_destroy(writer
)) {
748 /* Preserve original error code */
749 command_ret
= CMD_ERROR
;
753 return (int) command_ret
;
756 int cmd_track(int argc
, const char **argv
)
758 static const char *help_msg
=
759 #ifdef LTTNG_EMBED_HELP
760 #include <lttng-track.1.h>
766 return cmd_track_untrack(CMD_TRACK
, "track", argc
, argv
, help_msg
);
769 int cmd_untrack(int argc
, const char **argv
)
771 static const char *help_msg
=
772 #ifdef LTTNG_EMBED_HELP
773 #include <lttng-untrack.1.h>
779 return cmd_track_untrack(CMD_UNTRACK
, "untrack", argc
, argv
, help_msg
);