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 "../command.h"
28 static int opt_userspace
;
29 static int opt_kernel
;
31 static char *opt_channel
;
32 static int opt_domain
;
33 static int opt_fields
;
35 /* Not implemented yet */
36 static char *opt_cmd_name
;
40 const char *indent4
= " ";
41 const char *indent6
= " ";
42 const char *indent8
= " ";
50 static struct lttng_handle
*handle
;
52 static struct poptOption long_options
[] = {
53 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
54 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
55 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
56 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
58 /* Not implemented yet */
59 {"userspace", 'u', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_cmd_name
, OPT_USERSPACE
, 0, 0},
60 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
62 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
64 {"channel", 'c', POPT_ARG_STRING
, &opt_channel
, 0, 0, 0},
65 {"domain", 'd', POPT_ARG_VAL
, &opt_domain
, 1, 0, 0},
66 {"fields", 'f', POPT_ARG_VAL
, &opt_fields
, 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
, " -f, --fields List event fields.\n");
90 fprintf(ofp
, " -p, --pid PID List user-space events by PID\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 char path
[24]; /* Can't go bigger than /proc/65535/cmdline */
112 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
113 fp
= fopen(path
, "r");
118 /* Caller must free() *cmdline */
119 cmdline
= malloc(PATH_MAX
);
120 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
122 perror("fread proc list");
131 const char *active_string(int value
)
134 case 0: return "inactive";
135 case 1: return "active";
137 default: return NULL
;
141 static const char *snapshot_string(int value
)
152 const char *enabled_string(int value
)
155 case 0: return " [disabled]";
156 case 1: return " [enabled]";
158 default: return NULL
;
163 const char *filter_string(int value
)
166 case 1: return " [with filter]";
172 const char *exclusion_string(int value
)
175 case 1: return " [has exclusions]";
180 static const char *loglevel_string(int value
)
185 case LTTNG_LOGLEVEL_EMERG
:
186 return "TRACE_EMERG";
187 case LTTNG_LOGLEVEL_ALERT
:
188 return "TRACE_ALERT";
189 case LTTNG_LOGLEVEL_CRIT
:
191 case LTTNG_LOGLEVEL_ERR
:
193 case LTTNG_LOGLEVEL_WARNING
:
194 return "TRACE_WARNING";
195 case LTTNG_LOGLEVEL_NOTICE
:
196 return "TRACE_NOTICE";
197 case LTTNG_LOGLEVEL_INFO
:
199 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
200 return "TRACE_DEBUG_SYSTEM";
201 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
202 return "TRACE_DEBUG_PROGRAM";
203 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
204 return "TRACE_DEBUG_PROCESS";
205 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
206 return "TRACE_DEBUG_MODULE";
207 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
208 return "TRACE_DEBUG_UNIT";
209 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
210 return "TRACE_DEBUG_FUNCTION";
211 case LTTNG_LOGLEVEL_DEBUG_LINE
:
212 return "TRACE_DEBUG_LINE";
213 case LTTNG_LOGLEVEL_DEBUG
:
214 return "TRACE_DEBUG";
216 return "<<UNKNOWN>>";
220 static const char *logleveltype_string(enum lttng_loglevel_type value
)
223 case LTTNG_EVENT_LOGLEVEL_ALL
:
225 case LTTNG_EVENT_LOGLEVEL_RANGE
:
227 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
230 return " <<TYPE UNKN>>";
235 * Pretty print single event.
237 static void print_events(struct lttng_event
*event
)
239 switch (event
->type
) {
240 case LTTNG_EVENT_TRACEPOINT
:
242 if (event
->loglevel
!= -1) {
243 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
246 logleveltype_string(event
->loglevel_type
),
247 loglevel_string(event
->loglevel
),
249 enabled_string(event
->enabled
),
250 exclusion_string(event
->exclusion
),
251 filter_string(event
->filter
));
253 MSG("%s%s (type: tracepoint)%s%s%s",
256 enabled_string(event
->enabled
),
257 exclusion_string(event
->exclusion
),
258 filter_string(event
->filter
));
262 case LTTNG_EVENT_FUNCTION
:
263 MSG("%s%s (type: function)%s%s", indent6
,
264 event
->name
, enabled_string(event
->enabled
),
265 filter_string(event
->filter
));
266 if (event
->attr
.probe
.addr
!= 0) {
267 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
269 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
270 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
273 case LTTNG_EVENT_PROBE
:
274 MSG("%s%s (type: probe)%s%s", indent6
,
275 event
->name
, enabled_string(event
->enabled
),
276 filter_string(event
->filter
));
277 if (event
->attr
.probe
.addr
!= 0) {
278 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
280 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
281 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
284 case LTTNG_EVENT_FUNCTION_ENTRY
:
285 MSG("%s%s (type: function)%s%s", indent6
,
286 event
->name
, enabled_string(event
->enabled
),
287 filter_string(event
->filter
));
288 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
290 case LTTNG_EVENT_SYSCALL
:
291 MSG("%ssyscalls (type: syscall)%s%s", indent6
,
292 enabled_string(event
->enabled
),
293 filter_string(event
->filter
));
295 case LTTNG_EVENT_NOOP
:
296 MSG("%s (type: noop)%s%s", indent6
,
297 enabled_string(event
->enabled
),
298 filter_string(event
->filter
));
300 case LTTNG_EVENT_ALL
:
301 /* 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]" : "");
336 static int list_jul_events(void)
339 struct lttng_domain domain
;
340 struct lttng_handle
*handle
;
341 struct lttng_event
*event_list
;
343 char *cmdline
= NULL
;
345 DBG("Getting JUL tracing events");
347 memset(&domain
, 0, sizeof(domain
));
348 domain
.type
= LTTNG_DOMAIN_JUL
;
350 handle
= lttng_create_handle(NULL
, &domain
);
351 if (handle
== NULL
) {
355 size
= lttng_list_tracepoints(handle
, &event_list
);
357 ERR("Unable to list JUL events: %s", lttng_strerror(size
));
358 lttng_destroy_handle(handle
);
362 MSG("JUL events (Logger name):\n-------------------------");
368 for (i
= 0; i
< size
; i
++) {
369 if (cur_pid
!= event_list
[i
].pid
) {
370 cur_pid
= event_list
[i
].pid
;
371 cmdline
= get_cmdline_by_pid(cur_pid
);
372 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
375 MSG("%s- %s", indent6
, event_list
[i
].name
);
381 lttng_destroy_handle(handle
);
386 lttng_destroy_handle(handle
);
391 * Ask session daemon for all user space tracepoints available.
393 static int list_ust_events(void)
396 struct lttng_domain domain
;
397 struct lttng_handle
*handle
;
398 struct lttng_event
*event_list
;
400 char *cmdline
= NULL
;
402 memset(&domain
, 0, sizeof(domain
));
404 DBG("Getting UST tracing events");
406 domain
.type
= LTTNG_DOMAIN_UST
;
408 handle
= lttng_create_handle(NULL
, &domain
);
409 if (handle
== NULL
) {
413 size
= lttng_list_tracepoints(handle
, &event_list
);
415 ERR("Unable to list UST events: %s", lttng_strerror(size
));
416 lttng_destroy_handle(handle
);
420 MSG("UST events:\n-------------");
426 for (i
= 0; i
< size
; i
++) {
427 if (cur_pid
!= event_list
[i
].pid
) {
428 cur_pid
= event_list
[i
].pid
;
429 cmdline
= get_cmdline_by_pid(cur_pid
);
430 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
433 print_events(&event_list
[i
]);
439 lttng_destroy_handle(handle
);
444 lttng_destroy_handle(handle
);
449 * Ask session daemon for all user space tracepoint fields available.
451 static int list_ust_event_fields(void)
454 struct lttng_domain domain
;
455 struct lttng_handle
*handle
;
456 struct lttng_event_field
*event_field_list
;
458 char *cmdline
= NULL
;
460 struct lttng_event cur_event
;
462 memset(&domain
, 0, sizeof(domain
));
463 memset(&cur_event
, 0, sizeof(cur_event
));
465 DBG("Getting UST tracing event fields");
467 domain
.type
= LTTNG_DOMAIN_UST
;
469 handle
= lttng_create_handle(NULL
, &domain
);
470 if (handle
== NULL
) {
474 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
476 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
477 lttng_destroy_handle(handle
);
481 MSG("UST events:\n-------------");
487 for (i
= 0; i
< size
; i
++) {
488 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
489 cur_pid
= event_field_list
[i
].event
.pid
;
490 cmdline
= get_cmdline_by_pid(cur_pid
);
491 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
493 /* Wipe current event since we are about to print a new PID. */
494 memset(&cur_event
, 0, sizeof(cur_event
));
496 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
497 print_events(&event_field_list
[i
].event
);
498 memcpy(&cur_event
, &event_field_list
[i
].event
,
501 print_event_field(&event_field_list
[i
]);
506 free(event_field_list
);
507 lttng_destroy_handle(handle
);
512 lttng_destroy_handle(handle
);
517 * Ask for all trace events in the kernel and pretty print them.
519 static int list_kernel_events(void)
522 struct lttng_domain domain
;
523 struct lttng_handle
*handle
;
524 struct lttng_event
*event_list
;
526 memset(&domain
, 0, sizeof(domain
));
528 DBG("Getting kernel tracing events");
530 domain
.type
= LTTNG_DOMAIN_KERNEL
;
532 handle
= lttng_create_handle(NULL
, &domain
);
533 if (handle
== NULL
) {
537 size
= lttng_list_tracepoints(handle
, &event_list
);
539 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
540 lttng_destroy_handle(handle
);
544 MSG("Kernel events:\n-------------");
546 for (i
= 0; i
< size
; i
++) {
547 print_events(&event_list
[i
]);
554 lttng_destroy_handle(handle
);
558 lttng_destroy_handle(handle
);
563 * List JUL events for a specific session using the handle.
565 * Return CMD_SUCCESS on success else a negative value.
567 static int list_session_jul_events(void)
570 struct lttng_event
*events
= NULL
;
572 count
= lttng_list_events(handle
, "", &events
);
575 ERR("%s", lttng_strerror(ret
));
579 MSG("Events (Logger name):\n---------------------");
581 MSG("%sNone\n", indent6
);
585 for (i
= 0; i
< count
; i
++) {
586 MSG("%s- %s%s", indent4
, events
[i
].name
,
587 enabled_string(events
[i
].enabled
));
601 * List events of channel of session and domain.
603 static int list_events(const char *channel_name
)
606 struct lttng_event
*events
= NULL
;
608 count
= lttng_list_events(handle
, channel_name
, &events
);
611 ERR("%s", lttng_strerror(ret
));
615 MSG("\n%sEvents:", indent4
);
617 MSG("%sNone\n", indent6
);
621 for (i
= 0; i
< count
; i
++) {
622 print_events(&events
[i
]);
636 * Pretty print channel
638 static void print_channel(struct lttng_channel
*channel
)
640 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
642 MSG("%sAttributes:", indent4
);
643 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
644 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
645 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
646 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
647 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
648 switch (channel
->attr
.output
) {
649 case LTTNG_EVENT_SPLICE
:
650 MSG("%soutput: splice()", indent6
);
652 case LTTNG_EVENT_MMAP
:
653 MSG("%soutput: mmap()", indent6
);
659 * List channel(s) of session and domain.
661 * If channel_name is NULL, all channels are listed.
663 static int list_channels(const char *channel_name
)
665 int count
, i
, ret
= CMD_SUCCESS
;
666 unsigned int chan_found
= 0;
667 struct lttng_channel
*channels
= NULL
;
669 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
671 count
= lttng_list_channels(handle
, &channels
);
674 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
676 WARN("No kernel channel");
679 /* We had a real error */
681 ERR("%s", lttng_strerror(ret
));
687 if (channel_name
== NULL
) {
688 MSG("Channels:\n-------------");
691 for (i
= 0; i
< count
; i
++) {
692 if (channel_name
!= NULL
) {
693 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
699 print_channel(&channels
[i
]);
701 /* Listing events per channel */
702 ret
= list_events(channels
[i
].name
);
704 ERR("%s", lttng_strerror(ret
));
712 if (!chan_found
&& channel_name
!= NULL
) {
713 ERR("Channel %s not found", channel_name
);
727 * List available tracing session. List only basic information.
729 * If session_name is NULL, all sessions are listed.
731 static int list_sessions(const char *session_name
)
734 unsigned int session_found
= 0;
735 struct lttng_session
*sessions
;
737 count
= lttng_list_sessions(&sessions
);
738 DBG("Session count %d", count
);
741 ERR("%s", lttng_strerror(ret
));
743 } else if (count
== 0) {
744 MSG("Currently no available tracing session");
748 if (session_name
== NULL
) {
749 MSG("Available tracing sessions:");
752 for (i
= 0; i
< count
; i
++) {
753 if (session_name
!= NULL
) {
754 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
756 MSG("Tracing session %s: [%s%s]", session_name
,
757 active_string(sessions
[i
].enabled
),
758 snapshot_string(sessions
[i
].snapshot_mode
));
759 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
763 MSG(" %d) %s (%s) [%s%s]", i
+ 1, sessions
[i
].name
, sessions
[i
].path
,
764 active_string(sessions
[i
].enabled
),
765 snapshot_string(sessions
[i
].snapshot_mode
));
771 if (!session_found
&& session_name
!= NULL
) {
772 ERR("Session '%s' not found", session_name
);
777 if (session_name
== NULL
) {
778 MSG("\nUse lttng list <session_name> for more details");
789 * List available domain(s) for a session.
791 static int list_domains(const char *session_name
)
793 int i
, count
, ret
= CMD_SUCCESS
;
794 struct lttng_domain
*domains
= NULL
;
796 MSG("Domains:\n-------------");
798 count
= lttng_list_domains(session_name
, &domains
);
801 ERR("%s", lttng_strerror(ret
));
803 } else if (count
== 0) {
808 for (i
= 0; i
< count
; i
++) {
809 switch (domains
[i
].type
) {
810 case LTTNG_DOMAIN_KERNEL
:
813 case LTTNG_DOMAIN_UST
:
814 MSG(" - UST global");
816 case LTTNG_DOMAIN_JUL
:
817 MSG(" - JUL (Java Util Logging)");
832 * The 'list <options>' first level command
834 int cmd_list(int argc
, const char **argv
)
836 int opt
, ret
= CMD_SUCCESS
;
837 const char *session_name
;
838 static poptContext pc
;
839 struct lttng_domain domain
;
840 struct lttng_domain
*domains
= NULL
;
842 memset(&domain
, 0, sizeof(domain
));
850 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
851 poptReadDefaultConfig(pc
, 0);
853 while ((opt
= poptGetNextOpt(pc
)) != -1) {
861 case OPT_LIST_OPTIONS
:
862 list_cmd_options(stdout
, long_options
);
871 /* Get session name (trailing argument) */
872 session_name
= poptGetArg(pc
);
873 DBG2("Session name: %s", session_name
);
876 domain
.type
= LTTNG_DOMAIN_KERNEL
;
877 } else if (opt_userspace
) {
878 DBG2("Listing userspace global domain");
879 domain
.type
= LTTNG_DOMAIN_UST
;
880 } else if (opt_jul
) {
881 DBG2("Listing JUL domain");
882 domain
.type
= LTTNG_DOMAIN_JUL
;
885 if (opt_kernel
|| opt_userspace
|| opt_jul
) {
886 handle
= lttng_create_handle(session_name
, &domain
);
887 if (handle
== NULL
) {
893 if (session_name
== NULL
) {
894 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
) {
895 ret
= list_sessions(NULL
);
901 ret
= list_kernel_events();
909 ret
= list_ust_event_fields();
911 ret
= list_ust_events();
919 ret
= list_jul_events();
926 /* List session attributes */
927 ret
= list_sessions(session_name
);
934 ret
= list_domains(session_name
);
938 if (opt_kernel
|| opt_userspace
) {
939 /* Channel listing */
940 ret
= list_channels(opt_channel
);
947 /* We want all domain(s) */
948 nb_domain
= lttng_list_domains(session_name
, &domains
);
951 ERR("%s", lttng_strerror(ret
));
955 for (i
= 0; i
< nb_domain
; i
++) {
956 switch (domains
[i
].type
) {
957 case LTTNG_DOMAIN_KERNEL
:
958 MSG("=== Domain: Kernel ===\n");
960 case LTTNG_DOMAIN_UST
:
961 MSG("=== Domain: UST global ===\n");
962 MSG("Buffer type: %s\n",
963 domains
[i
].buf_type
==
964 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
966 case LTTNG_DOMAIN_JUL
:
967 MSG("=== Domain: JUL (Java Util Logging) ===\n");
970 MSG("=== Domain: Unimplemented ===\n");
974 /* Clean handle before creating a new one */
976 lttng_destroy_handle(handle
);
979 handle
= lttng_create_handle(session_name
, &domains
[i
]);
980 if (handle
== NULL
) {
985 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
) {
986 ret
= list_session_jul_events();
993 ret
= list_channels(opt_channel
);
1004 lttng_destroy_handle(handle
);
1007 poptFreeContext(pc
);