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
},
73 static void usage(FILE *ofp
)
75 fprintf(ofp
, "usage: lttng list [OPTIONS] [SESSION [SESSION OPTIONS]]\n");
77 fprintf(ofp
, "With no arguments, list available tracing session(s)\n");
79 fprintf(ofp
, "Without a session, -k lists available kernel events\n");
80 fprintf(ofp
, "Without a session, -u lists available userspace events\n");
82 fprintf(ofp
, " -h, --help Show this help\n");
83 fprintf(ofp
, " --list-options Simple listing of options\n");
84 fprintf(ofp
, " -k, --kernel Select kernel domain\n");
85 fprintf(ofp
, " -u, --userspace Select user-space domain.\n");
86 fprintf(ofp
, " -j, --jul Apply for Java application using JUL\n");
87 fprintf(ofp
, " -l, --log4j Apply for Java application using LOG4J\n");
88 fprintf(ofp
, " -p, --python Apply for Python application using logging\n");
89 fprintf(ofp
, " -f, --fields List event fields.\n");
90 fprintf(ofp
, " --syscall List available system calls.\n");
92 fprintf(ofp
, "Session Options:\n");
93 fprintf(ofp
, " -c, --channel NAME List details of a channel\n");
94 fprintf(ofp
, " -d, --domain List available domain(s)\n");
99 * Get command line from /proc for a specific pid.
101 * On success, return an allocated string pointer to the proc cmdline.
102 * On error, return NULL.
104 static char *get_cmdline_by_pid(pid_t pid
)
108 char *cmdline
= NULL
;
109 /* Can't go bigger than /proc/LTTNG_MAX_PID/cmdline */
110 char path
[sizeof("/proc//cmdline") + sizeof(LTTNG_MAX_PID_STR
) - 1];
112 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
113 fp
= fopen(path
, "r");
118 /* Caller must free() *cmdline */
119 cmdline
= zmalloc(PATH_MAX
);
121 PERROR("malloc cmdline");
124 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
126 PERROR("fread proc list");
137 const char *active_string(int value
)
140 case 0: return "inactive";
141 case 1: return "active";
143 default: return NULL
;
147 static const char *snapshot_string(int value
)
158 const char *enabled_string(int value
)
161 case 0: return " [disabled]";
162 case 1: return " [enabled]";
164 default: return NULL
;
169 const char *safe_string(const char *str
)
171 return str
? str
: "";
174 static const char *logleveltype_string(enum lttng_loglevel_type value
)
177 case LTTNG_EVENT_LOGLEVEL_ALL
:
179 case LTTNG_EVENT_LOGLEVEL_RANGE
:
181 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
184 return " <<TYPE UNKN>>";
188 static const char *bitness_event(enum lttng_event_flag flags
)
190 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_32
) {
191 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
192 return " [32/64-bit]";
196 } else if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
204 * Get exclusion names message for a single event.
206 * Returned pointer must be freed by caller. Returns NULL on error.
208 static char *get_exclusion_names_msg(struct lttng_event
*event
)
212 char *exclusion_msg
= NULL
;
215 const char * const exclusion_fmt
= " [exclusions: ";
216 const size_t exclusion_fmt_len
= strlen(exclusion_fmt
);
218 exclusion_count
= lttng_event_get_exclusion_name_count(event
);
219 if (exclusion_count
< 0) {
221 } else if (exclusion_count
== 0) {
223 * No exclusions: return copy of empty string so that
224 * it can be freed by caller.
226 exclusion_msg
= strdup("");
231 * exclusion_msg's size is bounded by the exclusion_fmt string,
232 * a comma per entry, the entry count (fixed-size), a closing
233 * bracket, and a trailing \0.
235 exclusion_msg
= malloc(exclusion_count
+
236 exclusion_count
* LTTNG_SYMBOL_NAME_LEN
+
237 exclusion_fmt_len
+ 1);
238 if (!exclusion_msg
) {
242 at
= strcpy(exclusion_msg
, exclusion_fmt
) + exclusion_fmt_len
;
243 for (i
= 0; i
< exclusion_count
; ++i
) {
246 /* Append comma between exclusion names */
252 ret
= lttng_event_get_exclusion_name(event
, i
, &name
);
254 /* Prints '?' on local error; should never happen */
260 /* Append exclusion name */
261 at
+= sprintf(at
, "%s", name
);
264 /* This also puts a final '\0' at the end of exclusion_msg */
268 return exclusion_msg
;
272 * Pretty print single event.
274 static void print_events(struct lttng_event
*event
)
277 const char *filter_str
;
278 char *filter_msg
= NULL
;
279 char *exclusion_msg
= NULL
;
281 ret
= lttng_event_get_filter_expression(event
, &filter_str
);
284 filter_msg
= strdup(" [failed to retrieve filter]");
285 } else if (filter_str
) {
286 const char * const filter_fmt
= " [filter: '%s']";
288 filter_msg
= malloc(strlen(filter_str
) +
289 strlen(filter_fmt
) + 1);
291 sprintf(filter_msg
, filter_fmt
,
296 exclusion_msg
= get_exclusion_names_msg(event
);
297 if (!exclusion_msg
) {
298 exclusion_msg
= strdup(" [failed to retrieve exclusions]");
301 switch (event
->type
) {
302 case LTTNG_EVENT_TRACEPOINT
:
304 if (event
->loglevel
!= -1) {
305 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
308 logleveltype_string(event
->loglevel_type
),
309 mi_lttng_loglevel_string(event
->loglevel
, handle
->domain
.type
),
311 enabled_string(event
->enabled
),
312 safe_string(exclusion_msg
),
313 safe_string(filter_msg
));
315 MSG("%s%s (type: tracepoint)%s%s%s",
318 enabled_string(event
->enabled
),
319 safe_string(exclusion_msg
),
320 safe_string(filter_msg
));
324 case LTTNG_EVENT_FUNCTION
:
325 MSG("%s%s (type: function)%s%s", indent6
,
326 event
->name
, enabled_string(event
->enabled
),
327 safe_string(filter_msg
));
328 if (event
->attr
.probe
.addr
!= 0) {
329 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
331 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
332 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
335 case LTTNG_EVENT_PROBE
:
336 MSG("%s%s (type: probe)%s%s", indent6
,
337 event
->name
, enabled_string(event
->enabled
),
338 safe_string(filter_msg
));
339 if (event
->attr
.probe
.addr
!= 0) {
340 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
342 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
343 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
346 case LTTNG_EVENT_FUNCTION_ENTRY
:
347 MSG("%s%s (type: function)%s%s", indent6
,
348 event
->name
, enabled_string(event
->enabled
),
349 safe_string(filter_msg
));
350 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
352 case LTTNG_EVENT_SYSCALL
:
353 MSG("%s%s%s%s%s", indent6
, event
->name
,
354 (opt_syscall
? "" : " (type:syscall)"),
355 enabled_string(event
->enabled
),
356 bitness_event(event
->flags
));
358 case LTTNG_EVENT_NOOP
:
359 MSG("%s (type: noop)%s%s", indent6
,
360 enabled_string(event
->enabled
),
361 safe_string(filter_msg
));
363 case LTTNG_EVENT_ALL
:
364 /* We should never have "all" events in list. */
373 static const char *field_type(struct lttng_event_field
*field
)
375 switch(field
->type
) {
376 case LTTNG_EVENT_FIELD_INTEGER
:
378 case LTTNG_EVENT_FIELD_ENUM
:
380 case LTTNG_EVENT_FIELD_FLOAT
:
382 case LTTNG_EVENT_FIELD_STRING
:
384 case LTTNG_EVENT_FIELD_OTHER
:
385 default: /* fall-through */
391 * Pretty print single event fields.
393 static void print_event_field(struct lttng_event_field
*field
)
395 if (!field
->field_name
[0]) {
398 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
399 field_type(field
), field
->nowrite
? " [no write]" : "");
404 * Jul and ust event listing
406 static int mi_list_agent_ust_events(struct lttng_event
*events
, int count
,
407 struct lttng_domain
*domain
)
411 char *cmdline
= NULL
;
412 int pid_element_open
= 0;
414 /* Open domains element */
415 ret
= mi_lttng_domains_open(writer
);
421 ret
= mi_lttng_domain(writer
, domain
, 1);
426 /* Open pids element element */
427 ret
= mi_lttng_pids_open(writer
);
432 for (i
= 0; i
< count
; i
++) {
433 if (cur_pid
!= events
[i
].pid
) {
434 if (pid_element_open
) {
435 /* Close the previous events and pid element */
436 ret
= mi_lttng_close_multi_element(writer
, 2);
440 pid_element_open
= 0;
443 cur_pid
= events
[i
].pid
;
444 cmdline
= get_cmdline_by_pid(cur_pid
);
450 if (!pid_element_open
) {
451 /* Open and write a pid element */
452 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
457 /* Open events element */
458 ret
= mi_lttng_events_open(writer
);
463 pid_element_open
= 1;
469 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
476 ret
= mi_lttng_writer_close_element(writer
);
481 /* Close domain, domains */
482 ret
= mi_lttng_close_multi_element(writer
, 2);
490 static int list_agent_events(void)
492 int i
, size
, ret
= CMD_SUCCESS
;
493 struct lttng_domain domain
;
494 struct lttng_handle
*handle
= NULL
;
495 struct lttng_event
*event_list
= NULL
;
497 char *cmdline
= NULL
;
498 const char *agent_domain_str
;
500 memset(&domain
, 0, sizeof(domain
));
502 domain
.type
= LTTNG_DOMAIN_JUL
;
503 } else if (opt_log4j
) {
504 domain
.type
= LTTNG_DOMAIN_LOG4J
;
505 } else if (opt_python
) {
506 domain
.type
= LTTNG_DOMAIN_PYTHON
;
508 ERR("Invalid agent domain selected.");
513 agent_domain_str
= get_domain_str(domain
.type
);
515 DBG("Getting %s tracing events", agent_domain_str
);
517 handle
= lttng_create_handle(NULL
, &domain
);
518 if (handle
== NULL
) {
523 size
= lttng_list_tracepoints(handle
, &event_list
);
525 ERR("Unable to list %s events: %s", agent_domain_str
,
526 lttng_strerror(size
));
533 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
540 MSG("%s events (Logger name):\n-------------------------",
547 for (i
= 0; i
< size
; i
++) {
548 if (cur_pid
!= event_list
[i
].pid
) {
549 cur_pid
= event_list
[i
].pid
;
550 cmdline
= get_cmdline_by_pid(cur_pid
);
551 if (cmdline
== NULL
) {
555 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
558 MSG("%s- %s", indent6
, event_list
[i
].name
);
567 lttng_destroy_handle(handle
);
572 * Ask session daemon for all user space tracepoints available.
574 static int list_ust_events(void)
576 int i
, size
, ret
= CMD_SUCCESS
;
577 struct lttng_domain domain
;
578 struct lttng_handle
*handle
;
579 struct lttng_event
*event_list
= NULL
;
581 char *cmdline
= NULL
;
583 memset(&domain
, 0, sizeof(domain
));
585 DBG("Getting UST tracing events");
587 domain
.type
= LTTNG_DOMAIN_UST
;
589 handle
= lttng_create_handle(NULL
, &domain
);
590 if (handle
== NULL
) {
595 size
= lttng_list_tracepoints(handle
, &event_list
);
597 ERR("Unable to list UST events: %s", lttng_strerror(size
));
604 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
607 MSG("UST events:\n-------------");
613 for (i
= 0; i
< size
; i
++) {
614 if (cur_pid
!= event_list
[i
].pid
) {
615 cur_pid
= event_list
[i
].pid
;
616 cmdline
= get_cmdline_by_pid(cur_pid
);
617 if (cmdline
== NULL
) {
621 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
624 print_events(&event_list
[i
]);
633 lttng_destroy_handle(handle
);
639 * List all ust event with their fields
641 static int mi_list_ust_event_fields(struct lttng_event_field
*fields
, int count
,
642 struct lttng_domain
*domain
)
646 char *cmdline
= NULL
;
647 int pid_element_open
= 0;
648 int event_element_open
= 0;
649 struct lttng_event cur_event
;
651 /* Open domains element */
652 ret
= mi_lttng_domains_open(writer
);
658 ret
= mi_lttng_domain(writer
, domain
, 1);
663 /* Open pids element */
664 ret
= mi_lttng_pids_open(writer
);
669 for (i
= 0; i
< count
; i
++) {
670 if (cur_pid
!= fields
[i
].event
.pid
) {
671 if (pid_element_open
) {
672 if (event_element_open
) {
674 /* Close the previous field element and event. */
675 ret
= mi_lttng_close_multi_element(writer
, 2);
679 event_element_open
= 0;
681 /* Close the previous events, pid element */
682 ret
= mi_lttng_close_multi_element(writer
, 2);
686 pid_element_open
= 0;
689 cur_pid
= fields
[i
].event
.pid
;
690 cmdline
= get_cmdline_by_pid(cur_pid
);
691 if (!pid_element_open
) {
692 /* Open and write a pid element */
693 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
698 /* Open events element */
699 ret
= mi_lttng_events_open(writer
);
703 pid_element_open
= 1;
706 /* Wipe current event since we are about to print a new PID. */
707 memset(&cur_event
, 0, sizeof(cur_event
));
710 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
711 if (event_element_open
) {
712 /* Close the previous fields element and the previous event */
713 ret
= mi_lttng_close_multi_element(writer
, 2);
717 event_element_open
= 0;
720 memcpy(&cur_event
, &fields
[i
].event
,
723 if (!event_element_open
) {
724 /* Open and write the event */
725 ret
= mi_lttng_event(writer
, &cur_event
, 1,
726 handle
->domain
.type
);
731 /* Open a fields element */
732 ret
= mi_lttng_event_fields_open(writer
);
736 event_element_open
= 1;
740 /* Print the event_field */
741 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
747 /* Close pid, domain, domains */
748 ret
= mi_lttng_close_multi_element(writer
, 3);
757 * Ask session daemon for all user space tracepoint fields available.
759 static int list_ust_event_fields(void)
761 int i
, size
, ret
= CMD_SUCCESS
;
762 struct lttng_domain domain
;
763 struct lttng_handle
*handle
;
764 struct lttng_event_field
*event_field_list
;
766 char *cmdline
= NULL
;
768 struct lttng_event cur_event
;
770 memset(&domain
, 0, sizeof(domain
));
771 memset(&cur_event
, 0, sizeof(cur_event
));
773 DBG("Getting UST tracing event fields");
775 domain
.type
= LTTNG_DOMAIN_UST
;
777 handle
= lttng_create_handle(NULL
, &domain
);
778 if (handle
== NULL
) {
783 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
785 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
792 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
799 MSG("UST events:\n-------------");
805 for (i
= 0; i
< size
; i
++) {
806 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
807 cur_pid
= event_field_list
[i
].event
.pid
;
808 cmdline
= get_cmdline_by_pid(cur_pid
);
809 if (cmdline
== NULL
) {
813 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
815 /* Wipe current event since we are about to print a new PID. */
816 memset(&cur_event
, 0, sizeof(cur_event
));
818 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
819 print_events(&event_field_list
[i
].event
);
820 memcpy(&cur_event
, &event_field_list
[i
].event
,
823 print_event_field(&event_field_list
[i
]);
830 free(event_field_list
);
832 lttng_destroy_handle(handle
);
838 * Print a list of kernel events
840 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
841 struct lttng_domain
*domain
)
845 /* Open domains element */
846 ret
= mi_lttng_domains_open(writer
);
852 ret
= mi_lttng_domain(writer
, domain
, 1);
858 ret
= mi_lttng_events_open(writer
);
863 for (i
= 0; i
< count
; i
++) {
864 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
870 /* close events, domain and domains */
871 ret
= mi_lttng_close_multi_element(writer
, 3);
881 * Ask for all trace events in the kernel
883 static int list_kernel_events(void)
885 int i
, size
, ret
= CMD_SUCCESS
;
886 struct lttng_domain domain
;
887 struct lttng_handle
*handle
;
888 struct lttng_event
*event_list
;
890 memset(&domain
, 0, sizeof(domain
));
892 DBG("Getting kernel tracing events");
894 domain
.type
= LTTNG_DOMAIN_KERNEL
;
896 handle
= lttng_create_handle(NULL
, &domain
);
897 if (handle
== NULL
) {
902 size
= lttng_list_tracepoints(handle
, &event_list
);
904 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
905 lttng_destroy_handle(handle
);
911 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
917 MSG("Kernel events:\n-------------");
919 for (i
= 0; i
< size
; i
++) {
920 print_events(&event_list
[i
]);
929 lttng_destroy_handle(handle
);
933 lttng_destroy_handle(handle
);
939 * Print a list of system calls.
941 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
946 ret
= mi_lttng_events_open(writer
);
951 for (i
= 0; i
< count
; i
++) {
952 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
959 ret
= mi_lttng_writer_close_element(writer
);
969 * Ask for kernel system calls.
971 static int list_syscalls(void)
973 int i
, size
, ret
= CMD_SUCCESS
;
974 struct lttng_event
*event_list
;
976 DBG("Getting kernel system call events");
978 size
= lttng_list_syscalls(&event_list
);
980 ERR("Unable to list system calls: %s", lttng_strerror(size
));
987 ret
= mi_list_syscalls(event_list
, size
);
993 MSG("System calls:\n-------------");
995 for (i
= 0; i
< size
; i
++) {
996 print_events(&event_list
[i
]);
1012 * Print a list of agent events
1014 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
1018 /* Open events element */
1019 ret
= mi_lttng_events_open(writer
);
1024 for (i
= 0; i
< count
; i
++) {
1025 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1031 /* Close events element */
1032 ret
= mi_lttng_writer_close_element(writer
);
1039 * List agent events for a specific session using the handle.
1041 * Return CMD_SUCCESS on success else a negative value.
1043 static int list_session_agent_events(void)
1045 int ret
= CMD_SUCCESS
, count
, i
;
1046 struct lttng_event
*events
= NULL
;
1048 count
= lttng_list_events(handle
, "", &events
);
1051 ERR("%s", lttng_strerror(count
));
1057 ret
= mi_list_session_agent_events(events
, count
);
1064 MSG("Events (Logger name):\n---------------------");
1066 MSG("%sNone\n", indent6
);
1070 for (i
= 0; i
< count
; i
++) {
1071 const char *filter_str
;
1072 char *filter_msg
= NULL
;
1073 struct lttng_event
*event
= &events
[i
];
1075 ret
= lttng_event_get_filter_expression(event
,
1078 filter_msg
= strdup(" [failed to retrieve filter]");
1079 } else if (filter_str
) {
1080 const char * const filter_fmt
=
1083 filter_msg
= malloc(strlen(filter_str
) +
1084 strlen(filter_fmt
) + 1);
1086 sprintf(filter_msg
, filter_fmt
,
1091 if (event
->loglevel_type
!=
1092 LTTNG_EVENT_LOGLEVEL_ALL
) {
1093 MSG("%s- %s%s (loglevel%s %s)%s", indent4
,
1095 enabled_string(event
->enabled
),
1096 logleveltype_string(
1097 event
->loglevel_type
),
1098 mi_lttng_loglevel_string(
1100 handle
->domain
.type
),
1101 safe_string(filter_msg
));
1103 MSG("%s- %s%s%s", indent4
, event
->name
,
1104 enabled_string(event
->enabled
),
1105 safe_string(filter_msg
));
1121 * print a list of event
1123 static int mi_list_events(struct lttng_event
*events
, int count
)
1127 /* Open events element */
1128 ret
= mi_lttng_events_open(writer
);
1133 for (i
= 0; i
< count
; i
++) {
1134 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1140 /* Close events element */
1141 ret
= mi_lttng_writer_close_element(writer
);
1148 * List events of channel of session and domain.
1150 static int list_events(const char *channel_name
)
1152 int ret
= CMD_SUCCESS
, count
, i
;
1153 struct lttng_event
*events
= NULL
;
1155 count
= lttng_list_events(handle
, channel_name
, &events
);
1158 ERR("%s", lttng_strerror(count
));
1164 ret
= mi_list_events(events
, count
);
1171 MSG("\n%sEvents:", indent4
);
1173 MSG("%sNone\n", indent6
);
1177 for (i
= 0; i
< count
; i
++) {
1178 print_events(&events
[i
]);
1190 * Pretty print channel
1192 static void print_channel(struct lttng_channel
*channel
)
1195 uint64_t discarded_events
, lost_packets
;
1197 ret
= lttng_channel_get_discarded_event_count(channel
,
1200 ERR("Failed to retrieve discarded event count of channel");
1204 ret
= lttng_channel_get_lost_packet_count(channel
,
1207 ERR("Failed to retrieve lost packet count of channel");
1211 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1213 MSG("%sAttributes:", indent4
);
1214 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1215 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1216 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1217 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1218 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1219 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1220 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1221 MSG("%sdiscarded events: %" PRIu64
, indent6
, discarded_events
);
1222 MSG("%slost packets: %" PRIu64
, indent6
, lost_packets
);
1223 switch (channel
->attr
.output
) {
1224 case LTTNG_EVENT_SPLICE
:
1225 MSG("%soutput: splice()", indent6
);
1227 case LTTNG_EVENT_MMAP
:
1228 MSG("%soutput: mmap()", indent6
);
1235 * Print a list of channel
1238 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1239 const char *channel_name
)
1242 unsigned int chan_found
= 0;
1244 /* Open channels element */
1245 ret
= mi_lttng_channels_open(writer
);
1250 for (i
= 0; i
< count
; i
++) {
1251 if (channel_name
!= NULL
) {
1252 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1259 /* Write channel element and leave it open */
1260 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1265 /* Listing events per channel */
1266 ret
= list_events(channels
[i
].name
);
1271 /* Closing the channel element we opened earlier */
1272 ret
= mi_lttng_writer_close_element(writer
);
1282 /* Close channels element */
1283 ret
= mi_lttng_writer_close_element(writer
);
1293 * List channel(s) of session and domain.
1295 * If channel_name is NULL, all channels are listed.
1297 static int list_channels(const char *channel_name
)
1299 int count
, i
, ret
= CMD_SUCCESS
;
1300 unsigned int chan_found
= 0;
1301 struct lttng_channel
*channels
= NULL
;
1303 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1305 count
= lttng_list_channels(handle
, &channels
);
1308 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1310 /* When printing mi this is not an error
1311 * but an empty channels element */
1315 WARN("No kernel channel");
1316 goto error_channels
;
1320 /* We had a real error */
1322 ERR("%s", lttng_strerror(count
));
1323 goto error_channels
;
1330 ret
= mi_list_channels(channels
, count
, channel_name
);
1338 MSG("Channels:\n-------------");
1341 for (i
= 0; i
< count
; i
++) {
1342 if (channel_name
!= NULL
) {
1343 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1349 print_channel(&channels
[i
]);
1351 /* Listing events per channel */
1352 ret
= list_events(channels
[i
].name
);
1362 if (!chan_found
&& channel_name
!= NULL
) {
1364 ERR("Channel %s not found", channel_name
);
1376 * List tracker PID(s) of session and domain.
1378 static int list_tracker_pids(void)
1385 ret
= lttng_list_tracker_pids(handle
,
1386 &enabled
, &pids
, &nr_pids
);
1392 _MSG("PID tracker: [");
1394 /* Mi tracker_pid element*/
1396 /* Open tracker_pid and targets elements */
1397 ret
= mi_lttng_pid_tracker_open(writer
);
1403 for (i
= 0; i
< nr_pids
; i
++) {
1407 _MSG(" %d", pids
[i
]);
1411 ret
= mi_lttng_pid_target(writer
, pids
[i
], 0);
1419 /* Mi close tracker_pid and targets */
1421 ret
= mi_lttng_close_multi_element(writer
,2);
1434 * List all tracker of a domain
1436 static int list_trackers(void)
1440 /* Trackers listing */
1442 ret
= mi_lttng_trackers_open(writer
);
1449 ret
= list_tracker_pids();
1455 /* Close trackers element */
1456 ret
= mi_lttng_writer_close_element(writer
);
1468 * Find the session with session_name as name
1469 * and print his informations.
1471 static int mi_list_session(const char *session_name
,
1472 struct lttng_session
*sessions
, int count
)
1475 unsigned int session_found
= 0;
1477 if (session_name
== NULL
) {
1478 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1482 for (i
= 0; i
< count
; i
++) {
1483 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1484 /* We need to leave it open to append other informations
1485 * like domain, channel, events etc.*/
1487 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1495 if (!session_found
) {
1496 ERR("Session '%s' not found", session_name
);
1497 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1507 * List all availables session
1509 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1513 /* Opening sessions element */
1514 ret
= mi_lttng_sessions_open(writer
);
1519 /* Listing sessions */
1520 for (i
= 0; i
< count
; i
++) {
1521 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1527 /* Closing sessions element */
1528 ret
= mi_lttng_writer_close_element(writer
);
1538 * List available tracing session. List only basic information.
1540 * If session_name is NULL, all sessions are listed.
1542 static int list_sessions(const char *session_name
)
1544 int ret
= CMD_SUCCESS
;
1546 unsigned int session_found
= 0;
1547 struct lttng_session
*sessions
;
1549 count
= lttng_list_sessions(&sessions
);
1550 DBG("Session count %d", count
);
1553 ERR("%s", lttng_strerror(count
));
1559 if (session_name
== NULL
) {
1560 /* List all session */
1561 ret
= mi_list_sessions(sessions
, count
);
1563 /* Note : this return an open session element */
1564 ret
= mi_list_session(session_name
, sessions
, count
);
1573 MSG("Currently no available tracing session");
1577 if (session_name
== NULL
) {
1578 MSG("Available tracing sessions:");
1582 for (i
= 0; i
< count
; i
++) {
1583 if (session_name
!= NULL
) {
1584 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1586 MSG("Tracing session %s: [%s%s]", session_name
,
1587 active_string(sessions
[i
].enabled
),
1588 snapshot_string(sessions
[i
].snapshot_mode
));
1589 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1593 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1594 sessions
[i
].name
, sessions
[i
].path
,
1595 active_string(sessions
[i
].enabled
),
1596 snapshot_string(sessions
[i
].snapshot_mode
));
1597 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1598 if (sessions
[i
].live_timer_interval
!= 0) {
1599 MSG("%sLive timer interval (usec): %u", indent4
,
1600 sessions
[i
].live_timer_interval
);
1606 if (!session_found
&& session_name
!= NULL
) {
1607 ERR("Session '%s' not found", session_name
);
1612 if (session_name
== NULL
) {
1613 MSG("\nUse lttng list <session_name> for more details");
1626 * list available domain(s) for a session.
1628 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1631 /* Open domains element */
1632 ret
= mi_lttng_domains_open(writer
);
1637 for (i
= 0; i
< count
; i
++) {
1638 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1644 /* Closing domains element */
1645 ret
= mi_lttng_writer_close_element(writer
);
1654 * List available domain(s) for a session.
1656 static int list_domains(const char *session_name
)
1658 int i
, count
, ret
= CMD_SUCCESS
;
1659 struct lttng_domain
*domains
= NULL
;
1662 count
= lttng_list_domains(session_name
, &domains
);
1665 ERR("%s", lttng_strerror(count
));
1671 ret
= mi_list_domains(domains
, count
);
1678 MSG("Domains:\n-------------");
1684 for (i
= 0; i
< count
; i
++) {
1685 switch (domains
[i
].type
) {
1686 case LTTNG_DOMAIN_KERNEL
:
1689 case LTTNG_DOMAIN_UST
:
1690 MSG(" - UST global");
1692 case LTTNG_DOMAIN_JUL
:
1693 MSG(" - JUL (Java Util Logging)");
1695 case LTTNG_DOMAIN_LOG4J
:
1696 MSG(" - LOG4j (Logging for Java)");
1698 case LTTNG_DOMAIN_PYTHON
:
1699 MSG(" - Python (logging)");
1715 * The 'list <options>' first level command
1717 int cmd_list(int argc
, const char **argv
)
1719 int opt
, ret
= CMD_SUCCESS
;
1720 const char *session_name
;
1721 static poptContext pc
;
1722 struct lttng_domain domain
;
1723 struct lttng_domain
*domains
= NULL
;
1725 memset(&domain
, 0, sizeof(domain
));
1733 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1734 poptReadDefaultConfig(pc
, 0);
1736 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1744 case OPT_LIST_OPTIONS
:
1745 list_cmd_options(stdout
, long_options
);
1749 ret
= CMD_UNDEFINED
;
1756 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1762 /* Open command element */
1763 ret
= mi_lttng_writer_command_open(writer
,
1764 mi_lttng_element_command_list
);
1770 /* Open output element */
1771 ret
= mi_lttng_writer_open_element(writer
,
1772 mi_lttng_element_command_output
);
1779 /* Get session name (trailing argument) */
1780 session_name
= poptGetArg(pc
);
1781 DBG2("Session name: %s", session_name
);
1784 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1785 } else if (opt_userspace
) {
1786 DBG2("Listing userspace global domain");
1787 domain
.type
= LTTNG_DOMAIN_UST
;
1788 } else if (opt_jul
) {
1789 DBG2("Listing JUL domain");
1790 domain
.type
= LTTNG_DOMAIN_JUL
;
1791 } else if (opt_log4j
) {
1792 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1793 } else if (opt_python
) {
1794 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1797 if (!opt_kernel
&& opt_syscall
) {
1798 WARN("--syscall will only work with the Kernel domain (-k)");
1803 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1804 handle
= lttng_create_handle(session_name
, &domain
);
1805 if (handle
== NULL
) {
1811 if (session_name
== NULL
) {
1812 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1814 ret
= list_sessions(NULL
);
1821 ret
= list_syscalls();
1826 ret
= list_kernel_events();
1832 if (opt_userspace
) {
1834 ret
= list_ust_event_fields();
1836 ret
= list_ust_events();
1842 if (opt_jul
|| opt_log4j
|| opt_python
) {
1843 ret
= list_agent_events();
1849 /* List session attributes */
1851 /* Open element sessions
1852 * Present for xml consistency */
1853 ret
= mi_lttng_sessions_open(writer
);
1858 /* MI: the ouptut of list_sessions is an unclosed session element */
1859 ret
= list_sessions(session_name
);
1864 /* Domain listing */
1866 ret
= list_domains(session_name
);
1870 /* Channel listing */
1871 if (opt_kernel
|| opt_userspace
) {
1873 /* Add of domains and domain element for xml
1874 * consistency and validation
1876 ret
= mi_lttng_domains_open(writer
);
1881 /* Open domain and leave it open for
1882 * nested channels printing */
1883 ret
= mi_lttng_domain(writer
, &domain
, 1);
1892 ret
= list_trackers();
1898 ret
= list_channels(opt_channel
);
1904 /* Close domain and domain element */
1905 ret
= mi_lttng_close_multi_element(writer
, 2);
1915 /* We want all domain(s) */
1916 nb_domain
= lttng_list_domains(session_name
, &domains
);
1917 if (nb_domain
< 0) {
1919 ERR("%s", lttng_strerror(nb_domain
));
1924 ret
= mi_lttng_domains_open(writer
);
1931 for (i
= 0; i
< nb_domain
; i
++) {
1932 switch (domains
[i
].type
) {
1933 case LTTNG_DOMAIN_KERNEL
:
1934 MSG("=== Domain: Kernel ===\n");
1936 case LTTNG_DOMAIN_UST
:
1937 MSG("=== Domain: UST global ===\n");
1938 MSG("Buffer type: %s\n",
1939 domains
[i
].buf_type
==
1940 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1942 case LTTNG_DOMAIN_JUL
:
1943 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1945 case LTTNG_DOMAIN_LOG4J
:
1946 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1948 case LTTNG_DOMAIN_PYTHON
:
1949 MSG("=== Domain: Python (logging) ===\n");
1952 MSG("=== Domain: Unimplemented ===\n");
1957 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1964 /* Clean handle before creating a new one */
1966 lttng_destroy_handle(handle
);
1969 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1970 if (handle
== NULL
) {
1975 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1976 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1977 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1978 ret
= list_session_agent_events();
1986 switch (domains
[i
].type
) {
1987 case LTTNG_DOMAIN_KERNEL
:
1988 case LTTNG_DOMAIN_UST
:
1989 ret
= list_trackers();
1998 ret
= list_channels(opt_channel
);
2005 /* Close domain element */
2006 ret
= mi_lttng_writer_close_element(writer
);
2015 /* Close the domains, session and sessions element */
2016 ret
= mi_lttng_close_multi_element(writer
, 3);
2027 /* Close output element */
2028 ret
= mi_lttng_writer_close_element(writer
);
2034 /* Command element close */
2035 ret
= mi_lttng_writer_command_close(writer
);
2043 if (writer
&& mi_lttng_writer_destroy(writer
)) {
2044 /* Preserve original error code */
2045 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
2050 lttng_destroy_handle(handle
);
2053 poptFreeContext(pc
);