2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <common/mi-lttng.h>
27 #include <lttng/constant.h>
29 #include "../command.h"
31 static int opt_userspace
;
32 static int opt_kernel
;
35 static int opt_python
;
36 static char *opt_channel
;
37 static int opt_domain
;
38 static int opt_fields
;
39 static int opt_syscall
;
41 const char *indent4
= " ";
42 const char *indent6
= " ";
43 const char *indent8
= " ";
51 static struct lttng_handle
*handle
;
52 static struct mi_writer
*writer
;
54 static struct poptOption long_options
[] = {
55 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
56 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
57 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
58 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
59 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
60 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
61 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
62 {"channel", 'c', POPT_ARG_STRING
, &opt_channel
, 0, 0, 0},
63 {"domain", 'd', POPT_ARG_VAL
, &opt_domain
, 1, 0, 0},
64 {"fields", 'f', POPT_ARG_VAL
, &opt_fields
, 1, 0, 0},
65 {"syscall", 'S', POPT_ARG_VAL
, &opt_syscall
, 1, 0, 0},
66 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
71 * Get command line from /proc for a specific pid.
73 * On success, return an allocated string pointer to the proc cmdline.
74 * On error, return NULL.
76 static char *get_cmdline_by_pid(pid_t pid
)
81 /* Can't go bigger than /proc/LTTNG_MAX_PID/cmdline */
82 char path
[sizeof("/proc//cmdline") + sizeof(LTTNG_MAX_PID_STR
) - 1];
84 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
85 fp
= fopen(path
, "r");
90 /* Caller must free() *cmdline */
91 cmdline
= zmalloc(PATH_MAX
);
93 PERROR("malloc cmdline");
96 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
98 PERROR("fread proc list");
109 const char *active_string(int value
)
112 case 0: return "inactive";
113 case 1: return "active";
115 default: return NULL
;
119 static const char *snapshot_string(int value
)
130 const char *enabled_string(int value
)
133 case 0: return " [disabled]";
134 case 1: return " [enabled]";
136 default: return NULL
;
141 const char *safe_string(const char *str
)
143 return str
? str
: "";
146 static const char *logleveltype_string(enum lttng_loglevel_type value
)
149 case LTTNG_EVENT_LOGLEVEL_ALL
:
151 case LTTNG_EVENT_LOGLEVEL_RANGE
:
153 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
156 return " <<TYPE UNKN>>";
160 static const char *bitness_event(enum lttng_event_flag flags
)
162 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_32
) {
163 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
164 return " [32/64-bit]";
168 } else if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
176 * Get exclusion names message for a single event.
178 * Returned pointer must be freed by caller. Returns NULL on error.
180 static char *get_exclusion_names_msg(struct lttng_event
*event
)
184 char *exclusion_msg
= NULL
;
187 const char * const exclusion_fmt
= " [exclusions: ";
188 const size_t exclusion_fmt_len
= strlen(exclusion_fmt
);
190 exclusion_count
= lttng_event_get_exclusion_name_count(event
);
191 if (exclusion_count
< 0) {
193 } else if (exclusion_count
== 0) {
195 * No exclusions: return copy of empty string so that
196 * it can be freed by caller.
198 exclusion_msg
= strdup("");
203 * exclusion_msg's size is bounded by the exclusion_fmt string,
204 * a comma per entry, the entry count (fixed-size), a closing
205 * bracket, and a trailing \0.
207 exclusion_msg
= malloc(exclusion_count
+
208 exclusion_count
* LTTNG_SYMBOL_NAME_LEN
+
209 exclusion_fmt_len
+ 1);
210 if (!exclusion_msg
) {
214 at
= strcpy(exclusion_msg
, exclusion_fmt
) + exclusion_fmt_len
;
215 for (i
= 0; i
< exclusion_count
; ++i
) {
218 /* Append comma between exclusion names */
224 ret
= lttng_event_get_exclusion_name(event
, i
, &name
);
226 /* Prints '?' on local error; should never happen */
232 /* Append exclusion name */
233 at
+= sprintf(at
, "%s", name
);
236 /* This also puts a final '\0' at the end of exclusion_msg */
240 return exclusion_msg
;
244 * Pretty print single event.
246 static void print_events(struct lttng_event
*event
)
249 const char *filter_str
;
250 char *filter_msg
= NULL
;
251 char *exclusion_msg
= NULL
;
253 ret
= lttng_event_get_filter_expression(event
, &filter_str
);
256 filter_msg
= strdup(" [failed to retrieve filter]");
257 } else if (filter_str
) {
258 const char * const filter_fmt
= " [filter: '%s']";
260 filter_msg
= malloc(strlen(filter_str
) +
261 strlen(filter_fmt
) + 1);
263 sprintf(filter_msg
, filter_fmt
,
268 exclusion_msg
= get_exclusion_names_msg(event
);
269 if (!exclusion_msg
) {
270 exclusion_msg
= strdup(" [failed to retrieve exclusions]");
273 switch (event
->type
) {
274 case LTTNG_EVENT_TRACEPOINT
:
276 if (event
->loglevel
!= -1) {
277 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
280 logleveltype_string(event
->loglevel_type
),
281 mi_lttng_loglevel_string(event
->loglevel
, handle
->domain
.type
),
283 enabled_string(event
->enabled
),
284 safe_string(exclusion_msg
),
285 safe_string(filter_msg
));
287 MSG("%s%s (type: tracepoint)%s%s%s",
290 enabled_string(event
->enabled
),
291 safe_string(exclusion_msg
),
292 safe_string(filter_msg
));
296 case LTTNG_EVENT_FUNCTION
:
297 MSG("%s%s (type: function)%s%s", indent6
,
298 event
->name
, enabled_string(event
->enabled
),
299 safe_string(filter_msg
));
300 if (event
->attr
.probe
.addr
!= 0) {
301 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
303 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
304 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
307 case LTTNG_EVENT_PROBE
:
308 MSG("%s%s (type: probe)%s%s", indent6
,
309 event
->name
, enabled_string(event
->enabled
),
310 safe_string(filter_msg
));
311 if (event
->attr
.probe
.addr
!= 0) {
312 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
314 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
315 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
318 case LTTNG_EVENT_FUNCTION_ENTRY
:
319 MSG("%s%s (type: function)%s%s", indent6
,
320 event
->name
, enabled_string(event
->enabled
),
321 safe_string(filter_msg
));
322 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
324 case LTTNG_EVENT_SYSCALL
:
325 MSG("%s%s%s%s%s%s", indent6
, event
->name
,
326 (opt_syscall
? "" : " (type:syscall)"),
327 enabled_string(event
->enabled
),
328 bitness_event(event
->flags
),
329 safe_string(filter_msg
));
331 case LTTNG_EVENT_NOOP
:
332 MSG("%s (type: noop)%s%s", indent6
,
333 enabled_string(event
->enabled
),
334 safe_string(filter_msg
));
336 case LTTNG_EVENT_ALL
:
337 /* We should never have "all" events in list. */
346 static const char *field_type(struct lttng_event_field
*field
)
348 switch(field
->type
) {
349 case LTTNG_EVENT_FIELD_INTEGER
:
351 case LTTNG_EVENT_FIELD_ENUM
:
353 case LTTNG_EVENT_FIELD_FLOAT
:
355 case LTTNG_EVENT_FIELD_STRING
:
357 case LTTNG_EVENT_FIELD_OTHER
:
358 default: /* fall-through */
364 * Pretty print single event fields.
366 static void print_event_field(struct lttng_event_field
*field
)
368 if (!field
->field_name
[0]) {
371 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
372 field_type(field
), field
->nowrite
? " [no write]" : "");
377 * Jul and ust event listing
379 static int mi_list_agent_ust_events(struct lttng_event
*events
, int count
,
380 struct lttng_domain
*domain
)
384 char *cmdline
= NULL
;
385 int pid_element_open
= 0;
387 /* Open domains element */
388 ret
= mi_lttng_domains_open(writer
);
394 ret
= mi_lttng_domain(writer
, domain
, 1);
399 /* Open pids element element */
400 ret
= mi_lttng_pids_open(writer
);
405 for (i
= 0; i
< count
; i
++) {
406 if (cur_pid
!= events
[i
].pid
) {
407 if (pid_element_open
) {
408 /* Close the previous events and pid element */
409 ret
= mi_lttng_close_multi_element(writer
, 2);
413 pid_element_open
= 0;
416 cur_pid
= events
[i
].pid
;
417 cmdline
= get_cmdline_by_pid(cur_pid
);
423 if (!pid_element_open
) {
424 /* Open and write a pid element */
425 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
430 /* Open events element */
431 ret
= mi_lttng_events_open(writer
);
436 pid_element_open
= 1;
442 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
449 ret
= mi_lttng_writer_close_element(writer
);
454 /* Close domain, domains */
455 ret
= mi_lttng_close_multi_element(writer
, 2);
463 static int list_agent_events(void)
465 int i
, size
, ret
= CMD_SUCCESS
;
466 struct lttng_domain domain
;
467 struct lttng_handle
*handle
= NULL
;
468 struct lttng_event
*event_list
= NULL
;
470 char *cmdline
= NULL
;
471 const char *agent_domain_str
;
473 memset(&domain
, 0, sizeof(domain
));
475 domain
.type
= LTTNG_DOMAIN_JUL
;
476 } else if (opt_log4j
) {
477 domain
.type
= LTTNG_DOMAIN_LOG4J
;
478 } else if (opt_python
) {
479 domain
.type
= LTTNG_DOMAIN_PYTHON
;
481 ERR("Invalid agent domain selected.");
486 agent_domain_str
= get_domain_str(domain
.type
);
488 DBG("Getting %s tracing events", agent_domain_str
);
490 handle
= lttng_create_handle(NULL
, &domain
);
491 if (handle
== NULL
) {
496 size
= lttng_list_tracepoints(handle
, &event_list
);
498 ERR("Unable to list %s events: %s", agent_domain_str
,
499 lttng_strerror(size
));
506 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
513 MSG("%s events (Logger name):\n-------------------------",
520 for (i
= 0; i
< size
; i
++) {
521 if (cur_pid
!= event_list
[i
].pid
) {
522 cur_pid
= event_list
[i
].pid
;
523 cmdline
= get_cmdline_by_pid(cur_pid
);
524 if (cmdline
== NULL
) {
528 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
531 MSG("%s- %s", indent6
, event_list
[i
].name
);
540 lttng_destroy_handle(handle
);
545 * Ask session daemon for all user space tracepoints available.
547 static int list_ust_events(void)
549 int i
, size
, ret
= CMD_SUCCESS
;
550 struct lttng_domain domain
;
551 struct lttng_handle
*handle
;
552 struct lttng_event
*event_list
= NULL
;
554 char *cmdline
= NULL
;
556 memset(&domain
, 0, sizeof(domain
));
558 DBG("Getting UST tracing events");
560 domain
.type
= LTTNG_DOMAIN_UST
;
562 handle
= lttng_create_handle(NULL
, &domain
);
563 if (handle
== NULL
) {
568 size
= lttng_list_tracepoints(handle
, &event_list
);
570 ERR("Unable to list UST events: %s", lttng_strerror(size
));
577 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
580 MSG("UST events:\n-------------");
586 for (i
= 0; i
< size
; i
++) {
587 if (cur_pid
!= event_list
[i
].pid
) {
588 cur_pid
= event_list
[i
].pid
;
589 cmdline
= get_cmdline_by_pid(cur_pid
);
590 if (cmdline
== NULL
) {
594 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
597 print_events(&event_list
[i
]);
606 lttng_destroy_handle(handle
);
612 * List all ust event with their fields
614 static int mi_list_ust_event_fields(struct lttng_event_field
*fields
, int count
,
615 struct lttng_domain
*domain
)
619 char *cmdline
= NULL
;
620 int pid_element_open
= 0;
621 int event_element_open
= 0;
622 struct lttng_event cur_event
;
624 memset(&cur_event
, 0, sizeof(cur_event
));
626 /* Open domains element */
627 ret
= mi_lttng_domains_open(writer
);
633 ret
= mi_lttng_domain(writer
, domain
, 1);
638 /* Open pids element */
639 ret
= mi_lttng_pids_open(writer
);
644 for (i
= 0; i
< count
; i
++) {
645 if (cur_pid
!= fields
[i
].event
.pid
) {
646 if (pid_element_open
) {
647 if (event_element_open
) {
648 /* Close the previous field element and event. */
649 ret
= mi_lttng_close_multi_element(writer
, 2);
653 event_element_open
= 0;
655 /* Close the previous events, pid element */
656 ret
= mi_lttng_close_multi_element(writer
, 2);
660 pid_element_open
= 0;
663 cur_pid
= fields
[i
].event
.pid
;
664 cmdline
= get_cmdline_by_pid(cur_pid
);
665 if (!pid_element_open
) {
666 /* Open and write a pid element */
667 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
672 /* Open events element */
673 ret
= mi_lttng_events_open(writer
);
677 pid_element_open
= 1;
680 /* Wipe current event since we are about to print a new PID. */
681 memset(&cur_event
, 0, sizeof(cur_event
));
684 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
685 if (event_element_open
) {
686 /* Close the previous fields element and the previous event */
687 ret
= mi_lttng_close_multi_element(writer
, 2);
691 event_element_open
= 0;
694 memcpy(&cur_event
, &fields
[i
].event
,
697 if (!event_element_open
) {
698 /* Open and write the event */
699 ret
= mi_lttng_event(writer
, &cur_event
, 1,
700 handle
->domain
.type
);
705 /* Open a fields element */
706 ret
= mi_lttng_event_fields_open(writer
);
710 event_element_open
= 1;
714 /* Print the event_field */
715 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
721 /* Close pid, domain, domains */
722 ret
= mi_lttng_close_multi_element(writer
, 3);
731 * Ask session daemon for all user space tracepoint fields available.
733 static int list_ust_event_fields(void)
735 int i
, size
, ret
= CMD_SUCCESS
;
736 struct lttng_domain domain
;
737 struct lttng_handle
*handle
;
738 struct lttng_event_field
*event_field_list
;
740 char *cmdline
= NULL
;
742 struct lttng_event cur_event
;
744 memset(&domain
, 0, sizeof(domain
));
745 memset(&cur_event
, 0, sizeof(cur_event
));
747 DBG("Getting UST tracing event fields");
749 domain
.type
= LTTNG_DOMAIN_UST
;
751 handle
= lttng_create_handle(NULL
, &domain
);
752 if (handle
== NULL
) {
757 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
759 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
766 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
773 MSG("UST events:\n-------------");
779 for (i
= 0; i
< size
; i
++) {
780 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
781 cur_pid
= event_field_list
[i
].event
.pid
;
782 cmdline
= get_cmdline_by_pid(cur_pid
);
783 if (cmdline
== NULL
) {
787 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
789 /* Wipe current event since we are about to print a new PID. */
790 memset(&cur_event
, 0, sizeof(cur_event
));
792 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
793 print_events(&event_field_list
[i
].event
);
794 memcpy(&cur_event
, &event_field_list
[i
].event
,
797 print_event_field(&event_field_list
[i
]);
804 free(event_field_list
);
806 lttng_destroy_handle(handle
);
812 * Print a list of kernel events
814 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
815 struct lttng_domain
*domain
)
819 /* Open domains element */
820 ret
= mi_lttng_domains_open(writer
);
826 ret
= mi_lttng_domain(writer
, domain
, 1);
832 ret
= mi_lttng_events_open(writer
);
837 for (i
= 0; i
< count
; i
++) {
838 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
844 /* close events, domain and domains */
845 ret
= mi_lttng_close_multi_element(writer
, 3);
855 * Ask for all trace events in the kernel
857 static int list_kernel_events(void)
859 int i
, size
, ret
= CMD_SUCCESS
;
860 struct lttng_domain domain
;
861 struct lttng_handle
*handle
;
862 struct lttng_event
*event_list
;
864 memset(&domain
, 0, sizeof(domain
));
866 DBG("Getting kernel tracing events");
868 domain
.type
= LTTNG_DOMAIN_KERNEL
;
870 handle
= lttng_create_handle(NULL
, &domain
);
871 if (handle
== NULL
) {
876 size
= lttng_list_tracepoints(handle
, &event_list
);
878 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
879 lttng_destroy_handle(handle
);
885 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
891 MSG("Kernel events:\n-------------");
893 for (i
= 0; i
< size
; i
++) {
894 print_events(&event_list
[i
]);
903 lttng_destroy_handle(handle
);
907 lttng_destroy_handle(handle
);
913 * Print a list of system calls.
915 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
920 ret
= mi_lttng_events_open(writer
);
925 for (i
= 0; i
< count
; i
++) {
926 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
933 ret
= mi_lttng_writer_close_element(writer
);
943 * Ask for kernel system calls.
945 static int list_syscalls(void)
947 int i
, size
, ret
= CMD_SUCCESS
;
948 struct lttng_event
*event_list
;
950 DBG("Getting kernel system call events");
952 size
= lttng_list_syscalls(&event_list
);
954 ERR("Unable to list system calls: %s", lttng_strerror(size
));
961 ret
= mi_list_syscalls(event_list
, size
);
967 MSG("System calls:\n-------------");
969 for (i
= 0; i
< size
; i
++) {
970 print_events(&event_list
[i
]);
986 * Print a list of agent events
988 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
992 /* Open events element */
993 ret
= mi_lttng_events_open(writer
);
998 for (i
= 0; i
< count
; i
++) {
999 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1005 /* Close events element */
1006 ret
= mi_lttng_writer_close_element(writer
);
1013 * List agent events for a specific session using the handle.
1015 * Return CMD_SUCCESS on success else a negative value.
1017 static int list_session_agent_events(void)
1019 int ret
= CMD_SUCCESS
, count
, i
;
1020 struct lttng_event
*events
= NULL
;
1022 count
= lttng_list_events(handle
, "", &events
);
1025 ERR("%s", lttng_strerror(count
));
1031 ret
= mi_list_session_agent_events(events
, count
);
1038 MSG("Events (Logger name):\n---------------------");
1040 MSG("%sNone\n", indent6
);
1044 for (i
= 0; i
< count
; i
++) {
1045 const char *filter_str
;
1046 char *filter_msg
= NULL
;
1047 struct lttng_event
*event
= &events
[i
];
1049 ret
= lttng_event_get_filter_expression(event
,
1052 filter_msg
= strdup(" [failed to retrieve filter]");
1053 } else if (filter_str
) {
1054 const char * const filter_fmt
=
1057 filter_msg
= malloc(strlen(filter_str
) +
1058 strlen(filter_fmt
) + 1);
1060 sprintf(filter_msg
, filter_fmt
,
1065 if (event
->loglevel_type
!=
1066 LTTNG_EVENT_LOGLEVEL_ALL
) {
1067 MSG("%s- %s%s (loglevel%s %s)%s", indent4
,
1069 enabled_string(event
->enabled
),
1070 logleveltype_string(
1071 event
->loglevel_type
),
1072 mi_lttng_loglevel_string(
1074 handle
->domain
.type
),
1075 safe_string(filter_msg
));
1077 MSG("%s- %s%s%s", indent4
, event
->name
,
1078 enabled_string(event
->enabled
),
1079 safe_string(filter_msg
));
1095 * print a list of event
1097 static int mi_list_events(struct lttng_event
*events
, int count
)
1101 /* Open events element */
1102 ret
= mi_lttng_events_open(writer
);
1107 for (i
= 0; i
< count
; i
++) {
1108 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1114 /* Close events element */
1115 ret
= mi_lttng_writer_close_element(writer
);
1122 * List events of channel of session and domain.
1124 static int list_events(const char *channel_name
)
1126 int ret
= CMD_SUCCESS
, count
, i
;
1127 struct lttng_event
*events
= NULL
;
1129 count
= lttng_list_events(handle
, channel_name
, &events
);
1132 ERR("%s", lttng_strerror(count
));
1138 ret
= mi_list_events(events
, count
);
1145 MSG("\n%sEvents:", indent4
);
1147 MSG("%sNone\n", indent6
);
1151 for (i
= 0; i
< count
; i
++) {
1152 print_events(&events
[i
]);
1164 * Pretty print channel
1166 static void print_channel(struct lttng_channel
*channel
)
1169 uint64_t discarded_events
, lost_packets
;
1171 ret
= lttng_channel_get_discarded_event_count(channel
,
1174 ERR("Failed to retrieve discarded event count of channel");
1178 ret
= lttng_channel_get_lost_packet_count(channel
,
1181 ERR("Failed to retrieve lost packet count of channel");
1185 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1187 MSG("%sAttributes:", indent4
);
1188 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1189 MSG("%ssubbuffers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1190 MSG("%snumber of subbuffers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1191 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1192 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1193 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1194 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1195 MSG("%sdiscarded events: %" PRIu64
, indent6
, discarded_events
);
1196 MSG("%slost packets: %" PRIu64
, indent6
, lost_packets
);
1197 switch (channel
->attr
.output
) {
1198 case LTTNG_EVENT_SPLICE
:
1199 MSG("%soutput: splice()", indent6
);
1201 case LTTNG_EVENT_MMAP
:
1202 MSG("%soutput: mmap()", indent6
);
1209 * Print a list of channel
1212 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1213 const char *channel_name
)
1216 unsigned int chan_found
= 0;
1218 /* Open channels element */
1219 ret
= mi_lttng_channels_open(writer
);
1224 for (i
= 0; i
< count
; i
++) {
1225 if (channel_name
!= NULL
) {
1226 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1233 /* Write channel element and leave it open */
1234 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1239 /* Listing events per channel */
1240 ret
= list_events(channels
[i
].name
);
1245 /* Closing the channel element we opened earlier */
1246 ret
= mi_lttng_writer_close_element(writer
);
1256 /* Close channels element */
1257 ret
= mi_lttng_writer_close_element(writer
);
1267 * List channel(s) of session and domain.
1269 * If channel_name is NULL, all channels are listed.
1271 static int list_channels(const char *channel_name
)
1273 int count
, i
, ret
= CMD_SUCCESS
;
1274 unsigned int chan_found
= 0;
1275 struct lttng_channel
*channels
= NULL
;
1277 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1279 count
= lttng_list_channels(handle
, &channels
);
1282 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1284 /* When printing mi this is not an error
1285 * but an empty channels element */
1289 WARN("No kernel channel");
1290 goto error_channels
;
1294 /* We had a real error */
1296 ERR("%s", lttng_strerror(count
));
1297 goto error_channels
;
1304 ret
= mi_list_channels(channels
, count
, channel_name
);
1312 MSG("Channels:\n-------------");
1315 for (i
= 0; i
< count
; i
++) {
1316 if (channel_name
!= NULL
) {
1317 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1323 print_channel(&channels
[i
]);
1325 /* Listing events per channel */
1326 ret
= list_events(channels
[i
].name
);
1336 if (!chan_found
&& channel_name
!= NULL
) {
1338 ERR("Channel %s not found", channel_name
);
1350 * List tracker PID(s) of session and domain.
1352 static int list_tracker_pids(void)
1359 ret
= lttng_list_tracker_pids(handle
,
1360 &enabled
, &pids
, &nr_pids
);
1366 _MSG("PID tracker: [");
1368 /* Mi tracker_pid element*/
1370 /* Open tracker_pid and targets elements */
1371 ret
= mi_lttng_pid_tracker_open(writer
);
1377 for (i
= 0; i
< nr_pids
; i
++) {
1381 _MSG(" %d", pids
[i
]);
1385 ret
= mi_lttng_pid_target(writer
, pids
[i
], 0);
1393 /* Mi close tracker_pid and targets */
1395 ret
= mi_lttng_close_multi_element(writer
,2);
1408 * List all tracker of a domain
1410 static int list_trackers(void)
1414 /* Trackers listing */
1416 ret
= mi_lttng_trackers_open(writer
);
1423 ret
= list_tracker_pids();
1429 /* Close trackers element */
1430 ret
= mi_lttng_writer_close_element(writer
);
1442 * Find the session with session_name as name
1443 * and print his informations.
1445 static int mi_list_session(const char *session_name
,
1446 struct lttng_session
*sessions
, int count
)
1449 unsigned int session_found
= 0;
1451 if (session_name
== NULL
) {
1452 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1456 for (i
= 0; i
< count
; i
++) {
1457 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1458 /* We need to leave it open to append other informations
1459 * like domain, channel, events etc.*/
1461 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1469 if (!session_found
) {
1470 ERR("Session '%s' not found", session_name
);
1471 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1481 * List all availables session
1483 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1487 /* Opening sessions element */
1488 ret
= mi_lttng_sessions_open(writer
);
1493 /* Listing sessions */
1494 for (i
= 0; i
< count
; i
++) {
1495 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1501 /* Closing sessions element */
1502 ret
= mi_lttng_writer_close_element(writer
);
1512 * List available tracing session. List only basic information.
1514 * If session_name is NULL, all sessions are listed.
1516 static int list_sessions(const char *session_name
)
1518 int ret
= CMD_SUCCESS
;
1520 unsigned int session_found
= 0;
1521 struct lttng_session
*sessions
;
1523 count
= lttng_list_sessions(&sessions
);
1524 DBG("Session count %d", count
);
1527 ERR("%s", lttng_strerror(count
));
1533 if (session_name
== NULL
) {
1534 /* List all session */
1535 ret
= mi_list_sessions(sessions
, count
);
1537 /* Note : this return an open session element */
1538 ret
= mi_list_session(session_name
, sessions
, count
);
1547 MSG("Currently no available tracing session");
1551 if (session_name
== NULL
) {
1552 MSG("Available tracing sessions:");
1556 for (i
= 0; i
< count
; i
++) {
1557 if (session_name
!= NULL
) {
1558 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1560 MSG("Tracing session %s: [%s%s]", session_name
,
1561 active_string(sessions
[i
].enabled
),
1562 snapshot_string(sessions
[i
].snapshot_mode
));
1563 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1567 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1568 sessions
[i
].name
, sessions
[i
].path
,
1569 active_string(sessions
[i
].enabled
),
1570 snapshot_string(sessions
[i
].snapshot_mode
));
1571 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1572 if (sessions
[i
].live_timer_interval
!= 0) {
1573 MSG("%sLive timer interval (usec): %u", indent4
,
1574 sessions
[i
].live_timer_interval
);
1580 if (!session_found
&& session_name
!= NULL
) {
1581 ERR("Session '%s' not found", session_name
);
1586 if (session_name
== NULL
) {
1587 MSG("\nUse lttng list <session_name> for more details");
1600 * list available domain(s) for a session.
1602 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1605 /* Open domains element */
1606 ret
= mi_lttng_domains_open(writer
);
1611 for (i
= 0; i
< count
; i
++) {
1612 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1618 /* Closing domains element */
1619 ret
= mi_lttng_writer_close_element(writer
);
1628 * List available domain(s) for a session.
1630 static int list_domains(const char *session_name
)
1632 int i
, count
, ret
= CMD_SUCCESS
;
1633 struct lttng_domain
*domains
= NULL
;
1636 count
= lttng_list_domains(session_name
, &domains
);
1639 ERR("%s", lttng_strerror(count
));
1645 ret
= mi_list_domains(domains
, count
);
1652 MSG("Domains:\n-------------");
1658 for (i
= 0; i
< count
; i
++) {
1659 switch (domains
[i
].type
) {
1660 case LTTNG_DOMAIN_KERNEL
:
1663 case LTTNG_DOMAIN_UST
:
1664 MSG(" - UST global");
1666 case LTTNG_DOMAIN_JUL
:
1667 MSG(" - JUL (Java Util Logging)");
1669 case LTTNG_DOMAIN_LOG4J
:
1670 MSG(" - LOG4j (Logging for Java)");
1672 case LTTNG_DOMAIN_PYTHON
:
1673 MSG(" - Python (logging)");
1689 * The 'list <options>' first level command
1691 int cmd_list(int argc
, const char **argv
)
1693 int opt
, ret
= CMD_SUCCESS
;
1694 const char *session_name
;
1695 static poptContext pc
;
1696 struct lttng_domain domain
;
1697 struct lttng_domain
*domains
= NULL
;
1699 memset(&domain
, 0, sizeof(domain
));
1706 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1707 poptReadDefaultConfig(pc
, 0);
1709 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1717 case OPT_LIST_OPTIONS
:
1718 list_cmd_options(stdout
, long_options
);
1721 ret
= CMD_UNDEFINED
;
1728 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1734 /* Open command element */
1735 ret
= mi_lttng_writer_command_open(writer
,
1736 mi_lttng_element_command_list
);
1742 /* Open output element */
1743 ret
= mi_lttng_writer_open_element(writer
,
1744 mi_lttng_element_command_output
);
1751 /* Get session name (trailing argument) */
1752 session_name
= poptGetArg(pc
);
1753 DBG2("Session name: %s", session_name
);
1756 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1757 } else if (opt_userspace
) {
1758 DBG2("Listing userspace global domain");
1759 domain
.type
= LTTNG_DOMAIN_UST
;
1760 } else if (opt_jul
) {
1761 DBG2("Listing JUL domain");
1762 domain
.type
= LTTNG_DOMAIN_JUL
;
1763 } else if (opt_log4j
) {
1764 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1765 } else if (opt_python
) {
1766 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1769 if (!opt_kernel
&& opt_syscall
) {
1770 WARN("--syscall will only work with the Kernel domain (-k)");
1775 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1776 handle
= lttng_create_handle(session_name
, &domain
);
1777 if (handle
== NULL
) {
1783 if (session_name
== NULL
) {
1784 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1786 ret
= list_sessions(NULL
);
1793 ret
= list_syscalls();
1798 ret
= list_kernel_events();
1804 if (opt_userspace
) {
1806 ret
= list_ust_event_fields();
1808 ret
= list_ust_events();
1814 if (opt_jul
|| opt_log4j
|| opt_python
) {
1815 ret
= list_agent_events();
1821 /* List session attributes */
1823 /* Open element sessions
1824 * Present for xml consistency */
1825 ret
= mi_lttng_sessions_open(writer
);
1830 /* MI: the ouptut of list_sessions is an unclosed session element */
1831 ret
= list_sessions(session_name
);
1836 /* Domain listing */
1838 ret
= list_domains(session_name
);
1842 /* Channel listing */
1843 if (opt_kernel
|| opt_userspace
) {
1845 /* Add of domains and domain element for xml
1846 * consistency and validation
1848 ret
= mi_lttng_domains_open(writer
);
1853 /* Open domain and leave it open for
1854 * nested channels printing */
1855 ret
= mi_lttng_domain(writer
, &domain
, 1);
1864 ret
= list_trackers();
1870 ret
= list_channels(opt_channel
);
1876 /* Close domain and domain element */
1877 ret
= mi_lttng_close_multi_element(writer
, 2);
1887 /* We want all domain(s) */
1888 nb_domain
= lttng_list_domains(session_name
, &domains
);
1889 if (nb_domain
< 0) {
1891 ERR("%s", lttng_strerror(nb_domain
));
1896 ret
= mi_lttng_domains_open(writer
);
1903 for (i
= 0; i
< nb_domain
; i
++) {
1904 switch (domains
[i
].type
) {
1905 case LTTNG_DOMAIN_KERNEL
:
1906 MSG("=== Domain: Kernel ===\n");
1908 case LTTNG_DOMAIN_UST
:
1909 MSG("=== Domain: UST global ===\n");
1910 MSG("Buffer type: %s\n",
1911 domains
[i
].buf_type
==
1912 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1914 case LTTNG_DOMAIN_JUL
:
1915 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1917 case LTTNG_DOMAIN_LOG4J
:
1918 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1920 case LTTNG_DOMAIN_PYTHON
:
1921 MSG("=== Domain: Python (logging) ===\n");
1924 MSG("=== Domain: Unimplemented ===\n");
1929 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1936 /* Clean handle before creating a new one */
1938 lttng_destroy_handle(handle
);
1941 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1942 if (handle
== NULL
) {
1947 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1948 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1949 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1950 ret
= list_session_agent_events();
1958 switch (domains
[i
].type
) {
1959 case LTTNG_DOMAIN_KERNEL
:
1960 case LTTNG_DOMAIN_UST
:
1961 ret
= list_trackers();
1970 ret
= list_channels(opt_channel
);
1977 /* Close domain element */
1978 ret
= mi_lttng_writer_close_element(writer
);
1987 /* Close the domains, session and sessions element */
1988 ret
= mi_lttng_close_multi_element(writer
, 3);
1999 /* Close output element */
2000 ret
= mi_lttng_writer_close_element(writer
);
2006 /* Command element close */
2007 ret
= mi_lttng_writer_command_close(writer
);
2015 if (writer
&& mi_lttng_writer_destroy(writer
)) {
2016 /* Preserve original error code */
2017 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
2022 lttng_destroy_handle(handle
);
2025 poptFreeContext(pc
);