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/config.h>
28 #include <common/utils.h>
29 #include <common/runas.h>
30 #include <lttng/save-internal.h>
35 #include "trace-ust.h"
38 int save_kernel_channel_attributes(struct config_writer
*writer
,
39 struct lttng_channel_attr
*attr
)
43 ret
= config_writer_write_element_string(writer
,
44 config_element_overwrite_mode
,
45 attr
->overwrite
? config_overwrite_mode_overwrite
:
46 config_overwrite_mode_discard
);
51 ret
= config_writer_write_element_unsigned_int(writer
,
52 config_element_subbuf_size
, attr
->subbuf_size
);
57 ret
= config_writer_write_element_unsigned_int(writer
,
58 config_element_num_subbuf
,
64 ret
= config_writer_write_element_unsigned_int(writer
,
65 config_element_switch_timer_interval
,
66 attr
->switch_timer_interval
);
71 ret
= config_writer_write_element_unsigned_int(writer
,
72 config_element_read_timer_interval
,
73 attr
->read_timer_interval
);
78 ret
= config_writer_write_element_string(writer
,
79 config_element_output_type
,
80 attr
->output
== LTTNG_EVENT_SPLICE
?
81 config_output_type_splice
: config_output_type_mmap
);
86 ret
= config_writer_write_element_unsigned_int(writer
,
87 config_element_tracefile_size
, attr
->tracefile_size
);
92 ret
= config_writer_write_element_unsigned_int(writer
,
93 config_element_tracefile_count
,
94 attr
->tracefile_count
);
99 ret
= config_writer_write_element_unsigned_int(writer
,
100 config_element_live_timer_interval
,
101 attr
->live_timer_interval
);
106 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
110 int save_ust_channel_attributes(struct config_writer
*writer
,
111 struct lttng_ust_channel_attr
*attr
)
115 ret
= config_writer_write_element_string(writer
,
116 config_element_overwrite_mode
,
117 attr
->overwrite
? config_overwrite_mode_overwrite
:
118 config_overwrite_mode_discard
);
123 ret
= config_writer_write_element_unsigned_int(writer
,
124 config_element_subbuf_size
, attr
->subbuf_size
);
129 ret
= config_writer_write_element_unsigned_int(writer
,
130 config_element_num_subbuf
,
136 ret
= config_writer_write_element_unsigned_int(writer
,
137 config_element_switch_timer_interval
,
138 attr
->switch_timer_interval
);
143 ret
= config_writer_write_element_unsigned_int(writer
,
144 config_element_read_timer_interval
,
145 attr
->read_timer_interval
);
150 ret
= config_writer_write_element_string(writer
,
151 config_element_output_type
,
152 attr
->output
== LTTNG_UST_MMAP
?
153 config_output_type_mmap
: config_output_type_splice
);
158 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
162 const char *get_kernel_instrumentation_string(
163 enum lttng_kernel_instrumentation instrumentation
)
165 const char *instrumentation_string
;
167 switch (instrumentation
) {
168 case LTTNG_KERNEL_ALL
:
169 instrumentation_string
= config_event_type_all
;
171 case LTTNG_KERNEL_TRACEPOINT
:
172 instrumentation_string
= config_event_type_tracepoint
;
174 case LTTNG_KERNEL_KPROBE
:
175 instrumentation_string
= config_event_type_kprobe
;
177 case LTTNG_KERNEL_FUNCTION
:
178 instrumentation_string
= config_event_type_function
;
180 case LTTNG_KERNEL_KRETPROBE
:
181 instrumentation_string
= config_event_type_kretprobe
;
183 case LTTNG_KERNEL_NOOP
:
184 instrumentation_string
= config_event_type_noop
;
186 case LTTNG_KERNEL_SYSCALL
:
187 instrumentation_string
= config_event_type_syscall
;
190 instrumentation_string
= NULL
;
193 return instrumentation_string
;
197 const char *get_kernel_context_type_string(
198 enum lttng_kernel_context_type context_type
)
200 const char *context_type_string
;
202 switch (context_type
) {
203 case LTTNG_KERNEL_CONTEXT_PID
:
204 context_type_string
= config_event_context_pid
;
206 case LTTNG_KERNEL_CONTEXT_PROCNAME
:
207 context_type_string
= config_event_context_procname
;
209 case LTTNG_KERNEL_CONTEXT_PRIO
:
210 context_type_string
= config_event_context_prio
;
212 case LTTNG_KERNEL_CONTEXT_NICE
:
213 context_type_string
= config_event_context_nice
;
215 case LTTNG_KERNEL_CONTEXT_VPID
:
216 context_type_string
= config_event_context_vpid
;
218 case LTTNG_KERNEL_CONTEXT_TID
:
219 context_type_string
= config_event_context_tid
;
221 case LTTNG_KERNEL_CONTEXT_VTID
:
222 context_type_string
= config_event_context_vtid
;
224 case LTTNG_KERNEL_CONTEXT_PPID
:
225 context_type_string
= config_event_context_ppid
;
227 case LTTNG_KERNEL_CONTEXT_VPPID
:
228 context_type_string
= config_event_context_vppid
;
230 case LTTNG_KERNEL_CONTEXT_HOSTNAME
:
231 context_type_string
= config_event_context_hostname
;
234 context_type_string
= NULL
;
237 return context_type_string
;
241 const char *get_ust_context_type_string(
242 enum lttng_ust_context_type context_type
)
244 const char *context_type_string
;
246 switch (context_type
) {
247 case LTTNG_UST_CONTEXT_PROCNAME
:
248 context_type_string
= config_event_context_procname
;
250 case LTTNG_UST_CONTEXT_VPID
:
251 context_type_string
= config_event_context_vpid
;
253 case LTTNG_UST_CONTEXT_VTID
:
254 context_type_string
= config_event_context_vtid
;
256 case LTTNG_UST_CONTEXT_IP
:
257 context_type_string
= config_event_context_ip
;
259 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
260 context_type_string
= config_event_context_pthread_id
;
262 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
263 context_type_string
= config_event_context_perf_thread_counter
;
266 context_type_string
= NULL
;
270 return context_type_string
;
274 const char *get_buffer_type_string(
275 enum lttng_buffer_type buffer_type
)
277 const char *buffer_type_string
;
279 switch (buffer_type
) {
280 case LTTNG_BUFFER_PER_PID
:
281 buffer_type_string
= config_buffer_type_per_pid
;
283 case LTTNG_BUFFER_PER_UID
:
284 buffer_type_string
= config_buffer_type_per_uid
;
286 case LTTNG_BUFFER_GLOBAL
:
287 buffer_type_string
= config_buffer_type_global
;
290 buffer_type_string
= NULL
;
293 return buffer_type_string
;
297 const char *get_loglevel_type_string(
298 enum lttng_ust_loglevel_type loglevel_type
)
300 const char *loglevel_type_string
;
302 switch (loglevel_type
) {
303 case LTTNG_UST_LOGLEVEL_ALL
:
304 loglevel_type_string
= config_loglevel_type_all
;
306 case LTTNG_UST_LOGLEVEL_RANGE
:
307 loglevel_type_string
= config_loglevel_type_range
;
309 case LTTNG_UST_LOGLEVEL_SINGLE
:
310 loglevel_type_string
= config_loglevel_type_single
;
313 loglevel_type_string
= NULL
;
316 return loglevel_type_string
;
320 int save_kernel_event(struct config_writer
*writer
,
321 struct ltt_kernel_event
*event
)
324 const char *instrumentation_type
;
326 ret
= config_writer_open_element(writer
, config_element_event
);
328 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
332 if (event
->event
->name
[0]) {
333 ret
= config_writer_write_element_string(writer
,
334 config_element_name
, event
->event
->name
);
336 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
341 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
344 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
348 instrumentation_type
= get_kernel_instrumentation_string(
349 event
->event
->instrumentation
);
350 if (!instrumentation_type
) {
351 ret
= LTTNG_ERR_INVALID
;
355 ret
= config_writer_write_element_string(writer
, config_element_type
,
356 instrumentation_type
);
358 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
362 if (event
->event
->instrumentation
== LTTNG_KERNEL_FUNCTION
||
363 event
->event
->instrumentation
== LTTNG_KERNEL_KPROBE
||
364 event
->event
->instrumentation
== LTTNG_KERNEL_KRETPROBE
) {
366 ret
= config_writer_open_element(writer
,
367 config_element_attributes
);
369 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
373 switch (event
->event
->instrumentation
) {
374 case LTTNG_KERNEL_SYSCALL
:
375 case LTTNG_KERNEL_FUNCTION
:
376 ret
= config_writer_open_element(writer
,
377 config_element_function_attributes
);
379 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
383 ret
= config_writer_write_element_string(writer
,
385 event
->event
->u
.ftrace
.symbol_name
);
387 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
391 /* /function attributes */
392 ret
= config_writer_close_element(writer
);
394 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
398 case LTTNG_KERNEL_KPROBE
:
399 case LTTNG_KERNEL_KRETPROBE
:
401 const char *symbol_name
;
405 if (event
->event
->instrumentation
==
406 LTTNG_KERNEL_KPROBE
) {
408 * Comments in lttng-kernel.h mention that
409 * either addr or symbol_name are set, not both.
411 addr
= event
->event
->u
.kprobe
.addr
;
412 offset
= event
->event
->u
.kprobe
.offset
;
413 symbol_name
= addr
? NULL
:
414 event
->event
->u
.kprobe
.symbol_name
;
417 event
->event
->u
.kretprobe
.symbol_name
;
418 addr
= event
->event
->u
.kretprobe
.addr
;
419 offset
= event
->event
->u
.kretprobe
.offset
;
422 ret
= config_writer_open_element(writer
,
423 config_element_probe_attributes
);
425 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
430 ret
= config_writer_write_element_string(writer
,
431 config_element_symbol_name
,
434 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
440 ret
= config_writer_write_element_unsigned_int(
441 writer
, config_element_address
, addr
);
443 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
449 ret
= config_writer_write_element_unsigned_int(
450 writer
, config_element_offset
, offset
);
452 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
457 ret
= config_writer_close_element(writer
);
459 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
465 ERR("Unsupported kernel instrumentation type.");
466 ret
= LTTNG_ERR_INVALID
;
471 ret
= config_writer_close_element(writer
);
473 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
479 ret
= config_writer_close_element(writer
);
481 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
489 int save_kernel_syscall(struct config_writer
*writer
,
490 struct ltt_kernel_channel
*kchan
)
494 struct lttng_event
*events
= NULL
;
499 count
= syscall_list_channel(kchan
, &events
, 0);
501 /* No syscalls, just gracefully return. */
506 for (i
= 0; i
< count
; i
++) {
507 struct ltt_kernel_event
*kevent
;
509 /* Create a temporary kevent in order to save it. */
510 kevent
= trace_kernel_create_event(&events
[i
]);
515 /* Init list in order so the destroy call can del the node. */
516 CDS_INIT_LIST_HEAD(&kevent
->list
);
518 ret
= save_kernel_event(writer
, kevent
);
519 trace_kernel_destroy_event(kevent
);
525 /* Everything went well */
534 int save_kernel_events(struct config_writer
*writer
,
535 struct ltt_kernel_channel
*kchan
)
538 struct ltt_kernel_event
*event
;
540 ret
= config_writer_open_element(writer
, config_element_events
);
542 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
546 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
547 ret
= save_kernel_event(writer
, event
);
553 /* Save syscalls if any. */
554 ret
= save_kernel_syscall(writer
, kchan
);
560 ret
= config_writer_close_element(writer
);
562 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
570 int save_ust_event(struct config_writer
*writer
,
571 struct ltt_ust_event
*event
)
574 const char *loglevel_type_string
;
576 ret
= config_writer_open_element(writer
, config_element_event
);
578 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
582 if (event
->attr
.name
[0]) {
583 ret
= config_writer_write_element_string(writer
,
584 config_element_name
, event
->attr
.name
);
586 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
591 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
594 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
598 if (event
->attr
.instrumentation
!= LTTNG_UST_TRACEPOINT
) {
599 ERR("Unsupported UST instrumentation type.");
600 ret
= LTTNG_ERR_INVALID
;
603 ret
= config_writer_write_element_string(writer
, config_element_type
,
604 config_event_type_tracepoint
);
606 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
610 loglevel_type_string
= get_loglevel_type_string(
611 event
->attr
.loglevel_type
);
612 if (!loglevel_type_string
) {
613 ERR("Unsupported UST loglevel type.");
614 ret
= LTTNG_ERR_INVALID
;
618 ret
= config_writer_write_element_string(writer
,
619 config_element_loglevel_type
, loglevel_type_string
);
621 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
625 ret
= config_writer_write_element_signed_int(writer
,
626 config_element_loglevel
, event
->attr
.loglevel
);
628 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
632 if (event
->filter_expression
) {
633 ret
= config_writer_write_element_string(writer
,
634 config_element_filter
, event
->filter_expression
);
636 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
641 if (event
->exclusion
&& event
->exclusion
->count
) {
644 ret
= config_writer_open_element(writer
,
645 config_element_exclusions
);
647 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
651 for (i
= 0; i
< event
->exclusion
->count
; i
++) {
652 ret
= config_writer_write_element_string(writer
,
653 config_element_exclusion
,
654 &event
->exclusion
->names
[0][i
]);
656 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
662 ret
= config_writer_close_element(writer
);
664 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
670 ret
= config_writer_close_element(writer
);
672 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
680 int save_ust_events(struct config_writer
*writer
,
681 struct lttng_ht
*events
)
684 struct ltt_ust_event
*event
;
685 struct lttng_ht_node_str
*node
;
686 struct lttng_ht_iter iter
;
688 ret
= config_writer_open_element(writer
, config_element_events
);
690 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
695 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
696 event
= caa_container_of(node
, struct ltt_ust_event
, node
);
698 ret
= save_ust_event(writer
, event
);
707 ret
= config_writer_close_element(writer
);
709 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
717 int save_kernel_context(struct config_writer
*writer
,
718 struct lttng_kernel_context
*ctx
)
726 ret
= config_writer_open_element(writer
, config_element_context
);
728 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
732 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
733 ret
= config_writer_open_element(writer
, config_element_perf
);
735 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
739 ret
= config_writer_write_element_unsigned_int(writer
,
740 config_element_type
, ctx
->u
.perf_counter
.type
);
742 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
746 ret
= config_writer_write_element_unsigned_int(writer
,
747 config_element_config
, ctx
->u
.perf_counter
.config
);
749 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
753 ret
= config_writer_write_element_string(writer
,
754 config_element_name
, ctx
->u
.perf_counter
.name
);
756 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
761 ret
= config_writer_close_element(writer
);
763 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
767 const char *context_type_string
=
768 get_kernel_context_type_string(ctx
->ctx
);
770 if (!context_type_string
) {
771 ERR("Unsupported kernel context type.");
772 ret
= LTTNG_ERR_INVALID
;
776 ret
= config_writer_write_element_string(writer
,
777 config_element_type
, context_type_string
);
779 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
785 ret
= config_writer_close_element(writer
);
787 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
796 int save_kernel_contexts(struct config_writer
*writer
,
797 struct ltt_kernel_channel
*kchan
)
800 struct ltt_kernel_context
*ctx
;
802 ret
= config_writer_open_element(writer
, config_element_contexts
);
804 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
808 cds_list_for_each_entry(ctx
, &kchan
->ctx_list
, list
) {
809 ret
= save_kernel_context(writer
, &ctx
->ctx
);
816 ret
= config_writer_close_element(writer
);
818 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
826 int save_ust_context(struct config_writer
*writer
,
827 struct cds_list_head
*ctx_list
)
830 struct ltt_ust_context
*ctx
;
835 ret
= config_writer_open_element(writer
, config_element_contexts
);
837 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
841 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
842 const char *context_type_string
;
844 context_type_string
= get_ust_context_type_string(ctx
->ctx
.ctx
);
845 if (!context_type_string
) {
846 ERR("Unsupported UST context type.")
847 ret
= LTTNG_ERR_INVALID
;
851 ret
= config_writer_open_element(writer
,
852 config_element_context
);
854 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
858 ret
= config_writer_write_element_string(writer
,
859 config_element_type
, context_type_string
);
861 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
866 ret
= config_writer_close_element(writer
);
868 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
874 ret
= config_writer_close_element(writer
);
876 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
884 int save_kernel_channel(struct config_writer
*writer
,
885 struct ltt_kernel_channel
*kchan
)
892 ret
= config_writer_open_element(writer
, config_element_channel
);
894 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
898 ret
= config_writer_write_element_string(writer
, config_element_name
,
899 kchan
->channel
->name
);
901 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
905 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
906 kchan
->channel
->enabled
);
908 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
912 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
917 ret
= save_kernel_events(writer
, kchan
);
922 ret
= save_kernel_contexts(writer
, kchan
);
928 ret
= config_writer_close_element(writer
);
930 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
938 int save_ust_channel(struct config_writer
*writer
,
939 struct ltt_ust_channel
*ust_chan
,
940 struct ltt_ust_session
*session
)
948 ret
= config_writer_open_element(writer
, config_element_channel
);
950 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
954 ret
= config_writer_write_element_string(writer
, config_element_name
,
957 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
961 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
964 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
968 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
973 ret
= config_writer_write_element_unsigned_int(writer
,
974 config_element_tracefile_size
, ust_chan
->tracefile_size
);
976 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
980 ret
= config_writer_write_element_unsigned_int(writer
,
981 config_element_tracefile_count
, ust_chan
->tracefile_count
);
983 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
987 ret
= config_writer_write_element_unsigned_int(writer
,
988 config_element_live_timer_interval
,
989 session
->live_timer_interval
);
991 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
995 ret
= save_ust_events(writer
, ust_chan
->events
);
997 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1001 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1007 ret
= config_writer_close_element(writer
);
1009 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1017 int save_kernel_session(struct config_writer
*writer
,
1018 struct ltt_session
*session
)
1021 struct ltt_kernel_channel
*kchan
;
1026 ret
= config_writer_write_element_string(writer
, config_element_type
,
1027 config_domain_type_kernel
);
1029 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1033 ret
= config_writer_write_element_string(writer
,
1034 config_element_buffer_type
, config_buffer_type_global
);
1036 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1040 ret
= config_writer_open_element(writer
,
1041 config_element_channels
);
1043 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1047 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1049 ret
= save_kernel_channel(writer
, kchan
);
1056 ret
= config_writer_close_element(writer
);
1058 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1066 int save_ust_session(struct config_writer
*writer
,
1067 struct ltt_session
*session
, int save_agent
)
1070 struct ltt_ust_channel
*ust_chan
;
1071 const char *buffer_type_string
;
1072 struct lttng_ht_node_str
*node
;
1073 struct lttng_ht_iter iter
;
1078 ret
= config_writer_write_element_string(writer
, config_element_type
,
1079 save_agent
? config_domain_type_jul
: config_domain_type_ust
);
1081 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1085 buffer_type_string
= get_buffer_type_string(
1086 session
->ust_session
->buffer_type
);
1087 if (!buffer_type_string
) {
1088 ERR("Unsupported buffer type.");
1089 ret
= LTTNG_ERR_INVALID
;
1093 ret
= config_writer_write_element_string(writer
,
1094 config_element_buffer_type
, buffer_type_string
);
1096 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1100 ret
= config_writer_open_element(writer
, config_element_channels
);
1102 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1107 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1108 &iter
.iter
, node
, node
) {
1111 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1112 agent_channel
= !strcmp(DEFAULT_JUL_CHANNEL_NAME
, ust_chan
->name
) ||
1113 !strcmp(DEFAULT_LOG4J_CHANNEL_NAME
, ust_chan
->name
);
1114 if (!(save_agent
^ agent_channel
)) {
1115 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1125 ret
= config_writer_close_element(writer
);
1127 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1135 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1142 if (!session
->kernel_session
&& !session
->ust_session
) {
1146 ret
= config_writer_open_element(writer
, config_element_domains
);
1148 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1153 if (session
->kernel_session
) {
1154 ret
= config_writer_open_element(writer
,
1155 config_element_domain
);
1157 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1161 ret
= save_kernel_session(writer
, session
);
1167 ret
= config_writer_close_element(writer
);
1169 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1174 if (session
->ust_session
) {
1175 ret
= config_writer_open_element(writer
,
1176 config_element_domain
);
1178 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1182 ret
= save_ust_session(writer
, session
, 0);
1188 ret
= config_writer_close_element(writer
);
1190 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1195 if (session
->ust_session
&&
1196 lttng_ht_get_count(session
->ust_session
->agents
) > 0) {
1197 ret
= config_writer_open_element(writer
,
1198 config_element_domain
);
1200 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1204 ret
= save_ust_session(writer
, session
, 1);
1210 ret
= config_writer_close_element(writer
);
1212 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1218 ret
= config_writer_close_element(writer
);
1220 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1228 int save_consumer_output(struct config_writer
*writer
,
1229 struct consumer_output
*output
)
1236 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1238 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1242 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1245 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1249 ret
= config_writer_open_element(writer
, config_element_destination
);
1251 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1255 switch (output
->type
) {
1256 case CONSUMER_DST_LOCAL
:
1257 ret
= config_writer_write_element_string(writer
,
1258 config_element_path
, output
->dst
.trace_path
);
1260 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1264 case CONSUMER_DST_NET
:
1268 uri
= zmalloc(PATH_MAX
);
1270 ret
= LTTNG_ERR_NOMEM
;
1274 ret
= config_writer_open_element(writer
, config_element_net_output
);
1276 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1277 goto end_net_output
;
1280 if (output
->dst
.net
.control_isset
&&
1281 output
->dst
.net
.data_isset
) {
1282 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1284 ret
= LTTNG_ERR_INVALID
;
1285 goto end_net_output
;
1288 ret
= config_writer_write_element_string(writer
,
1289 config_element_control_uri
, uri
);
1291 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1292 goto end_net_output
;
1295 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1297 ret
= LTTNG_ERR_INVALID
;
1298 goto end_net_output
;
1301 ret
= config_writer_write_element_string(writer
,
1302 config_element_data_uri
, uri
);
1304 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1305 goto end_net_output
;
1314 ret
= !output
->dst
.net
.control_isset
?
1315 LTTNG_ERR_URL_CTRL_MISS
:
1316 LTTNG_ERR_URL_DATA_MISS
;
1321 ret
= config_writer_close_element(writer
);
1323 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1329 ERR("Unsupported consumer output type.");
1330 ret
= LTTNG_ERR_INVALID
;
1335 ret
= config_writer_close_element(writer
);
1337 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1341 /* /consumer_output */
1342 ret
= config_writer_close_element(writer
);
1344 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1352 int save_snapshot_outputs(struct config_writer
*writer
,
1353 struct snapshot
*snapshot
)
1356 struct lttng_ht_iter iter
;
1357 struct snapshot_output
*output
;
1362 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1364 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1369 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1371 ret
= config_writer_open_element(writer
,
1372 config_element_output
);
1374 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1378 ret
= config_writer_write_element_string(writer
,
1379 config_element_name
, output
->name
);
1381 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1385 ret
= config_writer_write_element_unsigned_int(writer
,
1386 config_element_max_size
, output
->max_size
);
1388 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1392 ret
= save_consumer_output(writer
, output
->consumer
);
1398 ret
= config_writer_close_element(writer
);
1400 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1406 /* /snapshot_outputs */
1407 ret
= config_writer_close_element(writer
);
1409 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1421 int save_session_output(struct config_writer
*writer
,
1422 struct ltt_session
*session
)
1429 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1430 (!session
->snapshot_mode
&& !session
->consumer
)) {
1431 /* Session is in no output mode */
1436 ret
= config_writer_open_element(writer
, config_element_output
);
1438 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1442 if (session
->snapshot_mode
) {
1443 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1448 if (session
->consumer
) {
1449 ret
= save_consumer_output(writer
, session
->consumer
);
1457 ret
= config_writer_close_element(writer
);
1459 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1467 * Save the given session.
1469 * Return 0 on success else a LTTNG_ERR* code.
1472 int save_session(struct ltt_session
*session
,
1473 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1476 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1477 char config_file_path
[PATH_MAX
];
1479 struct config_writer
*writer
= NULL
;
1480 size_t session_name_len
;
1481 const char *provided_path
;
1487 session_name_len
= strlen(session
->name
);
1488 memset(config_file_path
, 0, sizeof(config_file_path
));
1490 if (!session_access_ok(session
,
1491 LTTNG_SOCK_GET_UID_CRED(creds
),
1492 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1493 ret
= LTTNG_ERR_EPERM
;
1497 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1498 if (provided_path
) {
1499 DBG3("Save session in provided path %s", provided_path
);
1500 len
= strlen(provided_path
);
1501 if (len
>= sizeof(config_file_path
)) {
1502 ret
= LTTNG_ERR_SET_URL
;
1505 strncpy(config_file_path
, provided_path
, len
);
1508 char *home_dir
= utils_get_user_home_dir(
1509 LTTNG_SOCK_GET_UID_CRED(creds
));
1511 ret
= LTTNG_ERR_SET_URL
;
1515 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1516 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1519 PERROR("snprintf save session");
1520 ret
= LTTNG_ERR_SET_URL
;
1527 * Check the path fits in the config file path dst including the '/'
1528 * followed by trailing .lttng extension and the NULL terminated string.
1530 if ((len
+ session_name_len
+ 2 +
1531 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1532 > sizeof(config_file_path
)) {
1533 ret
= LTTNG_ERR_SET_URL
;
1537 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1538 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1540 ret
= LTTNG_ERR_SET_URL
;
1545 * At this point, we know that everything fits in the buffer. Validation
1546 * was done just above.
1548 config_file_path
[len
++] = '/';
1549 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1550 len
+= session_name_len
;
1551 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1552 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1553 config_file_path
[len
] = '\0';
1555 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1556 /* File exists, notify the user since the overwrite flag is off. */
1557 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1561 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1562 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1563 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1565 PERROR("Could not create configuration file");
1566 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1571 writer
= config_writer_create(fd
, 1);
1573 ret
= LTTNG_ERR_NOMEM
;
1577 ret
= config_writer_open_element(writer
, config_element_sessions
);
1579 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1583 ret
= config_writer_open_element(writer
, config_element_session
);
1585 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1589 ret
= config_writer_write_element_string(writer
, config_element_name
,
1592 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1596 ret
= save_domains(writer
, session
);
1601 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1604 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1608 if (session
->snapshot_mode
|| session
->live_timer
) {
1609 ret
= config_writer_open_element(writer
, config_element_attributes
);
1611 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1615 if (session
->snapshot_mode
) {
1616 ret
= config_writer_write_element_bool(writer
,
1617 config_element_snapshot_mode
, 1);
1619 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1623 ret
= config_writer_write_element_unsigned_int(writer
,
1624 config_element_live_timer_interval
, session
->live_timer
);
1626 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1632 ret
= config_writer_close_element(writer
);
1634 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1639 ret
= save_session_output(writer
, session
);
1645 ret
= config_writer_close_element(writer
);
1647 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1652 ret
= config_writer_close_element(writer
);
1654 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1658 if (writer
&& config_writer_destroy(writer
)) {
1659 /* Preserve the original error code */
1660 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
1663 /* Delete file in case of error */
1664 if (file_opened
&& unlink(config_file_path
)) {
1665 PERROR("Unlinking XML session configuration.");
1672 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
1673 lttng_sock_cred
*creds
)
1676 const char *session_name
;
1677 struct ltt_session
*session
;
1679 session_lock_list();
1681 session_name
= lttng_save_session_attr_get_session_name(attr
);
1683 session
= session_find_by_name(session_name
);
1685 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1689 session_lock(session
);
1690 ret
= save_session(session
, attr
, creds
);
1691 session_unlock(session
);
1696 struct ltt_session_list
*list
= session_get_list();
1698 cds_list_for_each_entry(session
, &list
->head
, list
) {
1699 session_lock(session
);
1700 ret
= save_session(session
, attr
, creds
);
1701 session_unlock(session
);
1703 /* Don't abort if we don't have the required permissions. */
1704 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
1712 session_unlock_list();