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
->filter_expression
) {
367 ret
= config_writer_write_element_string(writer
,
368 config_element_filter
,
369 event
->filter_expression
);
371 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
376 if (event
->event
->instrumentation
== LTTNG_KERNEL_FUNCTION
||
377 event
->event
->instrumentation
== LTTNG_KERNEL_KPROBE
||
378 event
->event
->instrumentation
== LTTNG_KERNEL_KRETPROBE
) {
380 ret
= config_writer_open_element(writer
,
381 config_element_attributes
);
383 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
387 switch (event
->event
->instrumentation
) {
388 case LTTNG_KERNEL_SYSCALL
:
389 case LTTNG_KERNEL_FUNCTION
:
390 ret
= config_writer_open_element(writer
,
391 config_element_function_attributes
);
393 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
397 ret
= config_writer_write_element_string(writer
,
399 event
->event
->u
.ftrace
.symbol_name
);
401 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
405 /* /function attributes */
406 ret
= config_writer_close_element(writer
);
408 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
412 case LTTNG_KERNEL_KPROBE
:
413 case LTTNG_KERNEL_KRETPROBE
:
415 const char *symbol_name
;
419 if (event
->event
->instrumentation
==
420 LTTNG_KERNEL_KPROBE
) {
422 * Comments in lttng-kernel.h mention that
423 * either addr or symbol_name are set, not both.
425 addr
= event
->event
->u
.kprobe
.addr
;
426 offset
= event
->event
->u
.kprobe
.offset
;
427 symbol_name
= addr
? NULL
:
428 event
->event
->u
.kprobe
.symbol_name
;
431 event
->event
->u
.kretprobe
.symbol_name
;
432 addr
= event
->event
->u
.kretprobe
.addr
;
433 offset
= event
->event
->u
.kretprobe
.offset
;
436 ret
= config_writer_open_element(writer
,
437 config_element_probe_attributes
);
439 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
444 ret
= config_writer_write_element_string(writer
,
445 config_element_symbol_name
,
448 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
454 ret
= config_writer_write_element_unsigned_int(
455 writer
, config_element_address
, addr
);
457 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
463 ret
= config_writer_write_element_unsigned_int(
464 writer
, config_element_offset
, offset
);
466 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
471 ret
= config_writer_close_element(writer
);
473 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
479 ERR("Unsupported kernel instrumentation type.");
480 ret
= LTTNG_ERR_INVALID
;
485 ret
= config_writer_close_element(writer
);
487 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
493 ret
= config_writer_close_element(writer
);
495 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
503 int save_kernel_syscall(struct config_writer
*writer
,
504 struct ltt_kernel_channel
*kchan
)
508 struct lttng_event
*events
= NULL
;
513 count
= syscall_list_channel(kchan
, &events
, 0);
515 /* No syscalls, just gracefully return. */
520 for (i
= 0; i
< count
; i
++) {
521 struct ltt_kernel_event
*kevent
;
523 /* Create a temporary kevent in order to save it. */
525 * TODO: struct lttng_event does not really work for a filter,
526 * but unfortunately, it is exposed as external API (and used as
527 * internal representation. Using NULL meanwhile.
529 kevent
= trace_kernel_create_event(&events
[i
],
535 /* Init list in order so the destroy call can del the node. */
536 CDS_INIT_LIST_HEAD(&kevent
->list
);
538 ret
= save_kernel_event(writer
, kevent
);
539 trace_kernel_destroy_event(kevent
);
545 /* Everything went well */
554 int save_kernel_events(struct config_writer
*writer
,
555 struct ltt_kernel_channel
*kchan
)
558 struct ltt_kernel_event
*event
;
560 ret
= config_writer_open_element(writer
, config_element_events
);
562 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
566 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
567 ret
= save_kernel_event(writer
, event
);
573 /* Save syscalls if any. */
574 ret
= save_kernel_syscall(writer
, kchan
);
580 ret
= config_writer_close_element(writer
);
582 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
590 int save_ust_event(struct config_writer
*writer
,
591 struct ltt_ust_event
*event
)
594 const char *loglevel_type_string
;
596 ret
= config_writer_open_element(writer
, config_element_event
);
598 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
602 if (event
->attr
.name
[0]) {
603 ret
= config_writer_write_element_string(writer
,
604 config_element_name
, event
->attr
.name
);
606 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
611 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
614 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
618 if (event
->attr
.instrumentation
!= LTTNG_UST_TRACEPOINT
) {
619 ERR("Unsupported UST instrumentation type.");
620 ret
= LTTNG_ERR_INVALID
;
623 ret
= config_writer_write_element_string(writer
, config_element_type
,
624 config_event_type_tracepoint
);
626 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
630 loglevel_type_string
= get_loglevel_type_string(
631 event
->attr
.loglevel_type
);
632 if (!loglevel_type_string
) {
633 ERR("Unsupported UST loglevel type.");
634 ret
= LTTNG_ERR_INVALID
;
638 ret
= config_writer_write_element_string(writer
,
639 config_element_loglevel_type
, loglevel_type_string
);
641 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
645 ret
= config_writer_write_element_signed_int(writer
,
646 config_element_loglevel
, event
->attr
.loglevel
);
648 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
652 if (event
->filter_expression
) {
653 ret
= config_writer_write_element_string(writer
,
654 config_element_filter
, event
->filter_expression
);
656 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
661 if (event
->exclusion
&& event
->exclusion
->count
) {
664 ret
= config_writer_open_element(writer
,
665 config_element_exclusions
);
667 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
671 for (i
= 0; i
< event
->exclusion
->count
; i
++) {
672 ret
= config_writer_write_element_string(writer
,
673 config_element_exclusion
,
674 &event
->exclusion
->names
[0][i
]);
676 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
682 ret
= config_writer_close_element(writer
);
684 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
690 ret
= config_writer_close_element(writer
);
692 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
700 int save_ust_events(struct config_writer
*writer
,
701 struct lttng_ht
*events
)
704 struct ltt_ust_event
*event
;
705 struct lttng_ht_node_str
*node
;
706 struct lttng_ht_iter iter
;
708 ret
= config_writer_open_element(writer
, config_element_events
);
710 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
715 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
716 event
= caa_container_of(node
, struct ltt_ust_event
, node
);
718 if (event
->internal
) {
719 /* Internal events must not be exposed to clients */
722 ret
= save_ust_event(writer
, event
);
731 ret
= config_writer_close_element(writer
);
733 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
741 int save_kernel_context(struct config_writer
*writer
,
742 struct lttng_kernel_context
*ctx
)
750 ret
= config_writer_open_element(writer
, config_element_context
);
752 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
756 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
757 ret
= config_writer_open_element(writer
, config_element_perf
);
759 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
763 ret
= config_writer_write_element_unsigned_int(writer
,
764 config_element_type
, ctx
->u
.perf_counter
.type
);
766 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
770 ret
= config_writer_write_element_unsigned_int(writer
,
771 config_element_config
, ctx
->u
.perf_counter
.config
);
773 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
777 ret
= config_writer_write_element_string(writer
,
778 config_element_name
, ctx
->u
.perf_counter
.name
);
780 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
785 ret
= config_writer_close_element(writer
);
787 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
791 const char *context_type_string
=
792 get_kernel_context_type_string(ctx
->ctx
);
794 if (!context_type_string
) {
795 ERR("Unsupported kernel context type.");
796 ret
= LTTNG_ERR_INVALID
;
800 ret
= config_writer_write_element_string(writer
,
801 config_element_type
, context_type_string
);
803 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
809 ret
= config_writer_close_element(writer
);
811 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
820 int save_kernel_contexts(struct config_writer
*writer
,
821 struct ltt_kernel_channel
*kchan
)
824 struct ltt_kernel_context
*ctx
;
826 if (cds_list_empty(&kchan
->ctx_list
)) {
831 ret
= config_writer_open_element(writer
, config_element_contexts
);
833 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
837 cds_list_for_each_entry(ctx
, &kchan
->ctx_list
, list
) {
838 ret
= save_kernel_context(writer
, &ctx
->ctx
);
845 ret
= config_writer_close_element(writer
);
847 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
855 int save_ust_context(struct config_writer
*writer
,
856 struct cds_list_head
*ctx_list
)
859 struct ltt_ust_context
*ctx
;
864 ret
= config_writer_open_element(writer
, config_element_contexts
);
866 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
870 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
871 const char *context_type_string
;
874 ret
= config_writer_open_element(writer
,
875 config_element_context
);
877 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
881 if (ctx
->ctx
.ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
882 /* Perf contexts are saved as event_perf_context_type */
883 ret
= config_writer_open_element(writer
,
884 config_element_perf
);
886 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
890 ret
= config_writer_write_element_unsigned_int(writer
,
892 ctx
->ctx
.u
.perf_counter
.type
);
894 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
898 ret
= config_writer_write_element_unsigned_int(writer
,
899 config_element_config
,
900 ctx
->ctx
.u
.perf_counter
.config
);
902 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
906 ret
= config_writer_write_element_string(writer
,
908 ctx
->ctx
.u
.perf_counter
.name
);
910 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
915 ret
= config_writer_close_element(writer
);
917 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
921 /* Save context as event_context_type_type */
922 context_type_string
= get_ust_context_type_string(
924 if (!context_type_string
) {
925 ERR("Unsupported UST context type.")
926 ret
= LTTNG_ERR_INVALID
;
930 ret
= config_writer_write_element_string(writer
,
931 config_element_type
, context_type_string
);
933 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
939 ret
= config_writer_close_element(writer
);
941 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
947 ret
= config_writer_close_element(writer
);
949 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
957 int save_kernel_channel(struct config_writer
*writer
,
958 struct ltt_kernel_channel
*kchan
)
965 ret
= config_writer_open_element(writer
, config_element_channel
);
967 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
971 ret
= config_writer_write_element_string(writer
, config_element_name
,
972 kchan
->channel
->name
);
974 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
978 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
979 kchan
->channel
->enabled
);
981 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
985 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
990 ret
= save_kernel_events(writer
, kchan
);
995 ret
= save_kernel_contexts(writer
, kchan
);
1001 ret
= config_writer_close_element(writer
);
1003 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1011 int save_ust_channel(struct config_writer
*writer
,
1012 struct ltt_ust_channel
*ust_chan
,
1013 struct ltt_ust_session
*session
)
1021 ret
= config_writer_open_element(writer
, config_element_channel
);
1023 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1027 ret
= config_writer_write_element_string(writer
, config_element_name
,
1030 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1034 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1037 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1041 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
1046 ret
= config_writer_write_element_unsigned_int(writer
,
1047 config_element_tracefile_size
, ust_chan
->tracefile_size
);
1049 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1053 ret
= config_writer_write_element_unsigned_int(writer
,
1054 config_element_tracefile_count
, ust_chan
->tracefile_count
);
1056 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1060 ret
= config_writer_write_element_unsigned_int(writer
,
1061 config_element_live_timer_interval
,
1062 session
->live_timer_interval
);
1064 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1068 ret
= save_ust_events(writer
, ust_chan
->events
);
1070 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1074 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1080 ret
= config_writer_close_element(writer
);
1082 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1090 int save_kernel_session(struct config_writer
*writer
,
1091 struct ltt_session
*session
)
1094 struct ltt_kernel_channel
*kchan
;
1099 ret
= config_writer_write_element_string(writer
, config_element_type
,
1100 config_domain_type_kernel
);
1102 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1106 ret
= config_writer_write_element_string(writer
,
1107 config_element_buffer_type
, config_buffer_type_global
);
1109 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1113 ret
= config_writer_open_element(writer
,
1114 config_element_channels
);
1116 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1120 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1122 ret
= save_kernel_channel(writer
, kchan
);
1129 ret
= config_writer_close_element(writer
);
1131 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1139 int save_ust_session(struct config_writer
*writer
,
1140 struct ltt_session
*session
, int save_agent
)
1143 struct ltt_ust_channel
*ust_chan
;
1144 const char *buffer_type_string
;
1145 struct lttng_ht_node_str
*node
;
1146 struct lttng_ht_iter iter
;
1151 ret
= config_writer_write_element_string(writer
, config_element_type
,
1152 save_agent
? config_domain_type_jul
: config_domain_type_ust
);
1154 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1158 buffer_type_string
= get_buffer_type_string(
1159 session
->ust_session
->buffer_type
);
1160 if (!buffer_type_string
) {
1161 ERR("Unsupported buffer type.");
1162 ret
= LTTNG_ERR_INVALID
;
1166 ret
= config_writer_write_element_string(writer
,
1167 config_element_buffer_type
, buffer_type_string
);
1169 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1173 ret
= config_writer_open_element(writer
, config_element_channels
);
1175 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1180 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1181 &iter
.iter
, node
, node
) {
1184 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1185 agent_channel
= !strcmp(DEFAULT_JUL_CHANNEL_NAME
, ust_chan
->name
) ||
1186 !strcmp(DEFAULT_LOG4J_CHANNEL_NAME
, ust_chan
->name
) ||
1187 !strcmp(DEFAULT_PYTHON_CHANNEL_NAME
, ust_chan
->name
);
1188 if (!(save_agent
^ agent_channel
)) {
1189 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1199 ret
= config_writer_close_element(writer
);
1201 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1209 int save_pid_tracker(struct config_writer
*writer
,
1210 struct ltt_session
*sess
, int domain
)
1213 ssize_t nr_pids
= 0, i
;
1214 int32_t *pids
= NULL
;
1217 case LTTNG_DOMAIN_KERNEL
:
1219 nr_pids
= kernel_list_tracker_pids(sess
->kernel_session
, &pids
);
1221 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1226 case LTTNG_DOMAIN_UST
:
1228 nr_pids
= trace_ust_list_tracker_pids(sess
->ust_session
, &pids
);
1230 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1235 case LTTNG_DOMAIN_JUL
:
1236 case LTTNG_DOMAIN_LOG4J
:
1237 case LTTNG_DOMAIN_PYTHON
:
1239 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1243 /* Only create a pid_tracker if enabled or untrack all */
1244 if (nr_pids
!= 1 || (nr_pids
== 1 && pids
[0] != -1)) {
1245 ret
= config_writer_open_element(writer
,
1246 config_element_pid_tracker
);
1248 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1252 ret
= config_writer_open_element(writer
,
1253 config_element_targets
);
1255 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1259 for (i
= 0; i
< nr_pids
; i
++) {
1260 ret
= config_writer_open_element(writer
,
1261 config_element_target_pid
);
1263 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1267 ret
= config_writer_write_element_unsigned_int(writer
,
1268 config_element_pid
, pids
[i
]);
1270 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1275 ret
= config_writer_close_element(writer
);
1277 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1283 ret
= config_writer_close_element(writer
);
1285 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1290 ret
= config_writer_close_element(writer
);
1292 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1302 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1309 if (!session
->kernel_session
&& !session
->ust_session
) {
1313 ret
= config_writer_open_element(writer
, config_element_domains
);
1315 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1320 if (session
->kernel_session
) {
1321 ret
= config_writer_open_element(writer
,
1322 config_element_domain
);
1324 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1328 ret
= save_kernel_session(writer
, session
);
1333 ret
= config_writer_open_element(writer
,
1334 config_element_trackers
);
1336 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1340 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_KERNEL
);
1346 ret
= config_writer_close_element(writer
);
1348 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1352 ret
= config_writer_close_element(writer
);
1354 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1359 if (session
->ust_session
) {
1360 unsigned long agent_count
;
1362 ret
= config_writer_open_element(writer
,
1363 config_element_domain
);
1365 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1369 ret
= save_ust_session(writer
, session
, 0);
1374 ret
= config_writer_open_element(writer
,
1375 config_element_trackers
);
1377 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1381 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_UST
);
1387 ret
= config_writer_close_element(writer
);
1389 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1393 ret
= config_writer_close_element(writer
);
1395 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1399 agent_count
= lttng_ht_get_count(session
->ust_session
->agents
);
1400 if (agent_count
> 0) {
1401 ret
= config_writer_open_element(writer
,
1402 config_element_domain
);
1404 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1408 ret
= save_ust_session(writer
, session
, 1);
1414 ret
= config_writer_close_element(writer
);
1416 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1423 ret
= config_writer_close_element(writer
);
1425 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1433 int save_consumer_output(struct config_writer
*writer
,
1434 struct consumer_output
*output
)
1441 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1443 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1447 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1450 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1454 ret
= config_writer_open_element(writer
, config_element_destination
);
1456 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1460 switch (output
->type
) {
1461 case CONSUMER_DST_LOCAL
:
1462 ret
= config_writer_write_element_string(writer
,
1463 config_element_path
, output
->dst
.trace_path
);
1465 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1469 case CONSUMER_DST_NET
:
1473 uri
= zmalloc(PATH_MAX
);
1475 ret
= LTTNG_ERR_NOMEM
;
1479 ret
= config_writer_open_element(writer
, config_element_net_output
);
1481 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1482 goto end_net_output
;
1485 if (output
->dst
.net
.control_isset
&&
1486 output
->dst
.net
.data_isset
) {
1487 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1489 ret
= LTTNG_ERR_INVALID
;
1490 goto end_net_output
;
1493 ret
= config_writer_write_element_string(writer
,
1494 config_element_control_uri
, uri
);
1496 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1497 goto end_net_output
;
1500 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1502 ret
= LTTNG_ERR_INVALID
;
1503 goto end_net_output
;
1506 ret
= config_writer_write_element_string(writer
,
1507 config_element_data_uri
, uri
);
1509 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1510 goto end_net_output
;
1519 ret
= !output
->dst
.net
.control_isset
?
1520 LTTNG_ERR_URL_CTRL_MISS
:
1521 LTTNG_ERR_URL_DATA_MISS
;
1526 ret
= config_writer_close_element(writer
);
1528 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1534 ERR("Unsupported consumer output type.");
1535 ret
= LTTNG_ERR_INVALID
;
1540 ret
= config_writer_close_element(writer
);
1542 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1546 /* /consumer_output */
1547 ret
= config_writer_close_element(writer
);
1549 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1557 int save_snapshot_outputs(struct config_writer
*writer
,
1558 struct snapshot
*snapshot
)
1561 struct lttng_ht_iter iter
;
1562 struct snapshot_output
*output
;
1567 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1569 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1574 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1576 ret
= config_writer_open_element(writer
,
1577 config_element_output
);
1579 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1583 ret
= config_writer_write_element_string(writer
,
1584 config_element_name
, output
->name
);
1586 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1590 ret
= config_writer_write_element_unsigned_int(writer
,
1591 config_element_max_size
, output
->max_size
);
1593 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1597 ret
= save_consumer_output(writer
, output
->consumer
);
1603 ret
= config_writer_close_element(writer
);
1605 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1611 /* /snapshot_outputs */
1612 ret
= config_writer_close_element(writer
);
1614 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1626 int save_session_output(struct config_writer
*writer
,
1627 struct ltt_session
*session
)
1634 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1635 (!session
->snapshot_mode
&& !session
->consumer
)) {
1636 /* Session is in no output mode */
1641 ret
= config_writer_open_element(writer
, config_element_output
);
1643 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1647 if (session
->snapshot_mode
) {
1648 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1653 if (session
->consumer
) {
1654 ret
= save_consumer_output(writer
, session
->consumer
);
1662 ret
= config_writer_close_element(writer
);
1664 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1672 * Save the given session.
1674 * Return 0 on success else a LTTNG_ERR* code.
1677 int save_session(struct ltt_session
*session
,
1678 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1681 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1682 char config_file_path
[PATH_MAX
];
1684 struct config_writer
*writer
= NULL
;
1685 size_t session_name_len
;
1686 const char *provided_path
;
1692 session_name_len
= strlen(session
->name
);
1693 memset(config_file_path
, 0, sizeof(config_file_path
));
1695 if (!session_access_ok(session
,
1696 LTTNG_SOCK_GET_UID_CRED(creds
),
1697 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1698 ret
= LTTNG_ERR_EPERM
;
1702 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1703 if (provided_path
) {
1704 DBG3("Save session in provided path %s", provided_path
);
1705 len
= strlen(provided_path
);
1706 if (len
>= sizeof(config_file_path
)) {
1707 ret
= LTTNG_ERR_SET_URL
;
1710 strncpy(config_file_path
, provided_path
, len
);
1713 char *home_dir
= utils_get_user_home_dir(
1714 LTTNG_SOCK_GET_UID_CRED(creds
));
1716 ret
= LTTNG_ERR_SET_URL
;
1720 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1721 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1724 PERROR("snprintf save session");
1725 ret
= LTTNG_ERR_SET_URL
;
1732 * Check the path fits in the config file path dst including the '/'
1733 * followed by trailing .lttng extension and the NULL terminated string.
1735 if ((len
+ session_name_len
+ 2 +
1736 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1737 > sizeof(config_file_path
)) {
1738 ret
= LTTNG_ERR_SET_URL
;
1742 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1743 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1745 ret
= LTTNG_ERR_SET_URL
;
1750 * At this point, we know that everything fits in the buffer. Validation
1751 * was done just above.
1753 config_file_path
[len
++] = '/';
1754 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1755 len
+= session_name_len
;
1756 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1757 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1758 config_file_path
[len
] = '\0';
1760 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1761 /* File exists, notify the user since the overwrite flag is off. */
1762 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1766 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1767 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1768 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1770 PERROR("Could not create configuration file");
1771 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1776 writer
= config_writer_create(fd
, 1);
1778 ret
= LTTNG_ERR_NOMEM
;
1782 ret
= config_writer_open_element(writer
, config_element_sessions
);
1784 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1788 ret
= config_writer_open_element(writer
, config_element_session
);
1790 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1794 ret
= config_writer_write_element_string(writer
, config_element_name
,
1797 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1801 if(session
->shm_path
[0] != '\0') {
1802 ret
= config_writer_write_element_string(writer
,
1803 config_element_shared_memory_path
,
1806 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1811 ret
= save_domains(writer
, session
);
1816 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1819 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1823 if (session
->snapshot_mode
|| session
->live_timer
) {
1824 ret
= config_writer_open_element(writer
, config_element_attributes
);
1826 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1830 if (session
->snapshot_mode
) {
1831 ret
= config_writer_write_element_bool(writer
,
1832 config_element_snapshot_mode
, 1);
1834 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1838 ret
= config_writer_write_element_unsigned_int(writer
,
1839 config_element_live_timer_interval
, session
->live_timer
);
1841 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1847 ret
= config_writer_close_element(writer
);
1849 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1854 ret
= save_session_output(writer
, session
);
1860 ret
= config_writer_close_element(writer
);
1862 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1867 ret
= config_writer_close_element(writer
);
1869 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1873 if (writer
&& config_writer_destroy(writer
)) {
1874 /* Preserve the original error code */
1875 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
1878 /* Delete file in case of error */
1879 if (file_opened
&& unlink(config_file_path
)) {
1880 PERROR("Unlinking XML session configuration.");
1887 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
1888 lttng_sock_cred
*creds
)
1891 const char *session_name
;
1892 struct ltt_session
*session
;
1894 session_lock_list();
1896 session_name
= lttng_save_session_attr_get_session_name(attr
);
1898 session
= session_find_by_name(session_name
);
1900 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1904 session_lock(session
);
1905 ret
= save_session(session
, attr
, creds
);
1906 session_unlock(session
);
1911 struct ltt_session_list
*list
= session_get_list();
1913 cds_list_for_each_entry(session
, &list
->head
, list
) {
1914 session_lock(session
);
1915 ret
= save_session(session
, attr
, creds
);
1916 session_unlock(session
);
1918 /* Don't abort if we don't have the required permissions. */
1919 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
1927 session_unlock_list();