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
= NULL
;
412 struct lttng_event
*event_list
= NULL
;
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
;
425 ERR("Invalid agent domain selected.");
430 agent_domain_str
= get_domain_str(domain
.type
);
432 DBG("Getting %s tracing events", agent_domain_str
);
434 handle
= lttng_create_handle(NULL
, &domain
);
435 if (handle
== NULL
) {
440 size
= lttng_list_tracepoints(handle
, &event_list
);
442 ERR("Unable to list %s events: %s", agent_domain_str
,
443 lttng_strerror(size
));
450 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
457 MSG("%s events (Logger name):\n-------------------------",
464 for (i
= 0; i
< size
; i
++) {
465 if (cur_pid
!= event_list
[i
].pid
) {
466 cur_pid
= event_list
[i
].pid
;
467 cmdline
= get_cmdline_by_pid(cur_pid
);
468 if (cmdline
== NULL
) {
472 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
475 MSG("%s- %s", indent6
, event_list
[i
].name
);
484 lttng_destroy_handle(handle
);
489 * Ask session daemon for all user space tracepoints available.
491 static int list_ust_events(void)
493 int i
, size
, ret
= CMD_SUCCESS
;
494 struct lttng_domain domain
;
495 struct lttng_handle
*handle
;
496 struct lttng_event
*event_list
;
498 char *cmdline
= NULL
;
500 memset(&domain
, 0, sizeof(domain
));
502 DBG("Getting UST tracing events");
504 domain
.type
= LTTNG_DOMAIN_UST
;
506 handle
= lttng_create_handle(NULL
, &domain
);
507 if (handle
== NULL
) {
512 size
= lttng_list_tracepoints(handle
, &event_list
);
514 ERR("Unable to list UST events: %s", lttng_strerror(size
));
521 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
524 MSG("UST events:\n-------------");
530 for (i
= 0; i
< size
; i
++) {
531 if (cur_pid
!= event_list
[i
].pid
) {
532 cur_pid
= event_list
[i
].pid
;
533 cmdline
= get_cmdline_by_pid(cur_pid
);
534 if (cmdline
== NULL
) {
538 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
541 print_events(&event_list
[i
]);
550 lttng_destroy_handle(handle
);
556 * List all ust event with their fields
558 static int mi_list_ust_event_fields(struct lttng_event_field
*fields
, int count
,
559 struct lttng_domain
*domain
)
563 char *cmdline
= NULL
;
564 int pid_element_open
= 0;
565 int event_element_open
= 0;
566 struct lttng_event cur_event
;
568 /* Open domains element */
569 ret
= mi_lttng_domains_open(writer
);
575 ret
= mi_lttng_domain(writer
, domain
, 1);
580 /* Open pids element */
581 ret
= mi_lttng_pids_open(writer
);
586 for (i
= 0; i
< count
; i
++) {
587 if (cur_pid
!= fields
[i
].event
.pid
) {
588 if (pid_element_open
) {
589 if (event_element_open
) {
591 /* Close the previous field element and event. */
592 ret
= mi_lttng_close_multi_element(writer
, 2);
596 event_element_open
= 0;
598 /* Close the previous events, pid element */
599 ret
= mi_lttng_close_multi_element(writer
, 2);
603 pid_element_open
= 0;
606 cur_pid
= fields
[i
].event
.pid
;
607 cmdline
= get_cmdline_by_pid(cur_pid
);
608 if (!pid_element_open
) {
609 /* Open and write a pid element */
610 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
615 /* Open events element */
616 ret
= mi_lttng_events_open(writer
);
620 pid_element_open
= 1;
623 /* Wipe current event since we are about to print a new PID. */
624 memset(&cur_event
, 0, sizeof(cur_event
));
627 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
628 if (event_element_open
) {
629 /* Close the previous fields element and the previous event */
630 ret
= mi_lttng_close_multi_element(writer
, 2);
634 event_element_open
= 0;
637 memcpy(&cur_event
, &fields
[i
].event
,
640 if (!event_element_open
) {
641 /* Open and write the event */
642 ret
= mi_lttng_event(writer
, &cur_event
, 1,
643 handle
->domain
.type
);
648 /* Open a fields element */
649 ret
= mi_lttng_event_fields_open(writer
);
653 event_element_open
= 1;
657 /* Print the event_field */
658 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
664 /* Close pids, domain, domains */
665 ret
= mi_lttng_close_multi_element(writer
, 3);
674 * Ask session daemon for all user space tracepoint fields available.
676 static int list_ust_event_fields(void)
678 int i
, size
, ret
= CMD_SUCCESS
;
679 struct lttng_domain domain
;
680 struct lttng_handle
*handle
;
681 struct lttng_event_field
*event_field_list
;
683 char *cmdline
= NULL
;
685 struct lttng_event cur_event
;
687 memset(&domain
, 0, sizeof(domain
));
688 memset(&cur_event
, 0, sizeof(cur_event
));
690 DBG("Getting UST tracing event fields");
692 domain
.type
= LTTNG_DOMAIN_UST
;
694 handle
= lttng_create_handle(NULL
, &domain
);
695 if (handle
== NULL
) {
700 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
702 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
709 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
716 MSG("UST events:\n-------------");
722 for (i
= 0; i
< size
; i
++) {
723 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
724 cur_pid
= event_field_list
[i
].event
.pid
;
725 cmdline
= get_cmdline_by_pid(cur_pid
);
726 if (cmdline
== NULL
) {
730 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
732 /* Wipe current event since we are about to print a new PID. */
733 memset(&cur_event
, 0, sizeof(cur_event
));
735 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
736 print_events(&event_field_list
[i
].event
);
737 memcpy(&cur_event
, &event_field_list
[i
].event
,
740 print_event_field(&event_field_list
[i
]);
747 free(event_field_list
);
749 lttng_destroy_handle(handle
);
755 * Print a list of kernel events
757 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
758 struct lttng_domain
*domain
)
762 /* Open domains element */
763 ret
= mi_lttng_domains_open(writer
);
769 ret
= mi_lttng_domain(writer
, domain
, 1);
775 ret
= mi_lttng_events_open(writer
);
780 for (i
= 0; i
< count
; i
++) {
781 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
787 /* close events, domain and domains */
788 ret
= mi_lttng_close_multi_element(writer
, 3);
798 * Ask for all trace events in the kernel
800 static int list_kernel_events(void)
802 int i
, size
, ret
= CMD_SUCCESS
;
803 struct lttng_domain domain
;
804 struct lttng_handle
*handle
;
805 struct lttng_event
*event_list
;
807 memset(&domain
, 0, sizeof(domain
));
809 DBG("Getting kernel tracing events");
811 domain
.type
= LTTNG_DOMAIN_KERNEL
;
813 handle
= lttng_create_handle(NULL
, &domain
);
814 if (handle
== NULL
) {
819 size
= lttng_list_tracepoints(handle
, &event_list
);
821 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
822 lttng_destroy_handle(handle
);
828 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
834 MSG("Kernel events:\n-------------");
836 for (i
= 0; i
< size
; i
++) {
837 print_events(&event_list
[i
]);
846 lttng_destroy_handle(handle
);
850 lttng_destroy_handle(handle
);
856 * Print a list of system calls.
858 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
863 ret
= mi_lttng_events_open(writer
);
868 for (i
= 0; i
< count
; i
++) {
869 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
876 ret
= mi_lttng_writer_close_element(writer
);
886 * Ask for kernel system calls.
888 static int list_syscalls(void)
890 int i
, size
, ret
= CMD_SUCCESS
;
891 struct lttng_event
*event_list
;
893 DBG("Getting kernel system call events");
895 size
= lttng_list_syscalls(&event_list
);
897 ERR("Unable to list system calls: %s", lttng_strerror(size
));
904 ret
= mi_list_syscalls(event_list
, size
);
910 MSG("System calls:\n-------------");
912 for (i
= 0; i
< size
; i
++) {
913 print_events(&event_list
[i
]);
929 * Print a list of agent events
931 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
935 /* Open events element */
936 ret
= mi_lttng_events_open(writer
);
941 for (i
= 0; i
< count
; i
++) {
942 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
948 /* Close events element */
949 ret
= mi_lttng_writer_close_element(writer
);
956 * List agent events for a specific session using the handle.
958 * Return CMD_SUCCESS on success else a negative value.
960 static int list_session_agent_events(void)
962 int ret
= CMD_SUCCESS
, count
, i
;
963 struct lttng_event
*events
= NULL
;
965 count
= lttng_list_events(handle
, "", &events
);
968 ERR("%s", lttng_strerror(count
));
974 ret
= mi_list_session_agent_events(events
, count
);
981 MSG("Events (Logger name):\n---------------------");
983 MSG("%sNone\n", indent6
);
987 for (i
= 0; i
< count
; i
++) {
988 MSG("%s- %s%s (loglevel%s %s)", indent4
, events
[i
].name
,
989 enabled_string(events
[i
].enabled
),
990 logleveltype_string(events
[i
].loglevel_type
),
991 mi_lttng_loglevel_string(events
[i
].loglevel
,
992 handle
->domain
.type
));
1006 * print a list of event
1008 static int mi_list_events(struct lttng_event
*events
, int count
)
1012 /* Open events element */
1013 ret
= mi_lttng_events_open(writer
);
1018 for (i
= 0; i
< count
; i
++) {
1019 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1025 /* Close events element */
1026 ret
= mi_lttng_writer_close_element(writer
);
1033 * List events of channel of session and domain.
1035 static int list_events(const char *channel_name
)
1037 int ret
= CMD_SUCCESS
, count
, i
;
1038 struct lttng_event
*events
= NULL
;
1040 count
= lttng_list_events(handle
, channel_name
, &events
);
1043 ERR("%s", lttng_strerror(count
));
1049 ret
= mi_list_events(events
, count
);
1056 MSG("\n%sEvents:", indent4
);
1058 MSG("%sNone\n", indent6
);
1062 for (i
= 0; i
< count
; i
++) {
1063 print_events(&events
[i
]);
1075 * Pretty print channel
1077 static void print_channel(struct lttng_channel
*channel
)
1079 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1081 MSG("%sAttributes:", indent4
);
1082 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1083 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1084 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1085 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1086 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1087 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1088 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1089 switch (channel
->attr
.output
) {
1090 case LTTNG_EVENT_SPLICE
:
1091 MSG("%soutput: splice()", indent6
);
1093 case LTTNG_EVENT_MMAP
:
1094 MSG("%soutput: mmap()", indent6
);
1101 * Print a list of channel
1104 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1105 const char *channel_name
)
1108 unsigned int chan_found
= 0;
1110 /* Open channels element */
1111 ret
= mi_lttng_channels_open(writer
);
1116 for (i
= 0; i
< count
; i
++) {
1117 if (channel_name
!= NULL
) {
1118 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1125 /* Write channel element and leave it open */
1126 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1131 /* Listing events per channel */
1132 ret
= list_events(channels
[i
].name
);
1137 /* Closing the channel element we opened earlier */
1138 ret
= mi_lttng_writer_close_element(writer
);
1148 /* Close channels element */
1149 ret
= mi_lttng_writer_close_element(writer
);
1159 * List channel(s) of session and domain.
1161 * If channel_name is NULL, all channels are listed.
1163 static int list_channels(const char *channel_name
)
1165 int count
, i
, ret
= CMD_SUCCESS
;
1166 unsigned int chan_found
= 0;
1167 struct lttng_channel
*channels
= NULL
;
1169 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1171 count
= lttng_list_channels(handle
, &channels
);
1174 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1176 /* When printing mi this is not an error
1177 * but an empty channels element */
1181 WARN("No kernel channel");
1182 goto error_channels
;
1186 /* We had a real error */
1188 ERR("%s", lttng_strerror(count
));
1189 goto error_channels
;
1196 ret
= mi_list_channels(channels
, count
, channel_name
);
1204 MSG("Channels:\n-------------");
1207 for (i
= 0; i
< count
; i
++) {
1208 if (channel_name
!= NULL
) {
1209 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1215 print_channel(&channels
[i
]);
1217 /* Listing events per channel */
1218 ret
= list_events(channels
[i
].name
);
1228 if (!chan_found
&& channel_name
!= NULL
) {
1230 ERR("Channel %s not found", channel_name
);
1242 * List tracker PID(s) of session and domain.
1244 static int list_tracker_pids(void)
1250 ret
= lttng_list_tracker_pids(handle
,
1251 &enabled
, &pids
, &nr_pids
);
1257 _MSG("PID tracker: [");
1259 for (i
= 0; i
< nr_pids
; i
++) {
1263 _MSG(" %d", pids
[i
]);
1273 * Find the session with session_name as name
1274 * and print his informations.
1276 static int mi_list_session(const char *session_name
,
1277 struct lttng_session
*sessions
, int count
)
1280 unsigned int session_found
= 0;
1282 if (session_name
== NULL
) {
1283 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1287 for (i
= 0; i
< count
; i
++) {
1288 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1289 /* We need to leave it open to append other informations
1290 * like domain, channel, events etc.*/
1292 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1300 if (!session_found
) {
1301 ERR("Session '%s' not found", session_name
);
1302 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1312 * List all availables session
1314 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1318 /* Opening sessions element */
1319 ret
= mi_lttng_sessions_open(writer
);
1324 /* Listing sessions */
1325 for (i
= 0; i
< count
; i
++) {
1326 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1332 /* Closing sessions element */
1333 ret
= mi_lttng_writer_close_element(writer
);
1343 * List available tracing session. List only basic information.
1345 * If session_name is NULL, all sessions are listed.
1347 static int list_sessions(const char *session_name
)
1349 int ret
= CMD_SUCCESS
;
1351 unsigned int session_found
= 0;
1352 struct lttng_session
*sessions
;
1354 count
= lttng_list_sessions(&sessions
);
1355 DBG("Session count %d", count
);
1358 ERR("%s", lttng_strerror(count
));
1364 if (session_name
== NULL
) {
1365 /* List all session */
1366 ret
= mi_list_sessions(sessions
, count
);
1368 /* Note : this return an open session element */
1369 ret
= mi_list_session(session_name
, sessions
, count
);
1378 MSG("Currently no available tracing session");
1382 if (session_name
== NULL
) {
1383 MSG("Available tracing sessions:");
1387 for (i
= 0; i
< count
; i
++) {
1388 if (session_name
!= NULL
) {
1389 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1391 MSG("Tracing session %s: [%s%s]", session_name
,
1392 active_string(sessions
[i
].enabled
),
1393 snapshot_string(sessions
[i
].snapshot_mode
));
1394 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1398 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1399 sessions
[i
].name
, sessions
[i
].path
,
1400 active_string(sessions
[i
].enabled
),
1401 snapshot_string(sessions
[i
].snapshot_mode
));
1402 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1403 if (sessions
[i
].live_timer_interval
!= 0) {
1404 MSG("%sLive timer interval (usec): %u", indent4
,
1405 sessions
[i
].live_timer_interval
);
1411 if (!session_found
&& session_name
!= NULL
) {
1412 ERR("Session '%s' not found", session_name
);
1417 if (session_name
== NULL
) {
1418 MSG("\nUse lttng list <session_name> for more details");
1431 * list available domain(s) for a session.
1433 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1436 /* Open domains element */
1437 ret
= mi_lttng_domains_open(writer
);
1442 for (i
= 0; i
< count
; i
++) {
1443 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1449 /* Closing domains element */
1450 ret
= mi_lttng_writer_close_element(writer
);
1459 * List available domain(s) for a session.
1461 static int list_domains(const char *session_name
)
1463 int i
, count
, ret
= CMD_SUCCESS
;
1464 struct lttng_domain
*domains
= NULL
;
1467 count
= lttng_list_domains(session_name
, &domains
);
1470 ERR("%s", lttng_strerror(count
));
1476 ret
= mi_list_domains(domains
, count
);
1483 MSG("Domains:\n-------------");
1489 for (i
= 0; i
< count
; i
++) {
1490 switch (domains
[i
].type
) {
1491 case LTTNG_DOMAIN_KERNEL
:
1494 case LTTNG_DOMAIN_UST
:
1495 MSG(" - UST global");
1497 case LTTNG_DOMAIN_JUL
:
1498 MSG(" - JUL (Java Util Logging)");
1500 case LTTNG_DOMAIN_LOG4J
:
1501 MSG(" - LOG4j (Logging for Java)");
1503 case LTTNG_DOMAIN_PYTHON
:
1504 MSG(" - Python (logging)");
1520 * The 'list <options>' first level command
1522 int cmd_list(int argc
, const char **argv
)
1524 int opt
, ret
= CMD_SUCCESS
;
1525 const char *session_name
;
1526 static poptContext pc
;
1527 struct lttng_domain domain
;
1528 struct lttng_domain
*domains
= NULL
;
1530 memset(&domain
, 0, sizeof(domain
));
1538 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1539 poptReadDefaultConfig(pc
, 0);
1541 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1549 case OPT_LIST_OPTIONS
:
1550 list_cmd_options(stdout
, long_options
);
1554 ret
= CMD_UNDEFINED
;
1561 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1567 /* Open command element */
1568 ret
= mi_lttng_writer_command_open(writer
,
1569 mi_lttng_element_command_list
);
1575 /* Open output element */
1576 ret
= mi_lttng_writer_open_element(writer
,
1577 mi_lttng_element_command_output
);
1584 /* Get session name (trailing argument) */
1585 session_name
= poptGetArg(pc
);
1586 DBG2("Session name: %s", session_name
);
1589 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1590 } else if (opt_userspace
) {
1591 DBG2("Listing userspace global domain");
1592 domain
.type
= LTTNG_DOMAIN_UST
;
1593 } else if (opt_jul
) {
1594 DBG2("Listing JUL domain");
1595 domain
.type
= LTTNG_DOMAIN_JUL
;
1596 } else if (opt_log4j
) {
1597 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1598 } else if (opt_python
) {
1599 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1602 if (!opt_kernel
&& opt_syscall
) {
1603 WARN("--syscall will only work with the Kernel domain (-k)");
1608 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1609 handle
= lttng_create_handle(session_name
, &domain
);
1610 if (handle
== NULL
) {
1616 if (session_name
== NULL
) {
1617 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1619 ret
= list_sessions(NULL
);
1626 ret
= list_syscalls();
1631 ret
= list_kernel_events();
1637 if (opt_userspace
) {
1639 ret
= list_ust_event_fields();
1641 ret
= list_ust_events();
1647 if (opt_jul
|| opt_log4j
|| opt_python
) {
1648 ret
= list_agent_events();
1654 /* List session attributes */
1656 /* Open element sessions
1657 * Present for xml consistency */
1658 ret
= mi_lttng_sessions_open(writer
);
1663 /* MI: the ouptut of list_sessions is an unclosed session element */
1664 ret
= list_sessions(session_name
);
1669 /* Domain listing */
1671 ret
= list_domains(session_name
);
1675 /* Channel listing */
1676 if (opt_kernel
|| opt_userspace
) {
1678 /* Add of domains and domain element for xml
1679 * consistency and validation
1681 ret
= mi_lttng_domains_open(writer
);
1686 /* Open domain and leave it open for
1687 * nested channels printing */
1688 ret
= mi_lttng_domain(writer
, &domain
, 1);
1695 ret
= list_tracker_pids();
1700 ret
= list_channels(opt_channel
);
1706 /* Close domain and domain element */
1707 ret
= mi_lttng_close_multi_element(writer
, 2);
1717 /* We want all domain(s) */
1718 nb_domain
= lttng_list_domains(session_name
, &domains
);
1719 if (nb_domain
< 0) {
1721 ERR("%s", lttng_strerror(nb_domain
));
1726 ret
= mi_lttng_domains_open(writer
);
1733 for (i
= 0; i
< nb_domain
; i
++) {
1734 switch (domains
[i
].type
) {
1735 case LTTNG_DOMAIN_KERNEL
:
1736 MSG("=== Domain: Kernel ===\n");
1738 case LTTNG_DOMAIN_UST
:
1739 MSG("=== Domain: UST global ===\n");
1740 MSG("Buffer type: %s\n",
1741 domains
[i
].buf_type
==
1742 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1744 case LTTNG_DOMAIN_JUL
:
1745 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1747 case LTTNG_DOMAIN_LOG4J
:
1748 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1750 case LTTNG_DOMAIN_PYTHON
:
1751 MSG("=== Domain: Python (logging) ===\n");
1754 MSG("=== Domain: Unimplemented ===\n");
1759 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1766 /* Clean handle before creating a new one */
1768 lttng_destroy_handle(handle
);
1771 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1772 if (handle
== NULL
) {
1777 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1778 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1779 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1780 ret
= list_session_agent_events();
1787 switch (domains
[i
].type
) {
1788 case LTTNG_DOMAIN_KERNEL
:
1789 case LTTNG_DOMAIN_UST
:
1790 ret
= list_tracker_pids();
1799 ret
= list_channels(opt_channel
);
1805 /* Close domain element */
1806 ret
= mi_lttng_writer_close_element(writer
);
1815 /* Close the domains, session and sessions element */
1816 ret
= mi_lttng_close_multi_element(writer
, 3);
1827 /* Close output element */
1828 ret
= mi_lttng_writer_close_element(writer
);
1834 /* Command element close */
1835 ret
= mi_lttng_writer_command_close(writer
);
1843 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1844 /* Preserve original error code */
1845 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
1850 lttng_destroy_handle(handle
);
1853 poptFreeContext(pc
);