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
:
264 * Error, should not be stored in the XML, perf contexts
265 * are stored as a node of type event_perf_context_type.
268 context_type_string
= NULL
;
272 return context_type_string
;
276 const char *get_buffer_type_string(
277 enum lttng_buffer_type buffer_type
)
279 const char *buffer_type_string
;
281 switch (buffer_type
) {
282 case LTTNG_BUFFER_PER_PID
:
283 buffer_type_string
= config_buffer_type_per_pid
;
285 case LTTNG_BUFFER_PER_UID
:
286 buffer_type_string
= config_buffer_type_per_uid
;
288 case LTTNG_BUFFER_GLOBAL
:
289 buffer_type_string
= config_buffer_type_global
;
292 buffer_type_string
= NULL
;
295 return buffer_type_string
;
299 const char *get_loglevel_type_string(
300 enum lttng_ust_loglevel_type loglevel_type
)
302 const char *loglevel_type_string
;
304 switch (loglevel_type
) {
305 case LTTNG_UST_LOGLEVEL_ALL
:
306 loglevel_type_string
= config_loglevel_type_all
;
308 case LTTNG_UST_LOGLEVEL_RANGE
:
309 loglevel_type_string
= config_loglevel_type_range
;
311 case LTTNG_UST_LOGLEVEL_SINGLE
:
312 loglevel_type_string
= config_loglevel_type_single
;
315 loglevel_type_string
= NULL
;
318 return loglevel_type_string
;
322 int save_kernel_event(struct config_writer
*writer
,
323 struct ltt_kernel_event
*event
)
326 const char *instrumentation_type
;
328 ret
= config_writer_open_element(writer
, config_element_event
);
330 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
334 if (event
->event
->name
[0]) {
335 ret
= config_writer_write_element_string(writer
,
336 config_element_name
, event
->event
->name
);
338 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
343 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
346 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
350 instrumentation_type
= get_kernel_instrumentation_string(
351 event
->event
->instrumentation
);
352 if (!instrumentation_type
) {
353 ret
= LTTNG_ERR_INVALID
;
357 ret
= config_writer_write_element_string(writer
, config_element_type
,
358 instrumentation_type
);
360 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
364 if (event
->event
->instrumentation
== LTTNG_KERNEL_FUNCTION
||
365 event
->event
->instrumentation
== LTTNG_KERNEL_KPROBE
||
366 event
->event
->instrumentation
== LTTNG_KERNEL_KRETPROBE
) {
368 ret
= config_writer_open_element(writer
,
369 config_element_attributes
);
371 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
375 switch (event
->event
->instrumentation
) {
376 case LTTNG_KERNEL_SYSCALL
:
377 case LTTNG_KERNEL_FUNCTION
:
378 ret
= config_writer_open_element(writer
,
379 config_element_function_attributes
);
381 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
385 ret
= config_writer_write_element_string(writer
,
387 event
->event
->u
.ftrace
.symbol_name
);
389 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
393 /* /function attributes */
394 ret
= config_writer_close_element(writer
);
396 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
400 case LTTNG_KERNEL_KPROBE
:
401 case LTTNG_KERNEL_KRETPROBE
:
403 const char *symbol_name
;
407 if (event
->event
->instrumentation
==
408 LTTNG_KERNEL_KPROBE
) {
410 * Comments in lttng-kernel.h mention that
411 * either addr or symbol_name are set, not both.
413 addr
= event
->event
->u
.kprobe
.addr
;
414 offset
= event
->event
->u
.kprobe
.offset
;
415 symbol_name
= addr
? NULL
:
416 event
->event
->u
.kprobe
.symbol_name
;
419 event
->event
->u
.kretprobe
.symbol_name
;
420 addr
= event
->event
->u
.kretprobe
.addr
;
421 offset
= event
->event
->u
.kretprobe
.offset
;
424 ret
= config_writer_open_element(writer
,
425 config_element_probe_attributes
);
427 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
432 ret
= config_writer_write_element_string(writer
,
433 config_element_symbol_name
,
436 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
442 ret
= config_writer_write_element_unsigned_int(
443 writer
, config_element_address
, addr
);
445 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
451 ret
= config_writer_write_element_unsigned_int(
452 writer
, config_element_offset
, offset
);
454 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
459 ret
= config_writer_close_element(writer
);
461 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
467 ERR("Unsupported kernel instrumentation type.");
468 ret
= LTTNG_ERR_INVALID
;
473 ret
= config_writer_close_element(writer
);
475 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
481 ret
= config_writer_close_element(writer
);
483 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
491 int save_kernel_syscall(struct config_writer
*writer
,
492 struct ltt_kernel_channel
*kchan
)
496 struct lttng_event
*events
= NULL
;
501 count
= syscall_list_channel(kchan
, &events
, 0);
503 /* No syscalls, just gracefully return. */
508 for (i
= 0; i
< count
; i
++) {
509 struct ltt_kernel_event
*kevent
;
511 /* Create a temporary kevent in order to save it. */
512 kevent
= trace_kernel_create_event(&events
[i
]);
517 /* Init list in order so the destroy call can del the node. */
518 CDS_INIT_LIST_HEAD(&kevent
->list
);
520 ret
= save_kernel_event(writer
, kevent
);
521 trace_kernel_destroy_event(kevent
);
527 /* Everything went well */
536 int save_kernel_events(struct config_writer
*writer
,
537 struct ltt_kernel_channel
*kchan
)
540 struct ltt_kernel_event
*event
;
542 ret
= config_writer_open_element(writer
, config_element_events
);
544 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
548 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
549 ret
= save_kernel_event(writer
, event
);
555 /* Save syscalls if any. */
556 ret
= save_kernel_syscall(writer
, kchan
);
562 ret
= config_writer_close_element(writer
);
564 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
572 int save_ust_event(struct config_writer
*writer
,
573 struct ltt_ust_event
*event
)
576 const char *loglevel_type_string
;
578 ret
= config_writer_open_element(writer
, config_element_event
);
580 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
584 if (event
->attr
.name
[0]) {
585 ret
= config_writer_write_element_string(writer
,
586 config_element_name
, event
->attr
.name
);
588 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
593 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
596 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
600 if (event
->attr
.instrumentation
!= LTTNG_UST_TRACEPOINT
) {
601 ERR("Unsupported UST instrumentation type.");
602 ret
= LTTNG_ERR_INVALID
;
605 ret
= config_writer_write_element_string(writer
, config_element_type
,
606 config_event_type_tracepoint
);
608 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
612 loglevel_type_string
= get_loglevel_type_string(
613 event
->attr
.loglevel_type
);
614 if (!loglevel_type_string
) {
615 ERR("Unsupported UST loglevel type.");
616 ret
= LTTNG_ERR_INVALID
;
620 ret
= config_writer_write_element_string(writer
,
621 config_element_loglevel_type
, loglevel_type_string
);
623 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
627 /* The log level is irrelevant if no "filtering" is enabled */
628 if (event
->attr
.loglevel_type
!= LTTNG_UST_LOGLEVEL_ALL
) {
629 ret
= config_writer_write_element_signed_int(writer
,
630 config_element_loglevel
, event
->attr
.loglevel
);
632 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
637 if (event
->filter_expression
) {
638 ret
= config_writer_write_element_string(writer
,
639 config_element_filter
, event
->filter_expression
);
641 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
646 if (event
->exclusion
&& event
->exclusion
->count
) {
649 ret
= config_writer_open_element(writer
,
650 config_element_exclusions
);
652 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
656 for (i
= 0; i
< event
->exclusion
->count
; i
++) {
657 ret
= config_writer_write_element_string(writer
,
658 config_element_exclusion
,
659 &event
->exclusion
->names
[0][i
]);
661 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
667 ret
= config_writer_close_element(writer
);
669 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
675 ret
= config_writer_close_element(writer
);
677 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
685 int save_ust_events(struct config_writer
*writer
,
686 struct lttng_ht
*events
)
689 struct ltt_ust_event
*event
;
690 struct lttng_ht_node_str
*node
;
691 struct lttng_ht_iter iter
;
693 ret
= config_writer_open_element(writer
, config_element_events
);
695 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
700 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
701 event
= caa_container_of(node
, struct ltt_ust_event
, node
);
703 ret
= save_ust_event(writer
, event
);
712 ret
= config_writer_close_element(writer
);
714 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
722 int save_kernel_context(struct config_writer
*writer
,
723 struct lttng_kernel_context
*ctx
)
731 ret
= config_writer_open_element(writer
, config_element_context
);
733 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
737 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
738 ret
= config_writer_open_element(writer
, config_element_perf
);
740 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
744 ret
= config_writer_write_element_unsigned_int(writer
,
745 config_element_type
, ctx
->u
.perf_counter
.type
);
747 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
751 ret
= config_writer_write_element_unsigned_int(writer
,
752 config_element_config
, ctx
->u
.perf_counter
.config
);
754 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
758 ret
= config_writer_write_element_string(writer
,
759 config_element_name
, ctx
->u
.perf_counter
.name
);
761 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
766 ret
= config_writer_close_element(writer
);
768 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
772 const char *context_type_string
=
773 get_kernel_context_type_string(ctx
->ctx
);
775 if (!context_type_string
) {
776 ERR("Unsupported kernel context type.");
777 ret
= LTTNG_ERR_INVALID
;
781 ret
= config_writer_write_element_string(writer
,
782 config_element_type
, context_type_string
);
784 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
790 ret
= config_writer_close_element(writer
);
792 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
801 int save_kernel_contexts(struct config_writer
*writer
,
802 struct ltt_kernel_channel
*kchan
)
805 struct ltt_kernel_context
*ctx
;
807 if (cds_list_empty(&kchan
->ctx_list
)) {
812 ret
= config_writer_open_element(writer
, config_element_contexts
);
814 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
818 cds_list_for_each_entry(ctx
, &kchan
->ctx_list
, list
) {
819 ret
= save_kernel_context(writer
, &ctx
->ctx
);
826 ret
= config_writer_close_element(writer
);
828 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
836 int save_ust_context(struct config_writer
*writer
,
837 struct cds_list_head
*ctx_list
)
840 struct ltt_ust_context
*ctx
;
845 ret
= config_writer_open_element(writer
, config_element_contexts
);
847 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
851 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
852 const char *context_type_string
;
855 ret
= config_writer_open_element(writer
,
856 config_element_context
);
858 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
862 if (ctx
->ctx
.ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
863 /* Perf contexts are saved as event_perf_context_type */
864 ret
= config_writer_open_element(writer
,
865 config_element_perf
);
867 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
871 ret
= config_writer_write_element_unsigned_int(writer
,
873 ctx
->ctx
.u
.perf_counter
.type
);
875 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
879 ret
= config_writer_write_element_unsigned_int(writer
,
880 config_element_config
,
881 ctx
->ctx
.u
.perf_counter
.config
);
883 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
887 ret
= config_writer_write_element_string(writer
,
889 ctx
->ctx
.u
.perf_counter
.name
);
891 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
896 ret
= config_writer_close_element(writer
);
898 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
902 /* Save context as event_context_type_type */
903 context_type_string
= get_ust_context_type_string(
905 if (!context_type_string
) {
906 ERR("Unsupported UST context type.")
907 ret
= LTTNG_ERR_INVALID
;
911 ret
= config_writer_write_element_string(writer
,
912 config_element_type
, context_type_string
);
914 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
920 ret
= config_writer_close_element(writer
);
922 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
928 ret
= config_writer_close_element(writer
);
930 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
938 int save_kernel_channel(struct config_writer
*writer
,
939 struct ltt_kernel_channel
*kchan
)
946 ret
= config_writer_open_element(writer
, config_element_channel
);
948 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
952 ret
= config_writer_write_element_string(writer
, config_element_name
,
953 kchan
->channel
->name
);
955 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
959 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
960 kchan
->channel
->enabled
);
962 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
966 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
971 ret
= save_kernel_events(writer
, kchan
);
976 ret
= save_kernel_contexts(writer
, kchan
);
982 ret
= config_writer_close_element(writer
);
984 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
992 int save_ust_channel(struct config_writer
*writer
,
993 struct ltt_ust_channel
*ust_chan
,
994 struct ltt_ust_session
*session
)
1002 ret
= config_writer_open_element(writer
, config_element_channel
);
1004 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1008 ret
= config_writer_write_element_string(writer
, config_element_name
,
1011 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1015 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1018 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1022 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
1027 ret
= config_writer_write_element_unsigned_int(writer
,
1028 config_element_tracefile_size
, ust_chan
->tracefile_size
);
1030 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1034 ret
= config_writer_write_element_unsigned_int(writer
,
1035 config_element_tracefile_count
, ust_chan
->tracefile_count
);
1037 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1041 ret
= config_writer_write_element_unsigned_int(writer
,
1042 config_element_live_timer_interval
,
1043 session
->live_timer_interval
);
1045 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1049 ret
= save_ust_events(writer
, ust_chan
->events
);
1051 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1055 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1061 ret
= config_writer_close_element(writer
);
1063 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1071 int save_kernel_session(struct config_writer
*writer
,
1072 struct ltt_session
*session
)
1075 struct ltt_kernel_channel
*kchan
;
1080 ret
= config_writer_write_element_string(writer
, config_element_type
,
1081 config_domain_type_kernel
);
1083 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1087 ret
= config_writer_write_element_string(writer
,
1088 config_element_buffer_type
, config_buffer_type_global
);
1090 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1094 ret
= config_writer_open_element(writer
,
1095 config_element_channels
);
1097 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1101 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1103 ret
= save_kernel_channel(writer
, kchan
);
1110 ret
= config_writer_close_element(writer
);
1112 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1120 int save_ust_session(struct config_writer
*writer
,
1121 struct ltt_session
*session
, int save_agent
)
1124 struct ltt_ust_channel
*ust_chan
;
1125 const char *buffer_type_string
;
1126 struct lttng_ht_node_str
*node
;
1127 struct lttng_ht_iter iter
;
1132 ret
= config_writer_write_element_string(writer
, config_element_type
,
1133 save_agent
? config_domain_type_jul
: config_domain_type_ust
);
1135 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1139 buffer_type_string
= get_buffer_type_string(
1140 session
->ust_session
->buffer_type
);
1141 if (!buffer_type_string
) {
1142 ERR("Unsupported buffer type.");
1143 ret
= LTTNG_ERR_INVALID
;
1147 ret
= config_writer_write_element_string(writer
,
1148 config_element_buffer_type
, buffer_type_string
);
1150 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1154 ret
= config_writer_open_element(writer
, config_element_channels
);
1156 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1161 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1162 &iter
.iter
, node
, node
) {
1165 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1166 agent_channel
= !strcmp(DEFAULT_JUL_CHANNEL_NAME
, ust_chan
->name
) ||
1167 !strcmp(DEFAULT_LOG4J_CHANNEL_NAME
, ust_chan
->name
);
1168 if (!(save_agent
^ agent_channel
)) {
1169 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1179 ret
= config_writer_close_element(writer
);
1181 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1189 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1196 if (!session
->kernel_session
&& !session
->ust_session
) {
1200 ret
= config_writer_open_element(writer
, config_element_domains
);
1202 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1207 if (session
->kernel_session
) {
1208 ret
= config_writer_open_element(writer
,
1209 config_element_domain
);
1211 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1215 ret
= save_kernel_session(writer
, session
);
1221 ret
= config_writer_close_element(writer
);
1223 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1228 if (session
->ust_session
) {
1229 unsigned long agent_count
;
1231 ret
= config_writer_open_element(writer
,
1232 config_element_domain
);
1234 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1238 ret
= save_ust_session(writer
, session
, 0);
1244 ret
= config_writer_close_element(writer
);
1246 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1252 lttng_ht_get_count(session
->ust_session
->agents
);
1255 if (agent_count
> 0) {
1256 ret
= config_writer_open_element(writer
,
1257 config_element_domain
);
1259 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1263 ret
= save_ust_session(writer
, session
, 1);
1269 ret
= config_writer_close_element(writer
);
1271 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1277 if (session
->ust_session
) {
1281 ret
= config_writer_close_element(writer
);
1283 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1291 int save_consumer_output(struct config_writer
*writer
,
1292 struct consumer_output
*output
)
1299 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1301 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1305 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1308 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1312 ret
= config_writer_open_element(writer
, config_element_destination
);
1314 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1318 switch (output
->type
) {
1319 case CONSUMER_DST_LOCAL
:
1320 ret
= config_writer_write_element_string(writer
,
1321 config_element_path
, output
->dst
.trace_path
);
1323 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1327 case CONSUMER_DST_NET
:
1331 uri
= zmalloc(PATH_MAX
);
1333 ret
= LTTNG_ERR_NOMEM
;
1337 ret
= config_writer_open_element(writer
, config_element_net_output
);
1339 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1340 goto end_net_output
;
1343 if (output
->dst
.net
.control_isset
&&
1344 output
->dst
.net
.data_isset
) {
1345 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1347 ret
= LTTNG_ERR_INVALID
;
1348 goto end_net_output
;
1351 ret
= config_writer_write_element_string(writer
,
1352 config_element_control_uri
, uri
);
1354 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1355 goto end_net_output
;
1358 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1360 ret
= LTTNG_ERR_INVALID
;
1361 goto end_net_output
;
1364 ret
= config_writer_write_element_string(writer
,
1365 config_element_data_uri
, uri
);
1367 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1368 goto end_net_output
;
1377 ret
= !output
->dst
.net
.control_isset
?
1378 LTTNG_ERR_URL_CTRL_MISS
:
1379 LTTNG_ERR_URL_DATA_MISS
;
1384 ret
= config_writer_close_element(writer
);
1386 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1392 ERR("Unsupported consumer output type.");
1393 ret
= LTTNG_ERR_INVALID
;
1398 ret
= config_writer_close_element(writer
);
1400 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1404 /* /consumer_output */
1405 ret
= config_writer_close_element(writer
);
1407 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1415 int save_snapshot_outputs(struct config_writer
*writer
,
1416 struct snapshot
*snapshot
)
1419 struct lttng_ht_iter iter
;
1420 struct snapshot_output
*output
;
1425 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1427 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1432 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1434 ret
= config_writer_open_element(writer
,
1435 config_element_output
);
1437 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1441 ret
= config_writer_write_element_string(writer
,
1442 config_element_name
, output
->name
);
1444 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1448 ret
= config_writer_write_element_unsigned_int(writer
,
1449 config_element_max_size
, output
->max_size
);
1451 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1455 ret
= save_consumer_output(writer
, output
->consumer
);
1461 ret
= config_writer_close_element(writer
);
1463 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1469 /* /snapshot_outputs */
1470 ret
= config_writer_close_element(writer
);
1472 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1484 int save_session_output(struct config_writer
*writer
,
1485 struct ltt_session
*session
)
1492 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1493 (!session
->snapshot_mode
&& !session
->consumer
)) {
1494 /* Session is in no output mode */
1499 ret
= config_writer_open_element(writer
, config_element_output
);
1501 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1505 if (session
->snapshot_mode
) {
1506 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1511 if (session
->consumer
) {
1512 ret
= save_consumer_output(writer
, session
->consumer
);
1520 ret
= config_writer_close_element(writer
);
1522 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1530 * Save the given session.
1532 * Return 0 on success else a LTTNG_ERR* code.
1535 int save_session(struct ltt_session
*session
,
1536 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1539 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1540 char config_file_path
[PATH_MAX
];
1542 struct config_writer
*writer
= NULL
;
1543 size_t session_name_len
;
1544 const char *provided_path
;
1550 session_name_len
= strlen(session
->name
);
1551 memset(config_file_path
, 0, sizeof(config_file_path
));
1553 if (!session_access_ok(session
,
1554 LTTNG_SOCK_GET_UID_CRED(creds
),
1555 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1556 ret
= LTTNG_ERR_EPERM
;
1560 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1561 if (provided_path
) {
1562 DBG3("Save session in provided path %s", provided_path
);
1563 len
= strlen(provided_path
);
1564 if (len
>= sizeof(config_file_path
)) {
1565 ret
= LTTNG_ERR_SET_URL
;
1568 strncpy(config_file_path
, provided_path
, len
);
1571 char *home_dir
= utils_get_user_home_dir(
1572 LTTNG_SOCK_GET_UID_CRED(creds
));
1574 ret
= LTTNG_ERR_SET_URL
;
1578 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1579 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1582 PERROR("snprintf save session");
1583 ret
= LTTNG_ERR_SET_URL
;
1590 * Check the path fits in the config file path dst including the '/'
1591 * followed by trailing .lttng extension and the NULL terminated string.
1593 if ((len
+ session_name_len
+ 2 +
1594 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1595 > sizeof(config_file_path
)) {
1596 ret
= LTTNG_ERR_SET_URL
;
1600 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1601 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1603 ret
= LTTNG_ERR_SET_URL
;
1608 * At this point, we know that everything fits in the buffer. Validation
1609 * was done just above.
1611 config_file_path
[len
++] = '/';
1612 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1613 len
+= session_name_len
;
1614 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1615 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1616 config_file_path
[len
] = '\0';
1618 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1619 /* File exists, notify the user since the overwrite flag is off. */
1620 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1624 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1625 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1626 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1628 PERROR("Could not create configuration file");
1629 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1634 writer
= config_writer_create(fd
, 1);
1636 ret
= LTTNG_ERR_NOMEM
;
1640 ret
= config_writer_open_element(writer
, config_element_sessions
);
1642 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1646 ret
= config_writer_open_element(writer
, config_element_session
);
1648 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1652 ret
= config_writer_write_element_string(writer
, config_element_name
,
1655 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1659 ret
= save_domains(writer
, session
);
1664 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1667 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1671 if (session
->snapshot_mode
|| session
->live_timer
) {
1672 ret
= config_writer_open_element(writer
, config_element_attributes
);
1674 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1678 if (session
->snapshot_mode
) {
1679 ret
= config_writer_write_element_bool(writer
,
1680 config_element_snapshot_mode
, 1);
1682 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1686 ret
= config_writer_write_element_unsigned_int(writer
,
1687 config_element_live_timer_interval
, session
->live_timer
);
1689 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1695 ret
= config_writer_close_element(writer
);
1697 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1702 ret
= save_session_output(writer
, session
);
1708 ret
= config_writer_close_element(writer
);
1710 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1715 ret
= config_writer_close_element(writer
);
1717 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1721 if (writer
&& config_writer_destroy(writer
)) {
1722 /* Preserve the original error code */
1723 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
1726 /* Delete file in case of error */
1727 if (file_opened
&& unlink(config_file_path
)) {
1728 PERROR("Unlinking XML session configuration.");
1735 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
1736 lttng_sock_cred
*creds
)
1739 const char *session_name
;
1740 struct ltt_session
*session
;
1742 session_lock_list();
1744 session_name
= lttng_save_session_attr_get_session_name(attr
);
1746 session
= session_find_by_name(session_name
);
1748 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1752 session_lock(session
);
1753 ret
= save_session(session
, attr
, creds
);
1754 session_unlock(session
);
1759 struct ltt_session_list
*list
= session_get_list();
1761 cds_list_for_each_entry(session
, &list
->head
, list
) {
1762 session_lock(session
);
1763 ret
= save_session(session
, attr
, creds
);
1764 session_unlock(session
);
1766 /* Don't abort if we don't have the required permissions. */
1767 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
1775 session_unlock_list();