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_message(const char *filter_msg
)
171 return filter_msg
? filter_msg
: "";
175 const char *exclusion_string(int value
)
178 case 1: return " [has exclusions]";
183 static const char *logleveltype_string(enum lttng_loglevel_type value
)
186 case LTTNG_EVENT_LOGLEVEL_ALL
:
188 case LTTNG_EVENT_LOGLEVEL_RANGE
:
190 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
193 return " <<TYPE UNKN>>";
197 static const char *bitness_event(enum lttng_event_flag flags
)
199 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_32
) {
200 if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
201 return " [32/64-bit]";
205 } else if (flags
& LTTNG_EVENT_FLAG_SYSCALL_64
) {
213 * Pretty print single event.
215 static void print_events(struct lttng_event
*event
)
218 const char *filter_str
;
219 char *filter_msg
= NULL
;
221 ret
= lttng_event_get_filter_string(event
, &filter_str
);
224 filter_msg
= strdup(" [failed to retrieve filter]");
225 } else if (filter_str
) {
226 const char * const filter_fmt
= " [filter: '%s']";
228 filter_msg
= malloc(strlen(filter_str
) +
229 strlen(filter_fmt
) + 1);
231 sprintf(filter_msg
, filter_fmt
,
236 switch (event
->type
) {
237 case LTTNG_EVENT_TRACEPOINT
:
239 if (event
->loglevel
!= -1) {
240 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
243 logleveltype_string(event
->loglevel_type
),
244 mi_lttng_loglevel_string(event
->loglevel
, handle
->domain
.type
),
246 enabled_string(event
->enabled
),
247 exclusion_string(event
->exclusion
),
248 filter_message(filter_msg
));
250 MSG("%s%s (type: tracepoint)%s%s%s",
253 enabled_string(event
->enabled
),
254 exclusion_string(event
->exclusion
),
255 filter_message(filter_msg
));
259 case LTTNG_EVENT_FUNCTION
:
260 MSG("%s%s (type: function)%s%s", indent6
,
261 event
->name
, enabled_string(event
->enabled
),
262 filter_message(filter_msg
));
263 if (event
->attr
.probe
.addr
!= 0) {
264 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
266 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
267 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
270 case LTTNG_EVENT_PROBE
:
271 MSG("%s%s (type: probe)%s%s", indent6
,
272 event
->name
, enabled_string(event
->enabled
),
273 filter_message(filter_msg
));
274 if (event
->attr
.probe
.addr
!= 0) {
275 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
277 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
278 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
281 case LTTNG_EVENT_FUNCTION_ENTRY
:
282 MSG("%s%s (type: function)%s%s", indent6
,
283 event
->name
, enabled_string(event
->enabled
),
284 filter_message(filter_msg
));
285 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
287 case LTTNG_EVENT_SYSCALL
:
288 MSG("%s%s%s%s%s", indent6
, event
->name
,
289 (opt_syscall
? "" : " (type:syscall)"),
290 enabled_string(event
->enabled
),
291 bitness_event(event
->flags
));
293 case LTTNG_EVENT_NOOP
:
294 MSG("%s (type: noop)%s%s", indent6
,
295 enabled_string(event
->enabled
),
296 filter_message(filter_msg
));
298 case LTTNG_EVENT_ALL
:
299 /* We should never have "all" events in list. */
307 static const char *field_type(struct lttng_event_field
*field
)
309 switch(field
->type
) {
310 case LTTNG_EVENT_FIELD_INTEGER
:
312 case LTTNG_EVENT_FIELD_ENUM
:
314 case LTTNG_EVENT_FIELD_FLOAT
:
316 case LTTNG_EVENT_FIELD_STRING
:
318 case LTTNG_EVENT_FIELD_OTHER
:
319 default: /* fall-through */
325 * Pretty print single event fields.
327 static void print_event_field(struct lttng_event_field
*field
)
329 if (!field
->field_name
[0]) {
332 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
333 field_type(field
), field
->nowrite
? " [no write]" : "");
338 * Jul and ust event listing
340 static int mi_list_agent_ust_events(struct lttng_event
*events
, int count
,
341 struct lttng_domain
*domain
)
345 char *cmdline
= NULL
;
346 int pid_element_open
= 0;
348 /* Open domains element */
349 ret
= mi_lttng_domains_open(writer
);
355 ret
= mi_lttng_domain(writer
, domain
, 1);
360 /* Open pids element element */
361 ret
= mi_lttng_pids_open(writer
);
366 for (i
= 0; i
< count
; i
++) {
367 if (cur_pid
!= events
[i
].pid
) {
368 if (pid_element_open
) {
369 /* Close the previous events and pid element */
370 ret
= mi_lttng_close_multi_element(writer
, 2);
374 pid_element_open
= 0;
377 cur_pid
= events
[i
].pid
;
378 cmdline
= get_cmdline_by_pid(cur_pid
);
384 if (!pid_element_open
) {
385 /* Open and write a pid element */
386 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
391 /* Open events element */
392 ret
= mi_lttng_events_open(writer
);
397 pid_element_open
= 1;
403 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
410 ret
= mi_lttng_writer_close_element(writer
);
415 /* Close domain, domains */
416 ret
= mi_lttng_close_multi_element(writer
, 2);
424 static int list_agent_events(void)
426 int i
, size
, ret
= CMD_SUCCESS
;
427 struct lttng_domain domain
;
428 struct lttng_handle
*handle
= NULL
;
429 struct lttng_event
*event_list
= NULL
;
431 char *cmdline
= NULL
;
432 const char *agent_domain_str
;
434 memset(&domain
, 0, sizeof(domain
));
436 domain
.type
= LTTNG_DOMAIN_JUL
;
437 } else if (opt_log4j
) {
438 domain
.type
= LTTNG_DOMAIN_LOG4J
;
439 } else if (opt_python
) {
440 domain
.type
= LTTNG_DOMAIN_PYTHON
;
442 ERR("Invalid agent domain selected.");
447 agent_domain_str
= get_domain_str(domain
.type
);
449 DBG("Getting %s tracing events", agent_domain_str
);
451 handle
= lttng_create_handle(NULL
, &domain
);
452 if (handle
== NULL
) {
457 size
= lttng_list_tracepoints(handle
, &event_list
);
459 ERR("Unable to list %s events: %s", agent_domain_str
,
460 lttng_strerror(size
));
467 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
474 MSG("%s events (Logger name):\n-------------------------",
481 for (i
= 0; i
< size
; i
++) {
482 if (cur_pid
!= event_list
[i
].pid
) {
483 cur_pid
= event_list
[i
].pid
;
484 cmdline
= get_cmdline_by_pid(cur_pid
);
485 if (cmdline
== NULL
) {
489 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
492 MSG("%s- %s", indent6
, event_list
[i
].name
);
501 lttng_destroy_handle(handle
);
506 * Ask session daemon for all user space tracepoints available.
508 static int list_ust_events(void)
510 int i
, size
, ret
= CMD_SUCCESS
;
511 struct lttng_domain domain
;
512 struct lttng_handle
*handle
;
513 struct lttng_event
*event_list
= NULL
;
515 char *cmdline
= NULL
;
517 memset(&domain
, 0, sizeof(domain
));
519 DBG("Getting UST tracing events");
521 domain
.type
= LTTNG_DOMAIN_UST
;
523 handle
= lttng_create_handle(NULL
, &domain
);
524 if (handle
== NULL
) {
529 size
= lttng_list_tracepoints(handle
, &event_list
);
531 ERR("Unable to list UST events: %s", lttng_strerror(size
));
538 ret
= mi_list_agent_ust_events(event_list
, size
, &domain
);
541 MSG("UST events:\n-------------");
547 for (i
= 0; i
< size
; i
++) {
548 if (cur_pid
!= event_list
[i
].pid
) {
549 cur_pid
= event_list
[i
].pid
;
550 cmdline
= get_cmdline_by_pid(cur_pid
);
551 if (cmdline
== NULL
) {
555 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
558 print_events(&event_list
[i
]);
567 lttng_destroy_handle(handle
);
573 * List all ust event with their fields
575 static int mi_list_ust_event_fields(struct lttng_event_field
*fields
, int count
,
576 struct lttng_domain
*domain
)
580 char *cmdline
= NULL
;
581 int pid_element_open
= 0;
582 int event_element_open
= 0;
583 struct lttng_event cur_event
;
585 /* Open domains element */
586 ret
= mi_lttng_domains_open(writer
);
592 ret
= mi_lttng_domain(writer
, domain
, 1);
597 /* Open pids element */
598 ret
= mi_lttng_pids_open(writer
);
603 for (i
= 0; i
< count
; i
++) {
604 if (cur_pid
!= fields
[i
].event
.pid
) {
605 if (pid_element_open
) {
606 if (event_element_open
) {
608 /* Close the previous field element and event. */
609 ret
= mi_lttng_close_multi_element(writer
, 2);
613 event_element_open
= 0;
615 /* Close the previous events, pid element */
616 ret
= mi_lttng_close_multi_element(writer
, 2);
620 pid_element_open
= 0;
623 cur_pid
= fields
[i
].event
.pid
;
624 cmdline
= get_cmdline_by_pid(cur_pid
);
625 if (!pid_element_open
) {
626 /* Open and write a pid element */
627 ret
= mi_lttng_pid(writer
, cur_pid
, cmdline
, 1);
632 /* Open events element */
633 ret
= mi_lttng_events_open(writer
);
637 pid_element_open
= 1;
640 /* Wipe current event since we are about to print a new PID. */
641 memset(&cur_event
, 0, sizeof(cur_event
));
644 if (strcmp(cur_event
.name
, fields
[i
].event
.name
) != 0) {
645 if (event_element_open
) {
646 /* Close the previous fields element and the previous event */
647 ret
= mi_lttng_close_multi_element(writer
, 2);
651 event_element_open
= 0;
654 memcpy(&cur_event
, &fields
[i
].event
,
657 if (!event_element_open
) {
658 /* Open and write the event */
659 ret
= mi_lttng_event(writer
, &cur_event
, 1,
660 handle
->domain
.type
);
665 /* Open a fields element */
666 ret
= mi_lttng_event_fields_open(writer
);
670 event_element_open
= 1;
674 /* Print the event_field */
675 ret
= mi_lttng_event_field(writer
, &fields
[i
]);
681 /* Close pid, domain, domains */
682 ret
= mi_lttng_close_multi_element(writer
, 3);
691 * Ask session daemon for all user space tracepoint fields available.
693 static int list_ust_event_fields(void)
695 int i
, size
, ret
= CMD_SUCCESS
;
696 struct lttng_domain domain
;
697 struct lttng_handle
*handle
;
698 struct lttng_event_field
*event_field_list
;
700 char *cmdline
= NULL
;
702 struct lttng_event cur_event
;
704 memset(&domain
, 0, sizeof(domain
));
705 memset(&cur_event
, 0, sizeof(cur_event
));
707 DBG("Getting UST tracing event fields");
709 domain
.type
= LTTNG_DOMAIN_UST
;
711 handle
= lttng_create_handle(NULL
, &domain
);
712 if (handle
== NULL
) {
717 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
719 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
726 ret
= mi_list_ust_event_fields(event_field_list
, size
, &domain
);
733 MSG("UST events:\n-------------");
739 for (i
= 0; i
< size
; i
++) {
740 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
741 cur_pid
= event_field_list
[i
].event
.pid
;
742 cmdline
= get_cmdline_by_pid(cur_pid
);
743 if (cmdline
== NULL
) {
747 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
749 /* Wipe current event since we are about to print a new PID. */
750 memset(&cur_event
, 0, sizeof(cur_event
));
752 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
753 print_events(&event_field_list
[i
].event
);
754 memcpy(&cur_event
, &event_field_list
[i
].event
,
757 print_event_field(&event_field_list
[i
]);
764 free(event_field_list
);
766 lttng_destroy_handle(handle
);
772 * Print a list of kernel events
774 static int mi_list_kernel_events(struct lttng_event
*events
, int count
,
775 struct lttng_domain
*domain
)
779 /* Open domains element */
780 ret
= mi_lttng_domains_open(writer
);
786 ret
= mi_lttng_domain(writer
, domain
, 1);
792 ret
= mi_lttng_events_open(writer
);
797 for (i
= 0; i
< count
; i
++) {
798 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
804 /* close events, domain and domains */
805 ret
= mi_lttng_close_multi_element(writer
, 3);
815 * Ask for all trace events in the kernel
817 static int list_kernel_events(void)
819 int i
, size
, ret
= CMD_SUCCESS
;
820 struct lttng_domain domain
;
821 struct lttng_handle
*handle
;
822 struct lttng_event
*event_list
;
824 memset(&domain
, 0, sizeof(domain
));
826 DBG("Getting kernel tracing events");
828 domain
.type
= LTTNG_DOMAIN_KERNEL
;
830 handle
= lttng_create_handle(NULL
, &domain
);
831 if (handle
== NULL
) {
836 size
= lttng_list_tracepoints(handle
, &event_list
);
838 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
839 lttng_destroy_handle(handle
);
845 ret
= mi_list_kernel_events(event_list
, size
, &domain
);
851 MSG("Kernel events:\n-------------");
853 for (i
= 0; i
< size
; i
++) {
854 print_events(&event_list
[i
]);
863 lttng_destroy_handle(handle
);
867 lttng_destroy_handle(handle
);
873 * Print a list of system calls.
875 static int mi_list_syscalls(struct lttng_event
*events
, int count
)
880 ret
= mi_lttng_events_open(writer
);
885 for (i
= 0; i
< count
; i
++) {
886 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
893 ret
= mi_lttng_writer_close_element(writer
);
903 * Ask for kernel system calls.
905 static int list_syscalls(void)
907 int i
, size
, ret
= CMD_SUCCESS
;
908 struct lttng_event
*event_list
;
910 DBG("Getting kernel system call events");
912 size
= lttng_list_syscalls(&event_list
);
914 ERR("Unable to list system calls: %s", lttng_strerror(size
));
921 ret
= mi_list_syscalls(event_list
, size
);
927 MSG("System calls:\n-------------");
929 for (i
= 0; i
< size
; i
++) {
930 print_events(&event_list
[i
]);
946 * Print a list of agent events
948 static int mi_list_session_agent_events(struct lttng_event
*events
, int count
)
952 /* Open events element */
953 ret
= mi_lttng_events_open(writer
);
958 for (i
= 0; i
< count
; i
++) {
959 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
965 /* Close events element */
966 ret
= mi_lttng_writer_close_element(writer
);
973 * List agent events for a specific session using the handle.
975 * Return CMD_SUCCESS on success else a negative value.
977 static int list_session_agent_events(void)
979 int ret
= CMD_SUCCESS
, count
, i
;
980 struct lttng_event
*events
= NULL
;
982 count
= lttng_list_events(handle
, "", &events
);
985 ERR("%s", lttng_strerror(count
));
991 ret
= mi_list_session_agent_events(events
, count
);
998 MSG("Events (Logger name):\n---------------------");
1000 MSG("%sNone\n", indent6
);
1004 for (i
= 0; i
< count
; i
++) {
1005 const char *filter_str
;
1006 char *filter_msg
= NULL
;
1007 struct lttng_event
*event
= &events
[i
];
1009 ret
= lttng_event_get_filter_string(event
, &filter_str
);
1011 filter_msg
= strdup(" [failed to retrieve filter]");
1012 } else if (filter_str
) {
1013 const char * const filter_fmt
=
1016 filter_msg
= malloc(strlen(filter_str
) +
1017 strlen(filter_fmt
) + 1);
1019 sprintf(filter_msg
, " [filter: '%s']",
1024 if (event
->loglevel_type
!=
1025 LTTNG_EVENT_LOGLEVEL_ALL
) {
1026 MSG("%s- %s%s (loglevel%s %s)%s", indent4
,
1028 enabled_string(event
->enabled
),
1029 logleveltype_string(
1030 event
->loglevel_type
),
1031 mi_lttng_loglevel_string(
1033 handle
->domain
.type
),
1034 filter_message(filter_msg
));
1036 MSG("%s- %s%s%s", indent4
, event
->name
,
1037 enabled_string(event
->enabled
),
1038 filter_message(filter_msg
));
1054 * print a list of event
1056 static int mi_list_events(struct lttng_event
*events
, int count
)
1060 /* Open events element */
1061 ret
= mi_lttng_events_open(writer
);
1066 for (i
= 0; i
< count
; i
++) {
1067 ret
= mi_lttng_event(writer
, &events
[i
], 0, handle
->domain
.type
);
1073 /* Close events element */
1074 ret
= mi_lttng_writer_close_element(writer
);
1081 * List events of channel of session and domain.
1083 static int list_events(const char *channel_name
)
1085 int ret
= CMD_SUCCESS
, count
, i
;
1086 struct lttng_event
*events
= NULL
;
1088 count
= lttng_list_events(handle
, channel_name
, &events
);
1091 ERR("%s", lttng_strerror(count
));
1097 ret
= mi_list_events(events
, count
);
1104 MSG("\n%sEvents:", indent4
);
1106 MSG("%sNone\n", indent6
);
1110 for (i
= 0; i
< count
; i
++) {
1111 print_events(&events
[i
]);
1123 * Pretty print channel
1125 static void print_channel(struct lttng_channel
*channel
)
1127 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
1129 MSG("%sAttributes:", indent4
);
1130 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
1131 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
1132 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
1133 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
1134 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
1135 MSG("%strace file count: %" PRIu64
, indent6
, channel
->attr
.tracefile_count
);
1136 MSG("%strace file size (bytes): %" PRIu64
, indent6
, channel
->attr
.tracefile_size
);
1137 switch (channel
->attr
.output
) {
1138 case LTTNG_EVENT_SPLICE
:
1139 MSG("%soutput: splice()", indent6
);
1141 case LTTNG_EVENT_MMAP
:
1142 MSG("%soutput: mmap()", indent6
);
1149 * Print a list of channel
1152 static int mi_list_channels(struct lttng_channel
*channels
, int count
,
1153 const char *channel_name
)
1156 unsigned int chan_found
= 0;
1158 /* Open channels element */
1159 ret
= mi_lttng_channels_open(writer
);
1164 for (i
= 0; i
< count
; i
++) {
1165 if (channel_name
!= NULL
) {
1166 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1173 /* Write channel element and leave it open */
1174 ret
= mi_lttng_channel(writer
, &channels
[i
], 1);
1179 /* Listing events per channel */
1180 ret
= list_events(channels
[i
].name
);
1185 /* Closing the channel element we opened earlier */
1186 ret
= mi_lttng_writer_close_element(writer
);
1196 /* Close channels element */
1197 ret
= mi_lttng_writer_close_element(writer
);
1207 * List channel(s) of session and domain.
1209 * If channel_name is NULL, all channels are listed.
1211 static int list_channels(const char *channel_name
)
1213 int count
, i
, ret
= CMD_SUCCESS
;
1214 unsigned int chan_found
= 0;
1215 struct lttng_channel
*channels
= NULL
;
1217 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
1219 count
= lttng_list_channels(handle
, &channels
);
1222 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
1224 /* When printing mi this is not an error
1225 * but an empty channels element */
1229 WARN("No kernel channel");
1230 goto error_channels
;
1234 /* We had a real error */
1236 ERR("%s", lttng_strerror(count
));
1237 goto error_channels
;
1244 ret
= mi_list_channels(channels
, count
, channel_name
);
1252 MSG("Channels:\n-------------");
1255 for (i
= 0; i
< count
; i
++) {
1256 if (channel_name
!= NULL
) {
1257 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
1263 print_channel(&channels
[i
]);
1265 /* Listing events per channel */
1266 ret
= list_events(channels
[i
].name
);
1276 if (!chan_found
&& channel_name
!= NULL
) {
1278 ERR("Channel %s not found", channel_name
);
1290 * List tracker PID(s) of session and domain.
1292 static int list_tracker_pids(void)
1299 ret
= lttng_list_tracker_pids(handle
,
1300 &enabled
, &pids
, &nr_pids
);
1306 _MSG("PID tracker: [");
1308 /* Mi tracker_pid element*/
1310 /* Open tracker_pid and targets elements */
1311 ret
= mi_lttng_pid_tracker_open(writer
);
1317 for (i
= 0; i
< nr_pids
; i
++) {
1321 _MSG(" %d", pids
[i
]);
1325 ret
= mi_lttng_pid_target(writer
, pids
[i
], 0);
1333 /* Mi close tracker_pid and targets */
1335 ret
= mi_lttng_close_multi_element(writer
,2);
1348 * List all tracker of a domain
1350 static int list_trackers(void)
1354 /* Trackers listing */
1356 ret
= mi_lttng_trackers_open(writer
);
1363 ret
= list_tracker_pids();
1369 /* Close trackers element */
1370 ret
= mi_lttng_writer_close_element(writer
);
1382 * Find the session with session_name as name
1383 * and print his informations.
1385 static int mi_list_session(const char *session_name
,
1386 struct lttng_session
*sessions
, int count
)
1389 unsigned int session_found
= 0;
1391 if (session_name
== NULL
) {
1392 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1396 for (i
= 0; i
< count
; i
++) {
1397 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1398 /* We need to leave it open to append other informations
1399 * like domain, channel, events etc.*/
1401 ret
= mi_lttng_session(writer
, &sessions
[i
], 1);
1409 if (!session_found
) {
1410 ERR("Session '%s' not found", session_name
);
1411 ret
= -LTTNG_ERR_SESS_NOT_FOUND
;
1421 * List all availables session
1423 static int mi_list_sessions(struct lttng_session
*sessions
, int count
)
1427 /* Opening sessions element */
1428 ret
= mi_lttng_sessions_open(writer
);
1433 /* Listing sessions */
1434 for (i
= 0; i
< count
; i
++) {
1435 ret
= mi_lttng_session(writer
, &sessions
[i
], 0);
1441 /* Closing sessions element */
1442 ret
= mi_lttng_writer_close_element(writer
);
1452 * List available tracing session. List only basic information.
1454 * If session_name is NULL, all sessions are listed.
1456 static int list_sessions(const char *session_name
)
1458 int ret
= CMD_SUCCESS
;
1460 unsigned int session_found
= 0;
1461 struct lttng_session
*sessions
;
1463 count
= lttng_list_sessions(&sessions
);
1464 DBG("Session count %d", count
);
1467 ERR("%s", lttng_strerror(count
));
1473 if (session_name
== NULL
) {
1474 /* List all session */
1475 ret
= mi_list_sessions(sessions
, count
);
1477 /* Note : this return an open session element */
1478 ret
= mi_list_session(session_name
, sessions
, count
);
1487 MSG("Currently no available tracing session");
1491 if (session_name
== NULL
) {
1492 MSG("Available tracing sessions:");
1496 for (i
= 0; i
< count
; i
++) {
1497 if (session_name
!= NULL
) {
1498 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
1500 MSG("Tracing session %s: [%s%s]", session_name
,
1501 active_string(sessions
[i
].enabled
),
1502 snapshot_string(sessions
[i
].snapshot_mode
));
1503 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
1507 MSG(" %d) %s (%s) [%s%s]", i
+ 1,
1508 sessions
[i
].name
, sessions
[i
].path
,
1509 active_string(sessions
[i
].enabled
),
1510 snapshot_string(sessions
[i
].snapshot_mode
));
1511 MSG("%sTrace path: %s", indent4
, sessions
[i
].path
);
1512 if (sessions
[i
].live_timer_interval
!= 0) {
1513 MSG("%sLive timer interval (usec): %u", indent4
,
1514 sessions
[i
].live_timer_interval
);
1520 if (!session_found
&& session_name
!= NULL
) {
1521 ERR("Session '%s' not found", session_name
);
1526 if (session_name
== NULL
) {
1527 MSG("\nUse lttng list <session_name> for more details");
1540 * list available domain(s) for a session.
1542 static int mi_list_domains(struct lttng_domain
*domains
, int count
)
1545 /* Open domains element */
1546 ret
= mi_lttng_domains_open(writer
);
1551 for (i
= 0; i
< count
; i
++) {
1552 ret
= mi_lttng_domain(writer
, &domains
[i
] , 0);
1558 /* Closing domains element */
1559 ret
= mi_lttng_writer_close_element(writer
);
1568 * List available domain(s) for a session.
1570 static int list_domains(const char *session_name
)
1572 int i
, count
, ret
= CMD_SUCCESS
;
1573 struct lttng_domain
*domains
= NULL
;
1576 count
= lttng_list_domains(session_name
, &domains
);
1579 ERR("%s", lttng_strerror(count
));
1585 ret
= mi_list_domains(domains
, count
);
1592 MSG("Domains:\n-------------");
1598 for (i
= 0; i
< count
; i
++) {
1599 switch (domains
[i
].type
) {
1600 case LTTNG_DOMAIN_KERNEL
:
1603 case LTTNG_DOMAIN_UST
:
1604 MSG(" - UST global");
1606 case LTTNG_DOMAIN_JUL
:
1607 MSG(" - JUL (Java Util Logging)");
1609 case LTTNG_DOMAIN_LOG4J
:
1610 MSG(" - LOG4j (Logging for Java)");
1612 case LTTNG_DOMAIN_PYTHON
:
1613 MSG(" - Python (logging)");
1629 * The 'list <options>' first level command
1631 int cmd_list(int argc
, const char **argv
)
1633 int opt
, ret
= CMD_SUCCESS
;
1634 const char *session_name
;
1635 static poptContext pc
;
1636 struct lttng_domain domain
;
1637 struct lttng_domain
*domains
= NULL
;
1639 memset(&domain
, 0, sizeof(domain
));
1647 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1648 poptReadDefaultConfig(pc
, 0);
1650 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1658 case OPT_LIST_OPTIONS
:
1659 list_cmd_options(stdout
, long_options
);
1663 ret
= CMD_UNDEFINED
;
1670 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
1676 /* Open command element */
1677 ret
= mi_lttng_writer_command_open(writer
,
1678 mi_lttng_element_command_list
);
1684 /* Open output element */
1685 ret
= mi_lttng_writer_open_element(writer
,
1686 mi_lttng_element_command_output
);
1693 /* Get session name (trailing argument) */
1694 session_name
= poptGetArg(pc
);
1695 DBG2("Session name: %s", session_name
);
1698 domain
.type
= LTTNG_DOMAIN_KERNEL
;
1699 } else if (opt_userspace
) {
1700 DBG2("Listing userspace global domain");
1701 domain
.type
= LTTNG_DOMAIN_UST
;
1702 } else if (opt_jul
) {
1703 DBG2("Listing JUL domain");
1704 domain
.type
= LTTNG_DOMAIN_JUL
;
1705 } else if (opt_log4j
) {
1706 domain
.type
= LTTNG_DOMAIN_LOG4J
;
1707 } else if (opt_python
) {
1708 domain
.type
= LTTNG_DOMAIN_PYTHON
;
1711 if (!opt_kernel
&& opt_syscall
) {
1712 WARN("--syscall will only work with the Kernel domain (-k)");
1717 if (opt_kernel
|| opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
) {
1718 handle
= lttng_create_handle(session_name
, &domain
);
1719 if (handle
== NULL
) {
1725 if (session_name
== NULL
) {
1726 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
&& !opt_log4j
1728 ret
= list_sessions(NULL
);
1735 ret
= list_syscalls();
1740 ret
= list_kernel_events();
1746 if (opt_userspace
) {
1748 ret
= list_ust_event_fields();
1750 ret
= list_ust_events();
1756 if (opt_jul
|| opt_log4j
|| opt_python
) {
1757 ret
= list_agent_events();
1763 /* List session attributes */
1765 /* Open element sessions
1766 * Present for xml consistency */
1767 ret
= mi_lttng_sessions_open(writer
);
1772 /* MI: the ouptut of list_sessions is an unclosed session element */
1773 ret
= list_sessions(session_name
);
1778 /* Domain listing */
1780 ret
= list_domains(session_name
);
1784 /* Channel listing */
1785 if (opt_kernel
|| opt_userspace
) {
1787 /* Add of domains and domain element for xml
1788 * consistency and validation
1790 ret
= mi_lttng_domains_open(writer
);
1795 /* Open domain and leave it open for
1796 * nested channels printing */
1797 ret
= mi_lttng_domain(writer
, &domain
, 1);
1806 ret
= list_trackers();
1812 ret
= list_channels(opt_channel
);
1818 /* Close domain and domain element */
1819 ret
= mi_lttng_close_multi_element(writer
, 2);
1829 /* We want all domain(s) */
1830 nb_domain
= lttng_list_domains(session_name
, &domains
);
1831 if (nb_domain
< 0) {
1833 ERR("%s", lttng_strerror(nb_domain
));
1838 ret
= mi_lttng_domains_open(writer
);
1845 for (i
= 0; i
< nb_domain
; i
++) {
1846 switch (domains
[i
].type
) {
1847 case LTTNG_DOMAIN_KERNEL
:
1848 MSG("=== Domain: Kernel ===\n");
1850 case LTTNG_DOMAIN_UST
:
1851 MSG("=== Domain: UST global ===\n");
1852 MSG("Buffer type: %s\n",
1853 domains
[i
].buf_type
==
1854 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
1856 case LTTNG_DOMAIN_JUL
:
1857 MSG("=== Domain: JUL (Java Util Logging) ===\n");
1859 case LTTNG_DOMAIN_LOG4J
:
1860 MSG("=== Domain: LOG4j (Logging for Java) ===\n");
1862 case LTTNG_DOMAIN_PYTHON
:
1863 MSG("=== Domain: Python (logging) ===\n");
1866 MSG("=== Domain: Unimplemented ===\n");
1871 ret
= mi_lttng_domain(writer
, &domains
[i
], 1);
1878 /* Clean handle before creating a new one */
1880 lttng_destroy_handle(handle
);
1883 handle
= lttng_create_handle(session_name
, &domains
[i
]);
1884 if (handle
== NULL
) {
1889 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
||
1890 domains
[i
].type
== LTTNG_DOMAIN_LOG4J
||
1891 domains
[i
].type
== LTTNG_DOMAIN_PYTHON
) {
1892 ret
= list_session_agent_events();
1900 switch (domains
[i
].type
) {
1901 case LTTNG_DOMAIN_KERNEL
:
1902 case LTTNG_DOMAIN_UST
:
1903 ret
= list_trackers();
1912 ret
= list_channels(opt_channel
);
1919 /* Close domain element */
1920 ret
= mi_lttng_writer_close_element(writer
);
1929 /* Close the domains, session and sessions element */
1930 ret
= mi_lttng_close_multi_element(writer
, 3);
1941 /* Close output element */
1942 ret
= mi_lttng_writer_close_element(writer
);
1948 /* Command element close */
1949 ret
= mi_lttng_writer_command_close(writer
);
1957 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1958 /* Preserve original error code */
1959 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
1964 lttng_destroy_handle(handle
);
1967 poptFreeContext(pc
);