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
;
30 static char *opt_channel
;
31 static int opt_domain
;
32 static int opt_fields
;
34 /* Not implemented yet */
35 static char *opt_cmd_name
;
39 const char *indent4
= " ";
40 const char *indent6
= " ";
41 const char *indent8
= " ";
49 static struct lttng_handle
*handle
;
51 static struct poptOption long_options
[] = {
52 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
53 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
54 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
56 /* Not implemented yet */
57 {"userspace", 'u', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_cmd_name
, OPT_USERSPACE
, 0, 0},
58 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
60 {"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 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
72 static void usage(FILE *ofp
)
74 fprintf(ofp
, "usage: lttng list [OPTIONS] [SESSION [SESSION OPTIONS]]\n");
76 fprintf(ofp
, "With no arguments, list available tracing session(s)\n");
78 fprintf(ofp
, "Without a session, -k lists available kernel events\n");
79 fprintf(ofp
, "Without a session, -u lists available userspace events\n");
81 fprintf(ofp
, " -h, --help Show this help\n");
82 fprintf(ofp
, " --list-options Simple listing of options\n");
83 fprintf(ofp
, " -k, --kernel Select kernel domain\n");
84 fprintf(ofp
, " -u, --userspace Select user-space domain.\n");
85 fprintf(ofp
, " -f, --fields List event fields.\n");
87 fprintf(ofp
, " -p, --pid PID List user-space events by PID\n");
90 fprintf(ofp
, "Session Options:\n");
91 fprintf(ofp
, " -c, --channel NAME List details of a channel\n");
92 fprintf(ofp
, " -d, --domain List available domain(s)\n");
97 * Get command line from /proc for a specific pid.
99 * On success, return an allocated string pointer to the proc cmdline.
100 * On error, return NULL.
102 static char *get_cmdline_by_pid(pid_t pid
)
106 char *cmdline
= NULL
;
107 char path
[20]; /* Can't go bigger than /proc/65535/cmdline */
109 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
110 fp
= fopen(path
, "r");
115 /* Caller must free() *cmdline */
116 cmdline
= malloc(PATH_MAX
);
118 perror("malloc cmdline");
121 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
123 perror("fread proc list");
132 const char *active_string(int value
)
135 case 0: return "inactive";
136 case 1: return "active";
138 default: return NULL
;
142 static const char *snapshot_string(int value
)
153 const char *enabled_string(int value
)
156 case 0: return " [disabled]";
157 case 1: return " [enabled]";
159 default: return NULL
;
164 const char *filter_string(int value
)
167 case 1: return " [with filter]";
172 static const char *loglevel_string(int value
)
177 case LTTNG_LOGLEVEL_EMERG
:
178 return "TRACE_EMERG";
179 case LTTNG_LOGLEVEL_ALERT
:
180 return "TRACE_ALERT";
181 case LTTNG_LOGLEVEL_CRIT
:
183 case LTTNG_LOGLEVEL_ERR
:
185 case LTTNG_LOGLEVEL_WARNING
:
186 return "TRACE_WARNING";
187 case LTTNG_LOGLEVEL_NOTICE
:
188 return "TRACE_NOTICE";
189 case LTTNG_LOGLEVEL_INFO
:
191 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
192 return "TRACE_DEBUG_SYSTEM";
193 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
194 return "TRACE_DEBUG_PROGRAM";
195 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
196 return "TRACE_DEBUG_PROCESS";
197 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
198 return "TRACE_DEBUG_MODULE";
199 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
200 return "TRACE_DEBUG_UNIT";
201 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
202 return "TRACE_DEBUG_FUNCTION";
203 case LTTNG_LOGLEVEL_DEBUG_LINE
:
204 return "TRACE_DEBUG_LINE";
205 case LTTNG_LOGLEVEL_DEBUG
:
206 return "TRACE_DEBUG";
208 return "<<UNKNOWN>>";
213 * Pretty print single event.
215 static void print_events(struct lttng_event
*event
)
217 switch (event
->type
) {
218 case LTTNG_EVENT_TRACEPOINT
:
220 if (event
->loglevel
!= -1) {
221 MSG("%s%s (loglevel: %s (%d)) (type: tracepoint)%s%s",
224 loglevel_string(event
->loglevel
),
226 enabled_string(event
->enabled
),
227 filter_string(event
->filter
));
229 MSG("%s%s (type: tracepoint)%s%s",
232 enabled_string(event
->enabled
),
233 filter_string(event
->filter
));
237 case LTTNG_EVENT_FUNCTION
:
238 MSG("%s%s (type: function)%s%s", indent6
,
239 event
->name
, enabled_string(event
->enabled
),
240 filter_string(event
->filter
));
241 if (event
->attr
.probe
.addr
!= 0) {
242 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
244 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
245 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
248 case LTTNG_EVENT_PROBE
:
249 MSG("%s%s (type: probe)%s%s", indent6
,
250 event
->name
, enabled_string(event
->enabled
),
251 filter_string(event
->filter
));
252 if (event
->attr
.probe
.addr
!= 0) {
253 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
255 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
256 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
259 case LTTNG_EVENT_FUNCTION_ENTRY
:
260 MSG("%s%s (type: function)%s%s", indent6
,
261 event
->name
, enabled_string(event
->enabled
),
262 filter_string(event
->filter
));
263 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
265 case LTTNG_EVENT_SYSCALL
:
266 MSG("%ssyscalls (type: syscall)%s%s", indent6
,
267 enabled_string(event
->enabled
),
268 filter_string(event
->filter
));
270 case LTTNG_EVENT_NOOP
:
271 MSG("%s (type: noop)%s%s", indent6
,
272 enabled_string(event
->enabled
),
273 filter_string(event
->filter
));
275 case LTTNG_EVENT_ALL
:
276 /* We should never have "all" events in list. */
282 static const char *field_type(struct lttng_event_field
*field
)
284 switch(field
->type
) {
285 case LTTNG_EVENT_FIELD_INTEGER
:
287 case LTTNG_EVENT_FIELD_ENUM
:
289 case LTTNG_EVENT_FIELD_FLOAT
:
291 case LTTNG_EVENT_FIELD_STRING
:
293 case LTTNG_EVENT_FIELD_OTHER
:
294 default: /* fall-through */
300 * Pretty print single event fields.
302 static void print_event_field(struct lttng_event_field
*field
)
304 if (!field
->field_name
[0]) {
307 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
308 field_type(field
), field
->nowrite
? " [no write]" : "");
312 * Ask session daemon for all user space tracepoints available.
314 static int list_ust_events(void)
317 struct lttng_domain domain
;
318 struct lttng_handle
*handle
;
319 struct lttng_event
*event_list
;
321 char *cmdline
= NULL
;
323 memset(&domain
, 0, sizeof(domain
));
325 DBG("Getting UST tracing events");
327 domain
.type
= LTTNG_DOMAIN_UST
;
329 handle
= lttng_create_handle(NULL
, &domain
);
330 if (handle
== NULL
) {
334 size
= lttng_list_tracepoints(handle
, &event_list
);
336 ERR("Unable to list UST events: %s", lttng_strerror(size
));
337 lttng_destroy_handle(handle
);
341 MSG("UST events:\n-------------");
347 for (i
= 0; i
< size
; i
++) {
348 if (cur_pid
!= event_list
[i
].pid
) {
349 cur_pid
= event_list
[i
].pid
;
350 cmdline
= get_cmdline_by_pid(cur_pid
);
351 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
354 print_events(&event_list
[i
]);
360 lttng_destroy_handle(handle
);
365 lttng_destroy_handle(handle
);
370 * Ask session daemon for all user space tracepoint fields available.
372 static int list_ust_event_fields(void)
375 struct lttng_domain domain
;
376 struct lttng_handle
*handle
;
377 struct lttng_event_field
*event_field_list
;
379 char *cmdline
= NULL
;
381 struct lttng_event cur_event
;
383 memset(&domain
, 0, sizeof(domain
));
384 memset(&cur_event
, 0, sizeof(cur_event
));
386 DBG("Getting UST tracing event fields");
388 domain
.type
= LTTNG_DOMAIN_UST
;
390 handle
= lttng_create_handle(NULL
, &domain
);
391 if (handle
== NULL
) {
395 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
397 ERR("Unable to list UST event fields: %s", lttng_strerror(size
));
398 lttng_destroy_handle(handle
);
402 MSG("UST events:\n-------------");
408 for (i
= 0; i
< size
; i
++) {
409 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
410 cur_pid
= event_field_list
[i
].event
.pid
;
411 cmdline
= get_cmdline_by_pid(cur_pid
);
412 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
414 /* Wipe current event since we are about to print a new PID. */
415 memset(&cur_event
, 0, sizeof(cur_event
));
417 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
418 print_events(&event_field_list
[i
].event
);
419 memcpy(&cur_event
, &event_field_list
[i
].event
,
422 print_event_field(&event_field_list
[i
]);
427 free(event_field_list
);
428 lttng_destroy_handle(handle
);
433 lttng_destroy_handle(handle
);
438 * Ask for all trace events in the kernel and pretty print them.
440 static int list_kernel_events(void)
443 struct lttng_domain domain
;
444 struct lttng_handle
*handle
;
445 struct lttng_event
*event_list
;
447 memset(&domain
, 0, sizeof(domain
));
449 DBG("Getting kernel tracing events");
451 domain
.type
= LTTNG_DOMAIN_KERNEL
;
453 handle
= lttng_create_handle(NULL
, &domain
);
454 if (handle
== NULL
) {
458 size
= lttng_list_tracepoints(handle
, &event_list
);
460 ERR("Unable to list kernel events: %s", lttng_strerror(size
));
461 lttng_destroy_handle(handle
);
465 MSG("Kernel events:\n-------------");
467 for (i
= 0; i
< size
; i
++) {
468 print_events(&event_list
[i
]);
475 lttng_destroy_handle(handle
);
479 lttng_destroy_handle(handle
);
484 * List events of channel of session and domain.
486 static int list_events(const char *channel_name
)
489 struct lttng_event
*events
= NULL
;
491 count
= lttng_list_events(handle
, channel_name
, &events
);
494 ERR("%s", lttng_strerror(ret
));
498 MSG("\n%sEvents:", indent4
);
500 MSG("%sNone\n", indent6
);
504 for (i
= 0; i
< count
; i
++) {
505 print_events(&events
[i
]);
519 * Pretty print channel
521 static void print_channel(struct lttng_channel
*channel
)
523 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
525 MSG("%sAttributes:", indent4
);
526 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
527 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
528 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
529 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
530 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
531 switch (channel
->attr
.output
) {
532 case LTTNG_EVENT_SPLICE
:
533 MSG("%soutput: splice()", indent6
);
535 case LTTNG_EVENT_MMAP
:
536 MSG("%soutput: mmap()", indent6
);
542 * List channel(s) of session and domain.
544 * If channel_name is NULL, all channels are listed.
546 static int list_channels(const char *channel_name
)
548 int count
, i
, ret
= CMD_SUCCESS
;
549 unsigned int chan_found
= 0;
550 struct lttng_channel
*channels
= NULL
;
552 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
554 count
= lttng_list_channels(handle
, &channels
);
557 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
559 WARN("No kernel channel");
562 /* We had a real error */
564 ERR("%s", lttng_strerror(ret
));
570 if (channel_name
== NULL
) {
571 MSG("Channels:\n-------------");
574 for (i
= 0; i
< count
; i
++) {
575 if (channel_name
!= NULL
) {
576 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
582 print_channel(&channels
[i
]);
584 /* Listing events per channel */
585 ret
= list_events(channels
[i
].name
);
587 ERR("%s", lttng_strerror(ret
));
595 if (!chan_found
&& channel_name
!= NULL
) {
596 ERR("Channel %s not found", channel_name
);
610 * List available tracing session. List only basic information.
612 * If session_name is NULL, all sessions are listed.
614 static int list_sessions(const char *session_name
)
617 unsigned int session_found
= 0;
618 struct lttng_session
*sessions
;
620 count
= lttng_list_sessions(&sessions
);
621 DBG("Session count %d", count
);
624 ERR("%s", lttng_strerror(ret
));
626 } else if (count
== 0) {
627 MSG("Currently no available tracing session");
631 if (session_name
== NULL
) {
632 MSG("Available tracing sessions:");
635 for (i
= 0; i
< count
; i
++) {
636 if (session_name
!= NULL
) {
637 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
639 MSG("Tracing session %s: [%s%s]", session_name
,
640 active_string(sessions
[i
].enabled
),
641 snapshot_string(sessions
[i
].snapshot_mode
));
642 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
646 MSG(" %d) %s (%s) [%s%s]", i
+ 1, sessions
[i
].name
, sessions
[i
].path
,
647 active_string(sessions
[i
].enabled
),
648 snapshot_string(sessions
[i
].snapshot_mode
));
654 if (!session_found
&& session_name
!= NULL
) {
655 ERR("Session '%s' not found", session_name
);
660 if (session_name
== NULL
) {
661 MSG("\nUse lttng list <session_name> for more details");
672 * List available domain(s) for a session.
674 static int list_domains(const char *session_name
)
676 int i
, count
, ret
= CMD_SUCCESS
;
677 struct lttng_domain
*domains
= NULL
;
679 MSG("Domains:\n-------------");
681 count
= lttng_list_domains(session_name
, &domains
);
684 ERR("%s", lttng_strerror(ret
));
686 } else if (count
== 0) {
691 for (i
= 0; i
< count
; i
++) {
692 switch (domains
[i
].type
) {
693 case LTTNG_DOMAIN_KERNEL
:
696 case LTTNG_DOMAIN_UST
:
697 MSG(" - UST global");
712 * The 'list <options>' first level command
714 int cmd_list(int argc
, const char **argv
)
716 int opt
, ret
= CMD_SUCCESS
;
717 const char *session_name
;
718 static poptContext pc
;
719 struct lttng_domain domain
;
720 struct lttng_domain
*domains
= NULL
;
722 memset(&domain
, 0, sizeof(domain
));
730 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
731 poptReadDefaultConfig(pc
, 0);
733 while ((opt
= poptGetNextOpt(pc
)) != -1) {
741 case OPT_LIST_OPTIONS
:
742 list_cmd_options(stdout
, long_options
);
751 /* Get session name (trailing argument) */
752 session_name
= poptGetArg(pc
);
753 DBG2("Session name: %s", session_name
);
756 domain
.type
= LTTNG_DOMAIN_KERNEL
;
757 } else if (opt_userspace
) {
758 DBG2("Listing userspace global domain");
759 domain
.type
= LTTNG_DOMAIN_UST
;
762 if (opt_kernel
|| opt_userspace
) {
763 handle
= lttng_create_handle(session_name
, &domain
);
764 if (handle
== NULL
) {
770 if (session_name
== NULL
) {
771 if (!opt_kernel
&& !opt_userspace
) {
772 ret
= list_sessions(NULL
);
778 ret
= list_kernel_events();
786 ret
= list_ust_event_fields();
788 ret
= list_ust_events();
796 /* List session attributes */
797 ret
= list_sessions(session_name
);
804 ret
= list_domains(session_name
);
808 if (opt_kernel
|| opt_userspace
) {
809 /* Channel listing */
810 ret
= list_channels(opt_channel
);
817 /* We want all domain(s) */
818 nb_domain
= lttng_list_domains(session_name
, &domains
);
821 ERR("%s", lttng_strerror(ret
));
825 for (i
= 0; i
< nb_domain
; i
++) {
826 switch (domains
[i
].type
) {
827 case LTTNG_DOMAIN_KERNEL
:
828 MSG("=== Domain: Kernel ===\n");
830 case LTTNG_DOMAIN_UST
:
831 MSG("=== Domain: UST global ===\n");
832 MSG("Buffer type: %s\n",
833 domains
[i
].buf_type
==
834 LTTNG_BUFFER_PER_PID
? "per PID" : "per UID");
837 MSG("=== Domain: Unimplemented ===\n");
841 /* Clean handle before creating a new one */
843 lttng_destroy_handle(handle
);
846 handle
= lttng_create_handle(session_name
, &domains
[i
]);
847 if (handle
== NULL
) {
852 ret
= list_channels(opt_channel
);
863 lttng_destroy_handle(handle
);