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>
28 #include "../command.h"
30 static int opt_userspace
;
31 static int opt_kernel
;
34 static int opt_python
;
35 static char *opt_channel
;
36 static int opt_domain
;
37 static int opt_fields
;
38 static int opt_syscall
;
40 /* Not implemented yet */
41 static char *opt_cmd_name
;
45 const char *indent4
= " ";
46 const char *indent6
= " ";
47 const char *indent8
= " ";
55 static struct lttng_handle
*handle
;
56 static struct mi_writer
*writer
;
58 static struct poptOption long_options
[] = {
59 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
60 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
61 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
62 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
63 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
64 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
66 /* Not implemented yet */
67 {"userspace", 'u', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_cmd_name
, OPT_USERSPACE
, 0, 0},
68 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
70 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
72 {"channel", 'c', POPT_ARG_STRING
, &opt_channel
, 0, 0, 0},
73 {"domain", 'd', POPT_ARG_VAL
, &opt_domain
, 1, 0, 0},
74 {"fields", 'f', POPT_ARG_VAL
, &opt_fields
, 1, 0, 0},
75 {"syscall", 'S', POPT_ARG_VAL
, &opt_syscall
, 1, 0, 0},
76 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
83 static void usage(FILE *ofp
)
85 fprintf(ofp
, "usage: lttng list [OPTIONS] [SESSION [SESSION OPTIONS]]\n");
87 fprintf(ofp
, "With no arguments, list available tracing session(s)\n");
89 fprintf(ofp
, "Without a session, -k lists available kernel events\n");
90 fprintf(ofp
, "Without a session, -u lists available userspace events\n");
92 fprintf(ofp
, " -h, --help Show this help\n");
93 fprintf(ofp
, " --list-options Simple listing of options\n");
94 fprintf(ofp
, " -k, --kernel Select kernel domain\n");
95 fprintf(ofp
, " -u, --userspace Select user-space domain.\n");
96 fprintf(ofp
, " -j, --jul Apply for Java application using JUL\n");
97 fprintf(ofp
, " -l, --log4j Apply for Java application using LOG4J\n");
98 fprintf(ofp
, " -p, --python Apply for Python application using logging\n");
99 fprintf(ofp
, " -f, --fields List event fields.\n");
100 fprintf(ofp
, " --syscall List available system calls.\n");
102 fprintf(ofp
, " -p, --pid PID List user-space events by PID\n");
105 fprintf(ofp
, "Session Options:\n");
106 fprintf(ofp
, " -c, --channel NAME List details of a channel\n");
107 fprintf(ofp
, " -d, --domain List available domain(s)\n");
112 * Get command line from /proc for a specific pid.
114 * On success, return an allocated string pointer to the proc cmdline.
115 * On error, return NULL.
117 static char *get_cmdline_by_pid(pid_t pid
)
121 char *cmdline
= NULL
;
122 char path
[20]; /* Can't go bigger than /proc/65535/cmdline */
124 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
125 fp
= fopen(path
, "r");
130 /* Caller must free() *cmdline */
131 cmdline
= malloc(PATH_MAX
);
133 perror("malloc cmdline");
136 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
138 perror("fread proc list");
149 const char *active_string(int value
)
152 case 0: return "inactive";
153 case 1: return "active";
155 default: return NULL
;
159 static const char *snapshot_string(int value
)
170 const char *enabled_string(int value
)
173 case 0: return " [disabled]";
174 case 1: return " [enabled]";
176 default: return NULL
;
181 const char *filter_string(int value
)
184 case 1: return " [with filter]";
190 const char *exclusion_string(int value
)
193 case 1: return " [has exclusions]";
198 static const char *logleveltype_string(enum lttng_loglevel_type value
)
201 case LTTNG_EVENT_LOGLEVEL_ALL
:
203 case LTTNG_EVENT_LOGLEVEL_RANGE
:
205 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
208 return " <<TYPE UNKN>>";
212 static const char *bitness_event(enum lttng_event_flag flags
)
214 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_32
) {
215 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
216 return " [32/64-bit]";
220 } else if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
228 * Pretty print single event.
230 static void print_events(struct lttng_event
*event
)
232 switch (event
->type
) {
233 case LTTNG_EVENT_TRACEPOINT
:
235 if (event
->loglevel
!= -1) {
236 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
239 logleveltype_string(event
->loglevel_type
),
240 mi_lttng_loglevel_string(event
->loglevel
, handle
->domain
.type
),
242 enabled_string(event
->enabled
),
243 exclusion_string(event
->exclusion
),
244 filter_string(event
->filter
));
246 MSG("%s%s (type: tracepoint)%s%s%s",
249 enabled_string(event
->enabled
),
250 exclusion_string(event
->exclusion
),
251 filter_string(event
->filter
));
255 case LTTNG_EVENT_FUNCTION
:
256 MSG("%s%s (type: function)%s%s", indent6
,
257 event
->name
, enabled_string(event
->enabled
),
258 filter_string(event
->filter
));
259 if (event
->attr
.probe
.addr
!= 0) {
260 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
262 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
263 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
266 case LTTNG_EVENT_PROBE
:
267 MSG("%s%s (type: probe)%s%s", indent6
,
268 event
->name
, enabled_string(event
->enabled
),
269 filter_string(event
->filter
));
270 if (event
->attr
.probe
.addr
!= 0) {
271 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
273 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
274 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
277 case LTTNG_EVENT_FUNCTION_ENTRY
:
278 MSG("%s%s (type: function)%s%s", indent6
,
279 event
->name
, enabled_string(event
->enabled
),
280 filter_string(event
->filter
));
281 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
283 case LTTNG_EVENT_SYSCALL
:
284 MSG("%s%s%s%s%s", indent6
, event
->name
,
285 (opt_syscall
? "" : " (type:syscall)"),
286 enabled_string(event
->enabled
),
287 bitness_event(event
->flags
));
289 case LTTNG_EVENT_NOOP
:
290 MSG("%s (type: noop)%s%s", indent6
,
291 enabled_string(event
->enabled
),
292 filter_string(event
->filter
));
294 case LTTNG_EVENT_ALL
:
295 /* We should never have "all" events in list. */
301 static const char *field_type(struct lttng_event_field
*field
)
303 switch(field
->type
) {
304 case LTTNG_EVENT_FIELD_INTEGER
:
306 case LTTNG_EVENT_FIELD_ENUM
:
308 case LTTNG_EVENT_FIELD_FLOAT
:
310 case LTTNG_EVENT_FIELD_STRING
:
312 case LTTNG_EVENT_FIELD_OTHER
:
313 default: /* fall-through */
319 * Pretty print single event fields.
321 static void print_event_field(struct lttng_event_field
*field
)
323 if (!field
->field_name
[0]) {
326 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
327 field_type(field
), field
->nowrite
? " [no write]" : "");
332 * Jul and ust event listing
334 static int mi_list_agent_ust_events(struct lttng_event
*events
, int count
,
335 struct lttng_domain
*domain
)
339 char *cmdline
= NULL
;
340 int pid_element_open
= 0;
342 /* Open domains element */
343 ret
= mi_lttng_domains_open(writer
);
349 ret
= mi_lttng_domain(writer
, domain
, 1);
354 /* Open pids element */
355 ret
= mi_lttng_pids_open(writer
);
360 for (i
= 0; i
< count
; i
++) {
361 if (cur_pid
!= events
[i
].pid
) {
362 if (pid_element_open
) {
363 /* Close the previous events and pid element */
364 ret
= mi_lttng_close_multi_element(writer
, 2);
368 pid_element_open
= 0;
371 cur_pid
= events
[i
].pid
;
372 cmdline
= get_cmdline_by_pid(cur_pid
);
378 if (!pid_element_open
) {
379 /* Open and write a pid element */
380 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
385 /* Open events element */
386 ret
= mi_lttng_events_open(writer
);
391 pid_element_open
= 1;
397 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
404 ret
= mi_lttng_writer_close_element(writer
);
409 /* Close domain, domains */
410 ret
= mi_lttng_close_multi_element(writer
, 2);
418 static int list_agent_events(void)
420 int i
, size
, ret
= CMD_SUCCESS
;
421 struct lttng_domain domain
;
422 struct lttng_handle
*handle
;
423 struct lttng_event
*event_list
;
425 char *cmdline
= NULL
;
426 const char *agent_domain_str
;
428 memset(&domain
, 0, sizeof(domain
));
430 domain
.type
= LTTNG_DOMAIN_JUL
;
431 } else if (opt_log4j
) {
432 domain
.type
= LTTNG_DOMAIN_LOG4J
;
433 } else if (opt_python
) {
434 domain
.type
= LTTNG_DOMAIN_PYTHON
;
437 agent_domain_str
= get_domain_str(domain
.type
);
439 DBG("Getting %s tracing events", agent_domain_str
);
441 handle
= lttng_create_handle(NULL
, &domain
);
442 if (handle
== NULL
) {
447 size
= lttng_list_tracepoints(handle
, &event_list
);
449 ERR("Unable to list %s events: %s", agent_domain_str
,
450 lttng_strerror(size
));
457 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
464 MSG("%s events (Logger name):\n-------------------------",
471 for (i
= 0; i
< size
; i
++) {
472 if (cur_pid
!= event_list
[i
].pid
) {
473 cur_pid
= event_list
[i
].pid
;
474 cmdline
= get_cmdline_by_pid(cur_pid
);
475 if (cmdline
== NULL
) {
479 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
482 MSG("%s- %s", indent6
, event_list
[i
].name
);
491 lttng_destroy_handle(handle
);
496 * Ask session daemon for all user space tracepoints available.
498 static int list_ust_events(void)
500 int i
, size
, ret
= CMD_SUCCESS
;
501 struct lttng_domain domain
;
502 struct lttng_handle
*handle
;
503 struct lttng_event
*event_list
;
505 char *cmdline
= NULL
;
507 memset(&domain
, 0, sizeof(domain
));
509 DBG("Getting UST tracing events");
511 domain
.type
= LTTNG_DOMAIN_UST
;
513 handle
= lttng_create_handle(NULL
, &domain
);
514 if (handle
== NULL
) {
519 size
= lttng_list_tracepoints(handle
, &event_list
);
521 ERR("Unable to list UST events: %s", lttng_strerror(size
));
528 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
531 MSG("UST events:\n-------------");
537 for (i
= 0; i
< size
; i
++) {
538 if (cur_pid
!= event_list
[i
].pid
) {
539 cur_pid
= event_list
[i
].pid
;
540 cmdline
= get_cmdline_by_pid(cur_pid
);
541 if (cmdline
== NULL
) {
545 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
548 print_events(&event_list
[i
]);
557 lttng_destroy_handle(handle
);
563 * List all ust event with their fields
565 static int mi_list_ust_event_fields(struct lttng_event_field
*fields
, int count
,
566 struct lttng_domain
*domain
)
570 char *cmdline
= NULL
;
571 int pid_element_open
= 0;
572 int event_element_open
= 0;
573 struct lttng_event cur_event
;
575 /* Open domains element */
576 ret
= mi_lttng_domains_open(writer
);
582 ret
= mi_lttng_domain(writer
, domain
, 1);
587 /* Open pids element */
588 ret
= mi_lttng_pids_open(writer
);
593 for (i
= 0; i
< count
; i
++) {
594 if (cur_pid
!= fields
[i
].event
.pid
) {
595 if (pid_element_open
) {
596 if (event_element_open
) {
598 /* Close the previous field element and event. */
599 ret
= mi_lttng_close_multi_element(writer
, 2);
603 event_element_open
= 0;
605 /* Close the previous events, pid element */
606 ret
= mi_lttng_close_multi_element(writer
, 2);
610 pid_element_open
= 0;
613 cur_pid
= fields
[i
].event
.pid
;
614 cmdline
= get_cmdline_by_pid(cur_pid
);
615 if (!pid_element_open
) {
616 /* Open and write a pid element */
617 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
622 /* Open events element */
623 ret
= mi_lttng_events_open(writer
);
627 pid_element_open
= 1;
630 /* Wipe current event since we are about to print a new PID. */
631 memset(&cur_event
, 0, sizeof(cur_event
));
634 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
635 if (event_element_open
) {
636 /* Close the previous fields element and the previous event */
637 ret
= mi_lttng_close_multi_element(writer
, 2);
641 event_element_open
= 0;
644 memcpy(&cur_event
, &fields
[i
].event
,
647 if (!event_element_open
) {
648 /* Open and write the event */
649 ret
= mi_lttng_event(writer
, &cur_event
, 1,
650 handle
->domain
.type
);
655 /* Open a fields element */
656 ret
= mi_lttng_event_fields_open(writer
);
660 event_element_open
= 1;
664 /* Print the event_field */
665 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
671 /* Close pids, domain, domains */
672 ret
= mi_lttng_close_multi_element(writer
, 3);
681 * Ask session daemon for all user space tracepoint fields available.
683 static int list_ust_event_fields(void)
685 int i
, size
, ret
= CMD_SUCCESS
;
686 struct lttng_domain domain
;
687 struct lttng_handle
*handle
;
688 struct lttng_event_field
*event_field_list
;
690 char *cmdline
= NULL
;
692 struct lttng_event cur_event
;
694 memset(&domain
, 0, sizeof(domain
));
695 memset(&cur_event
, 0, sizeof(cur_event
));
697 DBG("Getting UST tracing event fields");
699 domain
.type
= LTTNG_DOMAIN_UST
;
701 handle
= lttng_create_handle(NULL
, &domain
);
702 if (handle
== NULL
) {
707 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
709 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
716 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
723 MSG("UST events:\n-------------");
729 for (i
= 0; i
< size
; i
++) {
730 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
731 cur_pid
= event_field_list
[i
].event
.pid
;
732 cmdline
= get_cmdline_by_pid(cur_pid
);
733 if (cmdline
== NULL
) {
737 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
739 /* Wipe current event since we are about to print a new PID. */
740 memset(&cur_event
, 0, sizeof(cur_event
));
742 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
743 print_events(&event_field_list
[i
].event
);
744 memcpy(&cur_event
, &event_field_list
[i
].event
,
747 print_event_field(&event_field_list
[i
]);
754 free(event_field_list
);
756 lttng_destroy_handle(handle
);
762 * Print a list of kernel events
764 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
765 struct lttng_domain
*domain
)
769 /* Open domains element */
770 ret
= mi_lttng_domains_open(writer
);
776 ret
= mi_lttng_domain(writer
, domain
, 1);
782 ret
= mi_lttng_events_open(writer
);
787 for (i
= 0; i
< count
; i
++) {
788 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
794 /* close events, domain and domains */
795 ret
= mi_lttng_close_multi_element(writer
, 3);
805 * Ask for all trace events in the kernel
807 static int list_kernel_events(void)
809 int i
, size
, ret
= CMD_SUCCESS
;
810 struct lttng_domain domain
;
811 struct lttng_handle
*handle
;
812 struct lttng_event
*event_list
;
814 memset(&domain
, 0, sizeof(domain
));
816 DBG("Getting kernel tracing events");
818 domain
.type
= LTTNG_DOMAIN_KERNEL
;
820 handle
= lttng_create_handle(NULL
, &domain
);
821 if (handle
== NULL
) {
826 size
= lttng_list_tracepoints(handle
, &event_list
);
828 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
829 lttng_destroy_handle(handle
);
835 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
841 MSG("Kernel events:\n-------------");
843 for (i
= 0; i
< size
; i
++) {
844 print_events(&event_list
[i
]);
853 lttng_destroy_handle(handle
);
857 lttng_destroy_handle(handle
);
863 * Print a list of system calls.
865 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
870 ret
= mi_lttng_events_open(writer
);
875 for (i
= 0; i
< count
; i
++) {
876 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
883 ret
= mi_lttng_writer_close_element(writer
);
893 * Ask for kernel system calls.
895 static int list_syscalls(void)
897 int i
, size
, ret
= CMD_SUCCESS
;
898 struct lttng_event
*event_list
;
900 DBG("Getting kernel system call events");
902 size
= lttng_list_syscalls(&event_list
);
904 ERR("Unable to list system calls: %s", lttng_strerror(size
));
911 ret
= mi_list_syscalls(event_list
, size
);
917 MSG("System calls:\n-------------");
919 for (i
= 0; i
< size
; i
++) {
920 print_events(&event_list
[i
]);
936 * Print a list of agent events
938 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
942 /* Open events element */
943 ret
= mi_lttng_events_open(writer
);
948 for (i
= 0; i
< count
; i
++) {
949 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
955 /* Close events element */
956 ret
= mi_lttng_writer_close_element(writer
);
963 * List agent events for a specific session using the handle.
965 * Return CMD_SUCCESS on success else a negative value.
967 static int list_session_agent_events(void)
969 int ret
= CMD_SUCCESS
, count
, i
;
970 struct lttng_event
*events
= NULL
;
972 count
= lttng_list_events(handle
, "", &events
);
975 ERR("%s", lttng_strerror(count
));
981 ret
= mi_list_session_agent_events(events
, count
);
988 MSG("Events (Logger name):\n---------------------");
990 MSG("%sNone\n", indent6
);
994 for (i
= 0; i
< count
; i
++) {
995 MSG("%s- %s%s (loglevel%s %s)", indent4
, events
[i
].name
,
996 enabled_string(events
[i
].enabled
),
997 logleveltype_string(events
[i
].loglevel_type
),
998 mi_lttng_loglevel_string(events
[i
].loglevel
,
999 handle
->domain
.type
));
1013 * print a list of event
1015 static int mi_list_events(struct lttng_event
*events
, int count
)
1019 /* Open events element */
1020 ret
= mi_lttng_events_open(writer
);
1025 for (i
= 0; i
< count
; i
++) {
1026 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1032 /* Close events element */
1033 ret
= mi_lttng_writer_close_element(writer
);
1040 * List events of channel of session and domain.
1042 static int list_events(const char *channel_name
)
1044 int ret
= CMD_SUCCESS
, count
, i
;
1045 struct lttng_event
*events
= NULL
;
1047 count
= lttng_list_events(handle
, channel_name
, &events
);
1050 ERR("%s", lttng_strerror(count
));
1056 ret
= mi_list_events(events
, count
);
1063 MSG("\n%sEvents:", indent4
);
1065 MSG("%sNone\n", indent6
);
1069 for (i
= 0; i
< count
; i
++) {
1070 print_events(&events
[i
]);
1082 * Pretty print channel
1084 static void print_channel(struct lttng_channel
*channel
)
1086 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1088 MSG("%sAttributes:", indent4
);
1089 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1090 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1091 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1092 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1093 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1094 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1095 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1096 switch (channel
->attr
.output
) {
1097 case LTTNG_EVENT_SPLICE
:
1098 MSG("%soutput: splice()", indent6
);
1100 case LTTNG_EVENT_MMAP
:
1101 MSG("%soutput: mmap()", indent6
);
1108 * Print a list of channel
1111 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1112 const char *channel_name
)
1115 unsigned int chan_found
= 0;
1117 /* Open channels element */
1118 ret
= mi_lttng_channels_open(writer
);
1123 for (i
= 0; i
< count
; i
++) {
1124 if (channel_name
!= NULL
) {
1125 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1132 /* Write channel element and leave it open */
1133 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1138 /* Listing events per channel */
1139 ret
= list_events(channels
[i
].name
);
1144 /* Closing the channel element we opened earlier */
1145 ret
= mi_lttng_writer_close_element(writer
);
1155 /* Close channels element */
1156 ret
= mi_lttng_writer_close_element(writer
);
1166 * List channel(s) of session and domain.
1168 * If channel_name is NULL, all channels are listed.
1170 static int list_channels(const char *channel_name
)
1172 int count
, i
, ret
= CMD_SUCCESS
;
1173 unsigned int chan_found
= 0;
1174 struct lttng_channel
*channels
= NULL
;
1176 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1178 count
= lttng_list_channels(handle
, &channels
);
1181 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1183 /* When printing mi this is not an error
1184 * but an empty channels element */
1188 WARN("No kernel channel");
1189 goto error_channels
;
1193 /* We had a real error */
1195 ERR("%s", lttng_strerror(count
));
1196 goto error_channels
;
1203 ret
= mi_list_channels(channels
, count
, channel_name
);
1211 MSG("Channels:\n-------------");
1214 for (i
= 0; i
< count
; i
++) {
1215 if (channel_name
!= NULL
) {
1216 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1222 print_channel(&channels
[i
]);
1224 /* Listing events per channel */
1225 ret
= list_events(channels
[i
].name
);
1235 if (!chan_found
&& channel_name
!= NULL
) {
1237 ERR("Channel %s not found", channel_name
);
1250 * Find the session with session_name as name
1251 * and print his informations.
1253 static int mi_list_session(const char *session_name
,
1254 struct lttng_session
*sessions
, int count
)
1257 unsigned int session_found
= 0;
1259 if (session_name
== NULL
) {
1260 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1264 for (i
= 0; i
< count
; i
++) {
1265 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1266 /* We need to leave it open to append other informations
1267 * like domain, channel, events etc.*/
1269 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1277 if (!session_found
) {
1278 ERR("Session '%s' not found", session_name
);
1279 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1289 * List all availables session
1291 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1295 /* Opening sessions element */
1296 ret
= mi_lttng_sessions_open(writer
);
1301 /* Listing sessions */
1302 for (i
= 0; i
< count
; i
++) {
1303 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1309 /* Closing sessions element */
1310 ret
= mi_lttng_writer_close_element(writer
);
1320 * List available tracing session. List only basic information.
1322 * If session_name is NULL, all sessions are listed.
1324 static int list_sessions(const char *session_name
)
1326 int ret
= CMD_SUCCESS
;
1328 unsigned int session_found
= 0;
1329 struct lttng_session
*sessions
;
1331 count
= lttng_list_sessions(&sessions
);
1332 DBG("Session count %d", count
);
1335 ERR("%s", lttng_strerror(count
));
1341 if (session_name
== NULL
) {
1342 /* List all session */
1343 ret
= mi_list_sessions(sessions
, count
);
1345 /* Note : this return an open session element */
1346 ret
= mi_list_session(session_name
, sessions
, count
);
1355 MSG("Currently no available tracing session");
1359 if (session_name
== NULL
) {
1360 MSG("Available tracing sessions:");
1364 for (i
= 0; i
< count
; i
++) {
1365 if (session_name
!= NULL
) {
1366 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1368 MSG("Tracing session %s: [%s%s]", session_name
,
1369 active_string(sessions
[i
].enabled
),
1370 snapshot_string(sessions
[i
].snapshot_mode
));
1371 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1375 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1376 sessions
[i
].name
, sessions
[i
].path
,
1377 active_string(sessions
[i
].enabled
),
1378 snapshot_string(sessions
[i
].snapshot_mode
));
1379 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1380 MSG("%sLive timer interval (usec): %u\n", indent4
,
1381 sessions
[i
].live_timer_interval
);
1385 if (!session_found
&& session_name
!= NULL
) {
1386 ERR("Session '%s' not found", session_name
);
1391 if (session_name
== NULL
) {
1392 MSG("\nUse lttng list <session_name> for more details");
1405 * list available domain(s) for a session.
1407 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1410 /* Open domains element */
1411 ret
= mi_lttng_domains_open(writer
);
1416 for (i
= 0; i
< count
; i
++) {
1417 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1423 /* Closing domains element */
1424 ret
= mi_lttng_writer_close_element(writer
);
1433 * List available domain(s) for a session.
1435 static int list_domains(const char *session_name
)
1437 int i
, count
, ret
= CMD_SUCCESS
;
1438 struct lttng_domain
*domains
= NULL
;
1441 count
= lttng_list_domains(session_name
, &domains
);
1444 ERR("%s", lttng_strerror(count
));
1450 ret
= mi_list_domains(domains
, count
);
1457 MSG("Domains:\n-------------");
1463 for (i
= 0; i
< count
; i
++) {
1464 switch (domains
[i
].type
) {
1465 case LTTNG_DOMAIN_KERNEL
:
1468 case LTTNG_DOMAIN_UST
:
1469 MSG(" - UST global");
1471 case LTTNG_DOMAIN_JUL
:
1472 MSG(" - JUL (Java Util Logging)");
1474 case LTTNG_DOMAIN_LOG4J
:
1475 MSG(" - LOG4j (Logging for Java)");
1477 case LTTNG_DOMAIN_PYTHON
:
1478 MSG(" - Python (logging)");
1494 * The 'list <options>' first level command
1496 int cmd_list(int argc
, const char **argv
)
1498 int opt
, ret
= CMD_SUCCESS
;
1499 const char *session_name
;
1500 static poptContext pc
;
1501 struct lttng_domain domain
;
1502 struct lttng_domain
*domains
= NULL
;
1504 memset(&domain
, 0, sizeof(domain
));
1512 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1513 poptReadDefaultConfig(pc
, 0);
1515 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1523 case OPT_LIST_OPTIONS
:
1524 list_cmd_options(stdout
, long_options
);
1528 ret
= CMD_UNDEFINED
;
1535 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1541 /* Open command element */
1542 ret
= mi_lttng_writer_command_open(writer
,
1543 mi_lttng_element_command_list
);
1549 /* Open output element */
1550 ret
= mi_lttng_writer_open_element(writer
,
1551 mi_lttng_element_command_output
);
1558 /* Get session name (trailing argument) */
1559 session_name
= poptGetArg(pc
);
1560 DBG2("Session name: %s", session_name
);
1563 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1564 } else if (opt_userspace
) {
1565 DBG2("Listing userspace global domain");
1566 domain
.type
= LTTNG_DOMAIN_UST
;
1567 } else if (opt_jul
) {
1568 DBG2("Listing JUL domain");
1569 domain
.type
= LTTNG_DOMAIN_JUL
;
1570 } else if (opt_log4j
) {
1571 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1572 } else if (opt_python
) {
1573 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1576 if (!opt_kernel
&& opt_syscall
) {
1577 WARN("--syscall will only work with the Kernel domain (-k)");
1582 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1583 handle
= lttng_create_handle(session_name
, &domain
);
1584 if (handle
== NULL
) {
1590 if (session_name
== NULL
) {
1591 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1593 ret
= list_sessions(NULL
);
1600 ret
= list_syscalls();
1605 ret
= list_kernel_events();
1611 if (opt_userspace
) {
1613 ret
= list_ust_event_fields();
1615 ret
= list_ust_events();
1621 if (opt_jul
|| opt_log4j
|| opt_python
) {
1622 ret
= list_agent_events();
1628 /* List session attributes */
1630 /* Open element sessions
1631 * Present for xml consistency */
1632 ret
= mi_lttng_sessions_open(writer
);
1637 /* MI: the ouptut of list_sessions is an unclosed session element */
1638 ret
= list_sessions(session_name
);
1643 /* Domain listing */
1645 ret
= list_domains(session_name
);
1649 /* Channel listing */
1650 if (opt_kernel
|| opt_userspace
) {
1652 /* Add of domains and domain element for xml
1653 * consistency and validation
1655 ret
= mi_lttng_domains_open(writer
);
1660 /* Open domain and leave it open for
1661 * nested channels printing */
1662 ret
= mi_lttng_domain(writer
, &domain
, 1);
1669 ret
= list_channels(opt_channel
);
1675 /* Close domain and domain element */
1676 ret
= mi_lttng_close_multi_element(writer
, 2);
1686 /* We want all domain(s) */
1687 nb_domain
= lttng_list_domains(session_name
, &domains
);
1688 if (nb_domain
< 0) {
1690 ERR("%s", lttng_strerror(nb_domain
));
1695 ret
= mi_lttng_domains_open(writer
);
1702 for (i
= 0; i
< nb_domain
; i
++) {
1703 switch (domains
[i
].type
) {
1704 case LTTNG_DOMAIN_KERNEL
:
1705 MSG("=== Domain: Kernel ===\n");
1707 case LTTNG_DOMAIN_UST
:
1708 MSG("=== Domain: UST global ===\n");
1709 MSG("Buffer type: %s\n",
1710 domains
[i
].buf_type
==
1711 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1713 case LTTNG_DOMAIN_JUL
:
1714 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1716 case LTTNG_DOMAIN_LOG4J
:
1717 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1719 case LTTNG_DOMAIN_PYTHON
:
1720 MSG("=== Domain: Python (logging) ===\n");
1723 MSG("=== Domain: Unimplemented ===\n");
1728 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1735 /* Clean handle before creating a new one */
1737 lttng_destroy_handle(handle
);
1740 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1741 if (handle
== NULL
) {
1746 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1747 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1748 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1749 ret
= list_session_agent_events();
1756 ret
= list_channels(opt_channel
);
1762 /* Close domain element */
1763 ret
= mi_lttng_writer_close_element(writer
);
1772 /* Close the domains, session and sessions element */
1773 ret
= mi_lttng_close_multi_element(writer
, 3);
1784 /* Close output element */
1785 ret
= mi_lttng_writer_close_element(writer
);
1791 /* Command element close */
1792 ret
= mi_lttng_writer_command_close(writer
);
1800 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1801 /* Preserve original error code */
1802 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
1807 lttng_destroy_handle(handle
);
1810 poptFreeContext(pc
);