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.
29 static int opt_userspace
;
30 static int opt_kernel
;
31 static char *opt_channel
;
32 static int opt_domain
;
34 const char *indent4
= " ";
35 const char *indent6
= " ";
36 const char *indent8
= " ";
42 static struct lttng_handle
*handle
;
44 static struct poptOption long_options
[] = {
45 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
46 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
47 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
48 {"userspace", 'u', POPT_ARG_VAL
, &opt_userspace
, 1, 0, 0},
49 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
50 {"channel", 'c', POPT_ARG_STRING
, &opt_channel
, 0, 0, 0},
51 {"domain", 'd', POPT_ARG_VAL
, &opt_domain
, 1, 0, 0},
58 static void usage(FILE *ofp
)
60 fprintf(ofp
, "usage: lttng list [[-k] [-u] [-p PID] [SESSION [<options>]]]\n");
62 fprintf(ofp
, "With no arguments, list available tracing session(s)\n");
64 fprintf(ofp
, "With -k alone, list available kernel events\n");
65 fprintf(ofp
, "With -u alone, list available userspace events\n");
67 fprintf(ofp
, " -h, --help Show this help\n");
68 fprintf(ofp
, " -k, --kernel Select kernel domain\n");
69 fprintf(ofp
, " -u, --userspace Select user-space domain.\n");
70 fprintf(ofp
, " -p, --pid PID List user-space events by PID\n");
72 fprintf(ofp
, "Options:\n");
73 fprintf(ofp
, " -c, --channel NAME List details of a channel\n");
74 fprintf(ofp
, " -d, --domain List available domain(s)\n");
79 * Get command line from /proc for a specific pid.
81 * On success, return an allocated string pointer to the proc cmdline.
82 * On error, return NULL.
85 static char *get_cmdline_by_pid(pid_t pid
)
90 char path
[24]; /* Can't go bigger than /proc/65535/cmdline */
92 snprintf(path
, sizeof(path
), "/proc/%d/cmdline", pid
);
93 fp
= fopen(path
, "r");
98 /* Caller must free() *cmdline */
99 cmdline
= malloc(PATH_MAX
);
100 ret
= fread(cmdline
, 1, PATH_MAX
, fp
);
102 perror("fread proc list");
112 * Ask for all trace events in the kernel and pretty print them.
114 static int list_kernel_events(void)
117 struct lttng_event
*event_list
;
119 DBG("Getting all tracing events");
121 size
= lttng_list_tracepoints(handle
, &event_list
);
123 ERR("Unable to list kernel events");
127 MSG("Kernel events:\n-------------");
129 for (i
= 0; i
< size
; i
++) {
130 MSG(" %s", event_list
[i
].name
);
139 * List events of channel of session and domain.
141 static int list_events(const char *channel_name
)
144 struct lttng_event
*events
= NULL
;
146 count
= lttng_list_events(handle
, channel_name
, &events
);
152 MSG("\n%sEvents:", indent4
);
154 MSG("%sNone", indent6
);
158 for (i
= 0; i
< count
; i
++) {
159 switch (events
[i
].type
) {
160 case LTTNG_EVENT_TRACEPOINT
:
161 MSG("%s%s (type: tracepoint) [enabled: %d]", indent6
,
162 events
[i
].name
, events
[i
].enabled
);
164 case LTTNG_EVENT_PROBE
:
165 MSG("%s%s (type: probe) [enabled: %d]", indent6
,
166 events
[i
].name
, events
[i
].enabled
);
167 if (events
[i
].attr
.probe
.addr
!= 0) {
168 MSG("%saddr: 0x%" PRIx64
, indent8
, events
[i
].attr
.probe
.addr
);
170 MSG("%soffset: 0x%" PRIx64
, indent8
, events
[i
].attr
.probe
.offset
);
171 MSG("%ssymbol: %s", indent8
, events
[i
].attr
.probe
.symbol_name
);
174 case LTTNG_EVENT_FUNCTION
:
175 case LTTNG_EVENT_FUNCTION_ENTRY
:
176 MSG("%s%s (type: function) [enabled: %d]", indent6
,
177 events
[i
].name
, events
[i
].enabled
);
178 MSG("%ssymbol: \"%s\"", indent8
, events
[i
].attr
.ftrace
.symbol_name
);
180 case LTTNG_EVENT_SYSCALLS
:
181 MSG("%s (type: syscalls) [enabled: %d]", indent6
,
184 case LTTNG_EVENT_NOOP
:
185 MSG("%s (type: noop) [enabled: %d]", indent6
,
204 * Pretty print channel
206 static void print_channel(struct lttng_channel
*channel
)
208 MSG("- %s (enabled: %d):\n", channel
->name
, channel
->enabled
);
210 MSG("%sAttributes:", indent4
);
211 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
212 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
213 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
214 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
215 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
216 switch (channel
->attr
.output
) {
217 case LTTNG_EVENT_SPLICE
:
218 MSG("%soutput: splice()", indent6
);
220 case LTTNG_EVENT_MMAP
:
221 MSG("%soutput: mmap()", indent6
);
227 * List channel(s) of session and domain.
229 * If channel_name is NULL, all channels are listed.
231 static int list_channels(const char *channel_name
)
233 int count
, i
, ret
= CMD_SUCCESS
;
234 unsigned int chan_found
= 0;
235 struct lttng_channel
*channels
= NULL
;
237 DBG("Listing channel(s) (%s)", channel_name
);
239 count
= lttng_list_channels(handle
, &channels
);
243 } else if (count
== 0) {
244 MSG("No channel found");
248 if (channel_name
== NULL
) {
249 MSG("Channels:\n-------------");
252 for (i
= 0; i
< count
; i
++) {
253 if (channel_name
!= NULL
) {
254 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
260 print_channel(&channels
[i
]);
262 /* Listing events per channel */
263 ret
= list_events(channels
[i
].name
);
265 MSG("%s", lttng_get_readable_code(ret
));
273 if (!chan_found
&& channel_name
!= NULL
) {
274 MSG("Channel %s not found", channel_name
);
286 * List available tracing session. List only basic information.
288 * If session_name is NULL, all sessions are listed.
290 static int list_sessions(const char *session_name
)
293 unsigned int session_found
= 0;
294 struct lttng_session
*sessions
;
296 count
= lttng_list_sessions(&sessions
);
297 DBG("Session count %d", count
);
303 if (session_name
== NULL
) {
304 MSG("Available tracing sessions:");
307 for (i
= 0; i
< count
; i
++) {
308 if (session_name
!= NULL
) {
309 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
311 MSG("Tracing session %s:", session_name
);
312 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
318 MSG(" %d) %s (%s)", i
+ 1, sessions
[i
].name
, sessions
[i
].path
);
327 if (!session_found
&& session_name
!= NULL
) {
328 MSG("Session %s not found", session_name
);
331 if (session_name
== NULL
) {
332 MSG("\nUse lttng list <session_name> for more details");
342 * List available domain(s) for a session.
344 static int list_domains(void)
346 int i
, count
, ret
= CMD_SUCCESS
;
347 struct lttng_domain
*domains
= NULL
;
349 MSG("Domains:\n-------------");
351 count
= lttng_list_domains(handle
, &domains
);
355 } else if (count
== 0) {
360 for (i
= 0; i
< count
; i
++) {
361 switch (domains
[i
].type
) {
362 case LTTNG_DOMAIN_KERNEL
:
377 * The 'list <options>' first level command
379 int cmd_list(int argc
, const char **argv
)
381 int opt
, i
, ret
= CMD_SUCCESS
;
382 const char *session_name
;
383 static poptContext pc
;
384 struct lttng_domain domain
;
385 struct lttng_domain
*domains
= NULL
;
392 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
393 poptReadDefaultConfig(pc
, 0);
395 while ((opt
= poptGetNextOpt(pc
)) != -1) {
407 if (opt_userspace
|| opt_pid
!= 0) {
408 MSG("*** Userspace tracing not implemented ***\n");
411 /* Get session name (trailing argument) */
412 session_name
= poptGetArg(pc
);
413 DBG("Session name: %s", session_name
);
416 domain
.type
= LTTNG_DOMAIN_KERNEL
;
419 handle
= lttng_create_handle(session_name
, &domain
);
420 if (handle
== NULL
) {
424 if (session_name
== NULL
) {
426 ret
= list_kernel_events();
431 ret
= list_sessions(NULL
);
437 /* List session attributes */
438 ret
= list_sessions(session_name
);
445 ret
= list_domains();
450 /* Channel listing */
451 ret
= list_channels(opt_channel
);
455 } else if (opt_userspace
) {
456 /* TODO: Userspace domain */
458 /* We want all domain(s) */
459 ret
= lttng_list_domains(handle
, &domains
);
464 for (i
= 0; i
< ret
; i
++) {
465 switch (domains
[i
].type
) {
466 case LTTNG_DOMAIN_KERNEL
:
467 MSG("=== Domain: Kernel ===\n");
470 MSG("=== Domain: Unimplemented ===\n");
474 /* Clean handle before creating a new one */
475 lttng_destroy_handle(handle
);
477 handle
= lttng_create_handle(session_name
, &domains
[i
]);
478 if (handle
== NULL
) {
482 ret
= list_channels(opt_channel
);
494 lttng_destroy_handle(handle
);