2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
17 #include <sys/types.h>
21 #include <urcu/list.h>
23 #include <common/mi-lttng.h>
25 #include "../command.h"
32 enum tracker_type_state
{
50 struct lttng_tracker_id
**array
;
53 static char *opt_session_name
;
54 static int opt_kernel
;
55 static int opt_userspace
;
57 static struct opt_type opt_pid
, opt_vpid
, opt_uid
, opt_vuid
, opt_gid
, opt_vgid
;
59 static enum tracker_type_state type_state
;
74 static struct poptOption long_options
[] = {
75 /* { longName, shortName, argInfo, argPtr, value, descrip, argDesc, } */
76 { "help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0, },
77 { "session", 's', POPT_ARG_STRING
, &opt_session_name
, OPT_SESSION
, 0, 0, },
78 { "kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0, },
79 { "userspace", 'u', POPT_ARG_VAL
, &opt_userspace
, 1, 0, 0, },
80 { "pid", 'p', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_pid
.string
, OPT_PID
, 0, 0, },
81 { "vpid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_vpid
.string
, OPT_VPID
, 0, 0, },
82 { "uid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_uid
.string
, OPT_UID
, 0, 0, },
83 { "vuid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_vuid
.string
, OPT_VUID
, 0, 0, },
84 { "gid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_gid
.string
, OPT_GID
, 0, 0, },
85 { "vgid", 0, POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_vgid
.string
, OPT_VGID
, 0, 0, },
86 { "all", 'a', POPT_ARG_NONE
, 0, OPT_ALL
, 0, 0, },
87 { "list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, 0, 0, },
88 { 0, 0, 0, 0, 0, 0, 0, },
91 static struct id_list
*alloc_id_list(size_t nr_items
)
93 struct id_list
*id_list
;
94 struct lttng_tracker_id
**items
;
96 id_list
= zmalloc(sizeof(*id_list
));
100 items
= zmalloc(nr_items
* sizeof(*items
));
104 id_list
->nr
= nr_items
;
105 id_list
->array
= items
;
112 static void free_id_list(struct id_list
*list
)
121 for (i
= 0; i
< nr_items
; i
++) {
122 struct lttng_tracker_id
*item
= list
->array
[i
];
123 lttng_tracker_id_destroy(item
);
128 static int parse_id_string(const char *_id_string
,
130 struct id_list
**_id_list
,
131 enum lttng_tracker_type tracker_type
)
133 const char *one_id_str
;
135 int retval
= CMD_SUCCESS
;
137 struct id_list
*id_list
= NULL
;
138 char *id_string
= NULL
;
141 if (all
&& _id_string
) {
142 ERR("An empty ID string is expected with --all");
146 if (!all
&& !_id_string
) {
147 ERR("An ID string is expected");
152 enum lttng_tracker_id_status status
;
153 /* Empty `ID string means all IDs */
154 id_list
= alloc_id_list(1);
156 ERR("Out of memory");
161 id_list
->array
[0] = lttng_tracker_id_create();
162 if (id_list
->array
[0] == NULL
) {
163 ERR("Out of memory");
168 status
= lttng_tracker_id_set_all(id_list
->array
[0]);
169 if (status
!= LTTNG_TRACKER_ID_STATUS_OK
) {
170 ERR("Invalid value for tracker id");
177 id_string
= strdup(_id_string
);
179 ERR("Out of memory");
185 one_id_str
= strtok_r(id_string
, ",", &iter
);
186 while (one_id_str
!= NULL
) {
189 if (isdigit(one_id_str
[0])) {
191 v
= strtoul(one_id_str
, &endptr
, 10);
192 if ((v
== 0 && errno
== EINVAL
) ||
193 (v
== ULONG_MAX
&& errno
== ERANGE
) ||
194 (*one_id_str
!= '\0' &&
196 ERR("Error parsing ID %s", one_id_str
);
201 if ((long) v
> INT_MAX
|| (int) v
< 0) {
202 ERR("Invalid ID value %ld", (long) v
);
210 one_id_str
= strtok_r(NULL
, ",", &iter
);
213 ERR("Fatal error occurred when parsing pid string");
219 /* Identity of delimiter has been lost in first pass. */
220 id_string
= strdup(_id_string
);
222 ERR("Out of memory");
228 id_list
= alloc_id_list(count
);
230 ERR("Out of memory");
235 /* Reparse string and populate the id list. */
237 one_id_str
= strtok_r(id_string
, ",", &iter
);
238 while (one_id_str
!= NULL
) {
239 enum lttng_tracker_id_status status
;
240 struct lttng_tracker_id
*item
;
241 item
= lttng_tracker_id_create();
243 ERR("Out of memory");
248 id_list
->array
[count
++] = item
;
249 if (isdigit(one_id_str
[0])) {
252 v
= strtoul(one_id_str
, NULL
, 10);
253 status
= lttng_tracker_id_set_value(item
, (int) v
);
254 if (status
== LTTNG_TRACKER_ID_STATUS_INVALID
) {
255 ERR("Invalid value");
260 status
= lttng_tracker_id_set_string(item
, one_id_str
);
261 if (status
== LTTNG_TRACKER_ID_STATUS_INVALID
) {
262 ERR("Failed to set ID string");
269 one_id_str
= strtok_r(NULL
, ",", &iter
);
279 free_id_list(id_list
);
285 static const char *get_tracker_str(enum lttng_tracker_type tracker_type
)
287 switch (tracker_type
) {
288 case LTTNG_TRACKER_PID
:
290 case LTTNG_TRACKER_VPID
:
292 case LTTNG_TRACKER_UID
:
294 case LTTNG_TRACKER_VUID
:
296 case LTTNG_TRACKER_GID
:
298 case LTTNG_TRACKER_VGID
:
306 static int ust_tracker_type_support(enum lttng_tracker_type
*tracker_type
)
310 switch (*tracker_type
) {
311 case LTTNG_TRACKER_PID
:
312 *tracker_type
= LTTNG_TRACKER_VPID
;
315 case LTTNG_TRACKER_VPID
:
316 case LTTNG_TRACKER_VUID
:
317 case LTTNG_TRACKER_VGID
:
320 case LTTNG_TRACKER_UID
:
321 case LTTNG_TRACKER_GID
:
322 ERR("The %s tracker is invalid for UST domain.",
323 get_tracker_str(*tracker_type
));
334 static enum cmd_error_code
track_untrack_id(enum cmd_type cmd_type
,
336 const char *session_name
,
337 const char *id_string
,
339 struct mi_writer
*writer
,
340 enum lttng_tracker_type tracker_type
)
342 int ret
, success
= 1 , i
;
343 enum cmd_error_code retval
= CMD_SUCCESS
;
344 struct id_list
*id_list
= NULL
;
345 struct lttng_domain dom
;
346 struct lttng_handle
*handle
= NULL
;
347 int (*cmd_func
)(struct lttng_handle
*handle
,
348 enum lttng_tracker_type tracker_type
,
349 const struct lttng_tracker_id
*id
);
350 const char *tracker_str
;
354 cmd_func
= lttng_track_id
;
357 cmd_func
= lttng_untrack_id
;
360 ERR("Unknown command");
364 memset(&dom
, 0, sizeof(dom
));
366 dom
.type
= LTTNG_DOMAIN_KERNEL
;
367 } else if (opt_userspace
) {
368 dom
.type
= LTTNG_DOMAIN_UST
;
369 ret
= ust_tracker_type_support(&tracker_type
);
371 ERR("Invalid parameter");
376 /* Checked by the caller. */
379 tracker_str
= get_tracker_str(tracker_type
);
381 ERR("Unknown tracker type");
385 ret
= parse_id_string(id_string
, all
, &id_list
, tracker_type
);
386 if (ret
!= CMD_SUCCESS
) {
387 ERR("Error parsing %s string", tracker_str
);
392 handle
= lttng_create_handle(session_name
, &dom
);
393 if (handle
== NULL
) {
399 /* Open tracker_id and targets elements */
400 ret
= mi_lttng_id_tracker_open(writer
, tracker_type
);
406 for (i
= 0; i
< id_list
->nr
; i
++) {
407 struct lttng_tracker_id
*item
= id_list
->array
[i
];
408 enum lttng_tracker_id_type type
=
409 lttng_tracker_id_get_type(item
);
410 enum lttng_tracker_id_status status
=
411 LTTNG_TRACKER_ID_STATUS_OK
;
413 const char *value_string
;
417 /* Nothing to check */
420 status
= lttng_tracker_id_get_value(item
, &value
);
422 case LTTNG_ID_STRING
:
423 status
= lttng_tracker_id_get_string(
424 item
, &value_string
);
431 if (status
!= LTTNG_TRACKER_ID_STATUS_OK
) {
432 ERR("Tracker id object is in an invalid state");
439 DBG("%s all IDs", cmd_str
);
442 DBG("%s ID %d", cmd_str
, value
);
444 case LTTNG_ID_STRING
:
445 DBG("%s ID '%s'", cmd_str
, value_string
);
452 ret
= cmd_func(handle
, tracker_type
, item
);
454 const char *msg
= NULL
;
457 case LTTNG_ERR_ID_TRACKED
:
458 msg
= "already tracked";
460 retval
= CMD_SUCCESS
;
462 case LTTNG_ERR_ID_NOT_TRACKED
:
463 msg
= "already not tracked";
465 retval
= CMD_SUCCESS
;
468 ERR("%s", lttng_strerror(ret
));
476 WARN("All %ss %s in session %s",
481 WARN("%s %i %s in session %s",
482 tracker_str
, value
, msg
,
485 case LTTNG_ID_STRING
:
486 WARN("%s '%s' %s in session %s",
499 MSG("All %ss %sed in session %s", tracker_str
,
500 cmd_str
, session_name
);
503 MSG("%s %i %sed in session %s", tracker_str
,
504 value
, cmd_str
, session_name
);
506 case LTTNG_ID_STRING
:
507 MSG("%s '%s' %sed in session %s", tracker_str
,
508 value_string
, cmd_str
,
520 ret
= mi_lttng_id_target(writer
, tracker_type
, item
, 1);
526 ret
= mi_lttng_writer_write_element_bool(writer
,
527 mi_lttng_element_success
, success
);
533 ret
= mi_lttng_writer_close_element(writer
);
542 /* Close targets and tracker_id elements */
543 ret
= mi_lttng_close_multi_element(writer
, 2);
552 lttng_destroy_handle(handle
);
554 free_id_list(id_list
);
559 const char *get_mi_element_command(enum cmd_type cmd_type
)
563 return mi_lttng_element_command_track
;
565 return mi_lttng_element_command_untrack
;
571 static void print_err_duplicate(const char *type
)
573 ERR("The --%s option can only be used once. A list of comma-separated values can be specified.",
578 * Add/remove tracker to/from session.
581 int cmd_track_untrack(enum cmd_type cmd_type
, const char *cmd_str
,
582 int argc
, const char **argv
, const char *help_msg
)
584 int opt
, ret
= 0, success
= 1;
585 bool opt_all_present
= false;
586 enum cmd_error_code command_ret
= CMD_SUCCESS
;
587 static poptContext pc
;
588 char *session_name
= NULL
;
589 const char *leftover
= NULL
;
590 struct mi_writer
*writer
= NULL
;
593 command_ret
= CMD_ERROR
;
597 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
598 poptReadDefaultConfig(pc
, 0);
600 while ((opt
= poptGetNextOpt(pc
)) != -1) {
605 case OPT_LIST_OPTIONS
:
606 list_cmd_options(stdout
, long_options
);
612 print_err_duplicate("pid");
613 command_ret
= CMD_ERROR
;
617 type_state
= STATE_PID
;
621 print_err_duplicate("vpid");
622 command_ret
= CMD_ERROR
;
626 type_state
= STATE_VPID
;
630 print_err_duplicate("uid");
631 command_ret
= CMD_ERROR
;
635 type_state
= STATE_UID
;
639 print_err_duplicate("vuid");
640 command_ret
= CMD_ERROR
;
644 type_state
= STATE_VUID
;
648 print_err_duplicate("gid");
649 command_ret
= CMD_ERROR
;
653 type_state
= STATE_GID
;
657 print_err_duplicate("vgid");
658 command_ret
= CMD_ERROR
;
662 type_state
= STATE_VGID
;
665 opt_all_present
= true;
668 command_ret
= CMD_UNDEFINED
;
673 ret
= print_missing_or_multiple_domains(opt_kernel
+ opt_userspace
);
675 command_ret
= CMD_ERROR
;
680 * If the `--all` option is present set the appropriate tracker's `all`
683 if (opt_all_present
) {
684 switch (type_state
) {
704 command_ret
= CMD_ERROR
;
709 if (!opt_session_name
) {
710 session_name
= get_session_name();
711 if (session_name
== NULL
) {
712 command_ret
= CMD_ERROR
;
716 session_name
= opt_session_name
;
719 leftover
= poptGetArg(pc
);
721 ERR("Unknown argument: %s", leftover
);
722 command_ret
= CMD_ERROR
;
728 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
730 command_ret
= CMD_ERROR
;
736 /* Open command element */
737 ret
= mi_lttng_writer_command_open(writer
,
738 get_mi_element_command(cmd_type
));
740 command_ret
= CMD_ERROR
;
744 /* Open output element */
745 ret
= mi_lttng_writer_open_element(writer
,
746 mi_lttng_element_command_output
);
748 command_ret
= CMD_ERROR
;
752 ret
= mi_lttng_trackers_open(writer
);
759 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
760 opt_pid
.string
, opt_pid
.all
, writer
,
762 if (command_ret
!= CMD_SUCCESS
) {
767 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
768 opt_vpid
.string
, opt_vpid
.all
, writer
,
770 if (command_ret
!= CMD_SUCCESS
) {
775 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
776 opt_uid
.string
, opt_uid
.all
, writer
,
778 if (command_ret
!= CMD_SUCCESS
) {
783 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
784 opt_vuid
.string
, opt_vuid
.all
, writer
,
786 if (command_ret
!= CMD_SUCCESS
) {
791 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
792 opt_gid
.string
, opt_gid
.all
, writer
,
794 if (command_ret
!= CMD_SUCCESS
) {
799 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
800 opt_vgid
.string
, opt_vgid
.all
, writer
,
802 if (command_ret
!= CMD_SUCCESS
) {
809 /* Close trackers and output elements */
810 ret
= mi_lttng_close_multi_element(writer
, 2);
812 command_ret
= CMD_ERROR
;
817 ret
= mi_lttng_writer_write_element_bool(writer
,
818 mi_lttng_element_command_success
, success
);
820 command_ret
= CMD_ERROR
;
824 /* Command element close */
825 ret
= mi_lttng_writer_command_close(writer
);
827 command_ret
= CMD_ERROR
;
833 if (!opt_session_name
) {
838 if (writer
&& mi_lttng_writer_destroy(writer
)) {
839 /* Preserve original error code */
840 command_ret
= CMD_ERROR
;
844 return (int) command_ret
;
847 int cmd_track(int argc
, const char **argv
)
849 static const char *help_msg
=
850 #ifdef LTTNG_EMBED_HELP
851 #include <lttng-track.1.h>
857 return cmd_track_untrack(CMD_TRACK
, "track", argc
, argv
, help_msg
);
860 int cmd_untrack(int argc
, const char **argv
)
862 static const char *help_msg
=
863 #ifdef LTTNG_EMBED_HELP
864 #include <lttng-untrack.1.h>
870 return cmd_track_untrack(CMD_UNTRACK
, "untrack", argc
, argv
, help_msg
);