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
];
132 lttng_tracker_id_destroy(item
);
137 static int parse_id_string(const char *_id_string
,
139 struct id_list
**_id_list
,
140 enum lttng_tracker_type tracker_type
)
142 const char *one_id_str
;
144 int retval
= CMD_SUCCESS
;
146 struct id_list
*id_list
= NULL
;
147 char *id_string
= NULL
;
150 if (all
&& _id_string
) {
151 ERR("An empty ID string is expected with --all");
155 if (!all
&& !_id_string
) {
156 ERR("An ID string is expected");
161 enum lttng_tracker_id_status status
;
162 /* Empty `ID string means all IDs */
163 id_list
= alloc_id_list(1);
165 ERR("Out of memory");
170 id_list
->array
[0] = lttng_tracker_id_create();
171 if (id_list
->array
[0] == NULL
) {
172 ERR("Out of memory");
177 status
= lttng_tracker_id_set_all(id_list
->array
[0]);
178 if (status
!= LTTNG_TRACKER_ID_STATUS_OK
) {
179 ERR("Invalid value for tracker id");
186 id_string
= strdup(_id_string
);
188 ERR("Out of memory");
194 one_id_str
= strtok_r(id_string
, ",", &iter
);
195 while (one_id_str
!= NULL
) {
198 if (isdigit(one_id_str
[0])) {
200 v
= strtoul(one_id_str
, &endptr
, 10);
201 if ((v
== 0 && errno
== EINVAL
) ||
202 (v
== ULONG_MAX
&& errno
== ERANGE
) ||
203 (*one_id_str
!= '\0' &&
205 ERR("Error parsing ID %s", one_id_str
);
210 if ((long) v
> INT_MAX
|| (int) v
< 0) {
211 ERR("Invalid ID value %ld", (long) v
);
219 one_id_str
= strtok_r(NULL
, ",", &iter
);
222 ERR("Fatal error occurred when parsing pid string");
228 /* Identity of delimiter has been lost in first pass. */
229 id_string
= strdup(_id_string
);
231 ERR("Out of memory");
237 id_list
= alloc_id_list(count
);
239 ERR("Out of memory");
244 /* Reparse string and populate the id list. */
246 one_id_str
= strtok_r(id_string
, ",", &iter
);
247 while (one_id_str
!= NULL
) {
248 enum lttng_tracker_id_status status
;
249 struct lttng_tracker_id
*item
;
250 item
= lttng_tracker_id_create();
252 ERR("Out of memory");
257 id_list
->array
[count
++] = item
;
258 if (isdigit(one_id_str
[0])) {
261 v
= strtoul(one_id_str
, NULL
, 10);
262 status
= lttng_tracker_id_set_value(item
, (int) v
);
263 if (status
== LTTNG_TRACKER_ID_STATUS_INVALID
) {
264 ERR("Invalid value");
269 status
= lttng_tracker_id_set_string(item
, one_id_str
);
270 if (status
== LTTNG_TRACKER_ID_STATUS_INVALID
) {
271 ERR("Failed to set ID string");
278 one_id_str
= strtok_r(NULL
, ",", &iter
);
288 free_id_list(id_list
);
294 static const char *get_tracker_str(enum lttng_tracker_type tracker_type
)
296 switch (tracker_type
) {
297 case LTTNG_TRACKER_PID
:
299 case LTTNG_TRACKER_VPID
:
301 case LTTNG_TRACKER_UID
:
303 case LTTNG_TRACKER_VUID
:
305 case LTTNG_TRACKER_GID
:
307 case LTTNG_TRACKER_VGID
:
315 static int ust_tracker_type_support(enum lttng_tracker_type
*tracker_type
)
319 switch (*tracker_type
) {
320 case LTTNG_TRACKER_PID
:
321 *tracker_type
= LTTNG_TRACKER_VPID
;
324 case LTTNG_TRACKER_VPID
:
325 case LTTNG_TRACKER_VUID
:
326 case LTTNG_TRACKER_VGID
:
329 case LTTNG_TRACKER_UID
:
330 case LTTNG_TRACKER_GID
:
331 ERR("The %s tracker is invalid for UST domain.",
332 get_tracker_str(*tracker_type
));
343 static enum cmd_error_code
track_untrack_id(enum cmd_type cmd_type
,
345 const char *session_name
,
346 const char *id_string
,
348 struct mi_writer
*writer
,
349 enum lttng_tracker_type tracker_type
)
351 int ret
, success
= 1 , i
;
352 enum cmd_error_code retval
= CMD_SUCCESS
;
353 struct id_list
*id_list
= NULL
;
354 struct lttng_domain dom
;
355 struct lttng_handle
*handle
= NULL
;
356 int (*cmd_func
)(struct lttng_handle
*handle
,
357 enum lttng_tracker_type tracker_type
,
358 const struct lttng_tracker_id
*id
);
359 const char *tracker_str
;
363 cmd_func
= lttng_track_id
;
366 cmd_func
= lttng_untrack_id
;
369 ERR("Unknown command");
373 memset(&dom
, 0, sizeof(dom
));
375 dom
.type
= LTTNG_DOMAIN_KERNEL
;
376 } else if (opt_userspace
) {
377 dom
.type
= LTTNG_DOMAIN_UST
;
378 ret
= ust_tracker_type_support(&tracker_type
);
380 ERR("Invalid parameter");
385 /* Checked by the caller. */
388 tracker_str
= get_tracker_str(tracker_type
);
390 ERR("Unknown tracker type");
394 ret
= parse_id_string(id_string
, all
, &id_list
, tracker_type
);
395 if (ret
!= CMD_SUCCESS
) {
396 ERR("Error parsing %s string", tracker_str
);
401 handle
= lttng_create_handle(session_name
, &dom
);
402 if (handle
== NULL
) {
408 /* Open tracker_id and targets elements */
409 ret
= mi_lttng_id_tracker_open(writer
, tracker_type
);
415 for (i
= 0; i
< id_list
->nr
; i
++) {
416 struct lttng_tracker_id
*item
= id_list
->array
[i
];
417 enum lttng_tracker_id_type type
=
418 lttng_tracker_id_get_type(item
);
419 enum lttng_tracker_id_status status
=
420 LTTNG_TRACKER_ID_STATUS_OK
;
422 const char *value_string
;
426 /* Nothing to check */
429 status
= lttng_tracker_id_get_value(item
, &value
);
431 case LTTNG_ID_STRING
:
432 status
= lttng_tracker_id_get_string(
433 item
, &value_string
);
440 if (status
!= LTTNG_TRACKER_ID_STATUS_OK
) {
441 ERR("Tracker id object is in an invalid state");
448 DBG("%s all IDs", cmd_str
);
451 DBG("%s ID %d", cmd_str
, value
);
453 case LTTNG_ID_STRING
:
454 DBG("%s ID '%s'", cmd_str
, value_string
);
461 ret
= cmd_func(handle
, tracker_type
, item
);
466 case LTTNG_ERR_ID_TRACKED
:
467 msg
= "already tracked";
469 retval
= CMD_SUCCESS
;
471 case LTTNG_ERR_ID_NOT_TRACKED
:
472 msg
= "already not tracked";
474 retval
= CMD_SUCCESS
;
477 ERR("%s", lttng_strerror(ret
));
485 WARN("All %ss %s in session %s",
490 WARN("%s %i %s in session %s",
491 tracker_str
, value
, msg
,
494 case LTTNG_ID_STRING
:
495 WARN("%s '%s' %s in session %s",
508 MSG("All %ss %sed in session %s", tracker_str
,
509 cmd_str
, session_name
);
512 MSG("%s %i %sed in session %s", tracker_str
,
513 value
, cmd_str
, session_name
);
515 case LTTNG_ID_STRING
:
516 MSG("%s '%s' %sed in session %s", tracker_str
,
517 value_string
, cmd_str
,
529 ret
= mi_lttng_id_target(writer
, tracker_type
, item
, 1);
535 ret
= mi_lttng_writer_write_element_bool(writer
,
536 mi_lttng_element_success
, success
);
542 ret
= mi_lttng_writer_close_element(writer
);
551 /* Close targets and tracker_id elements */
552 ret
= mi_lttng_close_multi_element(writer
, 2);
561 lttng_destroy_handle(handle
);
563 free_id_list(id_list
);
568 const char *get_mi_element_command(enum cmd_type cmd_type
)
572 return mi_lttng_element_command_track
;
574 return mi_lttng_element_command_untrack
;
580 static void print_err_duplicate(const char *type
)
582 ERR("The --%s option can only be used once. A list of comma-separated values can be specified.",
587 * Add/remove tracker to/from session.
590 int cmd_track_untrack(enum cmd_type cmd_type
, const char *cmd_str
,
591 int argc
, const char **argv
, const char *help_msg
)
593 int opt
, ret
= 0, success
= 1;
594 enum cmd_error_code command_ret
= CMD_SUCCESS
;
595 static poptContext pc
;
596 char *session_name
= NULL
;
597 const char *leftover
= NULL
;
598 struct mi_writer
*writer
= NULL
;
601 command_ret
= CMD_ERROR
;
605 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
606 poptReadDefaultConfig(pc
, 0);
608 while ((opt
= poptGetNextOpt(pc
)) != -1) {
613 case OPT_LIST_OPTIONS
:
614 list_cmd_options(stdout
, long_options
);
620 print_err_duplicate("pid");
621 command_ret
= CMD_ERROR
;
625 type_state
= STATE_PID
;
629 print_err_duplicate("vpid");
630 command_ret
= CMD_ERROR
;
634 type_state
= STATE_VPID
;
638 print_err_duplicate("uid");
639 command_ret
= CMD_ERROR
;
643 type_state
= STATE_UID
;
647 print_err_duplicate("vuid");
648 command_ret
= CMD_ERROR
;
652 type_state
= STATE_VUID
;
656 print_err_duplicate("gid");
657 command_ret
= CMD_ERROR
;
661 type_state
= STATE_GID
;
665 print_err_duplicate("vgid");
666 command_ret
= CMD_ERROR
;
670 type_state
= STATE_VGID
;
673 switch (type_state
) {
693 command_ret
= CMD_ERROR
;
698 command_ret
= CMD_UNDEFINED
;
703 ret
= print_missing_or_multiple_domains(opt_kernel
+ opt_userspace
);
705 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
);
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
);