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 strncpy(ust_event
->attr
.name
, agent_event
->name
, LTTNG_SYMBOL_NAME_LEN
);
697 switch (agent_event
->loglevel_type
) {
698 case LTTNG_EVENT_LOGLEVEL_ALL
:
699 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
701 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
702 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
704 case LTTNG_EVENT_LOGLEVEL_RANGE
:
705 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
708 ERR("Invalid agent_event loglevel_type.");
713 ust_event
->attr
.loglevel_type
= ust_loglevel_type
;
714 ust_event
->attr
.loglevel
= agent_event
->loglevel_value
;
715 ust_event
->filter_expression
= agent_event
->filter_expression
;
716 ust_event
->exclusion
= agent_event
->exclusion
;
722 int save_agent_events(struct config_writer
*writer
,
723 struct ltt_ust_channel
*chan
,
727 struct lttng_ht_iter iter
;
728 struct lttng_ht_node_str
*node
;
730 ret
= config_writer_open_element(writer
, config_element_events
);
732 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
737 cds_lfht_for_each_entry(agent
->events
->ht
, &iter
.iter
, node
, node
) {
739 struct agent_event
*agent_event
;
740 struct ltt_ust_event fake_event
;
742 memset(&fake_event
, 0, sizeof(fake_event
));
743 agent_event
= caa_container_of(node
, struct agent_event
, node
);
746 * Initialize a fake ust event to reuse the same serialization
747 * function since UST and agent events contain the same info
748 * (and one could wonder why they don't reuse the same
751 ret
= init_ust_event_from_agent_event(&fake_event
, agent_event
);
756 ret
= save_ust_event(writer
, &fake_event
);
765 ret
= config_writer_close_element(writer
);
767 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
775 int save_kernel_context(struct config_writer
*writer
,
776 struct lttng_kernel_context
*ctx
)
784 ret
= config_writer_open_element(writer
, config_element_context
);
786 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
790 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
791 ret
= config_writer_open_element(writer
, config_element_perf
);
793 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
797 ret
= config_writer_write_element_unsigned_int(writer
,
798 config_element_type
, ctx
->u
.perf_counter
.type
);
800 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
804 ret
= config_writer_write_element_unsigned_int(writer
,
805 config_element_config
, ctx
->u
.perf_counter
.config
);
807 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
811 ret
= config_writer_write_element_string(writer
,
812 config_element_name
, ctx
->u
.perf_counter
.name
);
814 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
819 ret
= config_writer_close_element(writer
);
821 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
825 const char *context_type_string
=
826 get_kernel_context_type_string(ctx
->ctx
);
828 if (!context_type_string
) {
829 ERR("Unsupported kernel context type.");
830 ret
= LTTNG_ERR_INVALID
;
834 ret
= config_writer_write_element_string(writer
,
835 config_element_type
, context_type_string
);
837 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
843 ret
= config_writer_close_element(writer
);
845 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
854 int save_kernel_contexts(struct config_writer
*writer
,
855 struct ltt_kernel_channel
*kchan
)
858 struct ltt_kernel_context
*ctx
;
860 if (cds_list_empty(&kchan
->ctx_list
)) {
865 ret
= config_writer_open_element(writer
, config_element_contexts
);
867 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
871 cds_list_for_each_entry(ctx
, &kchan
->ctx_list
, list
) {
872 ret
= save_kernel_context(writer
, &ctx
->ctx
);
879 ret
= config_writer_close_element(writer
);
881 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
889 int save_ust_context(struct config_writer
*writer
,
890 struct cds_list_head
*ctx_list
)
893 struct ltt_ust_context
*ctx
;
898 ret
= config_writer_open_element(writer
, config_element_contexts
);
900 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
904 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
905 const char *context_type_string
;
908 ret
= config_writer_open_element(writer
,
909 config_element_context
);
911 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
915 if (ctx
->ctx
.ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
916 /* Perf contexts are saved as event_perf_context_type */
917 ret
= config_writer_open_element(writer
,
918 config_element_perf
);
920 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
924 ret
= config_writer_write_element_unsigned_int(writer
,
926 ctx
->ctx
.u
.perf_counter
.type
);
928 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
932 ret
= config_writer_write_element_unsigned_int(writer
,
933 config_element_config
,
934 ctx
->ctx
.u
.perf_counter
.config
);
936 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
940 ret
= config_writer_write_element_string(writer
,
942 ctx
->ctx
.u
.perf_counter
.name
);
944 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
949 ret
= config_writer_close_element(writer
);
951 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
955 /* Save context as event_context_type_type */
956 context_type_string
= get_ust_context_type_string(
958 if (!context_type_string
) {
959 ERR("Unsupported UST context type.")
960 ret
= LTTNG_ERR_INVALID
;
964 ret
= config_writer_write_element_string(writer
,
965 config_element_type
, context_type_string
);
967 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
973 ret
= config_writer_close_element(writer
);
975 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
981 ret
= config_writer_close_element(writer
);
983 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
991 int save_kernel_channel(struct config_writer
*writer
,
992 struct ltt_kernel_channel
*kchan
)
999 ret
= config_writer_open_element(writer
, config_element_channel
);
1001 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1005 ret
= config_writer_write_element_string(writer
, config_element_name
,
1006 kchan
->channel
->name
);
1008 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1012 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1013 kchan
->channel
->enabled
);
1015 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1019 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
1024 ret
= save_kernel_events(writer
, kchan
);
1029 ret
= save_kernel_contexts(writer
, kchan
);
1035 ret
= config_writer_close_element(writer
);
1037 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1045 int save_ust_channel(struct config_writer
*writer
,
1046 struct ltt_ust_channel
*ust_chan
,
1047 struct ltt_ust_session
*session
)
1055 ret
= config_writer_open_element(writer
, config_element_channel
);
1057 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1061 ret
= config_writer_write_element_string(writer
, config_element_name
,
1064 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1068 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1071 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1075 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
1080 ret
= config_writer_write_element_unsigned_int(writer
,
1081 config_element_tracefile_size
, ust_chan
->tracefile_size
);
1083 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1087 ret
= config_writer_write_element_unsigned_int(writer
,
1088 config_element_tracefile_count
, ust_chan
->tracefile_count
);
1090 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1094 ret
= config_writer_write_element_unsigned_int(writer
,
1095 config_element_live_timer_interval
,
1096 session
->live_timer_interval
);
1098 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1102 if (ust_chan
->domain
== LTTNG_DOMAIN_UST
) {
1103 ret
= save_ust_events(writer
, ust_chan
->events
);
1108 struct agent
*agent
= NULL
;
1110 agent
= trace_ust_find_agent(session
, ust_chan
->domain
);
1112 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1113 ERR("Could not find agent associated to UST subdomain");
1118 * Channels associated with a UST sub-domain (such as JUL, Log4j
1119 * or Python) don't have any non-internal events. We retrieve
1120 * the "agent" events associated with this channel and serialize
1123 ret
= save_agent_events(writer
, ust_chan
, agent
);
1129 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1135 ret
= config_writer_close_element(writer
);
1137 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1145 int save_kernel_session(struct config_writer
*writer
,
1146 struct ltt_session
*session
)
1149 struct ltt_kernel_channel
*kchan
;
1154 ret
= config_writer_write_element_string(writer
, config_element_type
,
1155 config_domain_type_kernel
);
1157 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1161 ret
= config_writer_write_element_string(writer
,
1162 config_element_buffer_type
, config_buffer_type_global
);
1164 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1168 ret
= config_writer_open_element(writer
,
1169 config_element_channels
);
1171 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1175 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1177 ret
= save_kernel_channel(writer
, kchan
);
1184 ret
= config_writer_close_element(writer
);
1186 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1194 const char *get_config_domain_str(enum lttng_domain_type domain
)
1196 const char *str_dom
;
1199 case LTTNG_DOMAIN_KERNEL
:
1200 str_dom
= config_domain_type_kernel
;
1202 case LTTNG_DOMAIN_UST
:
1203 str_dom
= config_domain_type_ust
;
1205 case LTTNG_DOMAIN_JUL
:
1206 str_dom
= config_domain_type_jul
;
1208 case LTTNG_DOMAIN_LOG4J
:
1209 str_dom
= config_domain_type_log4j
;
1211 case LTTNG_DOMAIN_PYTHON
:
1212 str_dom
= config_domain_type_python
;
1222 int save_pid_tracker(struct config_writer
*writer
,
1223 struct ltt_session
*sess
, int domain
)
1226 ssize_t nr_pids
= 0, i
;
1227 int32_t *pids
= NULL
;
1230 case LTTNG_DOMAIN_KERNEL
:
1232 nr_pids
= kernel_list_tracker_pids(sess
->kernel_session
, &pids
);
1234 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1239 case LTTNG_DOMAIN_UST
:
1241 nr_pids
= trace_ust_list_tracker_pids(sess
->ust_session
, &pids
);
1243 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1248 case LTTNG_DOMAIN_JUL
:
1249 case LTTNG_DOMAIN_LOG4J
:
1250 case LTTNG_DOMAIN_PYTHON
:
1252 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1256 /* Only create a pid_tracker if enabled or untrack all */
1257 if (nr_pids
!= 1 || (nr_pids
== 1 && pids
[0] != -1)) {
1258 ret
= config_writer_open_element(writer
,
1259 config_element_pid_tracker
);
1261 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1265 ret
= config_writer_open_element(writer
,
1266 config_element_targets
);
1268 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1272 for (i
= 0; i
< nr_pids
; i
++) {
1273 ret
= config_writer_open_element(writer
,
1274 config_element_target_pid
);
1276 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1280 ret
= config_writer_write_element_unsigned_int(writer
,
1281 config_element_pid
, pids
[i
]);
1283 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1288 ret
= config_writer_close_element(writer
);
1290 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1296 ret
= config_writer_close_element(writer
);
1298 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1303 ret
= config_writer_close_element(writer
);
1305 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1315 int save_ust_domain(struct config_writer
*writer
,
1316 struct ltt_session
*session
, enum lttng_domain_type domain
)
1319 struct ltt_ust_channel
*ust_chan
;
1320 const char *buffer_type_string
;
1321 struct lttng_ht_node_str
*node
;
1322 struct lttng_ht_iter iter
;
1323 const char *config_domain_name
;
1328 ret
= config_writer_open_element(writer
,
1329 config_element_domain
);
1331 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1335 config_domain_name
= get_config_domain_str(domain
);
1336 if (!config_domain_name
) {
1337 ret
= LTTNG_ERR_INVALID
;
1341 ret
= config_writer_write_element_string(writer
,
1342 config_element_type
, config_domain_name
);
1344 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1348 buffer_type_string
= get_buffer_type_string(
1349 session
->ust_session
->buffer_type
);
1350 if (!buffer_type_string
) {
1351 ERR("Unsupported buffer type.");
1352 ret
= LTTNG_ERR_INVALID
;
1356 ret
= config_writer_write_element_string(writer
,
1357 config_element_buffer_type
, buffer_type_string
);
1359 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1363 ret
= config_writer_open_element(writer
, config_element_channels
);
1365 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1370 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1371 &iter
.iter
, node
, node
) {
1372 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1373 if (domain
== ust_chan
->domain
) {
1374 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1384 ret
= config_writer_close_element(writer
);
1386 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1390 if (domain
== LTTNG_DOMAIN_UST
) {
1391 ret
= config_writer_open_element(writer
,
1392 config_element_trackers
);
1394 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1398 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_UST
);
1404 ret
= config_writer_close_element(writer
);
1411 ret
= config_writer_close_element(writer
);
1413 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1422 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1429 if (!session
->kernel_session
&& !session
->ust_session
) {
1433 ret
= config_writer_open_element(writer
, config_element_domains
);
1435 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1440 if (session
->kernel_session
) {
1441 ret
= config_writer_open_element(writer
,
1442 config_element_domain
);
1444 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1448 ret
= save_kernel_session(writer
, session
);
1453 ret
= config_writer_open_element(writer
,
1454 config_element_trackers
);
1456 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1460 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_KERNEL
);
1466 ret
= config_writer_close_element(writer
);
1468 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1472 ret
= config_writer_close_element(writer
);
1474 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1479 if (session
->ust_session
) {
1480 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_UST
);
1485 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_JUL
);
1490 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_LOG4J
);
1495 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_PYTHON
);
1501 if (session
->ust_session
) {
1505 ret
= config_writer_close_element(writer
);
1507 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1515 int save_consumer_output(struct config_writer
*writer
,
1516 struct consumer_output
*output
)
1523 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1525 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1529 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1532 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1536 ret
= config_writer_open_element(writer
, config_element_destination
);
1538 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1542 switch (output
->type
) {
1543 case CONSUMER_DST_LOCAL
:
1544 ret
= config_writer_write_element_string(writer
,
1545 config_element_path
, output
->dst
.trace_path
);
1547 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1551 case CONSUMER_DST_NET
:
1555 uri
= zmalloc(PATH_MAX
);
1557 ret
= LTTNG_ERR_NOMEM
;
1561 ret
= config_writer_open_element(writer
, config_element_net_output
);
1563 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1564 goto end_net_output
;
1567 if (output
->dst
.net
.control_isset
&&
1568 output
->dst
.net
.data_isset
) {
1569 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1571 ret
= LTTNG_ERR_INVALID
;
1572 goto end_net_output
;
1575 ret
= config_writer_write_element_string(writer
,
1576 config_element_control_uri
, uri
);
1578 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1579 goto end_net_output
;
1582 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1584 ret
= LTTNG_ERR_INVALID
;
1585 goto end_net_output
;
1588 ret
= config_writer_write_element_string(writer
,
1589 config_element_data_uri
, uri
);
1591 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1592 goto end_net_output
;
1601 ret
= !output
->dst
.net
.control_isset
?
1602 LTTNG_ERR_URL_CTRL_MISS
:
1603 LTTNG_ERR_URL_DATA_MISS
;
1608 ret
= config_writer_close_element(writer
);
1610 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1616 ERR("Unsupported consumer output type.");
1617 ret
= LTTNG_ERR_INVALID
;
1622 ret
= config_writer_close_element(writer
);
1624 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1628 /* /consumer_output */
1629 ret
= config_writer_close_element(writer
);
1631 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1639 int save_snapshot_outputs(struct config_writer
*writer
,
1640 struct snapshot
*snapshot
)
1643 struct lttng_ht_iter iter
;
1644 struct snapshot_output
*output
;
1649 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1651 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1656 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1658 ret
= config_writer_open_element(writer
,
1659 config_element_output
);
1661 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1665 ret
= config_writer_write_element_string(writer
,
1666 config_element_name
, output
->name
);
1668 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1672 ret
= config_writer_write_element_unsigned_int(writer
,
1673 config_element_max_size
, output
->max_size
);
1675 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1679 ret
= save_consumer_output(writer
, output
->consumer
);
1685 ret
= config_writer_close_element(writer
);
1687 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1693 /* /snapshot_outputs */
1694 ret
= config_writer_close_element(writer
);
1696 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1708 int save_session_output(struct config_writer
*writer
,
1709 struct ltt_session
*session
)
1716 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1717 (!session
->snapshot_mode
&& !session
->consumer
)) {
1718 /* Session is in no output mode */
1723 ret
= config_writer_open_element(writer
, config_element_output
);
1725 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1729 if (session
->snapshot_mode
) {
1730 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1735 if (session
->consumer
) {
1736 ret
= save_consumer_output(writer
, session
->consumer
);
1744 ret
= config_writer_close_element(writer
);
1746 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1754 * Save the given session.
1756 * Return 0 on success else a LTTNG_ERR* code.
1759 int save_session(struct ltt_session
*session
,
1760 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1763 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1764 char config_file_path
[PATH_MAX
];
1766 struct config_writer
*writer
= NULL
;
1767 size_t session_name_len
;
1768 const char *provided_path
;
1774 session_name_len
= strlen(session
->name
);
1775 memset(config_file_path
, 0, sizeof(config_file_path
));
1777 if (!session_access_ok(session
,
1778 LTTNG_SOCK_GET_UID_CRED(creds
),
1779 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1780 ret
= LTTNG_ERR_EPERM
;
1784 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1785 if (provided_path
) {
1786 DBG3("Save session in provided path %s", provided_path
);
1787 len
= strlen(provided_path
);
1788 if (len
>= sizeof(config_file_path
)) {
1789 ret
= LTTNG_ERR_SET_URL
;
1792 strncpy(config_file_path
, provided_path
, len
);
1795 char *home_dir
= utils_get_user_home_dir(
1796 LTTNG_SOCK_GET_UID_CRED(creds
));
1798 ret
= LTTNG_ERR_SET_URL
;
1802 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1803 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1806 PERROR("snprintf save session");
1807 ret
= LTTNG_ERR_SET_URL
;
1814 * Check the path fits in the config file path dst including the '/'
1815 * followed by trailing .lttng extension and the NULL terminated string.
1817 if ((len
+ session_name_len
+ 2 +
1818 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1819 > sizeof(config_file_path
)) {
1820 ret
= LTTNG_ERR_SET_URL
;
1824 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1825 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1827 ret
= LTTNG_ERR_SET_URL
;
1832 * At this point, we know that everything fits in the buffer. Validation
1833 * was done just above.
1835 config_file_path
[len
++] = '/';
1836 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1837 len
+= session_name_len
;
1838 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1839 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1840 config_file_path
[len
] = '\0';
1842 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1843 /* File exists, notify the user since the overwrite flag is off. */
1844 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1848 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1849 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1850 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1852 PERROR("Could not create configuration file");
1853 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1858 writer
= config_writer_create(fd
, 1);
1860 ret
= LTTNG_ERR_NOMEM
;
1864 ret
= config_writer_open_element(writer
, config_element_sessions
);
1866 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1870 ret
= config_writer_open_element(writer
, config_element_session
);
1872 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1876 ret
= config_writer_write_element_string(writer
, config_element_name
,
1879 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1883 if(session
->shm_path
[0] != '\0') {
1884 ret
= config_writer_write_element_string(writer
,
1885 config_element_shared_memory_path
,
1888 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1893 ret
= save_domains(writer
, session
);
1898 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1901 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1905 if (session
->snapshot_mode
|| session
->live_timer
) {
1906 ret
= config_writer_open_element(writer
, config_element_attributes
);
1908 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1912 if (session
->snapshot_mode
) {
1913 ret
= config_writer_write_element_bool(writer
,
1914 config_element_snapshot_mode
, 1);
1916 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1920 ret
= config_writer_write_element_unsigned_int(writer
,
1921 config_element_live_timer_interval
, session
->live_timer
);
1923 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1929 ret
= config_writer_close_element(writer
);
1931 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1936 ret
= save_session_output(writer
, session
);
1942 ret
= config_writer_close_element(writer
);
1944 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1949 ret
= config_writer_close_element(writer
);
1951 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1955 if (writer
&& config_writer_destroy(writer
)) {
1956 /* Preserve the original error code */
1957 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
1960 /* Delete file in case of error */
1961 if (file_opened
&& unlink(config_file_path
)) {
1962 PERROR("Unlinking XML session configuration.");
1969 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
1970 lttng_sock_cred
*creds
)
1973 const char *session_name
;
1974 struct ltt_session
*session
;
1976 session_lock_list();
1978 session_name
= lttng_save_session_attr_get_session_name(attr
);
1980 session
= session_find_by_name(session_name
);
1982 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
1986 session_lock(session
);
1987 ret
= save_session(session
, attr
, creds
);
1988 session_unlock(session
);
1993 struct ltt_session_list
*list
= session_get_list();
1995 cds_list_for_each_entry(session
, &list
->head
, list
) {
1996 session_lock(session
);
1997 ret
= save_session(session
, attr
, creds
);
1998 session_unlock(session
);
2000 /* Don't abort if we don't have the required permissions. */
2001 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
2009 session_unlock_list();