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
= " ";
45 #ifdef LTTNG_EMBED_HELP
46 static const char help_msg
[] =
47 #include <lttng-list.1.h>
57 static struct lttng_handle
*handle
;
58 static struct mi_writer
*writer
;
60 static struct poptOption long_options
[] = {
61 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
62 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
63 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
64 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
65 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
66 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
67 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
68 {"channel", 'c', POPT_ARG_STRING
, &opt_channel
, 0, 0, 0},
69 {"domain", 'd', POPT_ARG_VAL
, &opt_domain
, 1, 0, 0},
70 {"fields", 'f', POPT_ARG_VAL
, &opt_fields
, 1, 0, 0},
71 {"syscall", 'S', POPT_ARG_VAL
, &opt_syscall
, 1, 0, 0},
72 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
77 * Get command line from /proc for a specific pid.
79 * On success, return an allocated string pointer to the proc cmdline.
80 * On error, return NULL.
82 static char *get_cmdline_by_pid(pid_t pid
)
87 /* Can't go bigger than /proc/LTTNG_MAX_PID/cmdline */
88 char path
[sizeof("/proc//cmdline") + sizeof(LTTNG_MAX_PID_STR
) - 1];
90 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
91 fp
= fopen(path
, "r");
96 /* Caller must free() *cmdline */
97 cmdline
= zmalloc(PATH_MAX
);
99 PERROR("malloc cmdline");
102 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
104 PERROR("fread proc list");
115 const char *active_string(int value
)
118 case 0: return "inactive";
119 case 1: return "active";
121 default: return NULL
;
125 static const char *snapshot_string(int value
)
136 const char *enabled_string(int value
)
139 case 0: return " [disabled]";
140 case 1: return " [enabled]";
142 default: return NULL
;
147 const char *safe_string(const char *str
)
149 return str
? str
: "";
152 static const char *logleveltype_string(enum lttng_loglevel_type value
)
155 case LTTNG_EVENT_LOGLEVEL_ALL
:
157 case LTTNG_EVENT_LOGLEVEL_RANGE
:
159 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
162 return " <<TYPE UNKN>>";
166 static const char *bitness_event(enum lttng_event_flag flags
)
168 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_32
) {
169 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
170 return " [32/64-bit]";
174 } else if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
182 * Get exclusion names message for a single event.
184 * Returned pointer must be freed by caller. Returns NULL on error.
186 static char *get_exclusion_names_msg(struct lttng_event
*event
)
190 char *exclusion_msg
= NULL
;
193 const char * const exclusion_fmt
= " [exclusions: ";
194 const size_t exclusion_fmt_len
= strlen(exclusion_fmt
);
196 exclusion_count
= lttng_event_get_exclusion_name_count(event
);
197 if (exclusion_count
< 0) {
199 } else if (exclusion_count
== 0) {
201 * No exclusions: return copy of empty string so that
202 * it can be freed by caller.
204 exclusion_msg
= strdup("");
209 * exclusion_msg's size is bounded by the exclusion_fmt string,
210 * a comma per entry, the entry count (fixed-size), a closing
211 * bracket, and a trailing \0.
213 exclusion_msg
= malloc(exclusion_count
+
214 exclusion_count
* LTTNG_SYMBOL_NAME_LEN
+
215 exclusion_fmt_len
+ 1);
216 if (!exclusion_msg
) {
220 at
= strcpy(exclusion_msg
, exclusion_fmt
) + exclusion_fmt_len
;
221 for (i
= 0; i
< exclusion_count
; ++i
) {
224 /* Append comma between exclusion names */
230 ret
= lttng_event_get_exclusion_name(event
, i
, &name
);
232 /* Prints '?' on local error; should never happen */
238 /* Append exclusion name */
239 at
+= sprintf(at
, "%s", name
);
242 /* This also puts a final '\0' at the end of exclusion_msg */
246 return exclusion_msg
;
250 * Pretty print single event.
252 static void print_events(struct lttng_event
*event
)
255 const char *filter_str
;
256 char *filter_msg
= NULL
;
257 char *exclusion_msg
= NULL
;
259 ret
= lttng_event_get_filter_expression(event
, &filter_str
);
262 filter_msg
= strdup(" [failed to retrieve filter]");
263 } else if (filter_str
) {
264 const char * const filter_fmt
= " [filter: '%s']";
266 filter_msg
= malloc(strlen(filter_str
) +
267 strlen(filter_fmt
) + 1);
269 sprintf(filter_msg
, filter_fmt
,
274 exclusion_msg
= get_exclusion_names_msg(event
);
275 if (!exclusion_msg
) {
276 exclusion_msg
= strdup(" [failed to retrieve exclusions]");
279 switch (event
->type
) {
280 case LTTNG_EVENT_TRACEPOINT
:
282 if (event
->loglevel
!= -1) {
283 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
286 logleveltype_string(event
->loglevel_type
),
287 mi_lttng_loglevel_string(event
->loglevel
, handle
->domain
.type
),
289 enabled_string(event
->enabled
),
290 safe_string(exclusion_msg
),
291 safe_string(filter_msg
));
293 MSG("%s%s (type: tracepoint)%s%s%s",
296 enabled_string(event
->enabled
),
297 safe_string(exclusion_msg
),
298 safe_string(filter_msg
));
302 case LTTNG_EVENT_FUNCTION
:
303 MSG("%s%s (type: function)%s%s", indent6
,
304 event
->name
, enabled_string(event
->enabled
),
305 safe_string(filter_msg
));
306 if (event
->attr
.probe
.addr
!= 0) {
307 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
309 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
310 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
313 case LTTNG_EVENT_PROBE
:
314 MSG("%s%s (type: probe)%s%s", indent6
,
315 event
->name
, enabled_string(event
->enabled
),
316 safe_string(filter_msg
));
317 if (event
->attr
.probe
.addr
!= 0) {
318 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
320 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
321 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
324 case LTTNG_EVENT_FUNCTION_ENTRY
:
325 MSG("%s%s (type: function)%s%s", indent6
,
326 event
->name
, enabled_string(event
->enabled
),
327 safe_string(filter_msg
));
328 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
330 case LTTNG_EVENT_SYSCALL
:
331 MSG("%s%s%s%s%s%s", indent6
, event
->name
,
332 (opt_syscall
? "" : " (type:syscall)"),
333 enabled_string(event
->enabled
),
334 bitness_event(event
->flags
),
335 safe_string(filter_msg
));
337 case LTTNG_EVENT_NOOP
:
338 MSG("%s (type: noop)%s%s", indent6
,
339 enabled_string(event
->enabled
),
340 safe_string(filter_msg
));
342 case LTTNG_EVENT_ALL
:
343 /* We should never have "all" events in list. */
352 static const char *field_type(struct lttng_event_field
*field
)
354 switch(field
->type
) {
355 case LTTNG_EVENT_FIELD_INTEGER
:
357 case LTTNG_EVENT_FIELD_ENUM
:
359 case LTTNG_EVENT_FIELD_FLOAT
:
361 case LTTNG_EVENT_FIELD_STRING
:
363 case LTTNG_EVENT_FIELD_OTHER
:
364 default: /* fall-through */
370 * Pretty print single event fields.
372 static void print_event_field(struct lttng_event_field
*field
)
374 if (!field
->field_name
[0]) {
377 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
378 field_type(field
), field
->nowrite
? " [no write]" : "");
383 * Jul and ust event listing
385 static int mi_list_agent_ust_events(struct lttng_event
*events
, int count
,
386 struct lttng_domain
*domain
)
390 char *cmdline
= NULL
;
391 int pid_element_open
= 0;
393 /* Open domains element */
394 ret
= mi_lttng_domains_open(writer
);
400 ret
= mi_lttng_domain(writer
, domain
, 1);
405 /* Open pids element element */
406 ret
= mi_lttng_pids_open(writer
);
411 for (i
= 0; i
< count
; i
++) {
412 if (cur_pid
!= events
[i
].pid
) {
413 if (pid_element_open
) {
414 /* Close the previous events and pid element */
415 ret
= mi_lttng_close_multi_element(writer
, 2);
419 pid_element_open
= 0;
422 cur_pid
= events
[i
].pid
;
423 cmdline
= get_cmdline_by_pid(cur_pid
);
429 if (!pid_element_open
) {
430 /* Open and write a pid element */
431 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
436 /* Open events element */
437 ret
= mi_lttng_events_open(writer
);
442 pid_element_open
= 1;
448 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
455 ret
= mi_lttng_writer_close_element(writer
);
460 /* Close domain, domains */
461 ret
= mi_lttng_close_multi_element(writer
, 2);
469 static int list_agent_events(void)
471 int i
, size
, ret
= CMD_SUCCESS
;
472 struct lttng_domain domain
;
473 struct lttng_handle
*handle
= NULL
;
474 struct lttng_event
*event_list
= NULL
;
476 char *cmdline
= NULL
;
477 const char *agent_domain_str
;
479 memset(&domain
, 0, sizeof(domain
));
481 domain
.type
= LTTNG_DOMAIN_JUL
;
482 } else if (opt_log4j
) {
483 domain
.type
= LTTNG_DOMAIN_LOG4J
;
484 } else if (opt_python
) {
485 domain
.type
= LTTNG_DOMAIN_PYTHON
;
487 ERR("Invalid agent domain selected.");
492 agent_domain_str
= get_domain_str(domain
.type
);
494 DBG("Getting %s tracing events", agent_domain_str
);
496 handle
= lttng_create_handle(NULL
, &domain
);
497 if (handle
== NULL
) {
502 size
= lttng_list_tracepoints(handle
, &event_list
);
504 ERR("Unable to list %s events: %s", agent_domain_str
,
505 lttng_strerror(size
));
512 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
519 MSG("%s events (Logger name):\n-------------------------",
526 for (i
= 0; i
< size
; i
++) {
527 if (cur_pid
!= event_list
[i
].pid
) {
528 cur_pid
= event_list
[i
].pid
;
529 cmdline
= get_cmdline_by_pid(cur_pid
);
530 if (cmdline
== NULL
) {
534 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
537 MSG("%s- %s", indent6
, event_list
[i
].name
);
546 lttng_destroy_handle(handle
);
551 * Ask session daemon for all user space tracepoints available.
553 static int list_ust_events(void)
555 int i
, size
, ret
= CMD_SUCCESS
;
556 struct lttng_domain domain
;
557 struct lttng_handle
*handle
;
558 struct lttng_event
*event_list
= NULL
;
560 char *cmdline
= NULL
;
562 memset(&domain
, 0, sizeof(domain
));
564 DBG("Getting UST tracing events");
566 domain
.type
= LTTNG_DOMAIN_UST
;
568 handle
= lttng_create_handle(NULL
, &domain
);
569 if (handle
== NULL
) {
574 size
= lttng_list_tracepoints(handle
, &event_list
);
576 ERR("Unable to list UST events: %s", lttng_strerror(size
));
583 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
586 MSG("UST events:\n-------------");
592 for (i
= 0; i
< size
; i
++) {
593 if (cur_pid
!= event_list
[i
].pid
) {
594 cur_pid
= event_list
[i
].pid
;
595 cmdline
= get_cmdline_by_pid(cur_pid
);
596 if (cmdline
== NULL
) {
600 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
603 print_events(&event_list
[i
]);
612 lttng_destroy_handle(handle
);
618 * List all ust event with their fields
620 static int mi_list_ust_event_fields(struct lttng_event_field
*fields
, int count
,
621 struct lttng_domain
*domain
)
625 char *cmdline
= NULL
;
626 int pid_element_open
= 0;
627 int event_element_open
= 0;
628 struct lttng_event cur_event
;
630 memset(&cur_event
, 0, sizeof(cur_event
));
632 /* Open domains element */
633 ret
= mi_lttng_domains_open(writer
);
639 ret
= mi_lttng_domain(writer
, domain
, 1);
644 /* Open pids element */
645 ret
= mi_lttng_pids_open(writer
);
650 for (i
= 0; i
< count
; i
++) {
651 if (cur_pid
!= fields
[i
].event
.pid
) {
652 if (pid_element_open
) {
653 if (event_element_open
) {
654 /* Close the previous field element and event. */
655 ret
= mi_lttng_close_multi_element(writer
, 2);
659 event_element_open
= 0;
661 /* Close the previous events, pid element */
662 ret
= mi_lttng_close_multi_element(writer
, 2);
666 pid_element_open
= 0;
669 cur_pid
= fields
[i
].event
.pid
;
670 cmdline
= get_cmdline_by_pid(cur_pid
);
671 if (!pid_element_open
) {
672 /* Open and write a pid element */
673 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
678 /* Open events element */
679 ret
= mi_lttng_events_open(writer
);
683 pid_element_open
= 1;
686 /* Wipe current event since we are about to print a new PID. */
687 memset(&cur_event
, 0, sizeof(cur_event
));
690 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
691 if (event_element_open
) {
692 /* Close the previous fields element and the previous event */
693 ret
= mi_lttng_close_multi_element(writer
, 2);
697 event_element_open
= 0;
700 memcpy(&cur_event
, &fields
[i
].event
,
703 if (!event_element_open
) {
704 /* Open and write the event */
705 ret
= mi_lttng_event(writer
, &cur_event
, 1,
706 handle
->domain
.type
);
711 /* Open a fields element */
712 ret
= mi_lttng_event_fields_open(writer
);
716 event_element_open
= 1;
720 /* Print the event_field */
721 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
727 /* Close pid, domain, domains */
728 ret
= mi_lttng_close_multi_element(writer
, 3);
737 * Ask session daemon for all user space tracepoint fields available.
739 static int list_ust_event_fields(void)
741 int i
, size
, ret
= CMD_SUCCESS
;
742 struct lttng_domain domain
;
743 struct lttng_handle
*handle
;
744 struct lttng_event_field
*event_field_list
;
746 char *cmdline
= NULL
;
748 struct lttng_event cur_event
;
750 memset(&domain
, 0, sizeof(domain
));
751 memset(&cur_event
, 0, sizeof(cur_event
));
753 DBG("Getting UST tracing event fields");
755 domain
.type
= LTTNG_DOMAIN_UST
;
757 handle
= lttng_create_handle(NULL
, &domain
);
758 if (handle
== NULL
) {
763 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
765 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
772 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
779 MSG("UST events:\n-------------");
785 for (i
= 0; i
< size
; i
++) {
786 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
787 cur_pid
= event_field_list
[i
].event
.pid
;
788 cmdline
= get_cmdline_by_pid(cur_pid
);
789 if (cmdline
== NULL
) {
793 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
795 /* Wipe current event since we are about to print a new PID. */
796 memset(&cur_event
, 0, sizeof(cur_event
));
798 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
799 print_events(&event_field_list
[i
].event
);
800 memcpy(&cur_event
, &event_field_list
[i
].event
,
803 print_event_field(&event_field_list
[i
]);
810 free(event_field_list
);
812 lttng_destroy_handle(handle
);
818 * Print a list of kernel events
820 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
821 struct lttng_domain
*domain
)
825 /* Open domains element */
826 ret
= mi_lttng_domains_open(writer
);
832 ret
= mi_lttng_domain(writer
, domain
, 1);
838 ret
= mi_lttng_events_open(writer
);
843 for (i
= 0; i
< count
; i
++) {
844 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
850 /* close events, domain and domains */
851 ret
= mi_lttng_close_multi_element(writer
, 3);
861 * Ask for all trace events in the kernel
863 static int list_kernel_events(void)
865 int i
, size
, ret
= CMD_SUCCESS
;
866 struct lttng_domain domain
;
867 struct lttng_handle
*handle
;
868 struct lttng_event
*event_list
;
870 memset(&domain
, 0, sizeof(domain
));
872 DBG("Getting kernel tracing events");
874 domain
.type
= LTTNG_DOMAIN_KERNEL
;
876 handle
= lttng_create_handle(NULL
, &domain
);
877 if (handle
== NULL
) {
882 size
= lttng_list_tracepoints(handle
, &event_list
);
884 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
885 lttng_destroy_handle(handle
);
891 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
897 MSG("Kernel events:\n-------------");
899 for (i
= 0; i
< size
; i
++) {
900 print_events(&event_list
[i
]);
909 lttng_destroy_handle(handle
);
913 lttng_destroy_handle(handle
);
919 * Print a list of system calls.
921 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
926 ret
= mi_lttng_events_open(writer
);
931 for (i
= 0; i
< count
; i
++) {
932 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
939 ret
= mi_lttng_writer_close_element(writer
);
949 * Ask for kernel system calls.
951 static int list_syscalls(void)
953 int i
, size
, ret
= CMD_SUCCESS
;
954 struct lttng_event
*event_list
;
956 DBG("Getting kernel system call events");
958 size
= lttng_list_syscalls(&event_list
);
960 ERR("Unable to list system calls: %s", lttng_strerror(size
));
967 ret
= mi_list_syscalls(event_list
, size
);
973 MSG("System calls:\n-------------");
975 for (i
= 0; i
< size
; i
++) {
976 print_events(&event_list
[i
]);
992 * Print a list of agent events
994 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
998 /* Open events element */
999 ret
= mi_lttng_events_open(writer
);
1004 for (i
= 0; i
< count
; i
++) {
1005 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1011 /* Close events element */
1012 ret
= mi_lttng_writer_close_element(writer
);
1019 * List agent events for a specific session using the handle.
1021 * Return CMD_SUCCESS on success else a negative value.
1023 static int list_session_agent_events(void)
1025 int ret
= CMD_SUCCESS
, count
, i
;
1026 struct lttng_event
*events
= NULL
;
1028 count
= lttng_list_events(handle
, "", &events
);
1031 ERR("%s", lttng_strerror(count
));
1037 ret
= mi_list_session_agent_events(events
, count
);
1044 MSG("Events (Logger name):\n---------------------");
1046 MSG("%sNone\n", indent6
);
1050 for (i
= 0; i
< count
; i
++) {
1051 const char *filter_str
;
1052 char *filter_msg
= NULL
;
1053 struct lttng_event
*event
= &events
[i
];
1055 ret
= lttng_event_get_filter_expression(event
,
1058 filter_msg
= strdup(" [failed to retrieve filter]");
1059 } else if (filter_str
) {
1060 const char * const filter_fmt
=
1063 filter_msg
= malloc(strlen(filter_str
) +
1064 strlen(filter_fmt
) + 1);
1066 sprintf(filter_msg
, filter_fmt
,
1071 if (event
->loglevel_type
!=
1072 LTTNG_EVENT_LOGLEVEL_ALL
) {
1073 MSG("%s- %s%s (loglevel%s %s)%s", indent4
,
1075 enabled_string(event
->enabled
),
1076 logleveltype_string(
1077 event
->loglevel_type
),
1078 mi_lttng_loglevel_string(
1080 handle
->domain
.type
),
1081 safe_string(filter_msg
));
1083 MSG("%s- %s%s%s", indent4
, event
->name
,
1084 enabled_string(event
->enabled
),
1085 safe_string(filter_msg
));
1101 * print a list of event
1103 static int mi_list_events(struct lttng_event
*events
, int count
)
1107 /* Open events element */
1108 ret
= mi_lttng_events_open(writer
);
1113 for (i
= 0; i
< count
; i
++) {
1114 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1120 /* Close events element */
1121 ret
= mi_lttng_writer_close_element(writer
);
1128 * List events of channel of session and domain.
1130 static int list_events(const char *channel_name
)
1132 int ret
= CMD_SUCCESS
, count
, i
;
1133 struct lttng_event
*events
= NULL
;
1135 count
= lttng_list_events(handle
, channel_name
, &events
);
1138 ERR("%s", lttng_strerror(count
));
1144 ret
= mi_list_events(events
, count
);
1151 MSG("\n%sEvents:", indent4
);
1153 MSG("%sNone\n", indent6
);
1157 for (i
= 0; i
< count
; i
++) {
1158 print_events(&events
[i
]);
1170 * Pretty print channel
1172 static void print_channel(struct lttng_channel
*channel
)
1175 uint64_t discarded_events
, lost_packets
, monitor_timer_interval
;
1177 ret
= lttng_channel_get_discarded_event_count(channel
,
1180 ERR("Failed to retrieve discarded event count of channel");
1184 ret
= lttng_channel_get_lost_packet_count(channel
,
1187 ERR("Failed to retrieve lost packet count of channel");
1191 ret
= lttng_channel_get_monitor_timer_interval(channel
,
1192 &monitor_timer_interval
);
1194 ERR("Failed to retrieve monitor interval of channel");
1198 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1200 MSG("%sAttributes:", indent4
);
1201 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1202 MSG("%ssubbuffers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1203 MSG("%snumber of subbuffers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1204 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1205 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1206 MSG("%smonitor timer interval: %" PRIu64
, indent6
, monitor_timer_interval
);
1207 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1208 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1209 MSG("%sdiscarded events: %" PRIu64
, indent6
, discarded_events
);
1210 MSG("%slost packets: %" PRIu64
, indent6
, lost_packets
);
1211 switch (channel
->attr
.output
) {
1212 case LTTNG_EVENT_SPLICE
:
1213 MSG("%soutput: splice()", indent6
);
1215 case LTTNG_EVENT_MMAP
:
1216 MSG("%soutput: mmap()", indent6
);
1223 * Print a list of channel
1226 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1227 const char *channel_name
)
1230 unsigned int chan_found
= 0;
1232 /* Open channels element */
1233 ret
= mi_lttng_channels_open(writer
);
1238 for (i
= 0; i
< count
; i
++) {
1239 if (channel_name
!= NULL
) {
1240 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1247 /* Write channel element and leave it open */
1248 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1253 /* Listing events per channel */
1254 ret
= list_events(channels
[i
].name
);
1259 /* Closing the channel element we opened earlier */
1260 ret
= mi_lttng_writer_close_element(writer
);
1270 /* Close channels element */
1271 ret
= mi_lttng_writer_close_element(writer
);
1281 * List channel(s) of session and domain.
1283 * If channel_name is NULL, all channels are listed.
1285 static int list_channels(const char *channel_name
)
1287 int count
, i
, ret
= CMD_SUCCESS
;
1288 unsigned int chan_found
= 0;
1289 struct lttng_channel
*channels
= NULL
;
1291 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1293 count
= lttng_list_channels(handle
, &channels
);
1296 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1298 /* When printing mi this is not an error
1299 * but an empty channels element */
1303 WARN("No kernel channel");
1304 goto error_channels
;
1308 /* We had a real error */
1310 ERR("%s", lttng_strerror(count
));
1311 goto error_channels
;
1318 ret
= mi_list_channels(channels
, count
, channel_name
);
1326 MSG("Channels:\n-------------");
1329 for (i
= 0; i
< count
; i
++) {
1330 if (channel_name
!= NULL
) {
1331 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1337 print_channel(&channels
[i
]);
1339 /* Listing events per channel */
1340 ret
= list_events(channels
[i
].name
);
1350 if (!chan_found
&& channel_name
!= NULL
) {
1352 ERR("Channel %s not found", channel_name
);
1364 * List tracker PID(s) of session and domain.
1366 static int list_tracker_pids(void)
1373 ret
= lttng_list_tracker_pids(handle
,
1374 &enabled
, &pids
, &nr_pids
);
1380 _MSG("PID tracker: [");
1382 /* Mi tracker_pid element*/
1384 /* Open tracker_pid and targets elements */
1385 ret
= mi_lttng_pid_tracker_open(writer
);
1391 for (i
= 0; i
< nr_pids
; i
++) {
1395 _MSG(" %d", pids
[i
]);
1399 ret
= mi_lttng_pid_target(writer
, pids
[i
], 0);
1407 /* Mi close tracker_pid and targets */
1409 ret
= mi_lttng_close_multi_element(writer
,2);
1422 * List all tracker of a domain
1424 static int list_trackers(void)
1428 /* Trackers listing */
1430 ret
= mi_lttng_trackers_open(writer
);
1437 ret
= list_tracker_pids();
1443 /* Close trackers element */
1444 ret
= mi_lttng_writer_close_element(writer
);
1456 * Find the session with session_name as name
1457 * and print his informations.
1459 static int mi_list_session(const char *session_name
,
1460 struct lttng_session
*sessions
, int count
)
1463 unsigned int session_found
= 0;
1465 if (session_name
== NULL
) {
1466 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1470 for (i
= 0; i
< count
; i
++) {
1471 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1472 /* We need to leave it open to append other informations
1473 * like domain, channel, events etc.*/
1475 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1483 if (!session_found
) {
1484 ERR("Session '%s' not found", session_name
);
1485 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1495 * List all availables session
1497 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1501 /* Opening sessions element */
1502 ret
= mi_lttng_sessions_open(writer
);
1507 /* Listing sessions */
1508 for (i
= 0; i
< count
; i
++) {
1509 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1515 /* Closing sessions element */
1516 ret
= mi_lttng_writer_close_element(writer
);
1526 * List available tracing session. List only basic information.
1528 * If session_name is NULL, all sessions are listed.
1530 static int list_sessions(const char *session_name
)
1532 int ret
= CMD_SUCCESS
;
1534 unsigned int session_found
= 0;
1535 struct lttng_session
*sessions
;
1537 count
= lttng_list_sessions(&sessions
);
1538 DBG("Session count %d", count
);
1541 ERR("%s", lttng_strerror(count
));
1547 if (session_name
== NULL
) {
1548 /* List all session */
1549 ret
= mi_list_sessions(sessions
, count
);
1551 /* Note : this return an open session element */
1552 ret
= mi_list_session(session_name
, sessions
, count
);
1561 MSG("Currently no available tracing session");
1565 if (session_name
== NULL
) {
1566 MSG("Available tracing sessions:");
1570 for (i
= 0; i
< count
; i
++) {
1571 if (session_name
!= NULL
) {
1572 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1574 MSG("Tracing session %s: [%s%s]", session_name
,
1575 active_string(sessions
[i
].enabled
),
1576 snapshot_string(sessions
[i
].snapshot_mode
));
1577 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1581 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1582 sessions
[i
].name
, sessions
[i
].path
,
1583 active_string(sessions
[i
].enabled
),
1584 snapshot_string(sessions
[i
].snapshot_mode
));
1585 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1586 if (sessions
[i
].live_timer_interval
!= 0) {
1587 MSG("%sLive timer interval (usec): %u", indent4
,
1588 sessions
[i
].live_timer_interval
);
1594 if (!session_found
&& session_name
!= NULL
) {
1595 ERR("Session '%s' not found", session_name
);
1600 if (session_name
== NULL
) {
1601 MSG("\nUse lttng list <session_name> for more details");
1614 * list available domain(s) for a session.
1616 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1619 /* Open domains element */
1620 ret
= mi_lttng_domains_open(writer
);
1625 for (i
= 0; i
< count
; i
++) {
1626 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1632 /* Closing domains element */
1633 ret
= mi_lttng_writer_close_element(writer
);
1642 * List available domain(s) for a session.
1644 static int list_domains(const char *session_name
)
1646 int i
, count
, ret
= CMD_SUCCESS
;
1647 struct lttng_domain
*domains
= NULL
;
1650 count
= lttng_list_domains(session_name
, &domains
);
1653 ERR("%s", lttng_strerror(count
));
1659 ret
= mi_list_domains(domains
, count
);
1666 MSG("Domains:\n-------------");
1672 for (i
= 0; i
< count
; i
++) {
1673 switch (domains
[i
].type
) {
1674 case LTTNG_DOMAIN_KERNEL
:
1677 case LTTNG_DOMAIN_UST
:
1678 MSG(" - UST global");
1680 case LTTNG_DOMAIN_JUL
:
1681 MSG(" - JUL (Java Util Logging)");
1683 case LTTNG_DOMAIN_LOG4J
:
1684 MSG(" - LOG4j (Logging for Java)");
1686 case LTTNG_DOMAIN_PYTHON
:
1687 MSG(" - Python (logging)");
1703 * The 'list <options>' first level command
1705 int cmd_list(int argc
, const char **argv
)
1707 int opt
, ret
= CMD_SUCCESS
;
1708 const char *session_name
;
1709 static poptContext pc
;
1710 struct lttng_domain domain
;
1711 struct lttng_domain
*domains
= NULL
;
1713 memset(&domain
, 0, sizeof(domain
));
1720 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1721 poptReadDefaultConfig(pc
, 0);
1723 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1731 case OPT_LIST_OPTIONS
:
1732 list_cmd_options(stdout
, long_options
);
1735 ret
= CMD_UNDEFINED
;
1742 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1748 /* Open command element */
1749 ret
= mi_lttng_writer_command_open(writer
,
1750 mi_lttng_element_command_list
);
1756 /* Open output element */
1757 ret
= mi_lttng_writer_open_element(writer
,
1758 mi_lttng_element_command_output
);
1765 /* Get session name (trailing argument) */
1766 session_name
= poptGetArg(pc
);
1767 DBG2("Session name: %s", session_name
);
1770 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1771 } else if (opt_userspace
) {
1772 DBG2("Listing userspace global domain");
1773 domain
.type
= LTTNG_DOMAIN_UST
;
1774 } else if (opt_jul
) {
1775 DBG2("Listing JUL domain");
1776 domain
.type
= LTTNG_DOMAIN_JUL
;
1777 } else if (opt_log4j
) {
1778 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1779 } else if (opt_python
) {
1780 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1783 if (!opt_kernel
&& opt_syscall
) {
1784 WARN("--syscall will only work with the Kernel domain (-k)");
1789 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1790 handle
= lttng_create_handle(session_name
, &domain
);
1791 if (handle
== NULL
) {
1797 if (session_name
== NULL
) {
1798 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1800 ret
= list_sessions(NULL
);
1807 ret
= list_syscalls();
1812 ret
= list_kernel_events();
1818 if (opt_userspace
) {
1820 ret
= list_ust_event_fields();
1822 ret
= list_ust_events();
1828 if (opt_jul
|| opt_log4j
|| opt_python
) {
1829 ret
= list_agent_events();
1835 /* List session attributes */
1837 /* Open element sessions
1838 * Present for xml consistency */
1839 ret
= mi_lttng_sessions_open(writer
);
1844 /* MI: the ouptut of list_sessions is an unclosed session element */
1845 ret
= list_sessions(session_name
);
1850 /* Domain listing */
1852 ret
= list_domains(session_name
);
1856 /* Channel listing */
1857 if (opt_kernel
|| opt_userspace
) {
1859 /* Add of domains and domain element for xml
1860 * consistency and validation
1862 ret
= mi_lttng_domains_open(writer
);
1867 /* Open domain and leave it open for
1868 * nested channels printing */
1869 ret
= mi_lttng_domain(writer
, &domain
, 1);
1878 ret
= list_trackers();
1884 ret
= list_channels(opt_channel
);
1890 /* Close domain and domain element */
1891 ret
= mi_lttng_close_multi_element(writer
, 2);
1901 /* We want all domain(s) */
1902 nb_domain
= lttng_list_domains(session_name
, &domains
);
1903 if (nb_domain
< 0) {
1905 ERR("%s", lttng_strerror(nb_domain
));
1910 ret
= mi_lttng_domains_open(writer
);
1917 for (i
= 0; i
< nb_domain
; i
++) {
1918 switch (domains
[i
].type
) {
1919 case LTTNG_DOMAIN_KERNEL
:
1920 MSG("=== Domain: Kernel ===\n");
1922 case LTTNG_DOMAIN_UST
:
1923 MSG("=== Domain: UST global ===\n");
1924 MSG("Buffer type: %s\n",
1925 domains
[i
].buf_type
==
1926 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1928 case LTTNG_DOMAIN_JUL
:
1929 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1931 case LTTNG_DOMAIN_LOG4J
:
1932 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1934 case LTTNG_DOMAIN_PYTHON
:
1935 MSG("=== Domain: Python (logging) ===\n");
1938 MSG("=== Domain: Unimplemented ===\n");
1943 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1950 /* Clean handle before creating a new one */
1952 lttng_destroy_handle(handle
);
1955 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1956 if (handle
== NULL
) {
1961 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1962 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1963 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1964 ret
= list_session_agent_events();
1972 switch (domains
[i
].type
) {
1973 case LTTNG_DOMAIN_KERNEL
:
1974 case LTTNG_DOMAIN_UST
:
1975 ret
= list_trackers();
1984 ret
= list_channels(opt_channel
);
1991 /* Close domain element */
1992 ret
= mi_lttng_writer_close_element(writer
);
2001 /* Close the domains, session and sessions element */
2002 ret
= mi_lttng_close_multi_element(writer
, 3);
2013 /* Close output element */
2014 ret
= mi_lttng_writer_close_element(writer
);
2020 /* Command element close */
2021 ret
= mi_lttng_writer_command_close(writer
);
2029 if (writer
&& mi_lttng_writer_destroy(writer
)) {
2030 /* Preserve original error code */
2031 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
2036 lttng_destroy_handle(handle
);
2039 poptFreeContext(pc
);