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>
28 #include <lttng/constant.h>
30 #include "../command.h"
32 static int opt_userspace
;
33 static int opt_kernel
;
36 static int opt_python
;
37 static char *opt_channel
;
38 static int opt_domain
;
39 static int opt_fields
;
40 static int opt_syscall
;
42 const char *indent4
= " ";
43 const char *indent6
= " ";
44 const char *indent8
= " ";
52 static struct lttng_handle
*handle
;
53 static struct mi_writer
*writer
;
55 static struct poptOption long_options
[] = {
56 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
57 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
58 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
59 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
60 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
61 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
62 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
63 {"channel", 'c', POPT_ARG_STRING
, &opt_channel
, 0, 0, 0},
64 {"domain", 'd', POPT_ARG_VAL
, &opt_domain
, 1, 0, 0},
65 {"fields", 'f', POPT_ARG_VAL
, &opt_fields
, 1, 0, 0},
66 {"syscall", 'S', POPT_ARG_VAL
, &opt_syscall
, 1, 0, 0},
67 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
74 static void usage(FILE *ofp
)
76 fprintf(ofp
, "usage: lttng list [OPTIONS] [SESSION [SESSION OPTIONS]]\n");
78 fprintf(ofp
, "With no arguments, list available tracing session(s)\n");
80 fprintf(ofp
, "Without a session, -k lists available kernel events\n");
81 fprintf(ofp
, "Without a session, -u lists available userspace events\n");
83 fprintf(ofp
, " -h, --help Show this help\n");
84 fprintf(ofp
, " --list-options Simple listing of options\n");
85 fprintf(ofp
, " -k, --kernel Select kernel domain\n");
86 fprintf(ofp
, " -u, --userspace Select user-space domain.\n");
87 fprintf(ofp
, " -j, --jul Apply for Java application using JUL\n");
88 fprintf(ofp
, " -l, --log4j Apply for Java application using LOG4J\n");
89 fprintf(ofp
, " -p, --python Apply for Python application using logging\n");
90 fprintf(ofp
, " -f, --fields List event fields.\n");
91 fprintf(ofp
, " --syscall List available system calls.\n");
93 fprintf(ofp
, "Session Options:\n");
94 fprintf(ofp
, " -c, --channel NAME List details of a channel\n");
95 fprintf(ofp
, " -d, --domain List available domain(s)\n");
100 * Get command line from /proc for a specific pid.
102 * On success, return an allocated string pointer to the proc cmdline.
103 * On error, return NULL.
105 static char *get_cmdline_by_pid(pid_t pid
)
109 char *cmdline
= NULL
;
110 /* Can't go bigger than /proc/LTTNG_MAX_PID/cmdline */
111 char path
[sizeof("/proc//cmdline") + sizeof(LTTNG_MAX_PID_STR
) - 1];
113 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
114 fp
= fopen(path
, "r");
119 /* Caller must free() *cmdline */
120 cmdline
= zmalloc(PATH_MAX
);
122 PERROR("malloc cmdline");
125 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
127 PERROR("fread proc list");
138 const char *active_string(int value
)
141 case 0: return "inactive";
142 case 1: return "active";
144 default: return NULL
;
148 static const char *snapshot_string(int value
)
159 const char *enabled_string(int value
)
162 case 0: return " [disabled]";
163 case 1: return " [enabled]";
165 default: return NULL
;
170 const char *filter_string(int value
)
173 case 1: return " [with filter]";
179 const char *exclusion_string(int value
)
182 case 1: return " [has exclusions]";
187 static const char *logleveltype_string(enum lttng_loglevel_type value
)
190 case LTTNG_EVENT_LOGLEVEL_ALL
:
192 case LTTNG_EVENT_LOGLEVEL_RANGE
:
194 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
197 return " <<TYPE UNKN>>";
201 static const char *bitness_event(enum lttng_event_flag flags
)
203 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_32
) {
204 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
205 return " [32/64-bit]";
209 } else if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
217 * Pretty print single event.
219 static void print_events(struct lttng_event
*event
)
221 switch (event
->type
) {
222 case LTTNG_EVENT_TRACEPOINT
:
224 if (event
->loglevel
!= -1) {
225 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
228 logleveltype_string(event
->loglevel_type
),
229 mi_lttng_loglevel_string(event
->loglevel
, handle
->domain
.type
),
231 enabled_string(event
->enabled
),
232 exclusion_string(event
->exclusion
),
233 filter_string(event
->filter
));
235 MSG("%s%s (type: tracepoint)%s%s%s",
238 enabled_string(event
->enabled
),
239 exclusion_string(event
->exclusion
),
240 filter_string(event
->filter
));
244 case LTTNG_EVENT_FUNCTION
:
245 MSG("%s%s (type: function)%s%s", indent6
,
246 event
->name
, enabled_string(event
->enabled
),
247 filter_string(event
->filter
));
248 if (event
->attr
.probe
.addr
!= 0) {
249 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
251 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
252 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
255 case LTTNG_EVENT_PROBE
:
256 MSG("%s%s (type: probe)%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_FUNCTION_ENTRY
:
267 MSG("%s%s (type: function)%s%s", indent6
,
268 event
->name
, enabled_string(event
->enabled
),
269 filter_string(event
->filter
));
270 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
272 case LTTNG_EVENT_SYSCALL
:
273 MSG("%s%s%s%s%s", indent6
, event
->name
,
274 (opt_syscall
? "" : " (type:syscall)"),
275 enabled_string(event
->enabled
),
276 bitness_event(event
->flags
));
278 case LTTNG_EVENT_NOOP
:
279 MSG("%s (type: noop)%s%s", indent6
,
280 enabled_string(event
->enabled
),
281 filter_string(event
->filter
));
283 case LTTNG_EVENT_ALL
:
284 /* We should never have "all" events in list. */
290 static const char *field_type(struct lttng_event_field
*field
)
292 switch(field
->type
) {
293 case LTTNG_EVENT_FIELD_INTEGER
:
295 case LTTNG_EVENT_FIELD_ENUM
:
297 case LTTNG_EVENT_FIELD_FLOAT
:
299 case LTTNG_EVENT_FIELD_STRING
:
301 case LTTNG_EVENT_FIELD_OTHER
:
302 default: /* fall-through */
308 * Pretty print single event fields.
310 static void print_event_field(struct lttng_event_field
*field
)
312 if (!field
->field_name
[0]) {
315 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
316 field_type(field
), field
->nowrite
? " [no write]" : "");
321 * Jul and ust event listing
323 static int mi_list_agent_ust_events(struct lttng_event
*events
, int count
,
324 struct lttng_domain
*domain
)
328 char *cmdline
= NULL
;
329 int pid_element_open
= 0;
331 /* Open domains element */
332 ret
= mi_lttng_domains_open(writer
);
338 ret
= mi_lttng_domain(writer
, domain
, 1);
343 /* Open pids element */
344 ret
= mi_lttng_pids_open(writer
);
349 for (i
= 0; i
< count
; i
++) {
350 if (cur_pid
!= events
[i
].pid
) {
351 if (pid_element_open
) {
352 /* Close the previous events and pid element */
353 ret
= mi_lttng_close_multi_element(writer
, 2);
357 pid_element_open
= 0;
360 cur_pid
= events
[i
].pid
;
361 cmdline
= get_cmdline_by_pid(cur_pid
);
367 if (!pid_element_open
) {
368 /* Open and write a pid element */
369 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
374 /* Open events element */
375 ret
= mi_lttng_events_open(writer
);
380 pid_element_open
= 1;
386 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
393 ret
= mi_lttng_writer_close_element(writer
);
398 /* Close domain, domains */
399 ret
= mi_lttng_close_multi_element(writer
, 2);
407 static int list_agent_events(void)
409 int i
, size
, ret
= CMD_SUCCESS
;
410 struct lttng_domain domain
;
411 struct lttng_handle
*handle
;
412 struct lttng_event
*event_list
;
414 char *cmdline
= NULL
;
415 const char *agent_domain_str
;
417 memset(&domain
, 0, sizeof(domain
));
419 domain
.type
= LTTNG_DOMAIN_JUL
;
420 } else if (opt_log4j
) {
421 domain
.type
= LTTNG_DOMAIN_LOG4J
;
422 } else if (opt_python
) {
423 domain
.type
= LTTNG_DOMAIN_PYTHON
;
426 agent_domain_str
= get_domain_str(domain
.type
);
428 DBG("Getting %s tracing events", agent_domain_str
);
430 handle
= lttng_create_handle(NULL
, &domain
);
431 if (handle
== NULL
) {
436 size
= lttng_list_tracepoints(handle
, &event_list
);
438 ERR("Unable to list %s events: %s", agent_domain_str
,
439 lttng_strerror(size
));
446 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
453 MSG("%s events (Logger name):\n-------------------------",
460 for (i
= 0; i
< size
; i
++) {
461 if (cur_pid
!= event_list
[i
].pid
) {
462 cur_pid
= event_list
[i
].pid
;
463 cmdline
= get_cmdline_by_pid(cur_pid
);
464 if (cmdline
== NULL
) {
468 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
471 MSG("%s- %s", indent6
, event_list
[i
].name
);
480 lttng_destroy_handle(handle
);
485 * Ask session daemon for all user space tracepoints available.
487 static int list_ust_events(void)
489 int i
, size
, ret
= CMD_SUCCESS
;
490 struct lttng_domain domain
;
491 struct lttng_handle
*handle
;
492 struct lttng_event
*event_list
;
494 char *cmdline
= NULL
;
496 memset(&domain
, 0, sizeof(domain
));
498 DBG("Getting UST tracing events");
500 domain
.type
= LTTNG_DOMAIN_UST
;
502 handle
= lttng_create_handle(NULL
, &domain
);
503 if (handle
== NULL
) {
508 size
= lttng_list_tracepoints(handle
, &event_list
);
510 ERR("Unable to list UST events: %s", lttng_strerror(size
));
517 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
520 MSG("UST events:\n-------------");
526 for (i
= 0; i
< size
; i
++) {
527 if (cur_pid
!= event_list
[i
].pid
) {
528 cur_pid
= event_list
[i
].pid
;
529 cmdline
= get_cmdline_by_pid(cur_pid
);
530 if (cmdline
== NULL
) {
534 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
537 print_events(&event_list
[i
]);
546 lttng_destroy_handle(handle
);
552 * List all ust event with their fields
554 static int mi_list_ust_event_fields(struct lttng_event_field
*fields
, int count
,
555 struct lttng_domain
*domain
)
559 char *cmdline
= NULL
;
560 int pid_element_open
= 0;
561 int event_element_open
= 0;
562 struct lttng_event cur_event
;
564 /* Open domains element */
565 ret
= mi_lttng_domains_open(writer
);
571 ret
= mi_lttng_domain(writer
, domain
, 1);
576 /* Open pids element */
577 ret
= mi_lttng_pids_open(writer
);
582 for (i
= 0; i
< count
; i
++) {
583 if (cur_pid
!= fields
[i
].event
.pid
) {
584 if (pid_element_open
) {
585 if (event_element_open
) {
587 /* Close the previous field element and event. */
588 ret
= mi_lttng_close_multi_element(writer
, 2);
592 event_element_open
= 0;
594 /* Close the previous events, pid element */
595 ret
= mi_lttng_close_multi_element(writer
, 2);
599 pid_element_open
= 0;
602 cur_pid
= fields
[i
].event
.pid
;
603 cmdline
= get_cmdline_by_pid(cur_pid
);
604 if (!pid_element_open
) {
605 /* Open and write a pid element */
606 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
611 /* Open events element */
612 ret
= mi_lttng_events_open(writer
);
616 pid_element_open
= 1;
619 /* Wipe current event since we are about to print a new PID. */
620 memset(&cur_event
, 0, sizeof(cur_event
));
623 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
624 if (event_element_open
) {
625 /* Close the previous fields element and the previous event */
626 ret
= mi_lttng_close_multi_element(writer
, 2);
630 event_element_open
= 0;
633 memcpy(&cur_event
, &fields
[i
].event
,
636 if (!event_element_open
) {
637 /* Open and write the event */
638 ret
= mi_lttng_event(writer
, &cur_event
, 1,
639 handle
->domain
.type
);
644 /* Open a fields element */
645 ret
= mi_lttng_event_fields_open(writer
);
649 event_element_open
= 1;
653 /* Print the event_field */
654 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
660 /* Close pids, domain, domains */
661 ret
= mi_lttng_close_multi_element(writer
, 3);
670 * Ask session daemon for all user space tracepoint fields available.
672 static int list_ust_event_fields(void)
674 int i
, size
, ret
= CMD_SUCCESS
;
675 struct lttng_domain domain
;
676 struct lttng_handle
*handle
;
677 struct lttng_event_field
*event_field_list
;
679 char *cmdline
= NULL
;
681 struct lttng_event cur_event
;
683 memset(&domain
, 0, sizeof(domain
));
684 memset(&cur_event
, 0, sizeof(cur_event
));
686 DBG("Getting UST tracing event fields");
688 domain
.type
= LTTNG_DOMAIN_UST
;
690 handle
= lttng_create_handle(NULL
, &domain
);
691 if (handle
== NULL
) {
696 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
698 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
705 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
712 MSG("UST events:\n-------------");
718 for (i
= 0; i
< size
; i
++) {
719 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
720 cur_pid
= event_field_list
[i
].event
.pid
;
721 cmdline
= get_cmdline_by_pid(cur_pid
);
722 if (cmdline
== NULL
) {
726 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
728 /* Wipe current event since we are about to print a new PID. */
729 memset(&cur_event
, 0, sizeof(cur_event
));
731 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
732 print_events(&event_field_list
[i
].event
);
733 memcpy(&cur_event
, &event_field_list
[i
].event
,
736 print_event_field(&event_field_list
[i
]);
743 free(event_field_list
);
745 lttng_destroy_handle(handle
);
751 * Print a list of kernel events
753 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
754 struct lttng_domain
*domain
)
758 /* Open domains element */
759 ret
= mi_lttng_domains_open(writer
);
765 ret
= mi_lttng_domain(writer
, domain
, 1);
771 ret
= mi_lttng_events_open(writer
);
776 for (i
= 0; i
< count
; i
++) {
777 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
783 /* close events, domain and domains */
784 ret
= mi_lttng_close_multi_element(writer
, 3);
794 * Ask for all trace events in the kernel
796 static int list_kernel_events(void)
798 int i
, size
, ret
= CMD_SUCCESS
;
799 struct lttng_domain domain
;
800 struct lttng_handle
*handle
;
801 struct lttng_event
*event_list
;
803 memset(&domain
, 0, sizeof(domain
));
805 DBG("Getting kernel tracing events");
807 domain
.type
= LTTNG_DOMAIN_KERNEL
;
809 handle
= lttng_create_handle(NULL
, &domain
);
810 if (handle
== NULL
) {
815 size
= lttng_list_tracepoints(handle
, &event_list
);
817 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
818 lttng_destroy_handle(handle
);
824 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
830 MSG("Kernel events:\n-------------");
832 for (i
= 0; i
< size
; i
++) {
833 print_events(&event_list
[i
]);
842 lttng_destroy_handle(handle
);
846 lttng_destroy_handle(handle
);
852 * Print a list of system calls.
854 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
859 ret
= mi_lttng_events_open(writer
);
864 for (i
= 0; i
< count
; i
++) {
865 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
872 ret
= mi_lttng_writer_close_element(writer
);
882 * Ask for kernel system calls.
884 static int list_syscalls(void)
886 int i
, size
, ret
= CMD_SUCCESS
;
887 struct lttng_event
*event_list
;
889 DBG("Getting kernel system call events");
891 size
= lttng_list_syscalls(&event_list
);
893 ERR("Unable to list system calls: %s", lttng_strerror(size
));
900 ret
= mi_list_syscalls(event_list
, size
);
906 MSG("System calls:\n-------------");
908 for (i
= 0; i
< size
; i
++) {
909 print_events(&event_list
[i
]);
925 * Print a list of agent events
927 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
931 /* Open events element */
932 ret
= mi_lttng_events_open(writer
);
937 for (i
= 0; i
< count
; i
++) {
938 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
944 /* Close events element */
945 ret
= mi_lttng_writer_close_element(writer
);
952 * List agent events for a specific session using the handle.
954 * Return CMD_SUCCESS on success else a negative value.
956 static int list_session_agent_events(void)
958 int ret
= CMD_SUCCESS
, count
, i
;
959 struct lttng_event
*events
= NULL
;
961 count
= lttng_list_events(handle
, "", &events
);
964 ERR("%s", lttng_strerror(count
));
970 ret
= mi_list_session_agent_events(events
, count
);
977 MSG("Events (Logger name):\n---------------------");
979 MSG("%sNone\n", indent6
);
983 for (i
= 0; i
< count
; i
++) {
984 MSG("%s- %s%s (loglevel%s %s)", indent4
, events
[i
].name
,
985 enabled_string(events
[i
].enabled
),
986 logleveltype_string(events
[i
].loglevel_type
),
987 mi_lttng_loglevel_string(events
[i
].loglevel
,
988 handle
->domain
.type
));
1002 * print a list of event
1004 static int mi_list_events(struct lttng_event
*events
, int count
)
1008 /* Open events element */
1009 ret
= mi_lttng_events_open(writer
);
1014 for (i
= 0; i
< count
; i
++) {
1015 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1021 /* Close events element */
1022 ret
= mi_lttng_writer_close_element(writer
);
1029 * List events of channel of session and domain.
1031 static int list_events(const char *channel_name
)
1033 int ret
= CMD_SUCCESS
, count
, i
;
1034 struct lttng_event
*events
= NULL
;
1036 count
= lttng_list_events(handle
, channel_name
, &events
);
1039 ERR("%s", lttng_strerror(count
));
1045 ret
= mi_list_events(events
, count
);
1052 MSG("\n%sEvents:", indent4
);
1054 MSG("%sNone\n", indent6
);
1058 for (i
= 0; i
< count
; i
++) {
1059 print_events(&events
[i
]);
1071 * Pretty print channel
1073 static void print_channel(struct lttng_channel
*channel
)
1075 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1077 MSG("%sAttributes:", indent4
);
1078 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1079 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1080 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1081 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1082 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1083 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1084 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1085 switch (channel
->attr
.output
) {
1086 case LTTNG_EVENT_SPLICE
:
1087 MSG("%soutput: splice()", indent6
);
1089 case LTTNG_EVENT_MMAP
:
1090 MSG("%soutput: mmap()", indent6
);
1097 * Print a list of channel
1100 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1101 const char *channel_name
)
1104 unsigned int chan_found
= 0;
1106 /* Open channels element */
1107 ret
= mi_lttng_channels_open(writer
);
1112 for (i
= 0; i
< count
; i
++) {
1113 if (channel_name
!= NULL
) {
1114 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1121 /* Write channel element and leave it open */
1122 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1127 /* Listing events per channel */
1128 ret
= list_events(channels
[i
].name
);
1133 /* Closing the channel element we opened earlier */
1134 ret
= mi_lttng_writer_close_element(writer
);
1144 /* Close channels element */
1145 ret
= mi_lttng_writer_close_element(writer
);
1155 * List channel(s) of session and domain.
1157 * If channel_name is NULL, all channels are listed.
1159 static int list_channels(const char *channel_name
)
1161 int count
, i
, ret
= CMD_SUCCESS
;
1162 unsigned int chan_found
= 0;
1163 struct lttng_channel
*channels
= NULL
;
1165 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1167 count
= lttng_list_channels(handle
, &channels
);
1170 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1172 /* When printing mi this is not an error
1173 * but an empty channels element */
1177 WARN("No kernel channel");
1178 goto error_channels
;
1182 /* We had a real error */
1184 ERR("%s", lttng_strerror(count
));
1185 goto error_channels
;
1192 ret
= mi_list_channels(channels
, count
, channel_name
);
1200 MSG("Channels:\n-------------");
1203 for (i
= 0; i
< count
; i
++) {
1204 if (channel_name
!= NULL
) {
1205 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1211 print_channel(&channels
[i
]);
1213 /* Listing events per channel */
1214 ret
= list_events(channels
[i
].name
);
1224 if (!chan_found
&& channel_name
!= NULL
) {
1226 ERR("Channel %s not found", channel_name
);
1238 * List tracker PID(s) of session and domain.
1240 static int list_tracker_pids(void)
1246 ret
= lttng_list_tracker_pids(handle
,
1247 &enabled
, &pids
, &nr_pids
);
1253 _MSG("PID tracker: [");
1255 for (i
= 0; i
< nr_pids
; i
++) {
1259 _MSG(" %d", pids
[i
]);
1269 * Find the session with session_name as name
1270 * and print his informations.
1272 static int mi_list_session(const char *session_name
,
1273 struct lttng_session
*sessions
, int count
)
1276 unsigned int session_found
= 0;
1278 if (session_name
== NULL
) {
1279 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1283 for (i
= 0; i
< count
; i
++) {
1284 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1285 /* We need to leave it open to append other informations
1286 * like domain, channel, events etc.*/
1288 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1296 if (!session_found
) {
1297 ERR("Session '%s' not found", session_name
);
1298 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1308 * List all availables session
1310 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1314 /* Opening sessions element */
1315 ret
= mi_lttng_sessions_open(writer
);
1320 /* Listing sessions */
1321 for (i
= 0; i
< count
; i
++) {
1322 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1328 /* Closing sessions element */
1329 ret
= mi_lttng_writer_close_element(writer
);
1339 * List available tracing session. List only basic information.
1341 * If session_name is NULL, all sessions are listed.
1343 static int list_sessions(const char *session_name
)
1345 int ret
= CMD_SUCCESS
;
1347 unsigned int session_found
= 0;
1348 struct lttng_session
*sessions
;
1350 count
= lttng_list_sessions(&sessions
);
1351 DBG("Session count %d", count
);
1354 ERR("%s", lttng_strerror(count
));
1360 if (session_name
== NULL
) {
1361 /* List all session */
1362 ret
= mi_list_sessions(sessions
, count
);
1364 /* Note : this return an open session element */
1365 ret
= mi_list_session(session_name
, sessions
, count
);
1374 MSG("Currently no available tracing session");
1378 if (session_name
== NULL
) {
1379 MSG("Available tracing sessions:");
1383 for (i
= 0; i
< count
; i
++) {
1384 if (session_name
!= NULL
) {
1385 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1387 MSG("Tracing session %s: [%s%s]", session_name
,
1388 active_string(sessions
[i
].enabled
),
1389 snapshot_string(sessions
[i
].snapshot_mode
));
1390 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1394 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1395 sessions
[i
].name
, sessions
[i
].path
,
1396 active_string(sessions
[i
].enabled
),
1397 snapshot_string(sessions
[i
].snapshot_mode
));
1398 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1399 if (sessions
[i
].live_timer_interval
!= 0) {
1400 MSG("%sLive timer interval (usec): %u", indent4
,
1401 sessions
[i
].live_timer_interval
);
1407 if (!session_found
&& session_name
!= NULL
) {
1408 ERR("Session '%s' not found", session_name
);
1413 if (session_name
== NULL
) {
1414 MSG("\nUse lttng list <session_name> for more details");
1427 * list available domain(s) for a session.
1429 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1432 /* Open domains element */
1433 ret
= mi_lttng_domains_open(writer
);
1438 for (i
= 0; i
< count
; i
++) {
1439 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1445 /* Closing domains element */
1446 ret
= mi_lttng_writer_close_element(writer
);
1455 * List available domain(s) for a session.
1457 static int list_domains(const char *session_name
)
1459 int i
, count
, ret
= CMD_SUCCESS
;
1460 struct lttng_domain
*domains
= NULL
;
1463 count
= lttng_list_domains(session_name
, &domains
);
1466 ERR("%s", lttng_strerror(count
));
1472 ret
= mi_list_domains(domains
, count
);
1479 MSG("Domains:\n-------------");
1485 for (i
= 0; i
< count
; i
++) {
1486 switch (domains
[i
].type
) {
1487 case LTTNG_DOMAIN_KERNEL
:
1490 case LTTNG_DOMAIN_UST
:
1491 MSG(" - UST global");
1493 case LTTNG_DOMAIN_JUL
:
1494 MSG(" - JUL (Java Util Logging)");
1496 case LTTNG_DOMAIN_LOG4J
:
1497 MSG(" - LOG4j (Logging for Java)");
1499 case LTTNG_DOMAIN_PYTHON
:
1500 MSG(" - Python (logging)");
1516 * The 'list <options>' first level command
1518 int cmd_list(int argc
, const char **argv
)
1520 int opt
, ret
= CMD_SUCCESS
;
1521 const char *session_name
;
1522 static poptContext pc
;
1523 struct lttng_domain domain
;
1524 struct lttng_domain
*domains
= NULL
;
1526 memset(&domain
, 0, sizeof(domain
));
1534 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1535 poptReadDefaultConfig(pc
, 0);
1537 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1545 case OPT_LIST_OPTIONS
:
1546 list_cmd_options(stdout
, long_options
);
1550 ret
= CMD_UNDEFINED
;
1557 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1563 /* Open command element */
1564 ret
= mi_lttng_writer_command_open(writer
,
1565 mi_lttng_element_command_list
);
1571 /* Open output element */
1572 ret
= mi_lttng_writer_open_element(writer
,
1573 mi_lttng_element_command_output
);
1580 /* Get session name (trailing argument) */
1581 session_name
= poptGetArg(pc
);
1582 DBG2("Session name: %s", session_name
);
1585 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1586 } else if (opt_userspace
) {
1587 DBG2("Listing userspace global domain");
1588 domain
.type
= LTTNG_DOMAIN_UST
;
1589 } else if (opt_jul
) {
1590 DBG2("Listing JUL domain");
1591 domain
.type
= LTTNG_DOMAIN_JUL
;
1592 } else if (opt_log4j
) {
1593 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1594 } else if (opt_python
) {
1595 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1598 if (!opt_kernel
&& opt_syscall
) {
1599 WARN("--syscall will only work with the Kernel domain (-k)");
1604 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1605 handle
= lttng_create_handle(session_name
, &domain
);
1606 if (handle
== NULL
) {
1612 if (session_name
== NULL
) {
1613 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1615 ret
= list_sessions(NULL
);
1622 ret
= list_syscalls();
1627 ret
= list_kernel_events();
1633 if (opt_userspace
) {
1635 ret
= list_ust_event_fields();
1637 ret
= list_ust_events();
1643 if (opt_jul
|| opt_log4j
|| opt_python
) {
1644 ret
= list_agent_events();
1650 /* List session attributes */
1652 /* Open element sessions
1653 * Present for xml consistency */
1654 ret
= mi_lttng_sessions_open(writer
);
1659 /* MI: the ouptut of list_sessions is an unclosed session element */
1660 ret
= list_sessions(session_name
);
1665 /* Domain listing */
1667 ret
= list_domains(session_name
);
1671 /* Channel listing */
1672 if (opt_kernel
|| opt_userspace
) {
1674 /* Add of domains and domain element for xml
1675 * consistency and validation
1677 ret
= mi_lttng_domains_open(writer
);
1682 /* Open domain and leave it open for
1683 * nested channels printing */
1684 ret
= mi_lttng_domain(writer
, &domain
, 1);
1691 ret
= list_tracker_pids();
1696 ret
= list_channels(opt_channel
);
1702 /* Close domain and domain element */
1703 ret
= mi_lttng_close_multi_element(writer
, 2);
1713 /* We want all domain(s) */
1714 nb_domain
= lttng_list_domains(session_name
, &domains
);
1715 if (nb_domain
< 0) {
1717 ERR("%s", lttng_strerror(nb_domain
));
1722 ret
= mi_lttng_domains_open(writer
);
1729 for (i
= 0; i
< nb_domain
; i
++) {
1730 switch (domains
[i
].type
) {
1731 case LTTNG_DOMAIN_KERNEL
:
1732 MSG("=== Domain: Kernel ===\n");
1734 case LTTNG_DOMAIN_UST
:
1735 MSG("=== Domain: UST global ===\n");
1736 MSG("Buffer type: %s\n",
1737 domains
[i
].buf_type
==
1738 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1740 case LTTNG_DOMAIN_JUL
:
1741 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1743 case LTTNG_DOMAIN_LOG4J
:
1744 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1746 case LTTNG_DOMAIN_PYTHON
:
1747 MSG("=== Domain: Python (logging) ===\n");
1750 MSG("=== Domain: Unimplemented ===\n");
1755 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1762 /* Clean handle before creating a new one */
1764 lttng_destroy_handle(handle
);
1767 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1768 if (handle
== NULL
) {
1773 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1774 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1775 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1776 ret
= list_session_agent_events();
1783 switch (domains
[i
].type
) {
1784 case LTTNG_DOMAIN_KERNEL
:
1785 case LTTNG_DOMAIN_UST
:
1786 ret
= list_tracker_pids();
1795 ret
= list_channels(opt_channel
);
1801 /* Close domain element */
1802 ret
= mi_lttng_writer_close_element(writer
);
1811 /* Close the domains, session and sessions element */
1812 ret
= mi_lttng_close_multi_element(writer
, 3);
1823 /* Close output element */
1824 ret
= mi_lttng_writer_close_element(writer
);
1830 /* Command element close */
1831 ret
= mi_lttng_writer_command_close(writer
);
1839 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1840 /* Preserve original error code */
1841 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
1846 lttng_destroy_handle(handle
);
1849 poptFreeContext(pc
);