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
);
196 * Pretty print channel
198 static void print_channel(struct lttng_channel
*channel
)
200 MSG("- %s (enabled: %d):\n", channel
->name
, channel
->enabled
);
202 MSG("%sAttributes:", indent4
);
203 MSG("%soverwrite mode: %d", indent6
, channel
->attr
.overwrite
);
204 MSG("%ssubbufers size: %" PRIu64
, indent6
, channel
->attr
.subbuf_size
);
205 MSG("%snumber of subbufers: %" PRIu64
, indent6
, channel
->attr
.num_subbuf
);
206 MSG("%sswitch timer interval: %u", indent6
, channel
->attr
.switch_timer_interval
);
207 MSG("%sread timer interval: %u", indent6
, channel
->attr
.read_timer_interval
);
208 switch (channel
->attr
.output
) {
209 case LTTNG_EVENT_SPLICE
:
210 MSG("%soutput: splice()", indent6
);
212 case LTTNG_EVENT_MMAP
:
213 MSG("%soutput: mmap()", indent6
);
219 * List channel(s) of session and domain.
221 * If channel_name is NULL, all channels are listed.
223 static int list_channels(const char *channel_name
)
225 int count
, i
, ret
= CMD_SUCCESS
;
226 unsigned int chan_found
= 0;
227 struct lttng_channel
*channels
= NULL
;
229 DBG("Listing channel(s) (%s)", channel_name
);
231 count
= lttng_list_channels(handle
, &channels
);
235 } else if (count
== 0) {
236 MSG("No channel found");
240 if (channel_name
== NULL
) {
241 MSG("Channels:\n-------------");
244 for (i
= 0; i
< count
; i
++) {
245 if (channel_name
!= NULL
) {
246 if (strncmp(channels
[i
].name
, channel_name
, NAME_MAX
) == 0) {
252 print_channel(&channels
[i
]);
254 /* Listing events per channel */
255 ret
= list_events(channels
[i
].name
);
257 MSG("%s", lttng_get_readable_code(ret
));
265 if (!chan_found
&& channel_name
!= NULL
) {
266 MSG("Channel %s not found", channel_name
);
278 * List available tracing session. List only basic information.
280 * If session_name is NULL, all sessions are listed.
282 static int list_sessions(const char *session_name
)
285 unsigned int session_found
= 0;
286 struct lttng_session
*sessions
;
288 count
= lttng_list_sessions(&sessions
);
289 DBG("Session count %d", count
);
295 if (session_name
== NULL
) {
296 MSG("Available tracing sessions:");
299 for (i
= 0; i
< count
; i
++) {
300 if (session_name
!= NULL
) {
301 if (strncmp(sessions
[i
].name
, session_name
, NAME_MAX
) == 0) {
303 MSG("Tracing session %s:", session_name
);
304 MSG("%sTrace path: %s\n", indent4
, sessions
[i
].path
);
310 MSG(" %d) %s (%s)", i
+ 1, sessions
[i
].name
, sessions
[i
].path
);
319 if (!session_found
&& session_name
!= NULL
) {
320 MSG("Session %s not found", session_name
);
323 if (session_name
== NULL
) {
324 MSG("\nUse lttng list <session_name> for more details");
334 * List available domain(s) for a session.
336 static int list_domains(void)
338 int i
, count
, ret
= CMD_SUCCESS
;
339 struct lttng_domain
*domains
= NULL
;
341 MSG("Domains:\n-------------");
343 count
= lttng_list_domains(handle
, &domains
);
347 } else if (count
== 0) {
352 for (i
= 0; i
< count
; i
++) {
353 switch (domains
[i
].type
) {
354 case LTTNG_DOMAIN_KERNEL
:
369 * The 'list <options>' first level command
371 int cmd_list(int argc
, const char **argv
)
373 int opt
, i
, ret
= CMD_SUCCESS
;
374 const char *session_name
;
375 static poptContext pc
;
376 struct lttng_domain domain
;
377 struct lttng_domain
*domains
= NULL
;
384 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
385 poptReadDefaultConfig(pc
, 0);
387 while ((opt
= poptGetNextOpt(pc
)) != -1) {
399 if (opt_userspace
|| opt_pid
!= 0) {
400 MSG("*** Userspace tracing not implemented ***\n");
403 /* Get session name (trailing argument) */
404 session_name
= poptGetArg(pc
);
405 DBG("Session name: %s", session_name
);
408 domain
.type
= LTTNG_DOMAIN_KERNEL
;
411 handle
= lttng_create_handle(session_name
, &domain
);
412 if (handle
== NULL
) {
416 if (session_name
== NULL
) {
418 ret
= list_kernel_events();
423 ret
= list_sessions(NULL
);
429 /* List session attributes */
430 ret
= list_sessions(session_name
);
437 ret
= list_domains();
442 /* Channel listing */
443 ret
= list_channels(opt_channel
);
447 } else if (opt_userspace
) {
448 /* TODO: Userspace domain */
450 /* We want all domain(s) */
451 ret
= lttng_list_domains(handle
, &domains
);
456 for (i
= 0; i
< ret
; i
++) {
457 switch (domains
[i
].type
) {
458 case LTTNG_DOMAIN_KERNEL
:
459 MSG("=== Domain: Kernel ===\n");
462 MSG("=== Domain: Unimplemented ===\n");
466 /* Clean handle before creating a new one */
467 lttng_destroy_handle(handle
);
469 handle
= lttng_create_handle(session_name
, &domains
[i
]);
470 if (handle
== NULL
) {
474 ret
= list_channels(opt_channel
);
486 lttng_destroy_handle(handle
);