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 ret
= save_ust_event(writer
, event
);
717 ret
= config_writer_close_element(writer
);
719 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
727 int save_kernel_context(struct config_writer
*writer
,
728 struct lttng_kernel_context
*ctx
)
736 ret
= config_writer_open_element(writer
, config_element_context
);
738 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
742 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
743 ret
= config_writer_open_element(writer
, config_element_perf
);
745 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
749 ret
= config_writer_write_element_unsigned_int(writer
,
750 config_element_type
, ctx
->u
.perf_counter
.type
);
752 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
756 ret
= config_writer_write_element_unsigned_int(writer
,
757 config_element_config
, ctx
->u
.perf_counter
.config
);
759 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
763 ret
= config_writer_write_element_string(writer
,
764 config_element_name
, ctx
->u
.perf_counter
.name
);
766 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
771 ret
= config_writer_close_element(writer
);
773 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
777 const char *context_type_string
=
778 get_kernel_context_type_string(ctx
->ctx
);
780 if (!context_type_string
) {
781 ERR("Unsupported kernel context type.");
782 ret
= LTTNG_ERR_INVALID
;
786 ret
= config_writer_write_element_string(writer
,
787 config_element_type
, context_type_string
);
789 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
795 ret
= config_writer_close_element(writer
);
797 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
806 int save_kernel_contexts(struct config_writer
*writer
,
807 struct ltt_kernel_channel
*kchan
)
810 struct ltt_kernel_context
*ctx
;
812 if (cds_list_empty(&kchan
->ctx_list
)) {
817 ret
= config_writer_open_element(writer
, config_element_contexts
);
819 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
823 cds_list_for_each_entry(ctx
, &kchan
->ctx_list
, list
) {
824 ret
= save_kernel_context(writer
, &ctx
->ctx
);
831 ret
= config_writer_close_element(writer
);
833 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
841 int save_ust_context(struct config_writer
*writer
,
842 struct cds_list_head
*ctx_list
)
845 struct ltt_ust_context
*ctx
;
850 ret
= config_writer_open_element(writer
, config_element_contexts
);
852 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
856 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
857 const char *context_type_string
;
860 ret
= config_writer_open_element(writer
,
861 config_element_context
);
863 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
867 if (ctx
->ctx
.ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
868 /* Perf contexts are saved as event_perf_context_type */
869 ret
= config_writer_open_element(writer
,
870 config_element_perf
);
872 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
876 ret
= config_writer_write_element_unsigned_int(writer
,
878 ctx
->ctx
.u
.perf_counter
.type
);
880 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
884 ret
= config_writer_write_element_unsigned_int(writer
,
885 config_element_config
,
886 ctx
->ctx
.u
.perf_counter
.config
);
888 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
892 ret
= config_writer_write_element_string(writer
,
894 ctx
->ctx
.u
.perf_counter
.name
);
896 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
901 ret
= config_writer_close_element(writer
);
903 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
907 /* Save context as event_context_type_type */
908 context_type_string
= get_ust_context_type_string(
910 if (!context_type_string
) {
911 ERR("Unsupported UST context type.")
912 ret
= LTTNG_ERR_INVALID
;
916 ret
= config_writer_write_element_string(writer
,
917 config_element_type
, context_type_string
);
919 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
925 ret
= config_writer_close_element(writer
);
927 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
933 ret
= config_writer_close_element(writer
);
935 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
943 int save_kernel_channel(struct config_writer
*writer
,
944 struct ltt_kernel_channel
*kchan
)
951 ret
= config_writer_open_element(writer
, config_element_channel
);
953 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
957 ret
= config_writer_write_element_string(writer
, config_element_name
,
958 kchan
->channel
->name
);
960 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
964 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
965 kchan
->channel
->enabled
);
967 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
971 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
976 ret
= save_kernel_events(writer
, kchan
);
981 ret
= save_kernel_contexts(writer
, kchan
);
987 ret
= config_writer_close_element(writer
);
989 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
997 int save_ust_channel(struct config_writer
*writer
,
998 struct ltt_ust_channel
*ust_chan
,
999 struct ltt_ust_session
*session
)
1007 ret
= config_writer_open_element(writer
, config_element_channel
);
1009 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1013 ret
= config_writer_write_element_string(writer
, config_element_name
,
1016 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1020 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1023 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1027 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
1032 ret
= config_writer_write_element_unsigned_int(writer
,
1033 config_element_tracefile_size
, ust_chan
->tracefile_size
);
1035 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1039 ret
= config_writer_write_element_unsigned_int(writer
,
1040 config_element_tracefile_count
, ust_chan
->tracefile_count
);
1042 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1046 ret
= config_writer_write_element_unsigned_int(writer
,
1047 config_element_live_timer_interval
,
1048 session
->live_timer_interval
);
1050 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1054 ret
= save_ust_events(writer
, ust_chan
->events
);
1056 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1060 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1066 ret
= config_writer_close_element(writer
);
1068 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1076 int save_kernel_session(struct config_writer
*writer
,
1077 struct ltt_session
*session
)
1080 struct ltt_kernel_channel
*kchan
;
1085 ret
= config_writer_write_element_string(writer
, config_element_type
,
1086 config_domain_type_kernel
);
1088 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1092 ret
= config_writer_write_element_string(writer
,
1093 config_element_buffer_type
, config_buffer_type_global
);
1095 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1099 ret
= config_writer_open_element(writer
,
1100 config_element_channels
);
1102 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1106 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1108 ret
= save_kernel_channel(writer
, kchan
);
1115 ret
= config_writer_close_element(writer
);
1117 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1125 int save_ust_session(struct config_writer
*writer
,
1126 struct ltt_session
*session
, int save_agent
)
1129 struct ltt_ust_channel
*ust_chan
;
1130 const char *buffer_type_string
;
1131 struct lttng_ht_node_str
*node
;
1132 struct lttng_ht_iter iter
;
1137 ret
= config_writer_write_element_string(writer
, config_element_type
,
1138 save_agent
? config_domain_type_jul
: config_domain_type_ust
);
1140 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1144 buffer_type_string
= get_buffer_type_string(
1145 session
->ust_session
->buffer_type
);
1146 if (!buffer_type_string
) {
1147 ERR("Unsupported buffer type.");
1148 ret
= LTTNG_ERR_INVALID
;
1152 ret
= config_writer_write_element_string(writer
,
1153 config_element_buffer_type
, buffer_type_string
);
1155 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1159 ret
= config_writer_open_element(writer
, config_element_channels
);
1161 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1166 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1167 &iter
.iter
, node
, node
) {
1170 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1171 agent_channel
= !strcmp(DEFAULT_JUL_CHANNEL_NAME
, ust_chan
->name
) ||
1172 !strcmp(DEFAULT_LOG4J_CHANNEL_NAME
, ust_chan
->name
) ||
1173 !strcmp(DEFAULT_PYTHON_CHANNEL_NAME
, ust_chan
->name
);
1174 if (!(save_agent
^ agent_channel
)) {
1175 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1185 ret
= config_writer_close_element(writer
);
1187 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1195 int save_pid_tracker(struct config_writer
*writer
,
1196 struct ltt_session
*sess
, int domain
)
1199 ssize_t nr_pids
= 0, i
;
1200 int32_t *pids
= NULL
;
1203 case LTTNG_DOMAIN_KERNEL
:
1205 nr_pids
= kernel_list_tracker_pids(sess
->kernel_session
, &pids
);
1207 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1212 case LTTNG_DOMAIN_UST
:
1214 nr_pids
= trace_ust_list_tracker_pids(sess
->ust_session
, &pids
);
1216 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1221 case LTTNG_DOMAIN_JUL
:
1222 case LTTNG_DOMAIN_LOG4J
:
1223 case LTTNG_DOMAIN_PYTHON
:
1225 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1229 /* Only create a pid_tracker if enabled or untrack all */
1230 if (nr_pids
!= 1 || (nr_pids
== 1 && pids
[0] != -1)) {
1231 ret
= config_writer_open_element(writer
,
1232 config_element_pid_tracker
);
1234 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1238 ret
= config_writer_open_element(writer
,
1239 config_element_targets
);
1241 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1245 for (i
= 0; i
< nr_pids
; i
++) {
1246 ret
= config_writer_open_element(writer
,
1247 config_element_target_pid
);
1249 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1253 ret
= config_writer_write_element_unsigned_int(writer
,
1254 config_element_pid
, pids
[i
]);
1256 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1261 ret
= config_writer_close_element(writer
);
1263 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1269 ret
= config_writer_close_element(writer
);
1271 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1276 ret
= config_writer_close_element(writer
);
1278 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1288 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1295 if (!session
->kernel_session
&& !session
->ust_session
) {
1299 ret
= config_writer_open_element(writer
, config_element_domains
);
1301 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1306 if (session
->kernel_session
) {
1307 ret
= config_writer_open_element(writer
,
1308 config_element_domain
);
1310 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1314 ret
= save_kernel_session(writer
, session
);
1319 ret
= config_writer_open_element(writer
,
1320 config_element_trackers
);
1322 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1326 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_KERNEL
);
1332 ret
= config_writer_close_element(writer
);
1334 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1338 ret
= config_writer_close_element(writer
);
1340 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1345 if (session
->ust_session
) {
1346 unsigned long agent_count
;
1348 ret
= config_writer_open_element(writer
,
1349 config_element_domain
);
1351 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1355 ret
= save_ust_session(writer
, session
, 0);
1360 ret
= config_writer_open_element(writer
,
1361 config_element_trackers
);
1363 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1367 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_UST
);
1373 ret
= config_writer_close_element(writer
);
1375 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1379 ret
= config_writer_close_element(writer
);
1381 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1387 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
;
1412 if (session
->ust_session
) {
1416 ret
= config_writer_close_element(writer
);
1418 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1426 int save_consumer_output(struct config_writer
*writer
,
1427 struct consumer_output
*output
)
1434 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1436 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1440 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1443 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1447 ret
= config_writer_open_element(writer
, config_element_destination
);
1449 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1453 switch (output
->type
) {
1454 case CONSUMER_DST_LOCAL
:
1455 ret
= config_writer_write_element_string(writer
,
1456 config_element_path
, output
->dst
.trace_path
);
1458 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1462 case CONSUMER_DST_NET
:
1466 uri
= zmalloc(PATH_MAX
);
1468 ret
= LTTNG_ERR_NOMEM
;
1472 ret
= config_writer_open_element(writer
, config_element_net_output
);
1474 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1475 goto end_net_output
;
1478 if (output
->dst
.net
.control_isset
&&
1479 output
->dst
.net
.data_isset
) {
1480 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1482 ret
= LTTNG_ERR_INVALID
;
1483 goto end_net_output
;
1486 ret
= config_writer_write_element_string(writer
,
1487 config_element_control_uri
, uri
);
1489 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1490 goto end_net_output
;
1493 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1495 ret
= LTTNG_ERR_INVALID
;
1496 goto end_net_output
;
1499 ret
= config_writer_write_element_string(writer
,
1500 config_element_data_uri
, uri
);
1502 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1503 goto end_net_output
;
1512 ret
= !output
->dst
.net
.control_isset
?
1513 LTTNG_ERR_URL_CTRL_MISS
:
1514 LTTNG_ERR_URL_DATA_MISS
;
1519 ret
= config_writer_close_element(writer
);
1521 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1527 ERR("Unsupported consumer output type.");
1528 ret
= LTTNG_ERR_INVALID
;
1533 ret
= config_writer_close_element(writer
);
1535 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1539 /* /consumer_output */
1540 ret
= config_writer_close_element(writer
);
1542 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1550 int save_snapshot_outputs(struct config_writer
*writer
,
1551 struct snapshot
*snapshot
)
1554 struct lttng_ht_iter iter
;
1555 struct snapshot_output
*output
;
1560 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1562 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1567 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1569 ret
= config_writer_open_element(writer
,
1570 config_element_output
);
1572 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1576 ret
= config_writer_write_element_string(writer
,
1577 config_element_name
, output
->name
);
1579 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1583 ret
= config_writer_write_element_unsigned_int(writer
,
1584 config_element_max_size
, output
->max_size
);
1586 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1590 ret
= save_consumer_output(writer
, output
->consumer
);
1596 ret
= config_writer_close_element(writer
);
1598 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1604 /* /snapshot_outputs */
1605 ret
= config_writer_close_element(writer
);
1607 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1619 int save_session_output(struct config_writer
*writer
,
1620 struct ltt_session
*session
)
1627 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1628 (!session
->snapshot_mode
&& !session
->consumer
)) {
1629 /* Session is in no output mode */
1634 ret
= config_writer_open_element(writer
, config_element_output
);
1636 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1640 if (session
->snapshot_mode
) {
1641 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1646 if (session
->consumer
) {
1647 ret
= save_consumer_output(writer
, session
->consumer
);
1655 ret
= config_writer_close_element(writer
);
1657 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1665 * Save the given session.
1667 * Return 0 on success else a LTTNG_ERR* code.
1670 int save_session(struct ltt_session
*session
,
1671 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1674 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1675 char config_file_path
[PATH_MAX
];
1677 struct config_writer
*writer
= NULL
;
1678 size_t session_name_len
;
1679 const char *provided_path
;
1685 session_name_len
= strlen(session
->name
);
1686 memset(config_file_path
, 0, sizeof(config_file_path
));
1688 if (!session_access_ok(session
,
1689 LTTNG_SOCK_GET_UID_CRED(creds
),
1690 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1691 ret
= LTTNG_ERR_EPERM
;
1695 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1696 if (provided_path
) {
1697 DBG3("Save session in provided path %s", provided_path
);
1698 len
= strlen(provided_path
);
1699 if (len
>= sizeof(config_file_path
)) {
1700 ret
= LTTNG_ERR_SET_URL
;
1703 strncpy(config_file_path
, provided_path
, len
);
1706 char *home_dir
= utils_get_user_home_dir(
1707 LTTNG_SOCK_GET_UID_CRED(creds
));
1709 ret
= LTTNG_ERR_SET_URL
;
1713 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1714 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1717 PERROR("snprintf save session");
1718 ret
= LTTNG_ERR_SET_URL
;
1725 * Check the path fits in the config file path dst including the '/'
1726 * followed by trailing .lttng extension and the NULL terminated string.
1728 if ((len
+ session_name_len
+ 2 +
1729 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1730 > sizeof(config_file_path
)) {
1731 ret
= LTTNG_ERR_SET_URL
;
1735 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1736 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1738 ret
= LTTNG_ERR_SET_URL
;
1743 * At this point, we know that everything fits in the buffer. Validation
1744 * was done just above.
1746 config_file_path
[len
++] = '/';
1747 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1748 len
+= session_name_len
;
1749 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1750 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1751 config_file_path
[len
] = '\0';
1753 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1754 /* File exists, notify the user since the overwrite flag is off. */
1755 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1759 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1760 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1761 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1763 PERROR("Could not create configuration file");
1764 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1769 writer
= config_writer_create(fd
, 1);
1771 ret
= LTTNG_ERR_NOMEM
;
1775 ret
= config_writer_open_element(writer
, config_element_sessions
);
1777 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1781 ret
= config_writer_open_element(writer
, config_element_session
);
1783 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1787 ret
= config_writer_write_element_string(writer
, config_element_name
,
1790 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1794 if(session
->shm_path
[0] != '\0') {
1795 ret
= config_writer_write_element_string(writer
,
1796 config_element_shared_memory_path
,
1799 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1804 ret
= save_domains(writer
, session
);
1809 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1812 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1816 if (session
->snapshot_mode
|| session
->live_timer
) {
1817 ret
= config_writer_open_element(writer
, config_element_attributes
);
1819 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1823 if (session
->snapshot_mode
) {
1824 ret
= config_writer_write_element_bool(writer
,
1825 config_element_snapshot_mode
, 1);
1827 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1831 ret
= config_writer_write_element_unsigned_int(writer
,
1832 config_element_live_timer_interval
, session
->live_timer
);
1834 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1840 ret
= config_writer_close_element(writer
);
1842 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1847 ret
= save_session_output(writer
, session
);
1853 ret
= config_writer_close_element(writer
);
1855 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1860 ret
= config_writer_close_element(writer
);
1862 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1866 if (writer
&& config_writer_destroy(writer
)) {
1867 /* Preserve the original error code */
1868 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
1871 /* Delete file in case of error */
1872 if (file_opened
&& unlink(config_file_path
)) {
1873 PERROR("Unlinking XML session configuration.");
1880 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
1881 lttng_sock_cred
*creds
)
1884 const char *session_name
;
1885 struct ltt_session
*session
;
1887 session_lock_list();
1889 session_name
= lttng_save_session_attr_get_session_name(attr
);
1891 session
= session_find_by_name(session_name
);
1893 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1897 session_lock(session
);
1898 ret
= save_session(session
, attr
, creds
);
1899 session_unlock(session
);
1904 struct ltt_session_list
*list
= session_get_list();
1906 cds_list_for_each_entry(session
, &list
->head
, list
) {
1907 session_lock(session
);
1908 ret
= save_session(session
, attr
, creds
);
1909 session_unlock(session
);
1911 /* Don't abort if we don't have the required permissions. */
1912 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
1920 session_unlock_list();