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 /* Open domains element */
625 ret
= mi_lttng_domains_open(writer
);
631 ret
= mi_lttng_domain(writer
, domain
, 1);
636 /* Open pids element */
637 ret
= mi_lttng_pids_open(writer
);
642 for (i
= 0; i
< count
; i
++) {
643 if (cur_pid
!= fields
[i
].event
.pid
) {
644 if (pid_element_open
) {
645 if (event_element_open
) {
647 /* Close the previous field element and event. */
648 ret
= mi_lttng_close_multi_element(writer
, 2);
652 event_element_open
= 0;
654 /* Close the previous events, pid element */
655 ret
= mi_lttng_close_multi_element(writer
, 2);
659 pid_element_open
= 0;
662 cur_pid
= fields
[i
].event
.pid
;
663 cmdline
= get_cmdline_by_pid(cur_pid
);
664 if (!pid_element_open
) {
665 /* Open and write a pid element */
666 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
671 /* Open events element */
672 ret
= mi_lttng_events_open(writer
);
676 pid_element_open
= 1;
679 /* Wipe current event since we are about to print a new PID. */
680 memset(&cur_event
, 0, sizeof(cur_event
));
683 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
684 if (event_element_open
) {
685 /* Close the previous fields element and the previous event */
686 ret
= mi_lttng_close_multi_element(writer
, 2);
690 event_element_open
= 0;
693 memcpy(&cur_event
, &fields
[i
].event
,
696 if (!event_element_open
) {
697 /* Open and write the event */
698 ret
= mi_lttng_event(writer
, &cur_event
, 1,
699 handle
->domain
.type
);
704 /* Open a fields element */
705 ret
= mi_lttng_event_fields_open(writer
);
709 event_element_open
= 1;
713 /* Print the event_field */
714 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
720 /* Close pid, domain, domains */
721 ret
= mi_lttng_close_multi_element(writer
, 3);
730 * Ask session daemon for all user space tracepoint fields available.
732 static int list_ust_event_fields(void)
734 int i
, size
, ret
= CMD_SUCCESS
;
735 struct lttng_domain domain
;
736 struct lttng_handle
*handle
;
737 struct lttng_event_field
*event_field_list
;
739 char *cmdline
= NULL
;
741 struct lttng_event cur_event
;
743 memset(&domain
, 0, sizeof(domain
));
744 memset(&cur_event
, 0, sizeof(cur_event
));
746 DBG("Getting UST tracing event fields");
748 domain
.type
= LTTNG_DOMAIN_UST
;
750 handle
= lttng_create_handle(NULL
, &domain
);
751 if (handle
== NULL
) {
756 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
758 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
765 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
772 MSG("UST events:\n-------------");
778 for (i
= 0; i
< size
; i
++) {
779 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
780 cur_pid
= event_field_list
[i
].event
.pid
;
781 cmdline
= get_cmdline_by_pid(cur_pid
);
782 if (cmdline
== NULL
) {
786 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
788 /* Wipe current event since we are about to print a new PID. */
789 memset(&cur_event
, 0, sizeof(cur_event
));
791 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
792 print_events(&event_field_list
[i
].event
);
793 memcpy(&cur_event
, &event_field_list
[i
].event
,
796 print_event_field(&event_field_list
[i
]);
803 free(event_field_list
);
805 lttng_destroy_handle(handle
);
811 * Print a list of kernel events
813 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
814 struct lttng_domain
*domain
)
818 /* Open domains element */
819 ret
= mi_lttng_domains_open(writer
);
825 ret
= mi_lttng_domain(writer
, domain
, 1);
831 ret
= mi_lttng_events_open(writer
);
836 for (i
= 0; i
< count
; i
++) {
837 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
843 /* close events, domain and domains */
844 ret
= mi_lttng_close_multi_element(writer
, 3);
854 * Ask for all trace events in the kernel
856 static int list_kernel_events(void)
858 int i
, size
, ret
= CMD_SUCCESS
;
859 struct lttng_domain domain
;
860 struct lttng_handle
*handle
;
861 struct lttng_event
*event_list
;
863 memset(&domain
, 0, sizeof(domain
));
865 DBG("Getting kernel tracing events");
867 domain
.type
= LTTNG_DOMAIN_KERNEL
;
869 handle
= lttng_create_handle(NULL
, &domain
);
870 if (handle
== NULL
) {
875 size
= lttng_list_tracepoints(handle
, &event_list
);
877 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
878 lttng_destroy_handle(handle
);
884 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
890 MSG("Kernel events:\n-------------");
892 for (i
= 0; i
< size
; i
++) {
893 print_events(&event_list
[i
]);
902 lttng_destroy_handle(handle
);
906 lttng_destroy_handle(handle
);
912 * Print a list of system calls.
914 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
919 ret
= mi_lttng_events_open(writer
);
924 for (i
= 0; i
< count
; i
++) {
925 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
932 ret
= mi_lttng_writer_close_element(writer
);
942 * Ask for kernel system calls.
944 static int list_syscalls(void)
946 int i
, size
, ret
= CMD_SUCCESS
;
947 struct lttng_event
*event_list
;
949 DBG("Getting kernel system call events");
951 size
= lttng_list_syscalls(&event_list
);
953 ERR("Unable to list system calls: %s", lttng_strerror(size
));
960 ret
= mi_list_syscalls(event_list
, size
);
966 MSG("System calls:\n-------------");
968 for (i
= 0; i
< size
; i
++) {
969 print_events(&event_list
[i
]);
985 * Print a list of agent events
987 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
991 /* Open events element */
992 ret
= mi_lttng_events_open(writer
);
997 for (i
= 0; i
< count
; i
++) {
998 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1004 /* Close events element */
1005 ret
= mi_lttng_writer_close_element(writer
);
1012 * List agent events for a specific session using the handle.
1014 * Return CMD_SUCCESS on success else a negative value.
1016 static int list_session_agent_events(void)
1018 int ret
= CMD_SUCCESS
, count
, i
;
1019 struct lttng_event
*events
= NULL
;
1021 count
= lttng_list_events(handle
, "", &events
);
1024 ERR("%s", lttng_strerror(count
));
1030 ret
= mi_list_session_agent_events(events
, count
);
1037 MSG("Events (Logger name):\n---------------------");
1039 MSG("%sNone\n", indent6
);
1043 for (i
= 0; i
< count
; i
++) {
1044 const char *filter_str
;
1045 char *filter_msg
= NULL
;
1046 struct lttng_event
*event
= &events
[i
];
1048 ret
= lttng_event_get_filter_expression(event
,
1051 filter_msg
= strdup(" [failed to retrieve filter]");
1052 } else if (filter_str
) {
1053 const char * const filter_fmt
=
1056 filter_msg
= malloc(strlen(filter_str
) +
1057 strlen(filter_fmt
) + 1);
1059 sprintf(filter_msg
, filter_fmt
,
1064 if (event
->loglevel_type
!=
1065 LTTNG_EVENT_LOGLEVEL_ALL
) {
1066 MSG("%s- %s%s (loglevel%s %s)%s", indent4
,
1068 enabled_string(event
->enabled
),
1069 logleveltype_string(
1070 event
->loglevel_type
),
1071 mi_lttng_loglevel_string(
1073 handle
->domain
.type
),
1074 safe_string(filter_msg
));
1076 MSG("%s- %s%s%s", indent4
, event
->name
,
1077 enabled_string(event
->enabled
),
1078 safe_string(filter_msg
));
1094 * print a list of event
1096 static int mi_list_events(struct lttng_event
*events
, int count
)
1100 /* Open events element */
1101 ret
= mi_lttng_events_open(writer
);
1106 for (i
= 0; i
< count
; i
++) {
1107 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1113 /* Close events element */
1114 ret
= mi_lttng_writer_close_element(writer
);
1121 * List events of channel of session and domain.
1123 static int list_events(const char *channel_name
)
1125 int ret
= CMD_SUCCESS
, count
, i
;
1126 struct lttng_event
*events
= NULL
;
1128 count
= lttng_list_events(handle
, channel_name
, &events
);
1131 ERR("%s", lttng_strerror(count
));
1137 ret
= mi_list_events(events
, count
);
1144 MSG("\n%sEvents:", indent4
);
1146 MSG("%sNone\n", indent6
);
1150 for (i
= 0; i
< count
; i
++) {
1151 print_events(&events
[i
]);
1163 * Pretty print channel
1165 static void print_channel(struct lttng_channel
*channel
)
1168 uint64_t discarded_events
, lost_packets
;
1170 ret
= lttng_channel_get_discarded_event_count(channel
,
1173 ERR("Failed to retrieve discarded event count of channel");
1177 ret
= lttng_channel_get_lost_packet_count(channel
,
1180 ERR("Failed to retrieve lost packet count of channel");
1184 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1186 MSG("%sAttributes:", indent4
);
1187 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1188 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1189 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1190 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1191 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1192 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1193 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1194 MSG("%sdiscarded events: %" PRIu64
, indent6
, discarded_events
);
1195 MSG("%slost packets: %" PRIu64
, indent6
, lost_packets
);
1196 switch (channel
->attr
.output
) {
1197 case LTTNG_EVENT_SPLICE
:
1198 MSG("%soutput: splice()", indent6
);
1200 case LTTNG_EVENT_MMAP
:
1201 MSG("%soutput: mmap()", indent6
);
1208 * Print a list of channel
1211 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1212 const char *channel_name
)
1215 unsigned int chan_found
= 0;
1217 /* Open channels element */
1218 ret
= mi_lttng_channels_open(writer
);
1223 for (i
= 0; i
< count
; i
++) {
1224 if (channel_name
!= NULL
) {
1225 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1232 /* Write channel element and leave it open */
1233 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1238 /* Listing events per channel */
1239 ret
= list_events(channels
[i
].name
);
1244 /* Closing the channel element we opened earlier */
1245 ret
= mi_lttng_writer_close_element(writer
);
1255 /* Close channels element */
1256 ret
= mi_lttng_writer_close_element(writer
);
1266 * List channel(s) of session and domain.
1268 * If channel_name is NULL, all channels are listed.
1270 static int list_channels(const char *channel_name
)
1272 int count
, i
, ret
= CMD_SUCCESS
;
1273 unsigned int chan_found
= 0;
1274 struct lttng_channel
*channels
= NULL
;
1276 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1278 count
= lttng_list_channels(handle
, &channels
);
1281 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1283 /* When printing mi this is not an error
1284 * but an empty channels element */
1288 WARN("No kernel channel");
1289 goto error_channels
;
1293 /* We had a real error */
1295 ERR("%s", lttng_strerror(count
));
1296 goto error_channels
;
1303 ret
= mi_list_channels(channels
, count
, channel_name
);
1311 MSG("Channels:\n-------------");
1314 for (i
= 0; i
< count
; i
++) {
1315 if (channel_name
!= NULL
) {
1316 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1322 print_channel(&channels
[i
]);
1324 /* Listing events per channel */
1325 ret
= list_events(channels
[i
].name
);
1335 if (!chan_found
&& channel_name
!= NULL
) {
1337 ERR("Channel %s not found", channel_name
);
1349 * List tracker PID(s) of session and domain.
1351 static int list_tracker_pids(void)
1358 ret
= lttng_list_tracker_pids(handle
,
1359 &enabled
, &pids
, &nr_pids
);
1365 _MSG("PID tracker: [");
1367 /* Mi tracker_pid element*/
1369 /* Open tracker_pid and targets elements */
1370 ret
= mi_lttng_pid_tracker_open(writer
);
1376 for (i
= 0; i
< nr_pids
; i
++) {
1380 _MSG(" %d", pids
[i
]);
1384 ret
= mi_lttng_pid_target(writer
, pids
[i
], 0);
1392 /* Mi close tracker_pid and targets */
1394 ret
= mi_lttng_close_multi_element(writer
,2);
1407 * List all tracker of a domain
1409 static int list_trackers(void)
1413 /* Trackers listing */
1415 ret
= mi_lttng_trackers_open(writer
);
1422 ret
= list_tracker_pids();
1428 /* Close trackers element */
1429 ret
= mi_lttng_writer_close_element(writer
);
1441 * Find the session with session_name as name
1442 * and print his informations.
1444 static int mi_list_session(const char *session_name
,
1445 struct lttng_session
*sessions
, int count
)
1448 unsigned int session_found
= 0;
1450 if (session_name
== NULL
) {
1451 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1455 for (i
= 0; i
< count
; i
++) {
1456 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1457 /* We need to leave it open to append other informations
1458 * like domain, channel, events etc.*/
1460 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1468 if (!session_found
) {
1469 ERR("Session '%s' not found", session_name
);
1470 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1480 * List all availables session
1482 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1486 /* Opening sessions element */
1487 ret
= mi_lttng_sessions_open(writer
);
1492 /* Listing sessions */
1493 for (i
= 0; i
< count
; i
++) {
1494 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1500 /* Closing sessions element */
1501 ret
= mi_lttng_writer_close_element(writer
);
1511 * List available tracing session. List only basic information.
1513 * If session_name is NULL, all sessions are listed.
1515 static int list_sessions(const char *session_name
)
1517 int ret
= CMD_SUCCESS
;
1519 unsigned int session_found
= 0;
1520 struct lttng_session
*sessions
;
1522 count
= lttng_list_sessions(&sessions
);
1523 DBG("Session count %d", count
);
1526 ERR("%s", lttng_strerror(count
));
1532 if (session_name
== NULL
) {
1533 /* List all session */
1534 ret
= mi_list_sessions(sessions
, count
);
1536 /* Note : this return an open session element */
1537 ret
= mi_list_session(session_name
, sessions
, count
);
1546 MSG("Currently no available tracing session");
1550 if (session_name
== NULL
) {
1551 MSG("Available tracing sessions:");
1555 for (i
= 0; i
< count
; i
++) {
1556 if (session_name
!= NULL
) {
1557 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1559 MSG("Tracing session %s: [%s%s]", session_name
,
1560 active_string(sessions
[i
].enabled
),
1561 snapshot_string(sessions
[i
].snapshot_mode
));
1562 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1566 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1567 sessions
[i
].name
, sessions
[i
].path
,
1568 active_string(sessions
[i
].enabled
),
1569 snapshot_string(sessions
[i
].snapshot_mode
));
1570 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1571 if (sessions
[i
].live_timer_interval
!= 0) {
1572 MSG("%sLive timer interval (usec): %u", indent4
,
1573 sessions
[i
].live_timer_interval
);
1579 if (!session_found
&& session_name
!= NULL
) {
1580 ERR("Session '%s' not found", session_name
);
1585 if (session_name
== NULL
) {
1586 MSG("\nUse lttng list <session_name> for more details");
1599 * list available domain(s) for a session.
1601 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1604 /* Open domains element */
1605 ret
= mi_lttng_domains_open(writer
);
1610 for (i
= 0; i
< count
; i
++) {
1611 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1617 /* Closing domains element */
1618 ret
= mi_lttng_writer_close_element(writer
);
1627 * List available domain(s) for a session.
1629 static int list_domains(const char *session_name
)
1631 int i
, count
, ret
= CMD_SUCCESS
;
1632 struct lttng_domain
*domains
= NULL
;
1635 count
= lttng_list_domains(session_name
, &domains
);
1638 ERR("%s", lttng_strerror(count
));
1644 ret
= mi_list_domains(domains
, count
);
1651 MSG("Domains:\n-------------");
1657 for (i
= 0; i
< count
; i
++) {
1658 switch (domains
[i
].type
) {
1659 case LTTNG_DOMAIN_KERNEL
:
1662 case LTTNG_DOMAIN_UST
:
1663 MSG(" - UST global");
1665 case LTTNG_DOMAIN_JUL
:
1666 MSG(" - JUL (Java Util Logging)");
1668 case LTTNG_DOMAIN_LOG4J
:
1669 MSG(" - LOG4j (Logging for Java)");
1671 case LTTNG_DOMAIN_PYTHON
:
1672 MSG(" - Python (logging)");
1688 * The 'list <options>' first level command
1690 int cmd_list(int argc
, const char **argv
)
1692 int opt
, ret
= CMD_SUCCESS
;
1693 const char *session_name
;
1694 static poptContext pc
;
1695 struct lttng_domain domain
;
1696 struct lttng_domain
*domains
= NULL
;
1698 memset(&domain
, 0, sizeof(domain
));
1705 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1706 poptReadDefaultConfig(pc
, 0);
1708 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1716 case OPT_LIST_OPTIONS
:
1717 list_cmd_options(stdout
, long_options
);
1720 ret
= CMD_UNDEFINED
;
1727 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1733 /* Open command element */
1734 ret
= mi_lttng_writer_command_open(writer
,
1735 mi_lttng_element_command_list
);
1741 /* Open output element */
1742 ret
= mi_lttng_writer_open_element(writer
,
1743 mi_lttng_element_command_output
);
1750 /* Get session name (trailing argument) */
1751 session_name
= poptGetArg(pc
);
1752 DBG2("Session name: %s", session_name
);
1755 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1756 } else if (opt_userspace
) {
1757 DBG2("Listing userspace global domain");
1758 domain
.type
= LTTNG_DOMAIN_UST
;
1759 } else if (opt_jul
) {
1760 DBG2("Listing JUL domain");
1761 domain
.type
= LTTNG_DOMAIN_JUL
;
1762 } else if (opt_log4j
) {
1763 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1764 } else if (opt_python
) {
1765 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1768 if (!opt_kernel
&& opt_syscall
) {
1769 WARN("--syscall will only work with the Kernel domain (-k)");
1774 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1775 handle
= lttng_create_handle(session_name
, &domain
);
1776 if (handle
== NULL
) {
1782 if (session_name
== NULL
) {
1783 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1785 ret
= list_sessions(NULL
);
1792 ret
= list_syscalls();
1797 ret
= list_kernel_events();
1803 if (opt_userspace
) {
1805 ret
= list_ust_event_fields();
1807 ret
= list_ust_events();
1813 if (opt_jul
|| opt_log4j
|| opt_python
) {
1814 ret
= list_agent_events();
1820 /* List session attributes */
1822 /* Open element sessions
1823 * Present for xml consistency */
1824 ret
= mi_lttng_sessions_open(writer
);
1829 /* MI: the ouptut of list_sessions is an unclosed session element */
1830 ret
= list_sessions(session_name
);
1835 /* Domain listing */
1837 ret
= list_domains(session_name
);
1841 /* Channel listing */
1842 if (opt_kernel
|| opt_userspace
) {
1844 /* Add of domains and domain element for xml
1845 * consistency and validation
1847 ret
= mi_lttng_domains_open(writer
);
1852 /* Open domain and leave it open for
1853 * nested channels printing */
1854 ret
= mi_lttng_domain(writer
, &domain
, 1);
1863 ret
= list_trackers();
1869 ret
= list_channels(opt_channel
);
1875 /* Close domain and domain element */
1876 ret
= mi_lttng_close_multi_element(writer
, 2);
1886 /* We want all domain(s) */
1887 nb_domain
= lttng_list_domains(session_name
, &domains
);
1888 if (nb_domain
< 0) {
1890 ERR("%s", lttng_strerror(nb_domain
));
1895 ret
= mi_lttng_domains_open(writer
);
1902 for (i
= 0; i
< nb_domain
; i
++) {
1903 switch (domains
[i
].type
) {
1904 case LTTNG_DOMAIN_KERNEL
:
1905 MSG("=== Domain: Kernel ===\n");
1907 case LTTNG_DOMAIN_UST
:
1908 MSG("=== Domain: UST global ===\n");
1909 MSG("Buffer type: %s\n",
1910 domains
[i
].buf_type
==
1911 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1913 case LTTNG_DOMAIN_JUL
:
1914 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1916 case LTTNG_DOMAIN_LOG4J
:
1917 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1919 case LTTNG_DOMAIN_PYTHON
:
1920 MSG("=== Domain: Python (logging) ===\n");
1923 MSG("=== Domain: Unimplemented ===\n");
1928 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1935 /* Clean handle before creating a new one */
1937 lttng_destroy_handle(handle
);
1940 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1941 if (handle
== NULL
) {
1946 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1947 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1948 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1949 ret
= list_session_agent_events();
1957 switch (domains
[i
].type
) {
1958 case LTTNG_DOMAIN_KERNEL
:
1959 case LTTNG_DOMAIN_UST
:
1960 ret
= list_trackers();
1969 ret
= list_channels(opt_channel
);
1976 /* Close domain element */
1977 ret
= mi_lttng_writer_close_element(writer
);
1986 /* Close the domains, session and sessions element */
1987 ret
= mi_lttng_close_multi_element(writer
, 3);
1998 /* Close output element */
1999 ret
= mi_lttng_writer_close_element(writer
);
2005 /* Command element close */
2006 ret
= mi_lttng_writer_command_close(writer
);
2014 if (writer
&& mi_lttng_writer_destroy(writer
)) {
2015 /* Preserve original error code */
2016 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
2021 lttng_destroy_handle(handle
);
2024 poptFreeContext(pc
);