2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <common/mi-lttng.h>
27 #include <lttng/constant.h>
29 #include "../command.h"
31 static int opt_userspace
;
32 static int opt_kernel
;
35 static int opt_python
;
36 static char *opt_channel
;
37 static int opt_domain
;
38 static int opt_fields
;
39 static int opt_syscall
;
41 const char *indent4
= " ";
42 const char *indent6
= " ";
43 const char *indent8
= " ";
51 static struct lttng_handle
*handle
;
52 static struct mi_writer
*writer
;
54 static struct poptOption long_options
[] = {
55 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
56 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
57 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
58 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
59 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
60 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
61 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
62 {"channel", 'c', POPT_ARG_STRING
, &opt_channel
, 0, 0, 0},
63 {"domain", 'd', POPT_ARG_VAL
, &opt_domain
, 1, 0, 0},
64 {"fields", 'f', POPT_ARG_VAL
, &opt_fields
, 1, 0, 0},
65 {"syscall", 'S', POPT_ARG_VAL
, &opt_syscall
, 1, 0, 0},
66 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
73 static void usage(FILE *ofp
)
75 fprintf(ofp
, "usage: lttng list [OPTIONS] [SESSION [SESSION OPTIONS]]\n");
77 fprintf(ofp
, "With no arguments, list available tracing session(s)\n");
79 fprintf(ofp
, "Without a session, -k lists available kernel events\n");
80 fprintf(ofp
, "Without a session, -u lists available userspace events\n");
82 fprintf(ofp
, " -h, --help Show this help\n");
83 fprintf(ofp
, " --list-options Simple listing of options\n");
84 fprintf(ofp
, " -k, --kernel Select kernel domain\n");
85 fprintf(ofp
, " -u, --userspace Select user-space domain.\n");
86 fprintf(ofp
, " -j, --jul Apply for Java application using JUL\n");
87 fprintf(ofp
, " -l, --log4j Apply for Java application using LOG4J\n");
88 fprintf(ofp
, " -p, --python Apply for Python application using logging\n");
89 fprintf(ofp
, " -f, --fields List event fields.\n");
90 fprintf(ofp
, " --syscall List available system calls.\n");
92 fprintf(ofp
, "Session Options:\n");
93 fprintf(ofp
, " -c, --channel NAME List details of a channel\n");
94 fprintf(ofp
, " -d, --domain List available domain(s)\n");
99 * Get command line from /proc for a specific pid.
101 * On success, return an allocated string pointer to the proc cmdline.
102 * On error, return NULL.
104 static char *get_cmdline_by_pid(pid_t pid
)
108 char *cmdline
= NULL
;
109 /* Can't go bigger than /proc/LTTNG_MAX_PID/cmdline */
110 char path
[sizeof("/proc//cmdline") + sizeof(LTTNG_MAX_PID_STR
) - 1];
112 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
113 fp
= fopen(path
, "r");
118 /* Caller must free() *cmdline */
119 cmdline
= zmalloc(PATH_MAX
);
121 PERROR("malloc cmdline");
124 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
126 PERROR("fread proc list");
137 const char *active_string(int value
)
140 case 0: return "inactive";
141 case 1: return "active";
143 default: return NULL
;
147 static const char *snapshot_string(int value
)
158 const char *enabled_string(int value
)
161 case 0: return " [disabled]";
162 case 1: return " [enabled]";
164 default: return NULL
;
169 const char *filter_string(int value
)
172 case 1: return " [with filter]";
178 const char *exclusion_string(int value
)
181 case 1: return " [has exclusions]";
186 static const char *logleveltype_string(enum lttng_loglevel_type value
)
189 case LTTNG_EVENT_LOGLEVEL_ALL
:
191 case LTTNG_EVENT_LOGLEVEL_RANGE
:
193 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
196 return " <<TYPE UNKN>>";
200 static const char *bitness_event(enum lttng_event_flag flags
)
202 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_32
) {
203 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
204 return " [32/64-bit]";
208 } else if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
216 * Pretty print single event.
218 static void print_events(struct lttng_event
*event
)
220 switch (event
->type
) {
221 case LTTNG_EVENT_TRACEPOINT
:
223 if (event
->loglevel
!= -1) {
224 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
227 logleveltype_string(event
->loglevel_type
),
228 mi_lttng_loglevel_string(event
->loglevel
, handle
->domain
.type
),
230 enabled_string(event
->enabled
),
231 exclusion_string(event
->exclusion
),
232 filter_string(event
->filter
));
234 MSG("%s%s (type: tracepoint)%s%s%s",
237 enabled_string(event
->enabled
),
238 exclusion_string(event
->exclusion
),
239 filter_string(event
->filter
));
243 case LTTNG_EVENT_FUNCTION
:
244 MSG("%s%s (type: function)%s%s", indent6
,
245 event
->name
, enabled_string(event
->enabled
),
246 filter_string(event
->filter
));
247 if (event
->attr
.probe
.addr
!= 0) {
248 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
250 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
251 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
254 case LTTNG_EVENT_PROBE
:
255 MSG("%s%s (type: probe)%s%s", indent6
,
256 event
->name
, enabled_string(event
->enabled
),
257 filter_string(event
->filter
));
258 if (event
->attr
.probe
.addr
!= 0) {
259 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
261 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
262 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
265 case LTTNG_EVENT_FUNCTION_ENTRY
:
266 MSG("%s%s (type: function)%s%s", indent6
,
267 event
->name
, enabled_string(event
->enabled
),
268 filter_string(event
->filter
));
269 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
271 case LTTNG_EVENT_SYSCALL
:
272 MSG("%s%s%s%s%s", indent6
, event
->name
,
273 (opt_syscall
? "" : " (type:syscall)"),
274 enabled_string(event
->enabled
),
275 bitness_event(event
->flags
));
277 case LTTNG_EVENT_NOOP
:
278 MSG("%s (type: noop)%s%s", indent6
,
279 enabled_string(event
->enabled
),
280 filter_string(event
->filter
));
282 case LTTNG_EVENT_ALL
:
283 /* We should never have "all" events in list. */
289 static const char *field_type(struct lttng_event_field
*field
)
291 switch(field
->type
) {
292 case LTTNG_EVENT_FIELD_INTEGER
:
294 case LTTNG_EVENT_FIELD_ENUM
:
296 case LTTNG_EVENT_FIELD_FLOAT
:
298 case LTTNG_EVENT_FIELD_STRING
:
300 case LTTNG_EVENT_FIELD_OTHER
:
301 default: /* fall-through */
307 * Pretty print single event fields.
309 static void print_event_field(struct lttng_event_field
*field
)
311 if (!field
->field_name
[0]) {
314 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
315 field_type(field
), field
->nowrite
? " [no write]" : "");
320 * Jul and ust event listing
322 static int mi_list_agent_ust_events(struct lttng_event
*events
, int count
,
323 struct lttng_domain
*domain
)
327 char *cmdline
= NULL
;
328 int pid_element_open
= 0;
330 /* Open domains element */
331 ret
= mi_lttng_domains_open(writer
);
337 ret
= mi_lttng_domain(writer
, domain
, 1);
342 /* Open pids element element */
343 ret
= mi_lttng_pids_open(writer
);
348 for (i
= 0; i
< count
; i
++) {
349 if (cur_pid
!= events
[i
].pid
) {
350 if (pid_element_open
) {
351 /* Close the previous events and pid element */
352 ret
= mi_lttng_close_multi_element(writer
, 2);
356 pid_element_open
= 0;
359 cur_pid
= events
[i
].pid
;
360 cmdline
= get_cmdline_by_pid(cur_pid
);
366 if (!pid_element_open
) {
367 /* Open and write a pid element */
368 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
373 /* Open events element */
374 ret
= mi_lttng_events_open(writer
);
379 pid_element_open
= 1;
385 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
392 ret
= mi_lttng_writer_close_element(writer
);
397 /* Close domain, domains */
398 ret
= mi_lttng_close_multi_element(writer
, 2);
406 static int list_agent_events(void)
408 int i
, size
, ret
= CMD_SUCCESS
;
409 struct lttng_domain domain
;
410 struct lttng_handle
*handle
= NULL
;
411 struct lttng_event
*event_list
= NULL
;
413 char *cmdline
= NULL
;
414 const char *agent_domain_str
;
416 memset(&domain
, 0, sizeof(domain
));
418 domain
.type
= LTTNG_DOMAIN_JUL
;
419 } else if (opt_log4j
) {
420 domain
.type
= LTTNG_DOMAIN_LOG4J
;
421 } else if (opt_python
) {
422 domain
.type
= LTTNG_DOMAIN_PYTHON
;
424 ERR("Invalid agent domain selected.");
429 agent_domain_str
= get_domain_str(domain
.type
);
431 DBG("Getting %s tracing events", agent_domain_str
);
433 handle
= lttng_create_handle(NULL
, &domain
);
434 if (handle
== NULL
) {
439 size
= lttng_list_tracepoints(handle
, &event_list
);
441 ERR("Unable to list %s events: %s", agent_domain_str
,
442 lttng_strerror(size
));
449 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
456 MSG("%s events (Logger name):\n-------------------------",
463 for (i
= 0; i
< size
; i
++) {
464 if (cur_pid
!= event_list
[i
].pid
) {
465 cur_pid
= event_list
[i
].pid
;
466 cmdline
= get_cmdline_by_pid(cur_pid
);
467 if (cmdline
== NULL
) {
471 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
474 MSG("%s- %s", indent6
, event_list
[i
].name
);
483 lttng_destroy_handle(handle
);
488 * Ask session daemon for all user space tracepoints available.
490 static int list_ust_events(void)
492 int i
, size
, ret
= CMD_SUCCESS
;
493 struct lttng_domain domain
;
494 struct lttng_handle
*handle
;
495 struct lttng_event
*event_list
= NULL
;
497 char *cmdline
= NULL
;
499 memset(&domain
, 0, sizeof(domain
));
501 DBG("Getting UST tracing events");
503 domain
.type
= LTTNG_DOMAIN_UST
;
505 handle
= lttng_create_handle(NULL
, &domain
);
506 if (handle
== NULL
) {
511 size
= lttng_list_tracepoints(handle
, &event_list
);
513 ERR("Unable to list UST events: %s", lttng_strerror(size
));
520 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
523 MSG("UST events:\n-------------");
529 for (i
= 0; i
< size
; i
++) {
530 if (cur_pid
!= event_list
[i
].pid
) {
531 cur_pid
= event_list
[i
].pid
;
532 cmdline
= get_cmdline_by_pid(cur_pid
);
533 if (cmdline
== NULL
) {
537 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
540 print_events(&event_list
[i
]);
549 lttng_destroy_handle(handle
);
555 * List all ust event with their fields
557 static int mi_list_ust_event_fields(struct lttng_event_field
*fields
, int count
,
558 struct lttng_domain
*domain
)
562 char *cmdline
= NULL
;
563 int pid_element_open
= 0;
564 int event_element_open
= 0;
565 struct lttng_event cur_event
;
567 /* Open domains element */
568 ret
= mi_lttng_domains_open(writer
);
574 ret
= mi_lttng_domain(writer
, domain
, 1);
579 /* Open pids element */
580 ret
= mi_lttng_pids_open(writer
);
585 for (i
= 0; i
< count
; i
++) {
586 if (cur_pid
!= fields
[i
].event
.pid
) {
587 if (pid_element_open
) {
588 if (event_element_open
) {
590 /* Close the previous field element and event. */
591 ret
= mi_lttng_close_multi_element(writer
, 2);
595 event_element_open
= 0;
597 /* Close the previous events, pid element */
598 ret
= mi_lttng_close_multi_element(writer
, 2);
602 pid_element_open
= 0;
605 cur_pid
= fields
[i
].event
.pid
;
606 cmdline
= get_cmdline_by_pid(cur_pid
);
607 if (!pid_element_open
) {
608 /* Open and write a pid element */
609 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
614 /* Open events element */
615 ret
= mi_lttng_events_open(writer
);
619 pid_element_open
= 1;
622 /* Wipe current event since we are about to print a new PID. */
623 memset(&cur_event
, 0, sizeof(cur_event
));
626 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
627 if (event_element_open
) {
628 /* Close the previous fields element and the previous event */
629 ret
= mi_lttng_close_multi_element(writer
, 2);
633 event_element_open
= 0;
636 memcpy(&cur_event
, &fields
[i
].event
,
639 if (!event_element_open
) {
640 /* Open and write the event */
641 ret
= mi_lttng_event(writer
, &cur_event
, 1,
642 handle
->domain
.type
);
647 /* Open a fields element */
648 ret
= mi_lttng_event_fields_open(writer
);
652 event_element_open
= 1;
656 /* Print the event_field */
657 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
663 /* Close pid, domain, domains */
664 ret
= mi_lttng_close_multi_element(writer
, 3);
673 * Ask session daemon for all user space tracepoint fields available.
675 static int list_ust_event_fields(void)
677 int i
, size
, ret
= CMD_SUCCESS
;
678 struct lttng_domain domain
;
679 struct lttng_handle
*handle
;
680 struct lttng_event_field
*event_field_list
;
682 char *cmdline
= NULL
;
684 struct lttng_event cur_event
;
686 memset(&domain
, 0, sizeof(domain
));
687 memset(&cur_event
, 0, sizeof(cur_event
));
689 DBG("Getting UST tracing event fields");
691 domain
.type
= LTTNG_DOMAIN_UST
;
693 handle
= lttng_create_handle(NULL
, &domain
);
694 if (handle
== NULL
) {
699 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
701 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
708 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
715 MSG("UST events:\n-------------");
721 for (i
= 0; i
< size
; i
++) {
722 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
723 cur_pid
= event_field_list
[i
].event
.pid
;
724 cmdline
= get_cmdline_by_pid(cur_pid
);
725 if (cmdline
== NULL
) {
729 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
731 /* Wipe current event since we are about to print a new PID. */
732 memset(&cur_event
, 0, sizeof(cur_event
));
734 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
735 print_events(&event_field_list
[i
].event
);
736 memcpy(&cur_event
, &event_field_list
[i
].event
,
739 print_event_field(&event_field_list
[i
]);
746 free(event_field_list
);
748 lttng_destroy_handle(handle
);
754 * Print a list of kernel events
756 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
757 struct lttng_domain
*domain
)
761 /* Open domains element */
762 ret
= mi_lttng_domains_open(writer
);
768 ret
= mi_lttng_domain(writer
, domain
, 1);
774 ret
= mi_lttng_events_open(writer
);
779 for (i
= 0; i
< count
; i
++) {
780 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
786 /* close events, domain and domains */
787 ret
= mi_lttng_close_multi_element(writer
, 3);
797 * Ask for all trace events in the kernel
799 static int list_kernel_events(void)
801 int i
, size
, ret
= CMD_SUCCESS
;
802 struct lttng_domain domain
;
803 struct lttng_handle
*handle
;
804 struct lttng_event
*event_list
;
806 memset(&domain
, 0, sizeof(domain
));
808 DBG("Getting kernel tracing events");
810 domain
.type
= LTTNG_DOMAIN_KERNEL
;
812 handle
= lttng_create_handle(NULL
, &domain
);
813 if (handle
== NULL
) {
818 size
= lttng_list_tracepoints(handle
, &event_list
);
820 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
821 lttng_destroy_handle(handle
);
827 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
833 MSG("Kernel events:\n-------------");
835 for (i
= 0; i
< size
; i
++) {
836 print_events(&event_list
[i
]);
845 lttng_destroy_handle(handle
);
849 lttng_destroy_handle(handle
);
855 * Print a list of system calls.
857 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
862 ret
= mi_lttng_events_open(writer
);
867 for (i
= 0; i
< count
; i
++) {
868 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
875 ret
= mi_lttng_writer_close_element(writer
);
885 * Ask for kernel system calls.
887 static int list_syscalls(void)
889 int i
, size
, ret
= CMD_SUCCESS
;
890 struct lttng_event
*event_list
;
892 DBG("Getting kernel system call events");
894 size
= lttng_list_syscalls(&event_list
);
896 ERR("Unable to list system calls: %s", lttng_strerror(size
));
903 ret
= mi_list_syscalls(event_list
, size
);
909 MSG("System calls:\n-------------");
911 for (i
= 0; i
< size
; i
++) {
912 print_events(&event_list
[i
]);
928 * Print a list of agent events
930 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
934 /* Open events element */
935 ret
= mi_lttng_events_open(writer
);
940 for (i
= 0; i
< count
; i
++) {
941 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
947 /* Close events element */
948 ret
= mi_lttng_writer_close_element(writer
);
955 * List agent events for a specific session using the handle.
957 * Return CMD_SUCCESS on success else a negative value.
959 static int list_session_agent_events(void)
961 int ret
= CMD_SUCCESS
, count
, i
;
962 struct lttng_event
*events
= NULL
;
964 count
= lttng_list_events(handle
, "", &events
);
967 ERR("%s", lttng_strerror(count
));
973 ret
= mi_list_session_agent_events(events
, count
);
980 MSG("Events (Logger name):\n---------------------");
982 MSG("%sNone\n", indent6
);
986 for (i
= 0; i
< count
; i
++) {
987 if (events
[i
].loglevel_type
!=
988 LTTNG_EVENT_LOGLEVEL_ALL
) {
989 MSG("%s- %s%s (loglevel%s %s)", indent4
,
994 events
[i
].loglevel_type
),
995 mi_lttng_loglevel_string(
997 handle
->domain
.type
));
999 MSG("%s- %s%s", indent4
, events
[i
].name
,
1000 enabled_string(events
[i
].enabled
));
1015 * print a list of event
1017 static int mi_list_events(struct lttng_event
*events
, int count
)
1021 /* Open events element */
1022 ret
= mi_lttng_events_open(writer
);
1027 for (i
= 0; i
< count
; i
++) {
1028 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1034 /* Close events element */
1035 ret
= mi_lttng_writer_close_element(writer
);
1042 * List events of channel of session and domain.
1044 static int list_events(const char *channel_name
)
1046 int ret
= CMD_SUCCESS
, count
, i
;
1047 struct lttng_event
*events
= NULL
;
1049 count
= lttng_list_events(handle
, channel_name
, &events
);
1052 ERR("%s", lttng_strerror(count
));
1058 ret
= mi_list_events(events
, count
);
1065 MSG("\n%sEvents:", indent4
);
1067 MSG("%sNone\n", indent6
);
1071 for (i
= 0; i
< count
; i
++) {
1072 print_events(&events
[i
]);
1084 * Pretty print channel
1086 static void print_channel(struct lttng_channel
*channel
)
1088 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1090 MSG("%sAttributes:", indent4
);
1091 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1092 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1093 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1094 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1095 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1096 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1097 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1098 switch (channel
->attr
.output
) {
1099 case LTTNG_EVENT_SPLICE
:
1100 MSG("%soutput: splice()", indent6
);
1102 case LTTNG_EVENT_MMAP
:
1103 MSG("%soutput: mmap()", indent6
);
1110 * Print a list of channel
1113 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1114 const char *channel_name
)
1117 unsigned int chan_found
= 0;
1119 /* Open channels element */
1120 ret
= mi_lttng_channels_open(writer
);
1125 for (i
= 0; i
< count
; i
++) {
1126 if (channel_name
!= NULL
) {
1127 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1134 /* Write channel element and leave it open */
1135 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1140 /* Listing events per channel */
1141 ret
= list_events(channels
[i
].name
);
1146 /* Closing the channel element we opened earlier */
1147 ret
= mi_lttng_writer_close_element(writer
);
1157 /* Close channels element */
1158 ret
= mi_lttng_writer_close_element(writer
);
1168 * List channel(s) of session and domain.
1170 * If channel_name is NULL, all channels are listed.
1172 static int list_channels(const char *channel_name
)
1174 int count
, i
, ret
= CMD_SUCCESS
;
1175 unsigned int chan_found
= 0;
1176 struct lttng_channel
*channels
= NULL
;
1178 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1180 count
= lttng_list_channels(handle
, &channels
);
1183 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1185 /* When printing mi this is not an error
1186 * but an empty channels element */
1190 WARN("No kernel channel");
1191 goto error_channels
;
1195 /* We had a real error */
1197 ERR("%s", lttng_strerror(count
));
1198 goto error_channels
;
1205 ret
= mi_list_channels(channels
, count
, channel_name
);
1213 MSG("Channels:\n-------------");
1216 for (i
= 0; i
< count
; i
++) {
1217 if (channel_name
!= NULL
) {
1218 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1224 print_channel(&channels
[i
]);
1226 /* Listing events per channel */
1227 ret
= list_events(channels
[i
].name
);
1237 if (!chan_found
&& channel_name
!= NULL
) {
1239 ERR("Channel %s not found", channel_name
);
1251 * List tracker PID(s) of session and domain.
1253 static int list_tracker_pids(void)
1260 ret
= lttng_list_tracker_pids(handle
,
1261 &enabled
, &pids
, &nr_pids
);
1267 _MSG("PID tracker: [");
1269 /* Mi tracker_pid element*/
1271 /* Open tracker_pid and targets elements */
1272 ret
= mi_lttng_pid_tracker_open(writer
);
1278 for (i
= 0; i
< nr_pids
; i
++) {
1282 _MSG(" %d", pids
[i
]);
1286 ret
= mi_lttng_pid_target(writer
, pids
[i
], 0);
1294 /* Mi close tracker_pid and targets */
1296 ret
= mi_lttng_close_multi_element(writer
,2);
1309 * List all tracker of a domain
1311 static int list_trackers(void)
1315 /* Trackers listing */
1317 ret
= mi_lttng_trackers_open(writer
);
1324 ret
= list_tracker_pids();
1330 /* Close trackers element */
1331 ret
= mi_lttng_writer_close_element(writer
);
1343 * Find the session with session_name as name
1344 * and print his informations.
1346 static int mi_list_session(const char *session_name
,
1347 struct lttng_session
*sessions
, int count
)
1350 unsigned int session_found
= 0;
1352 if (session_name
== NULL
) {
1353 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1357 for (i
= 0; i
< count
; i
++) {
1358 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1359 /* We need to leave it open to append other informations
1360 * like domain, channel, events etc.*/
1362 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1370 if (!session_found
) {
1371 ERR("Session '%s' not found", session_name
);
1372 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1382 * List all availables session
1384 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1388 /* Opening sessions element */
1389 ret
= mi_lttng_sessions_open(writer
);
1394 /* Listing sessions */
1395 for (i
= 0; i
< count
; i
++) {
1396 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1402 /* Closing sessions element */
1403 ret
= mi_lttng_writer_close_element(writer
);
1413 * List available tracing session. List only basic information.
1415 * If session_name is NULL, all sessions are listed.
1417 static int list_sessions(const char *session_name
)
1419 int ret
= CMD_SUCCESS
;
1421 unsigned int session_found
= 0;
1422 struct lttng_session
*sessions
;
1424 count
= lttng_list_sessions(&sessions
);
1425 DBG("Session count %d", count
);
1428 ERR("%s", lttng_strerror(count
));
1434 if (session_name
== NULL
) {
1435 /* List all session */
1436 ret
= mi_list_sessions(sessions
, count
);
1438 /* Note : this return an open session element */
1439 ret
= mi_list_session(session_name
, sessions
, count
);
1448 MSG("Currently no available tracing session");
1452 if (session_name
== NULL
) {
1453 MSG("Available tracing sessions:");
1457 for (i
= 0; i
< count
; i
++) {
1458 if (session_name
!= NULL
) {
1459 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1461 MSG("Tracing session %s: [%s%s]", session_name
,
1462 active_string(sessions
[i
].enabled
),
1463 snapshot_string(sessions
[i
].snapshot_mode
));
1464 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1468 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1469 sessions
[i
].name
, sessions
[i
].path
,
1470 active_string(sessions
[i
].enabled
),
1471 snapshot_string(sessions
[i
].snapshot_mode
));
1472 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1473 if (sessions
[i
].live_timer_interval
!= 0) {
1474 MSG("%sLive timer interval (usec): %u", indent4
,
1475 sessions
[i
].live_timer_interval
);
1481 if (!session_found
&& session_name
!= NULL
) {
1482 ERR("Session '%s' not found", session_name
);
1487 if (session_name
== NULL
) {
1488 MSG("\nUse lttng list <session_name> for more details");
1501 * list available domain(s) for a session.
1503 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1506 /* Open domains element */
1507 ret
= mi_lttng_domains_open(writer
);
1512 for (i
= 0; i
< count
; i
++) {
1513 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1519 /* Closing domains element */
1520 ret
= mi_lttng_writer_close_element(writer
);
1529 * List available domain(s) for a session.
1531 static int list_domains(const char *session_name
)
1533 int i
, count
, ret
= CMD_SUCCESS
;
1534 struct lttng_domain
*domains
= NULL
;
1537 count
= lttng_list_domains(session_name
, &domains
);
1540 ERR("%s", lttng_strerror(count
));
1546 ret
= mi_list_domains(domains
, count
);
1553 MSG("Domains:\n-------------");
1559 for (i
= 0; i
< count
; i
++) {
1560 switch (domains
[i
].type
) {
1561 case LTTNG_DOMAIN_KERNEL
:
1564 case LTTNG_DOMAIN_UST
:
1565 MSG(" - UST global");
1567 case LTTNG_DOMAIN_JUL
:
1568 MSG(" - JUL (Java Util Logging)");
1570 case LTTNG_DOMAIN_LOG4J
:
1571 MSG(" - LOG4j (Logging for Java)");
1573 case LTTNG_DOMAIN_PYTHON
:
1574 MSG(" - Python (logging)");
1590 * The 'list <options>' first level command
1592 int cmd_list(int argc
, const char **argv
)
1594 int opt
, ret
= CMD_SUCCESS
;
1595 const char *session_name
;
1596 static poptContext pc
;
1597 struct lttng_domain domain
;
1598 struct lttng_domain
*domains
= NULL
;
1600 memset(&domain
, 0, sizeof(domain
));
1608 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1609 poptReadDefaultConfig(pc
, 0);
1611 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1619 case OPT_LIST_OPTIONS
:
1620 list_cmd_options(stdout
, long_options
);
1624 ret
= CMD_UNDEFINED
;
1631 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1637 /* Open command element */
1638 ret
= mi_lttng_writer_command_open(writer
,
1639 mi_lttng_element_command_list
);
1645 /* Open output element */
1646 ret
= mi_lttng_writer_open_element(writer
,
1647 mi_lttng_element_command_output
);
1654 /* Get session name (trailing argument) */
1655 session_name
= poptGetArg(pc
);
1656 DBG2("Session name: %s", session_name
);
1659 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1660 } else if (opt_userspace
) {
1661 DBG2("Listing userspace global domain");
1662 domain
.type
= LTTNG_DOMAIN_UST
;
1663 } else if (opt_jul
) {
1664 DBG2("Listing JUL domain");
1665 domain
.type
= LTTNG_DOMAIN_JUL
;
1666 } else if (opt_log4j
) {
1667 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1668 } else if (opt_python
) {
1669 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1672 if (!opt_kernel
&& opt_syscall
) {
1673 WARN("--syscall will only work with the Kernel domain (-k)");
1678 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1679 handle
= lttng_create_handle(session_name
, &domain
);
1680 if (handle
== NULL
) {
1686 if (session_name
== NULL
) {
1687 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1689 ret
= list_sessions(NULL
);
1696 ret
= list_syscalls();
1701 ret
= list_kernel_events();
1707 if (opt_userspace
) {
1709 ret
= list_ust_event_fields();
1711 ret
= list_ust_events();
1717 if (opt_jul
|| opt_log4j
|| opt_python
) {
1718 ret
= list_agent_events();
1724 /* List session attributes */
1726 /* Open element sessions
1727 * Present for xml consistency */
1728 ret
= mi_lttng_sessions_open(writer
);
1733 /* MI: the ouptut of list_sessions is an unclosed session element */
1734 ret
= list_sessions(session_name
);
1739 /* Domain listing */
1741 ret
= list_domains(session_name
);
1745 /* Channel listing */
1746 if (opt_kernel
|| opt_userspace
) {
1748 /* Add of domains and domain element for xml
1749 * consistency and validation
1751 ret
= mi_lttng_domains_open(writer
);
1756 /* Open domain and leave it open for
1757 * nested channels printing */
1758 ret
= mi_lttng_domain(writer
, &domain
, 1);
1767 ret
= list_trackers();
1773 ret
= list_channels(opt_channel
);
1779 /* Close domain and domain element */
1780 ret
= mi_lttng_close_multi_element(writer
, 2);
1790 /* We want all domain(s) */
1791 nb_domain
= lttng_list_domains(session_name
, &domains
);
1792 if (nb_domain
< 0) {
1794 ERR("%s", lttng_strerror(nb_domain
));
1799 ret
= mi_lttng_domains_open(writer
);
1806 for (i
= 0; i
< nb_domain
; i
++) {
1807 switch (domains
[i
].type
) {
1808 case LTTNG_DOMAIN_KERNEL
:
1809 MSG("=== Domain: Kernel ===\n");
1811 case LTTNG_DOMAIN_UST
:
1812 MSG("=== Domain: UST global ===\n");
1813 MSG("Buffer type: %s\n",
1814 domains
[i
].buf_type
==
1815 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1817 case LTTNG_DOMAIN_JUL
:
1818 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1820 case LTTNG_DOMAIN_LOG4J
:
1821 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1823 case LTTNG_DOMAIN_PYTHON
:
1824 MSG("=== Domain: Python (logging) ===\n");
1827 MSG("=== Domain: Unimplemented ===\n");
1832 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1839 /* Clean handle before creating a new one */
1841 lttng_destroy_handle(handle
);
1844 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1845 if (handle
== NULL
) {
1850 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1851 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1852 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1853 ret
= list_session_agent_events();
1861 switch (domains
[i
].type
) {
1862 case LTTNG_DOMAIN_KERNEL
:
1863 case LTTNG_DOMAIN_UST
:
1864 ret
= list_trackers();
1873 ret
= list_channels(opt_channel
);
1880 /* Close domain element */
1881 ret
= mi_lttng_writer_close_element(writer
);
1890 /* Close the domains, session and sessions element */
1891 ret
= mi_lttng_close_multi_element(writer
, 3);
1902 /* Close output element */
1903 ret
= mi_lttng_writer_close_element(writer
);
1909 /* Command element close */
1910 ret
= mi_lttng_writer_command_close(writer
);
1918 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1919 /* Preserve original error code */
1920 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
1925 lttng_destroy_handle(handle
);
1928 poptFreeContext(pc
);