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.
27 #include <common/mi-lttng.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 char path
[20]; /* Can't go bigger than /proc/65535/cmdline */
111 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
112 fp
= fopen(path
, "r");
117 /* Caller must free() *cmdline */
118 cmdline
= zmalloc(PATH_MAX
);
120 PERROR("malloc cmdline");
123 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
125 PERROR("fread proc list");
136 const char *active_string(int value
)
139 case 0: return "inactive";
140 case 1: return "active";
142 default: return NULL
;
146 static const char *snapshot_string(int value
)
157 const char *enabled_string(int value
)
160 case 0: return " [disabled]";
161 case 1: return " [enabled]";
163 default: return NULL
;
168 const char *filter_string(int value
)
171 case 1: return " [with filter]";
177 const char *exclusion_string(int value
)
180 case 1: return " [has exclusions]";
185 static const char *logleveltype_string(enum lttng_loglevel_type value
)
188 case LTTNG_EVENT_LOGLEVEL_ALL
:
190 case LTTNG_EVENT_LOGLEVEL_RANGE
:
192 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
195 return " <<TYPE UNKN>>";
199 static const char *bitness_event(enum lttng_event_flag flags
)
201 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_32
) {
202 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
203 return " [32/64-bit]";
207 } else if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
215 * Pretty print single event.
217 static void print_events(struct lttng_event
*event
)
219 switch (event
->type
) {
220 case LTTNG_EVENT_TRACEPOINT
:
222 if (event
->loglevel
!= -1) {
223 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
226 logleveltype_string(event
->loglevel_type
),
227 mi_lttng_loglevel_string(event
->loglevel
, handle
->domain
.type
),
229 enabled_string(event
->enabled
),
230 exclusion_string(event
->exclusion
),
231 filter_string(event
->filter
));
233 MSG("%s%s (type: tracepoint)%s%s%s",
236 enabled_string(event
->enabled
),
237 exclusion_string(event
->exclusion
),
238 filter_string(event
->filter
));
242 case LTTNG_EVENT_FUNCTION
:
243 MSG("%s%s (type: function)%s%s", indent6
,
244 event
->name
, enabled_string(event
->enabled
),
245 filter_string(event
->filter
));
246 if (event
->attr
.probe
.addr
!= 0) {
247 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
249 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
250 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
253 case LTTNG_EVENT_PROBE
:
254 MSG("%s%s (type: probe)%s%s", indent6
,
255 event
->name
, enabled_string(event
->enabled
),
256 filter_string(event
->filter
));
257 if (event
->attr
.probe
.addr
!= 0) {
258 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
260 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
261 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
264 case LTTNG_EVENT_FUNCTION_ENTRY
:
265 MSG("%s%s (type: function)%s%s", indent6
,
266 event
->name
, enabled_string(event
->enabled
),
267 filter_string(event
->filter
));
268 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
270 case LTTNG_EVENT_SYSCALL
:
271 MSG("%s%s%s%s%s", indent6
, event
->name
,
272 (opt_syscall
? "" : " (type:syscall)"),
273 enabled_string(event
->enabled
),
274 bitness_event(event
->flags
));
276 case LTTNG_EVENT_NOOP
:
277 MSG("%s (type: noop)%s%s", indent6
,
278 enabled_string(event
->enabled
),
279 filter_string(event
->filter
));
281 case LTTNG_EVENT_ALL
:
282 /* We should never have "all" events in list. */
288 static const char *field_type(struct lttng_event_field
*field
)
290 switch(field
->type
) {
291 case LTTNG_EVENT_FIELD_INTEGER
:
293 case LTTNG_EVENT_FIELD_ENUM
:
295 case LTTNG_EVENT_FIELD_FLOAT
:
297 case LTTNG_EVENT_FIELD_STRING
:
299 case LTTNG_EVENT_FIELD_OTHER
:
300 default: /* fall-through */
306 * Pretty print single event fields.
308 static void print_event_field(struct lttng_event_field
*field
)
310 if (!field
->field_name
[0]) {
313 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
314 field_type(field
), field
->nowrite
? " [no write]" : "");
319 * Jul and ust event listing
321 static int mi_list_agent_ust_events(struct lttng_event
*events
, int count
,
322 struct lttng_domain
*domain
)
326 char *cmdline
= NULL
;
327 int pid_element_open
= 0;
329 /* Open domains element */
330 ret
= mi_lttng_domains_open(writer
);
336 ret
= mi_lttng_domain(writer
, domain
, 1);
341 /* Open pids element */
342 ret
= mi_lttng_pids_open(writer
);
347 for (i
= 0; i
< count
; i
++) {
348 if (cur_pid
!= events
[i
].pid
) {
349 if (pid_element_open
) {
350 /* Close the previous events and pid element */
351 ret
= mi_lttng_close_multi_element(writer
, 2);
355 pid_element_open
= 0;
358 cur_pid
= events
[i
].pid
;
359 cmdline
= get_cmdline_by_pid(cur_pid
);
365 if (!pid_element_open
) {
366 /* Open and write a pid element */
367 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
372 /* Open events element */
373 ret
= mi_lttng_events_open(writer
);
378 pid_element_open
= 1;
384 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
391 ret
= mi_lttng_writer_close_element(writer
);
396 /* Close domain, domains */
397 ret
= mi_lttng_close_multi_element(writer
, 2);
405 static int list_agent_events(void)
407 int i
, size
, ret
= CMD_SUCCESS
;
408 struct lttng_domain domain
;
409 struct lttng_handle
*handle
;
410 struct lttng_event
*event_list
;
412 char *cmdline
= NULL
;
413 const char *agent_domain_str
;
415 memset(&domain
, 0, sizeof(domain
));
417 domain
.type
= LTTNG_DOMAIN_JUL
;
418 } else if (opt_log4j
) {
419 domain
.type
= LTTNG_DOMAIN_LOG4J
;
420 } else if (opt_python
) {
421 domain
.type
= LTTNG_DOMAIN_PYTHON
;
424 agent_domain_str
= get_domain_str(domain
.type
);
426 DBG("Getting %s tracing events", agent_domain_str
);
428 handle
= lttng_create_handle(NULL
, &domain
);
429 if (handle
== NULL
) {
434 size
= lttng_list_tracepoints(handle
, &event_list
);
436 ERR("Unable to list %s events: %s", agent_domain_str
,
437 lttng_strerror(size
));
444 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
451 MSG("%s events (Logger name):\n-------------------------",
458 for (i
= 0; i
< size
; i
++) {
459 if (cur_pid
!= event_list
[i
].pid
) {
460 cur_pid
= event_list
[i
].pid
;
461 cmdline
= get_cmdline_by_pid(cur_pid
);
462 if (cmdline
== NULL
) {
466 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
469 MSG("%s- %s", indent6
, event_list
[i
].name
);
478 lttng_destroy_handle(handle
);
483 * Ask session daemon for all user space tracepoints available.
485 static int list_ust_events(void)
487 int i
, size
, ret
= CMD_SUCCESS
;
488 struct lttng_domain domain
;
489 struct lttng_handle
*handle
;
490 struct lttng_event
*event_list
;
492 char *cmdline
= NULL
;
494 memset(&domain
, 0, sizeof(domain
));
496 DBG("Getting UST tracing events");
498 domain
.type
= LTTNG_DOMAIN_UST
;
500 handle
= lttng_create_handle(NULL
, &domain
);
501 if (handle
== NULL
) {
506 size
= lttng_list_tracepoints(handle
, &event_list
);
508 ERR("Unable to list UST events: %s", lttng_strerror(size
));
515 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
518 MSG("UST events:\n-------------");
524 for (i
= 0; i
< size
; i
++) {
525 if (cur_pid
!= event_list
[i
].pid
) {
526 cur_pid
= event_list
[i
].pid
;
527 cmdline
= get_cmdline_by_pid(cur_pid
);
528 if (cmdline
== NULL
) {
532 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
535 print_events(&event_list
[i
]);
544 lttng_destroy_handle(handle
);
550 * List all ust event with their fields
552 static int mi_list_ust_event_fields(struct lttng_event_field
*fields
, int count
,
553 struct lttng_domain
*domain
)
557 char *cmdline
= NULL
;
558 int pid_element_open
= 0;
559 int event_element_open
= 0;
560 struct lttng_event cur_event
;
562 /* Open domains element */
563 ret
= mi_lttng_domains_open(writer
);
569 ret
= mi_lttng_domain(writer
, domain
, 1);
574 /* Open pids element */
575 ret
= mi_lttng_pids_open(writer
);
580 for (i
= 0; i
< count
; i
++) {
581 if (cur_pid
!= fields
[i
].event
.pid
) {
582 if (pid_element_open
) {
583 if (event_element_open
) {
585 /* Close the previous field element and event. */
586 ret
= mi_lttng_close_multi_element(writer
, 2);
590 event_element_open
= 0;
592 /* Close the previous events, pid element */
593 ret
= mi_lttng_close_multi_element(writer
, 2);
597 pid_element_open
= 0;
600 cur_pid
= fields
[i
].event
.pid
;
601 cmdline
= get_cmdline_by_pid(cur_pid
);
602 if (!pid_element_open
) {
603 /* Open and write a pid element */
604 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
609 /* Open events element */
610 ret
= mi_lttng_events_open(writer
);
614 pid_element_open
= 1;
617 /* Wipe current event since we are about to print a new PID. */
618 memset(&cur_event
, 0, sizeof(cur_event
));
621 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
622 if (event_element_open
) {
623 /* Close the previous fields element and the previous event */
624 ret
= mi_lttng_close_multi_element(writer
, 2);
628 event_element_open
= 0;
631 memcpy(&cur_event
, &fields
[i
].event
,
634 if (!event_element_open
) {
635 /* Open and write the event */
636 ret
= mi_lttng_event(writer
, &cur_event
, 1,
637 handle
->domain
.type
);
642 /* Open a fields element */
643 ret
= mi_lttng_event_fields_open(writer
);
647 event_element_open
= 1;
651 /* Print the event_field */
652 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
658 /* Close pids, domain, domains */
659 ret
= mi_lttng_close_multi_element(writer
, 3);
668 * Ask session daemon for all user space tracepoint fields available.
670 static int list_ust_event_fields(void)
672 int i
, size
, ret
= CMD_SUCCESS
;
673 struct lttng_domain domain
;
674 struct lttng_handle
*handle
;
675 struct lttng_event_field
*event_field_list
;
677 char *cmdline
= NULL
;
679 struct lttng_event cur_event
;
681 memset(&domain
, 0, sizeof(domain
));
682 memset(&cur_event
, 0, sizeof(cur_event
));
684 DBG("Getting UST tracing event fields");
686 domain
.type
= LTTNG_DOMAIN_UST
;
688 handle
= lttng_create_handle(NULL
, &domain
);
689 if (handle
== NULL
) {
694 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
696 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
703 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
710 MSG("UST events:\n-------------");
716 for (i
= 0; i
< size
; i
++) {
717 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
718 cur_pid
= event_field_list
[i
].event
.pid
;
719 cmdline
= get_cmdline_by_pid(cur_pid
);
720 if (cmdline
== NULL
) {
724 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
726 /* Wipe current event since we are about to print a new PID. */
727 memset(&cur_event
, 0, sizeof(cur_event
));
729 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
730 print_events(&event_field_list
[i
].event
);
731 memcpy(&cur_event
, &event_field_list
[i
].event
,
734 print_event_field(&event_field_list
[i
]);
741 free(event_field_list
);
743 lttng_destroy_handle(handle
);
749 * Print a list of kernel events
751 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
752 struct lttng_domain
*domain
)
756 /* Open domains element */
757 ret
= mi_lttng_domains_open(writer
);
763 ret
= mi_lttng_domain(writer
, domain
, 1);
769 ret
= mi_lttng_events_open(writer
);
774 for (i
= 0; i
< count
; i
++) {
775 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
781 /* close events, domain and domains */
782 ret
= mi_lttng_close_multi_element(writer
, 3);
792 * Ask for all trace events in the kernel
794 static int list_kernel_events(void)
796 int i
, size
, ret
= CMD_SUCCESS
;
797 struct lttng_domain domain
;
798 struct lttng_handle
*handle
;
799 struct lttng_event
*event_list
;
801 memset(&domain
, 0, sizeof(domain
));
803 DBG("Getting kernel tracing events");
805 domain
.type
= LTTNG_DOMAIN_KERNEL
;
807 handle
= lttng_create_handle(NULL
, &domain
);
808 if (handle
== NULL
) {
813 size
= lttng_list_tracepoints(handle
, &event_list
);
815 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
816 lttng_destroy_handle(handle
);
822 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
828 MSG("Kernel events:\n-------------");
830 for (i
= 0; i
< size
; i
++) {
831 print_events(&event_list
[i
]);
840 lttng_destroy_handle(handle
);
844 lttng_destroy_handle(handle
);
850 * Print a list of system calls.
852 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
857 ret
= mi_lttng_events_open(writer
);
862 for (i
= 0; i
< count
; i
++) {
863 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
870 ret
= mi_lttng_writer_close_element(writer
);
880 * Ask for kernel system calls.
882 static int list_syscalls(void)
884 int i
, size
, ret
= CMD_SUCCESS
;
885 struct lttng_event
*event_list
;
887 DBG("Getting kernel system call events");
889 size
= lttng_list_syscalls(&event_list
);
891 ERR("Unable to list system calls: %s", lttng_strerror(size
));
898 ret
= mi_list_syscalls(event_list
, size
);
904 MSG("System calls:\n-------------");
906 for (i
= 0; i
< size
; i
++) {
907 print_events(&event_list
[i
]);
923 * Print a list of agent events
925 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
929 /* Open events element */
930 ret
= mi_lttng_events_open(writer
);
935 for (i
= 0; i
< count
; i
++) {
936 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
942 /* Close events element */
943 ret
= mi_lttng_writer_close_element(writer
);
950 * List agent events for a specific session using the handle.
952 * Return CMD_SUCCESS on success else a negative value.
954 static int list_session_agent_events(void)
956 int ret
= CMD_SUCCESS
, count
, i
;
957 struct lttng_event
*events
= NULL
;
959 count
= lttng_list_events(handle
, "", &events
);
962 ERR("%s", lttng_strerror(count
));
968 ret
= mi_list_session_agent_events(events
, count
);
975 MSG("Events (Logger name):\n---------------------");
977 MSG("%sNone\n", indent6
);
981 for (i
= 0; i
< count
; i
++) {
982 MSG("%s- %s%s (loglevel%s %s)", indent4
, events
[i
].name
,
983 enabled_string(events
[i
].enabled
),
984 logleveltype_string(events
[i
].loglevel_type
),
985 mi_lttng_loglevel_string(events
[i
].loglevel
,
986 handle
->domain
.type
));
1000 * print a list of event
1002 static int mi_list_events(struct lttng_event
*events
, int count
)
1006 /* Open events element */
1007 ret
= mi_lttng_events_open(writer
);
1012 for (i
= 0; i
< count
; i
++) {
1013 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1019 /* Close events element */
1020 ret
= mi_lttng_writer_close_element(writer
);
1027 * List events of channel of session and domain.
1029 static int list_events(const char *channel_name
)
1031 int ret
= CMD_SUCCESS
, count
, i
;
1032 struct lttng_event
*events
= NULL
;
1034 count
= lttng_list_events(handle
, channel_name
, &events
);
1037 ERR("%s", lttng_strerror(count
));
1043 ret
= mi_list_events(events
, count
);
1050 MSG("\n%sEvents:", indent4
);
1052 MSG("%sNone\n", indent6
);
1056 for (i
= 0; i
< count
; i
++) {
1057 print_events(&events
[i
]);
1069 * Pretty print channel
1071 static void print_channel(struct lttng_channel
*channel
)
1073 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1075 MSG("%sAttributes:", indent4
);
1076 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1077 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1078 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1079 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1080 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1081 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1082 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1083 switch (channel
->attr
.output
) {
1084 case LTTNG_EVENT_SPLICE
:
1085 MSG("%soutput: splice()", indent6
);
1087 case LTTNG_EVENT_MMAP
:
1088 MSG("%soutput: mmap()", indent6
);
1095 * Print a list of channel
1098 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1099 const char *channel_name
)
1102 unsigned int chan_found
= 0;
1104 /* Open channels element */
1105 ret
= mi_lttng_channels_open(writer
);
1110 for (i
= 0; i
< count
; i
++) {
1111 if (channel_name
!= NULL
) {
1112 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1119 /* Write channel element and leave it open */
1120 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1125 /* Listing events per channel */
1126 ret
= list_events(channels
[i
].name
);
1131 /* Closing the channel element we opened earlier */
1132 ret
= mi_lttng_writer_close_element(writer
);
1142 /* Close channels element */
1143 ret
= mi_lttng_writer_close_element(writer
);
1153 * List channel(s) of session and domain.
1155 * If channel_name is NULL, all channels are listed.
1157 static int list_channels(const char *channel_name
)
1159 int count
, i
, ret
= CMD_SUCCESS
;
1160 unsigned int chan_found
= 0;
1161 struct lttng_channel
*channels
= NULL
;
1163 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1165 count
= lttng_list_channels(handle
, &channels
);
1168 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1170 /* When printing mi this is not an error
1171 * but an empty channels element */
1175 WARN("No kernel channel");
1176 goto error_channels
;
1180 /* We had a real error */
1182 ERR("%s", lttng_strerror(count
));
1183 goto error_channels
;
1190 ret
= mi_list_channels(channels
, count
, channel_name
);
1198 MSG("Channels:\n-------------");
1201 for (i
= 0; i
< count
; i
++) {
1202 if (channel_name
!= NULL
) {
1203 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1209 print_channel(&channels
[i
]);
1211 /* Listing events per channel */
1212 ret
= list_events(channels
[i
].name
);
1222 if (!chan_found
&& channel_name
!= NULL
) {
1224 ERR("Channel %s not found", channel_name
);
1236 * List tracker PID(s) of session and domain.
1238 static int list_tracker_pids(void)
1244 ret
= lttng_list_tracker_pids(handle
,
1245 &enabled
, &pids
, &nr_pids
);
1251 _MSG("PID tracker: [");
1253 for (i
= 0; i
< nr_pids
; i
++) {
1257 _MSG(" %d", pids
[i
]);
1267 * Find the session with session_name as name
1268 * and print his informations.
1270 static int mi_list_session(const char *session_name
,
1271 struct lttng_session
*sessions
, int count
)
1274 unsigned int session_found
= 0;
1276 if (session_name
== NULL
) {
1277 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1281 for (i
= 0; i
< count
; i
++) {
1282 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1283 /* We need to leave it open to append other informations
1284 * like domain, channel, events etc.*/
1286 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1294 if (!session_found
) {
1295 ERR("Session '%s' not found", session_name
);
1296 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1306 * List all availables session
1308 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1312 /* Opening sessions element */
1313 ret
= mi_lttng_sessions_open(writer
);
1318 /* Listing sessions */
1319 for (i
= 0; i
< count
; i
++) {
1320 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1326 /* Closing sessions element */
1327 ret
= mi_lttng_writer_close_element(writer
);
1337 * List available tracing session. List only basic information.
1339 * If session_name is NULL, all sessions are listed.
1341 static int list_sessions(const char *session_name
)
1343 int ret
= CMD_SUCCESS
;
1345 unsigned int session_found
= 0;
1346 struct lttng_session
*sessions
;
1348 count
= lttng_list_sessions(&sessions
);
1349 DBG("Session count %d", count
);
1352 ERR("%s", lttng_strerror(count
));
1358 if (session_name
== NULL
) {
1359 /* List all session */
1360 ret
= mi_list_sessions(sessions
, count
);
1362 /* Note : this return an open session element */
1363 ret
= mi_list_session(session_name
, sessions
, count
);
1372 MSG("Currently no available tracing session");
1376 if (session_name
== NULL
) {
1377 MSG("Available tracing sessions:");
1381 for (i
= 0; i
< count
; i
++) {
1382 if (session_name
!= NULL
) {
1383 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1385 MSG("Tracing session %s: [%s%s]", session_name
,
1386 active_string(sessions
[i
].enabled
),
1387 snapshot_string(sessions
[i
].snapshot_mode
));
1388 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1392 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1393 sessions
[i
].name
, sessions
[i
].path
,
1394 active_string(sessions
[i
].enabled
),
1395 snapshot_string(sessions
[i
].snapshot_mode
));
1396 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1397 if (sessions
[i
].live_timer_interval
!= 0) {
1398 MSG("%sLive timer interval (usec): %u", indent4
,
1399 sessions
[i
].live_timer_interval
);
1405 if (!session_found
&& session_name
!= NULL
) {
1406 ERR("Session '%s' not found", session_name
);
1411 if (session_name
== NULL
) {
1412 MSG("\nUse lttng list <session_name> for more details");
1425 * list available domain(s) for a session.
1427 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1430 /* Open domains element */
1431 ret
= mi_lttng_domains_open(writer
);
1436 for (i
= 0; i
< count
; i
++) {
1437 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1443 /* Closing domains element */
1444 ret
= mi_lttng_writer_close_element(writer
);
1453 * List available domain(s) for a session.
1455 static int list_domains(const char *session_name
)
1457 int i
, count
, ret
= CMD_SUCCESS
;
1458 struct lttng_domain
*domains
= NULL
;
1461 count
= lttng_list_domains(session_name
, &domains
);
1464 ERR("%s", lttng_strerror(count
));
1470 ret
= mi_list_domains(domains
, count
);
1477 MSG("Domains:\n-------------");
1483 for (i
= 0; i
< count
; i
++) {
1484 switch (domains
[i
].type
) {
1485 case LTTNG_DOMAIN_KERNEL
:
1488 case LTTNG_DOMAIN_UST
:
1489 MSG(" - UST global");
1491 case LTTNG_DOMAIN_JUL
:
1492 MSG(" - JUL (Java Util Logging)");
1494 case LTTNG_DOMAIN_LOG4J
:
1495 MSG(" - LOG4j (Logging for Java)");
1497 case LTTNG_DOMAIN_PYTHON
:
1498 MSG(" - Python (logging)");
1514 * The 'list <options>' first level command
1516 int cmd_list(int argc
, const char **argv
)
1518 int opt
, ret
= CMD_SUCCESS
;
1519 const char *session_name
;
1520 static poptContext pc
;
1521 struct lttng_domain domain
;
1522 struct lttng_domain
*domains
= NULL
;
1524 memset(&domain
, 0, sizeof(domain
));
1532 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1533 poptReadDefaultConfig(pc
, 0);
1535 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1543 case OPT_LIST_OPTIONS
:
1544 list_cmd_options(stdout
, long_options
);
1548 ret
= CMD_UNDEFINED
;
1555 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1561 /* Open command element */
1562 ret
= mi_lttng_writer_command_open(writer
,
1563 mi_lttng_element_command_list
);
1569 /* Open output element */
1570 ret
= mi_lttng_writer_open_element(writer
,
1571 mi_lttng_element_command_output
);
1578 /* Get session name (trailing argument) */
1579 session_name
= poptGetArg(pc
);
1580 DBG2("Session name: %s", session_name
);
1583 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1584 } else if (opt_userspace
) {
1585 DBG2("Listing userspace global domain");
1586 domain
.type
= LTTNG_DOMAIN_UST
;
1587 } else if (opt_jul
) {
1588 DBG2("Listing JUL domain");
1589 domain
.type
= LTTNG_DOMAIN_JUL
;
1590 } else if (opt_log4j
) {
1591 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1592 } else if (opt_python
) {
1593 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1596 if (!opt_kernel
&& opt_syscall
) {
1597 WARN("--syscall will only work with the Kernel domain (-k)");
1602 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1603 handle
= lttng_create_handle(session_name
, &domain
);
1604 if (handle
== NULL
) {
1610 if (session_name
== NULL
) {
1611 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1613 ret
= list_sessions(NULL
);
1620 ret
= list_syscalls();
1625 ret
= list_kernel_events();
1631 if (opt_userspace
) {
1633 ret
= list_ust_event_fields();
1635 ret
= list_ust_events();
1641 if (opt_jul
|| opt_log4j
|| opt_python
) {
1642 ret
= list_agent_events();
1648 /* List session attributes */
1650 /* Open element sessions
1651 * Present for xml consistency */
1652 ret
= mi_lttng_sessions_open(writer
);
1657 /* MI: the ouptut of list_sessions is an unclosed session element */
1658 ret
= list_sessions(session_name
);
1663 /* Domain listing */
1665 ret
= list_domains(session_name
);
1669 /* Channel listing */
1670 if (opt_kernel
|| opt_userspace
) {
1672 /* Add of domains and domain element for xml
1673 * consistency and validation
1675 ret
= mi_lttng_domains_open(writer
);
1680 /* Open domain and leave it open for
1681 * nested channels printing */
1682 ret
= mi_lttng_domain(writer
, &domain
, 1);
1689 ret
= list_tracker_pids();
1694 ret
= list_channels(opt_channel
);
1700 /* Close domain and domain element */
1701 ret
= mi_lttng_close_multi_element(writer
, 2);
1711 /* We want all domain(s) */
1712 nb_domain
= lttng_list_domains(session_name
, &domains
);
1713 if (nb_domain
< 0) {
1715 ERR("%s", lttng_strerror(nb_domain
));
1720 ret
= mi_lttng_domains_open(writer
);
1727 for (i
= 0; i
< nb_domain
; i
++) {
1728 switch (domains
[i
].type
) {
1729 case LTTNG_DOMAIN_KERNEL
:
1730 MSG("=== Domain: Kernel ===\n");
1732 case LTTNG_DOMAIN_UST
:
1733 MSG("=== Domain: UST global ===\n");
1734 MSG("Buffer type: %s\n",
1735 domains
[i
].buf_type
==
1736 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1738 case LTTNG_DOMAIN_JUL
:
1739 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1741 case LTTNG_DOMAIN_LOG4J
:
1742 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1744 case LTTNG_DOMAIN_PYTHON
:
1745 MSG("=== Domain: Python (logging) ===\n");
1748 MSG("=== Domain: Unimplemented ===\n");
1753 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1760 /* Clean handle before creating a new one */
1762 lttng_destroy_handle(handle
);
1765 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1766 if (handle
== NULL
) {
1771 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1772 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1773 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1774 ret
= list_session_agent_events();
1781 switch (domains
[i
].type
) {
1782 case LTTNG_DOMAIN_KERNEL
:
1783 case LTTNG_DOMAIN_UST
:
1784 ret
= list_tracker_pids();
1793 ret
= list_channels(opt_channel
);
1799 /* Close domain element */
1800 ret
= mi_lttng_writer_close_element(writer
);
1809 /* Close the domains, session and sessions element */
1810 ret
= mi_lttng_close_multi_element(writer
, 3);
1821 /* Close output element */
1822 ret
= mi_lttng_writer_close_element(writer
);
1828 /* Command element close */
1829 ret
= mi_lttng_writer_command_close(writer
);
1837 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1838 /* Preserve original error code */
1839 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
1844 lttng_destroy_handle(handle
);
1847 poptFreeContext(pc
);