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"
41 int save_kernel_channel_attributes(struct config_writer
*writer
,
42 struct lttng_channel_attr
*attr
)
46 ret
= config_writer_write_element_string(writer
,
47 config_element_overwrite_mode
,
48 attr
->overwrite
? config_overwrite_mode_overwrite
:
49 config_overwrite_mode_discard
);
54 ret
= config_writer_write_element_unsigned_int(writer
,
55 config_element_subbuf_size
, attr
->subbuf_size
);
60 ret
= config_writer_write_element_unsigned_int(writer
,
61 config_element_num_subbuf
,
67 ret
= config_writer_write_element_unsigned_int(writer
,
68 config_element_switch_timer_interval
,
69 attr
->switch_timer_interval
);
74 ret
= config_writer_write_element_unsigned_int(writer
,
75 config_element_read_timer_interval
,
76 attr
->read_timer_interval
);
81 ret
= config_writer_write_element_string(writer
,
82 config_element_output_type
,
83 attr
->output
== LTTNG_EVENT_SPLICE
?
84 config_output_type_splice
: config_output_type_mmap
);
89 ret
= config_writer_write_element_unsigned_int(writer
,
90 config_element_tracefile_size
, attr
->tracefile_size
);
95 ret
= config_writer_write_element_unsigned_int(writer
,
96 config_element_tracefile_count
,
97 attr
->tracefile_count
);
102 ret
= config_writer_write_element_unsigned_int(writer
,
103 config_element_live_timer_interval
,
104 attr
->live_timer_interval
);
109 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
113 int save_ust_channel_attributes(struct config_writer
*writer
,
114 struct lttng_ust_channel_attr
*attr
)
118 ret
= config_writer_write_element_string(writer
,
119 config_element_overwrite_mode
,
120 attr
->overwrite
? config_overwrite_mode_overwrite
:
121 config_overwrite_mode_discard
);
126 ret
= config_writer_write_element_unsigned_int(writer
,
127 config_element_subbuf_size
, attr
->subbuf_size
);
132 ret
= config_writer_write_element_unsigned_int(writer
,
133 config_element_num_subbuf
,
139 ret
= config_writer_write_element_unsigned_int(writer
,
140 config_element_switch_timer_interval
,
141 attr
->switch_timer_interval
);
146 ret
= config_writer_write_element_unsigned_int(writer
,
147 config_element_read_timer_interval
,
148 attr
->read_timer_interval
);
153 ret
= config_writer_write_element_string(writer
,
154 config_element_output_type
,
155 attr
->output
== LTTNG_UST_MMAP
?
156 config_output_type_mmap
: config_output_type_splice
);
161 return ret
? LTTNG_ERR_SAVE_IO_FAIL
: 0;
165 const char *get_kernel_instrumentation_string(
166 enum lttng_kernel_instrumentation instrumentation
)
168 const char *instrumentation_string
;
170 switch (instrumentation
) {
171 case LTTNG_KERNEL_ALL
:
172 instrumentation_string
= config_event_type_all
;
174 case LTTNG_KERNEL_TRACEPOINT
:
175 instrumentation_string
= config_event_type_tracepoint
;
177 case LTTNG_KERNEL_KPROBE
:
178 instrumentation_string
= config_event_type_kprobe
;
180 case LTTNG_KERNEL_FUNCTION
:
181 instrumentation_string
= config_event_type_function
;
183 case LTTNG_KERNEL_KRETPROBE
:
184 instrumentation_string
= config_event_type_kretprobe
;
186 case LTTNG_KERNEL_NOOP
:
187 instrumentation_string
= config_event_type_noop
;
189 case LTTNG_KERNEL_SYSCALL
:
190 instrumentation_string
= config_event_type_syscall
;
193 instrumentation_string
= NULL
;
196 return instrumentation_string
;
200 const char *get_kernel_context_type_string(
201 enum lttng_kernel_context_type context_type
)
203 const char *context_type_string
;
205 switch (context_type
) {
206 case LTTNG_KERNEL_CONTEXT_PID
:
207 context_type_string
= config_event_context_pid
;
209 case LTTNG_KERNEL_CONTEXT_PROCNAME
:
210 context_type_string
= config_event_context_procname
;
212 case LTTNG_KERNEL_CONTEXT_PRIO
:
213 context_type_string
= config_event_context_prio
;
215 case LTTNG_KERNEL_CONTEXT_NICE
:
216 context_type_string
= config_event_context_nice
;
218 case LTTNG_KERNEL_CONTEXT_VPID
:
219 context_type_string
= config_event_context_vpid
;
221 case LTTNG_KERNEL_CONTEXT_TID
:
222 context_type_string
= config_event_context_tid
;
224 case LTTNG_KERNEL_CONTEXT_VTID
:
225 context_type_string
= config_event_context_vtid
;
227 case LTTNG_KERNEL_CONTEXT_PPID
:
228 context_type_string
= config_event_context_ppid
;
230 case LTTNG_KERNEL_CONTEXT_VPPID
:
231 context_type_string
= config_event_context_vppid
;
233 case LTTNG_KERNEL_CONTEXT_HOSTNAME
:
234 context_type_string
= config_event_context_hostname
;
237 context_type_string
= NULL
;
240 return context_type_string
;
244 const char *get_ust_context_type_string(
245 enum lttng_ust_context_type context_type
)
247 const char *context_type_string
;
249 switch (context_type
) {
250 case LTTNG_UST_CONTEXT_PROCNAME
:
251 context_type_string
= config_event_context_procname
;
253 case LTTNG_UST_CONTEXT_VPID
:
254 context_type_string
= config_event_context_vpid
;
256 case LTTNG_UST_CONTEXT_VTID
:
257 context_type_string
= config_event_context_vtid
;
259 case LTTNG_UST_CONTEXT_IP
:
260 context_type_string
= config_event_context_ip
;
262 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
263 context_type_string
= config_event_context_pthread_id
;
265 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
267 * Error, should not be stored in the XML, perf contexts
268 * are stored as a node of type event_perf_context_type.
271 context_type_string
= NULL
;
275 return context_type_string
;
279 const char *get_buffer_type_string(
280 enum lttng_buffer_type buffer_type
)
282 const char *buffer_type_string
;
284 switch (buffer_type
) {
285 case LTTNG_BUFFER_PER_PID
:
286 buffer_type_string
= config_buffer_type_per_pid
;
288 case LTTNG_BUFFER_PER_UID
:
289 buffer_type_string
= config_buffer_type_per_uid
;
291 case LTTNG_BUFFER_GLOBAL
:
292 buffer_type_string
= config_buffer_type_global
;
295 buffer_type_string
= NULL
;
298 return buffer_type_string
;
302 const char *get_loglevel_type_string(
303 enum lttng_ust_loglevel_type loglevel_type
)
305 const char *loglevel_type_string
;
307 switch (loglevel_type
) {
308 case LTTNG_UST_LOGLEVEL_ALL
:
309 loglevel_type_string
= config_loglevel_type_all
;
311 case LTTNG_UST_LOGLEVEL_RANGE
:
312 loglevel_type_string
= config_loglevel_type_range
;
314 case LTTNG_UST_LOGLEVEL_SINGLE
:
315 loglevel_type_string
= config_loglevel_type_single
;
318 loglevel_type_string
= NULL
;
321 return loglevel_type_string
;
325 int save_kernel_event(struct config_writer
*writer
,
326 struct ltt_kernel_event
*event
)
329 const char *instrumentation_type
;
331 ret
= config_writer_open_element(writer
, config_element_event
);
333 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
337 if (event
->event
->name
[0]) {
338 ret
= config_writer_write_element_string(writer
,
339 config_element_name
, event
->event
->name
);
341 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
346 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
349 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
353 instrumentation_type
= get_kernel_instrumentation_string(
354 event
->event
->instrumentation
);
355 if (!instrumentation_type
) {
356 ret
= LTTNG_ERR_INVALID
;
360 ret
= config_writer_write_element_string(writer
, config_element_type
,
361 instrumentation_type
);
363 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
367 if (event
->filter_expression
) {
368 ret
= config_writer_write_element_string(writer
,
369 config_element_filter
,
370 event
->filter_expression
);
372 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
377 if (event
->event
->instrumentation
== LTTNG_KERNEL_FUNCTION
||
378 event
->event
->instrumentation
== LTTNG_KERNEL_KPROBE
||
379 event
->event
->instrumentation
== LTTNG_KERNEL_KRETPROBE
) {
381 ret
= config_writer_open_element(writer
,
382 config_element_attributes
);
384 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
388 switch (event
->event
->instrumentation
) {
389 case LTTNG_KERNEL_SYSCALL
:
390 case LTTNG_KERNEL_FUNCTION
:
391 ret
= config_writer_open_element(writer
,
392 config_element_function_attributes
);
394 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
398 ret
= config_writer_write_element_string(writer
,
400 event
->event
->u
.ftrace
.symbol_name
);
402 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
406 /* /function attributes */
407 ret
= config_writer_close_element(writer
);
409 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
413 case LTTNG_KERNEL_KPROBE
:
414 case LTTNG_KERNEL_KRETPROBE
:
416 const char *symbol_name
;
420 if (event
->event
->instrumentation
==
421 LTTNG_KERNEL_KPROBE
) {
423 * Comments in lttng-kernel.h mention that
424 * either addr or symbol_name are set, not both.
426 addr
= event
->event
->u
.kprobe
.addr
;
427 offset
= event
->event
->u
.kprobe
.offset
;
428 symbol_name
= addr
? NULL
:
429 event
->event
->u
.kprobe
.symbol_name
;
432 event
->event
->u
.kretprobe
.symbol_name
;
433 addr
= event
->event
->u
.kretprobe
.addr
;
434 offset
= event
->event
->u
.kretprobe
.offset
;
437 ret
= config_writer_open_element(writer
,
438 config_element_probe_attributes
);
440 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
445 ret
= config_writer_write_element_string(writer
,
446 config_element_symbol_name
,
449 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
455 ret
= config_writer_write_element_unsigned_int(
456 writer
, config_element_address
, addr
);
458 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
464 ret
= config_writer_write_element_unsigned_int(
465 writer
, config_element_offset
, offset
);
467 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
472 ret
= config_writer_close_element(writer
);
474 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
480 ERR("Unsupported kernel instrumentation type.");
481 ret
= LTTNG_ERR_INVALID
;
486 ret
= config_writer_close_element(writer
);
488 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
494 ret
= config_writer_close_element(writer
);
496 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
504 int save_kernel_events(struct config_writer
*writer
,
505 struct ltt_kernel_channel
*kchan
)
508 struct ltt_kernel_event
*event
;
510 ret
= config_writer_open_element(writer
, config_element_events
);
512 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
516 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
517 ret
= save_kernel_event(writer
, event
);
524 ret
= config_writer_close_element(writer
);
526 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
534 int save_ust_event(struct config_writer
*writer
,
535 struct ltt_ust_event
*event
)
538 const char *loglevel_type_string
;
540 ret
= config_writer_open_element(writer
, config_element_event
);
542 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
546 if (event
->attr
.name
[0]) {
547 ret
= config_writer_write_element_string(writer
,
548 config_element_name
, event
->attr
.name
);
550 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
555 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
558 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
562 if (event
->attr
.instrumentation
!= LTTNG_UST_TRACEPOINT
) {
563 ERR("Unsupported UST instrumentation type.");
564 ret
= LTTNG_ERR_INVALID
;
567 ret
= config_writer_write_element_string(writer
, config_element_type
,
568 config_event_type_tracepoint
);
570 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
574 loglevel_type_string
= get_loglevel_type_string(
575 event
->attr
.loglevel_type
);
576 if (!loglevel_type_string
) {
577 ERR("Unsupported UST loglevel type.");
578 ret
= LTTNG_ERR_INVALID
;
582 ret
= config_writer_write_element_string(writer
,
583 config_element_loglevel_type
, loglevel_type_string
);
585 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
589 /* The log level is irrelevant if no "filtering" is enabled */
590 if (event
->attr
.loglevel_type
!= LTTNG_UST_LOGLEVEL_ALL
) {
591 ret
= config_writer_write_element_signed_int(writer
,
592 config_element_loglevel
, event
->attr
.loglevel
);
594 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
599 if (event
->filter_expression
) {
600 ret
= config_writer_write_element_string(writer
,
601 config_element_filter
, event
->filter_expression
);
603 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
608 if (event
->exclusion
&& event
->exclusion
->count
) {
611 ret
= config_writer_open_element(writer
,
612 config_element_exclusions
);
614 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
618 for (i
= 0; i
< event
->exclusion
->count
; i
++) {
619 ret
= config_writer_write_element_string(writer
,
620 config_element_exclusion
,
621 &event
->exclusion
->names
[0][i
]);
623 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
629 ret
= config_writer_close_element(writer
);
631 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
637 ret
= config_writer_close_element(writer
);
639 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
647 int save_ust_events(struct config_writer
*writer
,
648 struct lttng_ht
*events
)
651 struct ltt_ust_event
*event
;
652 struct lttng_ht_node_str
*node
;
653 struct lttng_ht_iter iter
;
655 ret
= config_writer_open_element(writer
, config_element_events
);
657 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
662 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
663 event
= caa_container_of(node
, struct ltt_ust_event
, node
);
665 if (event
->internal
) {
666 /* Internal events must not be exposed to clients */
669 ret
= save_ust_event(writer
, event
);
678 ret
= config_writer_close_element(writer
);
680 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
688 int init_ust_event_from_agent_event(struct ltt_ust_event
*ust_event
,
689 struct agent_event
*agent_event
)
692 enum lttng_ust_loglevel_type ust_loglevel_type
;
694 ust_event
->enabled
= agent_event
->enabled
;
695 ust_event
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
696 if (lttng_strncpy(ust_event
->attr
.name
, agent_event
->name
,
697 LTTNG_SYMBOL_NAME_LEN
)) {
701 switch (agent_event
->loglevel_type
) {
702 case LTTNG_EVENT_LOGLEVEL_ALL
:
703 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
705 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
706 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
708 case LTTNG_EVENT_LOGLEVEL_RANGE
:
709 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
712 ERR("Invalid agent_event loglevel_type.");
717 ust_event
->attr
.loglevel_type
= ust_loglevel_type
;
718 ust_event
->attr
.loglevel
= agent_event
->loglevel_value
;
719 ust_event
->filter_expression
= agent_event
->filter_expression
;
720 ust_event
->exclusion
= agent_event
->exclusion
;
726 int save_agent_events(struct config_writer
*writer
,
727 struct ltt_ust_channel
*chan
,
731 struct lttng_ht_iter iter
;
732 struct lttng_ht_node_str
*node
;
734 ret
= config_writer_open_element(writer
, config_element_events
);
736 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
741 cds_lfht_for_each_entry(agent
->events
->ht
, &iter
.iter
, node
, node
) {
743 struct agent_event
*agent_event
;
744 struct ltt_ust_event fake_event
;
746 memset(&fake_event
, 0, sizeof(fake_event
));
747 agent_event
= caa_container_of(node
, struct agent_event
, node
);
750 * Initialize a fake ust event to reuse the same serialization
751 * function since UST and agent events contain the same info
752 * (and one could wonder why they don't reuse the same
755 ret
= init_ust_event_from_agent_event(&fake_event
, agent_event
);
760 ret
= save_ust_event(writer
, &fake_event
);
769 ret
= config_writer_close_element(writer
);
771 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
779 int save_kernel_context(struct config_writer
*writer
,
780 struct lttng_kernel_context
*ctx
)
788 ret
= config_writer_open_element(writer
, config_element_context
);
790 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
794 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
795 ret
= config_writer_open_element(writer
, config_element_perf
);
797 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
801 ret
= config_writer_write_element_unsigned_int(writer
,
802 config_element_type
, ctx
->u
.perf_counter
.type
);
804 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
808 ret
= config_writer_write_element_unsigned_int(writer
,
809 config_element_config
, ctx
->u
.perf_counter
.config
);
811 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
815 ret
= config_writer_write_element_string(writer
,
816 config_element_name
, ctx
->u
.perf_counter
.name
);
818 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
823 ret
= config_writer_close_element(writer
);
825 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
829 const char *context_type_string
=
830 get_kernel_context_type_string(ctx
->ctx
);
832 if (!context_type_string
) {
833 ERR("Unsupported kernel context type.");
834 ret
= LTTNG_ERR_INVALID
;
838 ret
= config_writer_write_element_string(writer
,
839 config_element_type
, context_type_string
);
841 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
847 ret
= config_writer_close_element(writer
);
849 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
858 int save_kernel_contexts(struct config_writer
*writer
,
859 struct ltt_kernel_channel
*kchan
)
862 struct ltt_kernel_context
*ctx
;
864 if (cds_list_empty(&kchan
->ctx_list
)) {
869 ret
= config_writer_open_element(writer
, config_element_contexts
);
871 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
875 cds_list_for_each_entry(ctx
, &kchan
->ctx_list
, list
) {
876 ret
= save_kernel_context(writer
, &ctx
->ctx
);
883 ret
= config_writer_close_element(writer
);
885 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
893 int save_ust_context(struct config_writer
*writer
,
894 struct cds_list_head
*ctx_list
)
897 struct ltt_ust_context
*ctx
;
902 ret
= config_writer_open_element(writer
, config_element_contexts
);
904 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
908 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
909 const char *context_type_string
;
912 ret
= config_writer_open_element(writer
,
913 config_element_context
);
915 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
919 if (ctx
->ctx
.ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
920 /* Perf contexts are saved as event_perf_context_type */
921 ret
= config_writer_open_element(writer
,
922 config_element_perf
);
924 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
928 ret
= config_writer_write_element_unsigned_int(writer
,
930 ctx
->ctx
.u
.perf_counter
.type
);
932 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
936 ret
= config_writer_write_element_unsigned_int(writer
,
937 config_element_config
,
938 ctx
->ctx
.u
.perf_counter
.config
);
940 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
944 ret
= config_writer_write_element_string(writer
,
946 ctx
->ctx
.u
.perf_counter
.name
);
948 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
953 ret
= config_writer_close_element(writer
);
955 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
959 /* Save context as event_context_type_type */
960 context_type_string
= get_ust_context_type_string(
962 if (!context_type_string
) {
963 ERR("Unsupported UST context type.")
964 ret
= LTTNG_ERR_INVALID
;
968 ret
= config_writer_write_element_string(writer
,
969 config_element_type
, context_type_string
);
971 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
977 ret
= config_writer_close_element(writer
);
979 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
985 ret
= config_writer_close_element(writer
);
987 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
995 int save_kernel_channel(struct config_writer
*writer
,
996 struct ltt_kernel_channel
*kchan
)
1003 ret
= config_writer_open_element(writer
, config_element_channel
);
1005 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1009 ret
= config_writer_write_element_string(writer
, config_element_name
,
1010 kchan
->channel
->name
);
1012 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1016 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1017 kchan
->channel
->enabled
);
1019 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1023 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
1028 ret
= save_kernel_events(writer
, kchan
);
1033 ret
= save_kernel_contexts(writer
, kchan
);
1039 ret
= config_writer_close_element(writer
);
1041 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1049 int save_ust_channel(struct config_writer
*writer
,
1050 struct ltt_ust_channel
*ust_chan
,
1051 struct ltt_ust_session
*session
)
1059 ret
= config_writer_open_element(writer
, config_element_channel
);
1061 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1065 ret
= config_writer_write_element_string(writer
, config_element_name
,
1068 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1072 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1075 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1079 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
1084 ret
= config_writer_write_element_unsigned_int(writer
,
1085 config_element_tracefile_size
, ust_chan
->tracefile_size
);
1087 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1091 ret
= config_writer_write_element_unsigned_int(writer
,
1092 config_element_tracefile_count
, ust_chan
->tracefile_count
);
1094 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1098 ret
= config_writer_write_element_unsigned_int(writer
,
1099 config_element_live_timer_interval
,
1100 session
->live_timer_interval
);
1102 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1106 if (ust_chan
->domain
== LTTNG_DOMAIN_UST
) {
1107 ret
= save_ust_events(writer
, ust_chan
->events
);
1112 struct agent
*agent
= NULL
;
1114 agent
= trace_ust_find_agent(session
, ust_chan
->domain
);
1116 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1117 ERR("Could not find agent associated to UST subdomain");
1122 * Channels associated with a UST sub-domain (such as JUL, Log4j
1123 * or Python) don't have any non-internal events. We retrieve
1124 * the "agent" events associated with this channel and serialize
1127 ret
= save_agent_events(writer
, ust_chan
, agent
);
1133 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1139 ret
= config_writer_close_element(writer
);
1141 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1149 int save_kernel_session(struct config_writer
*writer
,
1150 struct ltt_session
*session
)
1153 struct ltt_kernel_channel
*kchan
;
1158 ret
= config_writer_write_element_string(writer
, config_element_type
,
1159 config_domain_type_kernel
);
1161 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1165 ret
= config_writer_write_element_string(writer
,
1166 config_element_buffer_type
, config_buffer_type_global
);
1168 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1172 ret
= config_writer_open_element(writer
,
1173 config_element_channels
);
1175 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1179 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1181 ret
= save_kernel_channel(writer
, kchan
);
1188 ret
= config_writer_close_element(writer
);
1190 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1198 const char *get_config_domain_str(enum lttng_domain_type domain
)
1200 const char *str_dom
;
1203 case LTTNG_DOMAIN_KERNEL
:
1204 str_dom
= config_domain_type_kernel
;
1206 case LTTNG_DOMAIN_UST
:
1207 str_dom
= config_domain_type_ust
;
1209 case LTTNG_DOMAIN_JUL
:
1210 str_dom
= config_domain_type_jul
;
1212 case LTTNG_DOMAIN_LOG4J
:
1213 str_dom
= config_domain_type_log4j
;
1215 case LTTNG_DOMAIN_PYTHON
:
1216 str_dom
= config_domain_type_python
;
1226 int save_pid_tracker(struct config_writer
*writer
,
1227 struct ltt_session
*sess
, int domain
)
1230 ssize_t nr_pids
= 0, i
;
1231 int32_t *pids
= NULL
;
1234 case LTTNG_DOMAIN_KERNEL
:
1236 nr_pids
= kernel_list_tracker_pids(sess
->kernel_session
, &pids
);
1238 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1243 case LTTNG_DOMAIN_UST
:
1245 nr_pids
= trace_ust_list_tracker_pids(sess
->ust_session
, &pids
);
1247 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1252 case LTTNG_DOMAIN_JUL
:
1253 case LTTNG_DOMAIN_LOG4J
:
1254 case LTTNG_DOMAIN_PYTHON
:
1256 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1260 /* Only create a pid_tracker if enabled or untrack all */
1261 if (nr_pids
!= 1 || (nr_pids
== 1 && pids
[0] != -1)) {
1262 ret
= config_writer_open_element(writer
,
1263 config_element_pid_tracker
);
1265 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1269 ret
= config_writer_open_element(writer
,
1270 config_element_targets
);
1272 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1276 for (i
= 0; i
< nr_pids
; i
++) {
1277 ret
= config_writer_open_element(writer
,
1278 config_element_target_pid
);
1280 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1284 ret
= config_writer_write_element_unsigned_int(writer
,
1285 config_element_pid
, pids
[i
]);
1287 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1292 ret
= config_writer_close_element(writer
);
1294 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1300 ret
= config_writer_close_element(writer
);
1302 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1307 ret
= config_writer_close_element(writer
);
1309 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1319 int save_ust_domain(struct config_writer
*writer
,
1320 struct ltt_session
*session
, enum lttng_domain_type domain
)
1323 struct ltt_ust_channel
*ust_chan
;
1324 const char *buffer_type_string
;
1325 struct lttng_ht_node_str
*node
;
1326 struct lttng_ht_iter iter
;
1327 const char *config_domain_name
;
1332 ret
= config_writer_open_element(writer
,
1333 config_element_domain
);
1335 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1339 config_domain_name
= get_config_domain_str(domain
);
1340 if (!config_domain_name
) {
1341 ret
= LTTNG_ERR_INVALID
;
1345 ret
= config_writer_write_element_string(writer
,
1346 config_element_type
, config_domain_name
);
1348 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1352 buffer_type_string
= get_buffer_type_string(
1353 session
->ust_session
->buffer_type
);
1354 if (!buffer_type_string
) {
1355 ERR("Unsupported buffer type.");
1356 ret
= LTTNG_ERR_INVALID
;
1360 ret
= config_writer_write_element_string(writer
,
1361 config_element_buffer_type
, buffer_type_string
);
1363 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1367 ret
= config_writer_open_element(writer
, config_element_channels
);
1369 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1374 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1375 &iter
.iter
, node
, node
) {
1376 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1377 if (domain
== ust_chan
->domain
) {
1378 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1388 ret
= config_writer_close_element(writer
);
1390 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1394 if (domain
== LTTNG_DOMAIN_UST
) {
1395 ret
= config_writer_open_element(writer
,
1396 config_element_trackers
);
1398 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1402 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_UST
);
1408 ret
= config_writer_close_element(writer
);
1415 ret
= config_writer_close_element(writer
);
1417 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1426 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1433 if (!session
->kernel_session
&& !session
->ust_session
) {
1437 ret
= config_writer_open_element(writer
, config_element_domains
);
1439 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1444 if (session
->kernel_session
) {
1445 ret
= config_writer_open_element(writer
,
1446 config_element_domain
);
1448 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1452 ret
= save_kernel_session(writer
, session
);
1457 ret
= config_writer_open_element(writer
,
1458 config_element_trackers
);
1460 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1464 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_KERNEL
);
1470 ret
= config_writer_close_element(writer
);
1472 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1476 ret
= config_writer_close_element(writer
);
1478 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1483 if (session
->ust_session
) {
1484 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_UST
);
1489 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_JUL
);
1494 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_LOG4J
);
1499 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_PYTHON
);
1505 if (session
->ust_session
) {
1509 ret
= config_writer_close_element(writer
);
1511 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1519 int save_consumer_output(struct config_writer
*writer
,
1520 struct consumer_output
*output
)
1527 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1529 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1533 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1536 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1540 ret
= config_writer_open_element(writer
, config_element_destination
);
1542 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1546 switch (output
->type
) {
1547 case CONSUMER_DST_LOCAL
:
1548 ret
= config_writer_write_element_string(writer
,
1549 config_element_path
, output
->dst
.trace_path
);
1551 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1555 case CONSUMER_DST_NET
:
1559 uri
= zmalloc(PATH_MAX
);
1561 ret
= LTTNG_ERR_NOMEM
;
1565 ret
= config_writer_open_element(writer
, config_element_net_output
);
1567 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1568 goto end_net_output
;
1571 if (output
->dst
.net
.control_isset
&&
1572 output
->dst
.net
.data_isset
) {
1573 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1575 ret
= LTTNG_ERR_INVALID
;
1576 goto end_net_output
;
1579 ret
= config_writer_write_element_string(writer
,
1580 config_element_control_uri
, uri
);
1582 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1583 goto end_net_output
;
1586 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1588 ret
= LTTNG_ERR_INVALID
;
1589 goto end_net_output
;
1592 ret
= config_writer_write_element_string(writer
,
1593 config_element_data_uri
, uri
);
1595 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1596 goto end_net_output
;
1605 ret
= !output
->dst
.net
.control_isset
?
1606 LTTNG_ERR_URL_CTRL_MISS
:
1607 LTTNG_ERR_URL_DATA_MISS
;
1612 ret
= config_writer_close_element(writer
);
1614 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1620 ERR("Unsupported consumer output type.");
1621 ret
= LTTNG_ERR_INVALID
;
1626 ret
= config_writer_close_element(writer
);
1628 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1632 /* /consumer_output */
1633 ret
= config_writer_close_element(writer
);
1635 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1643 int save_snapshot_outputs(struct config_writer
*writer
,
1644 struct snapshot
*snapshot
)
1647 struct lttng_ht_iter iter
;
1648 struct snapshot_output
*output
;
1653 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1655 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1660 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1662 ret
= config_writer_open_element(writer
,
1663 config_element_output
);
1665 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1669 ret
= config_writer_write_element_string(writer
,
1670 config_element_name
, output
->name
);
1672 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1676 ret
= config_writer_write_element_unsigned_int(writer
,
1677 config_element_max_size
, output
->max_size
);
1679 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1683 ret
= save_consumer_output(writer
, output
->consumer
);
1689 ret
= config_writer_close_element(writer
);
1691 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1697 /* /snapshot_outputs */
1698 ret
= config_writer_close_element(writer
);
1700 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1712 int save_session_output(struct config_writer
*writer
,
1713 struct ltt_session
*session
)
1720 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1721 (!session
->snapshot_mode
&& !session
->consumer
)) {
1722 /* Session is in no output mode */
1727 ret
= config_writer_open_element(writer
, config_element_output
);
1729 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1733 if (session
->snapshot_mode
) {
1734 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1739 if (session
->consumer
) {
1740 ret
= save_consumer_output(writer
, session
->consumer
);
1748 ret
= config_writer_close_element(writer
);
1750 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1758 * Save the given session.
1760 * Return 0 on success else a LTTNG_ERR* code.
1763 int save_session(struct ltt_session
*session
,
1764 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1767 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1768 char config_file_path
[PATH_MAX
];
1770 struct config_writer
*writer
= NULL
;
1771 size_t session_name_len
;
1772 const char *provided_path
;
1778 session_name_len
= strlen(session
->name
);
1779 memset(config_file_path
, 0, sizeof(config_file_path
));
1781 if (!session_access_ok(session
,
1782 LTTNG_SOCK_GET_UID_CRED(creds
),
1783 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1784 ret
= LTTNG_ERR_EPERM
;
1788 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1789 if (provided_path
) {
1790 DBG3("Save session in provided path %s", provided_path
);
1791 len
= strlen(provided_path
);
1792 if (len
>= sizeof(config_file_path
)) {
1793 ret
= LTTNG_ERR_SET_URL
;
1796 strncpy(config_file_path
, provided_path
, len
);
1799 char *home_dir
= utils_get_user_home_dir(
1800 LTTNG_SOCK_GET_UID_CRED(creds
));
1802 ret
= LTTNG_ERR_SET_URL
;
1806 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1807 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1810 PERROR("snprintf save session");
1811 ret
= LTTNG_ERR_SET_URL
;
1818 * Check the path fits in the config file path dst including the '/'
1819 * followed by trailing .lttng extension and the NULL terminated string.
1821 if ((len
+ session_name_len
+ 2 +
1822 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1823 > sizeof(config_file_path
)) {
1824 ret
= LTTNG_ERR_SET_URL
;
1828 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1829 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1831 ret
= LTTNG_ERR_SET_URL
;
1836 * At this point, we know that everything fits in the buffer. Validation
1837 * was done just above.
1839 config_file_path
[len
++] = '/';
1840 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1841 len
+= session_name_len
;
1842 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1843 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1844 config_file_path
[len
] = '\0';
1846 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1847 /* File exists, notify the user since the overwrite flag is off. */
1848 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1852 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1853 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1854 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1856 PERROR("Could not create configuration file");
1857 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1862 writer
= config_writer_create(fd
, 1);
1864 ret
= LTTNG_ERR_NOMEM
;
1868 ret
= config_writer_open_element(writer
, config_element_sessions
);
1870 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1874 ret
= config_writer_open_element(writer
, config_element_session
);
1876 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1880 ret
= config_writer_write_element_string(writer
, config_element_name
,
1883 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1887 if(session
->shm_path
[0] != '\0') {
1888 ret
= config_writer_write_element_string(writer
,
1889 config_element_shared_memory_path
,
1892 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1897 ret
= save_domains(writer
, session
);
1902 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1905 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1909 if (session
->snapshot_mode
|| session
->live_timer
) {
1910 ret
= config_writer_open_element(writer
, config_element_attributes
);
1912 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1916 if (session
->snapshot_mode
) {
1917 ret
= config_writer_write_element_bool(writer
,
1918 config_element_snapshot_mode
, 1);
1920 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1924 ret
= config_writer_write_element_unsigned_int(writer
,
1925 config_element_live_timer_interval
, session
->live_timer
);
1927 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1933 ret
= config_writer_close_element(writer
);
1935 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1940 ret
= save_session_output(writer
, session
);
1946 ret
= config_writer_close_element(writer
);
1948 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1953 ret
= config_writer_close_element(writer
);
1955 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1959 if (writer
&& config_writer_destroy(writer
)) {
1960 /* Preserve the original error code */
1961 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
1964 /* Delete file in case of error */
1965 if (file_opened
&& unlink(config_file_path
)) {
1966 PERROR("Unlinking XML session configuration.");
1973 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
1974 lttng_sock_cred
*creds
)
1977 const char *session_name
;
1978 struct ltt_session
*session
;
1980 session_lock_list();
1982 session_name
= lttng_save_session_attr_get_session_name(attr
);
1984 session
= session_find_by_name(session_name
);
1986 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1990 session_lock(session
);
1991 ret
= save_session(session
, attr
, creds
);
1992 session_unlock(session
);
1997 struct ltt_session_list
*list
= session_get_list();
1999 cds_list_for_each_entry(session
, &list
->head
, list
) {
2000 session_lock(session
);
2001 ret
= save_session(session
, attr
, creds
);
2002 session_unlock(session
);
2004 /* Don't abort if we don't have the required permissions. */
2005 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
2013 session_unlock_list();