2 * Copyright (C) 2014 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
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.
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
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.
22 #include <urcu/uatomic.h>
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>
35 #include "lttng-syscall.h"
36 #include "trace-ust.h"
40 int save_kernel_channel_attributes(struct config_writer
*writer
,
41 struct lttng_channel_attr
*attr
)
45 ret
= config_writer_write_element_string(writer
,
46 config_element_overwrite_mode
,
47 attr
->overwrite
? config_overwrite_mode_overwrite
:
48 config_overwrite_mode_discard
);
53 ret
= config_writer_write_element_unsigned_int(writer
,
54 config_element_subbuf_size
, attr
->subbuf_size
);
59 ret
= config_writer_write_element_unsigned_int(writer
,
60 config_element_num_subbuf
,
66 ret
= config_writer_write_element_unsigned_int(writer
,
67 config_element_switch_timer_interval
,
68 attr
->switch_timer_interval
);
73 ret
= config_writer_write_element_unsigned_int(writer
,
74 config_element_read_timer_interval
,
75 attr
->read_timer_interval
);
80 ret
= config_writer_write_element_string(writer
,
81 config_element_output_type
,
82 attr
->output
== LTTNG_EVENT_SPLICE
?
83 config_output_type_splice
: config_output_type_mmap
);
88 ret
= config_writer_write_element_unsigned_int(writer
,
89 config_element_tracefile_size
, attr
->tracefile_size
);
94 ret
= config_writer_write_element_unsigned_int(writer
,
95 config_element_tracefile_count
,
96 attr
->tracefile_count
);
101 ret
= config_writer_write_element_unsigned_int(writer
,
102 config_element_live_timer_interval
,
103 attr
->live_timer_interval
);
108 if (attr
->extended
.ptr
) {
109 struct lttng_channel_extended
*ext
= NULL
;
111 ext
= (struct lttng_channel_extended
*) attr
->extended
.ptr
;
112 ret
= config_writer_write_element_unsigned_int(writer
,
113 config_element_monitor_timer_interval
,
114 ext
->monitor_timer_interval
);
119 ret
= config_writer_write_element_signed_int(writer
,
120 config_element_blocking_timeout
,
121 ext
->blocking_timeout
);
128 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
132 int save_ust_channel_attributes(struct config_writer
*writer
,
133 struct lttng_ust_channel_attr
*attr
)
136 struct ltt_ust_channel
*channel
= NULL
;
138 ret
= config_writer_write_element_string(writer
,
139 config_element_overwrite_mode
,
140 attr
->overwrite
? config_overwrite_mode_overwrite
:
141 config_overwrite_mode_discard
);
146 ret
= config_writer_write_element_unsigned_int(writer
,
147 config_element_subbuf_size
, attr
->subbuf_size
);
152 ret
= config_writer_write_element_unsigned_int(writer
,
153 config_element_num_subbuf
,
159 ret
= config_writer_write_element_unsigned_int(writer
,
160 config_element_switch_timer_interval
,
161 attr
->switch_timer_interval
);
166 ret
= config_writer_write_element_unsigned_int(writer
,
167 config_element_read_timer_interval
,
168 attr
->read_timer_interval
);
173 ret
= config_writer_write_element_string(writer
,
174 config_element_output_type
,
175 attr
->output
== LTTNG_UST_MMAP
?
176 config_output_type_mmap
: config_output_type_splice
);
181 ret
= config_writer_write_element_signed_int(writer
,
182 config_element_blocking_timeout
,
183 attr
->u
.s
.blocking_timeout
);
189 * Fetch the monitor timer which is located in the parent of
190 * lttng_ust_channel_attr
192 channel
= caa_container_of(attr
, struct ltt_ust_channel
, attr
);
193 ret
= config_writer_write_element_unsigned_int(writer
,
194 config_element_monitor_timer_interval
,
195 channel
->monitor_timer_interval
);
201 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
205 const char *get_kernel_instrumentation_string(
206 enum lttng_kernel_instrumentation instrumentation
)
208 const char *instrumentation_string
;
210 switch (instrumentation
) {
211 case LTTNG_KERNEL_ALL
:
212 instrumentation_string
= config_event_type_all
;
214 case LTTNG_KERNEL_TRACEPOINT
:
215 instrumentation_string
= config_event_type_tracepoint
;
217 case LTTNG_KERNEL_KPROBE
:
218 instrumentation_string
= config_event_type_probe
;
220 case LTTNG_KERNEL_UPROBE
:
221 instrumentation_string
= config_event_type_userspace_probe
;
223 case LTTNG_KERNEL_FUNCTION
:
224 instrumentation_string
= config_event_type_function_entry
;
226 case LTTNG_KERNEL_KRETPROBE
:
227 instrumentation_string
= config_event_type_function
;
229 case LTTNG_KERNEL_NOOP
:
230 instrumentation_string
= config_event_type_noop
;
232 case LTTNG_KERNEL_SYSCALL
:
233 instrumentation_string
= config_event_type_syscall
;
236 instrumentation_string
= NULL
;
239 return instrumentation_string
;
243 const char *get_kernel_context_type_string(
244 enum lttng_kernel_context_type context_type
)
246 const char *context_type_string
;
248 switch (context_type
) {
249 case LTTNG_KERNEL_CONTEXT_PID
:
250 context_type_string
= config_event_context_pid
;
252 case LTTNG_KERNEL_CONTEXT_PROCNAME
:
253 context_type_string
= config_event_context_procname
;
255 case LTTNG_KERNEL_CONTEXT_PRIO
:
256 context_type_string
= config_event_context_prio
;
258 case LTTNG_KERNEL_CONTEXT_NICE
:
259 context_type_string
= config_event_context_nice
;
261 case LTTNG_KERNEL_CONTEXT_VPID
:
262 context_type_string
= config_event_context_vpid
;
264 case LTTNG_KERNEL_CONTEXT_TID
:
265 context_type_string
= config_event_context_tid
;
267 case LTTNG_KERNEL_CONTEXT_VTID
:
268 context_type_string
= config_event_context_vtid
;
270 case LTTNG_KERNEL_CONTEXT_PPID
:
271 context_type_string
= config_event_context_ppid
;
273 case LTTNG_KERNEL_CONTEXT_VPPID
:
274 context_type_string
= config_event_context_vppid
;
276 case LTTNG_KERNEL_CONTEXT_HOSTNAME
:
277 context_type_string
= config_event_context_hostname
;
279 case LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE
:
280 context_type_string
= config_event_context_interruptible
;
282 case LTTNG_KERNEL_CONTEXT_PREEMPTIBLE
:
283 context_type_string
= config_event_context_preemptible
;
285 case LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE
:
286 context_type_string
= config_event_context_need_reschedule
;
288 case LTTNG_KERNEL_CONTEXT_MIGRATABLE
:
289 context_type_string
= config_event_context_migratable
;
291 case LTTNG_KERNEL_CONTEXT_CALLSTACK_USER
:
292 context_type_string
= config_event_context_callstack_user
;
294 case LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL
:
295 context_type_string
= config_event_context_callstack_kernel
;
297 case LTTNG_KERNEL_CONTEXT_CGROUP_NS
:
298 context_type_string
= config_event_context_cgroup_ns
;
300 case LTTNG_KERNEL_CONTEXT_IPC_NS
:
301 context_type_string
= config_event_context_ipc_ns
;
303 case LTTNG_KERNEL_CONTEXT_MNT_NS
:
304 context_type_string
= config_event_context_mnt_ns
;
306 case LTTNG_KERNEL_CONTEXT_NET_NS
:
307 context_type_string
= config_event_context_net_ns
;
309 case LTTNG_KERNEL_CONTEXT_PID_NS
:
310 context_type_string
= config_event_context_pid_ns
;
312 case LTTNG_KERNEL_CONTEXT_USER_NS
:
313 context_type_string
= config_event_context_user_ns
;
315 case LTTNG_KERNEL_CONTEXT_UTS_NS
:
316 context_type_string
= config_event_context_uts_ns
;
318 case LTTNG_KERNEL_CONTEXT_UID
:
319 context_type_string
= config_event_context_uid
;
321 case LTTNG_KERNEL_CONTEXT_EUID
:
322 context_type_string
= config_event_context_euid
;
324 case LTTNG_KERNEL_CONTEXT_SUID
:
325 context_type_string
= config_event_context_suid
;
327 case LTTNG_KERNEL_CONTEXT_GID
:
328 context_type_string
= config_event_context_gid
;
330 case LTTNG_KERNEL_CONTEXT_EGID
:
331 context_type_string
= config_event_context_egid
;
333 case LTTNG_KERNEL_CONTEXT_SGID
:
334 context_type_string
= config_event_context_sgid
;
336 case LTTNG_KERNEL_CONTEXT_VUID
:
337 context_type_string
= config_event_context_vuid
;
339 case LTTNG_KERNEL_CONTEXT_VEUID
:
340 context_type_string
= config_event_context_veuid
;
342 case LTTNG_KERNEL_CONTEXT_VSUID
:
343 context_type_string
= config_event_context_vsuid
;
345 case LTTNG_KERNEL_CONTEXT_VGID
:
346 context_type_string
= config_event_context_vgid
;
348 case LTTNG_KERNEL_CONTEXT_VEGID
:
349 context_type_string
= config_event_context_vegid
;
351 case LTTNG_KERNEL_CONTEXT_VSGID
:
352 context_type_string
= config_event_context_vsgid
;
355 context_type_string
= NULL
;
358 return context_type_string
;
362 const char *get_ust_context_type_string(
363 enum lttng_ust_context_type context_type
)
365 const char *context_type_string
;
367 switch (context_type
) {
368 case LTTNG_UST_CONTEXT_PROCNAME
:
369 context_type_string
= config_event_context_procname
;
371 case LTTNG_UST_CONTEXT_VPID
:
372 context_type_string
= config_event_context_vpid
;
374 case LTTNG_UST_CONTEXT_VTID
:
375 context_type_string
= config_event_context_vtid
;
377 case LTTNG_UST_CONTEXT_IP
:
378 context_type_string
= config_event_context_ip
;
380 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
381 context_type_string
= config_event_context_pthread_id
;
383 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
384 context_type_string
= config_event_context_app
;
386 case LTTNG_UST_CONTEXT_CGROUP_NS
:
387 context_type_string
= config_event_context_cgroup_ns
;
389 case LTTNG_UST_CONTEXT_IPC_NS
:
390 context_type_string
= config_event_context_ipc_ns
;
392 case LTTNG_UST_CONTEXT_MNT_NS
:
393 context_type_string
= config_event_context_mnt_ns
;
395 case LTTNG_UST_CONTEXT_NET_NS
:
396 context_type_string
= config_event_context_net_ns
;
398 case LTTNG_UST_CONTEXT_PID_NS
:
399 context_type_string
= config_event_context_pid_ns
;
401 case LTTNG_UST_CONTEXT_USER_NS
:
402 context_type_string
= config_event_context_user_ns
;
404 case LTTNG_UST_CONTEXT_UTS_NS
:
405 context_type_string
= config_event_context_uts_ns
;
407 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
409 * Error, should not be stored in the XML, perf contexts
410 * are stored as a node of type event_perf_context_type.
413 context_type_string
= NULL
;
417 return context_type_string
;
421 const char *get_buffer_type_string(
422 enum lttng_buffer_type buffer_type
)
424 const char *buffer_type_string
;
426 switch (buffer_type
) {
427 case LTTNG_BUFFER_PER_PID
:
428 buffer_type_string
= config_buffer_type_per_pid
;
430 case LTTNG_BUFFER_PER_UID
:
431 buffer_type_string
= config_buffer_type_per_uid
;
433 case LTTNG_BUFFER_GLOBAL
:
434 buffer_type_string
= config_buffer_type_global
;
437 buffer_type_string
= NULL
;
440 return buffer_type_string
;
444 const char *get_loglevel_type_string(
445 enum lttng_ust_loglevel_type loglevel_type
)
447 const char *loglevel_type_string
;
449 switch (loglevel_type
) {
450 case LTTNG_UST_LOGLEVEL_ALL
:
451 loglevel_type_string
= config_loglevel_type_all
;
453 case LTTNG_UST_LOGLEVEL_RANGE
:
454 loglevel_type_string
= config_loglevel_type_range
;
456 case LTTNG_UST_LOGLEVEL_SINGLE
:
457 loglevel_type_string
= config_loglevel_type_single
;
460 loglevel_type_string
= NULL
;
463 return loglevel_type_string
;
467 int save_kernel_function_event(struct config_writer
*writer
,
468 struct ltt_kernel_event
*event
)
472 ret
= config_writer_open_element(writer
, config_element_function_attributes
);
474 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
478 ret
= config_writer_write_element_string(writer
, config_element_name
,
479 event
->event
->u
.ftrace
.symbol_name
);
481 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
485 /* /function attributes */
486 ret
= config_writer_close_element(writer
);
488 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
496 int save_kernel_kprobe_event(struct config_writer
*writer
,
497 struct ltt_kernel_event
*event
)
500 const char *symbol_name
;
504 switch (event
->event
->instrumentation
) {
505 case LTTNG_KERNEL_KPROBE
:
507 * Comments in lttng-kernel.h mention that
508 * either addr or symbol_name are set, not both.
510 addr
= event
->event
->u
.kprobe
.addr
;
511 offset
= event
->event
->u
.kprobe
.offset
;
512 symbol_name
= addr
? NULL
: event
->event
->u
.kprobe
.symbol_name
;
514 case LTTNG_KERNEL_KRETPROBE
:
515 addr
= event
->event
->u
.kretprobe
.addr
;
516 offset
= event
->event
->u
.kretprobe
.offset
;
517 symbol_name
= addr
? NULL
: event
->event
->u
.kretprobe
.symbol_name
;
521 ERR("Unsupported kernel instrumentation type.");
522 ret
= LTTNG_ERR_INVALID
;
526 ret
= config_writer_open_element(writer
, config_element_probe_attributes
);
528 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
533 ret
= config_writer_write_element_unsigned_int( writer
,
534 config_element_address
, addr
);
536 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
539 } else if (symbol_name
) {
540 ret
= config_writer_write_element_string(writer
,
541 config_element_symbol_name
, symbol_name
);
543 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
546 /* If the offset is non-zero, write it.*/
548 ret
= config_writer_write_element_unsigned_int(writer
,
549 config_element_offset
, offset
);
551 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
557 * This really should not happen as we are either setting the
558 * address or the symbol above.
560 ERR("Invalid probe/function description.");
561 ret
= LTTNG_ERR_INVALID
;
566 ret
= config_writer_close_element(writer
);
568 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
576 * Save the userspace probe tracepoint event associated with the event to the
580 int save_kernel_userspace_probe_tracepoint_event(struct config_writer
*writer
,
581 struct ltt_kernel_event
*event
)
584 const char *probe_name
, *provider_name
, *binary_path
;
585 const struct lttng_userspace_probe_location
*userspace_probe_location
;
586 const struct lttng_userspace_probe_location_lookup_method
*lookup_method
;
587 enum lttng_userspace_probe_location_lookup_method_type lookup_type
;
589 /* Get userspace probe location from the event. */
590 userspace_probe_location
= event
->userspace_probe_location
;
591 if (!userspace_probe_location
) {
592 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
596 /* Get lookup method and lookup method type. */
597 lookup_method
= lttng_userspace_probe_location_get_lookup_method(userspace_probe_location
);
598 if (!lookup_method
) {
599 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
603 lookup_type
= lttng_userspace_probe_location_lookup_method_get_type(lookup_method
);
605 /* Get the binary path, probe name and provider name. */
607 lttng_userspace_probe_location_tracepoint_get_binary_path(
608 userspace_probe_location
);
610 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
615 lttng_userspace_probe_location_tracepoint_get_probe_name(
616 userspace_probe_location
);
618 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
623 lttng_userspace_probe_location_tracepoint_get_provider_name(
624 userspace_probe_location
);
625 if (!provider_name
) {
626 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
630 /* Open a userspace probe tracepoint attribute. */
631 ret
= config_writer_open_element(writer
, config_element_userspace_probe_tracepoint_attributes
);
633 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
637 switch (lookup_type
) {
638 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_TRACEPOINT_SDT
:
639 ret
= config_writer_write_element_string(writer
,
640 config_element_userspace_probe_lookup
,
641 config_element_userspace_probe_lookup_tracepoint_sdt
);
643 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
648 ERR("Unsupported kernel userspace probe tracepoint lookup method.");
649 ret
= LTTNG_ERR_INVALID
;
653 /* Write the binary path, provider name and the probe name. */
654 ret
= config_writer_write_element_string(writer
,
655 config_element_userspace_probe_location_binary_path
,
658 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
662 ret
= config_writer_write_element_string(writer
,
663 config_element_userspace_probe_tracepoint_location_provider_name
,
666 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
670 ret
= config_writer_write_element_string(writer
,
671 config_element_userspace_probe_tracepoint_location_probe_name
,
674 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
678 /* Close the userspace probe tracepoint attribute. */
679 ret
= config_writer_close_element(writer
);
681 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
690 * Save the userspace probe function event associated with the event to the
694 int save_kernel_userspace_probe_function_event(struct config_writer
*writer
,
695 struct ltt_kernel_event
*event
)
698 const char *function_name
, *binary_path
;
699 const struct lttng_userspace_probe_location
*userspace_probe_location
;
700 const struct lttng_userspace_probe_location_lookup_method
*lookup_method
;
701 enum lttng_userspace_probe_location_lookup_method_type lookup_type
;
703 /* Get userspace probe location from the event. */
704 userspace_probe_location
= event
->userspace_probe_location
;
705 if (!userspace_probe_location
) {
706 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
710 /* Get lookup method and lookup method type. */
711 lookup_method
= lttng_userspace_probe_location_get_lookup_method(
712 userspace_probe_location
);
713 if (!lookup_method
) {
714 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
718 /* Get the binary path and the function name. */
720 lttng_userspace_probe_location_function_get_binary_path(
721 userspace_probe_location
);
723 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
728 lttng_userspace_probe_location_function_get_function_name(
729 userspace_probe_location
);
730 if (!function_name
) {
731 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
735 /* Open a userspace probe function attribute. */
736 ret
= config_writer_open_element(writer
,
737 config_element_userspace_probe_function_attributes
);
739 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
743 lookup_type
= lttng_userspace_probe_location_lookup_method_get_type(lookup_method
);
744 switch (lookup_type
) {
745 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF
:
746 ret
= config_writer_write_element_string(writer
,
747 config_element_userspace_probe_lookup
,
748 config_element_userspace_probe_lookup_function_elf
);
750 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
754 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_DEFAULT
:
755 ret
= config_writer_write_element_string(writer
,
756 config_element_userspace_probe_lookup
,
757 config_element_userspace_probe_lookup_function_default
);
759 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
764 ERR("Unsupported kernel userspace probe function lookup method.");
765 ret
= LTTNG_ERR_INVALID
;
769 /* Write the binary path and the function name. */
770 ret
= config_writer_write_element_string(writer
,
771 config_element_userspace_probe_location_binary_path
,
774 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
778 ret
= config_writer_write_element_string(writer
,
779 config_element_userspace_probe_function_location_function_name
,
782 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
786 /* Close the userspace probe function attribute. */
787 ret
= config_writer_close_element(writer
);
789 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
798 int save_kernel_userspace_probe_event(struct config_writer
*writer
,
799 struct ltt_kernel_event
*event
)
802 struct lttng_userspace_probe_location
*userspace_probe_location
;
804 /* Get userspace probe location from the event. */
805 userspace_probe_location
= event
->userspace_probe_location
;
806 if (!userspace_probe_location
) {
807 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
811 switch(lttng_userspace_probe_location_get_type(userspace_probe_location
)) {
812 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION
:
814 ret
= save_kernel_userspace_probe_function_event(writer
, event
);
816 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
821 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT
:
823 ret
= save_kernel_userspace_probe_tracepoint_event(writer
, event
);
825 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
830 case LTTNG_USERSPACE_PROBE_LOCATION_TYPE_UNKNOWN
:
832 ERR("Unsupported kernel userspace probe location type.");
833 ret
= LTTNG_ERR_INVALID
;
842 int save_kernel_event(struct config_writer
*writer
,
843 struct ltt_kernel_event
*event
)
846 const char *instrumentation_type
;
848 ret
= config_writer_open_element(writer
, config_element_event
);
850 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
854 if (event
->event
->name
[0]) {
855 ret
= config_writer_write_element_string(writer
,
856 config_element_name
, event
->event
->name
);
858 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
863 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
866 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
870 instrumentation_type
= get_kernel_instrumentation_string(
871 event
->event
->instrumentation
);
872 if (!instrumentation_type
) {
873 ret
= LTTNG_ERR_INVALID
;
877 ret
= config_writer_write_element_string(writer
, config_element_type
,
878 instrumentation_type
);
880 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
884 if (event
->filter_expression
) {
885 ret
= config_writer_write_element_string(writer
,
886 config_element_filter
,
887 event
->filter_expression
);
889 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
894 if (event
->event
->instrumentation
== LTTNG_KERNEL_FUNCTION
||
895 event
->event
->instrumentation
== LTTNG_KERNEL_KPROBE
||
896 event
->event
->instrumentation
== LTTNG_KERNEL_UPROBE
||
897 event
->event
->instrumentation
== LTTNG_KERNEL_KRETPROBE
) {
899 ret
= config_writer_open_element(writer
,
900 config_element_attributes
);
902 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
906 switch (event
->event
->instrumentation
) {
907 case LTTNG_KERNEL_SYSCALL
:
908 case LTTNG_KERNEL_FUNCTION
:
909 ret
= save_kernel_function_event(writer
, event
);
914 case LTTNG_KERNEL_KPROBE
:
915 case LTTNG_KERNEL_KRETPROBE
:
916 ret
= save_kernel_kprobe_event(writer
, event
);
921 case LTTNG_KERNEL_UPROBE
:
922 ret
= save_kernel_userspace_probe_event(writer
, event
);
928 ERR("Unsupported kernel instrumentation type.");
929 ret
= LTTNG_ERR_INVALID
;
934 ret
= config_writer_close_element(writer
);
936 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
942 ret
= config_writer_close_element(writer
);
944 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
952 int save_kernel_events(struct config_writer
*writer
,
953 struct ltt_kernel_channel
*kchan
)
956 struct ltt_kernel_event
*event
;
958 ret
= config_writer_open_element(writer
, config_element_events
);
960 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
964 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
965 ret
= save_kernel_event(writer
, event
);
972 ret
= config_writer_close_element(writer
);
974 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
982 int save_ust_event(struct config_writer
*writer
,
983 struct ltt_ust_event
*event
)
986 const char *loglevel_type_string
;
988 ret
= config_writer_open_element(writer
, config_element_event
);
990 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
994 if (event
->attr
.name
[0]) {
995 ret
= config_writer_write_element_string(writer
,
996 config_element_name
, event
->attr
.name
);
998 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1003 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1006 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1010 if (event
->attr
.instrumentation
!= LTTNG_UST_TRACEPOINT
) {
1011 ERR("Unsupported UST instrumentation type.");
1012 ret
= LTTNG_ERR_INVALID
;
1015 ret
= config_writer_write_element_string(writer
, config_element_type
,
1016 config_event_type_tracepoint
);
1018 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1022 loglevel_type_string
= get_loglevel_type_string(
1023 event
->attr
.loglevel_type
);
1024 if (!loglevel_type_string
) {
1025 ERR("Unsupported UST loglevel type.");
1026 ret
= LTTNG_ERR_INVALID
;
1030 ret
= config_writer_write_element_string(writer
,
1031 config_element_loglevel_type
, loglevel_type_string
);
1033 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1037 /* The log level is irrelevant if no "filtering" is enabled */
1038 if (event
->attr
.loglevel_type
!= LTTNG_UST_LOGLEVEL_ALL
) {
1039 ret
= config_writer_write_element_signed_int(writer
,
1040 config_element_loglevel
, event
->attr
.loglevel
);
1042 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1047 if (event
->filter_expression
) {
1048 ret
= config_writer_write_element_string(writer
,
1049 config_element_filter
, event
->filter_expression
);
1051 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1056 if (event
->exclusion
&& event
->exclusion
->count
) {
1059 ret
= config_writer_open_element(writer
,
1060 config_element_exclusions
);
1062 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1066 for (i
= 0; i
< event
->exclusion
->count
; i
++) {
1067 ret
= config_writer_write_element_string(writer
,
1068 config_element_exclusion
,
1069 LTTNG_EVENT_EXCLUSION_NAME_AT(
1070 event
->exclusion
, i
));
1072 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1078 ret
= config_writer_close_element(writer
);
1080 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1086 ret
= config_writer_close_element(writer
);
1088 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1096 int save_ust_events(struct config_writer
*writer
,
1097 struct lttng_ht
*events
)
1100 struct ltt_ust_event
*event
;
1101 struct lttng_ht_node_str
*node
;
1102 struct lttng_ht_iter iter
;
1104 ret
= config_writer_open_element(writer
, config_element_events
);
1106 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1111 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
1112 event
= caa_container_of(node
, struct ltt_ust_event
, node
);
1114 if (event
->internal
) {
1115 /* Internal events must not be exposed to clients */
1118 ret
= save_ust_event(writer
, event
);
1127 ret
= config_writer_close_element(writer
);
1129 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1137 int init_ust_event_from_agent_event(struct ltt_ust_event
*ust_event
,
1138 struct agent_event
*agent_event
)
1141 enum lttng_ust_loglevel_type ust_loglevel_type
;
1143 ust_event
->enabled
= agent_event
->enabled
;
1144 ust_event
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
1145 if (lttng_strncpy(ust_event
->attr
.name
, agent_event
->name
,
1146 LTTNG_SYMBOL_NAME_LEN
)) {
1150 switch (agent_event
->loglevel_type
) {
1151 case LTTNG_EVENT_LOGLEVEL_ALL
:
1152 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1154 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
1155 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
1157 case LTTNG_EVENT_LOGLEVEL_RANGE
:
1158 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
1161 ERR("Invalid agent_event loglevel_type.");
1166 ust_event
->attr
.loglevel_type
= ust_loglevel_type
;
1167 ust_event
->attr
.loglevel
= agent_event
->loglevel_value
;
1168 ust_event
->filter_expression
= agent_event
->filter_expression
;
1169 ust_event
->exclusion
= agent_event
->exclusion
;
1175 int save_agent_events(struct config_writer
*writer
,
1176 struct agent
*agent
)
1179 struct lttng_ht_iter iter
;
1180 struct lttng_ht_node_str
*node
;
1182 ret
= config_writer_open_element(writer
, config_element_events
);
1184 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1189 cds_lfht_for_each_entry(agent
->events
->ht
, &iter
.iter
, node
, node
) {
1191 struct agent_event
*agent_event
;
1192 struct ltt_ust_event fake_event
;
1194 memset(&fake_event
, 0, sizeof(fake_event
));
1195 agent_event
= caa_container_of(node
, struct agent_event
, node
);
1198 * Initialize a fake ust event to reuse the same serialization
1199 * function since UST and agent events contain the same info
1200 * (and one could wonder why they don't reuse the same
1203 ret
= init_ust_event_from_agent_event(&fake_event
, agent_event
);
1208 ret
= save_ust_event(writer
, &fake_event
);
1217 ret
= config_writer_close_element(writer
);
1219 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1227 int save_kernel_context(struct config_writer
*writer
,
1228 struct lttng_kernel_context
*ctx
)
1236 ret
= config_writer_open_element(writer
, config_element_context
);
1238 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1242 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
1243 ret
= config_writer_open_element(writer
,
1244 config_element_context_perf
);
1246 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1250 ret
= config_writer_write_element_unsigned_int(writer
,
1251 config_element_type
, ctx
->u
.perf_counter
.type
);
1253 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1257 ret
= config_writer_write_element_unsigned_int(writer
,
1258 config_element_config
, ctx
->u
.perf_counter
.config
);
1260 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1264 ret
= config_writer_write_element_string(writer
,
1265 config_element_name
, ctx
->u
.perf_counter
.name
);
1267 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1272 ret
= config_writer_close_element(writer
);
1274 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1278 const char *context_type_string
=
1279 get_kernel_context_type_string(ctx
->ctx
);
1281 if (!context_type_string
) {
1282 ERR("Unsupported kernel context type.");
1283 ret
= LTTNG_ERR_INVALID
;
1287 ret
= config_writer_write_element_string(writer
,
1288 config_element_type
, context_type_string
);
1290 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1296 ret
= config_writer_close_element(writer
);
1298 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1307 int save_kernel_contexts(struct config_writer
*writer
,
1308 struct ltt_kernel_channel
*kchan
)
1311 struct ltt_kernel_context
*ctx
;
1313 if (cds_list_empty(&kchan
->ctx_list
)) {
1318 ret
= config_writer_open_element(writer
, config_element_contexts
);
1320 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1324 cds_list_for_each_entry(ctx
, &kchan
->ctx_list
, list
) {
1325 ret
= save_kernel_context(writer
, &ctx
->ctx
);
1332 ret
= config_writer_close_element(writer
);
1334 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1342 int save_ust_context_perf_thread_counter(struct config_writer
*writer
,
1343 struct ltt_ust_context
*ctx
)
1350 /* Perf contexts are saved as event_perf_context_type */
1351 ret
= config_writer_open_element(writer
, config_element_context_perf
);
1353 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1357 ret
= config_writer_write_element_unsigned_int(writer
,
1358 config_element_type
, ctx
->ctx
.u
.perf_counter
.type
);
1360 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1364 ret
= config_writer_write_element_unsigned_int(writer
,
1365 config_element_config
, ctx
->ctx
.u
.perf_counter
.config
);
1367 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1371 ret
= config_writer_write_element_string(writer
, config_element_name
,
1372 ctx
->ctx
.u
.perf_counter
.name
);
1374 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1379 ret
= config_writer_close_element(writer
);
1381 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1389 int save_ust_context_app_ctx(struct config_writer
*writer
,
1390 struct ltt_ust_context
*ctx
)
1397 /* Application contexts are saved as application_context_type */
1398 ret
= config_writer_open_element(writer
, config_element_context_app
);
1400 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1404 ret
= config_writer_write_element_string(writer
,
1405 config_element_context_app_provider_name
,
1406 ctx
->ctx
.u
.app_ctx
.provider_name
);
1408 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1412 ret
= config_writer_write_element_string(writer
,
1413 config_element_context_app_ctx_name
,
1414 ctx
->ctx
.u
.app_ctx
.ctx_name
);
1416 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1421 ret
= config_writer_close_element(writer
);
1423 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1431 int save_ust_context_generic(struct config_writer
*writer
,
1432 struct ltt_ust_context
*ctx
)
1435 const char *context_type_string
;
1440 /* Save context as event_context_type_type */
1441 context_type_string
= get_ust_context_type_string(
1443 if (!context_type_string
) {
1444 ERR("Unsupported UST context type.");
1445 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1449 ret
= config_writer_write_element_string(writer
,
1450 config_element_type
, context_type_string
);
1452 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1460 int save_ust_context(struct config_writer
*writer
,
1461 struct cds_list_head
*ctx_list
)
1464 struct ltt_ust_context
*ctx
;
1469 ret
= config_writer_open_element(writer
, config_element_contexts
);
1471 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1475 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
1476 ret
= config_writer_open_element(writer
,
1477 config_element_context
);
1479 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1483 switch (ctx
->ctx
.ctx
) {
1484 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
1485 ret
= save_ust_context_perf_thread_counter(writer
, ctx
);
1487 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
1488 ret
= save_ust_context_app_ctx(writer
, ctx
);
1491 /* Save generic context. */
1492 ret
= save_ust_context_generic(writer
, ctx
);
1499 ret
= config_writer_close_element(writer
);
1501 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1507 ret
= config_writer_close_element(writer
);
1509 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1517 int save_kernel_channel(struct config_writer
*writer
,
1518 struct ltt_kernel_channel
*kchan
)
1525 ret
= config_writer_open_element(writer
, config_element_channel
);
1527 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1531 ret
= config_writer_write_element_string(writer
, config_element_name
,
1532 kchan
->channel
->name
);
1534 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1538 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1539 kchan
->channel
->enabled
);
1541 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1545 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
1550 ret
= save_kernel_events(writer
, kchan
);
1555 ret
= save_kernel_contexts(writer
, kchan
);
1561 ret
= config_writer_close_element(writer
);
1563 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1571 int save_ust_channel(struct config_writer
*writer
,
1572 struct ltt_ust_channel
*ust_chan
,
1573 struct ltt_ust_session
*session
)
1581 ret
= config_writer_open_element(writer
, config_element_channel
);
1583 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1587 ret
= config_writer_write_element_string(writer
, config_element_name
,
1590 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1594 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1597 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1601 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
1606 ret
= config_writer_write_element_unsigned_int(writer
,
1607 config_element_tracefile_size
, ust_chan
->tracefile_size
);
1609 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1613 ret
= config_writer_write_element_unsigned_int(writer
,
1614 config_element_tracefile_count
, ust_chan
->tracefile_count
);
1616 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1620 ret
= config_writer_write_element_unsigned_int(writer
,
1621 config_element_live_timer_interval
,
1622 session
->live_timer_interval
);
1624 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1628 if (ust_chan
->domain
== LTTNG_DOMAIN_UST
) {
1629 ret
= save_ust_events(writer
, ust_chan
->events
);
1634 struct agent
*agent
= NULL
;
1636 agent
= trace_ust_find_agent(session
, ust_chan
->domain
);
1638 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1639 ERR("Could not find agent associated to UST subdomain");
1644 * Channels associated with a UST sub-domain (such as JUL, Log4j
1645 * or Python) don't have any non-internal events. We retrieve
1646 * the "agent" events associated with this channel and serialize
1649 ret
= save_agent_events(writer
, agent
);
1655 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1661 ret
= config_writer_close_element(writer
);
1663 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1671 int save_kernel_session(struct config_writer
*writer
,
1672 struct ltt_session
*session
)
1675 struct ltt_kernel_channel
*kchan
;
1680 ret
= config_writer_write_element_string(writer
, config_element_type
,
1681 config_domain_type_kernel
);
1683 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1687 ret
= config_writer_write_element_string(writer
,
1688 config_element_buffer_type
, config_buffer_type_global
);
1690 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1694 ret
= config_writer_open_element(writer
,
1695 config_element_channels
);
1697 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1701 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1703 ret
= save_kernel_channel(writer
, kchan
);
1710 ret
= config_writer_close_element(writer
);
1712 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1720 const char *get_config_domain_str(enum lttng_domain_type domain
)
1722 const char *str_dom
;
1725 case LTTNG_DOMAIN_KERNEL
:
1726 str_dom
= config_domain_type_kernel
;
1728 case LTTNG_DOMAIN_UST
:
1729 str_dom
= config_domain_type_ust
;
1731 case LTTNG_DOMAIN_JUL
:
1732 str_dom
= config_domain_type_jul
;
1734 case LTTNG_DOMAIN_LOG4J
:
1735 str_dom
= config_domain_type_log4j
;
1737 case LTTNG_DOMAIN_PYTHON
:
1738 str_dom
= config_domain_type_python
;
1748 int save_pid_tracker(struct config_writer
*writer
,
1749 struct ltt_session
*sess
, int domain
)
1752 ssize_t nr_pids
= 0, i
;
1753 int32_t *pids
= NULL
;
1756 case LTTNG_DOMAIN_KERNEL
:
1758 nr_pids
= kernel_list_tracker_pids(sess
->kernel_session
, &pids
);
1760 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1765 case LTTNG_DOMAIN_UST
:
1767 nr_pids
= trace_ust_list_tracker_pids(sess
->ust_session
, &pids
);
1769 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1774 case LTTNG_DOMAIN_JUL
:
1775 case LTTNG_DOMAIN_LOG4J
:
1776 case LTTNG_DOMAIN_PYTHON
:
1778 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1782 /* Only create a pid_tracker if enabled or untrack all */
1783 if (nr_pids
!= 1 || (nr_pids
== 1 && pids
[0] != -1)) {
1784 ret
= config_writer_open_element(writer
,
1785 config_element_pid_tracker
);
1787 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1791 ret
= config_writer_open_element(writer
,
1792 config_element_targets
);
1794 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1798 for (i
= 0; i
< nr_pids
; i
++) {
1799 ret
= config_writer_open_element(writer
,
1800 config_element_target_pid
);
1802 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1806 ret
= config_writer_write_element_unsigned_int(writer
,
1807 config_element_pid
, pids
[i
]);
1809 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1814 ret
= config_writer_close_element(writer
);
1816 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1822 ret
= config_writer_close_element(writer
);
1824 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1829 ret
= config_writer_close_element(writer
);
1831 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1841 int save_ust_domain(struct config_writer
*writer
,
1842 struct ltt_session
*session
, enum lttng_domain_type domain
)
1845 struct ltt_ust_channel
*ust_chan
;
1846 const char *buffer_type_string
;
1847 struct lttng_ht_node_str
*node
;
1848 struct lttng_ht_iter iter
;
1849 const char *config_domain_name
;
1854 ret
= config_writer_open_element(writer
,
1855 config_element_domain
);
1857 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1861 config_domain_name
= get_config_domain_str(domain
);
1862 if (!config_domain_name
) {
1863 ret
= LTTNG_ERR_INVALID
;
1867 ret
= config_writer_write_element_string(writer
,
1868 config_element_type
, config_domain_name
);
1870 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1874 buffer_type_string
= get_buffer_type_string(
1875 session
->ust_session
->buffer_type
);
1876 if (!buffer_type_string
) {
1877 ERR("Unsupported buffer type.");
1878 ret
= LTTNG_ERR_INVALID
;
1882 ret
= config_writer_write_element_string(writer
,
1883 config_element_buffer_type
, buffer_type_string
);
1885 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1889 ret
= config_writer_open_element(writer
, config_element_channels
);
1891 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1896 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1897 &iter
.iter
, node
, node
) {
1898 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1899 if (domain
== ust_chan
->domain
) {
1900 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1910 ret
= config_writer_close_element(writer
);
1912 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1916 if (domain
== LTTNG_DOMAIN_UST
) {
1917 ret
= config_writer_open_element(writer
,
1918 config_element_trackers
);
1920 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1924 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_UST
);
1930 ret
= config_writer_close_element(writer
);
1937 ret
= config_writer_close_element(writer
);
1939 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1948 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1955 if (!session
->kernel_session
&& !session
->ust_session
) {
1959 ret
= config_writer_open_element(writer
, config_element_domains
);
1961 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1966 if (session
->kernel_session
) {
1967 ret
= config_writer_open_element(writer
,
1968 config_element_domain
);
1970 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1974 ret
= save_kernel_session(writer
, session
);
1979 ret
= config_writer_open_element(writer
,
1980 config_element_trackers
);
1982 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1986 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_KERNEL
);
1992 ret
= config_writer_close_element(writer
);
1994 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1998 ret
= config_writer_close_element(writer
);
2000 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2005 if (session
->ust_session
) {
2006 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_UST
);
2011 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_JUL
);
2016 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_LOG4J
);
2021 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_PYTHON
);
2028 ret
= config_writer_close_element(writer
);
2030 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2038 int save_consumer_output(struct config_writer
*writer
,
2039 struct consumer_output
*output
)
2046 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
2048 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2052 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
2055 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2059 ret
= config_writer_open_element(writer
, config_element_destination
);
2061 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2065 switch (output
->type
) {
2066 case CONSUMER_DST_LOCAL
:
2067 ret
= config_writer_write_element_string(writer
,
2068 config_element_path
, output
->dst
.session_root_path
);
2070 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2074 case CONSUMER_DST_NET
:
2078 uri
= zmalloc(PATH_MAX
);
2080 ret
= LTTNG_ERR_NOMEM
;
2084 ret
= config_writer_open_element(writer
, config_element_net_output
);
2086 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2087 goto end_net_output
;
2090 if (output
->dst
.net
.control_isset
&&
2091 output
->dst
.net
.data_isset
) {
2092 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
2094 ret
= LTTNG_ERR_INVALID
;
2095 goto end_net_output
;
2098 ret
= config_writer_write_element_string(writer
,
2099 config_element_control_uri
, uri
);
2101 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2102 goto end_net_output
;
2105 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
2107 ret
= LTTNG_ERR_INVALID
;
2108 goto end_net_output
;
2111 ret
= config_writer_write_element_string(writer
,
2112 config_element_data_uri
, uri
);
2114 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2115 goto end_net_output
;
2124 ret
= !output
->dst
.net
.control_isset
?
2125 LTTNG_ERR_URL_CTRL_MISS
:
2126 LTTNG_ERR_URL_DATA_MISS
;
2131 ret
= config_writer_close_element(writer
);
2133 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2139 ERR("Unsupported consumer output type.");
2140 ret
= LTTNG_ERR_INVALID
;
2145 ret
= config_writer_close_element(writer
);
2147 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2151 /* /consumer_output */
2152 ret
= config_writer_close_element(writer
);
2154 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2162 int save_snapshot_outputs(struct config_writer
*writer
,
2163 struct snapshot
*snapshot
)
2166 struct lttng_ht_iter iter
;
2167 struct snapshot_output
*output
;
2172 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
2174 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2179 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
2181 ret
= config_writer_open_element(writer
,
2182 config_element_output
);
2184 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2188 ret
= config_writer_write_element_string(writer
,
2189 config_element_name
, output
->name
);
2191 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2195 ret
= config_writer_write_element_unsigned_int(writer
,
2196 config_element_max_size
, output
->max_size
);
2198 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2202 ret
= save_consumer_output(writer
, output
->consumer
);
2208 ret
= config_writer_close_element(writer
);
2210 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2216 /* /snapshot_outputs */
2217 ret
= config_writer_close_element(writer
);
2219 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2231 int save_session_output(struct config_writer
*writer
,
2232 struct ltt_session
*session
)
2239 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
2240 (!session
->snapshot_mode
&& !session
->consumer
)) {
2241 /* Session is in no output mode */
2246 ret
= config_writer_open_element(writer
, config_element_output
);
2248 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2252 if (session
->snapshot_mode
) {
2253 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
2258 if (session
->consumer
) {
2259 ret
= save_consumer_output(writer
, session
->consumer
);
2267 ret
= config_writer_close_element(writer
);
2269 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2277 int save_session_rotation_schedule(struct config_writer
*writer
,
2278 enum lttng_rotation_schedule_type type
, uint64_t value
)
2281 const char *element_name
;
2282 const char *value_name
;
2285 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
2286 element_name
= config_element_rotation_schedule_periodic
;
2287 value_name
= config_element_rotation_schedule_periodic_time_us
;
2289 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
2290 element_name
= config_element_rotation_schedule_size_threshold
;
2291 value_name
= config_element_rotation_schedule_size_threshold_bytes
;
2298 ret
= config_writer_open_element(writer
, element_name
);
2303 ret
= config_writer_write_element_unsigned_int(writer
,
2309 /* Close schedule descriptor element. */
2310 ret
= config_writer_close_element(writer
);
2319 int save_session_rotation_schedules(struct config_writer
*writer
,
2320 struct ltt_session
*session
)
2324 ret
= config_writer_open_element(writer
,
2325 config_element_rotation_schedules
);
2329 if (session
->rotate_timer_period
) {
2330 ret
= save_session_rotation_schedule(writer
,
2331 LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
,
2332 session
->rotate_timer_period
);
2334 goto close_schedules
;
2337 if (session
->rotate_size
) {
2338 ret
= save_session_rotation_schedule(writer
,
2339 LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
,
2340 session
->rotate_size
);
2342 goto close_schedules
;
2347 /* Close rotation schedules element. */
2348 ret
= config_writer_close_element(writer
);
2357 * Save the given session.
2359 * Return 0 on success else a LTTNG_ERR* code.
2362 int save_session(struct ltt_session
*session
,
2363 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
2366 char config_file_path
[LTTNG_PATH_MAX
];
2368 struct config_writer
*writer
= NULL
;
2369 size_t session_name_len
;
2370 const char *provided_path
;
2371 int file_open_flags
= O_CREAT
| O_WRONLY
| O_TRUNC
;
2377 session_name_len
= strlen(session
->name
);
2378 memset(config_file_path
, 0, sizeof(config_file_path
));
2380 if (!session_access_ok(session
,
2381 LTTNG_SOCK_GET_UID_CRED(creds
),
2382 LTTNG_SOCK_GET_GID_CRED(creds
)) || session
->destroyed
) {
2383 ret
= LTTNG_ERR_EPERM
;
2387 provided_path
= lttng_save_session_attr_get_output_url(attr
);
2388 if (provided_path
) {
2389 DBG3("Save session in provided path %s", provided_path
);
2390 len
= strlen(provided_path
);
2391 if (len
>= sizeof(config_file_path
)) {
2392 ret
= LTTNG_ERR_SET_URL
;
2395 strncpy(config_file_path
, provided_path
, sizeof(config_file_path
));
2398 char *home_dir
= utils_get_user_home_dir(
2399 LTTNG_SOCK_GET_UID_CRED(creds
));
2401 ret
= LTTNG_ERR_SET_URL
;
2405 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
2406 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
2409 PERROR("snprintf save session");
2410 ret
= LTTNG_ERR_SET_URL
;
2417 * Check the path fits in the config file path dst including the '/'
2418 * followed by trailing .lttng extension and the NULL terminated string.
2420 if ((len
+ session_name_len
+ 2 +
2421 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
2422 > sizeof(config_file_path
)) {
2423 ret
= LTTNG_ERR_SET_URL
;
2427 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
2428 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
2430 ret
= LTTNG_ERR_SET_URL
;
2435 * At this point, we know that everything fits in the buffer. Validation
2436 * was done just above.
2438 config_file_path
[len
++] = '/';
2439 strncpy(config_file_path
+ len
, session
->name
, sizeof(config_file_path
) - len
);
2440 len
+= session_name_len
;
2441 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
2442 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
2443 config_file_path
[len
] = '\0';
2445 if (!attr
->overwrite
) {
2446 file_open_flags
|= O_EXCL
;
2449 fd
= run_as_open(config_file_path
, file_open_flags
,
2450 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
2451 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
2453 PERROR("Could not create configuration file");
2456 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
2459 ret
= LTTNG_ERR_EPERM
;
2462 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2468 writer
= config_writer_create(fd
, 1);
2470 ret
= LTTNG_ERR_NOMEM
;
2474 ret
= config_writer_open_element(writer
, config_element_sessions
);
2476 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2480 ret
= config_writer_open_element(writer
, config_element_session
);
2482 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2486 ret
= config_writer_write_element_string(writer
, config_element_name
,
2489 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2493 if(session
->shm_path
[0] != '\0') {
2494 ret
= config_writer_write_element_string(writer
,
2495 config_element_shared_memory_path
,
2498 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2503 ret
= save_domains(writer
, session
);
2508 ret
= config_writer_write_element_bool(writer
, config_element_started
,
2511 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2515 if (session
->snapshot_mode
|| session
->live_timer
||
2516 session
->rotate_timer_period
|| session
->rotate_size
) {
2517 ret
= config_writer_open_element(writer
, config_element_attributes
);
2519 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2523 if (session
->snapshot_mode
) {
2524 ret
= config_writer_write_element_bool(writer
,
2525 config_element_snapshot_mode
, 1);
2527 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2530 } else if (session
->live_timer
) {
2531 ret
= config_writer_write_element_unsigned_int(writer
,
2532 config_element_live_timer_interval
, session
->live_timer
);
2534 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2538 if (session
->rotate_timer_period
|| session
->rotate_size
) {
2539 ret
= save_session_rotation_schedules(writer
,
2542 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2548 ret
= config_writer_close_element(writer
);
2550 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2555 ret
= save_session_output(writer
, session
);
2561 ret
= config_writer_close_element(writer
);
2563 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2568 ret
= config_writer_close_element(writer
);
2570 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2574 if (writer
&& config_writer_destroy(writer
)) {
2575 /* Preserve the original error code */
2576 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
2579 /* Delete file in case of error */
2580 if ((fd
>= 0) && unlink(config_file_path
)) {
2581 PERROR("Unlinking XML session configuration.");
2588 PERROR("Closing XML session configuration");
2595 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
2596 lttng_sock_cred
*creds
)
2599 const char *session_name
;
2600 struct ltt_session
*session
;
2602 session_lock_list();
2604 session_name
= lttng_save_session_attr_get_session_name(attr
);
2606 session
= session_find_by_name(session_name
);
2608 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
2612 session_lock(session
);
2613 ret
= save_session(session
, attr
, creds
);
2614 session_unlock(session
);
2615 session_put(session
);
2620 struct ltt_session_list
*list
= session_get_list();
2622 cds_list_for_each_entry(session
, &list
->head
, list
) {
2623 if (!session_get(session
)) {
2626 session_lock(session
);
2627 ret
= save_session(session
, attr
, creds
);
2628 session_unlock(session
);
2629 session_put(session
);
2630 /* Don't abort if we don't have the required permissions. */
2631 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
2639 session_unlock_list();