projects / lttng-tools.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
SoW-2020-0002: Trace Hit Counters
[lttng-tools.git] / src / bin / lttng / commands / list.c
1 /*
2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2020 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
5 * SPDX-License-Identifier: GPL-2.0-only
6 *
7 */
8
9 #include <stdint.h>
10 #define _LGPL_SOURCE
11 #include <inttypes.h>
12 #include <popt.h>
13 #include <stdio.h>
14 #include <stdlib.h>
15 #include <string.h>
16 #include <assert.h>
17
18 #include <common/mi-lttng.h>
19 #include <common/time.h>
20 #include <common/tracker.h>
21 #include <lttng/lttng.h>
22 #include <lttng/map/map.h>
23
24 #include "../command.h"
25
26 static int opt_userspace;
27 static int opt_kernel;
28 static int opt_jul;
29 static int opt_log4j;
30 static int opt_python;
31 static char *opt_channel;
32 static char *opt_map;
33 static int opt_domain;
34 static int opt_fields;
35 static int opt_syscall;
36
37 const char *indent4 = " ";
38 const char *indent6 = " ";
39 const char *indent8 = " ";
40
41 #ifdef LTTNG_EMBED_HELP
42 static const char help_msg[] =
43 #include <lttng-list.1.h>
44 ;
45 #endif
46
47 enum {
48 OPT_HELP = 1,
49 OPT_USERSPACE,
50 OPT_LIST_OPTIONS,
51 };
52
53 static struct lttng_handle *handle;
54 static struct mi_writer *writer;
55
56 /* Only set when listing a single session. */
57 static struct lttng_session listed_session;
58
59 static struct poptOption long_options[] = {
60 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
61 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
62 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
63 {"jul", 'j', POPT_ARG_VAL, &opt_jul, 1, 0, 0},
64 {"log4j", 'l', POPT_ARG_VAL, &opt_log4j, 1, 0, 0},
65 {"python", 'p', POPT_ARG_VAL, &opt_python, 1, 0, 0},
66 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
67 {"channel", 'c', POPT_ARG_STRING, &opt_channel, 0, 0, 0},
68 {"map", 'm', POPT_ARG_STRING, &opt_map, 0, 0, 0},
69 {"domain", 'd', POPT_ARG_VAL, &opt_domain, 1, 0, 0},
70 {"fields", 'f', POPT_ARG_VAL, &opt_fields, 1, 0, 0},
71 {"syscall", 'S', POPT_ARG_VAL, &opt_syscall, 1, 0, 0},
72 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
73 {0, 0, 0, 0, 0, 0, 0}
74 };
75
76 /*
77 * Get command line from /proc for a specific pid.
78 *
79 * On success, return an allocated string pointer to the proc cmdline.
80 * On error, return NULL.
81 */
82 static char *get_cmdline_by_pid(pid_t pid)
83 {
84 int ret;
85 FILE *fp = NULL;
86 char *cmdline = NULL;
87 /* Can't go bigger than /proc/LTTNG_MAX_PID/cmdline */
88 char path[sizeof("/proc//cmdline") + sizeof(LTTNG_MAX_PID_STR) - 1];
89
90 snprintf(path, sizeof(path), "/proc/%d/cmdline", pid);
91 fp = fopen(path, "r");
92 if (fp == NULL) {
93 goto end;
94 }
95
96 /* Caller must free() *cmdline */
97 cmdline = zmalloc(PATH_MAX);
98 if (!cmdline) {
99 PERROR("malloc cmdline");
100 goto end;
101 }
102 ret = fread(cmdline, 1, PATH_MAX, fp);
103 if (ret < 0) {
104 PERROR("fread proc list");
105 }
106
107 end:
108 if (fp) {
109 fclose(fp);
110 }
111 return cmdline;
112 }
113
114 static
115 const char *active_string(int value)
116 {
117 switch (value) {
118 case 0: return "inactive";
119 case 1: return "active";
120 case -1: return "";
121 default: return NULL;
122 }
123 }
124
125 static const char *snapshot_string(int value)
126 {
127 switch (value) {
128 case 1:
129 return " snapshot";
130 default:
131 return "";
132 }
133 }
134
135 static
136 const char *enabled_string(int value)
137 {
138 switch (value) {
139 case 0: return " [disabled]";
140 case 1: return " [enabled]";
141 case -1: return "";
142 default: return NULL;
143 }
144 }
145
146 static
147 const char *safe_string(const char *str)
148 {
149 return str ? str : "";
150 }
151
152 static const char *logleveltype_string(enum lttng_loglevel_type value)
153 {
154 switch (value) {
155 case LTTNG_EVENT_LOGLEVEL_ALL:
156 return ":";
157 case LTTNG_EVENT_LOGLEVEL_RANGE:
158 return " <=";
159 case LTTNG_EVENT_LOGLEVEL_SINGLE:
160 return " ==";
161 default:
162 return " <<TYPE UNKN>>";
163 }
164 }
165
166 static const char *bitness_event(enum lttng_event_flag flags)
167 {
168 if (flags & LTTNG_EVENT_FLAG_SYSCALL_32) {
169 if (flags & LTTNG_EVENT_FLAG_SYSCALL_64) {
170 return " [32/64-bit]";
171 } else {
172 return " [32-bit]";
173 }
174 } else if (flags & LTTNG_EVENT_FLAG_SYSCALL_64) {
175 return " [64-bit]";
176 } else {
177 return "";
178 }
179 }
180
181 /*
182 * Get exclusion names message for a single event.
183 *
184 * Returned pointer must be freed by caller. Returns NULL on error.
185 */
186 static char *get_exclusion_names_msg(struct lttng_event *event)
187 {
188 int ret;
189 int exclusion_count;
190 char *exclusion_msg = NULL;
191 char *at;
192 size_t i;
193 const char * const exclusion_fmt = " [exclusions: ";
194 const size_t exclusion_fmt_len = strlen(exclusion_fmt);
195
196 exclusion_count = lttng_event_get_exclusion_name_count(event);
197 if (exclusion_count < 0) {
198 goto end;
199 } else if (exclusion_count == 0) {
200 /*
201 * No exclusions: return copy of empty string so that
202 * it can be freed by caller.
203 */
204 exclusion_msg = strdup("");
205 goto end;
206 }
207
208 /*
209 * exclusion_msg's size is bounded by the exclusion_fmt string,
210 * a comma per entry, the entry count (fixed-size), a closing
211 * bracket, and a trailing \0.
212 */
213 exclusion_msg = malloc(exclusion_count +
214 exclusion_count * LTTNG_SYMBOL_NAME_LEN +
215 exclusion_fmt_len + 1);
216 if (!exclusion_msg) {
217 goto end;
218 }
219
220 at = strcpy(exclusion_msg, exclusion_fmt) + exclusion_fmt_len;
221 for (i = 0; i < exclusion_count; ++i) {
222 const char *name;
223
224 /* Append comma between exclusion names */
225 if (i > 0) {
226 *at = ',';
227 at++;
228 }
229
230 ret = lttng_event_get_exclusion_name(event, i, &name);
231 if (ret) {
232 /* Prints '?' on local error; should never happen */
233 *at = '?';
234 at++;
235 continue;
236 }
237
238 /* Append exclusion name */
239 at += sprintf(at, "%s", name);
240 }
241
242 /* This also puts a final '\0' at the end of exclusion_msg */
243 strcpy(at, "]");
244
245 end:
246 return exclusion_msg;
247 }
248
249 static void print_userspace_probe_location(struct lttng_event *event)
250 {
251 const struct lttng_userspace_probe_location *location;
252 const struct lttng_userspace_probe_location_lookup_method *lookup_method;
253 enum lttng_userspace_probe_location_lookup_method_type lookup_type;
254
255 location = lttng_event_get_userspace_probe_location(event);
256 if (!location) {
257 MSG("Event has no userspace probe location");
258 return;
259 }
260
261 lookup_method = lttng_userspace_probe_location_get_lookup_method(location);
262 if (!lookup_method) {
263 MSG("Event has no userspace probe location lookup method");
264 return;
265 }
266
267 MSG("%s%s (type: userspace-probe)%s", indent6, event->name, enabled_string(event->enabled));
268
269 lookup_type = lttng_userspace_probe_location_lookup_method_get_type(lookup_method);
270
271 switch (lttng_userspace_probe_location_get_type(location)) {
272 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_UNKNOWN:
273 MSG("%sType: Unknown", indent8);
274 break;
275 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION:
276 {
277 const char *function_name;
278 char *binary_path;
279
280 MSG("%sType: Function", indent8);
281 function_name = lttng_userspace_probe_location_function_get_function_name(location);
282 binary_path = realpath(lttng_userspace_probe_location_function_get_binary_path(location), NULL);
283
284 MSG("%sBinary path: %s", indent8, binary_path ? binary_path : "NULL");
285 MSG("%sFunction: %s()", indent8, function_name ? function_name : "NULL");
286 switch (lookup_type) {
287 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF:
288 MSG("%sLookup method: ELF", indent8);
289 break;
290 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_DEFAULT:
291 MSG("%sLookup method: default", indent8);
292 break;
293 default:
294 MSG("%sLookup method: INVALID LOOKUP TYPE ENCOUNTERED", indent8);
295 break;
296 }
297
298 free(binary_path);
299 break;
300 }
301 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT:
302 {
303 const char *probe_name, *provider_name;
304 char *binary_path;
305
306 MSG("%sType: Tracepoint", indent8);
307 probe_name = lttng_userspace_probe_location_tracepoint_get_probe_name(location);
308 provider_name = lttng_userspace_probe_location_tracepoint_get_provider_name(location);
309 binary_path = realpath(lttng_userspace_probe_location_tracepoint_get_binary_path(location), NULL);
310 MSG("%sBinary path: %s", indent8, binary_path ? binary_path : "NULL");
311 MSG("%sTracepoint: %s:%s", indent8, provider_name ? provider_name : "NULL", probe_name ? probe_name : "NULL");
312 switch (lookup_type) {
313 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_TRACEPOINT_SDT:
314 MSG("%sLookup method: SDT", indent8);
315 break;
316 default:
317 MSG("%sLookup method: INVALID LOOKUP TYPE ENCOUNTERED", indent8);
318 break;
319 }
320
321 free(binary_path);
322 break;
323 }
324 default:
325 ERR("Invalid probe type encountered");
326 }
327 }
328
329 /*
330 * Pretty print single event.
331 */
332 static void print_events(struct lttng_event *event)
333 {
334 int ret;
335 const char *filter_str;
336 char *filter_msg = NULL;
337 char *exclusion_msg = NULL;
338
339 ret = lttng_event_get_filter_expression(event, &filter_str);
340
341 if (ret) {
342 filter_msg = strdup(" [failed to retrieve filter]");
343 } else if (filter_str) {
344 const char * const filter_fmt = " [filter: '%s']";
345
346 filter_msg = malloc(strlen(filter_str) +
347 strlen(filter_fmt) + 1);
348 if (filter_msg) {
349 sprintf(filter_msg, filter_fmt,
350 filter_str);
351 }
352 }
353
354 exclusion_msg = get_exclusion_names_msg(event);
355 if (!exclusion_msg) {
356 exclusion_msg = strdup(" [failed to retrieve exclusions]");
357 }
358
359 switch (event->type) {
360 case LTTNG_EVENT_TRACEPOINT:
361 {
362 if (event->loglevel != -1) {
363 MSG("%s%s (loglevel%s %s (%d)) (type: tracepoint)%s%s%s",
364 indent6,
365 event->name,
366 logleveltype_string(event->loglevel_type),
367 mi_lttng_loglevel_string(event->loglevel, handle->domain.type),
368 event->loglevel,
369 enabled_string(event->enabled),
370 safe_string(exclusion_msg),
371 safe_string(filter_msg));
372 } else {
373 MSG("%s%s (type: tracepoint)%s%s%s",
374 indent6,
375 event->name,
376 enabled_string(event->enabled),
377 safe_string(exclusion_msg),
378 safe_string(filter_msg));
379 }
380 break;
381 }
382 case LTTNG_EVENT_FUNCTION:
383 MSG("%s%s (type: function)%s%s", indent6,
384 event->name, enabled_string(event->enabled),
385 safe_string(filter_msg));
386 if (event->attr.probe.addr != 0) {
387 MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
388 } else {
389 MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
390 MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
391 }
392 break;
393 case LTTNG_EVENT_PROBE:
394 MSG("%s%s (type: probe)%s%s", indent6,
395 event->name, enabled_string(event->enabled),
396 safe_string(filter_msg));
397 if (event->attr.probe.addr != 0) {
398 MSG("%saddr: 0x%" PRIx64, indent8, event->attr.probe.addr);
399 } else {
400 MSG("%soffset: 0x%" PRIx64, indent8, event->attr.probe.offset);
401 MSG("%ssymbol: %s", indent8, event->attr.probe.symbol_name);
402 }
403 break;
404 case LTTNG_EVENT_USERSPACE_PROBE:
405 print_userspace_probe_location(event);
406 break;
407 case LTTNG_EVENT_FUNCTION_ENTRY:
408 MSG("%s%s (type: function)%s%s", indent6,
409 event->name, enabled_string(event->enabled),
410 safe_string(filter_msg));
411 MSG("%ssymbol: \"%s\"", indent8, event->attr.ftrace.symbol_name);
412 break;
413 case LTTNG_EVENT_SYSCALL:
414 MSG("%s%s%s%s%s%s", indent6, event->name,
415 (opt_syscall ? "" : " (type:syscall)"),
416 enabled_string(event->enabled),
417 bitness_event(event->flags),
418 safe_string(filter_msg));
419 break;
420 case LTTNG_EVENT_NOOP:
421 MSG("%s (type: noop)%s%s", indent6,
422 enabled_string(event->enabled),
423 safe_string(filter_msg));
424 break;
425 case LTTNG_EVENT_ALL:
426 /* Fall-through. */
427 default:
428 /* We should never have "all" events in list. */
429 assert(0);
430 break;
431 }
432
433 free(filter_msg);
434 free(exclusion_msg);
435 }
436
437 static const char *field_type(struct lttng_event_field *field)
438 {
439 switch(field->type) {
440 case LTTNG_EVENT_FIELD_INTEGER:
441 return "integer";
442 case LTTNG_EVENT_FIELD_ENUM:
443 return "enum";
444 case LTTNG_EVENT_FIELD_FLOAT:
445 return "float";
446 case LTTNG_EVENT_FIELD_STRING:
447 return "string";
448 case LTTNG_EVENT_FIELD_OTHER:
449 default: /* fall-through */
450 return "unknown";
451 }
452 }
453
454 /*
455 * Pretty print single event fields.
456 */
457 static void print_event_field(struct lttng_event_field *field)
458 {
459 if (!field->field_name[0]) {
460 return;
461 }
462 MSG("%sfield: %s (%s)%s", indent8, field->field_name,
463 field_type(field), field->nowrite ? " [no write]" : "");
464 }
465
466 /*
467 * Machine interface
468 * Jul and ust event listing
469 */
470 static int mi_list_agent_ust_events(struct lttng_event *events, int count,
471 struct lttng_domain *domain)
472 {
473 int ret, i;
474 pid_t cur_pid = 0;
475 char *cmdline = NULL;
476 int pid_element_open = 0;
477
478 /* Open domains element */
479 ret = mi_lttng_domains_open(writer);
480 if (ret) {
481 goto end;
482 }
483
484 /* Write domain */
485 ret = mi_lttng_domain(writer, domain, 1);
486 if (ret) {
487 goto end;
488 }
489
490 /* Open pids element element */
491 ret = mi_lttng_pids_open(writer);
492 if (ret) {
493 goto end;
494 }
495
496 for (i = 0; i < count; i++) {
497 if (cur_pid != events[i].pid) {
498 if (pid_element_open) {
499 /* Close the previous events and pid element */
500 ret = mi_lttng_close_multi_element(writer, 2);
501 if (ret) {
502 goto end;
503 }
504 pid_element_open = 0;
505 }
506
507 cur_pid = events[i].pid;
508 cmdline = get_cmdline_by_pid(cur_pid);
509 if (!cmdline) {
510 ret = CMD_ERROR;
511 goto end;
512 }
513
514 if (!pid_element_open) {
515 /* Open and write a pid element */
516 ret = mi_lttng_pid(writer, cur_pid, cmdline, 1);
517 if (ret) {
518 goto error;
519 }
520
521 /* Open events element */
522 ret = mi_lttng_events_open(writer);
523 if (ret) {
524 goto error;
525 }
526
527 pid_element_open = 1;
528 }
529 free(cmdline);
530 }
531
532 /* Write an event */
533 ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
534 if (ret) {
535 goto end;
536 }
537 }
538
539 /* Close pids */
540 ret = mi_lttng_writer_close_element(writer);
541 if (ret) {
542 goto end;
543 }
544
545 /* Close domain, domains */
546 ret = mi_lttng_close_multi_element(writer, 2);
547 end:
548 return ret;
549 error:
550 free(cmdline);
551 return ret;
552 }
553
554 static int list_agent_events(void)
555 {
556 int i, size, ret = CMD_SUCCESS;
557 struct lttng_domain domain;
558 struct lttng_handle *handle = NULL;
559 struct lttng_event *event_list = NULL;
560 pid_t cur_pid = 0;
561 char *cmdline = NULL;
562 const char *agent_domain_str;
563
564 memset(&domain, 0, sizeof(domain));
565 if (opt_jul) {
566 domain.type = LTTNG_DOMAIN_JUL;
567 } else if (opt_log4j) {
568 domain.type = LTTNG_DOMAIN_LOG4J;
569 } else if (opt_python) {
570 domain.type = LTTNG_DOMAIN_PYTHON;
571 } else {
572 ERR("Invalid agent domain selected.");
573 ret = CMD_ERROR;
574 goto error;
575 }
576
577 agent_domain_str = get_domain_str(domain.type);
578
579 DBG("Getting %s tracing events", agent_domain_str);
580
581 handle = lttng_create_handle(NULL, &domain);
582 if (handle == NULL) {
583 ret = CMD_ERROR;
584 goto end;
585 }
586
587 size = lttng_list_tracepoints(handle, &event_list);
588 if (size < 0) {
589 ERR("Unable to list %s events: %s", agent_domain_str,
590 lttng_strerror(size));
591 ret = CMD_ERROR;
592 goto end;
593 }
594
595 if (lttng_opt_mi) {
596 /* Mi print */
597 ret = mi_list_agent_ust_events(event_list, size, &domain);
598 if (ret) {
599 ret = CMD_ERROR;
600 goto error;
601 }
602 } else {
603 /* Pretty print */
604 MSG("%s events (Logger name):\n-------------------------",
605 agent_domain_str);
606
607 if (size == 0) {
608 MSG("None");
609 }
610
611 for (i = 0; i < size; i++) {
612 if (cur_pid != event_list[i].pid) {
613 cur_pid = event_list[i].pid;
614 cmdline = get_cmdline_by_pid(cur_pid);
615 if (cmdline == NULL) {
616 ret = CMD_ERROR;
617 goto error;
618 }
619 MSG("\nPID: %d - Name: %s", cur_pid, cmdline);
620 free(cmdline);
621 }
622 MSG("%s- %s", indent6, event_list[i].name);
623 }
624
625 MSG("");
626 }
627
628 error:
629 free(event_list);
630 end:
631 lttng_destroy_handle(handle);
632 return ret;
633 }
634
635 /*
636 * Ask session daemon for all user space tracepoints available.
637 */
638 static int list_ust_events(void)
639 {
640 int i, size, ret = CMD_SUCCESS;
641 struct lttng_domain domain;
642 struct lttng_handle *handle;
643 struct lttng_event *event_list = NULL;
644 pid_t cur_pid = 0;
645 char *cmdline = NULL;
646
647 memset(&domain, 0, sizeof(domain));
648
649 DBG("Getting UST tracing events");
650
651 domain.type = LTTNG_DOMAIN_UST;
652
653 handle = lttng_create_handle(NULL, &domain);
654 if (handle == NULL) {
655 ret = CMD_ERROR;
656 goto end;
657 }
658
659 size = lttng_list_tracepoints(handle, &event_list);
660 if (size < 0) {
661 ERR("Unable to list UST events: %s", lttng_strerror(size));
662 ret = CMD_ERROR;
663 goto error;
664 }
665
666 if (lttng_opt_mi) {
667 /* Mi print */
668 ret = mi_list_agent_ust_events(event_list, size, &domain);
669 } else {
670 /* Pretty print */
671 MSG("UST events:\n-------------");
672
673 if (size == 0) {
674 MSG("None");
675 }
676
677 for (i = 0; i < size; i++) {
678 if (cur_pid != event_list[i].pid) {
679 cur_pid = event_list[i].pid;
680 cmdline = get_cmdline_by_pid(cur_pid);
681 if (cmdline == NULL) {
682 ret = CMD_ERROR;
683 goto error;
684 }
685 MSG("\nPID: %d - Name: %s", cur_pid, cmdline);
686 free(cmdline);
687 }
688 print_events(&event_list[i]);
689 }
690
691 MSG("");
692 }
693
694 error:
695 free(event_list);
696 end:
697 lttng_destroy_handle(handle);
698 return ret;
699 }
700
701 /*
702 * Machine interface
703 * List all ust event with their fields
704 */
705 static int mi_list_ust_event_fields(struct lttng_event_field *fields, int count,
706 struct lttng_domain *domain)
707 {
708 int ret, i;
709 pid_t cur_pid = 0;
710 char *cmdline = NULL;
711 int pid_element_open = 0;
712 int event_element_open = 0;
713 struct lttng_event cur_event;
714
715 memset(&cur_event, 0, sizeof(cur_event));
716
717 /* Open domains element */
718 ret = mi_lttng_domains_open(writer);
719 if (ret) {
720 goto end;
721 }
722
723 /* Write domain */
724 ret = mi_lttng_domain(writer, domain, 1);
725 if (ret) {
726 goto end;
727 }
728
729 /* Open pids element */
730 ret = mi_lttng_pids_open(writer);
731 if (ret) {
732 goto end;
733 }
734
735 for (i = 0; i < count; i++) {
736 if (cur_pid != fields[i].event.pid) {
737 if (pid_element_open) {
738 if (event_element_open) {
739 /* Close the previous field element and event. */
740 ret = mi_lttng_close_multi_element(writer, 2);
741 if (ret) {
742 goto end;
743 }
744 event_element_open = 0;
745 }
746 /* Close the previous events, pid element */
747 ret = mi_lttng_close_multi_element(writer, 2);
748 if (ret) {
749 goto end;
750 }
751 pid_element_open = 0;
752 }
753
754 cur_pid = fields[i].event.pid;
755 cmdline = get_cmdline_by_pid(cur_pid);
756 if (!pid_element_open) {
757 /* Open and write a pid element */
758 ret = mi_lttng_pid(writer, cur_pid, cmdline, 1);
759 if (ret) {
760 goto error;
761 }
762
763 /* Open events element */
764 ret = mi_lttng_events_open(writer);
765 if (ret) {
766 goto error;
767 }
768 pid_element_open = 1;
769 }
770 free(cmdline);
771 /* Wipe current event since we are about to print a new PID. */
772 memset(&cur_event, 0, sizeof(cur_event));
773 }
774
775 if (strcmp(cur_event.name, fields[i].event.name) != 0) {
776 if (event_element_open) {
777 /* Close the previous fields element and the previous event */
778 ret = mi_lttng_close_multi_element(writer, 2);
779 if (ret) {
780 goto end;
781 }
782 event_element_open = 0;
783 }
784
785 memcpy(&cur_event, &fields[i].event,
786 sizeof(cur_event));
787
788 if (!event_element_open) {
789 /* Open and write the event */
790 ret = mi_lttng_event(writer, &cur_event, 1,
791 handle->domain.type);
792 if (ret) {
793 goto end;
794 }
795
796 /* Open a fields element */
797 ret = mi_lttng_event_fields_open(writer);
798 if (ret) {
799 goto end;
800 }
801 event_element_open = 1;
802 }
803 }
804
805 /* Print the event_field */
806 ret = mi_lttng_event_field(writer, &fields[i]);
807 if (ret) {
808 goto end;
809 }
810 }
811
812 /* Close pids, domain, domains */
813 ret = mi_lttng_close_multi_element(writer, 3);
814 end:
815 return ret;
816 error:
817 free(cmdline);
818 return ret;
819 }
820
821 /*
822 * Ask session daemon for all user space tracepoint fields available.
823 */
824 static int list_ust_event_fields(void)
825 {
826 int i, size, ret = CMD_SUCCESS;
827 struct lttng_domain domain;
828 struct lttng_handle *handle;
829 struct lttng_event_field *event_field_list;
830 pid_t cur_pid = 0;
831 char *cmdline = NULL;
832
833 struct lttng_event cur_event;
834
835 memset(&domain, 0, sizeof(domain));
836 memset(&cur_event, 0, sizeof(cur_event));
837
838 DBG("Getting UST tracing event fields");
839
840 domain.type = LTTNG_DOMAIN_UST;
841
842 handle = lttng_create_handle(NULL, &domain);
843 if (handle == NULL) {
844 ret = CMD_ERROR;
845 goto end;
846 }
847
848 size = lttng_list_tracepoint_fields(handle, &event_field_list);
849 if (size < 0) {
850 ERR("Unable to list UST event fields: %s", lttng_strerror(size));
851 ret = CMD_ERROR;
852 goto end;
853 }
854
855 if (lttng_opt_mi) {
856 /* Mi print */
857 ret = mi_list_ust_event_fields(event_field_list, size, &domain);
858 if (ret) {
859 ret = CMD_ERROR;
860 goto error;
861 }
862 } else {
863 /* Pretty print */
864 MSG("UST events:\n-------------");
865
866 if (size == 0) {
867 MSG("None");
868 }
869
870 for (i = 0; i < size; i++) {
871 if (cur_pid != event_field_list[i].event.pid) {
872 cur_pid = event_field_list[i].event.pid;
873 cmdline = get_cmdline_by_pid(cur_pid);
874 if (cmdline == NULL) {
875 ret = CMD_ERROR;
876 goto error;
877 }
878 MSG("\nPID: %d - Name: %s", cur_pid, cmdline);
879 free(cmdline);
880 /* Wipe current event since we are about to print a new PID. */
881 memset(&cur_event, 0, sizeof(cur_event));
882 }
883 if (strcmp(cur_event.name, event_field_list[i].event.name) != 0) {
884 print_events(&event_field_list[i].event);
885 memcpy(&cur_event, &event_field_list[i].event,
886 sizeof(cur_event));
887 }
888 print_event_field(&event_field_list[i]);
889 }
890
891 MSG("");
892 }
893
894 error:
895 free(event_field_list);
896 end:
897 lttng_destroy_handle(handle);
898 return ret;
899 }
900
901 /*
902 * Machine interface
903 * Print a list of kernel events
904 */
905 static int mi_list_kernel_events(struct lttng_event *events, int count,
906 struct lttng_domain *domain)
907 {
908 int ret, i;
909
910 /* Open domains element */
911 ret = mi_lttng_domains_open(writer);
912 if (ret) {
913 goto end;
914 }
915
916 /* Write domain */
917 ret = mi_lttng_domain(writer, domain, 1);
918 if (ret) {
919 goto end;
920 }
921
922 /* Open events */
923 ret = mi_lttng_events_open(writer);
924 if (ret) {
925 goto end;
926 }
927
928 for (i = 0; i < count; i++) {
929 ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
930 if (ret) {
931 goto end;
932 }
933 }
934
935 /* close events, domain and domains */
936 ret = mi_lttng_close_multi_element(writer, 3);
937 if (ret) {
938 goto end;
939 }
940
941 end:
942 return ret;
943 }
944
945 /*
946 * Ask for all trace events in the kernel
947 */
948 static int list_kernel_events(void)
949 {
950 int i, size, ret = CMD_SUCCESS;
951 struct lttng_domain domain;
952 struct lttng_handle *handle;
953 struct lttng_event *event_list;
954
955 memset(&domain, 0, sizeof(domain));
956
957 DBG("Getting kernel tracing events");
958
959 domain.type = LTTNG_DOMAIN_KERNEL;
960
961 handle = lttng_create_handle(NULL, &domain);
962 if (handle == NULL) {
963 ret = CMD_ERROR;
964 goto error;
965 }
966
967 size = lttng_list_tracepoints(handle, &event_list);
968 if (size < 0) {
969 ERR("Unable to list kernel events: %s", lttng_strerror(size));
970 lttng_destroy_handle(handle);
971 return CMD_ERROR;
972 }
973
974 if (lttng_opt_mi) {
975 /* Mi print */
976 ret = mi_list_kernel_events(event_list, size, &domain);
977 if (ret) {
978 ret = CMD_ERROR;
979 goto end;
980 }
981 } else {
982 MSG("Kernel events:\n-------------");
983
984 for (i = 0; i < size; i++) {
985 print_events(&event_list[i]);
986 }
987
988 MSG("");
989 }
990
991 end:
992 free(event_list);
993
994 lttng_destroy_handle(handle);
995 return ret;
996
997 error:
998 lttng_destroy_handle(handle);
999 return ret;
1000 }
1001
1002 /*
1003 * Machine interface
1004 * Print a list of system calls.
1005 */
1006 static int mi_list_syscalls(struct lttng_event *events, int count)
1007 {
1008 int ret, i;
1009
1010 /* Open events */
1011 ret = mi_lttng_events_open(writer);
1012 if (ret) {
1013 goto end;
1014 }
1015
1016 for (i = 0; i < count; i++) {
1017 ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
1018 if (ret) {
1019 goto end;
1020 }
1021 }
1022
1023 /* Close events. */
1024 ret = mi_lttng_writer_close_element(writer);
1025 if (ret) {
1026 goto end;
1027 }
1028
1029 end:
1030 return ret;
1031 }
1032
1033 /*
1034 * Ask for kernel system calls.
1035 */
1036 static int list_syscalls(void)
1037 {
1038 int i, size, ret = CMD_SUCCESS;
1039 struct lttng_event *event_list;
1040
1041 DBG("Getting kernel system call events");
1042
1043 size = lttng_list_syscalls(&event_list);
1044 if (size < 0) {
1045 ERR("Unable to list system calls: %s", lttng_strerror(size));
1046 ret = CMD_ERROR;
1047 goto error;
1048 }
1049
1050 if (lttng_opt_mi) {
1051 /* Mi print */
1052 ret = mi_list_syscalls(event_list, size);
1053 if (ret) {
1054 ret = CMD_ERROR;
1055 goto end;
1056 }
1057 } else {
1058 MSG("System calls:\n-------------");
1059
1060 for (i = 0; i < size; i++) {
1061 print_events(&event_list[i]);
1062 }
1063
1064 MSG("");
1065 }
1066
1067 end:
1068 free(event_list);
1069 return ret;
1070
1071 error:
1072 return ret;
1073 }
1074
1075 /*
1076 * Machine Interface
1077 * Print a list of agent events
1078 */
1079 static int mi_list_session_agent_events(struct lttng_event *events, int count)
1080 {
1081 int ret, i;
1082
1083 /* Open events element */
1084 ret = mi_lttng_events_open(writer);
1085 if (ret) {
1086 goto end;
1087 }
1088
1089 for (i = 0; i < count; i++) {
1090 ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
1091 if (ret) {
1092 goto end;
1093 }
1094 }
1095
1096 /* Close events element */
1097 ret = mi_lttng_writer_close_element(writer);
1098
1099 end:
1100 return ret;
1101 }
1102
1103 /*
1104 * List agent events for a specific session using the handle.
1105 *
1106 * Return CMD_SUCCESS on success else a negative value.
1107 */
1108 static int list_session_agent_events(void)
1109 {
1110 int ret = CMD_SUCCESS, count, i;
1111 struct lttng_event *events = NULL;
1112
1113 count = lttng_list_events(handle, "", &events);
1114 if (count < 0) {
1115 ret = CMD_ERROR;
1116 ERR("%s", lttng_strerror(count));
1117 goto error;
1118 }
1119
1120 if (lttng_opt_mi) {
1121 /* Mi print */
1122 ret = mi_list_session_agent_events(events, count);
1123 if (ret) {
1124 ret = CMD_ERROR;
1125 goto end;
1126 }
1127 } else {
1128 /* Pretty print */
1129 MSG("Events (Logger name):\n---------------------");
1130 if (count == 0) {
1131 MSG("%sNone\n", indent6);
1132 goto end;
1133 }
1134
1135 for (i = 0; i < count; i++) {
1136 const char *filter_str;
1137 char *filter_msg = NULL;
1138 struct lttng_event *event = &events[i];
1139
1140 ret = lttng_event_get_filter_expression(event,
1141 &filter_str);
1142 if (ret) {
1143 filter_msg = strdup(" [failed to retrieve filter]");
1144 } else if (filter_str) {
1145 const char * const filter_fmt =
1146 " [filter: '%s']";
1147
1148 filter_msg = malloc(strlen(filter_str) +
1149 strlen(filter_fmt) + 1);
1150 if (filter_msg) {
1151 sprintf(filter_msg, filter_fmt,
1152 filter_str);
1153 }
1154 }
1155
1156 if (event->loglevel_type !=
1157 LTTNG_EVENT_LOGLEVEL_ALL) {
1158 MSG("%s- %s%s (loglevel%s %s)%s", indent4,
1159 event->name,
1160 enabled_string(event->enabled),
1161 logleveltype_string(
1162 event->loglevel_type),
1163 mi_lttng_loglevel_string(
1164 event->loglevel,
1165 handle->domain.type),
1166 safe_string(filter_msg));
1167 } else {
1168 MSG("%s- %s%s%s", indent4, event->name,
1169 enabled_string(event->enabled),
1170 safe_string(filter_msg));
1171 }
1172 free(filter_msg);
1173 }
1174
1175 MSG("");
1176 }
1177
1178 end:
1179 free(events);
1180 error:
1181 return ret;
1182 }
1183
1184 /*
1185 * Machine interface
1186 * print a list of event
1187 */
1188 static int mi_list_events(struct lttng_event *events, int count)
1189 {
1190 int ret, i;
1191
1192 /* Open events element */
1193 ret = mi_lttng_events_open(writer);
1194 if (ret) {
1195 goto end;
1196 }
1197
1198 for (i = 0; i < count; i++) {
1199 ret = mi_lttng_event(writer, &events[i], 0, handle->domain.type);
1200 if (ret) {
1201 goto end;
1202 }
1203 }
1204
1205 /* Close events element */
1206 ret = mi_lttng_writer_close_element(writer);
1207
1208 end:
1209 return ret;
1210 }
1211
1212 /*
1213 * List events of channel of session and domain.
1214 */
1215 static int list_events(const char *channel_name)
1216 {
1217 int ret = CMD_SUCCESS, count, i;
1218 struct lttng_event *events = NULL;
1219
1220 count = lttng_list_events(handle, channel_name, &events);
1221 if (count < 0) {
1222 ret = CMD_ERROR;
1223 ERR("%s", lttng_strerror(count));
1224 goto error;
1225 }
1226
1227 if (lttng_opt_mi) {
1228 /* Mi print */
1229 ret = mi_list_events(events, count);
1230 if (ret) {
1231 ret = CMD_ERROR;
1232 goto end;
1233 }
1234 } else {
1235 /* Pretty print */
1236 MSG("\n%sEvent rules:", indent4);
1237 if (count == 0) {
1238 MSG("%sNone\n", indent6);
1239 goto end;
1240 }
1241
1242 for (i = 0; i < count; i++) {
1243 print_events(&events[i]);
1244 }
1245
1246 MSG("");
1247 }
1248 end:
1249 free(events);
1250 error:
1251 return ret;
1252 }
1253
1254 static
1255 void print_timer(const char *timer_name, uint32_t space_count, int64_t value)
1256 {
1257 uint32_t i;
1258
1259 _MSG("%s%s:", indent6, timer_name);
1260 for (i = 0; i < space_count; i++) {
1261 _MSG(" ");
1262 }
1263
1264 if (value) {
1265 MSG("%" PRId64 " %s", value, USEC_UNIT);
1266 } else {
1267 MSG("inactive");
1268 }
1269 }
1270
1271 /*
1272 * Pretty print channel
1273 */
1274 static void print_channel(struct lttng_channel *channel)
1275 {
1276 int ret;
1277 uint64_t discarded_events, lost_packets, monitor_timer_interval;
1278 int64_t blocking_timeout;
1279
1280 ret = lttng_channel_get_discarded_event_count(channel,
1281 &discarded_events);
1282 if (ret) {
1283 ERR("Failed to retrieve discarded event count of channel");
1284 return;
1285 }
1286
1287 ret = lttng_channel_get_lost_packet_count(channel,
1288 &lost_packets);
1289 if (ret) {
1290 ERR("Failed to retrieve lost packet count of channel");
1291 return;
1292 }
1293
1294 ret = lttng_channel_get_monitor_timer_interval(channel,
1295 &monitor_timer_interval);
1296 if (ret) {
1297 ERR("Failed to retrieve monitor interval of channel");
1298 return;
1299 }
1300
1301 ret = lttng_channel_get_blocking_timeout(channel,
1302 &blocking_timeout);
1303 if (ret) {
1304 ERR("Failed to retrieve blocking timeout of channel");
1305 return;
1306 }
1307
1308 MSG("- %s:%s\n", channel->name, enabled_string(channel->enabled));
1309 MSG("%sAttributes:", indent4);
1310 MSG("%sEvent-loss mode: %s", indent6, channel->attr.overwrite ? "overwrite" : "discard");
1311 MSG("%sSub-buffer size: %" PRIu64 " bytes", indent6, channel->attr.subbuf_size);
1312 MSG("%sSub-buffer count: %" PRIu64, indent6, channel->attr.num_subbuf);
1313
1314 print_timer("Switch timer", 5, channel->attr.switch_timer_interval);
1315 print_timer("Read timer", 7, channel->attr.read_timer_interval);
1316 print_timer("Monitor timer", 4, monitor_timer_interval);
1317
1318 if (!channel->attr.overwrite) {
1319 if (blocking_timeout == -1) {
1320 MSG("%sBlocking timeout: infinite", indent6);
1321 } else {
1322 MSG("%sBlocking timeout: %" PRId64 " %s", indent6,
1323 blocking_timeout, USEC_UNIT);
1324 }
1325 }
1326
1327 MSG("%sTrace file count: %" PRIu64 " per stream", indent6,
1328 channel->attr.tracefile_count == 0 ?
1329 1 : channel->attr.tracefile_count);
1330 if (channel->attr.tracefile_size != 0 ) {
1331 MSG("%sTrace file size: %" PRIu64 " bytes", indent6,
1332 channel->attr.tracefile_size);
1333 } else {
1334 MSG("%sTrace file size: %s", indent6, "unlimited");
1335 }
1336 switch (channel->attr.output) {
1337 case LTTNG_EVENT_SPLICE:
1338 MSG("%sOutput mode: splice", indent6);
1339 break;
1340 case LTTNG_EVENT_MMAP:
1341 MSG("%sOutput mode: mmap", indent6);
1342 break;
1343 }
1344
1345 MSG("\n%sStatistics:", indent4);
1346 if (listed_session.snapshot_mode) {
1347 /*
1348 * The lost packet count is omitted for sessions in snapshot
1349 * mode as it is misleading: it would indicate the number of
1350 * packets that the consumer could not extract during the
1351 * course of recording the snapshot. It does not have the
1352 * same meaning as the "regular" lost packet count that
1353 * would result from the consumer not keeping up with
1354 * event production in an overwrite-mode channel.
1355 *
1356 * A more interesting statistic would be the number of
1357 * packets lost between the first and last extracted
1358 * packets of a given snapshot (which prevents most analyses).
1359 */
1360 MSG("%sNone", indent6);
1361 goto skip_stats_printing;
1362 }
1363
1364 if (!channel->attr.overwrite) {
1365 MSG("%sDiscarded events: %" PRIu64, indent6, discarded_events);
1366 } else {
1367 MSG("%sLost packets: %" PRIu64, indent6, lost_packets);
1368 }
1369 skip_stats_printing:
1370 return;
1371 }
1372
1373 static void print_map(const struct lttng_map *map)
1374 {
1375 const char *map_name;
1376 enum lttng_map_status map_status;
1377 enum lttng_buffer_type buffer_type;
1378 enum lttng_map_bitness bitness;
1379 enum lttng_map_boundary_policy boundary_policy;
1380 uint64_t bucket_count;
1381 bool is_enabled;
1382
1383 bitness = lttng_map_get_bitness(map);
1384 is_enabled = lttng_map_get_is_enabled(map);
1385 buffer_type = lttng_map_get_buffer_type(map);
1386
1387 boundary_policy = lttng_map_get_boundary_policy(map);
1388
1389 map_status = lttng_map_get_name(map, &map_name);
1390 if (map_status != LTTNG_MAP_STATUS_OK) {
1391 ERR("Failed to get map name");
1392 goto end;
1393 }
1394
1395 map_status = lttng_map_get_dimension_length(map, 0, &bucket_count);
1396 if (map_status != LTTNG_MAP_STATUS_OK) {
1397 ERR("Failed to bucket count");
1398 goto end;
1399 }
1400
1401 MSG("- %s (%s)", map_name, is_enabled ? "enabled": "disabled");
1402 MSG("%sAttributes:", indent4);
1403 MSG("%sBitness: %s", indent6, bitness == LTTNG_MAP_BITNESS_32BITS ? "32" : "64");
1404 _MSG("%sCounter type: ", indent6);
1405 switch (buffer_type) {
1406 case LTTNG_BUFFER_PER_PID:
1407 MSG("per-pid");
1408 break;
1409 case LTTNG_BUFFER_PER_UID:
1410 MSG("per-uid");
1411 break;
1412 case LTTNG_BUFFER_GLOBAL:
1413 MSG("global");
1414 break;
1415 default:
1416 abort();
1417 }
1418 MSG("%sBoundary policy: %s", indent6,
1419 boundary_policy == LTTNG_MAP_BOUNDARY_POLICY_OVERFLOW ? "OVERFLOW" : "<unknown>");
1420 MSG("%sBucket count: %"PRIu64, indent6, bucket_count);
1421 end:
1422 return;
1423 }
1424
1425 /*
1426 * Machine interface
1427 * Print a list of channel
1428 *
1429 */
1430 static int mi_list_channels(struct lttng_channel *channels, int count,
1431 const char *channel_name)
1432 {
1433 int i, ret;
1434 unsigned int chan_found = 0;
1435
1436 /* Open channels element */
1437 ret = mi_lttng_channels_open(writer);
1438 if (ret) {
1439 goto error;
1440 }
1441
1442 for (i = 0; i < count; i++) {
1443 if (channel_name != NULL) {
1444 if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
1445 chan_found = 1;
1446 } else {
1447 continue;
1448 }
1449 }
1450
1451 /* Write channel element and leave it open */
1452 ret = mi_lttng_channel(writer, &channels[i], 1);
1453 if (ret) {
1454 goto error;
1455 }
1456
1457 /* Listing events per channel */
1458 ret = list_events(channels[i].name);
1459 if (ret) {
1460 goto error;
1461 }
1462
1463 /* Closing the channel element we opened earlier */
1464 ret = mi_lttng_writer_close_element(writer);
1465 if (ret) {
1466 goto error;
1467 }
1468
1469 if (chan_found) {
1470 break;
1471 }
1472 }
1473
1474 /* Close channels element */
1475 ret = mi_lttng_writer_close_element(writer);
1476 if (ret) {
1477 goto error;
1478 }
1479
1480 error:
1481 return ret;
1482 }
1483
1484 /*
1485 * List channel(s) of session and domain.
1486 *
1487 * If channel_name is NULL, all channels are listed.
1488 */
1489 static int list_channels(const char *channel_name)
1490 {
1491 int count, i, ret = CMD_SUCCESS;
1492 unsigned int chan_found = 0;
1493 struct lttng_channel *channels = NULL;
1494
1495 DBG("Listing channel(s) (%s)", channel_name ? : "<all>");
1496
1497 count = lttng_list_channels(handle, &channels);
1498 if (count < 0) {
1499 switch (-count) {
1500 case LTTNG_ERR_KERN_CHAN_NOT_FOUND:
1501 if (lttng_opt_mi) {
1502 /* When printing mi this is not an error
1503 * but an empty channels element */
1504 count = 0;
1505 } else {
1506 ret = CMD_SUCCESS;
1507 goto error_channels;
1508 }
1509 break;
1510 default:
1511 /* We had a real error */
1512 ret = CMD_ERROR;
1513 ERR("%s", lttng_strerror(count));
1514 goto error_channels;
1515 break;
1516 }
1517 }
1518
1519 if (lttng_opt_mi) {
1520 /* Mi print */
1521 ret = mi_list_channels(channels, count, channel_name);
1522 if (ret) {
1523 ret = CMD_ERROR;
1524 goto error;
1525 }
1526 } else {
1527 /* Pretty print */
1528 if (count) {
1529 MSG("Channels:\n-------------");
1530 }
1531
1532 for (i = 0; i < count; i++) {
1533 if (channel_name != NULL) {
1534 if (strncmp(channels[i].name, channel_name, NAME_MAX) == 0) {
1535 chan_found = 1;
1536 } else {
1537 continue;
1538 }
1539 }
1540 print_channel(&channels[i]);
1541
1542 /* Listing events per channel */
1543 ret = list_events(channels[i].name);
1544 if (ret) {
1545 goto error;
1546 }
1547
1548 if (chan_found) {
1549 break;
1550 }
1551 }
1552
1553 if (!chan_found && channel_name != NULL) {
1554 ret = CMD_ERROR;
1555 ERR("Channel %s not found", channel_name);
1556 goto error;
1557 }
1558 }
1559 error:
1560 free(channels);
1561
1562 error_channels:
1563 return ret;
1564 }
1565
1566 /*
1567 * List map(s) of session and domain.
1568 *
1569 * If map_name is NULL, all maps are listed.
1570 */
1571 static int list_maps(const char *desired_map_name)
1572 {
1573 struct lttng_map_list *map_list = NULL;
1574 enum lttng_map_status map_status;
1575 enum lttng_error_code ret_code;
1576 unsigned int i, map_count;
1577 int ret = CMD_SUCCESS;
1578
1579 DBG("Listing map(s) (%s)", desired_map_name ? : "<all>");
1580
1581 ret_code = lttng_list_maps(handle, &map_list);
1582 if (ret_code != LTTNG_OK) {
1583 ERR("Error getting map list");
1584 ret = CMD_ERROR;
1585 goto end;
1586 }
1587
1588 map_status = lttng_map_list_get_count(map_list, &map_count);
1589 if (map_status != LTTNG_MAP_STATUS_OK) {
1590 ERR("Error getting map list element count");
1591 ret = CMD_ERROR;
1592 goto end;
1593 }
1594
1595 MSG("Maps:\n-------------");
1596 for (i = 0; i < map_count; i++) {
1597 const struct lttng_map *map = NULL;
1598 const char *map_name = NULL;
1599 map = lttng_map_list_get_at_index(map_list, i);
1600 if (!map) {
1601 ret = CMD_ERROR;
1602 ERR("Error getting map from list: index = %u", i);
1603 goto end;
1604 }
1605
1606 map_status = lttng_map_get_name(map, &map_name);
1607 if (map_status != LTTNG_MAP_STATUS_OK) {
1608 ERR("Error getting map name");
1609 ret = CMD_ERROR;
1610 goto end;
1611 }
1612
1613 if (desired_map_name != NULL) {
1614 if (strncmp(map_name, desired_map_name, NAME_MAX) == 0) {
1615 print_map(map);
1616 break;
1617 }
1618 } else {
1619 print_map(map);
1620 }
1621 }
1622 end:
1623 // Should be in its own patch.
1624 lttng_map_list_destroy(map_list);
1625 return ret;
1626 }
1627
1628 static const char *get_capitalized_process_attr_str(enum lttng_process_attr process_attr)
1629 {
1630 switch (process_attr) {
1631 case LTTNG_PROCESS_ATTR_PROCESS_ID:
1632 return "Process ID";
1633 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID:
1634 return "Virtual process ID";
1635 case LTTNG_PROCESS_ATTR_USER_ID:
1636 return "User ID";
1637 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID:
1638 return "Virtual user ID";
1639 case LTTNG_PROCESS_ATTR_GROUP_ID:
1640 return "Group ID";
1641 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID:
1642 return "Virtual group ID";
1643 default:
1644 return "Unknown";
1645 }
1646 return NULL;
1647 }
1648
1649 static int handle_process_attr_status(enum lttng_process_attr process_attr,
1650 enum lttng_process_attr_tracker_handle_status status)
1651 {
1652 int ret = CMD_SUCCESS;
1653
1654 switch (status) {
1655 case LTTNG_PROCESS_ATTR_TRACKER_HANDLE_STATUS_INVALID_TRACKING_POLICY:
1656 case LTTNG_PROCESS_ATTR_TRACKER_HANDLE_STATUS_OK:
1657 /* Carry on. */
1658 break;
1659 case LTTNG_PROCESS_ATTR_TRACKER_HANDLE_STATUS_COMMUNICATION_ERROR:
1660 ERR("Communication occurred while fetching %s tracker",
1661 lttng_process_attr_to_string(process_attr));
1662 ret = CMD_ERROR;
1663 break;
1664 case LTTNG_PROCESS_ATTR_TRACKER_HANDLE_STATUS_SESSION_DOES_NOT_EXIST:
1665 ERR("Failed to get the inclusion set of the %s tracker: session `%s` no longer exists",
1666 lttng_process_attr_to_string(process_attr),
1667 handle->session_name);
1668 ret = CMD_ERROR;
1669 break;
1670 default:
1671 ERR("Unknown error occurred while fetching the inclusion set of the %s tracker",
1672 lttng_process_attr_to_string(process_attr));
1673 ret = CMD_ERROR;
1674 break;
1675 }
1676
1677 return ret;
1678 }
1679
1680 static int mi_output_empty_tracker(enum lttng_process_attr process_attr)
1681 {
1682 int ret;
1683
1684 ret = mi_lttng_process_attribute_tracker_open(writer, process_attr);
1685 if (ret) {
1686 goto end;
1687 }
1688
1689 ret = mi_lttng_close_multi_element(writer, 2);
1690 end:
1691 return ret;
1692 }
1693
1694 static inline bool is_value_type_name(
1695 enum lttng_process_attr_value_type value_type)
1696 {
1697 return value_type == LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME ||
1698 value_type == LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME;
1699 }
1700
1701 /*
1702 * List a process attribute tracker for a session and domain tuple.
1703 */
1704 static int list_process_attr_tracker(enum lttng_process_attr process_attr)
1705 {
1706 int ret = 0;
1707 unsigned int count, i;
1708 enum lttng_tracking_policy policy;
1709 enum lttng_error_code ret_code;
1710 enum lttng_process_attr_tracker_handle_status handle_status;
1711 enum lttng_process_attr_values_status values_status;
1712 const struct lttng_process_attr_values *values;
1713 struct lttng_process_attr_tracker_handle *tracker_handle = NULL;
1714
1715 ret_code = lttng_session_get_tracker_handle(handle->session_name,
1716 handle->domain.type, process_attr, &tracker_handle);
1717 if (ret_code != LTTNG_OK) {
1718 ERR("Failed to get process attribute tracker handle: %s",
1719 lttng_strerror(ret_code));
1720 ret = CMD_ERROR;
1721 goto end;
1722 }
1723
1724 handle_status = lttng_process_attr_tracker_handle_get_inclusion_set(
1725 tracker_handle, &values);
1726 ret = handle_process_attr_status(process_attr, handle_status);
1727 if (ret != CMD_SUCCESS) {
1728 goto end;
1729 }
1730
1731 handle_status = lttng_process_attr_tracker_handle_get_tracking_policy(
1732 tracker_handle, &policy);
1733 ret = handle_process_attr_status(process_attr, handle_status);
1734 if (ret != CMD_SUCCESS) {
1735 goto end;
1736 }
1737
1738 {
1739 char *process_attr_name;
1740 const int print_ret = asprintf(&process_attr_name, "%ss:",
1741 get_capitalized_process_attr_str(process_attr));
1742
1743 if (print_ret == -1) {
1744 ret = CMD_FATAL;
1745 goto end;
1746 }
1747 _MSG(" %-22s", process_attr_name);
1748 free(process_attr_name);
1749 }
1750 switch (policy) {
1751 case LTTNG_TRACKING_POLICY_INCLUDE_SET:
1752 break;
1753 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL:
1754 if (writer) {
1755 mi_output_empty_tracker(process_attr);
1756 }
1757 MSG("none");
1758 ret = CMD_SUCCESS;
1759 goto end;
1760 case LTTNG_TRACKING_POLICY_INCLUDE_ALL:
1761 MSG("all");
1762 ret = CMD_SUCCESS;
1763 goto end;
1764 default:
1765 ERR("Unknown tracking policy encoutered while listing the %s process attribute tracker of session `%s`",
1766 lttng_process_attr_to_string(process_attr),
1767 handle->session_name);
1768 ret = CMD_FATAL;
1769 goto end;
1770 }
1771
1772 values_status = lttng_process_attr_values_get_count(values, &count);
1773 if (values_status != LTTNG_PROCESS_ATTR_VALUES_STATUS_OK) {
1774 ERR("Failed to get the count of values in the inclusion set of the %s process attribute tracker of session `%s`",
1775 lttng_process_attr_to_string(process_attr),
1776 handle->session_name);
1777 ret = CMD_FATAL;
1778 goto end;
1779 }
1780
1781 if (count == 0) {
1782 /* Functionally equivalent to the 'exclude all' policy. */
1783 if (writer) {
1784 mi_output_empty_tracker(process_attr);
1785 }
1786 MSG("none");
1787 ret = CMD_SUCCESS;
1788 goto end;
1789 }
1790
1791 /* Mi tracker_id element */
1792 if (writer) {
1793 /* Open tracker_id and targets elements */
1794 ret = mi_lttng_process_attribute_tracker_open(
1795 writer, process_attr);
1796 if (ret) {
1797 goto end;
1798 }
1799 }
1800
1801 for (i = 0; i < count; i++) {
1802 const enum lttng_process_attr_value_type value_type =
1803 lttng_process_attr_values_get_type_at_index(
1804 values, i);
1805 int64_t integral_value = INT64_MAX;
1806 const char *name = "error";
1807
1808 if (i >= 1) {
1809 _MSG(", ");
1810 }
1811 switch (value_type) {
1812 case LTTNG_PROCESS_ATTR_VALUE_TYPE_PID:
1813 {
1814 pid_t pid;
1815
1816 values_status = lttng_process_attr_values_get_pid_at_index(
1817 values, i, &pid);
1818 integral_value = (int64_t) pid;
1819 break;
1820 }
1821 case LTTNG_PROCESS_ATTR_VALUE_TYPE_UID:
1822 {
1823 uid_t uid;
1824
1825 values_status = lttng_process_attr_values_get_uid_at_index(
1826 values, i, &uid);
1827 integral_value = (int64_t) uid;
1828 break;
1829 }
1830 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GID:
1831 {
1832 gid_t gid;
1833
1834 values_status = lttng_process_attr_values_get_gid_at_index(
1835 values, i, &gid);
1836 integral_value = (int64_t) gid;
1837 break;
1838 }
1839 case LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME:
1840 values_status = lttng_process_attr_values_get_user_name_at_index(
1841 values, i, &name);
1842 break;
1843 case LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME:
1844 values_status = lttng_process_attr_values_get_group_name_at_index(
1845 values, i, &name);
1846 break;
1847 default:
1848 ret = CMD_ERROR;
1849 goto end;
1850 }
1851
1852 if (values_status != LTTNG_PROCESS_ATTR_VALUES_STATUS_OK) {
1853 /*
1854 * Not possible given the current liblttng-ctl
1855 * implementation.
1856 */
1857 ERR("Unknown error occurred while fetching process attribute value in inclusion list");
1858 ret = CMD_FATAL;
1859 goto end;
1860 }
1861
1862 if (is_value_type_name(value_type)) {
1863 _MSG("`%s`", name);
1864 } else {
1865 _MSG("%" PRIi64, integral_value);
1866 }
1867
1868 /* Mi */
1869 if (writer) {
1870 ret = is_value_type_name(value_type) ?
1871 mi_lttng_string_process_attribute_value(
1872 writer,
1873 process_attr,
1874 name, false) :
1875 mi_lttng_integral_process_attribute_value(
1876 writer,
1877 process_attr,
1878 integral_value,
1879 false);
1880 if (ret) {
1881 goto end;
1882 }
1883 }
1884 }
1885 MSG("");
1886
1887 /* Mi close tracker_id and targets */
1888 if (writer) {
1889 ret = mi_lttng_close_multi_element(writer, 2);
1890 if (ret) {
1891 goto end;
1892 }
1893 }
1894 end:
1895 lttng_process_attr_tracker_handle_destroy(tracker_handle);
1896 return ret;
1897 }
1898
1899 /*
1900 * List all trackers of a domain
1901 */
1902 static int list_trackers(const struct lttng_domain *domain)
1903 {
1904 int ret = 0;
1905
1906 MSG("Tracked process attributes");
1907 /* Trackers listing */
1908 if (lttng_opt_mi) {
1909 ret = mi_lttng_trackers_open(writer);
1910 if (ret) {
1911 goto end;
1912 }
1913 }
1914
1915 switch (domain->type) {
1916 case LTTNG_DOMAIN_KERNEL:
1917 /* pid tracker */
1918 ret = list_process_attr_tracker(LTTNG_PROCESS_ATTR_PROCESS_ID);
1919 if (ret) {
1920 goto end;
1921 }
1922 /* vpid tracker */
1923 ret = list_process_attr_tracker(
1924 LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID);
1925 if (ret) {
1926 goto end;
1927 }
1928 /* uid tracker */
1929 ret = list_process_attr_tracker(LTTNG_PROCESS_ATTR_USER_ID);
1930 if (ret) {
1931 goto end;
1932 }
1933 /* vuid tracker */
1934 ret = list_process_attr_tracker(
1935 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID);
1936 if (ret) {
1937 goto end;
1938 }
1939 /* gid tracker */
1940 ret = list_process_attr_tracker(LTTNG_PROCESS_ATTR_GROUP_ID);
1941 if (ret) {
1942 goto end;
1943 }
1944 /* vgid tracker */
1945 ret = list_process_attr_tracker(
1946 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID);
1947 if (ret) {
1948 goto end;
1949 }
1950 break;
1951 case LTTNG_DOMAIN_UST:
1952 /* vpid tracker */
1953 ret = list_process_attr_tracker(
1954 LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID);
1955 if (ret) {
1956 goto end;
1957 }
1958 /* vuid tracker */
1959 ret = list_process_attr_tracker(
1960 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID);
1961 if (ret) {
1962 goto end;
1963 }
1964 /* vgid tracker */
1965 ret = list_process_attr_tracker(
1966 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID);
1967 if (ret) {
1968 goto end;
1969 }
1970 break;
1971 default:
1972 break;
1973 }
1974 MSG();
1975 if (lttng_opt_mi) {
1976 /* Close trackers element */
1977 ret = mi_lttng_writer_close_element(writer);
1978 if (ret) {
1979 goto end;
1980 }
1981 }
1982
1983 end:
1984 return ret;
1985 }
1986
1987 static enum cmd_error_code print_periodic_rotation_schedule(
1988 const struct lttng_rotation_schedule *schedule)
1989 {
1990 enum cmd_error_code ret;
1991 enum lttng_rotation_status status;
1992 uint64_t value;
1993
1994 status = lttng_rotation_schedule_periodic_get_period(schedule,
1995 &value);
1996 if (status != LTTNG_ROTATION_STATUS_OK) {
1997 ERR("Failed to retrieve period parameter from periodic rotation schedule.");
1998 ret = CMD_ERROR;
1999 goto end;
2000 }
2001
2002 MSG(" timer period: %" PRIu64" %s", value, USEC_UNIT);
2003 ret = CMD_SUCCESS;
2004 end:
2005 return ret;
2006 }
2007
2008 static enum cmd_error_code print_size_threshold_rotation_schedule(
2009 const struct lttng_rotation_schedule *schedule)
2010 {
2011 enum cmd_error_code ret;
2012 enum lttng_rotation_status status;
2013 uint64_t value;
2014
2015 status = lttng_rotation_schedule_size_threshold_get_threshold(schedule,
2016 &value);
2017 if (status != LTTNG_ROTATION_STATUS_OK) {
2018 ERR("Failed to retrieve size parameter from size-based rotation schedule.");
2019 ret = CMD_ERROR;
2020 goto end;
2021 }
2022
2023 MSG(" size threshold: %" PRIu64" bytes", value);
2024 ret = CMD_SUCCESS;
2025 end:
2026 return ret;
2027 }
2028
2029 static enum cmd_error_code print_rotation_schedule(
2030 const struct lttng_rotation_schedule *schedule)
2031 {
2032 enum cmd_error_code ret;
2033
2034 switch (lttng_rotation_schedule_get_type(schedule)) {
2035 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD:
2036 ret = print_size_threshold_rotation_schedule(schedule);
2037 break;
2038 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC:
2039 ret = print_periodic_rotation_schedule(schedule);
2040 break;
2041 default:
2042 ret = CMD_ERROR;
2043 }
2044 return ret;
2045 }
2046
2047 /*
2048 * List the automatic rotation settings.
2049 */
2050 static enum cmd_error_code list_rotate_settings(const char *session_name)
2051 {
2052 int ret;
2053 enum cmd_error_code cmd_ret = CMD_SUCCESS;
2054 unsigned int count, i;
2055 struct lttng_rotation_schedules *schedules = NULL;
2056 enum lttng_rotation_status status;
2057
2058 ret = lttng_session_list_rotation_schedules(session_name, &schedules);
2059 if (ret != LTTNG_OK) {
2060 ERR("Failed to list session rotation schedules: %s", lttng_strerror(ret));
2061 cmd_ret = CMD_ERROR;
2062 goto end;
2063 }
2064
2065 status = lttng_rotation_schedules_get_count(schedules, &count);
2066 if (status != LTTNG_ROTATION_STATUS_OK) {
2067 ERR("Failed to retrieve the number of session rotation schedules.");
2068 cmd_ret = CMD_ERROR;
2069 goto end;
2070 }
2071
2072 if (count == 0) {
2073 cmd_ret = CMD_SUCCESS;
2074 goto end;
2075 }
2076
2077 MSG("Automatic rotation schedules:");
2078 if (lttng_opt_mi) {
2079 ret = mi_lttng_writer_open_element(writer,
2080 mi_lttng_element_rotation_schedules);
2081 if (ret) {
2082 cmd_ret = CMD_ERROR;
2083 goto end;
2084 }
2085 }
2086
2087 for (i = 0; i < count; i++) {
2088 enum cmd_error_code tmp_ret = CMD_SUCCESS;
2089 const struct lttng_rotation_schedule *schedule;
2090
2091 schedule = lttng_rotation_schedules_get_at_index(schedules, i);
2092 if (!schedule) {
2093 ERR("Failed to retrieve session rotation schedule.");
2094 cmd_ret = CMD_ERROR;
2095 goto end;
2096 }
2097
2098 if (lttng_opt_mi) {
2099 ret = mi_lttng_rotation_schedule(writer, schedule);
2100 if (ret) {
2101 tmp_ret = CMD_ERROR;
2102 }
2103 } else {
2104 tmp_ret = print_rotation_schedule(schedule);
2105 }
2106
2107 /*
2108 * Report an error if the serialization of any of the
2109 * descriptors failed.
2110 */
2111 cmd_ret = cmd_ret ? cmd_ret : tmp_ret;
2112 }
2113
2114 _MSG("\n");
2115 if (lttng_opt_mi) {
2116 /* Close the rotation_schedules element. */
2117 ret = mi_lttng_writer_close_element(writer);
2118 if (ret) {
2119 cmd_ret = CMD_ERROR;
2120 goto end;
2121 }
2122 }
2123 end:
2124 lttng_rotation_schedules_destroy(schedules);
2125 return cmd_ret;
2126 }
2127
2128 /*
2129 * Machine interface
2130 * Find the session with session_name as name
2131 * and print his informations.
2132 */
2133 static int mi_list_session(const char *session_name,
2134 struct lttng_session *sessions, int count)
2135 {
2136 int ret, i;
2137 unsigned int session_found = 0;
2138
2139 if (session_name == NULL) {
2140 ret = -LTTNG_ERR_SESS_NOT_FOUND;
2141 goto end;
2142 }
2143
2144 for (i = 0; i < count; i++) {
2145 if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
2146 /* We need to leave it open to append other informations
2147 * like domain, channel, events etc.*/
2148 session_found = 1;
2149 ret = mi_lttng_session(writer, &sessions[i], 1);
2150 if (ret) {
2151 goto end;
2152 }
2153 break;
2154 }
2155 }
2156
2157 if (!session_found) {
2158 ERR("Session '%s' not found", session_name);
2159 ret = -LTTNG_ERR_SESS_NOT_FOUND;
2160 goto end;
2161 }
2162
2163 end:
2164 return ret;
2165 }
2166
2167 /*
2168 * Machine interface
2169 * List all availables session
2170 */
2171 static int mi_list_sessions(struct lttng_session *sessions, int count)
2172 {
2173 int ret, i;
2174
2175 /* Opening sessions element */
2176 ret = mi_lttng_sessions_open(writer);
2177 if (ret) {
2178 goto end;
2179 }
2180
2181 /* Listing sessions */
2182 for (i = 0; i < count; i++) {
2183 ret = mi_lttng_session(writer, &sessions[i], 0);
2184 if (ret) {
2185 goto end;
2186 }
2187 }
2188
2189 /* Closing sessions element */
2190 ret = mi_lttng_writer_close_element(writer);
2191 if (ret) {
2192 goto end;
2193 }
2194
2195 end:
2196 return ret;
2197 }
2198
2199 /*
2200 * List available tracing session. List only basic information.
2201 *
2202 * If session_name is NULL, all sessions are listed.
2203 */
2204 static int list_sessions(const char *session_name)
2205 {
2206 int ret = CMD_SUCCESS;
2207 int count, i;
2208 unsigned int session_found = 0;
2209 struct lttng_session *sessions = NULL;
2210
2211 count = lttng_list_sessions(&sessions);
2212 DBG("Session count %d", count);
2213 if (count < 0) {
2214 ret = CMD_ERROR;
2215 ERR("%s", lttng_strerror(count));
2216 goto end;
2217 }
2218
2219 if (lttng_opt_mi) {
2220 /* Mi */
2221 if (session_name == NULL) {
2222 /* List all sessions */
2223 ret = mi_list_sessions(sessions, count);
2224 } else {
2225 /* Note : this return an open session element */
2226 ret = mi_list_session(session_name, sessions, count);
2227 }
2228 if (ret) {
2229 ret = CMD_ERROR;
2230 goto end;
2231 }
2232 } else {
2233 /* Pretty print */
2234 if (count == 0) {
2235 MSG("Currently no available tracing session");
2236 goto end;
2237 }
2238
2239 if (session_name == NULL) {
2240 MSG("Available tracing sessions:");
2241 }
2242
2243 for (i = 0; i < count; i++) {
2244 if (session_name != NULL) {
2245 if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
2246 session_found = 1;
2247 MSG("Tracing session %s: [%s%s]", session_name,
2248 active_string(sessions[i].enabled),
2249 snapshot_string(sessions[i].snapshot_mode));
2250 if (*sessions[i].path) {
2251 MSG("%sTrace output: %s\n", indent4, sessions[i].path);
2252 }
2253 memcpy(&listed_session, &sessions[i],
2254 sizeof(listed_session));
2255 break;
2256 }
2257 } else {
2258 MSG(" %d) %s [%s%s]", i + 1,
2259 sessions[i].name,
2260 active_string(sessions[i].enabled),
2261 snapshot_string(sessions[i].snapshot_mode));
2262 if (*sessions[i].path) {
2263 MSG("%sTrace output: %s", indent4, sessions[i].path);
2264 }
2265 if (sessions[i].live_timer_interval != 0) {
2266 MSG("%sLive timer interval: %u %s", indent4,
2267 sessions[i].live_timer_interval,
2268 USEC_UNIT);
2269 }
2270 MSG("");
2271 }
2272 }
2273
2274 if (!session_found && session_name != NULL) {
2275 ERR("Session '%s' not found", session_name);
2276 ret = CMD_ERROR;
2277 goto end;
2278 }
2279
2280 if (session_name == NULL) {
2281 MSG("\nUse lttng list <session_name> for more details");
2282 }
2283 }
2284
2285 end:
2286 free(sessions);
2287 return ret;
2288 }
2289
2290
2291 /*
2292 * Machine Interface
2293 * list available domain(s) for a session.
2294 */
2295 static int mi_list_domains(struct lttng_domain *domains, int count)
2296 {
2297 int i, ret;
2298 /* Open domains element */
2299 ret = mi_lttng_domains_open(writer);
2300 if (ret) {
2301 goto end;
2302 }
2303
2304 for (i = 0; i < count; i++) {
2305 ret = mi_lttng_domain(writer, &domains[i] , 0);
2306 if (ret) {
2307 goto end;
2308 }
2309 }
2310
2311 /* Closing domains element */
2312 ret = mi_lttng_writer_close_element(writer);
2313 if (ret) {
2314 goto end;
2315 }
2316 end:
2317 return ret;
2318 }
2319
2320 /*
2321 * List available domain(s) for a session.
2322 */
2323 static int list_domains(const char *session_name)
2324 {
2325 int i, count, ret = CMD_SUCCESS;
2326 struct lttng_domain *domains = NULL;
2327
2328
2329 count = lttng_list_domains(session_name, &domains);
2330 if (count < 0) {
2331 ret = CMD_ERROR;
2332 ERR("%s", lttng_strerror(count));
2333 goto end;
2334 }
2335
2336 if (lttng_opt_mi) {
2337 /* Mi output */
2338 ret = mi_list_domains(domains, count);
2339 if (ret) {
2340 ret = CMD_ERROR;
2341 goto error;
2342 }
2343 } else {
2344 /* Pretty print */
2345 MSG("Domains:\n-------------");
2346 if (count == 0) {
2347 MSG(" None");
2348 goto end;
2349 }
2350
2351 for (i = 0; i < count; i++) {
2352 switch (domains[i].type) {
2353 case LTTNG_DOMAIN_KERNEL:
2354 MSG(" - Kernel");
2355 break;
2356 case LTTNG_DOMAIN_UST:
2357 MSG(" - UST global");
2358 break;
2359 case LTTNG_DOMAIN_JUL:
2360 MSG(" - JUL (Java Util Logging)");
2361 break;
2362 case LTTNG_DOMAIN_LOG4J:
2363 MSG(" - LOG4j (Logging for Java)");
2364 break;
2365 case LTTNG_DOMAIN_PYTHON:
2366 MSG(" - Python (logging)");
2367 break;
2368 default:
2369 break;
2370 }
2371 }
2372 }
2373
2374 error:
2375 free(domains);
2376
2377 end:
2378 return ret;
2379 }
2380
2381 /*
2382 * The 'list <options>' first level command
2383 */
2384 int cmd_list(int argc, const char **argv)
2385 {
2386 int opt, ret = CMD_SUCCESS;
2387 const char *session_name, *leftover = NULL;
2388 static poptContext pc;
2389 struct lttng_domain domain;
2390 struct lttng_domain *domains = NULL;
2391
2392 memset(&domain, 0, sizeof(domain));
2393
2394 if (argc < 1) {
2395 ret = CMD_ERROR;
2396 goto end;
2397 }
2398
2399 pc = poptGetContext(NULL, argc, argv, long_options, 0);
2400 poptReadDefaultConfig(pc, 0);
2401
2402 while ((opt = poptGetNextOpt(pc)) != -1) {
2403 switch (opt) {
2404 case OPT_HELP:
2405 SHOW_HELP();
2406 goto end;
2407 case OPT_USERSPACE:
2408 opt_userspace = 1;
2409 break;
2410 case OPT_LIST_OPTIONS:
2411 list_cmd_options(stdout, long_options);
2412 goto end;
2413 default:
2414 ret = CMD_UNDEFINED;
2415 goto end;
2416 }
2417 }
2418
2419 /* Mi check */
2420 if (lttng_opt_mi) {
2421 writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
2422 if (!writer) {
2423 ret = CMD_ERROR;
2424 goto end;
2425 }
2426
2427 /* Open command element */
2428 ret = mi_lttng_writer_command_open(writer,
2429 mi_lttng_element_command_list);
2430 if (ret) {
2431 ret = CMD_ERROR;
2432 goto end;
2433 }
2434
2435 /* Open output element */
2436 ret = mi_lttng_writer_open_element(writer,
2437 mi_lttng_element_command_output);
2438 if (ret) {
2439 ret = CMD_ERROR;
2440 goto end;
2441 }
2442 }
2443
2444 /* Get session name (trailing argument) */
2445 session_name = poptGetArg(pc);
2446 DBG2("Session name: %s", session_name);
2447
2448 leftover = poptGetArg(pc);
2449 if (leftover) {
2450 ERR("Unknown argument: %s", leftover);
2451 ret = CMD_ERROR;
2452 goto end;
2453 }
2454
2455 if (opt_kernel) {
2456 domain.type = LTTNG_DOMAIN_KERNEL;
2457 } else if (opt_userspace) {
2458 DBG2("Listing userspace global domain");
2459 domain.type = LTTNG_DOMAIN_UST;
2460 } else if (opt_jul) {
2461 DBG2("Listing JUL domain");
2462 domain.type = LTTNG_DOMAIN_JUL;
2463 } else if (opt_log4j) {
2464 domain.type = LTTNG_DOMAIN_LOG4J;
2465 } else if (opt_python) {
2466 domain.type = LTTNG_DOMAIN_PYTHON;
2467 }
2468
2469 if (!opt_kernel && opt_syscall) {
2470 WARN("--syscall will only work with the Kernel domain (-k)");
2471 ret = CMD_ERROR;
2472 goto end;
2473 }
2474
2475 if (opt_kernel || opt_userspace || opt_jul || opt_log4j || opt_python) {
2476 handle = lttng_create_handle(session_name, &domain);
2477 if (handle == NULL) {
2478 ret = CMD_FATAL;
2479 goto end;
2480 }
2481 }
2482
2483 if (session_name == NULL) {
2484 if (!opt_kernel && !opt_userspace && !opt_jul && !opt_log4j
2485 && !opt_python) {
2486 ret = list_sessions(NULL);
2487 if (ret) {
2488 goto end;
2489 }
2490 }
2491 if (opt_kernel) {
2492 if (opt_syscall) {
2493 ret = list_syscalls();
2494 if (ret) {
2495 goto end;
2496 }
2497 } else {
2498 ret = list_kernel_events();
2499 if (ret) {
2500 goto end;
2501 }
2502 }
2503 }
2504 if (opt_userspace) {
2505 if (opt_fields) {
2506 ret = list_ust_event_fields();
2507 } else {
2508 ret = list_ust_events();
2509 }
2510 if (ret) {
2511 goto end;
2512 }
2513 }
2514 if (opt_jul || opt_log4j || opt_python) {
2515 ret = list_agent_events();
2516 if (ret) {
2517 goto end;
2518 }
2519 }
2520 } else {
2521 /* List session attributes */
2522 if (lttng_opt_mi) {
2523 /* Open element sessions
2524 * Present for xml consistency */
2525 ret = mi_lttng_sessions_open(writer);
2526 if (ret) {
2527 goto end;
2528 }
2529 }
2530 /* MI: the ouptut of list_sessions is an unclosed session element */
2531 ret = list_sessions(session_name);
2532 if (ret) {
2533 goto end;
2534 }
2535
2536 ret = list_rotate_settings(session_name);
2537 if (ret) {
2538 goto end;
2539 }
2540
2541 /* Domain listing */
2542 if (opt_domain) {
2543 ret = list_domains(session_name);
2544 goto end;
2545 }
2546
2547 /* Channel listing */
2548 if (opt_kernel || opt_userspace) {
2549 if (lttng_opt_mi) {
2550 /* Add of domains and domain element for xml
2551 * consistency and validation
2552 */
2553 ret = mi_lttng_domains_open(writer);
2554 if (ret) {
2555 goto end;
2556 }
2557
2558 /* Open domain and leave it open for
2559 * nested channels printing */
2560 ret = mi_lttng_domain(writer, &domain, 1);
2561 if (ret) {
2562 goto end;
2563 }
2564
2565 }
2566
2567
2568 /* Trackers */
2569 ret = list_trackers(&domain);
2570 if (ret) {
2571 goto end;
2572 }
2573
2574 /* Channels */
2575 ret = list_channels(opt_channel);
2576 if (ret) {
2577 goto end;
2578 }
2579
2580 ret = list_maps(opt_map);
2581 if (ret) {
2582 goto end;
2583 }
2584
2585 if (lttng_opt_mi) {
2586 /* Close domain and domain element */
2587 ret = mi_lttng_close_multi_element(writer, 2);
2588 }
2589 if (ret) {
2590 goto end;
2591 }
2592
2593
2594 } else {
2595 int i, nb_domain;
2596
2597 /* We want all domain(s) */
2598 nb_domain = lttng_list_domains(session_name, &domains);
2599 if (nb_domain < 0) {
2600 ret = CMD_ERROR;
2601 ERR("%s", lttng_strerror(nb_domain));
2602 goto end;
2603 }
2604
2605 if (lttng_opt_mi) {
2606 ret = mi_lttng_domains_open(writer);
2607 if (ret) {
2608 ret = CMD_ERROR;
2609 goto end;
2610 }
2611 }
2612
2613 for (i = 0; i < nb_domain; i++) {
2614 switch (domains[i].type) {
2615 case LTTNG_DOMAIN_KERNEL:
2616 MSG("=== Domain: Linux kernel ===\n");
2617 break;
2618 case LTTNG_DOMAIN_UST:
2619 MSG("=== Domain: User space ===\n");
2620 MSG("Buffering scheme: %s\n",
2621 domains[i].buf_type ==
2622 LTTNG_BUFFER_PER_PID ? "per-process" : "per-user");
2623 break;
2624 case LTTNG_DOMAIN_JUL:
2625 MSG("=== Domain: java.util.logging (JUL) ===\n");
2626 break;
2627 case LTTNG_DOMAIN_LOG4J:
2628 MSG("=== Domain: log4j ===\n");
2629 break;
2630 case LTTNG_DOMAIN_PYTHON:
2631 MSG("=== Domain: Python logging ===\n");
2632 break;
2633 default:
2634 MSG("=== Domain: Unimplemented ===\n");
2635 break;
2636 }
2637
2638 if (lttng_opt_mi) {
2639 ret = mi_lttng_domain(writer, &domains[i], 1);
2640 if (ret) {
2641 ret = CMD_ERROR;
2642 goto end;
2643 }
2644 }
2645
2646 /* Clean handle before creating a new one */
2647 if (handle) {
2648 lttng_destroy_handle(handle);
2649 }
2650
2651 handle = lttng_create_handle(session_name, &domains[i]);
2652 if (handle == NULL) {
2653 ret = CMD_FATAL;
2654 goto end;
2655 }
2656
2657 if (domains[i].type == LTTNG_DOMAIN_JUL ||
2658 domains[i].type == LTTNG_DOMAIN_LOG4J ||
2659 domains[i].type == LTTNG_DOMAIN_PYTHON) {
2660 ret = list_session_agent_events();
2661 if (ret) {
2662 goto end;
2663 }
2664
2665 goto next_domain;
2666 }
2667
2668 switch (domains[i].type) {
2669 case LTTNG_DOMAIN_KERNEL:
2670 case LTTNG_DOMAIN_UST:
2671 ret = list_trackers(&domains[i]);
2672 if (ret) {
2673 goto end;
2674 }
2675 break;
2676 default:
2677 break;
2678 }
2679
2680 ret = list_channels(opt_channel);
2681 if (ret) {
2682 goto end;
2683 }
2684
2685 ret = list_maps(opt_map);
2686 if (ret) {
2687 goto end;
2688 }
2689
2690 next_domain:
2691 if (lttng_opt_mi) {
2692 /* Close domain element */
2693 ret = mi_lttng_writer_close_element(writer);
2694 if (ret) {
2695 ret = CMD_ERROR;
2696 goto end;
2697 }
2698 }
2699
2700 }
2701 if (lttng_opt_mi) {
2702 /* Close the domains, session and sessions element */
2703 ret = mi_lttng_close_multi_element(writer, 3);
2704 if (ret) {
2705 ret = CMD_ERROR;
2706 goto end;
2707 }
2708 }
2709 }
2710 }
2711
2712 /* Mi closing */
2713 if (lttng_opt_mi) {
2714 /* Close output element */
2715 ret = mi_lttng_writer_close_element(writer);
2716 if (ret) {
2717 ret = CMD_ERROR;
2718 goto end;
2719 }
2720
2721 /* Command element close */
2722 ret = mi_lttng_writer_command_close(writer);
2723 if (ret) {
2724 ret = CMD_ERROR;
2725 goto end;
2726 }
2727 }
2728 end:
2729 /* Mi clean-up */
2730 if (writer && mi_lttng_writer_destroy(writer)) {
2731 /* Preserve original error code */
2732 ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
2733 }
2734
2735 free(domains);
2736 if (handle) {
2737 lttng_destroy_handle(handle);
2738 }
2739
2740 poptFreeContext(pc);
2741 return ret;
2742 }
LTTng tools - Deliverables
This page took 0.086035 seconds and 5 git commands to generate.