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
;
147 static const char *loglevel_string(int value
)
152 case LTTNG_LOGLEVEL_EMERG
:
153 return "TRACE_EMERG";
154 case LTTNG_LOGLEVEL_ALERT
:
155 return "TRACE_ALERT";
156 case LTTNG_LOGLEVEL_CRIT
:
158 case LTTNG_LOGLEVEL_ERR
:
160 case LTTNG_LOGLEVEL_WARNING
:
161 return "TRACE_WARNING";
162 case LTTNG_LOGLEVEL_NOTICE
:
163 return "TRACE_NOTICE";
164 case LTTNG_LOGLEVEL_INFO
:
166 case LTTNG_LOGLEVEL_DEBUG_SYSTEM
:
167 return "TRACE_DEBUG_SYSTEM";
168 case LTTNG_LOGLEVEL_DEBUG_PROGRAM
:
169 return "TRACE_DEBUG_PROGRAM";
170 case LTTNG_LOGLEVEL_DEBUG_PROCESS
:
171 return "TRACE_DEBUG_PROCESS";
172 case LTTNG_LOGLEVEL_DEBUG_MODULE
:
173 return "TRACE_DEBUG_MODULE";
174 case LTTNG_LOGLEVEL_DEBUG_UNIT
:
175 return "TRACE_DEBUG_UNIT";
176 case LTTNG_LOGLEVEL_DEBUG_FUNCTION
:
177 return "TRACE_DEBUG_FUNCTION";
178 case LTTNG_LOGLEVEL_DEBUG_LINE
:
179 return "TRACE_DEBUG_LINE";
180 case LTTNG_LOGLEVEL_DEBUG
:
181 return "TRACE_DEBUG";
183 return "<<UNKNOWN>>";
188 * Pretty print single event.
190 static void print_events(struct lttng_event
*event
)
192 switch (event
->type
) {
193 case LTTNG_EVENT_TRACEPOINT
:
195 if (event
->loglevel
!= -1) {
196 MSG("%s%s (loglevel: %s (%d)) (type: tracepoint)%s",
199 loglevel_string(event
->loglevel
),
201 enabled_string(event
->enabled
));
203 MSG("%s%s (type: tracepoint)%s",
206 enabled_string(event
->enabled
));
210 case LTTNG_EVENT_PROBE
:
211 MSG("%s%s (type: probe)%s", indent6
,
212 event
->name
, enabled_string(event
->enabled
));
213 if (event
->attr
.probe
.addr
!= 0) {
214 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
216 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
217 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
220 case LTTNG_EVENT_FUNCTION
:
221 case LTTNG_EVENT_FUNCTION_ENTRY
:
222 MSG("%s%s (type: function)%s", indent6
,
223 event
->name
, enabled_string(event
->enabled
));
224 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
226 case LTTNG_EVENT_SYSCALL
:
227 MSG("%ssyscalls (type: syscall)%s", indent6
,
228 enabled_string(event
->enabled
));
230 case LTTNG_EVENT_NOOP
:
231 MSG("%s (type: noop)%s", indent6
,
232 enabled_string(event
->enabled
));
234 case LTTNG_EVENT_ALL
:
235 /* We should never have "all" events in list. */
242 * Ask session daemon for all user space tracepoints available.
244 static int list_ust_events(void)
247 struct lttng_domain domain
;
248 struct lttng_handle
*handle
;
249 struct lttng_event
*event_list
;
252 memset(&domain
, 0, sizeof(domain
));
254 DBG("Getting UST tracing events");
256 domain
.type
= LTTNG_DOMAIN_UST
;
258 handle
= lttng_create_handle(NULL
, &domain
);
259 if (handle
== NULL
) {
263 size
= lttng_list_tracepoints(handle
, &event_list
);
265 ERR("Unable to list UST events");
266 lttng_destroy_handle(handle
);
270 MSG("UST events:\n-------------");
276 for (i
= 0; i
< size
; i
++) {
277 if (cur_pid
!= event_list
[i
].pid
) {
278 cur_pid
= event_list
[i
].pid
;
279 MSG("\nPID: %d - Name: %s", cur_pid
, get_cmdline_by_pid(cur_pid
));
281 print_events(&event_list
[i
]);
287 lttng_destroy_handle(handle
);
292 lttng_destroy_handle(handle
);
297 * Ask for all trace events in the kernel and pretty print them.
299 static int list_kernel_events(void)
302 struct lttng_domain domain
;
303 struct lttng_handle
*handle
;
304 struct lttng_event
*event_list
;
306 memset(&domain
, 0, sizeof(domain
));
308 DBG("Getting kernel tracing events");
310 domain
.type
= LTTNG_DOMAIN_KERNEL
;
312 handle
= lttng_create_handle(NULL
, &domain
);
313 if (handle
== NULL
) {
317 size
= lttng_list_tracepoints(handle
, &event_list
);
319 ERR("Unable to list kernel events");
320 lttng_destroy_handle(handle
);
324 MSG("Kernel events:\n-------------");
326 for (i
= 0; i
< size
; i
++) {
327 print_events(&event_list
[i
]);
334 lttng_destroy_handle(handle
);
338 lttng_destroy_handle(handle
);
343 * List events of channel of session and domain.
345 static int list_events(const char *channel_name
)
348 struct lttng_event
*events
= NULL
;
350 count
= lttng_list_events(handle
, channel_name
, &events
);
356 MSG("\n%sEvents:", indent4
);
358 MSG("%sNone\n", indent6
);
362 for (i
= 0; i
< count
; i
++) {
363 print_events(&events
[i
]);
379 * Pretty print channel
381 static void print_channel(struct lttng_channel
*channel
)
383 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
385 MSG("%sAttributes:", indent4
);
386 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
387 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
388 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
389 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
390 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
391 switch (channel
->attr
.output
) {
392 case LTTNG_EVENT_SPLICE
:
393 MSG("%soutput: splice()", indent6
);
395 case LTTNG_EVENT_MMAP
:
396 MSG("%soutput: mmap()", indent6
);
402 * List channel(s) of session and domain.
404 * If channel_name is NULL, all channels are listed.
406 static int list_channels(const char *channel_name
)
408 int count
, i
, ret
= CMD_SUCCESS
;
409 unsigned int chan_found
= 0;
410 struct lttng_channel
*channels
= NULL
;
412 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
414 count
= lttng_list_channels(handle
, &channels
);
418 } else if (count
== 0) {
419 ERR("Channel %s not found", channel_name
);
423 if (channel_name
== NULL
) {
424 MSG("Channels:\n-------------");
427 for (i
= 0; i
< count
; i
++) {
428 if (channel_name
!= NULL
) {
429 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
435 print_channel(&channels
[i
]);
437 /* Listing events per channel */
438 ret
= list_events(channels
[i
].name
);
440 MSG("%s", lttng_strerror(ret
));
448 if (!chan_found
&& channel_name
!= NULL
) {
449 ERR("Channel %s not found", channel_name
);
463 * List available tracing session. List only basic information.
465 * If session_name is NULL, all sessions are listed.
467 static int list_sessions(const char *session_name
)
470 unsigned int session_found
= 0;
471 struct lttng_session
*sessions
;
473 count
= lttng_list_sessions(&sessions
);
474 DBG("Session count %d", count
);
478 } else if (count
== 0) {
479 MSG("Currently no available tracing session");
483 if (session_name
== NULL
) {
484 MSG("Available tracing sessions:");
487 for (i
= 0; i
< count
; i
++) {
488 if (session_name
!= NULL
) {
489 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
491 MSG("Tracing session %s:%s", session_name
, active_string(sessions
[i
].enabled
));
492 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
498 MSG(" %d) %s (%s)%s", i
+ 1, sessions
[i
].name
, sessions
[i
].path
,
499 active_string(sessions
[i
].enabled
));
508 if (!session_found
&& session_name
!= NULL
) {
509 ERR("Session '%s' not found", session_name
);
514 if (session_name
== NULL
) {
515 MSG("\nUse lttng list <session_name> for more details");
526 * List available domain(s) for a session.
528 static int list_domains(const char *session_name
)
530 int i
, count
, ret
= CMD_SUCCESS
;
531 struct lttng_domain
*domains
= NULL
;
533 MSG("Domains:\n-------------");
535 count
= lttng_list_domains(session_name
, &domains
);
539 } else if (count
== 0) {
544 for (i
= 0; i
< count
; i
++) {
545 switch (domains
[i
].type
) {
546 case LTTNG_DOMAIN_KERNEL
:
549 case LTTNG_DOMAIN_UST
:
550 MSG(" - UST global");
565 * The 'list <options>' first level command
567 int cmd_list(int argc
, const char **argv
)
569 int opt
, i
, ret
= CMD_SUCCESS
;
571 const char *session_name
;
572 static poptContext pc
;
573 struct lttng_domain domain
;
574 struct lttng_domain
*domains
= NULL
;
576 memset(&domain
, 0, sizeof(domain
));
584 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
585 poptReadDefaultConfig(pc
, 0);
587 while ((opt
= poptGetNextOpt(pc
)) != -1) {
595 case OPT_LIST_OPTIONS
:
596 list_cmd_options(stdout
, long_options
);
605 /* Get session name (trailing argument) */
606 session_name
= poptGetArg(pc
);
607 DBG2("Session name: %s", session_name
);
610 domain
.type
= LTTNG_DOMAIN_KERNEL
;
611 } else if (opt_userspace
) {
612 DBG2("Listing userspace global domain");
613 domain
.type
= LTTNG_DOMAIN_UST
;
616 if (opt_kernel
|| opt_userspace
) {
617 handle
= lttng_create_handle(session_name
, &domain
);
618 if (handle
== NULL
) {
624 if (session_name
== NULL
) {
625 if (!opt_kernel
&& !opt_userspace
) {
626 ret
= list_sessions(NULL
);
632 ret
= list_kernel_events();
638 ret
= list_ust_events();
644 /* List session attributes */
645 ret
= list_sessions(session_name
);
652 ret
= list_domains(session_name
);
657 /* Channel listing */
658 ret
= list_channels(opt_channel
);
663 /* We want all domain(s) */
664 nb_domain
= lttng_list_domains(session_name
, &domains
);
670 for (i
= 0; i
< nb_domain
; i
++) {
671 switch (domains
[i
].type
) {
672 case LTTNG_DOMAIN_KERNEL
:
673 MSG("=== Domain: Kernel ===\n");
675 case LTTNG_DOMAIN_UST
:
676 MSG("=== Domain: UST global ===\n");
679 MSG("=== Domain: Unimplemented ===\n");
683 /* Clean handle before creating a new one */
685 lttng_destroy_handle(handle
);
688 handle
= lttng_create_handle(session_name
, &domains
[i
]);
689 if (handle
== NULL
) {
694 ret
= list_channels(opt_channel
);
707 lttng_destroy_handle(handle
);