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>
34 #include "trace-ust.h"
37 int save_kernel_channel_attributes(struct config_writer
*writer
,
38 struct lttng_channel_attr
*attr
)
42 ret
= config_writer_write_element_string(writer
,
43 config_element_overwrite_mode
,
44 attr
->overwrite
? config_overwrite_mode_overwrite
:
45 config_overwrite_mode_discard
);
50 ret
= config_writer_write_element_unsigned_int(writer
,
51 config_element_subbuf_size
, attr
->subbuf_size
);
56 ret
= config_writer_write_element_unsigned_int(writer
,
57 config_element_num_subbuf
,
63 ret
= config_writer_write_element_unsigned_int(writer
,
64 config_element_switch_timer_interval
,
65 attr
->switch_timer_interval
);
70 ret
= config_writer_write_element_unsigned_int(writer
,
71 config_element_read_timer_interval
,
72 attr
->read_timer_interval
);
77 ret
= config_writer_write_element_string(writer
,
78 config_element_output_type
,
79 attr
->output
== LTTNG_EVENT_SPLICE
?
80 config_output_type_splice
: config_output_type_mmap
);
85 ret
= config_writer_write_element_unsigned_int(writer
,
86 config_element_tracefile_size
, attr
->tracefile_size
);
91 ret
= config_writer_write_element_unsigned_int(writer
,
92 config_element_tracefile_count
,
93 attr
->tracefile_count
);
98 ret
= config_writer_write_element_unsigned_int(writer
,
99 config_element_live_timer_interval
,
100 attr
->live_timer_interval
);
105 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
109 int save_ust_channel_attributes(struct config_writer
*writer
,
110 struct lttng_ust_channel_attr
*attr
)
114 ret
= config_writer_write_element_string(writer
,
115 config_element_overwrite_mode
,
116 attr
->overwrite
? config_overwrite_mode_overwrite
:
117 config_overwrite_mode_discard
);
122 ret
= config_writer_write_element_unsigned_int(writer
,
123 config_element_subbuf_size
, attr
->subbuf_size
);
128 ret
= config_writer_write_element_unsigned_int(writer
,
129 config_element_num_subbuf
,
135 ret
= config_writer_write_element_unsigned_int(writer
,
136 config_element_switch_timer_interval
,
137 attr
->switch_timer_interval
);
142 ret
= config_writer_write_element_unsigned_int(writer
,
143 config_element_read_timer_interval
,
144 attr
->read_timer_interval
);
149 ret
= config_writer_write_element_string(writer
,
150 config_element_output_type
,
151 attr
->output
== LTTNG_UST_MMAP
?
152 config_output_type_mmap
: config_output_type_splice
);
157 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
161 const char *get_kernel_instrumentation_string(
162 enum lttng_kernel_instrumentation instrumentation
)
164 const char *instrumentation_string
;
166 switch (instrumentation
) {
167 case LTTNG_KERNEL_ALL
:
168 instrumentation_string
= config_event_type_all
;
170 case LTTNG_KERNEL_TRACEPOINT
:
171 instrumentation_string
= config_event_type_tracepoint
;
173 case LTTNG_KERNEL_KPROBE
:
174 instrumentation_string
= config_event_type_kprobe
;
176 case LTTNG_KERNEL_FUNCTION
:
177 instrumentation_string
= config_event_type_function
;
179 case LTTNG_KERNEL_KRETPROBE
:
180 instrumentation_string
= config_event_type_kretprobe
;
182 case LTTNG_KERNEL_NOOP
:
183 instrumentation_string
= config_event_type_noop
;
185 case LTTNG_KERNEL_SYSCALL
:
186 instrumentation_string
= config_event_type_syscall
;
189 instrumentation_string
= NULL
;
192 return instrumentation_string
;
196 const char *get_kernel_context_type_string(
197 enum lttng_kernel_context_type context_type
)
199 const char *context_type_string
;
201 switch (context_type
) {
202 case LTTNG_KERNEL_CONTEXT_PID
:
203 context_type_string
= config_event_context_pid
;
205 case LTTNG_KERNEL_CONTEXT_PROCNAME
:
206 context_type_string
= config_event_context_procname
;
208 case LTTNG_KERNEL_CONTEXT_PRIO
:
209 context_type_string
= config_event_context_prio
;
211 case LTTNG_KERNEL_CONTEXT_NICE
:
212 context_type_string
= config_event_context_nice
;
214 case LTTNG_KERNEL_CONTEXT_VPID
:
215 context_type_string
= config_event_context_vpid
;
217 case LTTNG_KERNEL_CONTEXT_TID
:
218 context_type_string
= config_event_context_tid
;
220 case LTTNG_KERNEL_CONTEXT_VTID
:
221 context_type_string
= config_event_context_vtid
;
223 case LTTNG_KERNEL_CONTEXT_PPID
:
224 context_type_string
= config_event_context_ppid
;
226 case LTTNG_KERNEL_CONTEXT_VPPID
:
227 context_type_string
= config_event_context_vppid
;
229 case LTTNG_KERNEL_CONTEXT_HOSTNAME
:
230 context_type_string
= config_event_context_hostname
;
233 context_type_string
= NULL
;
236 return context_type_string
;
240 const char *get_ust_context_type_string(
241 enum lttng_ust_context_type context_type
)
243 const char *context_type_string
;
245 switch (context_type
) {
246 case LTTNG_UST_CONTEXT_PROCNAME
:
247 context_type_string
= config_event_context_procname
;
249 case LTTNG_UST_CONTEXT_VPID
:
250 context_type_string
= config_event_context_vpid
;
252 case LTTNG_UST_CONTEXT_VTID
:
253 context_type_string
= config_event_context_vtid
;
255 case LTTNG_UST_CONTEXT_IP
:
256 context_type_string
= config_event_context_ip
;
258 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
259 context_type_string
= config_event_context_pthread_id
;
261 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
262 context_type_string
= config_event_context_perf_thread_counter
;
265 context_type_string
= NULL
;
269 return context_type_string
;
273 const char *get_buffer_type_string(
274 enum lttng_buffer_type buffer_type
)
276 const char *buffer_type_string
;
278 switch (buffer_type
) {
279 case LTTNG_BUFFER_PER_PID
:
280 buffer_type_string
= config_buffer_type_per_pid
;
282 case LTTNG_BUFFER_PER_UID
:
283 buffer_type_string
= config_buffer_type_per_uid
;
285 case LTTNG_BUFFER_GLOBAL
:
286 buffer_type_string
= config_buffer_type_global
;
289 buffer_type_string
= NULL
;
292 return buffer_type_string
;
296 const char *get_loglevel_type_string(
297 enum lttng_ust_loglevel_type loglevel_type
)
299 const char *loglevel_type_string
;
301 switch (loglevel_type
) {
302 case LTTNG_UST_LOGLEVEL_ALL
:
303 loglevel_type_string
= config_loglevel_type_all
;
305 case LTTNG_UST_LOGLEVEL_RANGE
:
306 loglevel_type_string
= config_loglevel_type_range
;
308 case LTTNG_UST_LOGLEVEL_SINGLE
:
309 loglevel_type_string
= config_loglevel_type_single
;
312 loglevel_type_string
= NULL
;
315 return loglevel_type_string
;
319 int save_kernel_event(struct config_writer
*writer
,
320 struct ltt_kernel_event
*event
)
323 const char *instrumentation_type
;
325 ret
= config_writer_open_element(writer
, config_element_event
);
327 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
331 if (event
->event
->name
[0]) {
332 ret
= config_writer_write_element_string(writer
,
333 config_element_name
, event
->event
->name
);
335 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
340 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
343 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
347 instrumentation_type
= get_kernel_instrumentation_string(
348 event
->event
->instrumentation
);
349 if (!instrumentation_type
) {
350 ret
= LTTNG_ERR_INVALID
;
354 ret
= config_writer_write_element_string(writer
, config_element_type
,
355 instrumentation_type
);
357 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
361 if (event
->event
->instrumentation
== LTTNG_KERNEL_FUNCTION
||
362 event
->event
->instrumentation
== LTTNG_KERNEL_KPROBE
||
363 event
->event
->instrumentation
== LTTNG_KERNEL_KRETPROBE
) {
365 ret
= config_writer_open_element(writer
,
366 config_element_attributes
);
368 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
372 switch (event
->event
->instrumentation
) {
373 case LTTNG_KERNEL_FUNCTION
:
374 ret
= config_writer_open_element(writer
,
375 config_element_function_attributes
);
377 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
381 ret
= config_writer_write_element_string(writer
,
383 event
->event
->u
.ftrace
.symbol_name
);
385 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
389 /* /function attributes */
390 ret
= config_writer_close_element(writer
);
392 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
396 case LTTNG_KERNEL_KPROBE
:
397 case LTTNG_KERNEL_KRETPROBE
:
399 const char *symbol_name
;
403 if (event
->event
->instrumentation
==
404 LTTNG_KERNEL_KPROBE
) {
406 * Comments in lttng-kernel.h mention that
407 * either addr or symbol_name are set, not both.
409 addr
= event
->event
->u
.kprobe
.addr
;
410 offset
= event
->event
->u
.kprobe
.offset
;
411 symbol_name
= addr
? NULL
:
412 event
->event
->u
.kprobe
.symbol_name
;
415 event
->event
->u
.kretprobe
.symbol_name
;
416 addr
= event
->event
->u
.kretprobe
.addr
;
417 offset
= event
->event
->u
.kretprobe
.offset
;
420 ret
= config_writer_open_element(writer
,
421 config_element_probe_attributes
);
423 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
428 ret
= config_writer_write_element_string(writer
,
429 config_element_symbol_name
,
432 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
438 ret
= config_writer_write_element_unsigned_int(
439 writer
, config_element_address
, addr
);
441 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
447 ret
= config_writer_write_element_unsigned_int(
448 writer
, config_element_offset
, offset
);
450 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
455 ret
= config_writer_close_element(writer
);
457 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
463 ERR("Unsupported kernel instrumentation type.");
464 ret
= LTTNG_ERR_INVALID
;
469 ret
= config_writer_close_element(writer
);
471 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
477 ret
= config_writer_close_element(writer
);
479 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
487 int save_kernel_events(struct config_writer
*writer
,
488 struct ltt_kernel_event_list
*event_list
)
491 struct ltt_kernel_event
*event
;
493 ret
= config_writer_open_element(writer
, config_element_events
);
495 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
499 cds_list_for_each_entry(event
, &event_list
->head
, list
) {
500 ret
= save_kernel_event(writer
, event
);
507 ret
= config_writer_close_element(writer
);
509 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
517 int save_ust_event(struct config_writer
*writer
,
518 struct ltt_ust_event
*event
)
521 const char *loglevel_type_string
;
523 ret
= config_writer_open_element(writer
, config_element_event
);
525 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
529 if (event
->attr
.name
[0]) {
530 ret
= config_writer_write_element_string(writer
,
531 config_element_name
, event
->attr
.name
);
533 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
538 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
541 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
545 if (event
->attr
.instrumentation
!= LTTNG_UST_TRACEPOINT
) {
546 ERR("Unsupported UST instrumentation type.");
547 ret
= LTTNG_ERR_INVALID
;
550 ret
= config_writer_write_element_string(writer
, config_element_type
,
551 config_event_type_tracepoint
);
553 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
557 loglevel_type_string
= get_loglevel_type_string(
558 event
->attr
.loglevel_type
);
559 if (!loglevel_type_string
) {
560 ERR("Unsupported UST loglevel type.");
561 ret
= LTTNG_ERR_INVALID
;
565 ret
= config_writer_write_element_string(writer
,
566 config_element_loglevel_type
, loglevel_type_string
);
568 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
572 ret
= config_writer_write_element_signed_int(writer
,
573 config_element_loglevel
, event
->attr
.loglevel
);
575 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
579 if (event
->filter_expression
) {
580 ret
= config_writer_write_element_string(writer
,
581 config_element_filter
, event
->filter_expression
);
583 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
588 if (event
->exclusion
&& event
->exclusion
->count
) {
591 ret
= config_writer_open_element(writer
,
592 config_element_exclusions
);
594 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
598 for (i
= 0; i
< event
->exclusion
->count
; i
++) {
599 ret
= config_writer_write_element_string(writer
,
600 config_element_exclusion
,
601 &event
->exclusion
->names
[0][i
]);
603 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
609 ret
= config_writer_close_element(writer
);
611 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
617 ret
= config_writer_close_element(writer
);
619 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
627 int save_ust_events(struct config_writer
*writer
,
628 struct lttng_ht
*events
)
631 struct ltt_ust_event
*event
;
632 struct lttng_ht_node_str
*node
;
633 struct lttng_ht_iter iter
;
635 ret
= config_writer_open_element(writer
, config_element_events
);
637 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
642 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
643 event
= caa_container_of(node
, struct ltt_ust_event
, node
);
645 ret
= save_ust_event(writer
, event
);
654 ret
= config_writer_close_element(writer
);
656 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
664 int save_kernel_context(struct config_writer
*writer
,
665 struct lttng_kernel_context
*ctx
)
673 ret
= config_writer_open_element(writer
, config_element_contexts
);
675 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
679 ret
= config_writer_open_element(writer
, config_element_context
);
681 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
685 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
686 ret
= config_writer_open_element(writer
, config_element_perf
);
688 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
692 ret
= config_writer_write_element_unsigned_int(writer
,
693 config_element_type
, ctx
->u
.perf_counter
.type
);
695 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
699 ret
= config_writer_write_element_unsigned_int(writer
,
700 config_element_config
, ctx
->u
.perf_counter
.config
);
702 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
706 ret
= config_writer_write_element_string(writer
,
707 config_element_name
, ctx
->u
.perf_counter
.name
);
709 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
714 ret
= config_writer_close_element(writer
);
716 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
720 const char *context_type_string
=
721 get_kernel_context_type_string(ctx
->ctx
);
723 if (!context_type_string
) {
724 ERR("Unsupported kernel context type.");
725 ret
= LTTNG_ERR_INVALID
;
729 ret
= config_writer_write_element_string(writer
,
730 config_element_type
, context_type_string
);
732 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
738 ret
= config_writer_close_element(writer
);
740 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
745 ret
= config_writer_close_element(writer
);
747 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
755 int save_ust_context(struct config_writer
*writer
,
756 struct cds_list_head
*ctx_list
)
759 struct ltt_ust_context
*ctx
;
764 ret
= config_writer_open_element(writer
, config_element_contexts
);
766 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
770 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
771 const char *context_type_string
;
773 context_type_string
= get_ust_context_type_string(ctx
->ctx
.ctx
);
774 if (!context_type_string
) {
775 ERR("Unsupported UST context type.")
776 ret
= LTTNG_ERR_INVALID
;
780 ret
= config_writer_open_element(writer
,
781 config_element_context
);
783 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
787 ret
= config_writer_write_element_string(writer
,
788 config_element_type
, context_type_string
);
790 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
795 ret
= config_writer_close_element(writer
);
797 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
803 ret
= config_writer_close_element(writer
);
805 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
813 int save_kernel_channel(struct config_writer
*writer
,
814 struct ltt_kernel_channel
*kchan
)
821 ret
= config_writer_open_element(writer
, config_element_channel
);
823 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
827 ret
= config_writer_write_element_string(writer
, config_element_name
,
828 kchan
->channel
->name
);
830 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
834 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
835 kchan
->channel
->enabled
);
837 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
841 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
846 ret
= save_kernel_events(writer
, &kchan
->events_list
);
851 ret
= save_kernel_context(writer
, kchan
->ctx
);
857 ret
= config_writer_close_element(writer
);
859 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
867 int save_ust_channel(struct config_writer
*writer
,
868 struct ltt_ust_channel
*ust_chan
,
869 struct ltt_ust_session
*session
)
877 ret
= config_writer_open_element(writer
, config_element_channel
);
879 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
883 ret
= config_writer_write_element_string(writer
, config_element_name
,
886 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
890 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
893 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
897 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
902 ret
= config_writer_write_element_unsigned_int(writer
,
903 config_element_tracefile_size
, ust_chan
->tracefile_size
);
905 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
909 ret
= config_writer_write_element_unsigned_int(writer
,
910 config_element_tracefile_count
, ust_chan
->tracefile_count
);
912 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
916 ret
= config_writer_write_element_unsigned_int(writer
,
917 config_element_live_timer_interval
,
918 session
->live_timer_interval
);
920 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
924 ret
= save_ust_events(writer
, ust_chan
->events
);
926 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
930 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
936 ret
= config_writer_close_element(writer
);
938 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
946 int save_kernel_session(struct config_writer
*writer
,
947 struct ltt_session
*session
)
950 struct ltt_kernel_channel
*kchan
;
955 ret
= config_writer_write_element_string(writer
, config_element_type
,
956 config_domain_type_kernel
);
958 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
962 ret
= config_writer_write_element_string(writer
,
963 config_element_buffer_type
, config_buffer_type_global
);
965 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
969 ret
= config_writer_open_element(writer
,
970 config_element_channels
);
972 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
976 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
978 ret
= save_kernel_channel(writer
, kchan
);
985 ret
= config_writer_close_element(writer
);
987 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
995 int save_ust_session(struct config_writer
*writer
,
996 struct ltt_session
*session
, int save_jul
)
999 struct ltt_ust_channel
*ust_chan
;
1000 const char *buffer_type_string
;
1001 struct lttng_ht_node_str
*node
;
1002 struct lttng_ht_iter iter
;
1007 ret
= config_writer_write_element_string(writer
, config_element_type
,
1008 save_jul
? config_domain_type_jul
: config_domain_type_ust
);
1010 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1014 buffer_type_string
= get_buffer_type_string(
1015 session
->ust_session
->buffer_type
);
1016 if (!buffer_type_string
) {
1017 ERR("Unsupported buffer type.");
1018 ret
= LTTNG_ERR_INVALID
;
1022 ret
= config_writer_write_element_string(writer
,
1023 config_element_buffer_type
, buffer_type_string
);
1025 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1029 ret
= config_writer_open_element(writer
, config_element_channels
);
1031 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1036 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1037 &iter
.iter
, node
, node
) {
1040 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1041 jul_channel
= !strcmp(DEFAULT_JUL_CHANNEL_NAME
, ust_chan
->name
);
1042 if (!(save_jul
^ jul_channel
)) {
1043 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1053 ret
= config_writer_close_element(writer
);
1055 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1063 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1070 if (!session
->kernel_session
&& !session
->ust_session
) {
1074 ret
= config_writer_open_element(writer
, config_element_domains
);
1076 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1081 if (session
->kernel_session
) {
1082 ret
= config_writer_open_element(writer
,
1083 config_element_domain
);
1085 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1089 ret
= save_kernel_session(writer
, session
);
1095 ret
= config_writer_close_element(writer
);
1097 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1102 if (session
->ust_session
) {
1103 ret
= config_writer_open_element(writer
,
1104 config_element_domain
);
1106 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1110 ret
= save_ust_session(writer
, session
, 0);
1116 ret
= config_writer_close_element(writer
);
1118 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1123 if (session
->ust_session
&&
1124 session
->ust_session
->domain_jul
.being_used
) {
1125 ret
= config_writer_open_element(writer
,
1126 config_element_domain
);
1128 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1132 ret
= save_ust_session(writer
, session
, 1);
1138 ret
= config_writer_close_element(writer
);
1140 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1146 ret
= config_writer_close_element(writer
);
1148 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1156 int save_consumer_output(struct config_writer
*writer
,
1157 struct consumer_output
*output
)
1164 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1166 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1170 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1173 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1177 ret
= config_writer_open_element(writer
, config_element_destination
);
1179 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1183 switch (output
->type
) {
1184 case CONSUMER_DST_LOCAL
:
1185 ret
= config_writer_write_element_string(writer
,
1186 config_element_path
, output
->dst
.trace_path
);
1188 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1192 case CONSUMER_DST_NET
:
1196 uri
= zmalloc(PATH_MAX
);
1198 ret
= LTTNG_ERR_NOMEM
;
1202 ret
= config_writer_open_element(writer
, config_element_net_output
);
1204 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1205 goto end_net_output
;
1208 if (output
->dst
.net
.control_isset
&&
1209 output
->dst
.net
.data_isset
) {
1210 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1212 ret
= LTTNG_ERR_INVALID
;
1213 goto end_net_output
;
1216 ret
= config_writer_write_element_string(writer
,
1217 config_element_control_uri
, uri
);
1219 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1220 goto end_net_output
;
1223 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1225 ret
= LTTNG_ERR_INVALID
;
1226 goto end_net_output
;
1229 ret
= config_writer_write_element_string(writer
,
1230 config_element_data_uri
, uri
);
1232 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1233 goto end_net_output
;
1242 ret
= !output
->dst
.net
.control_isset
?
1243 LTTNG_ERR_URL_CTRL_MISS
:
1244 LTTNG_ERR_URL_DATA_MISS
;
1249 ret
= config_writer_close_element(writer
);
1251 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1257 ERR("Unsupported consumer output type.");
1258 ret
= LTTNG_ERR_INVALID
;
1263 ret
= config_writer_close_element(writer
);
1265 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1269 /* /consumer_output */
1270 ret
= config_writer_close_element(writer
);
1272 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1280 int save_snapshot_outputs(struct config_writer
*writer
,
1281 struct snapshot
*snapshot
)
1284 struct lttng_ht_iter iter
;
1285 struct snapshot_output
*output
;
1290 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1292 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1297 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1299 ret
= config_writer_open_element(writer
,
1300 config_element_output
);
1302 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1306 ret
= config_writer_write_element_string(writer
,
1307 config_element_name
, output
->name
);
1309 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1313 ret
= config_writer_write_element_unsigned_int(writer
,
1314 config_element_max_size
, output
->max_size
);
1316 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1320 ret
= save_consumer_output(writer
, output
->consumer
);
1326 ret
= config_writer_close_element(writer
);
1328 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1334 /* /snapshot_outputs */
1335 ret
= config_writer_close_element(writer
);
1337 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1349 int save_session_output(struct config_writer
*writer
,
1350 struct ltt_session
*session
)
1357 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1358 (!session
->snapshot_mode
&& !session
->consumer
)) {
1359 /* Session is in no output mode */
1364 ret
= config_writer_open_element(writer
, config_element_output
);
1366 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1370 if (session
->snapshot_mode
) {
1371 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1376 if (session
->consumer
) {
1377 ret
= save_consumer_output(writer
, session
->consumer
);
1385 ret
= config_writer_close_element(writer
);
1387 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1395 * Save the given session.
1397 * Return 0 on success else a LTTNG_ERR* code.
1400 int save_session(struct ltt_session
*session
,
1401 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1404 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1405 char config_file_path
[PATH_MAX
];
1407 struct config_writer
*writer
= NULL
;
1408 size_t session_name_len
;
1409 const char *provided_path
;
1415 session_name_len
= strlen(session
->name
);
1416 memset(config_file_path
, 0, sizeof(config_file_path
));
1418 if (!session_access_ok(session
,
1419 LTTNG_SOCK_GET_UID_CRED(creds
),
1420 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1421 ret
= LTTNG_ERR_EPERM
;
1425 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1426 if (provided_path
) {
1427 DBG3("Save session in provided path %s", provided_path
);
1428 len
= strlen(provided_path
);
1429 if (len
>= sizeof(config_file_path
)) {
1430 ret
= LTTNG_ERR_SET_URL
;
1433 strncpy(config_file_path
, provided_path
, len
);
1436 char *home_dir
= utils_get_user_home_dir(
1437 LTTNG_SOCK_GET_UID_CRED(creds
));
1439 ret
= LTTNG_ERR_SET_URL
;
1443 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1444 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1447 PERROR("snprintf save session");
1448 ret
= LTTNG_ERR_SET_URL
;
1455 * Check the path fits in the config file path dst including the '/'
1456 * followed by trailing .lttng extension and the NULL terminated string.
1458 if ((len
+ session_name_len
+ 2 +
1459 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1460 > sizeof(config_file_path
)) {
1461 ret
= LTTNG_ERR_SET_URL
;
1465 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1466 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1468 ret
= LTTNG_ERR_SET_URL
;
1473 * At this point, we know that everything fits in the buffer. Validation
1474 * was done just above.
1476 config_file_path
[len
++] = '/';
1477 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1478 len
+= session_name_len
;
1479 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1480 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1481 config_file_path
[len
] = '\0';
1483 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1484 /* File exists, notify the user since the overwrite flag is off. */
1485 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1489 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1490 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1491 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1493 PERROR("Could not create configuration file");
1494 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1499 writer
= config_writer_create(fd
);
1501 ret
= LTTNG_ERR_NOMEM
;
1505 ret
= config_writer_open_element(writer
, config_element_sessions
);
1507 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1511 ret
= config_writer_open_element(writer
, config_element_session
);
1513 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1517 ret
= config_writer_write_element_string(writer
, config_element_name
,
1520 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1524 ret
= save_domains(writer
, session
);
1529 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1532 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1536 if (session
->snapshot_mode
|| session
->live_timer
) {
1537 ret
= config_writer_open_element(writer
, config_element_attributes
);
1539 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1543 if (session
->snapshot_mode
) {
1544 ret
= config_writer_write_element_bool(writer
,
1545 config_element_snapshot_mode
, 1);
1547 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1551 ret
= config_writer_write_element_signed_int(writer
,
1552 config_element_live_timer_interval
, session
->live_timer
);
1554 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1560 ret
= config_writer_close_element(writer
);
1562 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1567 ret
= save_session_output(writer
, session
);
1573 ret
= config_writer_close_element(writer
);
1575 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1580 ret
= config_writer_close_element(writer
);
1582 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1586 if (writer
&& config_writer_destroy(writer
)) {
1587 /* Preserve the original error code */
1588 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
1591 /* Delete file in case of error */
1592 if (file_opened
&& unlink(config_file_path
)) {
1593 PERROR("Unlinking XML session configuration.");
1600 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
1601 lttng_sock_cred
*creds
)
1604 const char *session_name
;
1605 struct ltt_session
*session
;
1607 session_lock_list();
1609 session_name
= lttng_save_session_attr_get_session_name(attr
);
1611 session
= session_find_by_name(session_name
);
1613 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1617 session_lock(session
);
1618 ret
= save_session(session
, attr
, creds
);
1619 session_unlock(session
);
1624 struct ltt_session_list
*list
= session_get_list();
1626 cds_list_for_each_entry(session
, &list
->head
, list
) {
1627 session_lock(session
);
1628 ret
= save_session(session
, attr
, creds
);
1629 session_unlock(session
);
1631 /* Don't abort if we don't have the required permissions. */
1632 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
1640 session_unlock_list();