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 [<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
[24]; /* 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
);
117 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
119 perror("fread proc list");
128 const char *active_string(int value
)
131 case 0: return " [inactive]";
132 case 1: return " [active]";
134 default: return NULL
;
139 const char *enabled_string(int value
)
142 case 0: return " [disabled]";
143 case 1: return " [enabled]";
145 default: return NULL
;
150 const char *filter_string(int value
)
153 case 1: return " [with filter]";
158 static const char *loglevel_string(int value
)
163 case LTTNG_LOGLEVEL_EMERG
:
164 return "TRACE_EMERG";
165 case LTTNG_LOGLEVEL_ALERT
:
166 return "TRACE_ALERT";
167 case LTTNG_LOGLEVEL_CRIT
:
169 case LTTNG_LOGLEVEL_ERR
:
171 case LTTNG_LOGLEVEL_WARNING
:
172 return "TRACE_WARNING";
173 case LTTNG_LOGLEVEL_NOTICE
:
174 return "TRACE_NOTICE";
175 case LTTNG_LOGLEVEL_INFO
:
177 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
178 return "TRACE_DEBUG_SYSTEM";
179 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
180 return "TRACE_DEBUG_PROGRAM";
181 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
182 return "TRACE_DEBUG_PROCESS";
183 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
184 return "TRACE_DEBUG_MODULE";
185 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
186 return "TRACE_DEBUG_UNIT";
187 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
188 return "TRACE_DEBUG_FUNCTION";
189 case LTTNG_LOGLEVEL_DEBUG_LINE
:
190 return "TRACE_DEBUG_LINE";
191 case LTTNG_LOGLEVEL_DEBUG
:
192 return "TRACE_DEBUG";
194 return "<<UNKNOWN>>";
199 * Pretty print single event.
201 static void print_events(struct lttng_event
*event
)
203 switch (event
->type
) {
204 case LTTNG_EVENT_TRACEPOINT
:
206 if (event
->loglevel
!= -1) {
207 MSG("%s%s (loglevel: %s (%d)) (type: tracepoint)%s%s",
210 loglevel_string(event
->loglevel
),
212 enabled_string(event
->enabled
),
213 filter_string(event
->filter
));
215 MSG("%s%s (type: tracepoint)%s%s",
218 enabled_string(event
->enabled
),
219 filter_string(event
->filter
));
223 case LTTNG_EVENT_PROBE
:
224 MSG("%s%s (type: probe)%s%s", indent6
,
225 event
->name
, enabled_string(event
->enabled
),
226 filter_string(event
->filter
));
227 if (event
->attr
.probe
.addr
!= 0) {
228 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
230 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
231 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
234 case LTTNG_EVENT_FUNCTION
:
235 case LTTNG_EVENT_FUNCTION_ENTRY
:
236 MSG("%s%s (type: function)%s%s", indent6
,
237 event
->name
, enabled_string(event
->enabled
),
238 filter_string(event
->filter
));
239 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
241 case LTTNG_EVENT_SYSCALL
:
242 MSG("%ssyscalls (type: syscall)%s%s", indent6
,
243 enabled_string(event
->enabled
),
244 filter_string(event
->filter
));
246 case LTTNG_EVENT_NOOP
:
247 MSG("%s (type: noop)%s%s", indent6
,
248 enabled_string(event
->enabled
),
249 filter_string(event
->filter
));
251 case LTTNG_EVENT_ALL
:
252 /* We should never have "all" events in list. */
258 static const char *field_type(struct lttng_event_field
*field
)
260 switch(field
->type
) {
261 case LTTNG_EVENT_FIELD_INTEGER
:
263 case LTTNG_EVENT_FIELD_ENUM
:
265 case LTTNG_EVENT_FIELD_FLOAT
:
267 case LTTNG_EVENT_FIELD_STRING
:
269 case LTTNG_EVENT_FIELD_OTHER
:
270 default: /* fall-through */
276 * Pretty print single event fields.
278 static void print_event_field(struct lttng_event_field
*field
)
280 if (!field
->field_name
[0]) {
283 MSG("%sfield: %s (%s)%s", indent8
, field
->field_name
,
284 field_type(field
), field
->nowrite
? " [no write]" : "");
288 * Ask session daemon for all user space tracepoints available.
290 static int list_ust_events(void)
293 struct lttng_domain domain
;
294 struct lttng_handle
*handle
;
295 struct lttng_event
*event_list
;
297 char *cmdline
= NULL
;
299 memset(&domain
, 0, sizeof(domain
));
301 DBG("Getting UST tracing events");
303 domain
.type
= LTTNG_DOMAIN_UST
;
305 handle
= lttng_create_handle(NULL
, &domain
);
306 if (handle
== NULL
) {
310 size
= lttng_list_tracepoints(handle
, &event_list
);
312 ERR("Unable to list UST events");
313 lttng_destroy_handle(handle
);
317 MSG("UST events:\n-------------");
323 for (i
= 0; i
< size
; i
++) {
324 if (cur_pid
!= event_list
[i
].pid
) {
325 cur_pid
= event_list
[i
].pid
;
326 cmdline
= get_cmdline_by_pid(cur_pid
);
327 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
330 print_events(&event_list
[i
]);
336 lttng_destroy_handle(handle
);
341 lttng_destroy_handle(handle
);
346 * Ask session daemon for all user space tracepoint fields available.
348 static int list_ust_event_fields(void)
351 struct lttng_domain domain
;
352 struct lttng_handle
*handle
;
353 struct lttng_event_field
*event_field_list
;
355 char *cmdline
= NULL
;
357 struct lttng_event cur_event
;
359 memset(&domain
, 0, sizeof(domain
));
360 memset(&cur_event
, 0, sizeof(cur_event
));
362 DBG("Getting UST tracing event fields");
364 domain
.type
= LTTNG_DOMAIN_UST
;
366 handle
= lttng_create_handle(NULL
, &domain
);
367 if (handle
== NULL
) {
371 size
= lttng_list_tracepoint_fields(handle
, &event_field_list
);
373 ERR("Unable to list UST event fields");
374 lttng_destroy_handle(handle
);
378 MSG("UST events:\n-------------");
384 for (i
= 0; i
< size
; i
++) {
385 if (cur_pid
!= event_field_list
[i
].event
.pid
) {
386 cur_pid
= event_field_list
[i
].event
.pid
;
387 cmdline
= get_cmdline_by_pid(cur_pid
);
388 MSG("\nPID: %d - Name: %s", cur_pid
, cmdline
);
391 if (strcmp(cur_event
.name
, event_field_list
[i
].event
.name
) != 0) {
392 print_events(&event_field_list
[i
].event
);
393 memcpy(&cur_event
, &event_field_list
[i
].event
,
396 print_event_field(&event_field_list
[i
]);
401 free(event_field_list
);
402 lttng_destroy_handle(handle
);
407 lttng_destroy_handle(handle
);
412 * Ask for all trace events in the kernel and pretty print them.
414 static int list_kernel_events(void)
417 struct lttng_domain domain
;
418 struct lttng_handle
*handle
;
419 struct lttng_event
*event_list
;
421 memset(&domain
, 0, sizeof(domain
));
423 DBG("Getting kernel tracing events");
425 domain
.type
= LTTNG_DOMAIN_KERNEL
;
427 handle
= lttng_create_handle(NULL
, &domain
);
428 if (handle
== NULL
) {
432 size
= lttng_list_tracepoints(handle
, &event_list
);
434 ERR("Unable to list kernel events");
435 lttng_destroy_handle(handle
);
439 MSG("Kernel events:\n-------------");
441 for (i
= 0; i
< size
; i
++) {
442 print_events(&event_list
[i
]);
449 lttng_destroy_handle(handle
);
453 lttng_destroy_handle(handle
);
458 * List events of channel of session and domain.
460 static int list_events(const char *channel_name
)
463 struct lttng_event
*events
= NULL
;
465 count
= lttng_list_events(handle
, channel_name
, &events
);
471 MSG("\n%sEvents:", indent4
);
473 MSG("%sNone\n", indent6
);
477 for (i
= 0; i
< count
; i
++) {
478 print_events(&events
[i
]);
492 * Pretty print channel
494 static void print_channel(struct lttng_channel
*channel
)
496 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
498 MSG("%sAttributes:", indent4
);
499 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
500 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
501 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
502 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
503 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
504 switch (channel
->attr
.output
) {
505 case LTTNG_EVENT_SPLICE
:
506 MSG("%soutput: splice()", indent6
);
508 case LTTNG_EVENT_MMAP
:
509 MSG("%soutput: mmap()", indent6
);
515 * List channel(s) of session and domain.
517 * If channel_name is NULL, all channels are listed.
519 static int list_channels(const char *channel_name
)
521 int count
, i
, ret
= CMD_SUCCESS
;
522 unsigned int chan_found
= 0;
523 struct lttng_channel
*channels
= NULL
;
525 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
527 count
= lttng_list_channels(handle
, &channels
);
530 case LTTNG_ERR_KERN_CHAN_NOT_FOUND
:
532 WARN("No kernel channel");
535 /* We had a real error */
537 ERR("%s", lttng_strerror(ret
));
542 if (channel_name
== NULL
) {
543 MSG("Channels:\n-------------");
546 for (i
= 0; i
< count
; i
++) {
547 if (channel_name
!= NULL
) {
548 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
554 print_channel(&channels
[i
]);
556 /* Listing events per channel */
557 ret
= list_events(channels
[i
].name
);
559 MSG("%s", lttng_strerror(ret
));
567 if (!chan_found
&& channel_name
!= NULL
) {
568 ERR("Channel %s not found", channel_name
);
582 * List available tracing session. List only basic information.
584 * If session_name is NULL, all sessions are listed.
586 static int list_sessions(const char *session_name
)
589 unsigned int session_found
= 0;
590 struct lttng_session
*sessions
;
592 count
= lttng_list_sessions(&sessions
);
593 DBG("Session count %d", count
);
596 ERR("%s", lttng_strerror(ret
));
598 } else if (count
== 0) {
599 MSG("Currently no available tracing session");
603 if (session_name
== NULL
) {
604 MSG("Available tracing sessions:");
607 for (i
= 0; i
< count
; i
++) {
608 if (session_name
!= NULL
) {
609 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
611 MSG("Tracing session %s:%s", session_name
, active_string(sessions
[i
].enabled
));
612 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
618 MSG(" %d) %s (%s)%s", i
+ 1, sessions
[i
].name
, sessions
[i
].path
,
619 active_string(sessions
[i
].enabled
));
628 if (!session_found
&& session_name
!= NULL
) {
629 ERR("Session '%s' not found", session_name
);
634 if (session_name
== NULL
) {
635 MSG("\nUse lttng list <session_name> for more details");
646 * List available domain(s) for a session.
648 static int list_domains(const char *session_name
)
650 int i
, count
, ret
= CMD_SUCCESS
;
651 struct lttng_domain
*domains
= NULL
;
653 MSG("Domains:\n-------------");
655 count
= lttng_list_domains(session_name
, &domains
);
659 } else if (count
== 0) {
664 for (i
= 0; i
< count
; i
++) {
665 switch (domains
[i
].type
) {
666 case LTTNG_DOMAIN_KERNEL
:
669 case LTTNG_DOMAIN_UST
:
670 MSG(" - UST global");
685 * The 'list <options>' first level command
687 int cmd_list(int argc
, const char **argv
)
689 int opt
, ret
= CMD_SUCCESS
;
690 const char *session_name
;
691 static poptContext pc
;
692 struct lttng_domain domain
;
693 struct lttng_domain
*domains
= NULL
;
695 memset(&domain
, 0, sizeof(domain
));
703 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
704 poptReadDefaultConfig(pc
, 0);
706 while ((opt
= poptGetNextOpt(pc
)) != -1) {
714 case OPT_LIST_OPTIONS
:
715 list_cmd_options(stdout
, long_options
);
724 /* Get session name (trailing argument) */
725 session_name
= poptGetArg(pc
);
726 DBG2("Session name: %s", session_name
);
729 domain
.type
= LTTNG_DOMAIN_KERNEL
;
730 } else if (opt_userspace
) {
731 DBG2("Listing userspace global domain");
732 domain
.type
= LTTNG_DOMAIN_UST
;
735 if (opt_kernel
|| opt_userspace
) {
736 handle
= lttng_create_handle(session_name
, &domain
);
737 if (handle
== NULL
) {
743 if (session_name
== NULL
) {
744 if (!opt_kernel
&& !opt_userspace
) {
745 ret
= list_sessions(NULL
);
751 ret
= list_kernel_events();
759 ret
= list_ust_event_fields();
761 ret
= list_ust_events();
769 /* List session attributes */
770 ret
= list_sessions(session_name
);
777 ret
= list_domains(session_name
);
782 /* Channel listing */
783 ret
= list_channels(opt_channel
);
790 /* We want all domain(s) */
791 nb_domain
= lttng_list_domains(session_name
, &domains
);
797 for (i
= 0; i
< nb_domain
; i
++) {
798 switch (domains
[i
].type
) {
799 case LTTNG_DOMAIN_KERNEL
:
800 MSG("=== Domain: Kernel ===\n");
802 case LTTNG_DOMAIN_UST
:
803 MSG("=== Domain: UST global ===\n");
806 MSG("=== Domain: Unimplemented ===\n");
810 /* Clean handle before creating a new one */
812 lttng_destroy_handle(handle
);
815 handle
= lttng_create_handle(session_name
, &domains
[i
]);
816 if (handle
== NULL
) {
821 ret
= list_channels(opt_channel
);
832 lttng_destroy_handle(handle
);