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 int ust_tracker_type_support(enum lttng_tracker_type
*tracker_type
)
293 switch (*tracker_type
) {
294 case LTTNG_TRACKER_PID
:
295 *tracker_type
= LTTNG_TRACKER_VPID
;
298 case LTTNG_TRACKER_VPID
:
299 case LTTNG_TRACKER_VUID
:
300 case LTTNG_TRACKER_VGID
:
303 case LTTNG_TRACKER_UID
:
304 case LTTNG_TRACKER_GID
:
305 ERR("The %s tracker is invalid for UST domain.",
306 get_tracker_str(*tracker_type
));
317 static enum cmd_error_code
track_untrack_id(enum cmd_type cmd_type
,
319 const char *session_name
,
320 const char *id_string
,
322 struct mi_writer
*writer
,
323 enum lttng_tracker_type tracker_type
)
325 int ret
, success
= 1 , i
;
326 enum cmd_error_code retval
= CMD_SUCCESS
;
327 struct id_list
*id_list
= NULL
;
328 struct lttng_domain dom
;
329 struct lttng_handle
*handle
= NULL
;
330 int (*cmd_func
)(struct lttng_handle
*handle
,
331 enum lttng_tracker_type tracker_type
,
332 const struct lttng_tracker_id
*id
);
333 const char *tracker_str
;
337 cmd_func
= lttng_track_id
;
340 cmd_func
= lttng_untrack_id
;
343 ERR("Unknown command");
347 memset(&dom
, 0, sizeof(dom
));
349 dom
.type
= LTTNG_DOMAIN_KERNEL
;
350 } else if (opt_userspace
) {
351 dom
.type
= LTTNG_DOMAIN_UST
;
352 ret
= ust_tracker_type_support(&tracker_type
);
354 ERR("Invalid parameter");
359 /* Checked by the caller. */
362 tracker_str
= get_tracker_str(tracker_type
);
364 ERR("Unknown tracker type");
368 ret
= parse_id_string(id_string
, all
, &id_list
);
369 if (ret
!= CMD_SUCCESS
) {
370 ERR("Error parsing %s string", tracker_str
);
375 handle
= lttng_create_handle(session_name
, &dom
);
376 if (handle
== NULL
) {
382 /* Open tracker_id and targets elements */
383 ret
= mi_lttng_id_tracker_open(writer
, tracker_type
);
389 for (i
= 0; i
< id_list
->nr
; i
++) {
390 struct lttng_tracker_id
*item
= &id_list
->array
[i
];
392 switch (item
->type
) {
394 DBG("%s all IDs", cmd_str
);
397 DBG("%s ID %d", cmd_str
, item
->value
);
399 case LTTNG_ID_STRING
:
400 DBG("%s ID '%s'", cmd_str
, item
->string
);
406 ret
= cmd_func(handle
, tracker_type
, item
);
411 case LTTNG_ERR_ID_TRACKED
:
412 msg
= "already tracked";
414 retval
= CMD_SUCCESS
;
416 case LTTNG_ERR_ID_NOT_TRACKED
:
417 msg
= "already not tracked";
419 retval
= CMD_SUCCESS
;
422 ERR("%s", lttng_strerror(ret
));
428 switch (item
->type
) {
430 WARN("All %ss %s in session %s",
435 WARN("%s %i %s in session %s",
440 case LTTNG_ID_STRING
:
441 WARN("%s '%s' %s in session %s",
452 switch (item
->type
) {
454 MSG("All %ss %sed in session %s", tracker_str
,
455 cmd_str
, session_name
);
458 MSG("%s %i %sed in session %s", tracker_str
,
459 item
->value
, cmd_str
,
462 case LTTNG_ID_STRING
:
463 MSG("%s '%s' %sed in session %s", tracker_str
,
464 item
->string
, cmd_str
,
476 ret
= mi_lttng_id_target(writer
, tracker_type
, item
, 1);
482 ret
= mi_lttng_writer_write_element_bool(writer
,
483 mi_lttng_element_success
, success
);
489 ret
= mi_lttng_writer_close_element(writer
);
498 /* Close targets and tracker_id elements */
499 ret
= mi_lttng_close_multi_element(writer
, 2);
508 lttng_destroy_handle(handle
);
510 free_id_list(id_list
);
515 const char *get_mi_element_command(enum cmd_type cmd_type
)
519 return mi_lttng_element_command_track
;
521 return mi_lttng_element_command_untrack
;
527 static void print_err_duplicate(const char *type
)
529 ERR("The --%s option can only be used once. A list of comma-separated values can be specified.",
534 * Add/remove tracker to/from session.
537 int cmd_track_untrack(enum cmd_type cmd_type
, const char *cmd_str
,
538 int argc
, const char **argv
, const char *help_msg
)
541 enum cmd_error_code command_ret
= CMD_SUCCESS
;
543 static poptContext pc
;
544 char *session_name
= NULL
;
545 struct mi_writer
*writer
= NULL
;
548 command_ret
= CMD_ERROR
;
552 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
553 poptReadDefaultConfig(pc
, 0);
555 while ((opt
= poptGetNextOpt(pc
)) != -1) {
560 case OPT_LIST_OPTIONS
:
561 list_cmd_options(stdout
, long_options
);
567 print_err_duplicate("pid");
568 command_ret
= CMD_ERROR
;
572 type_state
= STATE_PID
;
576 print_err_duplicate("vpid");
577 command_ret
= CMD_ERROR
;
581 type_state
= STATE_VPID
;
585 print_err_duplicate("uid");
586 command_ret
= CMD_ERROR
;
590 type_state
= STATE_UID
;
594 print_err_duplicate("vuid");
595 command_ret
= CMD_ERROR
;
599 type_state
= STATE_VUID
;
603 print_err_duplicate("gid");
604 command_ret
= CMD_ERROR
;
608 type_state
= STATE_GID
;
612 print_err_duplicate("vgid");
613 command_ret
= CMD_ERROR
;
617 type_state
= STATE_VGID
;
620 switch (type_state
) {
640 command_ret
= CMD_ERROR
;
645 command_ret
= CMD_UNDEFINED
;
650 ret
= print_missing_or_multiple_domains(opt_kernel
+ opt_userspace
);
652 command_ret
= CMD_ERROR
;
656 if (!opt_session_name
) {
657 session_name
= get_session_name();
658 if (session_name
== NULL
) {
659 command_ret
= CMD_ERROR
;
663 session_name
= opt_session_name
;
668 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
670 command_ret
= CMD_ERROR
;
676 /* Open command element */
677 ret
= mi_lttng_writer_command_open(writer
,
678 get_mi_element_command(cmd_type
));
680 command_ret
= CMD_ERROR
;
684 /* Open output element */
685 ret
= mi_lttng_writer_open_element(writer
,
686 mi_lttng_element_command_output
);
688 command_ret
= CMD_ERROR
;
692 ret
= mi_lttng_trackers_open(writer
);
699 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
700 opt_pid
.string
, opt_pid
.all
, writer
,
702 if (command_ret
!= CMD_SUCCESS
) {
707 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
708 opt_vpid
.string
, opt_vpid
.all
, writer
,
710 if (command_ret
!= CMD_SUCCESS
) {
715 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
716 opt_uid
.string
, opt_uid
.all
, writer
,
718 if (command_ret
!= CMD_SUCCESS
) {
723 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
724 opt_vuid
.string
, opt_vuid
.all
, writer
,
726 if (command_ret
!= CMD_SUCCESS
) {
731 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
732 opt_gid
.string
, opt_gid
.all
, writer
,
734 if (command_ret
!= CMD_SUCCESS
) {
739 command_ret
= track_untrack_id(cmd_type
, cmd_str
, session_name
,
740 opt_vgid
.string
, opt_vgid
.all
, writer
,
742 if (command_ret
!= CMD_SUCCESS
) {
749 /* Close trackers and output elements */
750 ret
= mi_lttng_close_multi_element(writer
, 2);
752 command_ret
= CMD_ERROR
;
757 ret
= mi_lttng_writer_write_element_bool(writer
,
758 mi_lttng_element_command_success
, success
);
760 command_ret
= CMD_ERROR
;
764 /* Command element close */
765 ret
= mi_lttng_writer_command_close(writer
);
767 command_ret
= CMD_ERROR
;
773 if (!opt_session_name
) {
778 if (writer
&& mi_lttng_writer_destroy(writer
)) {
779 /* Preserve original error code */
780 command_ret
= CMD_ERROR
;
784 return (int) command_ret
;
787 int cmd_track(int argc
, const char **argv
)
789 static const char *help_msg
=
790 #ifdef LTTNG_EMBED_HELP
791 #include <lttng-track.1.h>
797 return cmd_track_untrack(CMD_TRACK
, "track", argc
, argv
, help_msg
);
800 int cmd_untrack(int argc
, const char **argv
)
802 static const char *help_msg
=
803 #ifdef LTTNG_EMBED_HELP
804 #include <lttng-untrack.1.h>
810 return cmd_track_untrack(CMD_UNTRACK
, "untrack", argc
, argv
, help_msg
);