2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; only version 2
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 #include "../command.h"
29 static int opt_userspace
;
30 static int opt_kernel
;
31 static char *opt_channel
;
32 static int opt_domain
;
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 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
71 static void usage(FILE *ofp
)
73 fprintf(ofp
, "usage: lttng list [OPTIONS] [SESSION [<OPTIONS>]]\n");
75 fprintf(ofp
, "With no arguments, list available tracing session(s)\n");
77 fprintf(ofp
, "Without a session, -k lists available kernel events\n");
78 fprintf(ofp
, "Without a session, -u lists available userspace events\n");
80 fprintf(ofp
, " -h, --help Show this help\n");
81 fprintf(ofp
, " --list-options Simple listing of options\n");
82 fprintf(ofp
, " -k, --kernel Select kernel domain\n");
83 fprintf(ofp
, " -u, --userspace Select user-space domain.\n");
85 fprintf(ofp
, " -p, --pid PID List user-space events by PID\n");
88 fprintf(ofp
, "Session Options:\n");
89 fprintf(ofp
, " -c, --channel NAME List details of a channel\n");
90 fprintf(ofp
, " -d, --domain List available domain(s)\n");
95 * Get command line from /proc for a specific pid.
97 * On success, return an allocated string pointer to the proc cmdline.
98 * On error, return NULL.
100 static char *get_cmdline_by_pid(pid_t pid
)
104 char *cmdline
= NULL
;
105 char path
[24]; /* Can't go bigger than /proc/65535/cmdline */
107 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
108 fp
= fopen(path
, "r");
113 /* Caller must free() *cmdline */
114 cmdline
= malloc(PATH_MAX
);
115 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
117 perror("fread proc list");
126 const char *active_string(int value
)
129 case 0: return " [inactive]";
130 case 1: return " [active]";
132 default: return NULL
;
137 const char *enabled_string(int value
)
140 case 0: return " [disabled]";
141 case 1: return " [enabled]";
143 default: return NULL
;
148 const char *loglevel_string_pre(int loglevel
)
150 if (loglevel
== -1) {
153 return " (loglevel: ";
158 const char *loglevel_string_post(int loglevel
)
160 if (loglevel
== -1) {
167 static const char *loglevel_string(int value
)
172 case LTTNG_LOGLEVEL_EMERG
:
173 return "TRACE_EMERG";
174 case LTTNG_LOGLEVEL_ALERT
:
175 return "TRACE_ALERT";
176 case LTTNG_LOGLEVEL_CRIT
:
178 case LTTNG_LOGLEVEL_ERR
:
180 case LTTNG_LOGLEVEL_WARNING
:
181 return "TRACE_WARNING";
182 case LTTNG_LOGLEVEL_NOTICE
:
183 return "TRACE_NOTICE";
184 case LTTNG_LOGLEVEL_INFO
:
186 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
187 return "TRACE_DEBUG_SYSTEM";
188 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
189 return "TRACE_DEBUG_PROGRAM";
190 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
191 return "TRACE_DEBUG_PROCESS";
192 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
193 return "TRACE_DEBUG_MODULE";
194 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
195 return "TRACE_DEBUG_UNIT";
196 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
197 return "TRACE_DEBUG_FUNCTION";
198 case LTTNG_LOGLEVEL_DEBUG_LINE
:
199 return "TRACE_DEBUG_LINE";
200 case LTTNG_LOGLEVEL_DEBUG
:
201 return "TRACE_DEBUG";
203 return "<<UNKNOWN>>";
208 * Pretty print single event.
210 static void print_events(struct lttng_event
*event
)
212 switch (event
->type
) {
213 case LTTNG_EVENT_TRACEPOINT
:
215 MSG("%s%s%s%s%s (type: tracepoint)%s", indent6
,
217 loglevel_string_pre(event
->loglevel
),
218 loglevel_string(event
->loglevel
),
219 loglevel_string_post(event
->loglevel
),
220 enabled_string(event
->enabled
));
223 case LTTNG_EVENT_PROBE
:
224 MSG("%s%s (type: probe)%s", indent6
,
225 event
->name
, enabled_string(event
->enabled
));
226 if (event
->attr
.probe
.addr
!= 0) {
227 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
229 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
230 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
233 case LTTNG_EVENT_FUNCTION
:
234 case LTTNG_EVENT_FUNCTION_ENTRY
:
235 MSG("%s%s (type: function)%s", indent6
,
236 event
->name
, enabled_string(event
->enabled
));
237 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
239 case LTTNG_EVENT_SYSCALL
:
240 MSG("%ssyscalls (type: syscall)%s", indent6
,
241 enabled_string(event
->enabled
));
243 case LTTNG_EVENT_NOOP
:
244 MSG("%s (type: noop)%s", indent6
,
245 enabled_string(event
->enabled
));
247 case LTTNG_EVENT_ALL
:
248 /* We should never have "all" events in list. */
255 * Ask session daemon for all user space tracepoints available.
257 static int list_ust_events(void)
260 struct lttng_domain domain
;
261 struct lttng_handle
*handle
;
262 struct lttng_event
*event_list
;
265 memset(&domain
, 0, sizeof(domain
));
267 DBG("Getting UST tracing events");
269 domain
.type
= LTTNG_DOMAIN_UST
;
271 handle
= lttng_create_handle(NULL
, &domain
);
272 if (handle
== NULL
) {
276 size
= lttng_list_tracepoints(handle
, &event_list
);
278 ERR("Unable to list UST events");
279 lttng_destroy_handle(handle
);
283 MSG("UST events:\n-------------");
289 for (i
= 0; i
< size
; i
++) {
290 if (cur_pid
!= event_list
[i
].pid
) {
291 cur_pid
= event_list
[i
].pid
;
292 MSG("\nPID: %d - Name: %s", cur_pid
, get_cmdline_by_pid(cur_pid
));
294 print_events(&event_list
[i
]);
300 lttng_destroy_handle(handle
);
305 lttng_destroy_handle(handle
);
310 * Ask for all trace events in the kernel and pretty print them.
312 static int list_kernel_events(void)
315 struct lttng_domain domain
;
316 struct lttng_handle
*handle
;
317 struct lttng_event
*event_list
;
319 memset(&domain
, 0, sizeof(domain
));
321 DBG("Getting kernel tracing events");
323 domain
.type
= LTTNG_DOMAIN_KERNEL
;
325 handle
= lttng_create_handle(NULL
, &domain
);
326 if (handle
== NULL
) {
330 size
= lttng_list_tracepoints(handle
, &event_list
);
332 ERR("Unable to list kernel events");
333 lttng_destroy_handle(handle
);
337 MSG("Kernel events:\n-------------");
339 for (i
= 0; i
< size
; i
++) {
340 print_events(&event_list
[i
]);
347 lttng_destroy_handle(handle
);
351 lttng_destroy_handle(handle
);
356 * List events of channel of session and domain.
358 static int list_events(const char *channel_name
)
361 struct lttng_event
*events
= NULL
;
363 count
= lttng_list_events(handle
, channel_name
, &events
);
369 MSG("\n%sEvents:", indent4
);
371 MSG("%sNone\n", indent6
);
375 for (i
= 0; i
< count
; i
++) {
376 print_events(&events
[i
]);
392 * Pretty print channel
394 static void print_channel(struct lttng_channel
*channel
)
396 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
398 MSG("%sAttributes:", indent4
);
399 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
400 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
401 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
402 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
403 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
404 switch (channel
->attr
.output
) {
405 case LTTNG_EVENT_SPLICE
:
406 MSG("%soutput: splice()", indent6
);
408 case LTTNG_EVENT_MMAP
:
409 MSG("%soutput: mmap()", indent6
);
415 * List channel(s) of session and domain.
417 * If channel_name is NULL, all channels are listed.
419 static int list_channels(const char *channel_name
)
421 int count
, i
, ret
= CMD_SUCCESS
;
422 unsigned int chan_found
= 0;
423 struct lttng_channel
*channels
= NULL
;
425 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
427 count
= lttng_list_channels(handle
, &channels
);
431 } else if (count
== 0) {
432 ERR("Channel %s not found", channel_name
);
436 if (channel_name
== NULL
) {
437 MSG("Channels:\n-------------");
440 for (i
= 0; i
< count
; i
++) {
441 if (channel_name
!= NULL
) {
442 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
448 print_channel(&channels
[i
]);
450 /* Listing events per channel */
451 ret
= list_events(channels
[i
].name
);
453 MSG("%s", lttng_strerror(ret
));
461 if (!chan_found
&& channel_name
!= NULL
) {
462 ERR("Channel %s not found", channel_name
);
476 * List available tracing session. List only basic information.
478 * If session_name is NULL, all sessions are listed.
480 static int list_sessions(const char *session_name
)
483 unsigned int session_found
= 0;
484 struct lttng_session
*sessions
;
486 count
= lttng_list_sessions(&sessions
);
487 DBG("Session count %d", count
);
493 if (session_name
== NULL
) {
494 MSG("Available tracing sessions:");
497 for (i
= 0; i
< count
; i
++) {
498 if (session_name
!= NULL
) {
499 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
501 MSG("Tracing session %s:%s", session_name
, active_string(sessions
[i
].enabled
));
502 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
508 MSG(" %d) %s (%s)%s", i
+ 1, sessions
[i
].name
, sessions
[i
].path
,
509 active_string(sessions
[i
].enabled
));
518 if (!session_found
&& session_name
!= NULL
) {
519 ERR("Session '%s' not found", session_name
);
524 if (session_name
== NULL
) {
525 MSG("\nUse lttng list <session_name> for more details");
535 * List available domain(s) for a session.
537 static int list_domains(const char *session_name
)
539 int i
, count
, ret
= CMD_SUCCESS
;
540 struct lttng_domain
*domains
= NULL
;
542 MSG("Domains:\n-------------");
544 count
= lttng_list_domains(session_name
, &domains
);
548 } else if (count
== 0) {
553 for (i
= 0; i
< count
; i
++) {
554 switch (domains
[i
].type
) {
555 case LTTNG_DOMAIN_KERNEL
:
558 case LTTNG_DOMAIN_UST
:
559 MSG(" - UST global");
574 * The 'list <options>' first level command
576 int cmd_list(int argc
, const char **argv
)
578 int opt
, i
, ret
= CMD_SUCCESS
;
580 const char *session_name
;
581 static poptContext pc
;
582 struct lttng_domain domain
;
583 struct lttng_domain
*domains
= NULL
;
585 memset(&domain
, 0, sizeof(domain
));
593 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
594 poptReadDefaultConfig(pc
, 0);
596 while ((opt
= poptGetNextOpt(pc
)) != -1) {
604 case OPT_LIST_OPTIONS
:
605 list_cmd_options(stdout
, long_options
);
614 /* Get session name (trailing argument) */
615 session_name
= poptGetArg(pc
);
616 DBG2("Session name: %s", session_name
);
619 domain
.type
= LTTNG_DOMAIN_KERNEL
;
620 } else if (opt_userspace
) {
621 DBG2("Listing userspace global domain");
622 domain
.type
= LTTNG_DOMAIN_UST
;
625 if (opt_kernel
|| opt_userspace
) {
626 handle
= lttng_create_handle(session_name
, &domain
);
627 if (handle
== NULL
) {
633 if (session_name
== NULL
) {
634 if (!opt_kernel
&& !opt_userspace
) {
635 ret
= list_sessions(NULL
);
641 ret
= list_kernel_events();
647 ret
= list_ust_events();
653 /* List session attributes */
654 ret
= list_sessions(session_name
);
661 ret
= list_domains(session_name
);
666 /* Channel listing */
667 ret
= list_channels(opt_channel
);
672 /* We want all domain(s) */
673 nb_domain
= lttng_list_domains(session_name
, &domains
);
679 for (i
= 0; i
< nb_domain
; i
++) {
680 switch (domains
[i
].type
) {
681 case LTTNG_DOMAIN_KERNEL
:
682 MSG("=== Domain: Kernel ===\n");
684 case LTTNG_DOMAIN_UST
:
685 MSG("=== Domain: UST global ===\n");
688 MSG("=== Domain: Unimplemented ===\n");
692 /* Clean handle before creating a new one */
694 lttng_destroy_handle(handle
);
697 handle
= lttng_create_handle(session_name
, &domains
[i
]);
698 if (handle
== NULL
) {
703 ret
= list_channels(opt_channel
);
716 lttng_destroy_handle(handle
);