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.
23 #include <urcu/uatomic.h>
26 #include <common/defaults.h>
27 #include <common/error.h>
28 #include <common/config/config.h>
29 #include <common/utils.h>
30 #include <common/runas.h>
31 #include <lttng/save-internal.h>
37 #include "trace-ust.h"
40 int save_kernel_channel_attributes(struct config_writer
*writer
,
41 struct lttng_channel_attr
*attr
)
45 ret
= config_writer_write_element_string(writer
,
46 config_element_overwrite_mode
,
47 attr
->overwrite
? config_overwrite_mode_overwrite
:
48 config_overwrite_mode_discard
);
53 ret
= config_writer_write_element_unsigned_int(writer
,
54 config_element_subbuf_size
, attr
->subbuf_size
);
59 ret
= config_writer_write_element_unsigned_int(writer
,
60 config_element_num_subbuf
,
66 ret
= config_writer_write_element_unsigned_int(writer
,
67 config_element_switch_timer_interval
,
68 attr
->switch_timer_interval
);
73 ret
= config_writer_write_element_unsigned_int(writer
,
74 config_element_read_timer_interval
,
75 attr
->read_timer_interval
);
80 ret
= config_writer_write_element_string(writer
,
81 config_element_output_type
,
82 attr
->output
== LTTNG_EVENT_SPLICE
?
83 config_output_type_splice
: config_output_type_mmap
);
88 ret
= config_writer_write_element_unsigned_int(writer
,
89 config_element_tracefile_size
, attr
->tracefile_size
);
94 ret
= config_writer_write_element_unsigned_int(writer
,
95 config_element_tracefile_count
,
96 attr
->tracefile_count
);
101 ret
= config_writer_write_element_unsigned_int(writer
,
102 config_element_live_timer_interval
,
103 attr
->live_timer_interval
);
108 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
112 int save_ust_channel_attributes(struct config_writer
*writer
,
113 struct lttng_ust_channel_attr
*attr
)
117 ret
= config_writer_write_element_string(writer
,
118 config_element_overwrite_mode
,
119 attr
->overwrite
? config_overwrite_mode_overwrite
:
120 config_overwrite_mode_discard
);
125 ret
= config_writer_write_element_unsigned_int(writer
,
126 config_element_subbuf_size
, attr
->subbuf_size
);
131 ret
= config_writer_write_element_unsigned_int(writer
,
132 config_element_num_subbuf
,
138 ret
= config_writer_write_element_unsigned_int(writer
,
139 config_element_switch_timer_interval
,
140 attr
->switch_timer_interval
);
145 ret
= config_writer_write_element_unsigned_int(writer
,
146 config_element_read_timer_interval
,
147 attr
->read_timer_interval
);
152 ret
= config_writer_write_element_string(writer
,
153 config_element_output_type
,
154 attr
->output
== LTTNG_UST_MMAP
?
155 config_output_type_mmap
: config_output_type_splice
);
160 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
164 const char *get_kernel_instrumentation_string(
165 enum lttng_kernel_instrumentation instrumentation
)
167 const char *instrumentation_string
;
169 switch (instrumentation
) {
170 case LTTNG_KERNEL_ALL
:
171 instrumentation_string
= config_event_type_all
;
173 case LTTNG_KERNEL_TRACEPOINT
:
174 instrumentation_string
= config_event_type_tracepoint
;
176 case LTTNG_KERNEL_KPROBE
:
177 instrumentation_string
= config_event_type_kprobe
;
179 case LTTNG_KERNEL_FUNCTION
:
180 instrumentation_string
= config_event_type_function
;
182 case LTTNG_KERNEL_KRETPROBE
:
183 instrumentation_string
= config_event_type_kretprobe
;
185 case LTTNG_KERNEL_NOOP
:
186 instrumentation_string
= config_event_type_noop
;
188 case LTTNG_KERNEL_SYSCALL
:
189 instrumentation_string
= config_event_type_syscall
;
192 instrumentation_string
= NULL
;
195 return instrumentation_string
;
199 const char *get_kernel_context_type_string(
200 enum lttng_kernel_context_type context_type
)
202 const char *context_type_string
;
204 switch (context_type
) {
205 case LTTNG_KERNEL_CONTEXT_PID
:
206 context_type_string
= config_event_context_pid
;
208 case LTTNG_KERNEL_CONTEXT_PROCNAME
:
209 context_type_string
= config_event_context_procname
;
211 case LTTNG_KERNEL_CONTEXT_PRIO
:
212 context_type_string
= config_event_context_prio
;
214 case LTTNG_KERNEL_CONTEXT_NICE
:
215 context_type_string
= config_event_context_nice
;
217 case LTTNG_KERNEL_CONTEXT_VPID
:
218 context_type_string
= config_event_context_vpid
;
220 case LTTNG_KERNEL_CONTEXT_TID
:
221 context_type_string
= config_event_context_tid
;
223 case LTTNG_KERNEL_CONTEXT_VTID
:
224 context_type_string
= config_event_context_vtid
;
226 case LTTNG_KERNEL_CONTEXT_PPID
:
227 context_type_string
= config_event_context_ppid
;
229 case LTTNG_KERNEL_CONTEXT_VPPID
:
230 context_type_string
= config_event_context_vppid
;
232 case LTTNG_KERNEL_CONTEXT_HOSTNAME
:
233 context_type_string
= config_event_context_hostname
;
236 context_type_string
= NULL
;
239 return context_type_string
;
243 const char *get_ust_context_type_string(
244 enum lttng_ust_context_type context_type
)
246 const char *context_type_string
;
248 switch (context_type
) {
249 case LTTNG_UST_CONTEXT_PROCNAME
:
250 context_type_string
= config_event_context_procname
;
252 case LTTNG_UST_CONTEXT_VPID
:
253 context_type_string
= config_event_context_vpid
;
255 case LTTNG_UST_CONTEXT_VTID
:
256 context_type_string
= config_event_context_vtid
;
258 case LTTNG_UST_CONTEXT_IP
:
259 context_type_string
= config_event_context_ip
;
261 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
262 context_type_string
= config_event_context_pthread_id
;
264 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
266 * Error, should not be stored in the XML, perf contexts
267 * are stored as a node of type event_perf_context_type.
270 context_type_string
= NULL
;
274 return context_type_string
;
278 const char *get_buffer_type_string(
279 enum lttng_buffer_type buffer_type
)
281 const char *buffer_type_string
;
283 switch (buffer_type
) {
284 case LTTNG_BUFFER_PER_PID
:
285 buffer_type_string
= config_buffer_type_per_pid
;
287 case LTTNG_BUFFER_PER_UID
:
288 buffer_type_string
= config_buffer_type_per_uid
;
290 case LTTNG_BUFFER_GLOBAL
:
291 buffer_type_string
= config_buffer_type_global
;
294 buffer_type_string
= NULL
;
297 return buffer_type_string
;
301 const char *get_loglevel_type_string(
302 enum lttng_ust_loglevel_type loglevel_type
)
304 const char *loglevel_type_string
;
306 switch (loglevel_type
) {
307 case LTTNG_UST_LOGLEVEL_ALL
:
308 loglevel_type_string
= config_loglevel_type_all
;
310 case LTTNG_UST_LOGLEVEL_RANGE
:
311 loglevel_type_string
= config_loglevel_type_range
;
313 case LTTNG_UST_LOGLEVEL_SINGLE
:
314 loglevel_type_string
= config_loglevel_type_single
;
317 loglevel_type_string
= NULL
;
320 return loglevel_type_string
;
324 int save_kernel_event(struct config_writer
*writer
,
325 struct ltt_kernel_event
*event
)
328 const char *instrumentation_type
;
330 ret
= config_writer_open_element(writer
, config_element_event
);
332 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
336 if (event
->event
->name
[0]) {
337 ret
= config_writer_write_element_string(writer
,
338 config_element_name
, event
->event
->name
);
340 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
345 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
348 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
352 instrumentation_type
= get_kernel_instrumentation_string(
353 event
->event
->instrumentation
);
354 if (!instrumentation_type
) {
355 ret
= LTTNG_ERR_INVALID
;
359 ret
= config_writer_write_element_string(writer
, config_element_type
,
360 instrumentation_type
);
362 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
366 if (event
->event
->instrumentation
== LTTNG_KERNEL_FUNCTION
||
367 event
->event
->instrumentation
== LTTNG_KERNEL_KPROBE
||
368 event
->event
->instrumentation
== LTTNG_KERNEL_KRETPROBE
) {
370 ret
= config_writer_open_element(writer
,
371 config_element_attributes
);
373 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
377 switch (event
->event
->instrumentation
) {
378 case LTTNG_KERNEL_SYSCALL
:
379 case LTTNG_KERNEL_FUNCTION
:
380 ret
= config_writer_open_element(writer
,
381 config_element_function_attributes
);
383 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
387 ret
= config_writer_write_element_string(writer
,
389 event
->event
->u
.ftrace
.symbol_name
);
391 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
395 /* /function attributes */
396 ret
= config_writer_close_element(writer
);
398 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
402 case LTTNG_KERNEL_KPROBE
:
403 case LTTNG_KERNEL_KRETPROBE
:
405 const char *symbol_name
;
409 if (event
->event
->instrumentation
==
410 LTTNG_KERNEL_KPROBE
) {
412 * Comments in lttng-kernel.h mention that
413 * either addr or symbol_name are set, not both.
415 addr
= event
->event
->u
.kprobe
.addr
;
416 offset
= event
->event
->u
.kprobe
.offset
;
417 symbol_name
= addr
? NULL
:
418 event
->event
->u
.kprobe
.symbol_name
;
421 event
->event
->u
.kretprobe
.symbol_name
;
422 addr
= event
->event
->u
.kretprobe
.addr
;
423 offset
= event
->event
->u
.kretprobe
.offset
;
426 ret
= config_writer_open_element(writer
,
427 config_element_probe_attributes
);
429 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
434 ret
= config_writer_write_element_string(writer
,
435 config_element_symbol_name
,
438 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
444 ret
= config_writer_write_element_unsigned_int(
445 writer
, config_element_address
, addr
);
447 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
453 ret
= config_writer_write_element_unsigned_int(
454 writer
, config_element_offset
, offset
);
456 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
461 ret
= config_writer_close_element(writer
);
463 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
469 ERR("Unsupported kernel instrumentation type.");
470 ret
= LTTNG_ERR_INVALID
;
475 ret
= config_writer_close_element(writer
);
477 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
483 ret
= config_writer_close_element(writer
);
485 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
493 int save_kernel_syscall(struct config_writer
*writer
,
494 struct ltt_kernel_channel
*kchan
)
498 struct lttng_event
*events
= NULL
;
503 count
= syscall_list_channel(kchan
, &events
, 0);
505 /* No syscalls, just gracefully return. */
510 for (i
= 0; i
< count
; i
++) {
511 struct ltt_kernel_event
*kevent
;
513 /* Create a temporary kevent in order to save it. */
515 * TODO: struct lttng_event does not really work for a filter,
516 * but unfortunately, it is exposed as external API (and used as
517 * internal representation. Using NULL meanwhile.
519 kevent
= trace_kernel_create_event(&events
[i
],
525 /* Init list in order so the destroy call can del the node. */
526 CDS_INIT_LIST_HEAD(&kevent
->list
);
528 ret
= save_kernel_event(writer
, kevent
);
529 trace_kernel_destroy_event(kevent
);
535 /* Everything went well */
544 int save_kernel_events(struct config_writer
*writer
,
545 struct ltt_kernel_channel
*kchan
)
548 struct ltt_kernel_event
*event
;
550 ret
= config_writer_open_element(writer
, config_element_events
);
552 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
556 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
557 ret
= save_kernel_event(writer
, event
);
563 /* Save syscalls if any. */
564 ret
= save_kernel_syscall(writer
, kchan
);
570 ret
= config_writer_close_element(writer
);
572 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
580 int save_ust_event(struct config_writer
*writer
,
581 struct ltt_ust_event
*event
)
584 const char *loglevel_type_string
;
586 ret
= config_writer_open_element(writer
, config_element_event
);
588 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
592 if (event
->attr
.name
[0]) {
593 ret
= config_writer_write_element_string(writer
,
594 config_element_name
, event
->attr
.name
);
596 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
601 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
604 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
608 if (event
->attr
.instrumentation
!= LTTNG_UST_TRACEPOINT
) {
609 ERR("Unsupported UST instrumentation type.");
610 ret
= LTTNG_ERR_INVALID
;
613 ret
= config_writer_write_element_string(writer
, config_element_type
,
614 config_event_type_tracepoint
);
616 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
620 loglevel_type_string
= get_loglevel_type_string(
621 event
->attr
.loglevel_type
);
622 if (!loglevel_type_string
) {
623 ERR("Unsupported UST loglevel type.");
624 ret
= LTTNG_ERR_INVALID
;
628 ret
= config_writer_write_element_string(writer
,
629 config_element_loglevel_type
, loglevel_type_string
);
631 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
635 ret
= config_writer_write_element_signed_int(writer
,
636 config_element_loglevel
, event
->attr
.loglevel
);
638 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
642 if (event
->filter_expression
) {
643 ret
= config_writer_write_element_string(writer
,
644 config_element_filter
, event
->filter_expression
);
646 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
651 if (event
->exclusion
&& event
->exclusion
->count
) {
654 ret
= config_writer_open_element(writer
,
655 config_element_exclusions
);
657 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
661 for (i
= 0; i
< event
->exclusion
->count
; i
++) {
662 ret
= config_writer_write_element_string(writer
,
663 config_element_exclusion
,
664 &event
->exclusion
->names
[0][i
]);
666 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
672 ret
= config_writer_close_element(writer
);
674 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
680 ret
= config_writer_close_element(writer
);
682 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
690 int save_ust_events(struct config_writer
*writer
,
691 struct lttng_ht
*events
)
694 struct ltt_ust_event
*event
;
695 struct lttng_ht_node_str
*node
;
696 struct lttng_ht_iter iter
;
698 ret
= config_writer_open_element(writer
, config_element_events
);
700 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
705 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
706 event
= caa_container_of(node
, struct ltt_ust_event
, node
);
708 if (event
->internal
) {
709 /* Internal events must not be exposed to clients */
712 ret
= save_ust_event(writer
, event
);
721 ret
= config_writer_close_element(writer
);
723 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
731 int save_kernel_context(struct config_writer
*writer
,
732 struct lttng_kernel_context
*ctx
)
740 ret
= config_writer_open_element(writer
, config_element_context
);
742 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
746 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
747 ret
= config_writer_open_element(writer
, config_element_perf
);
749 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
753 ret
= config_writer_write_element_unsigned_int(writer
,
754 config_element_type
, ctx
->u
.perf_counter
.type
);
756 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
760 ret
= config_writer_write_element_unsigned_int(writer
,
761 config_element_config
, ctx
->u
.perf_counter
.config
);
763 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
767 ret
= config_writer_write_element_string(writer
,
768 config_element_name
, ctx
->u
.perf_counter
.name
);
770 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
775 ret
= config_writer_close_element(writer
);
777 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
781 const char *context_type_string
=
782 get_kernel_context_type_string(ctx
->ctx
);
784 if (!context_type_string
) {
785 ERR("Unsupported kernel context type.");
786 ret
= LTTNG_ERR_INVALID
;
790 ret
= config_writer_write_element_string(writer
,
791 config_element_type
, context_type_string
);
793 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
799 ret
= config_writer_close_element(writer
);
801 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
810 int save_kernel_contexts(struct config_writer
*writer
,
811 struct ltt_kernel_channel
*kchan
)
814 struct ltt_kernel_context
*ctx
;
816 if (cds_list_empty(&kchan
->ctx_list
)) {
821 ret
= config_writer_open_element(writer
, config_element_contexts
);
823 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
827 cds_list_for_each_entry(ctx
, &kchan
->ctx_list
, list
) {
828 ret
= save_kernel_context(writer
, &ctx
->ctx
);
835 ret
= config_writer_close_element(writer
);
837 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
845 int save_ust_context(struct config_writer
*writer
,
846 struct cds_list_head
*ctx_list
)
849 struct ltt_ust_context
*ctx
;
854 ret
= config_writer_open_element(writer
, config_element_contexts
);
856 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
860 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
861 const char *context_type_string
;
864 ret
= config_writer_open_element(writer
,
865 config_element_context
);
867 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
871 if (ctx
->ctx
.ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
872 /* Perf contexts are saved as event_perf_context_type */
873 ret
= config_writer_open_element(writer
,
874 config_element_perf
);
876 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
880 ret
= config_writer_write_element_unsigned_int(writer
,
882 ctx
->ctx
.u
.perf_counter
.type
);
884 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
888 ret
= config_writer_write_element_unsigned_int(writer
,
889 config_element_config
,
890 ctx
->ctx
.u
.perf_counter
.config
);
892 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
896 ret
= config_writer_write_element_string(writer
,
898 ctx
->ctx
.u
.perf_counter
.name
);
900 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
905 ret
= config_writer_close_element(writer
);
907 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
911 /* Save context as event_context_type_type */
912 context_type_string
= get_ust_context_type_string(
914 if (!context_type_string
) {
915 ERR("Unsupported UST context type.")
916 ret
= LTTNG_ERR_INVALID
;
920 ret
= config_writer_write_element_string(writer
,
921 config_element_type
, context_type_string
);
923 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
929 ret
= config_writer_close_element(writer
);
931 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
937 ret
= config_writer_close_element(writer
);
939 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
947 int save_kernel_channel(struct config_writer
*writer
,
948 struct ltt_kernel_channel
*kchan
)
955 ret
= config_writer_open_element(writer
, config_element_channel
);
957 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
961 ret
= config_writer_write_element_string(writer
, config_element_name
,
962 kchan
->channel
->name
);
964 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
968 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
969 kchan
->channel
->enabled
);
971 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
975 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
980 ret
= save_kernel_events(writer
, kchan
);
985 ret
= save_kernel_contexts(writer
, kchan
);
991 ret
= config_writer_close_element(writer
);
993 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1001 int save_ust_channel(struct config_writer
*writer
,
1002 struct ltt_ust_channel
*ust_chan
,
1003 struct ltt_ust_session
*session
)
1011 ret
= config_writer_open_element(writer
, config_element_channel
);
1013 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1017 ret
= config_writer_write_element_string(writer
, config_element_name
,
1020 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1024 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1027 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1031 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
1036 ret
= config_writer_write_element_unsigned_int(writer
,
1037 config_element_tracefile_size
, ust_chan
->tracefile_size
);
1039 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1043 ret
= config_writer_write_element_unsigned_int(writer
,
1044 config_element_tracefile_count
, ust_chan
->tracefile_count
);
1046 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1050 ret
= config_writer_write_element_unsigned_int(writer
,
1051 config_element_live_timer_interval
,
1052 session
->live_timer_interval
);
1054 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1058 ret
= save_ust_events(writer
, ust_chan
->events
);
1060 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1064 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1070 ret
= config_writer_close_element(writer
);
1072 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1080 int save_kernel_session(struct config_writer
*writer
,
1081 struct ltt_session
*session
)
1084 struct ltt_kernel_channel
*kchan
;
1089 ret
= config_writer_write_element_string(writer
, config_element_type
,
1090 config_domain_type_kernel
);
1092 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1096 ret
= config_writer_write_element_string(writer
,
1097 config_element_buffer_type
, config_buffer_type_global
);
1099 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1103 ret
= config_writer_open_element(writer
,
1104 config_element_channels
);
1106 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1110 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1112 ret
= save_kernel_channel(writer
, kchan
);
1119 ret
= config_writer_close_element(writer
);
1121 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1129 int save_ust_session(struct config_writer
*writer
,
1130 struct ltt_session
*session
, int save_agent
)
1133 struct ltt_ust_channel
*ust_chan
;
1134 const char *buffer_type_string
;
1135 struct lttng_ht_node_str
*node
;
1136 struct lttng_ht_iter iter
;
1141 ret
= config_writer_write_element_string(writer
, config_element_type
,
1142 save_agent
? config_domain_type_jul
: config_domain_type_ust
);
1144 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1148 buffer_type_string
= get_buffer_type_string(
1149 session
->ust_session
->buffer_type
);
1150 if (!buffer_type_string
) {
1151 ERR("Unsupported buffer type.");
1152 ret
= LTTNG_ERR_INVALID
;
1156 ret
= config_writer_write_element_string(writer
,
1157 config_element_buffer_type
, buffer_type_string
);
1159 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1163 ret
= config_writer_open_element(writer
, config_element_channels
);
1165 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1170 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1171 &iter
.iter
, node
, node
) {
1174 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1175 agent_channel
= !strcmp(DEFAULT_JUL_CHANNEL_NAME
, ust_chan
->name
) ||
1176 !strcmp(DEFAULT_LOG4J_CHANNEL_NAME
, ust_chan
->name
) ||
1177 !strcmp(DEFAULT_PYTHON_CHANNEL_NAME
, ust_chan
->name
);
1178 if (!(save_agent
^ agent_channel
)) {
1179 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1189 ret
= config_writer_close_element(writer
);
1191 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1199 int save_pid_tracker(struct config_writer
*writer
,
1200 struct ltt_session
*sess
, int domain
)
1203 ssize_t nr_pids
= 0, i
;
1204 int32_t *pids
= NULL
;
1207 case LTTNG_DOMAIN_KERNEL
:
1209 nr_pids
= kernel_list_tracker_pids(sess
->kernel_session
, &pids
);
1211 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1216 case LTTNG_DOMAIN_UST
:
1218 nr_pids
= trace_ust_list_tracker_pids(sess
->ust_session
, &pids
);
1220 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1225 case LTTNG_DOMAIN_JUL
:
1226 case LTTNG_DOMAIN_LOG4J
:
1227 case LTTNG_DOMAIN_PYTHON
:
1229 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1233 /* Only create a pid_tracker if enabled or untrack all */
1234 if (nr_pids
!= 1 || (nr_pids
== 1 && pids
[0] != -1)) {
1235 ret
= config_writer_open_element(writer
,
1236 config_element_pid_tracker
);
1238 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1242 ret
= config_writer_open_element(writer
,
1243 config_element_targets
);
1245 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1249 for (i
= 0; i
< nr_pids
; i
++) {
1250 ret
= config_writer_open_element(writer
,
1251 config_element_target_pid
);
1253 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1257 ret
= config_writer_write_element_unsigned_int(writer
,
1258 config_element_pid
, pids
[i
]);
1260 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1265 ret
= config_writer_close_element(writer
);
1267 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1273 ret
= config_writer_close_element(writer
);
1275 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1280 ret
= config_writer_close_element(writer
);
1282 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1292 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1299 if (!session
->kernel_session
&& !session
->ust_session
) {
1303 ret
= config_writer_open_element(writer
, config_element_domains
);
1305 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1310 if (session
->kernel_session
) {
1311 ret
= config_writer_open_element(writer
,
1312 config_element_domain
);
1314 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1318 ret
= save_kernel_session(writer
, session
);
1323 ret
= config_writer_open_element(writer
,
1324 config_element_trackers
);
1326 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1330 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_KERNEL
);
1336 ret
= config_writer_close_element(writer
);
1338 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1342 ret
= config_writer_close_element(writer
);
1344 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1349 if (session
->ust_session
) {
1350 unsigned long agent_count
;
1352 ret
= config_writer_open_element(writer
,
1353 config_element_domain
);
1355 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1359 ret
= save_ust_session(writer
, session
, 0);
1364 ret
= config_writer_open_element(writer
,
1365 config_element_trackers
);
1367 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1371 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_UST
);
1377 ret
= config_writer_close_element(writer
);
1379 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1383 ret
= config_writer_close_element(writer
);
1385 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1389 agent_count
= lttng_ht_get_count(session
->ust_session
->agents
);
1390 if (agent_count
> 0) {
1391 ret
= config_writer_open_element(writer
,
1392 config_element_domain
);
1394 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1398 ret
= save_ust_session(writer
, session
, 1);
1404 ret
= config_writer_close_element(writer
);
1406 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1413 ret
= config_writer_close_element(writer
);
1415 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1423 int save_consumer_output(struct config_writer
*writer
,
1424 struct consumer_output
*output
)
1431 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1433 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1437 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1440 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1444 ret
= config_writer_open_element(writer
, config_element_destination
);
1446 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1450 switch (output
->type
) {
1451 case CONSUMER_DST_LOCAL
:
1452 ret
= config_writer_write_element_string(writer
,
1453 config_element_path
, output
->dst
.trace_path
);
1455 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1459 case CONSUMER_DST_NET
:
1463 uri
= zmalloc(PATH_MAX
);
1465 ret
= LTTNG_ERR_NOMEM
;
1469 ret
= config_writer_open_element(writer
, config_element_net_output
);
1471 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1472 goto end_net_output
;
1475 if (output
->dst
.net
.control_isset
&&
1476 output
->dst
.net
.data_isset
) {
1477 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1479 ret
= LTTNG_ERR_INVALID
;
1480 goto end_net_output
;
1483 ret
= config_writer_write_element_string(writer
,
1484 config_element_control_uri
, uri
);
1486 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1487 goto end_net_output
;
1490 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1492 ret
= LTTNG_ERR_INVALID
;
1493 goto end_net_output
;
1496 ret
= config_writer_write_element_string(writer
,
1497 config_element_data_uri
, uri
);
1499 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1500 goto end_net_output
;
1509 ret
= !output
->dst
.net
.control_isset
?
1510 LTTNG_ERR_URL_CTRL_MISS
:
1511 LTTNG_ERR_URL_DATA_MISS
;
1516 ret
= config_writer_close_element(writer
);
1518 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1524 ERR("Unsupported consumer output type.");
1525 ret
= LTTNG_ERR_INVALID
;
1530 ret
= config_writer_close_element(writer
);
1532 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1536 /* /consumer_output */
1537 ret
= config_writer_close_element(writer
);
1539 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1547 int save_snapshot_outputs(struct config_writer
*writer
,
1548 struct snapshot
*snapshot
)
1551 struct lttng_ht_iter iter
;
1552 struct snapshot_output
*output
;
1557 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1559 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1564 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1566 ret
= config_writer_open_element(writer
,
1567 config_element_output
);
1569 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1573 ret
= config_writer_write_element_string(writer
,
1574 config_element_name
, output
->name
);
1576 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1580 ret
= config_writer_write_element_unsigned_int(writer
,
1581 config_element_max_size
, output
->max_size
);
1583 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1587 ret
= save_consumer_output(writer
, output
->consumer
);
1593 ret
= config_writer_close_element(writer
);
1595 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1601 /* /snapshot_outputs */
1602 ret
= config_writer_close_element(writer
);
1604 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1616 int save_session_output(struct config_writer
*writer
,
1617 struct ltt_session
*session
)
1624 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1625 (!session
->snapshot_mode
&& !session
->consumer
)) {
1626 /* Session is in no output mode */
1631 ret
= config_writer_open_element(writer
, config_element_output
);
1633 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1637 if (session
->snapshot_mode
) {
1638 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1643 if (session
->consumer
) {
1644 ret
= save_consumer_output(writer
, session
->consumer
);
1652 ret
= config_writer_close_element(writer
);
1654 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1662 * Save the given session.
1664 * Return 0 on success else a LTTNG_ERR* code.
1667 int save_session(struct ltt_session
*session
,
1668 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1671 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1672 char config_file_path
[PATH_MAX
];
1674 struct config_writer
*writer
= NULL
;
1675 size_t session_name_len
;
1676 const char *provided_path
;
1682 session_name_len
= strlen(session
->name
);
1683 memset(config_file_path
, 0, sizeof(config_file_path
));
1685 if (!session_access_ok(session
,
1686 LTTNG_SOCK_GET_UID_CRED(creds
),
1687 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1688 ret
= LTTNG_ERR_EPERM
;
1692 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1693 if (provided_path
) {
1694 DBG3("Save session in provided path %s", provided_path
);
1695 len
= strlen(provided_path
);
1696 if (len
>= sizeof(config_file_path
)) {
1697 ret
= LTTNG_ERR_SET_URL
;
1700 strncpy(config_file_path
, provided_path
, len
);
1703 char *home_dir
= utils_get_user_home_dir(
1704 LTTNG_SOCK_GET_UID_CRED(creds
));
1706 ret
= LTTNG_ERR_SET_URL
;
1710 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1711 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1714 PERROR("snprintf save session");
1715 ret
= LTTNG_ERR_SET_URL
;
1722 * Check the path fits in the config file path dst including the '/'
1723 * followed by trailing .lttng extension and the NULL terminated string.
1725 if ((len
+ session_name_len
+ 2 +
1726 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1727 > sizeof(config_file_path
)) {
1728 ret
= LTTNG_ERR_SET_URL
;
1732 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1733 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1735 ret
= LTTNG_ERR_SET_URL
;
1740 * At this point, we know that everything fits in the buffer. Validation
1741 * was done just above.
1743 config_file_path
[len
++] = '/';
1744 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1745 len
+= session_name_len
;
1746 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1747 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1748 config_file_path
[len
] = '\0';
1750 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1751 /* File exists, notify the user since the overwrite flag is off. */
1752 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1756 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1757 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1758 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1760 PERROR("Could not create configuration file");
1761 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1766 writer
= config_writer_create(fd
, 1);
1768 ret
= LTTNG_ERR_NOMEM
;
1772 ret
= config_writer_open_element(writer
, config_element_sessions
);
1774 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1778 ret
= config_writer_open_element(writer
, config_element_session
);
1780 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1784 ret
= config_writer_write_element_string(writer
, config_element_name
,
1787 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1791 if(session
->shm_path
[0] != '\0') {
1792 ret
= config_writer_write_element_string(writer
,
1793 config_element_shared_memory_path
,
1796 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1801 ret
= save_domains(writer
, session
);
1806 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1809 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1813 if (session
->snapshot_mode
|| session
->live_timer
) {
1814 ret
= config_writer_open_element(writer
, config_element_attributes
);
1816 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1820 if (session
->snapshot_mode
) {
1821 ret
= config_writer_write_element_bool(writer
,
1822 config_element_snapshot_mode
, 1);
1824 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1828 ret
= config_writer_write_element_unsigned_int(writer
,
1829 config_element_live_timer_interval
, session
->live_timer
);
1831 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1837 ret
= config_writer_close_element(writer
);
1839 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1844 ret
= save_session_output(writer
, session
);
1850 ret
= config_writer_close_element(writer
);
1852 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1857 ret
= config_writer_close_element(writer
);
1859 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1863 if (writer
&& config_writer_destroy(writer
)) {
1864 /* Preserve the original error code */
1865 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
1868 /* Delete file in case of error */
1869 if (file_opened
&& unlink(config_file_path
)) {
1870 PERROR("Unlinking XML session configuration.");
1877 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
1878 lttng_sock_cred
*creds
)
1881 const char *session_name
;
1882 struct ltt_session
*session
;
1884 session_lock_list();
1886 session_name
= lttng_save_session_attr_get_session_name(attr
);
1888 session
= session_find_by_name(session_name
);
1890 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1894 session_lock(session
);
1895 ret
= save_session(session
, attr
, creds
);
1896 session_unlock(session
);
1901 struct ltt_session_list
*list
= session_get_list();
1903 cds_list_for_each_entry(session
, &list
->head
, list
) {
1904 session_lock(session
);
1905 ret
= save_session(session
, attr
, creds
);
1906 session_unlock(session
);
1908 /* Don't abort if we don't have the required permissions. */
1909 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
1917 session_unlock_list();