trackers: support tracking feature
[lttng-tools.git] / src / bin / lttng-sessiond / save.c
1 /*
2 * Copyright (C) 2014 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16 */
17
18 #define _LGPL_SOURCE
19 #include <assert.h>
20 #include <inttypes.h>
21 #include <string.h>
22 #include <urcu/uatomic.h>
23 #include <unistd.h>
24
25 #include <common/defaults.h>
26 #include <common/error.h>
27 #include <common/config/session-config.h>
28 #include <common/utils.h>
29 #include <common/runas.h>
30 #include <lttng/save-internal.h>
31
32 #include "kernel.h"
33 #include "save.h"
34 #include "session.h"
35 #include "lttng-syscall.h"
36 #include "trace-ust.h"
37 #include "agent.h"
38
39 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
40 static
41 int save_kernel_channel_attributes(struct config_writer *writer,
42 struct lttng_channel_attr *attr)
43 {
44 int ret;
45
46 ret = config_writer_write_element_string(writer,
47 config_element_overwrite_mode,
48 attr->overwrite ? config_overwrite_mode_overwrite :
49 config_overwrite_mode_discard);
50 if (ret) {
51 ret = LTTNG_ERR_SAVE_IO_FAIL;
52 goto end;
53 }
54
55 ret = config_writer_write_element_unsigned_int(writer,
56 config_element_subbuf_size, attr->subbuf_size);
57 if (ret) {
58 ret = LTTNG_ERR_SAVE_IO_FAIL;
59 goto end;
60 }
61
62 ret = config_writer_write_element_unsigned_int(writer,
63 config_element_num_subbuf,
64 attr->num_subbuf);
65 if (ret) {
66 ret = LTTNG_ERR_SAVE_IO_FAIL;
67 goto end;
68 }
69
70 ret = config_writer_write_element_unsigned_int(writer,
71 config_element_switch_timer_interval,
72 attr->switch_timer_interval);
73 if (ret) {
74 ret = LTTNG_ERR_SAVE_IO_FAIL;
75 goto end;
76 }
77
78 ret = config_writer_write_element_unsigned_int(writer,
79 config_element_read_timer_interval,
80 attr->read_timer_interval);
81 if (ret) {
82 ret = LTTNG_ERR_SAVE_IO_FAIL;
83 goto end;
84 }
85
86 ret = config_writer_write_element_string(writer,
87 config_element_output_type,
88 attr->output == LTTNG_EVENT_SPLICE ?
89 config_output_type_splice : config_output_type_mmap);
90 if (ret) {
91 ret = LTTNG_ERR_SAVE_IO_FAIL;
92 goto end;
93 }
94
95 ret = config_writer_write_element_unsigned_int(writer,
96 config_element_tracefile_size, attr->tracefile_size);
97 if (ret) {
98 ret = LTTNG_ERR_SAVE_IO_FAIL;
99 goto end;
100 }
101
102 ret = config_writer_write_element_unsigned_int(writer,
103 config_element_tracefile_count,
104 attr->tracefile_count);
105 if (ret) {
106 ret = LTTNG_ERR_SAVE_IO_FAIL;
107 goto end;
108 }
109
110 ret = config_writer_write_element_unsigned_int(writer,
111 config_element_live_timer_interval,
112 attr->live_timer_interval);
113 if (ret) {
114 ret = LTTNG_ERR_SAVE_IO_FAIL;
115 goto end;
116 }
117
118 if (attr->extended.ptr) {
119 struct lttng_channel_extended *ext = NULL;
120
121 ext = (struct lttng_channel_extended *) attr->extended.ptr;
122 ret = config_writer_write_element_unsigned_int(writer,
123 config_element_monitor_timer_interval,
124 ext->monitor_timer_interval);
125 if (ret) {
126 ret = LTTNG_ERR_SAVE_IO_FAIL;
127 goto end;
128 }
129
130 ret = config_writer_write_element_signed_int(writer,
131 config_element_blocking_timeout,
132 ext->blocking_timeout);
133 if (ret) {
134 ret = LTTNG_ERR_SAVE_IO_FAIL;
135 goto end;
136 }
137 }
138
139 ret = LTTNG_OK;
140 end:
141 return ret;
142 }
143
144 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
145 static
146 int save_ust_channel_attributes(struct config_writer *writer,
147 struct lttng_ust_channel_attr *attr)
148 {
149 int ret;
150 struct ltt_ust_channel *channel = NULL;
151
152 ret = config_writer_write_element_string(writer,
153 config_element_overwrite_mode,
154 attr->overwrite ? config_overwrite_mode_overwrite :
155 config_overwrite_mode_discard);
156 if (ret) {
157 ret = LTTNG_ERR_SAVE_IO_FAIL;
158 goto end;
159 }
160
161 ret = config_writer_write_element_unsigned_int(writer,
162 config_element_subbuf_size, attr->subbuf_size);
163 if (ret) {
164 ret = LTTNG_ERR_SAVE_IO_FAIL;
165 goto end;
166 }
167
168 ret = config_writer_write_element_unsigned_int(writer,
169 config_element_num_subbuf,
170 attr->num_subbuf);
171 if (ret) {
172 ret = LTTNG_ERR_SAVE_IO_FAIL;
173 goto end;
174 }
175
176 ret = config_writer_write_element_unsigned_int(writer,
177 config_element_switch_timer_interval,
178 attr->switch_timer_interval);
179 if (ret) {
180 ret = LTTNG_ERR_SAVE_IO_FAIL;
181 goto end;
182 }
183
184 ret = config_writer_write_element_unsigned_int(writer,
185 config_element_read_timer_interval,
186 attr->read_timer_interval);
187 if (ret) {
188 ret = LTTNG_ERR_SAVE_IO_FAIL;
189 goto end;
190 }
191
192 ret = config_writer_write_element_string(writer,
193 config_element_output_type,
194 attr->output == LTTNG_UST_MMAP ?
195 config_output_type_mmap : config_output_type_splice);
196 if (ret) {
197 ret = LTTNG_ERR_SAVE_IO_FAIL;
198 goto end;
199 }
200
201 ret = config_writer_write_element_signed_int(writer,
202 config_element_blocking_timeout,
203 attr->u.s.blocking_timeout);
204 if (ret) {
205 ret = LTTNG_ERR_SAVE_IO_FAIL;
206 goto end;
207 }
208
209 /*
210 * Fetch the monitor timer which is located in the parent of
211 * lttng_ust_channel_attr
212 */
213 channel = caa_container_of(attr, struct ltt_ust_channel, attr);
214 ret = config_writer_write_element_unsigned_int(writer,
215 config_element_monitor_timer_interval,
216 channel->monitor_timer_interval);
217 if (ret) {
218 ret = LTTNG_ERR_SAVE_IO_FAIL;
219 goto end;
220 }
221
222 ret = LTTNG_OK;
223 end:
224 return ret;
225 }
226
227 static
228 const char *get_kernel_instrumentation_string(
229 enum lttng_kernel_instrumentation instrumentation)
230 {
231 const char *instrumentation_string;
232
233 switch (instrumentation) {
234 case LTTNG_KERNEL_ALL:
235 instrumentation_string = config_event_type_all;
236 break;
237 case LTTNG_KERNEL_TRACEPOINT:
238 instrumentation_string = config_event_type_tracepoint;
239 break;
240 case LTTNG_KERNEL_KPROBE:
241 instrumentation_string = config_event_type_probe;
242 break;
243 case LTTNG_KERNEL_UPROBE:
244 instrumentation_string = config_event_type_userspace_probe;
245 break;
246 case LTTNG_KERNEL_FUNCTION:
247 instrumentation_string = config_event_type_function_entry;
248 break;
249 case LTTNG_KERNEL_KRETPROBE:
250 instrumentation_string = config_event_type_function;
251 break;
252 case LTTNG_KERNEL_NOOP:
253 instrumentation_string = config_event_type_noop;
254 break;
255 case LTTNG_KERNEL_SYSCALL:
256 instrumentation_string = config_event_type_syscall;
257 break;
258 default:
259 instrumentation_string = NULL;
260 }
261
262 return instrumentation_string;
263 }
264
265 static
266 const char *get_kernel_context_type_string(
267 enum lttng_kernel_context_type context_type)
268 {
269 const char *context_type_string;
270
271 switch (context_type) {
272 case LTTNG_KERNEL_CONTEXT_PID:
273 context_type_string = config_event_context_pid;
274 break;
275 case LTTNG_KERNEL_CONTEXT_PROCNAME:
276 context_type_string = config_event_context_procname;
277 break;
278 case LTTNG_KERNEL_CONTEXT_PRIO:
279 context_type_string = config_event_context_prio;
280 break;
281 case LTTNG_KERNEL_CONTEXT_NICE:
282 context_type_string = config_event_context_nice;
283 break;
284 case LTTNG_KERNEL_CONTEXT_VPID:
285 context_type_string = config_event_context_vpid;
286 break;
287 case LTTNG_KERNEL_CONTEXT_TID:
288 context_type_string = config_event_context_tid;
289 break;
290 case LTTNG_KERNEL_CONTEXT_VTID:
291 context_type_string = config_event_context_vtid;
292 break;
293 case LTTNG_KERNEL_CONTEXT_PPID:
294 context_type_string = config_event_context_ppid;
295 break;
296 case LTTNG_KERNEL_CONTEXT_VPPID:
297 context_type_string = config_event_context_vppid;
298 break;
299 case LTTNG_KERNEL_CONTEXT_HOSTNAME:
300 context_type_string = config_event_context_hostname;
301 break;
302 case LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE:
303 context_type_string = config_event_context_interruptible;
304 break;
305 case LTTNG_KERNEL_CONTEXT_PREEMPTIBLE:
306 context_type_string = config_event_context_preemptible;
307 break;
308 case LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE:
309 context_type_string = config_event_context_need_reschedule;
310 break;
311 case LTTNG_KERNEL_CONTEXT_MIGRATABLE:
312 context_type_string = config_event_context_migratable;
313 break;
314 case LTTNG_KERNEL_CONTEXT_CALLSTACK_USER:
315 context_type_string = config_event_context_callstack_user;
316 break;
317 case LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL:
318 context_type_string = config_event_context_callstack_kernel;
319 break;
320 case LTTNG_KERNEL_CONTEXT_CGROUP_NS:
321 context_type_string = config_event_context_cgroup_ns;
322 break;
323 case LTTNG_KERNEL_CONTEXT_IPC_NS:
324 context_type_string = config_event_context_ipc_ns;
325 break;
326 case LTTNG_KERNEL_CONTEXT_MNT_NS:
327 context_type_string = config_event_context_mnt_ns;
328 break;
329 case LTTNG_KERNEL_CONTEXT_NET_NS:
330 context_type_string = config_event_context_net_ns;
331 break;
332 case LTTNG_KERNEL_CONTEXT_PID_NS:
333 context_type_string = config_event_context_pid_ns;
334 break;
335 case LTTNG_KERNEL_CONTEXT_USER_NS:
336 context_type_string = config_event_context_user_ns;
337 break;
338 case LTTNG_KERNEL_CONTEXT_UTS_NS:
339 context_type_string = config_event_context_uts_ns;
340 break;
341 case LTTNG_KERNEL_CONTEXT_UID:
342 context_type_string = config_event_context_uid;
343 break;
344 case LTTNG_KERNEL_CONTEXT_EUID:
345 context_type_string = config_event_context_euid;
346 break;
347 case LTTNG_KERNEL_CONTEXT_SUID:
348 context_type_string = config_event_context_suid;
349 break;
350 case LTTNG_KERNEL_CONTEXT_GID:
351 context_type_string = config_event_context_gid;
352 break;
353 case LTTNG_KERNEL_CONTEXT_EGID:
354 context_type_string = config_event_context_egid;
355 break;
356 case LTTNG_KERNEL_CONTEXT_SGID:
357 context_type_string = config_event_context_sgid;
358 break;
359 case LTTNG_KERNEL_CONTEXT_VUID:
360 context_type_string = config_event_context_vuid;
361 break;
362 case LTTNG_KERNEL_CONTEXT_VEUID:
363 context_type_string = config_event_context_veuid;
364 break;
365 case LTTNG_KERNEL_CONTEXT_VSUID:
366 context_type_string = config_event_context_vsuid;
367 break;
368 case LTTNG_KERNEL_CONTEXT_VGID:
369 context_type_string = config_event_context_vgid;
370 break;
371 case LTTNG_KERNEL_CONTEXT_VEGID:
372 context_type_string = config_event_context_vegid;
373 break;
374 case LTTNG_KERNEL_CONTEXT_VSGID:
375 context_type_string = config_event_context_vsgid;
376 break;
377 default:
378 context_type_string = NULL;
379 }
380
381 return context_type_string;
382 }
383
384 static
385 const char *get_ust_context_type_string(
386 enum lttng_ust_context_type context_type)
387 {
388 const char *context_type_string;
389
390 switch (context_type) {
391 case LTTNG_UST_CONTEXT_PROCNAME:
392 context_type_string = config_event_context_procname;
393 break;
394 case LTTNG_UST_CONTEXT_VPID:
395 context_type_string = config_event_context_vpid;
396 break;
397 case LTTNG_UST_CONTEXT_VTID:
398 context_type_string = config_event_context_vtid;
399 break;
400 case LTTNG_UST_CONTEXT_IP:
401 context_type_string = config_event_context_ip;
402 break;
403 case LTTNG_UST_CONTEXT_PTHREAD_ID:
404 context_type_string = config_event_context_pthread_id;
405 break;
406 case LTTNG_UST_CONTEXT_APP_CONTEXT:
407 context_type_string = config_event_context_app;
408 break;
409 case LTTNG_UST_CONTEXT_CGROUP_NS:
410 context_type_string = config_event_context_cgroup_ns;
411 break;
412 case LTTNG_UST_CONTEXT_IPC_NS:
413 context_type_string = config_event_context_ipc_ns;
414 break;
415 case LTTNG_UST_CONTEXT_MNT_NS:
416 context_type_string = config_event_context_mnt_ns;
417 break;
418 case LTTNG_UST_CONTEXT_NET_NS:
419 context_type_string = config_event_context_net_ns;
420 break;
421 case LTTNG_UST_CONTEXT_PID_NS:
422 context_type_string = config_event_context_pid_ns;
423 break;
424 case LTTNG_UST_CONTEXT_USER_NS:
425 context_type_string = config_event_context_user_ns;
426 break;
427 case LTTNG_UST_CONTEXT_UTS_NS:
428 context_type_string = config_event_context_uts_ns;
429 break;
430 case LTTNG_UST_CONTEXT_VUID:
431 context_type_string = config_event_context_vuid;
432 break;
433 case LTTNG_UST_CONTEXT_VEUID:
434 context_type_string = config_event_context_veuid;
435 break;
436 case LTTNG_UST_CONTEXT_VSUID:
437 context_type_string = config_event_context_vsuid;
438 break;
439 case LTTNG_UST_CONTEXT_VGID:
440 context_type_string = config_event_context_vgid;
441 break;
442 case LTTNG_UST_CONTEXT_VEGID:
443 context_type_string = config_event_context_vegid;
444 break;
445 case LTTNG_UST_CONTEXT_VSGID:
446 context_type_string = config_event_context_vsgid;
447 break;
448 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
449 /*
450 * Error, should not be stored in the XML, perf contexts
451 * are stored as a node of type event_perf_context_type.
452 */
453 default:
454 context_type_string = NULL;
455 break;
456 }
457
458 return context_type_string;
459 }
460
461 static
462 const char *get_buffer_type_string(
463 enum lttng_buffer_type buffer_type)
464 {
465 const char *buffer_type_string;
466
467 switch (buffer_type) {
468 case LTTNG_BUFFER_PER_PID:
469 buffer_type_string = config_buffer_type_per_pid;
470 break;
471 case LTTNG_BUFFER_PER_UID:
472 buffer_type_string = config_buffer_type_per_uid;
473 break;
474 case LTTNG_BUFFER_GLOBAL:
475 buffer_type_string = config_buffer_type_global;
476 break;
477 default:
478 buffer_type_string = NULL;
479 }
480
481 return buffer_type_string;
482 }
483
484 static
485 const char *get_loglevel_type_string(
486 enum lttng_ust_loglevel_type loglevel_type)
487 {
488 const char *loglevel_type_string;
489
490 switch (loglevel_type) {
491 case LTTNG_UST_LOGLEVEL_ALL:
492 loglevel_type_string = config_loglevel_type_all;
493 break;
494 case LTTNG_UST_LOGLEVEL_RANGE:
495 loglevel_type_string = config_loglevel_type_range;
496 break;
497 case LTTNG_UST_LOGLEVEL_SINGLE:
498 loglevel_type_string = config_loglevel_type_single;
499 break;
500 default:
501 loglevel_type_string = NULL;
502 }
503
504 return loglevel_type_string;
505 }
506
507 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
508 static
509 int save_kernel_function_event(struct config_writer *writer,
510 struct ltt_kernel_event *event)
511 {
512 int ret;
513
514 ret = config_writer_open_element(writer, config_element_function_attributes);
515 if (ret) {
516 ret = LTTNG_ERR_SAVE_IO_FAIL;
517 goto end;
518 }
519
520 ret = config_writer_write_element_string(writer, config_element_name,
521 event->event->u.ftrace.symbol_name);
522 if (ret) {
523 ret = LTTNG_ERR_SAVE_IO_FAIL;
524 goto end;
525 }
526
527 /* /function attributes */
528 ret = config_writer_close_element(writer);
529 if (ret) {
530 ret = LTTNG_ERR_SAVE_IO_FAIL;
531 goto end;
532 }
533 end:
534 return ret;
535 }
536
537 static
538 int save_kernel_kprobe_event(struct config_writer *writer,
539 struct ltt_kernel_event *event)
540 {
541 int ret;
542 const char *symbol_name;
543 uint64_t addr;
544 uint64_t offset;
545
546 switch (event->event->instrumentation) {
547 case LTTNG_KERNEL_KPROBE:
548 /*
549 * Comments in lttng-kernel.h mention that
550 * either addr or symbol_name are set, not both.
551 */
552 addr = event->event->u.kprobe.addr;
553 offset = event->event->u.kprobe.offset;
554 symbol_name = addr ? NULL : event->event->u.kprobe.symbol_name;
555 break;
556 case LTTNG_KERNEL_KRETPROBE:
557 addr = event->event->u.kretprobe.addr;
558 offset = event->event->u.kretprobe.offset;
559 symbol_name = addr ? NULL : event->event->u.kretprobe.symbol_name;
560 break;
561 default:
562 assert(1);
563 ERR("Unsupported kernel instrumentation type.");
564 ret = LTTNG_ERR_INVALID;
565 goto end;
566 }
567
568 ret = config_writer_open_element(writer, config_element_probe_attributes);
569 if (ret) {
570 ret = LTTNG_ERR_SAVE_IO_FAIL;
571 goto end;
572 }
573
574 if (addr) {
575 ret = config_writer_write_element_unsigned_int( writer,
576 config_element_address, addr);
577 if (ret) {
578 ret = LTTNG_ERR_SAVE_IO_FAIL;
579 goto end;
580 }
581 } else if (symbol_name) {
582 ret = config_writer_write_element_string(writer,
583 config_element_symbol_name, symbol_name);
584 if (ret) {
585 ret = LTTNG_ERR_SAVE_IO_FAIL;
586 goto end;
587 }
588 /* If the offset is non-zero, write it.*/
589 if (offset) {
590 ret = config_writer_write_element_unsigned_int(writer,
591 config_element_offset, offset);
592 if (ret) {
593 ret = LTTNG_ERR_SAVE_IO_FAIL;
594 goto end;
595 }
596 }
597 } else {
598 /*
599 * This really should not happen as we are either setting the
600 * address or the symbol above.
601 */
602 ERR("Invalid probe/function description.");
603 ret = LTTNG_ERR_INVALID;
604 goto end;
605 }
606
607
608 ret = config_writer_close_element(writer);
609 if (ret) {
610 ret = LTTNG_ERR_SAVE_IO_FAIL;
611 goto end;
612 }
613 end:
614 return ret;
615 }
616
617 /*
618 * Save the userspace probe tracepoint event associated with the event to the
619 * config writer.
620 */
621 static
622 int save_kernel_userspace_probe_tracepoint_event(struct config_writer *writer,
623 struct ltt_kernel_event *event)
624 {
625 int ret = 0;
626 const char *probe_name, *provider_name, *binary_path;
627 const struct lttng_userspace_probe_location *userspace_probe_location;
628 const struct lttng_userspace_probe_location_lookup_method *lookup_method;
629 enum lttng_userspace_probe_location_lookup_method_type lookup_type;
630
631 /* Get userspace probe location from the event. */
632 userspace_probe_location = event->userspace_probe_location;
633 if (!userspace_probe_location) {
634 ret = LTTNG_ERR_SAVE_IO_FAIL;
635 goto end;
636 }
637
638 /* Get lookup method and lookup method type. */
639 lookup_method = lttng_userspace_probe_location_get_lookup_method(userspace_probe_location);
640 if (!lookup_method) {
641 ret = LTTNG_ERR_SAVE_IO_FAIL;
642 goto end;
643 }
644
645 lookup_type = lttng_userspace_probe_location_lookup_method_get_type(lookup_method);
646
647 /* Get the binary path, probe name and provider name. */
648 binary_path =
649 lttng_userspace_probe_location_tracepoint_get_binary_path(
650 userspace_probe_location);
651 if (!binary_path) {
652 ret = LTTNG_ERR_SAVE_IO_FAIL;
653 goto end;
654 }
655
656 probe_name =
657 lttng_userspace_probe_location_tracepoint_get_probe_name(
658 userspace_probe_location);
659 if (!probe_name) {
660 ret = LTTNG_ERR_SAVE_IO_FAIL;
661 goto end;
662 }
663
664 provider_name =
665 lttng_userspace_probe_location_tracepoint_get_provider_name(
666 userspace_probe_location);
667 if (!provider_name) {
668 ret = LTTNG_ERR_SAVE_IO_FAIL;
669 goto end;
670 }
671
672 /* Open a userspace probe tracepoint attribute. */
673 ret = config_writer_open_element(writer, config_element_userspace_probe_tracepoint_attributes);
674 if (ret) {
675 ret = LTTNG_ERR_SAVE_IO_FAIL;
676 goto end;
677 }
678
679 switch (lookup_type) {
680 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_TRACEPOINT_SDT:
681 ret = config_writer_write_element_string(writer,
682 config_element_userspace_probe_lookup,
683 config_element_userspace_probe_lookup_tracepoint_sdt);
684 if (ret) {
685 ret = LTTNG_ERR_SAVE_IO_FAIL;
686 goto end;
687 }
688 break;
689 default:
690 ERR("Unsupported kernel userspace probe tracepoint lookup method.");
691 ret = LTTNG_ERR_INVALID;
692 goto end;
693 }
694
695 /* Write the binary path, provider name and the probe name. */
696 ret = config_writer_write_element_string(writer,
697 config_element_userspace_probe_location_binary_path,
698 binary_path);
699 if (ret) {
700 ret = LTTNG_ERR_SAVE_IO_FAIL;
701 goto end;
702 }
703
704 ret = config_writer_write_element_string(writer,
705 config_element_userspace_probe_tracepoint_location_provider_name,
706 provider_name);
707 if (ret) {
708 ret = LTTNG_ERR_SAVE_IO_FAIL;
709 goto end;
710 }
711
712 ret = config_writer_write_element_string(writer,
713 config_element_userspace_probe_tracepoint_location_probe_name,
714 probe_name);
715 if (ret) {
716 ret = LTTNG_ERR_SAVE_IO_FAIL;
717 goto end;
718 }
719
720 /* Close the userspace probe tracepoint attribute. */
721 ret = config_writer_close_element(writer);
722 if (ret) {
723 ret = LTTNG_ERR_SAVE_IO_FAIL;
724 goto end;
725 }
726
727 end:
728 return ret;
729 }
730
731 /*
732 * Save the userspace probe function event associated with the event to the
733 * config writer.
734 */
735 static
736 int save_kernel_userspace_probe_function_event(struct config_writer *writer,
737 struct ltt_kernel_event *event)
738 {
739 int ret = 0;
740 const char *function_name, *binary_path;
741 const struct lttng_userspace_probe_location *userspace_probe_location;
742 const struct lttng_userspace_probe_location_lookup_method *lookup_method;
743 enum lttng_userspace_probe_location_lookup_method_type lookup_type;
744
745 /* Get userspace probe location from the event. */
746 userspace_probe_location = event->userspace_probe_location;
747 if (!userspace_probe_location) {
748 ret = LTTNG_ERR_SAVE_IO_FAIL;
749 goto end;
750 }
751
752 /* Get lookup method and lookup method type. */
753 lookup_method = lttng_userspace_probe_location_get_lookup_method(
754 userspace_probe_location);
755 if (!lookup_method) {
756 ret = LTTNG_ERR_SAVE_IO_FAIL;
757 goto end;
758 }
759
760 /* Get the binary path and the function name. */
761 binary_path =
762 lttng_userspace_probe_location_function_get_binary_path(
763 userspace_probe_location);
764 if (!binary_path) {
765 ret = LTTNG_ERR_SAVE_IO_FAIL;
766 goto end;
767 }
768
769 function_name =
770 lttng_userspace_probe_location_function_get_function_name(
771 userspace_probe_location);
772 if (!function_name) {
773 ret = LTTNG_ERR_SAVE_IO_FAIL;
774 goto end;
775 }
776
777 /* Open a userspace probe function attribute. */
778 ret = config_writer_open_element(writer,
779 config_element_userspace_probe_function_attributes);
780 if (ret) {
781 ret = LTTNG_ERR_SAVE_IO_FAIL;
782 goto end;
783 }
784
785 lookup_type = lttng_userspace_probe_location_lookup_method_get_type(lookup_method);
786 switch (lookup_type) {
787 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF:
788 ret = config_writer_write_element_string(writer,
789 config_element_userspace_probe_lookup,
790 config_element_userspace_probe_lookup_function_elf);
791 if (ret) {
792 ret = LTTNG_ERR_SAVE_IO_FAIL;
793 goto end;
794 }
795 break;
796 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_DEFAULT:
797 ret = config_writer_write_element_string(writer,
798 config_element_userspace_probe_lookup,
799 config_element_userspace_probe_lookup_function_default);
800 if (ret) {
801 ret = LTTNG_ERR_SAVE_IO_FAIL;
802 goto end;
803 }
804 break;
805 default:
806 ERR("Unsupported kernel userspace probe function lookup method.");
807 ret = LTTNG_ERR_INVALID;
808 goto end;
809 }
810
811 /* Write the binary path and the function name. */
812 ret = config_writer_write_element_string(writer,
813 config_element_userspace_probe_location_binary_path,
814 binary_path);
815 if (ret) {
816 ret = LTTNG_ERR_SAVE_IO_FAIL;
817 goto end;
818 }
819
820 ret = config_writer_write_element_string(writer,
821 config_element_userspace_probe_function_location_function_name,
822 function_name);
823 if (ret) {
824 ret = LTTNG_ERR_SAVE_IO_FAIL;
825 goto end;
826 }
827
828 /* Close the userspace probe function attribute. */
829 ret = config_writer_close_element(writer);
830 if (ret) {
831 ret = LTTNG_ERR_SAVE_IO_FAIL;
832 goto end;
833 }
834
835 end:
836 return ret;
837 }
838
839 static
840 int save_kernel_userspace_probe_event(struct config_writer *writer,
841 struct ltt_kernel_event *event)
842 {
843 int ret;
844 struct lttng_userspace_probe_location *userspace_probe_location;
845
846 /* Get userspace probe location from the event. */
847 userspace_probe_location = event->userspace_probe_location;
848 if (!userspace_probe_location) {
849 ret = LTTNG_ERR_SAVE_IO_FAIL;
850 goto end;
851 }
852
853 switch(lttng_userspace_probe_location_get_type(userspace_probe_location)) {
854 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION:
855 {
856 ret = save_kernel_userspace_probe_function_event(writer, event);
857 if (ret) {
858 ret = LTTNG_ERR_SAVE_IO_FAIL;
859 goto end;
860 }
861 break;
862 }
863 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT:
864 {
865 ret = save_kernel_userspace_probe_tracepoint_event(writer, event);
866 if (ret) {
867 ret = LTTNG_ERR_SAVE_IO_FAIL;
868 goto end;
869 }
870 break;
871 }
872 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_UNKNOWN:
873 default:
874 ERR("Unsupported kernel userspace probe location type.");
875 ret = LTTNG_ERR_INVALID;
876 goto end;
877 }
878
879 end:
880 return ret;
881 }
882
883 static
884 int save_kernel_event(struct config_writer *writer,
885 struct ltt_kernel_event *event)
886 {
887 int ret;
888 const char *instrumentation_type;
889
890 ret = config_writer_open_element(writer, config_element_event);
891 if (ret) {
892 ret = LTTNG_ERR_SAVE_IO_FAIL;
893 goto end;
894 }
895
896 if (event->event->name[0]) {
897 ret = config_writer_write_element_string(writer,
898 config_element_name, event->event->name);
899 if (ret) {
900 ret = LTTNG_ERR_SAVE_IO_FAIL;
901 goto end;
902 }
903 }
904
905 ret = config_writer_write_element_bool(writer, config_element_enabled,
906 event->enabled);
907 if (ret) {
908 ret = LTTNG_ERR_SAVE_IO_FAIL;
909 goto end;
910 }
911
912 instrumentation_type = get_kernel_instrumentation_string(
913 event->event->instrumentation);
914 if (!instrumentation_type) {
915 ret = LTTNG_ERR_INVALID;
916 goto end;
917 }
918
919 ret = config_writer_write_element_string(writer, config_element_type,
920 instrumentation_type);
921 if (ret) {
922 ret = LTTNG_ERR_SAVE_IO_FAIL;
923 goto end;
924 }
925
926 if (event->filter_expression) {
927 ret = config_writer_write_element_string(writer,
928 config_element_filter,
929 event->filter_expression);
930 if (ret) {
931 ret = LTTNG_ERR_SAVE_IO_FAIL;
932 goto end;
933 }
934 }
935
936 if (event->event->instrumentation == LTTNG_KERNEL_FUNCTION ||
937 event->event->instrumentation == LTTNG_KERNEL_KPROBE ||
938 event->event->instrumentation == LTTNG_KERNEL_UPROBE ||
939 event->event->instrumentation == LTTNG_KERNEL_KRETPROBE) {
940
941 ret = config_writer_open_element(writer,
942 config_element_attributes);
943 if (ret) {
944 ret = LTTNG_ERR_SAVE_IO_FAIL;
945 goto end;
946 }
947
948 switch (event->event->instrumentation) {
949 case LTTNG_KERNEL_SYSCALL:
950 case LTTNG_KERNEL_FUNCTION:
951 ret = save_kernel_function_event(writer, event);
952 if (ret) {
953 goto end;
954 }
955 break;
956 case LTTNG_KERNEL_KPROBE:
957 case LTTNG_KERNEL_KRETPROBE:
958 ret = save_kernel_kprobe_event(writer, event);
959 if (ret) {
960 goto end;
961 }
962 break;
963 case LTTNG_KERNEL_UPROBE:
964 ret = save_kernel_userspace_probe_event(writer, event);
965 if (ret) {
966 goto end;
967 }
968 break;
969 default:
970 ERR("Unsupported kernel instrumentation type.");
971 ret = LTTNG_ERR_INVALID;
972 goto end;
973 }
974
975 /* /attributes */
976 ret = config_writer_close_element(writer);
977 if (ret) {
978 ret = LTTNG_ERR_SAVE_IO_FAIL;
979 goto end;
980 }
981 }
982
983 /* /event */
984 ret = config_writer_close_element(writer);
985 if (ret) {
986 ret = LTTNG_ERR_SAVE_IO_FAIL;
987 goto end;
988 }
989
990 ret = LTTNG_OK;
991 end:
992 return ret;
993 }
994
995 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
996 static
997 int save_kernel_events(struct config_writer *writer,
998 struct ltt_kernel_channel *kchan)
999 {
1000 int ret;
1001 struct ltt_kernel_event *event;
1002
1003 ret = config_writer_open_element(writer, config_element_events);
1004 if (ret) {
1005 ret = LTTNG_ERR_SAVE_IO_FAIL;
1006 goto end;
1007 }
1008
1009 cds_list_for_each_entry(event, &kchan->events_list.head, list) {
1010 ret = save_kernel_event(writer, event);
1011 if (ret != LTTNG_OK) {
1012 goto end;
1013 }
1014 }
1015
1016 /* /events */
1017 ret = config_writer_close_element(writer);
1018 if (ret) {
1019 ret = LTTNG_ERR_SAVE_IO_FAIL;
1020 goto end;
1021 }
1022
1023 ret = LTTNG_OK;
1024 end:
1025 return ret;
1026 }
1027
1028 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1029 static
1030 int save_ust_event(struct config_writer *writer,
1031 struct ltt_ust_event *event)
1032 {
1033 int ret;
1034 const char *loglevel_type_string;
1035
1036 ret = config_writer_open_element(writer, config_element_event);
1037 if (ret) {
1038 ret = LTTNG_ERR_SAVE_IO_FAIL;
1039 goto end;
1040 }
1041
1042 if (event->attr.name[0]) {
1043 ret = config_writer_write_element_string(writer,
1044 config_element_name, event->attr.name);
1045 if (ret) {
1046 ret = LTTNG_ERR_SAVE_IO_FAIL;
1047 goto end;
1048 }
1049 }
1050
1051 ret = config_writer_write_element_bool(writer, config_element_enabled,
1052 event->enabled);
1053 if (ret) {
1054 ret = LTTNG_ERR_SAVE_IO_FAIL;
1055 goto end;
1056 }
1057
1058 if (event->attr.instrumentation != LTTNG_UST_TRACEPOINT) {
1059 ERR("Unsupported UST instrumentation type.");
1060 ret = LTTNG_ERR_INVALID;
1061 goto end;
1062 }
1063 ret = config_writer_write_element_string(writer, config_element_type,
1064 config_event_type_tracepoint);
1065 if (ret) {
1066 ret = LTTNG_ERR_SAVE_IO_FAIL;
1067 goto end;
1068 }
1069
1070 loglevel_type_string = get_loglevel_type_string(
1071 event->attr.loglevel_type);
1072 if (!loglevel_type_string) {
1073 ERR("Unsupported UST loglevel type.");
1074 ret = LTTNG_ERR_INVALID;
1075 goto end;
1076 }
1077
1078 ret = config_writer_write_element_string(writer,
1079 config_element_loglevel_type, loglevel_type_string);
1080 if (ret) {
1081 ret = LTTNG_ERR_SAVE_IO_FAIL;
1082 goto end;
1083 }
1084
1085 /* The log level is irrelevant if no "filtering" is enabled */
1086 if (event->attr.loglevel_type != LTTNG_UST_LOGLEVEL_ALL) {
1087 ret = config_writer_write_element_signed_int(writer,
1088 config_element_loglevel, event->attr.loglevel);
1089 if (ret) {
1090 ret = LTTNG_ERR_SAVE_IO_FAIL;
1091 goto end;
1092 }
1093 }
1094
1095 if (event->filter_expression) {
1096 ret = config_writer_write_element_string(writer,
1097 config_element_filter, event->filter_expression);
1098 if (ret) {
1099 ret = LTTNG_ERR_SAVE_IO_FAIL;
1100 goto end;
1101 }
1102 }
1103
1104 if (event->exclusion && event->exclusion->count) {
1105 uint32_t i;
1106
1107 ret = config_writer_open_element(writer,
1108 config_element_exclusions);
1109 if (ret) {
1110 ret = LTTNG_ERR_SAVE_IO_FAIL;
1111 goto end;
1112 }
1113
1114 for (i = 0; i < event->exclusion->count; i++) {
1115 ret = config_writer_write_element_string(writer,
1116 config_element_exclusion,
1117 LTTNG_EVENT_EXCLUSION_NAME_AT(
1118 event->exclusion, i));
1119 if (ret) {
1120 ret = LTTNG_ERR_SAVE_IO_FAIL;
1121 goto end;
1122 }
1123 }
1124
1125 /* /exclusions */
1126 ret = config_writer_close_element(writer);
1127 if (ret) {
1128 ret = LTTNG_ERR_SAVE_IO_FAIL;
1129 goto end;
1130 }
1131 }
1132
1133 /* /event */
1134 ret = config_writer_close_element(writer);
1135 if (ret) {
1136 ret = LTTNG_ERR_SAVE_IO_FAIL;
1137 goto end;
1138 }
1139
1140 ret = LTTNG_OK;
1141 end:
1142 return ret;
1143 }
1144
1145 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1146 static
1147 int save_ust_events(struct config_writer *writer,
1148 struct lttng_ht *events)
1149 {
1150 int ret;
1151 struct ltt_ust_event *event;
1152 struct lttng_ht_node_str *node;
1153 struct lttng_ht_iter iter;
1154
1155 ret = config_writer_open_element(writer, config_element_events);
1156 if (ret) {
1157 ret = LTTNG_ERR_SAVE_IO_FAIL;
1158 goto end;
1159 }
1160
1161 rcu_read_lock();
1162 cds_lfht_for_each_entry(events->ht, &iter.iter, node, node) {
1163 event = caa_container_of(node, struct ltt_ust_event, node);
1164
1165 if (event->internal) {
1166 /* Internal events must not be exposed to clients */
1167 continue;
1168 }
1169 ret = save_ust_event(writer, event);
1170 if (ret != LTTNG_OK) {
1171 rcu_read_unlock();
1172 goto end;
1173 }
1174 }
1175 rcu_read_unlock();
1176
1177 /* /events */
1178 ret = config_writer_close_element(writer);
1179 if (ret) {
1180 ret = LTTNG_ERR_SAVE_IO_FAIL;
1181 goto end;
1182 }
1183
1184 ret = LTTNG_OK;
1185 end:
1186 return ret;
1187 }
1188
1189 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1190 static
1191 int init_ust_event_from_agent_event(struct ltt_ust_event *ust_event,
1192 struct agent_event *agent_event)
1193 {
1194 int ret;
1195 enum lttng_ust_loglevel_type ust_loglevel_type;
1196
1197 ust_event->enabled = agent_event->enabled;
1198 ust_event->attr.instrumentation = LTTNG_UST_TRACEPOINT;
1199 if (lttng_strncpy(ust_event->attr.name, agent_event->name,
1200 LTTNG_SYMBOL_NAME_LEN)) {
1201 ret = LTTNG_ERR_INVALID;
1202 goto end;
1203 }
1204 switch (agent_event->loglevel_type) {
1205 case LTTNG_EVENT_LOGLEVEL_ALL:
1206 ust_loglevel_type = LTTNG_UST_LOGLEVEL_ALL;
1207 break;
1208 case LTTNG_EVENT_LOGLEVEL_SINGLE:
1209 ust_loglevel_type = LTTNG_UST_LOGLEVEL_SINGLE;
1210 break;
1211 case LTTNG_EVENT_LOGLEVEL_RANGE:
1212 ust_loglevel_type = LTTNG_UST_LOGLEVEL_RANGE;
1213 break;
1214 default:
1215 ERR("Invalid agent_event loglevel_type.");
1216 ret = LTTNG_ERR_INVALID;
1217 goto end;
1218 }
1219
1220 ust_event->attr.loglevel_type = ust_loglevel_type;
1221 ust_event->attr.loglevel = agent_event->loglevel_value;
1222 ust_event->filter_expression = agent_event->filter_expression;
1223 ust_event->exclusion = agent_event->exclusion;
1224
1225 ret = LTTNG_OK;
1226 end:
1227 return ret;
1228 }
1229
1230 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1231 static
1232 int save_agent_events(struct config_writer *writer,
1233 struct agent *agent)
1234 {
1235 int ret;
1236 struct lttng_ht_iter iter;
1237 struct lttng_ht_node_str *node;
1238
1239 ret = config_writer_open_element(writer, config_element_events);
1240 if (ret) {
1241 ret = LTTNG_ERR_SAVE_IO_FAIL;
1242 goto end;
1243 }
1244
1245 rcu_read_lock();
1246 cds_lfht_for_each_entry(agent->events->ht, &iter.iter, node, node) {
1247 int ret;
1248 struct agent_event *agent_event;
1249 struct ltt_ust_event fake_event;
1250
1251 memset(&fake_event, 0, sizeof(fake_event));
1252 agent_event = caa_container_of(node, struct agent_event, node);
1253
1254 /*
1255 * Initialize a fake ust event to reuse the same serialization
1256 * function since UST and agent events contain the same info
1257 * (and one could wonder why they don't reuse the same
1258 * structures...).
1259 */
1260 ret = init_ust_event_from_agent_event(&fake_event, agent_event);
1261 if (ret != LTTNG_OK) {
1262 rcu_read_unlock();
1263 goto end;
1264 }
1265 ret = save_ust_event(writer, &fake_event);
1266 if (ret != LTTNG_OK) {
1267 rcu_read_unlock();
1268 goto end;
1269 }
1270 }
1271 rcu_read_unlock();
1272
1273 /* /events */
1274 ret = config_writer_close_element(writer);
1275 if (ret) {
1276 ret = LTTNG_ERR_SAVE_IO_FAIL;
1277 goto end;
1278 }
1279
1280 ret = LTTNG_OK;
1281 end:
1282 return ret;
1283 }
1284
1285 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1286 static
1287 int save_kernel_context(struct config_writer *writer,
1288 struct lttng_kernel_context *ctx)
1289 {
1290 int ret = LTTNG_OK;
1291
1292 if (!ctx) {
1293 goto end;
1294 }
1295
1296 ret = config_writer_open_element(writer, config_element_context);
1297 if (ret) {
1298 ret = LTTNG_ERR_SAVE_IO_FAIL;
1299 goto end;
1300 }
1301
1302 if (ctx->ctx == LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER) {
1303 ret = config_writer_open_element(writer,
1304 config_element_context_perf);
1305 if (ret) {
1306 ret = LTTNG_ERR_SAVE_IO_FAIL;
1307 goto end;
1308 }
1309
1310 ret = config_writer_write_element_unsigned_int(writer,
1311 config_element_type, ctx->u.perf_counter.type);
1312 if (ret) {
1313 ret = LTTNG_ERR_SAVE_IO_FAIL;
1314 goto end;
1315 }
1316
1317 ret = config_writer_write_element_unsigned_int(writer,
1318 config_element_config, ctx->u.perf_counter.config);
1319 if (ret) {
1320 ret = LTTNG_ERR_SAVE_IO_FAIL;
1321 goto end;
1322 }
1323
1324 ret = config_writer_write_element_string(writer,
1325 config_element_name, ctx->u.perf_counter.name);
1326 if (ret) {
1327 ret = LTTNG_ERR_SAVE_IO_FAIL;
1328 goto end;
1329 }
1330
1331 /* /perf */
1332 ret = config_writer_close_element(writer);
1333 if (ret) {
1334 ret = LTTNG_ERR_SAVE_IO_FAIL;
1335 goto end;
1336 }
1337 } else {
1338 const char *context_type_string =
1339 get_kernel_context_type_string(ctx->ctx);
1340
1341 if (!context_type_string) {
1342 ERR("Unsupported kernel context type.");
1343 ret = LTTNG_ERR_INVALID;
1344 goto end;
1345 }
1346
1347 ret = config_writer_write_element_string(writer,
1348 config_element_type, context_type_string);
1349 if (ret) {
1350 ret = LTTNG_ERR_SAVE_IO_FAIL;
1351 goto end;
1352 }
1353 }
1354
1355 /* /context */
1356 ret = config_writer_close_element(writer);
1357 if (ret) {
1358 ret = LTTNG_ERR_SAVE_IO_FAIL;
1359 goto end;
1360 }
1361
1362 ret = LTTNG_OK;
1363 end:
1364 return ret;
1365 }
1366
1367 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1368 static
1369 int save_kernel_contexts(struct config_writer *writer,
1370 struct ltt_kernel_channel *kchan)
1371 {
1372 int ret;
1373 struct ltt_kernel_context *ctx;
1374
1375 if (cds_list_empty(&kchan->ctx_list)) {
1376 ret = LTTNG_OK;
1377 goto end;
1378 }
1379
1380 ret = config_writer_open_element(writer, config_element_contexts);
1381 if (ret) {
1382 ret = LTTNG_ERR_SAVE_IO_FAIL;
1383 goto end;
1384 }
1385
1386 cds_list_for_each_entry(ctx, &kchan->ctx_list, list) {
1387 ret = save_kernel_context(writer, &ctx->ctx);
1388 if (ret != LTTNG_OK) {
1389 goto end;
1390 }
1391 }
1392
1393 /* /contexts */
1394 ret = config_writer_close_element(writer);
1395 if (ret) {
1396 ret = LTTNG_ERR_SAVE_IO_FAIL;
1397 goto end;
1398 }
1399
1400 ret = LTTNG_OK;
1401 end:
1402 return ret;
1403 }
1404
1405 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1406 static
1407 int save_ust_context_perf_thread_counter(struct config_writer *writer,
1408 struct ltt_ust_context *ctx)
1409 {
1410 int ret;
1411
1412 assert(writer);
1413 assert(ctx);
1414
1415 /* Perf contexts are saved as event_perf_context_type */
1416 ret = config_writer_open_element(writer, config_element_context_perf);
1417 if (ret) {
1418 ret = LTTNG_ERR_SAVE_IO_FAIL;
1419 goto end;
1420 }
1421
1422 ret = config_writer_write_element_unsigned_int(writer,
1423 config_element_type, ctx->ctx.u.perf_counter.type);
1424 if (ret) {
1425 ret = LTTNG_ERR_SAVE_IO_FAIL;
1426 goto end;
1427 }
1428
1429 ret = config_writer_write_element_unsigned_int(writer,
1430 config_element_config, ctx->ctx.u.perf_counter.config);
1431 if (ret) {
1432 ret = LTTNG_ERR_SAVE_IO_FAIL;
1433 goto end;
1434 }
1435
1436 ret = config_writer_write_element_string(writer, config_element_name,
1437 ctx->ctx.u.perf_counter.name);
1438 if (ret) {
1439 ret = LTTNG_ERR_SAVE_IO_FAIL;
1440 goto end;
1441 }
1442
1443 /* /perf */
1444 ret = config_writer_close_element(writer);
1445 if (ret) {
1446 ret = LTTNG_ERR_SAVE_IO_FAIL;
1447 goto end;
1448 }
1449
1450 ret = LTTNG_OK;
1451 end:
1452 return ret;
1453 }
1454
1455 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1456 static
1457 int save_ust_context_app_ctx(struct config_writer *writer,
1458 struct ltt_ust_context *ctx)
1459 {
1460 int ret;
1461
1462 assert(writer);
1463 assert(ctx);
1464
1465 /* Application contexts are saved as application_context_type */
1466 ret = config_writer_open_element(writer, config_element_context_app);
1467 if (ret) {
1468 ret = LTTNG_ERR_SAVE_IO_FAIL;
1469 goto end;
1470 }
1471
1472 ret = config_writer_write_element_string(writer,
1473 config_element_context_app_provider_name,
1474 ctx->ctx.u.app_ctx.provider_name);
1475 if (ret) {
1476 ret = LTTNG_ERR_SAVE_IO_FAIL;
1477 goto end;
1478 }
1479
1480 ret = config_writer_write_element_string(writer,
1481 config_element_context_app_ctx_name,
1482 ctx->ctx.u.app_ctx.ctx_name);
1483 if (ret) {
1484 ret = LTTNG_ERR_SAVE_IO_FAIL;
1485 goto end;
1486 }
1487
1488 /* /app */
1489 ret = config_writer_close_element(writer);
1490 if (ret) {
1491 ret = LTTNG_ERR_SAVE_IO_FAIL;
1492 goto end;
1493 }
1494
1495 ret = LTTNG_OK;
1496 end:
1497 return ret;
1498 }
1499
1500 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1501 static
1502 int save_ust_context_generic(struct config_writer *writer,
1503 struct ltt_ust_context *ctx)
1504 {
1505 int ret;
1506 const char *context_type_string;
1507
1508 assert(writer);
1509 assert(ctx);
1510
1511 /* Save context as event_context_type_type */
1512 context_type_string = get_ust_context_type_string(
1513 ctx->ctx.ctx);
1514 if (!context_type_string) {
1515 ERR("Unsupported UST context type.");
1516 ret = LTTNG_ERR_SAVE_IO_FAIL;
1517 goto end;
1518 }
1519
1520 ret = config_writer_write_element_string(writer,
1521 config_element_type, context_type_string);
1522 if (ret) {
1523 ret = LTTNG_ERR_SAVE_IO_FAIL;
1524 goto end;
1525 }
1526
1527 ret = LTTNG_OK;
1528 end:
1529 return ret;
1530 }
1531
1532 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1533 static
1534 int save_ust_context(struct config_writer *writer,
1535 struct cds_list_head *ctx_list)
1536 {
1537 int ret;
1538 struct ltt_ust_context *ctx;
1539
1540 assert(writer);
1541 assert(ctx_list);
1542
1543 ret = config_writer_open_element(writer, config_element_contexts);
1544 if (ret) {
1545 ret = LTTNG_ERR_SAVE_IO_FAIL;
1546 goto end;
1547 }
1548
1549 cds_list_for_each_entry(ctx, ctx_list, list) {
1550 ret = config_writer_open_element(writer,
1551 config_element_context);
1552 if (ret) {
1553 ret = LTTNG_ERR_SAVE_IO_FAIL;
1554 goto end;
1555 }
1556
1557 switch (ctx->ctx.ctx) {
1558 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
1559 ret = save_ust_context_perf_thread_counter(writer, ctx);
1560 break;
1561 case LTTNG_UST_CONTEXT_APP_CONTEXT:
1562 ret = save_ust_context_app_ctx(writer, ctx);
1563 break;
1564 default:
1565 /* Save generic context. */
1566 ret = save_ust_context_generic(writer, ctx);
1567 }
1568 if (ret != LTTNG_OK) {
1569 goto end;
1570 }
1571
1572 /* /context */
1573 ret = config_writer_close_element(writer);
1574 if (ret) {
1575 ret = LTTNG_ERR_SAVE_IO_FAIL;
1576 goto end;
1577 }
1578 }
1579
1580 /* /contexts */
1581 ret = config_writer_close_element(writer);
1582 if (ret) {
1583 ret = LTTNG_ERR_SAVE_IO_FAIL;
1584 goto end;
1585 }
1586
1587 ret = LTTNG_OK;
1588 end:
1589 return ret;
1590 }
1591
1592 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1593 static
1594 int save_kernel_channel(struct config_writer *writer,
1595 struct ltt_kernel_channel *kchan)
1596 {
1597 int ret;
1598
1599 assert(writer);
1600 assert(kchan);
1601
1602 ret = config_writer_open_element(writer, config_element_channel);
1603 if (ret) {
1604 ret = LTTNG_ERR_SAVE_IO_FAIL;
1605 goto end;
1606 }
1607
1608 ret = config_writer_write_element_string(writer, config_element_name,
1609 kchan->channel->name);
1610 if (ret) {
1611 ret = LTTNG_ERR_SAVE_IO_FAIL;
1612 goto end;
1613 }
1614
1615 ret = config_writer_write_element_bool(writer, config_element_enabled,
1616 kchan->channel->enabled);
1617 if (ret) {
1618 ret = LTTNG_ERR_SAVE_IO_FAIL;
1619 goto end;
1620 }
1621
1622 ret = save_kernel_channel_attributes(writer, &kchan->channel->attr);
1623 if (ret != LTTNG_OK) {
1624 goto end;
1625 }
1626
1627 ret = save_kernel_events(writer, kchan);
1628 if (ret != LTTNG_OK) {
1629 goto end;
1630 }
1631
1632 ret = save_kernel_contexts(writer, kchan);
1633 if (ret != LTTNG_OK) {
1634 goto end;
1635 }
1636
1637 /* /channel */
1638 ret = config_writer_close_element(writer);
1639 if (ret) {
1640 ret = LTTNG_ERR_SAVE_IO_FAIL;
1641 goto end;
1642 }
1643
1644 ret = LTTNG_OK;
1645 end:
1646 return ret;
1647 }
1648
1649 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1650 static
1651 int save_ust_channel(struct config_writer *writer,
1652 struct ltt_ust_channel *ust_chan,
1653 struct ltt_ust_session *session)
1654 {
1655 int ret;
1656
1657 assert(writer);
1658 assert(ust_chan);
1659 assert(session);
1660
1661 ret = config_writer_open_element(writer, config_element_channel);
1662 if (ret) {
1663 ret = LTTNG_ERR_SAVE_IO_FAIL;
1664 goto end;
1665 }
1666
1667 ret = config_writer_write_element_string(writer, config_element_name,
1668 ust_chan->name);
1669 if (ret) {
1670 ret = LTTNG_ERR_SAVE_IO_FAIL;
1671 goto end;
1672 }
1673
1674 ret = config_writer_write_element_bool(writer, config_element_enabled,
1675 ust_chan->enabled);
1676 if (ret) {
1677 ret = LTTNG_ERR_SAVE_IO_FAIL;
1678 goto end;
1679 }
1680
1681 ret = save_ust_channel_attributes(writer, &ust_chan->attr);
1682 if (ret != LTTNG_OK) {
1683 goto end;
1684 }
1685
1686 ret = config_writer_write_element_unsigned_int(writer,
1687 config_element_tracefile_size, ust_chan->tracefile_size);
1688 if (ret) {
1689 ret = LTTNG_ERR_SAVE_IO_FAIL;
1690 goto end;
1691 }
1692
1693 ret = config_writer_write_element_unsigned_int(writer,
1694 config_element_tracefile_count, ust_chan->tracefile_count);
1695 if (ret) {
1696 ret = LTTNG_ERR_SAVE_IO_FAIL;
1697 goto end;
1698 }
1699
1700 ret = config_writer_write_element_unsigned_int(writer,
1701 config_element_live_timer_interval,
1702 session->live_timer_interval);
1703 if (ret) {
1704 ret = LTTNG_ERR_SAVE_IO_FAIL;
1705 goto end;
1706 }
1707
1708 if (ust_chan->domain == LTTNG_DOMAIN_UST) {
1709 ret = save_ust_events(writer, ust_chan->events);
1710 if (ret != LTTNG_OK) {
1711 goto end;
1712 }
1713 } else {
1714 struct agent *agent = NULL;
1715
1716 agent = trace_ust_find_agent(session, ust_chan->domain);
1717 if (!agent) {
1718 ret = LTTNG_ERR_SAVE_IO_FAIL;
1719 ERR("Could not find agent associated to UST subdomain");
1720 goto end;
1721 }
1722
1723 /*
1724 * Channels associated with a UST sub-domain (such as JUL, Log4j
1725 * or Python) don't have any non-internal events. We retrieve
1726 * the "agent" events associated with this channel and serialize
1727 * them.
1728 */
1729 ret = save_agent_events(writer, agent);
1730 if (ret != LTTNG_OK) {
1731 goto end;
1732 }
1733 }
1734
1735 ret = save_ust_context(writer, &ust_chan->ctx_list);
1736 if (ret != LTTNG_OK) {
1737 goto end;
1738 }
1739
1740 /* /channel */
1741 ret = config_writer_close_element(writer);
1742 if (ret) {
1743 ret = LTTNG_ERR_SAVE_IO_FAIL;
1744 goto end;
1745 }
1746
1747 ret = LTTNG_OK;
1748 end:
1749 return ret;
1750 }
1751
1752 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1753 static
1754 int save_kernel_session(struct config_writer *writer,
1755 struct ltt_session *session)
1756 {
1757 int ret;
1758 struct ltt_kernel_channel *kchan;
1759
1760 assert(writer);
1761 assert(session);
1762
1763 ret = config_writer_write_element_string(writer, config_element_type,
1764 config_domain_type_kernel);
1765 if (ret) {
1766 ret = LTTNG_ERR_SAVE_IO_FAIL;
1767 goto end;
1768 }
1769
1770 ret = config_writer_write_element_string(writer,
1771 config_element_buffer_type, config_buffer_type_global);
1772 if (ret) {
1773 ret = LTTNG_ERR_SAVE_IO_FAIL;
1774 goto end;
1775 }
1776
1777 ret = config_writer_open_element(writer,
1778 config_element_channels);
1779 if (ret) {
1780 ret = LTTNG_ERR_SAVE_IO_FAIL;
1781 goto end;
1782 }
1783
1784 cds_list_for_each_entry(kchan, &session->kernel_session->channel_list.head,
1785 list) {
1786 ret = save_kernel_channel(writer, kchan);
1787 if (ret != LTTNG_OK) {
1788 goto end;
1789 }
1790 }
1791
1792 /* /channels */
1793 ret = config_writer_close_element(writer);
1794 if (ret) {
1795 ret = LTTNG_ERR_SAVE_IO_FAIL;
1796 goto end;
1797 }
1798
1799 ret = LTTNG_OK;
1800 end:
1801 return ret;
1802 }
1803
1804 static
1805 const char *get_config_domain_str(enum lttng_domain_type domain)
1806 {
1807 const char *str_dom;
1808
1809 switch (domain) {
1810 case LTTNG_DOMAIN_KERNEL:
1811 str_dom = config_domain_type_kernel;
1812 break;
1813 case LTTNG_DOMAIN_UST:
1814 str_dom = config_domain_type_ust;
1815 break;
1816 case LTTNG_DOMAIN_JUL:
1817 str_dom = config_domain_type_jul;
1818 break;
1819 case LTTNG_DOMAIN_LOG4J:
1820 str_dom = config_domain_type_log4j;
1821 break;
1822 case LTTNG_DOMAIN_PYTHON:
1823 str_dom = config_domain_type_python;
1824 break;
1825 default:
1826 assert(0);
1827 }
1828
1829 return str_dom;
1830 }
1831
1832 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
1833 static int save_id_tracker(struct config_writer *writer,
1834 struct ltt_session *sess,
1835 int domain,
1836 enum lttng_tracker_type tracker_type)
1837 {
1838 int ret = LTTNG_OK;
1839 ssize_t nr_ids = 0, i;
1840 struct lttng_tracker_id *ids = NULL;
1841 const char *element_id_tracker, *element_target_id, *element_id;
1842
1843 switch (tracker_type) {
1844 case LTTNG_TRACKER_PID:
1845 element_id_tracker = config_element_pid_tracker;
1846 element_target_id = config_element_target_pid;
1847 element_id = config_element_pid;
1848 break;
1849 case LTTNG_TRACKER_VPID:
1850 element_id_tracker = config_element_vpid_tracker;
1851 element_target_id = config_element_target_vpid;
1852 element_id = config_element_id;
1853 break;
1854 case LTTNG_TRACKER_UID:
1855 element_id_tracker = config_element_uid_tracker;
1856 element_target_id = config_element_target_uid;
1857 element_id = config_element_id;
1858 break;
1859 case LTTNG_TRACKER_VUID:
1860 element_id_tracker = config_element_vuid_tracker;
1861 element_target_id = config_element_target_vuid;
1862 element_id = config_element_id;
1863 break;
1864 case LTTNG_TRACKER_GID:
1865 element_id_tracker = config_element_gid_tracker;
1866 element_target_id = config_element_target_gid;
1867 element_id = config_element_id;
1868 break;
1869 case LTTNG_TRACKER_VGID:
1870 element_id_tracker = config_element_vgid_tracker;
1871 element_target_id = config_element_target_vgid;
1872 element_id = config_element_id;
1873 break;
1874 default:
1875 ret = LTTNG_ERR_SAVE_IO_FAIL;
1876 goto end;
1877 }
1878
1879 switch (domain) {
1880 case LTTNG_DOMAIN_KERNEL:
1881 {
1882 nr_ids = kernel_list_tracker_ids(
1883 tracker_type, sess->kernel_session, &ids);
1884 if (nr_ids < 0) {
1885 ret = LTTNG_ERR_KERN_LIST_FAIL;
1886 goto end;
1887 }
1888 break;
1889 }
1890 case LTTNG_DOMAIN_UST:
1891 {
1892 nr_ids = trace_ust_list_tracker_ids(
1893 tracker_type, sess->ust_session, &ids);
1894 if (nr_ids < 0) {
1895 ret = LTTNG_ERR_UST_LIST_FAIL;
1896 goto end;
1897 }
1898 break;
1899 }
1900 case LTTNG_DOMAIN_JUL:
1901 case LTTNG_DOMAIN_LOG4J:
1902 case LTTNG_DOMAIN_PYTHON:
1903 default:
1904 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1905 goto end;
1906 }
1907
1908 if (nr_ids == 1 && ids[0].type == LTTNG_ID_ALL) {
1909 /* Tracking all, nothing to output. */
1910 ret = LTTNG_OK;
1911 goto end;
1912 }
1913
1914 ret = config_writer_open_element(writer, element_id_tracker);
1915 if (ret) {
1916 ret = LTTNG_ERR_SAVE_IO_FAIL;
1917 goto end;
1918 }
1919
1920 ret = config_writer_open_element(writer, config_element_targets);
1921 if (ret) {
1922 ret = LTTNG_ERR_SAVE_IO_FAIL;
1923 goto end;
1924 }
1925
1926 if (nr_ids == 0) {
1927 /* Tracking none: empty list. */
1928 ret = config_writer_open_element(writer, element_target_id);
1929 if (ret) {
1930 ret = LTTNG_ERR_SAVE_IO_FAIL;
1931 goto end;
1932 }
1933
1934 /* /$element_target_id */
1935 ret = config_writer_close_element(writer);
1936 if (ret) {
1937 ret = LTTNG_ERR_SAVE_IO_FAIL;
1938 goto end;
1939 }
1940 } else {
1941 /* Tracking list. */
1942 for (i = 0; i < nr_ids; i++) {
1943 switch (ids[i].type) {
1944 case LTTNG_ID_VALUE:
1945 ret = config_writer_open_element(
1946 writer, element_target_id);
1947 if (ret) {
1948 ret = LTTNG_ERR_SAVE_IO_FAIL;
1949 goto end;
1950 }
1951 ret = config_writer_write_element_unsigned_int(
1952 writer, element_id,
1953 ids[i].value);
1954 break;
1955 case LTTNG_ID_STRING:
1956 ret = config_writer_open_element(
1957 writer, element_target_id);
1958 if (ret) {
1959 ret = LTTNG_ERR_SAVE_IO_FAIL;
1960 goto end;
1961 }
1962 ret = config_writer_write_element_string(writer,
1963 config_element_name,
1964 ids[i].string);
1965 break;
1966 default:
1967 /* Unexpected. */
1968 ret = LTTNG_ERR_SAVE_IO_FAIL;
1969 goto end;
1970 }
1971 if (ret) {
1972 ret = LTTNG_ERR_SAVE_IO_FAIL;
1973 goto end;
1974 }
1975
1976 /* /$element_target_id */
1977 ret = config_writer_close_element(writer);
1978 if (ret) {
1979 ret = LTTNG_ERR_SAVE_IO_FAIL;
1980 goto end;
1981 }
1982 }
1983 }
1984
1985 /* /targets */
1986 ret = config_writer_close_element(writer);
1987 if (ret) {
1988 ret = LTTNG_ERR_SAVE_IO_FAIL;
1989 goto end;
1990 }
1991
1992 /* /$element_id_tracker */
1993 ret = config_writer_close_element(writer);
1994 if (ret) {
1995 ret = LTTNG_ERR_SAVE_IO_FAIL;
1996 goto end;
1997 }
1998
1999 ret = LTTNG_OK;
2000 end:
2001 free(ids);
2002 return ret;
2003 }
2004
2005 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
2006 static int save_id_trackers(struct config_writer *writer,
2007 struct ltt_session *sess,
2008 int domain)
2009 {
2010 int ret;
2011
2012 switch (domain) {
2013 case LTTNG_DOMAIN_KERNEL:
2014 ret = save_id_tracker(writer, sess, domain, LTTNG_TRACKER_PID);
2015 if (ret != LTTNG_OK)
2016 return ret;
2017 ret = save_id_tracker(writer, sess, domain, LTTNG_TRACKER_VPID);
2018 if (ret != LTTNG_OK)
2019 return ret;
2020 ret = save_id_tracker(writer, sess, domain, LTTNG_TRACKER_UID);
2021 if (ret != LTTNG_OK)
2022 return ret;
2023 ret = save_id_tracker(writer, sess, domain, LTTNG_TRACKER_VUID);
2024 if (ret != LTTNG_OK)
2025 return ret;
2026 ret = save_id_tracker(writer, sess, domain, LTTNG_TRACKER_GID);
2027 if (ret != LTTNG_OK)
2028 return ret;
2029 ret = save_id_tracker(writer, sess, domain, LTTNG_TRACKER_VGID);
2030 if (ret != LTTNG_OK)
2031 return ret;
2032 break;
2033 case LTTNG_DOMAIN_UST:
2034 ret = save_id_tracker(writer, sess, domain, LTTNG_TRACKER_VPID);
2035 if (ret != LTTNG_OK)
2036 return ret;
2037 ret = save_id_tracker(writer, sess, domain, LTTNG_TRACKER_VUID);
2038 if (ret != LTTNG_OK)
2039 return ret;
2040 ret = save_id_tracker(writer, sess, domain, LTTNG_TRACKER_VGID);
2041 if (ret != LTTNG_OK)
2042 return ret;
2043 break;
2044 default:
2045 return LTTNG_ERR_INVALID;
2046 }
2047 return LTTNG_OK;
2048 }
2049
2050 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
2051 static
2052 int save_ust_domain(struct config_writer *writer,
2053 struct ltt_session *session, enum lttng_domain_type domain)
2054 {
2055 int ret;
2056 struct ltt_ust_channel *ust_chan;
2057 const char *buffer_type_string;
2058 struct lttng_ht_node_str *node;
2059 struct lttng_ht_iter iter;
2060 const char *config_domain_name;
2061
2062 assert(writer);
2063 assert(session);
2064
2065 ret = config_writer_open_element(writer,
2066 config_element_domain);
2067 if (ret) {
2068 ret = LTTNG_ERR_SAVE_IO_FAIL;
2069 goto end;
2070 }
2071
2072 config_domain_name = get_config_domain_str(domain);
2073 if (!config_domain_name) {
2074 ret = LTTNG_ERR_INVALID;
2075 goto end;
2076 }
2077
2078 ret = config_writer_write_element_string(writer,
2079 config_element_type, config_domain_name);
2080 if (ret) {
2081 ret = LTTNG_ERR_SAVE_IO_FAIL;
2082 goto end;
2083 }
2084
2085 buffer_type_string = get_buffer_type_string(
2086 session->ust_session->buffer_type);
2087 if (!buffer_type_string) {
2088 ERR("Unsupported buffer type.");
2089 ret = LTTNG_ERR_INVALID;
2090 goto end;
2091 }
2092
2093 ret = config_writer_write_element_string(writer,
2094 config_element_buffer_type, buffer_type_string);
2095 if (ret) {
2096 ret = LTTNG_ERR_SAVE_IO_FAIL;
2097 goto end;
2098 }
2099
2100 ret = config_writer_open_element(writer, config_element_channels);
2101 if (ret) {
2102 ret = LTTNG_ERR_SAVE_IO_FAIL;
2103 goto end;
2104 }
2105
2106 rcu_read_lock();
2107 cds_lfht_for_each_entry(session->ust_session->domain_global.channels->ht,
2108 &iter.iter, node, node) {
2109 ust_chan = caa_container_of(node, struct ltt_ust_channel, node);
2110 if (domain == ust_chan->domain) {
2111 ret = save_ust_channel(writer, ust_chan, session->ust_session);
2112 if (ret != LTTNG_OK) {
2113 rcu_read_unlock();
2114 goto end;
2115 }
2116 }
2117 }
2118 rcu_read_unlock();
2119
2120 /* /channels */
2121 ret = config_writer_close_element(writer);
2122 if (ret) {
2123 ret = LTTNG_ERR_SAVE_IO_FAIL;
2124 goto end;
2125 }
2126
2127 if (domain == LTTNG_DOMAIN_UST) {
2128 ret = config_writer_open_element(writer,
2129 config_element_trackers);
2130 if (ret) {
2131 ret = LTTNG_ERR_SAVE_IO_FAIL;
2132 goto end;
2133 }
2134
2135 ret = save_id_trackers(writer, session, LTTNG_DOMAIN_UST);
2136 if (ret != LTTNG_OK) {
2137 goto end;
2138 }
2139
2140 /* /trackers */
2141 ret = config_writer_close_element(writer);
2142 if (ret) {
2143 ret = LTTNG_ERR_SAVE_IO_FAIL;
2144 goto end;
2145 }
2146 }
2147
2148 /* /domain */
2149 ret = config_writer_close_element(writer);
2150 if (ret) {
2151 ret = LTTNG_ERR_SAVE_IO_FAIL;
2152 goto end;
2153 }
2154
2155 ret = LTTNG_OK;
2156 end:
2157 return ret;
2158 }
2159
2160 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
2161 static
2162 int save_domains(struct config_writer *writer, struct ltt_session *session)
2163 {
2164 int ret = LTTNG_OK;
2165
2166 assert(writer);
2167 assert(session);
2168
2169 if (!session->kernel_session && !session->ust_session) {
2170 goto end;
2171 }
2172
2173 ret = config_writer_open_element(writer, config_element_domains);
2174 if (ret) {
2175 ret = LTTNG_ERR_SAVE_IO_FAIL;
2176 goto end;
2177 }
2178
2179 if (session->kernel_session) {
2180 ret = config_writer_open_element(writer,
2181 config_element_domain);
2182 if (ret) {
2183 ret = LTTNG_ERR_SAVE_IO_FAIL;
2184 goto end;
2185 }
2186
2187 ret = save_kernel_session(writer, session);
2188 if (ret != LTTNG_OK) {
2189 goto end;
2190 }
2191
2192 ret = config_writer_open_element(writer,
2193 config_element_trackers);
2194 if (ret) {
2195 ret = LTTNG_ERR_SAVE_IO_FAIL;
2196 goto end;
2197 }
2198
2199 ret = save_id_trackers(writer, session, LTTNG_DOMAIN_KERNEL);
2200 if (ret != LTTNG_OK) {
2201 goto end;
2202 }
2203
2204 /* /trackers */
2205 ret = config_writer_close_element(writer);
2206 if (ret) {
2207 ret = LTTNG_ERR_SAVE_IO_FAIL;
2208 goto end;
2209 }
2210 /* /domain */
2211 ret = config_writer_close_element(writer);
2212 if (ret) {
2213 ret = LTTNG_ERR_SAVE_IO_FAIL;
2214 goto end;
2215 }
2216 }
2217
2218 if (session->ust_session) {
2219 ret = save_ust_domain(writer, session, LTTNG_DOMAIN_UST);
2220 if (ret != LTTNG_OK) {
2221 goto end;
2222 }
2223
2224 ret = save_ust_domain(writer, session, LTTNG_DOMAIN_JUL);
2225 if (ret != LTTNG_OK) {
2226 goto end;
2227 }
2228
2229 ret = save_ust_domain(writer, session, LTTNG_DOMAIN_LOG4J);
2230 if (ret != LTTNG_OK) {
2231 goto end;
2232 }
2233
2234 ret = save_ust_domain(writer, session, LTTNG_DOMAIN_PYTHON);
2235 if (ret != LTTNG_OK) {
2236 goto end;
2237 }
2238 }
2239
2240 /* /domains */
2241 ret = config_writer_close_element(writer);
2242 if (ret) {
2243 ret = LTTNG_ERR_SAVE_IO_FAIL;
2244 goto end;
2245 }
2246
2247 ret = LTTNG_OK;
2248 end:
2249 return ret;
2250 }
2251
2252 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
2253 static
2254 int save_consumer_output(struct config_writer *writer,
2255 struct consumer_output *output)
2256 {
2257 int ret;
2258
2259 assert(writer);
2260 assert(output);
2261
2262 ret = config_writer_open_element(writer, config_element_consumer_output);
2263 if (ret) {
2264 ret = LTTNG_ERR_SAVE_IO_FAIL;
2265 goto end;
2266 }
2267
2268 ret = config_writer_write_element_bool(writer, config_element_enabled,
2269 output->enabled);
2270 if (ret) {
2271 ret = LTTNG_ERR_SAVE_IO_FAIL;
2272 goto end;
2273 }
2274
2275 ret = config_writer_open_element(writer, config_element_destination);
2276 if (ret) {
2277 ret = LTTNG_ERR_SAVE_IO_FAIL;
2278 goto end;
2279 }
2280
2281 switch (output->type) {
2282 case CONSUMER_DST_LOCAL:
2283 ret = config_writer_write_element_string(writer,
2284 config_element_path, output->dst.session_root_path);
2285 if (ret) {
2286 ret = LTTNG_ERR_SAVE_IO_FAIL;
2287 goto end;
2288 }
2289 break;
2290 case CONSUMER_DST_NET:
2291 {
2292 char *uri;
2293
2294 uri = zmalloc(PATH_MAX);
2295 if (!uri) {
2296 ret = LTTNG_ERR_NOMEM;
2297 goto end;
2298 }
2299
2300 ret = config_writer_open_element(writer, config_element_net_output);
2301 if (ret) {
2302 ret = LTTNG_ERR_SAVE_IO_FAIL;
2303 goto end_net_output;
2304 }
2305
2306 if (output->dst.net.control_isset &&
2307 output->dst.net.data_isset) {
2308 ret = uri_to_str_url(&output->dst.net.control, uri, PATH_MAX);
2309 if (ret < 0) {
2310 ret = LTTNG_ERR_INVALID;
2311 goto end_net_output;
2312 }
2313
2314 ret = config_writer_write_element_string(writer,
2315 config_element_control_uri, uri);
2316 if (ret) {
2317 ret = LTTNG_ERR_SAVE_IO_FAIL;
2318 goto end_net_output;
2319 }
2320
2321 ret = uri_to_str_url(&output->dst.net.data, uri, PATH_MAX);
2322 if (ret < 0) {
2323 ret = LTTNG_ERR_INVALID;
2324 goto end_net_output;
2325 }
2326
2327 ret = config_writer_write_element_string(writer,
2328 config_element_data_uri, uri);
2329 if (ret) {
2330 ret = LTTNG_ERR_SAVE_IO_FAIL;
2331 goto end_net_output;
2332 }
2333 ret = LTTNG_OK;
2334 end_net_output:
2335 free(uri);
2336 if (ret != LTTNG_OK) {
2337 goto end;
2338 }
2339 } else {
2340 ret = !output->dst.net.control_isset ?
2341 LTTNG_ERR_URL_CTRL_MISS :
2342 LTTNG_ERR_URL_DATA_MISS;
2343 free(uri);
2344 goto end;
2345 }
2346
2347 ret = config_writer_close_element(writer);
2348 if (ret) {
2349 ret = LTTNG_ERR_SAVE_IO_FAIL;
2350 goto end;
2351 }
2352 break;
2353 }
2354 default:
2355 ERR("Unsupported consumer output type.");
2356 ret = LTTNG_ERR_INVALID;
2357 goto end;
2358 }
2359
2360 /* /destination */
2361 ret = config_writer_close_element(writer);
2362 if (ret) {
2363 ret = LTTNG_ERR_SAVE_IO_FAIL;
2364 goto end;
2365 }
2366
2367 /* /consumer_output */
2368 ret = config_writer_close_element(writer);
2369 if (ret) {
2370 ret = LTTNG_ERR_SAVE_IO_FAIL;
2371 goto end;
2372 }
2373
2374 ret = LTTNG_OK;
2375 end:
2376 return ret;
2377 }
2378
2379 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
2380 static
2381 int save_snapshot_outputs(struct config_writer *writer,
2382 struct snapshot *snapshot)
2383 {
2384 int ret;
2385 struct lttng_ht_iter iter;
2386 struct snapshot_output *output;
2387
2388 assert(writer);
2389 assert(snapshot);
2390
2391 ret = config_writer_open_element(writer, config_element_snapshot_outputs);
2392 if (ret) {
2393 ret = LTTNG_ERR_SAVE_IO_FAIL;
2394 goto end;
2395 }
2396
2397 rcu_read_lock();
2398 cds_lfht_for_each_entry(snapshot->output_ht->ht, &iter.iter, output,
2399 node.node) {
2400 ret = config_writer_open_element(writer,
2401 config_element_output);
2402 if (ret) {
2403 ret = LTTNG_ERR_SAVE_IO_FAIL;
2404 goto end_unlock;
2405 }
2406
2407 ret = config_writer_write_element_string(writer,
2408 config_element_name, output->name);
2409 if (ret) {
2410 ret = LTTNG_ERR_SAVE_IO_FAIL;
2411 goto end_unlock;
2412 }
2413
2414 ret = config_writer_write_element_unsigned_int(writer,
2415 config_element_max_size, output->max_size);
2416 if (ret) {
2417 ret = LTTNG_ERR_SAVE_IO_FAIL;
2418 goto end_unlock;
2419 }
2420
2421 ret = save_consumer_output(writer, output->consumer);
2422 if (ret != LTTNG_OK) {
2423 goto end_unlock;
2424 }
2425
2426 /* /output */
2427 ret = config_writer_close_element(writer);
2428 if (ret) {
2429 ret = LTTNG_ERR_SAVE_IO_FAIL;
2430 goto end_unlock;
2431 }
2432 }
2433 rcu_read_unlock();
2434
2435 /* /snapshot_outputs */
2436 ret = config_writer_close_element(writer);
2437 if (ret) {
2438 ret = LTTNG_ERR_SAVE_IO_FAIL;
2439 goto end;
2440 }
2441
2442 ret = LTTNG_OK;
2443 end:
2444 return ret;
2445 end_unlock:
2446 rcu_read_unlock();
2447 return ret;
2448 }
2449
2450 /* Return LTTNG_OK on success else a LTTNG_ERR* code. */
2451 static
2452 int save_session_output(struct config_writer *writer,
2453 struct ltt_session *session)
2454 {
2455 int ret;
2456
2457 assert(writer);
2458 assert(session);
2459
2460 if ((session->snapshot_mode && session->snapshot.nb_output == 0) ||
2461 (!session->snapshot_mode && !session->consumer)) {
2462 /* Session is in no output mode */
2463 ret = LTTNG_OK;
2464 goto end;
2465 }
2466
2467 ret = config_writer_open_element(writer, config_element_output);
2468 if (ret) {
2469 ret = LTTNG_ERR_SAVE_IO_FAIL;
2470 goto end;
2471 }
2472
2473 if (session->snapshot_mode) {
2474 ret = save_snapshot_outputs(writer, &session->snapshot);
2475 if (ret != LTTNG_OK) {
2476 goto end;
2477 }
2478 } else {
2479 if (session->consumer) {
2480 ret = save_consumer_output(writer, session->consumer);
2481 if (ret != LTTNG_OK) {
2482 goto end;
2483 }
2484 }
2485 }
2486
2487 /* /output */
2488 ret = config_writer_close_element(writer);
2489 if (ret) {
2490 ret = LTTNG_ERR_SAVE_IO_FAIL;
2491 goto end;
2492 }
2493 ret = LTTNG_OK;
2494 end:
2495 return ret;
2496 }
2497
2498 static
2499 int save_session_rotation_schedule(struct config_writer *writer,
2500 enum lttng_rotation_schedule_type type, uint64_t value)
2501 {
2502 int ret = 0;
2503 const char *element_name;
2504 const char *value_name;
2505
2506 switch (type) {
2507 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC:
2508 element_name = config_element_rotation_schedule_periodic;
2509 value_name = config_element_rotation_schedule_periodic_time_us;
2510 break;
2511 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD:
2512 element_name = config_element_rotation_schedule_size_threshold;
2513 value_name = config_element_rotation_schedule_size_threshold_bytes;
2514 break;
2515 default:
2516 ret = -1;
2517 goto end;
2518 }
2519
2520 ret = config_writer_open_element(writer, element_name);
2521 if (ret) {
2522 goto end;
2523 }
2524
2525 ret = config_writer_write_element_unsigned_int(writer,
2526 value_name, value);
2527 if (ret) {
2528 goto end;
2529 }
2530
2531 /* Close schedule descriptor element. */
2532 ret = config_writer_close_element(writer);
2533 if (ret) {
2534 goto end;
2535 }
2536 end:
2537 return ret;
2538 }
2539
2540 static
2541 int save_session_rotation_schedules(struct config_writer *writer,
2542 struct ltt_session *session)
2543 {
2544 int ret;
2545
2546 ret = config_writer_open_element(writer,
2547 config_element_rotation_schedules);
2548 if (ret) {
2549 goto end;
2550 }
2551 if (session->rotate_timer_period) {
2552 ret = save_session_rotation_schedule(writer,
2553 LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC,
2554 session->rotate_timer_period);
2555 if (ret) {
2556 goto close_schedules;
2557 }
2558 }
2559 if (session->rotate_size) {
2560 ret = save_session_rotation_schedule(writer,
2561 LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD,
2562 session->rotate_size);
2563 if (ret) {
2564 goto close_schedules;
2565 }
2566 }
2567
2568 close_schedules:
2569 /* Close rotation schedules element. */
2570 ret = config_writer_close_element(writer);
2571 if (ret) {
2572 goto end;
2573 }
2574 end:
2575 return ret;
2576 }
2577
2578 /*
2579 * Save the given session.
2580 *
2581 * Return LTTNG_OK on success else a LTTNG_ERR* code.
2582 */
2583 static
2584 int save_session(struct ltt_session *session,
2585 struct lttng_save_session_attr *attr, lttng_sock_cred *creds)
2586 {
2587 int ret, fd = -1;
2588 char config_file_path[LTTNG_PATH_MAX];
2589 size_t len;
2590 struct config_writer *writer = NULL;
2591 size_t session_name_len;
2592 const char *provided_path;
2593 int file_open_flags = O_CREAT | O_WRONLY | O_TRUNC;
2594
2595 assert(session);
2596 assert(attr);
2597 assert(creds);
2598
2599 session_name_len = strlen(session->name);
2600 memset(config_file_path, 0, sizeof(config_file_path));
2601
2602 if (!session_access_ok(session,
2603 LTTNG_SOCK_GET_UID_CRED(creds),
2604 LTTNG_SOCK_GET_GID_CRED(creds)) || session->destroyed) {
2605 ret = LTTNG_ERR_EPERM;
2606 goto end;
2607 }
2608
2609 provided_path = lttng_save_session_attr_get_output_url(attr);
2610 if (provided_path) {
2611 DBG3("Save session in provided path %s", provided_path);
2612 len = strlen(provided_path);
2613 if (len >= sizeof(config_file_path)) {
2614 ret = LTTNG_ERR_SET_URL;
2615 goto end;
2616 }
2617 strncpy(config_file_path, provided_path, sizeof(config_file_path));
2618 } else {
2619 ssize_t ret_len;
2620 char *home_dir = utils_get_user_home_dir(
2621 LTTNG_SOCK_GET_UID_CRED(creds));
2622 if (!home_dir) {
2623 ret = LTTNG_ERR_SET_URL;
2624 goto end;
2625 }
2626
2627 ret_len = snprintf(config_file_path, sizeof(config_file_path),
2628 DEFAULT_SESSION_HOME_CONFIGPATH, home_dir);
2629 free(home_dir);
2630 if (ret_len < 0) {
2631 PERROR("snprintf save session");
2632 ret = LTTNG_ERR_SET_URL;
2633 goto end;
2634 }
2635 len = ret_len;
2636 }
2637
2638 /*
2639 * Check the path fits in the config file path dst including the '/'
2640 * followed by trailing .lttng extension and the NULL terminated string.
2641 */
2642 if ((len + session_name_len + 2 +
2643 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION))
2644 > sizeof(config_file_path)) {
2645 ret = LTTNG_ERR_SET_URL;
2646 goto end;
2647 }
2648
2649 ret = run_as_mkdir_recursive(config_file_path, S_IRWXU | S_IRWXG,
2650 LTTNG_SOCK_GET_UID_CRED(creds), LTTNG_SOCK_GET_GID_CRED(creds));
2651 if (ret) {
2652 ret = LTTNG_ERR_SET_URL;
2653 goto end;
2654 }
2655
2656 /*
2657 * At this point, we know that everything fits in the buffer. Validation
2658 * was done just above.
2659 */
2660 config_file_path[len++] = '/';
2661 strncpy(config_file_path + len, session->name, sizeof(config_file_path) - len);
2662 len += session_name_len;
2663 strcpy(config_file_path + len, DEFAULT_SESSION_CONFIG_FILE_EXTENSION);
2664 len += sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION);
2665 config_file_path[len] = '\0';
2666
2667 if (!attr->overwrite) {
2668 file_open_flags |= O_EXCL;
2669 }
2670
2671 fd = run_as_open(config_file_path, file_open_flags,
2672 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP,
2673 LTTNG_SOCK_GET_UID_CRED(creds), LTTNG_SOCK_GET_GID_CRED(creds));
2674 if (fd < 0) {
2675 PERROR("Could not create configuration file");
2676 switch (errno) {
2677 case EEXIST:
2678 ret = LTTNG_ERR_SAVE_FILE_EXIST;
2679 break;
2680 case EACCES:
2681 ret = LTTNG_ERR_EPERM;
2682 break;
2683 default:
2684 ret = LTTNG_ERR_SAVE_IO_FAIL;
2685 break;
2686 }
2687 goto end;
2688 }
2689
2690 writer = config_writer_create(fd, 1);
2691 if (!writer) {
2692 ret = LTTNG_ERR_NOMEM;
2693 goto end;
2694 }
2695
2696 ret = config_writer_open_element(writer, config_element_sessions);
2697 if (ret) {
2698 ret = LTTNG_ERR_SAVE_IO_FAIL;
2699 goto end;
2700 }
2701
2702 ret = config_writer_open_element(writer, config_element_session);
2703 if (ret) {
2704 ret = LTTNG_ERR_SAVE_IO_FAIL;
2705 goto end;
2706 }
2707
2708 ret = config_writer_write_element_string(writer, config_element_name,
2709 session->name);
2710 if (ret) {
2711 ret = LTTNG_ERR_SAVE_IO_FAIL;
2712 goto end;
2713 }
2714
2715 if (session->shm_path[0] != '\0') {
2716 ret = config_writer_write_element_string(writer,
2717 config_element_shared_memory_path,
2718 session->shm_path);
2719 if (ret) {
2720 ret = LTTNG_ERR_SAVE_IO_FAIL;
2721 goto end;
2722 }
2723 }
2724
2725 ret = save_domains(writer, session);
2726 if (ret != LTTNG_OK) {
2727 goto end;
2728 }
2729
2730 ret = config_writer_write_element_bool(writer, config_element_started,
2731 session->active);
2732 if (ret) {
2733 ret = LTTNG_ERR_SAVE_IO_FAIL;
2734 goto end;
2735 }
2736
2737 if (session->snapshot_mode || session->live_timer ||
2738 session->rotate_timer_period || session->rotate_size) {
2739 ret = config_writer_open_element(writer, config_element_attributes);
2740 if (ret) {
2741 ret = LTTNG_ERR_SAVE_IO_FAIL;
2742 goto end;
2743 }
2744
2745 if (session->snapshot_mode) {
2746 ret = config_writer_write_element_bool(writer,
2747 config_element_snapshot_mode, 1);
2748 if (ret) {
2749 ret = LTTNG_ERR_SAVE_IO_FAIL;
2750 goto end;
2751 }
2752 } else if (session->live_timer) {
2753 ret = config_writer_write_element_unsigned_int(writer,
2754 config_element_live_timer_interval, session->live_timer);
2755 if (ret) {
2756 ret = LTTNG_ERR_SAVE_IO_FAIL;
2757 goto end;
2758 }
2759 }
2760 if (session->rotate_timer_period || session->rotate_size) {
2761 ret = save_session_rotation_schedules(writer,
2762 session);
2763 if (ret) {
2764 ret = LTTNG_ERR_SAVE_IO_FAIL;
2765 goto end;
2766 }
2767 }
2768
2769 /* /attributes */
2770 ret = config_writer_close_element(writer);
2771 if (ret) {
2772 ret = LTTNG_ERR_SAVE_IO_FAIL;
2773 goto end;
2774 }
2775 }
2776
2777 ret = save_session_output(writer, session);
2778 if (ret != LTTNG_OK) {
2779 goto end;
2780 }
2781
2782 /* /session */
2783 ret = config_writer_close_element(writer);
2784 if (ret) {
2785 ret = LTTNG_ERR_SAVE_IO_FAIL;
2786 goto end;
2787 }
2788
2789 /* /sessions */
2790 ret = config_writer_close_element(writer);
2791 if (ret) {
2792 ret = LTTNG_ERR_SAVE_IO_FAIL;
2793 goto end;
2794 }
2795
2796 ret = LTTNG_OK;
2797 end:
2798 if (writer && config_writer_destroy(writer)) {
2799 /* Preserve the original error code */
2800 ret = ret != LTTNG_OK ? ret : LTTNG_ERR_SAVE_IO_FAIL;
2801 }
2802 if (ret != LTTNG_OK) {
2803 /* Delete file in case of error */
2804 if ((fd >= 0) && unlink(config_file_path)) {
2805 PERROR("Unlinking XML session configuration.");
2806 }
2807 }
2808
2809 if (fd >= 0) {
2810 int closeret;
2811
2812 closeret = close(fd);
2813 if (closeret) {
2814 PERROR("Closing XML session configuration");
2815 }
2816 }
2817
2818 return ret;
2819 }
2820
2821 int cmd_save_sessions(struct lttng_save_session_attr *attr,
2822 lttng_sock_cred *creds)
2823 {
2824 int ret;
2825 const char *session_name;
2826 struct ltt_session *session;
2827
2828 session_lock_list();
2829
2830 session_name = lttng_save_session_attr_get_session_name(attr);
2831 if (session_name) {
2832 session = session_find_by_name(session_name);
2833 if (!session) {
2834 ret = LTTNG_ERR_SESS_NOT_FOUND;
2835 goto end;
2836 }
2837
2838 session_lock(session);
2839 ret = save_session(session, attr, creds);
2840 session_unlock(session);
2841 session_put(session);
2842 if (ret != LTTNG_OK) {
2843 goto end;
2844 }
2845 } else {
2846 struct ltt_session_list *list = session_get_list();
2847
2848 cds_list_for_each_entry(session, &list->head, list) {
2849 if (!session_get(session)) {
2850 continue;
2851 }
2852 session_lock(session);
2853 ret = save_session(session, attr, creds);
2854 session_unlock(session);
2855 session_put(session);
2856 /* Don't abort if we don't have the required permissions. */
2857 if (ret != LTTNG_OK && ret != LTTNG_ERR_EPERM) {
2858 goto end;
2859 }
2860 }
2861 }
2862 ret = LTTNG_OK;
2863
2864 end:
2865 session_unlock_list();
2866 return ret;
2867 }
This page took 0.0948 seconds and 4 git commands to generate.