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
)
171 case 0: return "TRACE_EMERG";
172 case 1: return "TRACE_ALERT";
173 case 2: return "TRACE_CRIT";
174 case 3: return "TRACE_ERR";
175 case 4: return "TRACE_WARNING";
176 case 5: return "TRACE_NOTICE";
177 case 6: return "TRACE_INFO";
178 case 7: return "TRACE_DEBUG_SYSTEM";
179 case 8: return "TRACE_DEBUG_PROGRAM";
180 case 9: return "TRACE_DEBUG_PROCESS";
181 case 10: return "TRACE_DEBUG_MODULE";
182 case 11: return "TRACE_DEBUG_UNIT";
183 case 12: return "TRACE_DEBUG_FUNCTION";
184 case 13: return "TRACE_DEBUG_LINE";
185 case 14: return "TRACE_DEBUG";
186 default: return "<<UNKNOWN>>";
191 * Pretty print single event.
193 static void print_events(struct lttng_event
*event
)
195 switch (event
->type
) {
196 case LTTNG_EVENT_TRACEPOINT
:
198 MSG("%s%s%s%s%s (type: tracepoint)%s", indent6
,
200 loglevel_string_pre(event
->loglevel
),
201 loglevel_string(event
->loglevel
),
202 loglevel_string_post(event
->loglevel
),
203 enabled_string(event
->enabled
));
206 case LTTNG_EVENT_PROBE
:
207 MSG("%s%s (type: probe)%s", indent6
,
208 event
->name
, enabled_string(event
->enabled
));
209 if (event
->attr
.probe
.addr
!= 0) {
210 MSG("%saddr: 0x%" PRIx64
, indent8
, event
->attr
.probe
.addr
);
212 MSG("%soffset: 0x%" PRIx64
, indent8
, event
->attr
.probe
.offset
);
213 MSG("%ssymbol: %s", indent8
, event
->attr
.probe
.symbol_name
);
216 case LTTNG_EVENT_FUNCTION
:
217 case LTTNG_EVENT_FUNCTION_ENTRY
:
218 MSG("%s%s (type: function)%s", indent6
,
219 event
->name
, enabled_string(event
->enabled
));
220 MSG("%ssymbol: \"%s\"", indent8
, event
->attr
.ftrace
.symbol_name
);
222 case LTTNG_EVENT_SYSCALL
:
223 MSG("%ssyscalls (type: syscall)%s", indent6
,
224 enabled_string(event
->enabled
));
226 case LTTNG_EVENT_NOOP
:
227 MSG("%s (type: noop)%s", indent6
,
228 enabled_string(event
->enabled
));
230 case LTTNG_EVENT_ALL
:
231 /* We should never have "all" events in list. */
238 * Ask session daemon for all user space tracepoints available.
240 static int list_ust_events(void)
243 struct lttng_domain domain
;
244 struct lttng_handle
*handle
;
245 struct lttng_event
*event_list
;
248 memset(&domain
, 0, sizeof(domain
));
250 DBG("Getting UST tracing events");
252 domain
.type
= LTTNG_DOMAIN_UST
;
254 handle
= lttng_create_handle(NULL
, &domain
);
255 if (handle
== NULL
) {
259 size
= lttng_list_tracepoints(handle
, &event_list
);
261 ERR("Unable to list UST events");
262 lttng_destroy_handle(handle
);
266 MSG("UST events:\n-------------");
272 for (i
= 0; i
< size
; i
++) {
273 if (cur_pid
!= event_list
[i
].pid
) {
274 cur_pid
= event_list
[i
].pid
;
275 MSG("\nPID: %d - Name: %s", cur_pid
, get_cmdline_by_pid(cur_pid
));
277 print_events(&event_list
[i
]);
283 lttng_destroy_handle(handle
);
288 lttng_destroy_handle(handle
);
293 * Ask for all trace events in the kernel and pretty print them.
295 static int list_kernel_events(void)
298 struct lttng_domain domain
;
299 struct lttng_handle
*handle
;
300 struct lttng_event
*event_list
;
302 memset(&domain
, 0, sizeof(domain
));
304 DBG("Getting kernel tracing events");
306 domain
.type
= LTTNG_DOMAIN_KERNEL
;
308 handle
= lttng_create_handle(NULL
, &domain
);
309 if (handle
== NULL
) {
313 size
= lttng_list_tracepoints(handle
, &event_list
);
315 ERR("Unable to list kernel events");
316 lttng_destroy_handle(handle
);
320 MSG("Kernel events:\n-------------");
322 for (i
= 0; i
< size
; i
++) {
323 print_events(&event_list
[i
]);
330 lttng_destroy_handle(handle
);
334 lttng_destroy_handle(handle
);
339 * List events of channel of session and domain.
341 static int list_events(const char *channel_name
)
344 struct lttng_event
*events
= NULL
;
346 count
= lttng_list_events(handle
, channel_name
, &events
);
352 MSG("\n%sEvents:", indent4
);
354 MSG("%sNone\n", indent6
);
358 for (i
= 0; i
< count
; i
++) {
359 print_events(&events
[i
]);
375 * Pretty print channel
377 static void print_channel(struct lttng_channel
*channel
)
379 MSG("- %s:%s\n", channel
->name
, enabled_string(channel
->enabled
));
381 MSG("%sAttributes:", indent4
);
382 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
383 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
384 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
385 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
386 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
387 switch (channel
->attr
.output
) {
388 case LTTNG_EVENT_SPLICE
:
389 MSG("%soutput: splice()", indent6
);
391 case LTTNG_EVENT_MMAP
:
392 MSG("%soutput: mmap()", indent6
);
398 * List channel(s) of session and domain.
400 * If channel_name is NULL, all channels are listed.
402 static int list_channels(const char *channel_name
)
404 int count
, i
, ret
= CMD_SUCCESS
;
405 unsigned int chan_found
= 0;
406 struct lttng_channel
*channels
= NULL
;
408 DBG("Listing channel(s) (%s)", channel_name
? : "<all>");
410 count
= lttng_list_channels(handle
, &channels
);
414 } else if (count
== 0) {
415 ERR("Channel %s not found", channel_name
);
419 if (channel_name
== NULL
) {
420 MSG("Channels:\n-------------");
423 for (i
= 0; i
< count
; i
++) {
424 if (channel_name
!= NULL
) {
425 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
431 print_channel(&channels
[i
]);
433 /* Listing events per channel */
434 ret
= list_events(channels
[i
].name
);
436 MSG("%s", lttng_strerror(ret
));
444 if (!chan_found
&& channel_name
!= NULL
) {
445 ERR("Channel %s not found", channel_name
);
459 * List available tracing session. List only basic information.
461 * If session_name is NULL, all sessions are listed.
463 static int list_sessions(const char *session_name
)
466 unsigned int session_found
= 0;
467 struct lttng_session
*sessions
;
469 count
= lttng_list_sessions(&sessions
);
470 DBG("Session count %d", count
);
476 if (session_name
== NULL
) {
477 MSG("Available tracing sessions:");
480 for (i
= 0; i
< count
; i
++) {
481 if (session_name
!= NULL
) {
482 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
484 MSG("Tracing session %s:%s", session_name
, active_string(sessions
[i
].enabled
));
485 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
491 MSG(" %d) %s (%s)%s", i
+ 1, sessions
[i
].name
, sessions
[i
].path
,
492 active_string(sessions
[i
].enabled
));
501 if (!session_found
&& session_name
!= NULL
) {
502 ERR("Session '%s' not found", session_name
);
507 if (session_name
== NULL
) {
508 MSG("\nUse lttng list <session_name> for more details");
518 * List available domain(s) for a session.
520 static int list_domains(const char *session_name
)
522 int i
, count
, ret
= CMD_SUCCESS
;
523 struct lttng_domain
*domains
= NULL
;
525 MSG("Domains:\n-------------");
527 count
= lttng_list_domains(session_name
, &domains
);
531 } else if (count
== 0) {
536 for (i
= 0; i
< count
; i
++) {
537 switch (domains
[i
].type
) {
538 case LTTNG_DOMAIN_KERNEL
:
541 case LTTNG_DOMAIN_UST
:
542 MSG(" - UST global");
557 * The 'list <options>' first level command
559 int cmd_list(int argc
, const char **argv
)
561 int opt
, i
, ret
= CMD_SUCCESS
;
563 const char *session_name
;
564 static poptContext pc
;
565 struct lttng_domain domain
;
566 struct lttng_domain
*domains
= NULL
;
568 memset(&domain
, 0, sizeof(domain
));
576 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
577 poptReadDefaultConfig(pc
, 0);
579 while ((opt
= poptGetNextOpt(pc
)) != -1) {
587 case OPT_LIST_OPTIONS
:
588 list_cmd_options(stdout
, long_options
);
597 /* Get session name (trailing argument) */
598 session_name
= poptGetArg(pc
);
599 DBG2("Session name: %s", session_name
);
602 domain
.type
= LTTNG_DOMAIN_KERNEL
;
603 } else if (opt_userspace
) {
604 DBG2("Listing userspace global domain");
605 domain
.type
= LTTNG_DOMAIN_UST
;
608 if (opt_kernel
|| opt_userspace
) {
609 handle
= lttng_create_handle(session_name
, &domain
);
610 if (handle
== NULL
) {
616 if (session_name
== NULL
) {
617 if (!opt_kernel
&& !opt_userspace
) {
618 ret
= list_sessions(NULL
);
624 ret
= list_kernel_events();
630 ret
= list_ust_events();
636 /* List session attributes */
637 ret
= list_sessions(session_name
);
644 ret
= list_domains(session_name
);
649 /* Channel listing */
650 ret
= list_channels(opt_channel
);
655 /* We want all domain(s) */
656 nb_domain
= lttng_list_domains(session_name
, &domains
);
662 for (i
= 0; i
< nb_domain
; i
++) {
663 switch (domains
[i
].type
) {
664 case LTTNG_DOMAIN_KERNEL
:
665 MSG("=== Domain: Kernel ===\n");
667 case LTTNG_DOMAIN_UST
:
668 MSG("=== Domain: UST global ===\n");
671 MSG("=== Domain: Unimplemented ===\n");
675 /* Clean handle before creating a new one */
677 lttng_destroy_handle(handle
);
680 handle
= lttng_create_handle(session_name
, &domains
[i
]);
681 if (handle
== NULL
) {
686 ret
= list_channels(opt_channel
);
699 lttng_destroy_handle(handle
);