Fix: possible use after free in consumer
[lttng-tools.git] / src / bin / lttng / commands / list.c
CommitLineData
f3ed775e
DG
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
d14d33bf
AM
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
f3ed775e
DG
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
d14d33bf
AM
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
f3ed775e
DG
16 */
17
18#define _GNU_SOURCE
9f19cc17 19#include <inttypes.h>
f3ed775e
DG
20#include <popt.h>
21#include <stdio.h>
22#include <stdlib.h>
23#include <string.h>
7a3d1328 24#include <assert.h>
f3ed775e 25
c399183f 26#include "../command.h"
f3ed775e 27
9f19cc17
DG
28static int opt_userspace;
29static int opt_kernel;
3c6a091f 30static int opt_jul;
9f19cc17
DG
31static char *opt_channel;
32static int opt_domain;
f37d259d 33static int opt_fields;
d78d6610
DG
34#if 0
35/* Not implemented yet */
36static char *opt_cmd_name;
37static pid_t opt_pid;
38#endif
9f19cc17
DG
39
40const char *indent4 = " ";
41const char *indent6 = " ";
42const char *indent8 = " ";
f3ed775e
DG
43
44enum {
45 OPT_HELP = 1,
eeac7d46 46 OPT_USERSPACE,
679b4943 47 OPT_LIST_OPTIONS,
f3ed775e
DG
48};
49
cd80958d
DG
50static struct lttng_handle *handle;
51
f3ed775e
DG
52static struct poptOption long_options[] = {
53 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
54 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
9f19cc17 55 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
3c6a091f 56 {"jul", 'j', POPT_ARG_VAL, &opt_jul, 1, 0, 0},
d78d6610
DG
57#if 0
58 /* Not implemented yet */
59 {"userspace", 'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
60 {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
61#else
62 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
63#endif
9f19cc17
DG
64 {"channel", 'c', POPT_ARG_STRING, &opt_channel, 0, 0, 0},
65 {"domain", 'd', POPT_ARG_VAL, &opt_domain, 1, 0, 0},
f37d259d 66 {"fields", 'f', POPT_ARG_VAL, &opt_fields, 1, 0, 0},
679b4943 67 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
f3ed775e
DG
68 {0, 0, 0, 0, 0, 0, 0}
69};
70
71/*
72 * usage
73 */
74static void usage(FILE *ofp)
75{
747361fe 76 fprintf(ofp, "usage: lttng list [OPTIONS] [SESSION [SESSION OPTIONS]]\n");
9f19cc17
DG
77 fprintf(ofp, "\n");
78 fprintf(ofp, "With no arguments, list available tracing session(s)\n");
79 fprintf(ofp, "\n");
27221701
DG
80 fprintf(ofp, "Without a session, -k lists available kernel events\n");
81 fprintf(ofp, "Without a session, -u lists available userspace events\n");
9f19cc17
DG
82 fprintf(ofp, "\n");
83 fprintf(ofp, " -h, --help Show this help\n");
27221701 84 fprintf(ofp, " --list-options Simple listing of options\n");
9f19cc17
DG
85 fprintf(ofp, " -k, --kernel Select kernel domain\n");
86 fprintf(ofp, " -u, --userspace Select user-space domain.\n");
3c6a091f 87 fprintf(ofp, " -j, --jul Apply for Java application using JUL\n");
f37d259d 88 fprintf(ofp, " -f, --fields List event fields.\n");
d78d6610 89#if 0
9f19cc17 90 fprintf(ofp, " -p, --pid PID List user-space events by PID\n");
d78d6610 91#endif
f3ed775e 92 fprintf(ofp, "\n");
27221701 93 fprintf(ofp, "Session Options:\n");
9f19cc17
DG
94 fprintf(ofp, " -c, --channel NAME List details of a channel\n");
95 fprintf(ofp, " -d, --domain List available domain(s)\n");
f3ed775e
DG
96 fprintf(ofp, "\n");
97}
98
99/*
9f19cc17 100 * Get command line from /proc for a specific pid.
f3ed775e 101 *
9f19cc17
DG
102 * On success, return an allocated string pointer to the proc cmdline.
103 * On error, return NULL.
f3ed775e
DG
104 */
105static char *get_cmdline_by_pid(pid_t pid)
106{
107 int ret;
108 FILE *fp;
109 char *cmdline = NULL;
110 char path[24]; /* Can't go bigger than /proc/65535/cmdline */
111
112 snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
113 fp = fopen(path, "r");
114 if (fp == NULL) {
115 goto end;
116 }
117
118 /* Caller must free() *cmdline */
119 cmdline = malloc(PATH_MAX);
120 ret = fread(cmdline, 1, PATH_MAX, fp);
f40799e8
DG
121 if (ret < 0) {
122 perror("fread proc list");
123 }
f3ed775e
DG
124 fclose(fp);
125
126end:
127 return cmdline;
128}
b551a063 129
464dd62d
MD
130static
131const char *active_string(int value)
132{
133 switch (value) {
2cbf8fed
DG
134 case 0: return "inactive";
135 case 1: return "active";
464dd62d
MD
136 case -1: return "";
137 default: return NULL;
138 }
139}
140
2cbf8fed
DG
141static const char *snapshot_string(int value)
142{
143 switch (value) {
144 case 1:
145 return " snapshot";
146 default:
147 return "";
148 }
149}
150
464dd62d
MD
151static
152const char *enabled_string(int value)
153{
154 switch (value) {
b09f0429
MD
155 case 0: return " [disabled]";
156 case 1: return " [enabled]";
464dd62d
MD
157 case -1: return "";
158 default: return NULL;
159 }
160}
161
fceb65df
MD
162static
163const char *filter_string(int value)
164{
165 switch (value) {
166 case 1: return " [with filter]";
167 default: return "";
168 }
169}
170
4634f12e
JI
171static
172const char *exclusion_string(int value)
173{
174 switch (value) {
175 case 1: return " [has exclusions]";
176 default: return "";
177 }
178}
179
8005f29a
MD
180static const char *loglevel_string(int value)
181{
182 switch (value) {
255a5dab
MD
183 case -1:
184 return "";
185 case LTTNG_LOGLEVEL_EMERG:
186 return "TRACE_EMERG";
187 case LTTNG_LOGLEVEL_ALERT:
188 return "TRACE_ALERT";
189 case LTTNG_LOGLEVEL_CRIT:
190 return "TRACE_CRIT";
191 case LTTNG_LOGLEVEL_ERR:
192 return "TRACE_ERR";
193 case LTTNG_LOGLEVEL_WARNING:
194 return "TRACE_WARNING";
195 case LTTNG_LOGLEVEL_NOTICE:
196 return "TRACE_NOTICE";
197 case LTTNG_LOGLEVEL_INFO:
198 return "TRACE_INFO";
199 case LTTNG_LOGLEVEL_DEBUG_SYSTEM:
200 return "TRACE_DEBUG_SYSTEM";
201 case LTTNG_LOGLEVEL_DEBUG_PROGRAM:
202 return "TRACE_DEBUG_PROGRAM";
203 case LTTNG_LOGLEVEL_DEBUG_PROCESS:
204 return "TRACE_DEBUG_PROCESS";
205 case LTTNG_LOGLEVEL_DEBUG_MODULE:
206 return "TRACE_DEBUG_MODULE";
207 case LTTNG_LOGLEVEL_DEBUG_UNIT:
208 return "TRACE_DEBUG_UNIT";
209 case LTTNG_LOGLEVEL_DEBUG_FUNCTION:
210 return "TRACE_DEBUG_FUNCTION";
211 case LTTNG_LOGLEVEL_DEBUG_LINE:
212 return "TRACE_DEBUG_LINE";
213 case LTTNG_LOGLEVEL_DEBUG:
214 return "TRACE_DEBUG";
215 default:
216 return "<<UNKNOWN>>";
8005f29a
MD
217 }
218}
219
1f0e17de
DG
220static const char *logleveltype_string(enum lttng_loglevel_type value)
221{
222 switch (value) {
af6bce80
DG
223 case LTTNG_EVENT_LOGLEVEL_ALL:
224 return ":";
1f0e17de 225 case LTTNG_EVENT_LOGLEVEL_RANGE:
af6bce80 226 return " <=";
1f0e17de 227 case LTTNG_EVENT_LOGLEVEL_SINGLE:
af6bce80 228 return " ==";
1f0e17de 229 default:
af6bce80 230 return " <<TYPE UNKN>>";
1f0e17de
DG
231 }
232}
233
b551a063
DG
234/*
235 * Pretty print single event.
236 */
237static void print_events(struct lttng_event *event)
238{
239 switch (event->type) {
240 case LTTNG_EVENT_TRACEPOINT:
e4baff1e 241 {
8b703175 242 if (event->loglevel != -1) {
af6bce80 243 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
8b703175 244 indent6,
81afa345 245 event->name,
1f0e17de 246 logleveltype_string(event->loglevel_type),
8005f29a 247 loglevel_string(event->loglevel),
8b703175 248 event->loglevel,
fceb65df 249 enabled_string(event->enabled),
4634f12e 250 exclusion_string(event->exclusion),
fceb65df 251 filter_string(event->filter));
8b703175 252 } else {
4634f12e 253 MSG("%s%s (type: tracepoint)%s%s%s",
8b703175
MD
254 indent6,
255 event->name,
fceb65df 256 enabled_string(event->enabled),
4634f12e 257 exclusion_string(event->exclusion),
fceb65df 258 filter_string(event->filter));
8b703175 259 }
b551a063 260 break;
e4baff1e 261 }
1896972b
DG
262 case LTTNG_EVENT_FUNCTION:
263 MSG("%s%s (type: function)%s%s", indent6,
264 event->name, enabled_string(event->enabled),
265 filter_string(event->filter));
266 if (event->attr.probe.addr != 0) {
267 MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
268 } else {
269 MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
270 MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
271 }
272 break;
b551a063 273 case LTTNG_EVENT_PROBE:
fceb65df
MD
274 MSG("%s%s (type: probe)%s%s", indent6,
275 event->name, enabled_string(event->enabled),
276 filter_string(event->filter));
b551a063
DG
277 if (event->attr.probe.addr != 0) {
278 MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
279 } else {
280 MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
281 MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
282 }
283 break;
b551a063 284 case LTTNG_EVENT_FUNCTION_ENTRY:
fceb65df
MD
285 MSG("%s%s (type: function)%s%s", indent6,
286 event->name, enabled_string(event->enabled),
287 filter_string(event->filter));
b551a063
DG
288 MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
289 break;
290 case LTTNG_EVENT_SYSCALL:
fceb65df
MD
291 MSG("%ssyscalls (type: syscall)%s%s", indent6,
292 enabled_string(event->enabled),
293 filter_string(event->filter));
b551a063
DG
294 break;
295 case LTTNG_EVENT_NOOP:
fceb65df
MD
296 MSG("%s (type: noop)%s%s", indent6,
297 enabled_string(event->enabled),
298 filter_string(event->filter));
b551a063
DG
299 break;
300 case LTTNG_EVENT_ALL:
301 /* We should never have "all" events in list. */
302 assert(0);
303 break;
304 }
305}
306
f37d259d
MD
307static const char *field_type(struct lttng_event_field *field)
308{
309 switch(field->type) {
310 case LTTNG_EVENT_FIELD_INTEGER:
311 return "integer";
312 case LTTNG_EVENT_FIELD_ENUM:
313 return "enum";
314 case LTTNG_EVENT_FIELD_FLOAT:
315 return "float";
316 case LTTNG_EVENT_FIELD_STRING:
317 return "string";
318 case LTTNG_EVENT_FIELD_OTHER:
319 default: /* fall-through */
320 return "unknown";
321 }
322}
323
324/*
325 * Pretty print single event fields.
326 */
327static void print_event_field(struct lttng_event_field *field)
328{
329 if (!field->field_name[0]) {
330 return;
331 }
d8fbe2a9 332 MSG("%sfield: %s (%s)%s", indent8, field->field_name,
45a32634 333 field_type(field), field->nowrite ? " [no write]" : "");
f37d259d
MD
334}
335
3c6a091f
DG
336static int list_jul_events(void)
337{
338 int i, size;
339 struct lttng_domain domain;
340 struct lttng_handle *handle;
341 struct lttng_event *event_list;
342 pid_t cur_pid = 0;
343 char *cmdline = NULL;
344
345 DBG("Getting JUL tracing events");
346
347 memset(&domain, 0, sizeof(domain));
348 domain.type = LTTNG_DOMAIN_JUL;
349
350 handle = lttng_create_handle(NULL, &domain);
351 if (handle == NULL) {
352 goto error;
353 }
354
355 size = lttng_list_tracepoints(handle, &event_list);
356 if (size < 0) {
357 ERR("Unable to list JUL events: %s", lttng_strerror(size));
358 lttng_destroy_handle(handle);
359 return size;
360 }
361
362 MSG("JUL events (Logger name):\n-------------------------");
363
364 if (size == 0) {
365 MSG("None");
366 }
367
368 for (i = 0; i < size; i++) {
369 if (cur_pid != event_list[i].pid) {
370 cur_pid = event_list[i].pid;
371 cmdline = get_cmdline_by_pid(cur_pid);
372 MSG("\nPID: %d - Name: %s", cur_pid, cmdline);
373 free(cmdline);
374 }
375 MSG("%s- %s", indent6, event_list[i].name);
376 }
377
378 MSG("");
379
380 free(event_list);
381 lttng_destroy_handle(handle);
382
383 return CMD_SUCCESS;
384
385error:
386 lttng_destroy_handle(handle);
387 return -1;
388}
389
b551a063
DG
390/*
391 * Ask session daemon for all user space tracepoints available.
392 */
393static int list_ust_events(void)
394{
395 int i, size;
396 struct lttng_domain domain;
397 struct lttng_handle *handle;
398 struct lttng_event *event_list;
399 pid_t cur_pid = 0;
ea5cbc00 400 char *cmdline = NULL;
b551a063 401
441c16a7
MD
402 memset(&domain, 0, sizeof(domain));
403
b551a063
DG
404 DBG("Getting UST tracing events");
405
406 domain.type = LTTNG_DOMAIN_UST;
407
408 handle = lttng_create_handle(NULL, &domain);
409 if (handle == NULL) {
410 goto error;
411 }
412
413 size = lttng_list_tracepoints(handle, &event_list);
414 if (size < 0) {
60e835ca 415 ERR("Unable to list UST events: %s", lttng_strerror(size));
ef021732 416 lttng_destroy_handle(handle);
b551a063
DG
417 return size;
418 }
419
420 MSG("UST events:\n-------------");
421
422 if (size == 0) {
423 MSG("None");
424 }
425
426 for (i = 0; i < size; i++) {
427 if (cur_pid != event_list[i].pid) {
428 cur_pid = event_list[i].pid;
ea5cbc00
CB
429 cmdline = get_cmdline_by_pid(cur_pid);
430 MSG("\nPID: %d - Name: %s", cur_pid, cmdline);
431 free(cmdline);
b551a063
DG
432 }
433 print_events(&event_list[i]);
434 }
435
436 MSG("");
437
438 free(event_list);
ef021732 439 lttng_destroy_handle(handle);
b551a063
DG
440
441 return CMD_SUCCESS;
442
443error:
ef021732 444 lttng_destroy_handle(handle);
b551a063
DG
445 return -1;
446}
f3ed775e 447
f37d259d
MD
448/*
449 * Ask session daemon for all user space tracepoint fields available.
450 */
451static int list_ust_event_fields(void)
452{
453 int i, size;
454 struct lttng_domain domain;
455 struct lttng_handle *handle;
456 struct lttng_event_field *event_field_list;
457 pid_t cur_pid = 0;
ea5cbc00
CB
458 char *cmdline = NULL;
459
f37d259d
MD
460 struct lttng_event cur_event;
461
462 memset(&domain, 0, sizeof(domain));
463 memset(&cur_event, 0, sizeof(cur_event));
464
465 DBG("Getting UST tracing event fields");
466
467 domain.type = LTTNG_DOMAIN_UST;
468
469 handle = lttng_create_handle(NULL, &domain);
470 if (handle == NULL) {
471 goto error;
472 }
473
474 size = lttng_list_tracepoint_fields(handle, &event_field_list);
475 if (size < 0) {
60e835ca 476 ERR("Unable to list UST event fields: %s", lttng_strerror(size));
f37d259d
MD
477 lttng_destroy_handle(handle);
478 return size;
479 }
480
481 MSG("UST events:\n-------------");
482
483 if (size == 0) {
484 MSG("None");
485 }
486
487 for (i = 0; i < size; i++) {
488 if (cur_pid != event_field_list[i].event.pid) {
489 cur_pid = event_field_list[i].event.pid;
ea5cbc00
CB
490 cmdline = get_cmdline_by_pid(cur_pid);
491 MSG("\nPID: %d - Name: %s", cur_pid, cmdline);
492 free(cmdline);
8966b2b0
DG
493 /* Wipe current event since we are about to print a new PID. */
494 memset(&cur_event, 0, sizeof(cur_event));
f37d259d
MD
495 }
496 if (strcmp(cur_event.name, event_field_list[i].event.name) != 0) {
497 print_events(&event_field_list[i].event);
498 memcpy(&cur_event, &event_field_list[i].event,
499 sizeof(cur_event));
500 }
501 print_event_field(&event_field_list[i]);
502 }
503
504 MSG("");
505
506 free(event_field_list);
507 lttng_destroy_handle(handle);
508
509 return CMD_SUCCESS;
510
511error:
512 lttng_destroy_handle(handle);
513 return -1;
514}
515
f3ed775e 516/*
9f19cc17 517 * Ask for all trace events in the kernel and pretty print them.
f3ed775e 518 */
9f19cc17 519static int list_kernel_events(void)
f3ed775e 520{
9f19cc17 521 int i, size;
b551a063
DG
522 struct lttng_domain domain;
523 struct lttng_handle *handle;
9f19cc17 524 struct lttng_event *event_list;
f3ed775e 525
441c16a7
MD
526 memset(&domain, 0, sizeof(domain));
527
b551a063
DG
528 DBG("Getting kernel tracing events");
529
530 domain.type = LTTNG_DOMAIN_KERNEL;
531
532 handle = lttng_create_handle(NULL, &domain);
533 if (handle == NULL) {
534 goto error;
535 }
f3ed775e 536
cd80958d 537 size = lttng_list_tracepoints(handle, &event_list);
9f19cc17 538 if (size < 0) {
60e835ca 539 ERR("Unable to list kernel events: %s", lttng_strerror(size));
ef021732 540 lttng_destroy_handle(handle);
9f19cc17 541 return size;
f3ed775e
DG
542 }
543
9f19cc17 544 MSG("Kernel events:\n-------------");
f3ed775e 545
9f19cc17 546 for (i = 0; i < size; i++) {
b551a063 547 print_events(&event_list[i]);
f3ed775e
DG
548 }
549
b551a063
DG
550 MSG("");
551
f3ed775e
DG
552 free(event_list);
553
ef021732 554 lttng_destroy_handle(handle);
f3ed775e 555 return CMD_SUCCESS;
b551a063
DG
556
557error:
ef021732 558 lttng_destroy_handle(handle);
b551a063 559 return -1;
f3ed775e
DG
560}
561
3c6a091f
DG
562/*
563 * List JUL events for a specific session using the handle.
564 *
565 * Return CMD_SUCCESS on success else a negative value.
566 */
567static int list_session_jul_events(void)
568{
569 int ret, count, i;
570 struct lttng_event *events = NULL;
571
572 count = lttng_list_events(handle, "", &events);
573 if (count < 0) {
574 ret = count;
575 ERR("%s", lttng_strerror(ret));
576 goto error;
577 }
578
579 MSG("Events (Logger name):\n---------------------");
580 if (count == 0) {
581 MSG("%sNone\n", indent6);
582 goto end;
583 }
584
585 for (i = 0; i < count; i++) {
586 MSG("%s- %s%s", indent4, events[i].name,
587 enabled_string(events[i].enabled));
588 }
589
590 MSG("");
591
592end:
593 free(events);
594 ret = CMD_SUCCESS;
595
596error:
597 return ret;
598}
599
f3ed775e 600/*
9f19cc17 601 * List events of channel of session and domain.
f3ed775e 602 */
cd80958d 603static int list_events(const char *channel_name)
f3ed775e
DG
604{
605 int ret, count, i;
9f19cc17 606 struct lttng_event *events = NULL;
f3ed775e 607
cd80958d 608 count = lttng_list_events(handle, channel_name, &events);
f3ed775e
DG
609 if (count < 0) {
610 ret = count;
60e835ca 611 ERR("%s", lttng_strerror(ret));
f3ed775e
DG
612 goto error;
613 }
614
9f19cc17
DG
615 MSG("\n%sEvents:", indent4);
616 if (count == 0) {
5edd7e09 617 MSG("%sNone\n", indent6);
9f19cc17
DG
618 goto end;
619 }
620
f3ed775e 621 for (i = 0; i < count; i++) {
b551a063 622 print_events(&events[i]);
f3ed775e
DG
623 }
624
9f19cc17 625 MSG("");
f3ed775e 626
9f19cc17 627end:
0e428499 628 free(events);
9f19cc17 629 ret = CMD_SUCCESS;
f3ed775e
DG
630
631error:
632 return ret;
633}
634
635/*
9f19cc17
DG
636 * Pretty print channel
637 */
638static void print_channel(struct lttng_channel *channel)
639{
464dd62d 640 MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
9f19cc17
DG
641
642 MSG("%sAttributes:", indent4);
a5bbe8f6
DG
643 MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
644 MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
9f19cc17 645 MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
a5bbe8f6
DG
646 MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
647 MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
2f785fe7
DG
648 MSG("%strace file count: %" PRIu64, indent6, channel->attr.tracefile_count);
649 MSG("%strace file size (bytes): %" PRIu64, indent6, channel->attr.tracefile_size);
9f19cc17
DG
650 switch (channel->attr.output) {
651 case LTTNG_EVENT_SPLICE:
652 MSG("%soutput: splice()", indent6);
653 break;
654 case LTTNG_EVENT_MMAP:
655 MSG("%soutput: mmap()", indent6);
656 break;
657 }
658}
659
660/*
661 * List channel(s) of session and domain.
f3ed775e 662 *
9f19cc17 663 * If channel_name is NULL, all channels are listed.
f3ed775e 664 */
cd80958d 665static int list_channels(const char *channel_name)
f3ed775e 666{
9f19cc17
DG
667 int count, i, ret = CMD_SUCCESS;
668 unsigned int chan_found = 0;
669 struct lttng_channel *channels = NULL;
f3ed775e 670
3e25cb20 671 DBG("Listing channel(s) (%s)", channel_name ? : "<all>");
9f19cc17 672
cd80958d 673 count = lttng_list_channels(handle, &channels);
f3ed775e 674 if (count < 0) {
c7d620a2
DG
675 switch (-count) {
676 case LTTNG_ERR_KERN_CHAN_NOT_FOUND:
677 ret = CMD_SUCCESS;
678 WARN("No kernel channel");
679 break;
680 default:
681 /* We had a real error */
682 ret = count;
683 ERR("%s", lttng_strerror(ret));
60e835ca 684 break;
c7d620a2 685 }
ae856491 686 goto error_channels;
f3ed775e
DG
687 }
688
9f19cc17
DG
689 if (channel_name == NULL) {
690 MSG("Channels:\n-------------");
691 }
692
693 for (i = 0; i < count; i++) {
694 if (channel_name != NULL) {
695 if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
696 chan_found = 1;
697 } else {
698 continue;
699 }
700 }
701 print_channel(&channels[i]);
702
703 /* Listing events per channel */
cd80958d 704 ret = list_events(channels[i].name);
9f19cc17 705 if (ret < 0) {
60e835ca 706 ERR("%s", lttng_strerror(ret));
9f19cc17
DG
707 }
708
709 if (chan_found) {
710 break;
f3ed775e 711 }
f3ed775e
DG
712 }
713
9f19cc17 714 if (!chan_found && channel_name != NULL) {
ae856491
DG
715 ERR("Channel %s not found", channel_name);
716 goto error;
9f19cc17 717 }
f3ed775e 718
9f19cc17 719 ret = CMD_SUCCESS;
f3ed775e
DG
720
721error:
ae856491
DG
722 free(channels);
723
724error_channels:
f3ed775e
DG
725 return ret;
726}
727
728/*
9f19cc17 729 * List available tracing session. List only basic information.
f3ed775e 730 *
9f19cc17 731 * If session_name is NULL, all sessions are listed.
f3ed775e 732 */
9f19cc17 733static int list_sessions(const char *session_name)
f3ed775e 734{
9f19cc17
DG
735 int ret, count, i;
736 unsigned int session_found = 0;
737 struct lttng_session *sessions;
738
739 count = lttng_list_sessions(&sessions);
740 DBG("Session count %d", count);
741 if (count < 0) {
742 ret = count;
8f3f773f 743 ERR("%s", lttng_strerror(ret));
9f19cc17 744 goto error;
d32fb093
DG
745 } else if (count == 0) {
746 MSG("Currently no available tracing session");
747 goto end;
9f19cc17
DG
748 }
749
750 if (session_name == NULL) {
751 MSG("Available tracing sessions:");
752 }
753
754 for (i = 0; i < count; i++) {
755 if (session_name != NULL) {
756 if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
757 session_found = 1;
2cbf8fed
DG
758 MSG("Tracing session %s: [%s%s]", session_name,
759 active_string(sessions[i].enabled),
760 snapshot_string(sessions[i].snapshot_mode));
2f785fe7
DG
761 MSG("%sTrace path: %s", indent4, sessions[i].path);
762 MSG("%sLive timer interval (usec): %u\n", indent4,
763 sessions[i].live_timer_interval);
9f19cc17
DG
764 break;
765 }
3842aa86 766 } else {
2cbf8fed
DG
767 MSG(" %d) %s (%s) [%s%s]", i + 1, sessions[i].name, sessions[i].path,
768 active_string(sessions[i].enabled),
769 snapshot_string(sessions[i].snapshot_mode));
9f19cc17
DG
770 }
771 }
772
773 free(sessions);
774
775 if (!session_found && session_name != NULL) {
b6913340
DG
776 ERR("Session '%s' not found", session_name);
777 ret = CMD_ERROR;
778 goto error;
9f19cc17
DG
779 }
780
781 if (session_name == NULL) {
6e0de39b 782 MSG("\nUse lttng list <session_name> for more details");
9f19cc17 783 }
f3ed775e 784
d32fb093 785end:
f3ed775e
DG
786 return CMD_SUCCESS;
787
788error:
789 return ret;
790}
f3ed775e
DG
791
792/*
9f19cc17 793 * List available domain(s) for a session.
f3ed775e 794 */
330be774 795static int list_domains(const char *session_name)
f3ed775e 796{
9f19cc17
DG
797 int i, count, ret = CMD_SUCCESS;
798 struct lttng_domain *domains = NULL;
799
800 MSG("Domains:\n-------------");
801
330be774 802 count = lttng_list_domains(session_name, &domains);
9f19cc17
DG
803 if (count < 0) {
804 ret = count;
60e835ca 805 ERR("%s", lttng_strerror(ret));
9f19cc17
DG
806 goto error;
807 } else if (count == 0) {
808 MSG(" None");
809 goto end;
810 }
811
812 for (i = 0; i < count; i++) {
813 switch (domains[i].type) {
814 case LTTNG_DOMAIN_KERNEL:
815 MSG(" - Kernel");
b551a063
DG
816 break;
817 case LTTNG_DOMAIN_UST:
818 MSG(" - UST global");
819 break;
3c6a091f
DG
820 case LTTNG_DOMAIN_JUL:
821 MSG(" - JUL (Java Util Logging)");
822 break;
9f19cc17
DG
823 default:
824 break;
825 }
826 }
827
828end:
829 free(domains);
830
831error:
832 return ret;
f3ed775e 833}
f3ed775e
DG
834
835/*
9f19cc17 836 * The 'list <options>' first level command
f3ed775e
DG
837 */
838int cmd_list(int argc, const char **argv)
839{
c617c0c6 840 int opt, ret = CMD_SUCCESS;
9f19cc17 841 const char *session_name;
f3ed775e 842 static poptContext pc;
9f19cc17
DG
843 struct lttng_domain domain;
844 struct lttng_domain *domains = NULL;
f3ed775e 845
441c16a7
MD
846 memset(&domain, 0, sizeof(domain));
847
9f19cc17 848 if (argc < 1) {
f3ed775e 849 usage(stderr);
ca1c3607 850 ret = CMD_ERROR;
f3ed775e
DG
851 goto end;
852 }
853
854 pc = poptGetContext(NULL, argc, argv, long_options, 0);
855 poptReadDefaultConfig(pc, 0);
856
857 while ((opt = poptGetNextOpt(pc)) != -1) {
858 switch (opt) {
859 case OPT_HELP:
ca1c3607 860 usage(stdout);
f3ed775e 861 goto end;
eeac7d46
MD
862 case OPT_USERSPACE:
863 opt_userspace = 1;
eeac7d46 864 break;
679b4943
SM
865 case OPT_LIST_OPTIONS:
866 list_cmd_options(stdout, long_options);
679b4943 867 goto end;
f3ed775e
DG
868 default:
869 usage(stderr);
870 ret = CMD_UNDEFINED;
871 goto end;
872 }
873 }
874
9f19cc17
DG
875 /* Get session name (trailing argument) */
876 session_name = poptGetArg(pc);
b551a063 877 DBG2("Session name: %s", session_name);
9f19cc17 878
cd80958d
DG
879 if (opt_kernel) {
880 domain.type = LTTNG_DOMAIN_KERNEL;
b551a063
DG
881 } else if (opt_userspace) {
882 DBG2("Listing userspace global domain");
883 domain.type = LTTNG_DOMAIN_UST;
3c6a091f
DG
884 } else if (opt_jul) {
885 DBG2("Listing JUL domain");
886 domain.type = LTTNG_DOMAIN_JUL;
cd80958d
DG
887 }
888
3c6a091f 889 if (opt_kernel || opt_userspace || opt_jul) {
aa5de748
MD
890 handle = lttng_create_handle(session_name, &domain);
891 if (handle == NULL) {
892 ret = CMD_FATAL;
893 goto end;
894 }
cd80958d
DG
895 }
896
9f19cc17 897 if (session_name == NULL) {
3c6a091f 898 if (!opt_kernel && !opt_userspace && !opt_jul) {
b551a063 899 ret = list_sessions(NULL);
b6913340 900 if (ret != 0) {
b551a063
DG
901 goto end;
902 }
903 }
9f19cc17
DG
904 if (opt_kernel) {
905 ret = list_kernel_events();
906 if (ret < 0) {
6191db77 907 ret = CMD_ERROR;
9f19cc17
DG
908 goto end;
909 }
b551a063
DG
910 }
911 if (opt_userspace) {
f37d259d
MD
912 if (opt_fields) {
913 ret = list_ust_event_fields();
914 } else {
915 ret = list_ust_events();
916 }
9f19cc17 917 if (ret < 0) {
6191db77 918 ret = CMD_ERROR;
9f19cc17
DG
919 goto end;
920 }
921 }
3c6a091f
DG
922 if (opt_jul) {
923 ret = list_jul_events();
924 if (ret < 0) {
925 ret = CMD_ERROR;
926 goto end;
927 }
928 }
9f19cc17
DG
929 } else {
930 /* List session attributes */
931 ret = list_sessions(session_name);
b6913340 932 if (ret != 0) {
9f19cc17
DG
933 goto end;
934 }
935
936 /* Domain listing */
937 if (opt_domain) {
330be774 938 ret = list_domains(session_name);
9f19cc17
DG
939 goto end;
940 }
941
1c3de747 942 if (opt_kernel || opt_userspace) {
9f19cc17 943 /* Channel listing */
cd80958d 944 ret = list_channels(opt_channel);
9f19cc17
DG
945 if (ret < 0) {
946 goto end;
947 }
9f19cc17 948 } else {
c617c0c6
MD
949 int i, nb_domain;
950
9f19cc17 951 /* We want all domain(s) */
330be774 952 nb_domain = lttng_list_domains(session_name, &domains);
b551a063 953 if (nb_domain < 0) {
67635185 954 ret = nb_domain;
60e835ca 955 ERR("%s", lttng_strerror(ret));
9f19cc17
DG
956 goto end;
957 }
958
b551a063 959 for (i = 0; i < nb_domain; i++) {
9f19cc17
DG
960 switch (domains[i].type) {
961 case LTTNG_DOMAIN_KERNEL:
962 MSG("=== Domain: Kernel ===\n");
963 break;
b551a063
DG
964 case LTTNG_DOMAIN_UST:
965 MSG("=== Domain: UST global ===\n");
88c5f0d8
DG
966 MSG("Buffer type: %s\n",
967 domains[i].buf_type ==
968 LTTNG_BUFFER_PER_PID ? "per PID" : "per UID");
b551a063 969 break;
3c6a091f
DG
970 case LTTNG_DOMAIN_JUL:
971 MSG("=== Domain: JUL (Java Util Logging) ===\n");
972 break;
9f19cc17
DG
973 default:
974 MSG("=== Domain: Unimplemented ===\n");
975 break;
976 }
977
cd80958d 978 /* Clean handle before creating a new one */
aa5de748
MD
979 if (handle) {
980 lttng_destroy_handle(handle);
981 }
cd80958d
DG
982
983 handle = lttng_create_handle(session_name, &domains[i]);
984 if (handle == NULL) {
ca1c3607 985 ret = CMD_FATAL;
cd80958d
DG
986 goto end;
987 }
988
3c6a091f
DG
989 if (domains[i].type == LTTNG_DOMAIN_JUL) {
990 ret = list_session_jul_events();
991 if (ret < 0) {
992 goto end;
993 }
994 continue;
995 }
996
cd80958d 997 ret = list_channels(opt_channel);
9f19cc17
DG
998 if (ret < 0) {
999 goto end;
1000 }
1001 }
1002 }
f3ed775e
DG
1003 }
1004
1005end:
0e428499 1006 free(domains);
aa5de748
MD
1007 if (handle) {
1008 lttng_destroy_handle(handle);
1009 }
cd80958d 1010
ca1c3607 1011 poptFreeContext(pc);
f3ed775e
DG
1012 return ret;
1013}
This page took 0.085189 seconds and 4 git commands to generate.