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>>";
221 * Pretty print single event.
223 static void print_events(struct lttng_event
*event
)
225 switch (event
->type
) {
226 case LTTNG_EVENT_TRACEPOINT
:
228 if (event
->loglevel
!= -1) {
229 MSG("%s%s (loglevel: %s (%d)) (type: tracepoint)%s%s%s",
232 loglevel_string(event
->loglevel
),
234 enabled_string(event
->enabled
),
235 exclusion_string(event
->exclusion
),
236 filter_string(event
->filter
));
238 MSG("%s%s (type: tracepoint)%s%s%s",
241 enabled_string(event
->enabled
),
242 exclusion_string(event
->exclusion
),
243 filter_string(event
->filter
));
247 case LTTNG_EVENT_FUNCTION
:
248 MSG("%s%s (type: function)%s%s", indent6
,
249 event
->name
, enabled_string(event
->enabled
),
250 filter_string(event
->filter
));
251 if (event
->attr
.probe
.addr
!= 0) {
252 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
254 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
255 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
258 case LTTNG_EVENT_PROBE
:
259 MSG("%s%s (type: probe)%s%s", indent6
,
260 event
->name
, enabled_string(event
->enabled
),
261 filter_string(event
->filter
));
262 if (event
->attr
.probe
.addr
!= 0) {
263 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
265 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
266 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
269 case LTTNG_EVENT_FUNCTION_ENTRY
:
270 MSG("%s%s (type: function)%s%s", indent6
,
271 event
->name
, enabled_string(event
->enabled
),
272 filter_string(event
->filter
));
273 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
275 case LTTNG_EVENT_SYSCALL
:
276 MSG("%ssyscalls (type: syscall)%s%s", indent6
,
277 enabled_string(event
->enabled
),
278 filter_string(event
->filter
));
280 case LTTNG_EVENT_NOOP
:
281 MSG("%s (type: noop)%s%s", indent6
,
282 enabled_string(event
->enabled
),
283 filter_string(event
->filter
));
285 case LTTNG_EVENT_ALL
:
286 /* We should never have "all" events in list. */
292 static const char *field_type(struct lttng_event_field
*field
)
294 switch(field
->type
) {
295 case LTTNG_EVENT_FIELD_INTEGER
:
297 case LTTNG_EVENT_FIELD_ENUM
:
299 case LTTNG_EVENT_FIELD_FLOAT
:
301 case LTTNG_EVENT_FIELD_STRING
:
303 case LTTNG_EVENT_FIELD_OTHER
:
304 default: /* fall-through */
310 * Pretty print single event fields.
312 static void print_event_field(struct lttng_event_field
*field
)
314 if (!field
->field_name
[0]) {
317 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
318 field_type(field
), field
->nowrite
? " [no write]" : "");
321 static int list_jul_events(void)
324 struct lttng_domain domain
;
325 struct lttng_handle
*handle
;
326 struct lttng_event
*event_list
;
328 char *cmdline
= NULL
;
330 DBG("Getting JUL tracing events");
332 memset(&domain
, 0, sizeof(domain
));
333 domain
.type
= LTTNG_DOMAIN_JUL
;
335 handle
= lttng_create_handle(NULL
, &domain
);
336 if (handle
== NULL
) {
340 size
= lttng_list_tracepoints(handle
, &event_list
);
342 ERR("Unable to list JUL events: %s", lttng_strerror(size
));
343 lttng_destroy_handle(handle
);
347 MSG("JUL events (Logger name):\n-------------------------");
353 for (i
= 0; i
< size
; i
++) {
354 if (cur_pid
!= event_list
[i
].pid
) {
355 cur_pid
= event_list
[i
].pid
;
356 cmdline
= get_cmdline_by_pid(cur_pid
);
357 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
360 MSG("%s- %s", indent6
, event_list
[i
].name
);
366 lttng_destroy_handle(handle
);
371 lttng_destroy_handle(handle
);
376 * Ask session daemon for all user space tracepoints available.
378 static int list_ust_events(void)
381 struct lttng_domain domain
;
382 struct lttng_handle
*handle
;
383 struct lttng_event
*event_list
;
385 char *cmdline
= NULL
;
387 memset(&domain
, 0, sizeof(domain
));
389 DBG("Getting UST tracing events");
391 domain
.type
= LTTNG_DOMAIN_UST
;
393 handle
= lttng_create_handle(NULL
, &domain
);
394 if (handle
== NULL
) {
398 size
= lttng_list_tracepoints(handle
, &event_list
);
400 ERR("Unable to list UST events: %s", lttng_strerror(size
));
401 lttng_destroy_handle(handle
);
405 MSG("UST events:\n-------------");
411 for (i
= 0; i
< size
; i
++) {
412 if (cur_pid
!= event_list
[i
].pid
) {
413 cur_pid
= event_list
[i
].pid
;
414 cmdline
= get_cmdline_by_pid(cur_pid
);
415 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
418 print_events(&event_list
[i
]);
424 lttng_destroy_handle(handle
);
429 lttng_destroy_handle(handle
);
434 * Ask session daemon for all user space tracepoint fields available.
436 static int list_ust_event_fields(void)
439 struct lttng_domain domain
;
440 struct lttng_handle
*handle
;
441 struct lttng_event_field
*event_field_list
;
443 char *cmdline
= NULL
;
445 struct lttng_event cur_event
;
447 memset(&domain
, 0, sizeof(domain
));
448 memset(&cur_event
, 0, sizeof(cur_event
));
450 DBG("Getting UST tracing event fields");
452 domain
.type
= LTTNG_DOMAIN_UST
;
454 handle
= lttng_create_handle(NULL
, &domain
);
455 if (handle
== NULL
) {
459 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
461 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
462 lttng_destroy_handle(handle
);
466 MSG("UST events:\n-------------");
472 for (i
= 0; i
< size
; i
++) {
473 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
474 cur_pid
= event_field_list
[i
].event
.pid
;
475 cmdline
= get_cmdline_by_pid(cur_pid
);
476 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
478 /* Wipe current event since we are about to print a new PID. */
479 memset(&cur_event
, 0, sizeof(cur_event
));
481 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
482 print_events(&event_field_list
[i
].event
);
483 memcpy(&cur_event
, &event_field_list
[i
].event
,
486 print_event_field(&event_field_list
[i
]);
491 free(event_field_list
);
492 lttng_destroy_handle(handle
);
497 lttng_destroy_handle(handle
);
502 * Ask for all trace events in the kernel and pretty print them.
504 static int list_kernel_events(void)
507 struct lttng_domain domain
;
508 struct lttng_handle
*handle
;
509 struct lttng_event
*event_list
;
511 memset(&domain
, 0, sizeof(domain
));
513 DBG("Getting kernel tracing events");
515 domain
.type
= LTTNG_DOMAIN_KERNEL
;
517 handle
= lttng_create_handle(NULL
, &domain
);
518 if (handle
== NULL
) {
522 size
= lttng_list_tracepoints(handle
, &event_list
);
524 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
525 lttng_destroy_handle(handle
);
529 MSG("Kernel events:\n-------------");
531 for (i
= 0; i
< size
; i
++) {
532 print_events(&event_list
[i
]);
539 lttng_destroy_handle(handle
);
543 lttng_destroy_handle(handle
);
548 * List JUL events for a specific session using the handle.
550 * Return CMD_SUCCESS on success else a negative value.
552 static int list_session_jul_events(void)
555 struct lttng_event
*events
= NULL
;
557 count
= lttng_list_events(handle
, "", &events
);
560 ERR("%s", lttng_strerror(ret
));
564 MSG("Events (Logger name):\n---------------------");
566 MSG("%sNone\n", indent6
);
570 for (i
= 0; i
< count
; i
++) {
571 MSG("%s- %s%s", indent4
, events
[i
].name
,
572 enabled_string(events
[i
].enabled
));
586 * List events of channel of session and domain.
588 static int list_events(const char *channel_name
)
591 struct lttng_event
*events
= NULL
;
593 count
= lttng_list_events(handle
, channel_name
, &events
);
596 ERR("%s", lttng_strerror(ret
));
600 MSG("\n%sEvents:", indent4
);
602 MSG("%sNone\n", indent6
);
606 for (i
= 0; i
< count
; i
++) {
607 print_events(&events
[i
]);
621 * Pretty print channel
623 static void print_channel(struct lttng_channel
*channel
)
625 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
627 MSG("%sAttributes:", indent4
);
628 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
629 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
630 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
631 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
632 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
633 switch (channel
->attr
.output
) {
634 case LTTNG_EVENT_SPLICE
:
635 MSG("%soutput: splice()", indent6
);
637 case LTTNG_EVENT_MMAP
:
638 MSG("%soutput: mmap()", indent6
);
644 * List channel(s) of session and domain.
646 * If channel_name is NULL, all channels are listed.
648 static int list_channels(const char *channel_name
)
650 int count
, i
, ret
= CMD_SUCCESS
;
651 unsigned int chan_found
= 0;
652 struct lttng_channel
*channels
= NULL
;
654 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
656 count
= lttng_list_channels(handle
, &channels
);
659 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
661 WARN("No kernel channel");
664 /* We had a real error */
666 ERR("%s", lttng_strerror(ret
));
672 if (channel_name
== NULL
) {
673 MSG("Channels:\n-------------");
676 for (i
= 0; i
< count
; i
++) {
677 if (channel_name
!= NULL
) {
678 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
684 print_channel(&channels
[i
]);
686 /* Listing events per channel */
687 ret
= list_events(channels
[i
].name
);
689 ERR("%s", lttng_strerror(ret
));
697 if (!chan_found
&& channel_name
!= NULL
) {
698 ERR("Channel %s not found", channel_name
);
712 * List available tracing session. List only basic information.
714 * If session_name is NULL, all sessions are listed.
716 static int list_sessions(const char *session_name
)
719 unsigned int session_found
= 0;
720 struct lttng_session
*sessions
;
722 count
= lttng_list_sessions(&sessions
);
723 DBG("Session count %d", count
);
726 ERR("%s", lttng_strerror(ret
));
728 } else if (count
== 0) {
729 MSG("Currently no available tracing session");
733 if (session_name
== NULL
) {
734 MSG("Available tracing sessions:");
737 for (i
= 0; i
< count
; i
++) {
738 if (session_name
!= NULL
) {
739 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
741 MSG("Tracing session %s: [%s%s]", session_name
,
742 active_string(sessions
[i
].enabled
),
743 snapshot_string(sessions
[i
].snapshot_mode
));
744 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
748 MSG(" %d) %s (%s) [%s%s]", i
+ 1, sessions
[i
].name
, sessions
[i
].path
,
749 active_string(sessions
[i
].enabled
),
750 snapshot_string(sessions
[i
].snapshot_mode
));
756 if (!session_found
&& session_name
!= NULL
) {
757 ERR("Session '%s' not found", session_name
);
762 if (session_name
== NULL
) {
763 MSG("\nUse lttng list <session_name> for more details");
774 * List available domain(s) for a session.
776 static int list_domains(const char *session_name
)
778 int i
, count
, ret
= CMD_SUCCESS
;
779 struct lttng_domain
*domains
= NULL
;
781 MSG("Domains:\n-------------");
783 count
= lttng_list_domains(session_name
, &domains
);
786 ERR("%s", lttng_strerror(ret
));
788 } else if (count
== 0) {
793 for (i
= 0; i
< count
; i
++) {
794 switch (domains
[i
].type
) {
795 case LTTNG_DOMAIN_KERNEL
:
798 case LTTNG_DOMAIN_UST
:
799 MSG(" - UST global");
801 case LTTNG_DOMAIN_JUL
:
802 MSG(" - JUL (Java Util Logging)");
817 * The 'list <options>' first level command
819 int cmd_list(int argc
, const char **argv
)
821 int opt
, ret
= CMD_SUCCESS
;
822 const char *session_name
;
823 static poptContext pc
;
824 struct lttng_domain domain
;
825 struct lttng_domain
*domains
= NULL
;
827 memset(&domain
, 0, sizeof(domain
));
835 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
836 poptReadDefaultConfig(pc
, 0);
838 while ((opt
= poptGetNextOpt(pc
)) != -1) {
846 case OPT_LIST_OPTIONS
:
847 list_cmd_options(stdout
, long_options
);
856 /* Get session name (trailing argument) */
857 session_name
= poptGetArg(pc
);
858 DBG2("Session name: %s", session_name
);
861 domain
.type
= LTTNG_DOMAIN_KERNEL
;
862 } else if (opt_userspace
) {
863 DBG2("Listing userspace global domain");
864 domain
.type
= LTTNG_DOMAIN_UST
;
865 } else if (opt_jul
) {
866 DBG2("Listing JUL domain");
867 domain
.type
= LTTNG_DOMAIN_JUL
;
870 if (opt_kernel
|| opt_userspace
|| opt_jul
) {
871 handle
= lttng_create_handle(session_name
, &domain
);
872 if (handle
== NULL
) {
878 if (session_name
== NULL
) {
879 if (!opt_kernel
&& !opt_userspace
&& !opt_jul
) {
880 ret
= list_sessions(NULL
);
886 ret
= list_kernel_events();
894 ret
= list_ust_event_fields();
896 ret
= list_ust_events();
904 ret
= list_jul_events();
911 /* List session attributes */
912 ret
= list_sessions(session_name
);
919 ret
= list_domains(session_name
);
923 if (opt_kernel
|| opt_userspace
) {
924 /* Channel listing */
925 ret
= list_channels(opt_channel
);
932 /* We want all domain(s) */
933 nb_domain
= lttng_list_domains(session_name
, &domains
);
936 ERR("%s", lttng_strerror(ret
));
940 for (i
= 0; i
< nb_domain
; i
++) {
941 switch (domains
[i
].type
) {
942 case LTTNG_DOMAIN_KERNEL
:
943 MSG("=== Domain: Kernel ===\n");
945 case LTTNG_DOMAIN_UST
:
946 MSG("=== Domain: UST global ===\n");
947 MSG("Buffer type: %s\n",
948 domains
[i
].buf_type
==
949 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
951 case LTTNG_DOMAIN_JUL
:
952 MSG("=== Domain: JUL (Java Util Logging) ===\n");
955 MSG("=== Domain: Unimplemented ===\n");
959 /* Clean handle before creating a new one */
961 lttng_destroy_handle(handle
);
964 handle
= lttng_create_handle(session_name
, &domains
[i
]);
965 if (handle
== NULL
) {
970 if (domains
[i
].type
== LTTNG_DOMAIN_JUL
) {
971 ret
= list_session_jul_events();
978 ret
= list_channels(opt_channel
);
989 lttng_destroy_handle(handle
);