Cleanup list command printout for loglevel
[lttng-tools.git] / src / bin / lttng / commands / list.c
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
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
7 * of the License.
8 *
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.
13 *
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.
17 */
18
19 #define _GNU_SOURCE
20 #include <inttypes.h>
21 #include <popt.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26
27 #include "../command.h"
28
29 static int opt_userspace;
30 static int opt_kernel;
31 static char *opt_channel;
32 static int opt_domain;
33 #if 0
34 /* Not implemented yet */
35 static char *opt_cmd_name;
36 static pid_t opt_pid;
37 #endif
38
39 const char *indent4 = " ";
40 const char *indent6 = " ";
41 const char *indent8 = " ";
42
43 enum {
44 OPT_HELP = 1,
45 OPT_USERSPACE,
46 OPT_LIST_OPTIONS,
47 };
48
49 static struct lttng_handle *handle;
50
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},
55 #if 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},
59 #else
60 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
61 #endif
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},
65 {0, 0, 0, 0, 0, 0, 0}
66 };
67
68 /*
69 * usage
70 */
71 static void usage(FILE *ofp)
72 {
73 fprintf(ofp, "usage: lttng list [OPTIONS] [SESSION [<OPTIONS>]]\n");
74 fprintf(ofp, "\n");
75 fprintf(ofp, "With no arguments, list available tracing session(s)\n");
76 fprintf(ofp, "\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");
79 fprintf(ofp, "\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");
84 #if 0
85 fprintf(ofp, " -p, --pid PID List user-space events by PID\n");
86 #endif
87 fprintf(ofp, "\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");
91 fprintf(ofp, "\n");
92 }
93
94 /*
95 * Get command line from /proc for a specific pid.
96 *
97 * On success, return an allocated string pointer to the proc cmdline.
98 * On error, return NULL.
99 */
100 static char *get_cmdline_by_pid(pid_t pid)
101 {
102 int ret;
103 FILE *fp;
104 char *cmdline = NULL;
105 char path[24]; /* Can't go bigger than /proc/65535/cmdline */
106
107 snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
108 fp = fopen(path, "r");
109 if (fp == NULL) {
110 goto end;
111 }
112
113 /* Caller must free() *cmdline */
114 cmdline = malloc(PATH_MAX);
115 ret = fread(cmdline, 1, PATH_MAX, fp);
116 if (ret < 0) {
117 perror("fread proc list");
118 }
119 fclose(fp);
120
121 end:
122 return cmdline;
123 }
124
125 static
126 const char *active_string(int value)
127 {
128 switch (value) {
129 case 0: return " [inactive]";
130 case 1: return " [active]";
131 case -1: return "";
132 default: return NULL;
133 }
134 }
135
136 static
137 const char *enabled_string(int value)
138 {
139 switch (value) {
140 case 0: return " [disabled]";
141 case 1: return " [enabled]";
142 case -1: return "";
143 default: return NULL;
144 }
145 }
146
147 static
148 const char *loglevel_string_pre(int loglevel)
149 {
150 if (loglevel == -1) {
151 return "";
152 } else {
153 return " (loglevel: ";
154 }
155 }
156
157 static
158 const char *loglevel_string_post(int loglevel)
159 {
160 if (loglevel == -1) {
161 return "";
162 } else {
163 return ")";
164 }
165 }
166
167 static const char *loglevel_string(int value)
168 {
169 switch (value) {
170 case -1: return "";
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_SYSTEM";
179 case 8: return "TRACE_PROGRAM";
180 case 9: return "TRACE_PROCESS";
181 case 10: return "TRACE_MODULE";
182 case 11: return "TRACE_UNIT";
183 case 12: return "TRACE_FUNCTION";
184 case 13: return "TRACE_DEFAULT";
185 case 14: return "TRACE_VERBOSE";
186 case 15: return "TRACE_DEBUG";
187 default: return "<<UNKNOWN>>";
188 }
189 }
190
191 /*
192 * Pretty print single event.
193 */
194 static void print_events(struct lttng_event *event)
195 {
196 switch (event->type) {
197 case LTTNG_EVENT_TRACEPOINT:
198 {
199 MSG("%s%s%s%s%s (type: tracepoint)%s", indent6,
200 event->name,
201 loglevel_string_pre(event->loglevel),
202 loglevel_string(event->loglevel),
203 loglevel_string_post(event->loglevel),
204 enabled_string(event->enabled));
205 break;
206 }
207 case LTTNG_EVENT_PROBE:
208 MSG("%s%s (type: probe)%s", indent6,
209 event->name, enabled_string(event->enabled));
210 if (event->attr.probe.addr != 0) {
211 MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
212 } else {
213 MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
214 MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
215 }
216 break;
217 case LTTNG_EVENT_FUNCTION:
218 case LTTNG_EVENT_FUNCTION_ENTRY:
219 MSG("%s%s (type: function)%s", indent6,
220 event->name, enabled_string(event->enabled));
221 MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
222 break;
223 case LTTNG_EVENT_SYSCALL:
224 MSG("%s (type: syscall)%s", indent6,
225 enabled_string(event->enabled));
226 break;
227 case LTTNG_EVENT_NOOP:
228 MSG("%s (type: noop)%s", indent6,
229 enabled_string(event->enabled));
230 break;
231 case LTTNG_EVENT_ALL:
232 /* We should never have "all" events in list. */
233 assert(0);
234 break;
235 }
236 }
237
238 /*
239 * Ask session daemon for all user space tracepoints available.
240 */
241 static int list_ust_events(void)
242 {
243 int i, size;
244 struct lttng_domain domain;
245 struct lttng_handle *handle;
246 struct lttng_event *event_list;
247 pid_t cur_pid = 0;
248
249 DBG("Getting UST tracing events");
250
251 domain.type = LTTNG_DOMAIN_UST;
252
253 handle = lttng_create_handle(NULL, &domain);
254 if (handle == NULL) {
255 goto error;
256 }
257
258 size = lttng_list_tracepoints(handle, &event_list);
259 if (size < 0) {
260 ERR("Unable to list UST events");
261 return size;
262 }
263
264 MSG("UST events:\n-------------");
265
266 if (size == 0) {
267 MSG("None");
268 }
269
270 for (i = 0; i < size; i++) {
271 if (cur_pid != event_list[i].pid) {
272 cur_pid = event_list[i].pid;
273 MSG("\nPID: %d - Name: %s", cur_pid, get_cmdline_by_pid(cur_pid));
274 }
275 print_events(&event_list[i]);
276 }
277
278 MSG("");
279
280 free(event_list);
281
282 return CMD_SUCCESS;
283
284 error:
285 return -1;
286 }
287
288 /*
289 * Ask for all trace events in the kernel and pretty print them.
290 */
291 static int list_kernel_events(void)
292 {
293 int i, size;
294 struct lttng_domain domain;
295 struct lttng_handle *handle;
296 struct lttng_event *event_list;
297
298 DBG("Getting kernel tracing events");
299
300 domain.type = LTTNG_DOMAIN_KERNEL;
301
302 handle = lttng_create_handle(NULL, &domain);
303 if (handle == NULL) {
304 goto error;
305 }
306
307 size = lttng_list_tracepoints(handle, &event_list);
308 if (size < 0) {
309 ERR("Unable to list kernel events");
310 return size;
311 }
312
313 MSG("Kernel events:\n-------------");
314
315 for (i = 0; i < size; i++) {
316 print_events(&event_list[i]);
317 }
318
319 MSG("");
320
321 free(event_list);
322
323 return CMD_SUCCESS;
324
325 error:
326 return -1;
327 }
328
329 /*
330 * List events of channel of session and domain.
331 */
332 static int list_events(const char *channel_name)
333 {
334 int ret, count, i;
335 struct lttng_event *events = NULL;
336
337 count = lttng_list_events(handle, channel_name, &events);
338 if (count < 0) {
339 ret = count;
340 goto error;
341 }
342
343 MSG("\n%sEvents:", indent4);
344 if (count == 0) {
345 MSG("%sNone\n", indent6);
346 goto end;
347 }
348
349 for (i = 0; i < count; i++) {
350 print_events(&events[i]);
351 }
352
353 MSG("");
354
355 end:
356 if (events) {
357 free(events);
358 }
359 ret = CMD_SUCCESS;
360
361 error:
362 return ret;
363 }
364
365 /*
366 * Pretty print channel
367 */
368 static void print_channel(struct lttng_channel *channel)
369 {
370 MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
371
372 MSG("%sAttributes:", indent4);
373 MSG("%soverwrite mode: %d", indent6, channel->attr.overwrite);
374 MSG("%ssubbufers size: %" PRIu64, indent6, channel->attr.subbuf_size);
375 MSG("%snumber of subbufers: %" PRIu64, indent6, channel->attr.num_subbuf);
376 MSG("%sswitch timer interval: %u", indent6, channel->attr.switch_timer_interval);
377 MSG("%sread timer interval: %u", indent6, channel->attr.read_timer_interval);
378 switch (channel->attr.output) {
379 case LTTNG_EVENT_SPLICE:
380 MSG("%soutput: splice()", indent6);
381 break;
382 case LTTNG_EVENT_MMAP:
383 MSG("%soutput: mmap()", indent6);
384 break;
385 }
386 }
387
388 /*
389 * List channel(s) of session and domain.
390 *
391 * If channel_name is NULL, all channels are listed.
392 */
393 static int list_channels(const char *channel_name)
394 {
395 int count, i, ret = CMD_SUCCESS;
396 unsigned int chan_found = 0;
397 struct lttng_channel *channels = NULL;
398
399 DBG("Listing channel(s) (%s)", channel_name ? : "<all>");
400
401 count = lttng_list_channels(handle, &channels);
402 if (count < 0) {
403 ret = count;
404 goto error_channels;
405 } else if (count == 0) {
406 ERR("Channel %s not found", channel_name);
407 goto error;
408 }
409
410 if (channel_name == NULL) {
411 MSG("Channels:\n-------------");
412 }
413
414 for (i = 0; i < count; i++) {
415 if (channel_name != NULL) {
416 if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
417 chan_found = 1;
418 } else {
419 continue;
420 }
421 }
422 print_channel(&channels[i]);
423
424 /* Listing events per channel */
425 ret = list_events(channels[i].name);
426 if (ret < 0) {
427 MSG("%s", lttng_strerror(ret));
428 }
429
430 if (chan_found) {
431 break;
432 }
433 }
434
435 if (!chan_found && channel_name != NULL) {
436 ERR("Channel %s not found", channel_name);
437 goto error;
438 }
439
440 ret = CMD_SUCCESS;
441
442 error:
443 free(channels);
444
445 error_channels:
446 return ret;
447 }
448
449 /*
450 * List available tracing session. List only basic information.
451 *
452 * If session_name is NULL, all sessions are listed.
453 */
454 static int list_sessions(const char *session_name)
455 {
456 int ret, count, i;
457 unsigned int session_found = 0;
458 struct lttng_session *sessions;
459
460 count = lttng_list_sessions(&sessions);
461 DBG("Session count %d", count);
462 if (count < 0) {
463 ret = count;
464 goto error;
465 }
466
467 if (session_name == NULL) {
468 MSG("Available tracing sessions:");
469 }
470
471 for (i = 0; i < count; i++) {
472 if (session_name != NULL) {
473 if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
474 session_found = 1;
475 MSG("Tracing session %s:%s", session_name, active_string(sessions[i].enabled));
476 MSG("%sTrace path: %s\n", indent4, sessions[i].path);
477 break;
478 }
479 continue;
480 }
481
482 MSG(" %d) %s (%s)%s", i + 1, sessions[i].name, sessions[i].path,
483 active_string(sessions[i].enabled));
484
485 if (session_found) {
486 break;
487 }
488 }
489
490 free(sessions);
491
492 if (!session_found && session_name != NULL) {
493 ERR("Session '%s' not found", session_name);
494 ret = CMD_ERROR;
495 goto error;
496 }
497
498 if (session_name == NULL) {
499 MSG("\nUse lttng list <session_name> for more details");
500 }
501
502 return CMD_SUCCESS;
503
504 error:
505 return ret;
506 }
507
508 /*
509 * List available domain(s) for a session.
510 */
511 static int list_domains(const char *session_name)
512 {
513 int i, count, ret = CMD_SUCCESS;
514 struct lttng_domain *domains = NULL;
515
516 MSG("Domains:\n-------------");
517
518 count = lttng_list_domains(session_name, &domains);
519 if (count < 0) {
520 ret = count;
521 goto error;
522 } else if (count == 0) {
523 MSG(" None");
524 goto end;
525 }
526
527 for (i = 0; i < count; i++) {
528 switch (domains[i].type) {
529 case LTTNG_DOMAIN_KERNEL:
530 MSG(" - Kernel");
531 break;
532 case LTTNG_DOMAIN_UST:
533 MSG(" - UST global");
534 break;
535 default:
536 break;
537 }
538 }
539
540 end:
541 free(domains);
542
543 error:
544 return ret;
545 }
546
547 /*
548 * The 'list <options>' first level command
549 */
550 int cmd_list(int argc, const char **argv)
551 {
552 int opt, i, ret = CMD_SUCCESS;
553 int nb_domain;
554 const char *session_name;
555 static poptContext pc;
556 struct lttng_domain domain;
557 struct lttng_domain *domains = NULL;
558
559 if (argc < 1) {
560 usage(stderr);
561 ret = CMD_ERROR;
562 goto end;
563 }
564
565 pc = poptGetContext(NULL, argc, argv, long_options, 0);
566 poptReadDefaultConfig(pc, 0);
567
568 while ((opt = poptGetNextOpt(pc)) != -1) {
569 switch (opt) {
570 case OPT_HELP:
571 usage(stdout);
572 goto end;
573 case OPT_USERSPACE:
574 opt_userspace = 1;
575 break;
576 case OPT_LIST_OPTIONS:
577 list_cmd_options(stdout, long_options);
578 goto end;
579 default:
580 usage(stderr);
581 ret = CMD_UNDEFINED;
582 goto end;
583 }
584 }
585
586 /* Get session name (trailing argument) */
587 session_name = poptGetArg(pc);
588 DBG2("Session name: %s", session_name);
589
590 if (opt_kernel) {
591 domain.type = LTTNG_DOMAIN_KERNEL;
592 } else if (opt_userspace) {
593 DBG2("Listing userspace global domain");
594 domain.type = LTTNG_DOMAIN_UST;
595 }
596
597 handle = lttng_create_handle(session_name, &domain);
598 if (handle == NULL) {
599 ret = CMD_FATAL;
600 goto end;
601 }
602
603 if (session_name == NULL) {
604 if (!opt_kernel && !opt_userspace) {
605 ret = list_sessions(NULL);
606 if (ret != 0) {
607 goto end;
608 }
609 }
610 if (opt_kernel) {
611 ret = list_kernel_events();
612 if (ret < 0) {
613 goto end;
614 }
615 }
616 if (opt_userspace) {
617 ret = list_ust_events();
618 if (ret < 0) {
619 goto end;
620 }
621 }
622 } else {
623 /* List session attributes */
624 ret = list_sessions(session_name);
625 if (ret != 0) {
626 goto end;
627 }
628
629 /* Domain listing */
630 if (opt_domain) {
631 ret = list_domains(session_name);
632 goto end;
633 }
634
635 if (opt_kernel) {
636 /* Channel listing */
637 ret = list_channels(opt_channel);
638 if (ret < 0) {
639 goto end;
640 }
641 } else {
642 /* We want all domain(s) */
643 nb_domain = lttng_list_domains(session_name, &domains);
644 if (nb_domain < 0) {
645 ret = nb_domain;
646 goto end;
647 }
648
649 for (i = 0; i < nb_domain; i++) {
650 switch (domains[i].type) {
651 case LTTNG_DOMAIN_KERNEL:
652 MSG("=== Domain: Kernel ===\n");
653 break;
654 case LTTNG_DOMAIN_UST:
655 MSG("=== Domain: UST global ===\n");
656 break;
657 default:
658 MSG("=== Domain: Unimplemented ===\n");
659 break;
660 }
661
662 /* Clean handle before creating a new one */
663 lttng_destroy_handle(handle);
664
665 handle = lttng_create_handle(session_name, &domains[i]);
666 if (handle == NULL) {
667 ret = CMD_FATAL;
668 goto end;
669 }
670
671 ret = list_channels(opt_channel);
672 if (ret < 0) {
673 goto end;
674 }
675 }
676 }
677 }
678
679 end:
680 if (domains) {
681 free(domains);
682 }
683 lttng_destroy_handle(handle);
684
685 poptFreeContext(pc);
686 return ret;
687 }
This page took 0.043448 seconds and 5 git commands to generate.