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.
22 #include <urcu/uatomic.h>
25 #include <common/defaults.h>
26 #include <common/error.h>
27 #include <common/config/session-config.h>
28 #include <common/utils.h>
29 #include <common/runas.h>
30 #include <lttng/save-internal.h>
36 #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
;
235 case LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE
:
236 context_type_string
= config_event_context_interruptible
;
238 case LTTNG_KERNEL_CONTEXT_PREEMPTIBLE
:
239 context_type_string
= config_event_context_preemptible
;
241 case LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE
:
242 context_type_string
= config_event_context_need_reschedule
;
244 case LTTNG_KERNEL_CONTEXT_MIGRATABLE
:
245 context_type_string
= config_event_context_migratable
;
248 context_type_string
= NULL
;
251 return context_type_string
;
255 const char *get_ust_context_type_string(
256 enum lttng_ust_context_type context_type
)
258 const char *context_type_string
;
260 switch (context_type
) {
261 case LTTNG_UST_CONTEXT_PROCNAME
:
262 context_type_string
= config_event_context_procname
;
264 case LTTNG_UST_CONTEXT_VPID
:
265 context_type_string
= config_event_context_vpid
;
267 case LTTNG_UST_CONTEXT_VTID
:
268 context_type_string
= config_event_context_vtid
;
270 case LTTNG_UST_CONTEXT_IP
:
271 context_type_string
= config_event_context_ip
;
273 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
274 context_type_string
= config_event_context_pthread_id
;
276 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
277 context_type_string
= config_event_context_app
;
279 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
281 * Error, should not be stored in the XML, perf contexts
282 * are stored as a node of type event_perf_context_type.
285 context_type_string
= NULL
;
289 return context_type_string
;
293 const char *get_buffer_type_string(
294 enum lttng_buffer_type buffer_type
)
296 const char *buffer_type_string
;
298 switch (buffer_type
) {
299 case LTTNG_BUFFER_PER_PID
:
300 buffer_type_string
= config_buffer_type_per_pid
;
302 case LTTNG_BUFFER_PER_UID
:
303 buffer_type_string
= config_buffer_type_per_uid
;
305 case LTTNG_BUFFER_GLOBAL
:
306 buffer_type_string
= config_buffer_type_global
;
309 buffer_type_string
= NULL
;
312 return buffer_type_string
;
316 const char *get_loglevel_type_string(
317 enum lttng_ust_loglevel_type loglevel_type
)
319 const char *loglevel_type_string
;
321 switch (loglevel_type
) {
322 case LTTNG_UST_LOGLEVEL_ALL
:
323 loglevel_type_string
= config_loglevel_type_all
;
325 case LTTNG_UST_LOGLEVEL_RANGE
:
326 loglevel_type_string
= config_loglevel_type_range
;
328 case LTTNG_UST_LOGLEVEL_SINGLE
:
329 loglevel_type_string
= config_loglevel_type_single
;
332 loglevel_type_string
= NULL
;
335 return loglevel_type_string
;
339 int save_kernel_event(struct config_writer
*writer
,
340 struct ltt_kernel_event
*event
)
343 const char *instrumentation_type
;
345 ret
= config_writer_open_element(writer
, config_element_event
);
347 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
351 if (event
->event
->name
[0]) {
352 ret
= config_writer_write_element_string(writer
,
353 config_element_name
, event
->event
->name
);
355 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
360 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
363 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
367 instrumentation_type
= get_kernel_instrumentation_string(
368 event
->event
->instrumentation
);
369 if (!instrumentation_type
) {
370 ret
= LTTNG_ERR_INVALID
;
374 ret
= config_writer_write_element_string(writer
, config_element_type
,
375 instrumentation_type
);
377 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
381 if (event
->filter_expression
) {
382 ret
= config_writer_write_element_string(writer
,
383 config_element_filter
,
384 event
->filter_expression
);
386 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
391 if (event
->event
->instrumentation
== LTTNG_KERNEL_FUNCTION
||
392 event
->event
->instrumentation
== LTTNG_KERNEL_KPROBE
||
393 event
->event
->instrumentation
== LTTNG_KERNEL_KRETPROBE
) {
395 ret
= config_writer_open_element(writer
,
396 config_element_attributes
);
398 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
402 switch (event
->event
->instrumentation
) {
403 case LTTNG_KERNEL_SYSCALL
:
404 case LTTNG_KERNEL_FUNCTION
:
405 ret
= config_writer_open_element(writer
,
406 config_element_function_attributes
);
408 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
412 ret
= config_writer_write_element_string(writer
,
414 event
->event
->u
.ftrace
.symbol_name
);
416 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
420 /* /function attributes */
421 ret
= config_writer_close_element(writer
);
423 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
427 case LTTNG_KERNEL_KPROBE
:
428 case LTTNG_KERNEL_KRETPROBE
:
430 const char *symbol_name
;
434 if (event
->event
->instrumentation
==
435 LTTNG_KERNEL_KPROBE
) {
437 * Comments in lttng-kernel.h mention that
438 * either addr or symbol_name are set, not both.
440 addr
= event
->event
->u
.kprobe
.addr
;
441 offset
= event
->event
->u
.kprobe
.offset
;
442 symbol_name
= addr
? NULL
:
443 event
->event
->u
.kprobe
.symbol_name
;
446 event
->event
->u
.kretprobe
.symbol_name
;
447 addr
= event
->event
->u
.kretprobe
.addr
;
448 offset
= event
->event
->u
.kretprobe
.offset
;
451 ret
= config_writer_open_element(writer
,
452 config_element_probe_attributes
);
454 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
459 ret
= config_writer_write_element_string(writer
,
460 config_element_symbol_name
,
463 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
469 ret
= config_writer_write_element_unsigned_int(
470 writer
, config_element_address
, addr
);
472 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
478 ret
= config_writer_write_element_unsigned_int(
479 writer
, config_element_offset
, offset
);
481 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
486 ret
= config_writer_close_element(writer
);
488 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
494 ERR("Unsupported kernel instrumentation type.");
495 ret
= LTTNG_ERR_INVALID
;
500 ret
= config_writer_close_element(writer
);
502 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
508 ret
= config_writer_close_element(writer
);
510 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
518 int save_kernel_events(struct config_writer
*writer
,
519 struct ltt_kernel_channel
*kchan
)
522 struct ltt_kernel_event
*event
;
524 ret
= config_writer_open_element(writer
, config_element_events
);
526 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
530 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
531 ret
= save_kernel_event(writer
, event
);
538 ret
= config_writer_close_element(writer
);
540 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
548 int save_ust_event(struct config_writer
*writer
,
549 struct ltt_ust_event
*event
)
552 const char *loglevel_type_string
;
554 ret
= config_writer_open_element(writer
, config_element_event
);
556 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
560 if (event
->attr
.name
[0]) {
561 ret
= config_writer_write_element_string(writer
,
562 config_element_name
, event
->attr
.name
);
564 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
569 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
572 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
576 if (event
->attr
.instrumentation
!= LTTNG_UST_TRACEPOINT
) {
577 ERR("Unsupported UST instrumentation type.");
578 ret
= LTTNG_ERR_INVALID
;
581 ret
= config_writer_write_element_string(writer
, config_element_type
,
582 config_event_type_tracepoint
);
584 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
588 loglevel_type_string
= get_loglevel_type_string(
589 event
->attr
.loglevel_type
);
590 if (!loglevel_type_string
) {
591 ERR("Unsupported UST loglevel type.");
592 ret
= LTTNG_ERR_INVALID
;
596 ret
= config_writer_write_element_string(writer
,
597 config_element_loglevel_type
, loglevel_type_string
);
599 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
603 /* The log level is irrelevant if no "filtering" is enabled */
604 if (event
->attr
.loglevel_type
!= LTTNG_UST_LOGLEVEL_ALL
) {
605 ret
= config_writer_write_element_signed_int(writer
,
606 config_element_loglevel
, event
->attr
.loglevel
);
608 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
613 if (event
->filter_expression
) {
614 ret
= config_writer_write_element_string(writer
,
615 config_element_filter
, event
->filter_expression
);
617 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
622 if (event
->exclusion
&& event
->exclusion
->count
) {
625 ret
= config_writer_open_element(writer
,
626 config_element_exclusions
);
628 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
632 for (i
= 0; i
< event
->exclusion
->count
; i
++) {
633 ret
= config_writer_write_element_string(writer
,
634 config_element_exclusion
,
635 LTTNG_EVENT_EXCLUSION_NAME_AT(
636 event
->exclusion
, i
));
638 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
644 ret
= config_writer_close_element(writer
);
646 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
652 ret
= config_writer_close_element(writer
);
654 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
662 int save_ust_events(struct config_writer
*writer
,
663 struct lttng_ht
*events
)
666 struct ltt_ust_event
*event
;
667 struct lttng_ht_node_str
*node
;
668 struct lttng_ht_iter iter
;
670 ret
= config_writer_open_element(writer
, config_element_events
);
672 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
677 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
678 event
= caa_container_of(node
, struct ltt_ust_event
, node
);
680 if (event
->internal
) {
681 /* Internal events must not be exposed to clients */
684 ret
= save_ust_event(writer
, event
);
693 ret
= config_writer_close_element(writer
);
695 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
703 int init_ust_event_from_agent_event(struct ltt_ust_event
*ust_event
,
704 struct agent_event
*agent_event
)
707 enum lttng_ust_loglevel_type ust_loglevel_type
;
709 ust_event
->enabled
= agent_event
->enabled
;
710 ust_event
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
711 strncpy(ust_event
->attr
.name
, agent_event
->name
, LTTNG_SYMBOL_NAME_LEN
);
712 switch (agent_event
->loglevel_type
) {
713 case LTTNG_EVENT_LOGLEVEL_ALL
:
714 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
716 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
717 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
719 case LTTNG_EVENT_LOGLEVEL_RANGE
:
720 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
723 ERR("Invalid agent_event loglevel_type.");
728 ust_event
->attr
.loglevel_type
= ust_loglevel_type
;
729 ust_event
->attr
.loglevel
= agent_event
->loglevel_value
;
730 ust_event
->filter_expression
= agent_event
->filter_expression
;
731 ust_event
->exclusion
= agent_event
->exclusion
;
737 int save_agent_events(struct config_writer
*writer
,
738 struct ltt_ust_channel
*chan
,
742 struct lttng_ht_iter iter
;
743 struct lttng_ht_node_str
*node
;
745 ret
= config_writer_open_element(writer
, config_element_events
);
747 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
752 cds_lfht_for_each_entry(agent
->events
->ht
, &iter
.iter
, node
, node
) {
754 struct agent_event
*agent_event
;
755 struct ltt_ust_event fake_event
;
757 memset(&fake_event
, 0, sizeof(fake_event
));
758 agent_event
= caa_container_of(node
, struct agent_event
, node
);
761 * Initialize a fake ust event to reuse the same serialization
762 * function since UST and agent events contain the same info
763 * (and one could wonder why they don't reuse the same
766 ret
= init_ust_event_from_agent_event(&fake_event
, agent_event
);
771 ret
= save_ust_event(writer
, &fake_event
);
780 ret
= config_writer_close_element(writer
);
782 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
790 int save_kernel_context(struct config_writer
*writer
,
791 struct lttng_kernel_context
*ctx
)
799 ret
= config_writer_open_element(writer
, config_element_context
);
801 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
805 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
806 ret
= config_writer_open_element(writer
,
807 config_element_context_perf
);
809 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
813 ret
= config_writer_write_element_unsigned_int(writer
,
814 config_element_type
, ctx
->u
.perf_counter
.type
);
816 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
820 ret
= config_writer_write_element_unsigned_int(writer
,
821 config_element_config
, ctx
->u
.perf_counter
.config
);
823 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
827 ret
= config_writer_write_element_string(writer
,
828 config_element_name
, ctx
->u
.perf_counter
.name
);
830 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
835 ret
= config_writer_close_element(writer
);
837 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
841 const char *context_type_string
=
842 get_kernel_context_type_string(ctx
->ctx
);
844 if (!context_type_string
) {
845 ERR("Unsupported kernel context type.");
846 ret
= LTTNG_ERR_INVALID
;
850 ret
= config_writer_write_element_string(writer
,
851 config_element_type
, context_type_string
);
853 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
859 ret
= config_writer_close_element(writer
);
861 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
870 int save_kernel_contexts(struct config_writer
*writer
,
871 struct ltt_kernel_channel
*kchan
)
874 struct ltt_kernel_context
*ctx
;
876 if (cds_list_empty(&kchan
->ctx_list
)) {
881 ret
= config_writer_open_element(writer
, config_element_contexts
);
883 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
887 cds_list_for_each_entry(ctx
, &kchan
->ctx_list
, list
) {
888 ret
= save_kernel_context(writer
, &ctx
->ctx
);
895 ret
= config_writer_close_element(writer
);
897 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
905 int save_ust_context_perf_thread_counter(struct config_writer
*writer
,
906 struct ltt_ust_context
*ctx
)
913 /* Perf contexts are saved as event_perf_context_type */
914 ret
= config_writer_open_element(writer
, config_element_context_perf
);
916 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
920 ret
= config_writer_write_element_unsigned_int(writer
,
921 config_element_type
, ctx
->ctx
.u
.perf_counter
.type
);
923 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
927 ret
= config_writer_write_element_unsigned_int(writer
,
928 config_element_config
, ctx
->ctx
.u
.perf_counter
.config
);
930 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
934 ret
= config_writer_write_element_string(writer
, config_element_name
,
935 ctx
->ctx
.u
.perf_counter
.name
);
937 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
942 ret
= config_writer_close_element(writer
);
944 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
952 int save_ust_context_app_ctx(struct config_writer
*writer
,
953 struct ltt_ust_context
*ctx
)
960 /* Application contexts are saved as application_context_type */
961 ret
= config_writer_open_element(writer
, config_element_context_app
);
963 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
967 ret
= config_writer_write_element_string(writer
,
968 config_element_context_app_provider_name
,
969 ctx
->ctx
.u
.app_ctx
.provider_name
);
971 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
975 ret
= config_writer_write_element_string(writer
,
976 config_element_context_app_ctx_name
,
977 ctx
->ctx
.u
.app_ctx
.ctx_name
);
979 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
984 ret
= config_writer_close_element(writer
);
986 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
994 int save_ust_context_generic(struct config_writer
*writer
,
995 struct ltt_ust_context
*ctx
)
998 const char *context_type_string
;
1003 /* Save context as event_context_type_type */
1004 context_type_string
= get_ust_context_type_string(
1006 if (!context_type_string
) {
1007 ERR("Unsupported UST context type.");
1008 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1012 ret
= config_writer_write_element_string(writer
,
1013 config_element_type
, context_type_string
);
1015 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1023 int save_ust_context(struct config_writer
*writer
,
1024 struct cds_list_head
*ctx_list
)
1027 struct ltt_ust_context
*ctx
;
1032 ret
= config_writer_open_element(writer
, config_element_contexts
);
1034 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1038 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
1039 ret
= config_writer_open_element(writer
,
1040 config_element_context
);
1042 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1046 switch (ctx
->ctx
.ctx
) {
1047 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
1048 ret
= save_ust_context_perf_thread_counter(writer
, ctx
);
1050 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
1051 ret
= save_ust_context_app_ctx(writer
, ctx
);
1054 /* Save generic context. */
1055 ret
= save_ust_context_generic(writer
, ctx
);
1062 ret
= config_writer_close_element(writer
);
1064 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1070 ret
= config_writer_close_element(writer
);
1072 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1080 int save_kernel_channel(struct config_writer
*writer
,
1081 struct ltt_kernel_channel
*kchan
)
1088 ret
= config_writer_open_element(writer
, config_element_channel
);
1090 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1094 ret
= config_writer_write_element_string(writer
, config_element_name
,
1095 kchan
->channel
->name
);
1097 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1101 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1102 kchan
->channel
->enabled
);
1104 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1108 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
1113 ret
= save_kernel_events(writer
, kchan
);
1118 ret
= save_kernel_contexts(writer
, kchan
);
1124 ret
= config_writer_close_element(writer
);
1126 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1134 int save_ust_channel(struct config_writer
*writer
,
1135 struct ltt_ust_channel
*ust_chan
,
1136 struct ltt_ust_session
*session
)
1144 ret
= config_writer_open_element(writer
, config_element_channel
);
1146 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1150 ret
= config_writer_write_element_string(writer
, config_element_name
,
1153 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1157 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1160 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1164 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
1169 ret
= config_writer_write_element_unsigned_int(writer
,
1170 config_element_tracefile_size
, ust_chan
->tracefile_size
);
1172 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1176 ret
= config_writer_write_element_unsigned_int(writer
,
1177 config_element_tracefile_count
, ust_chan
->tracefile_count
);
1179 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1183 ret
= config_writer_write_element_unsigned_int(writer
,
1184 config_element_live_timer_interval
,
1185 session
->live_timer_interval
);
1187 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1191 if (ust_chan
->domain
== LTTNG_DOMAIN_UST
) {
1192 ret
= save_ust_events(writer
, ust_chan
->events
);
1197 struct agent
*agent
= NULL
;
1199 agent
= trace_ust_find_agent(session
, ust_chan
->domain
);
1201 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1202 ERR("Could not find agent associated to UST subdomain");
1207 * Channels associated with a UST sub-domain (such as JUL, Log4j
1208 * or Python) don't have any non-internal events. We retrieve
1209 * the "agent" events associated with this channel and serialize
1212 ret
= save_agent_events(writer
, ust_chan
, agent
);
1218 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1224 ret
= config_writer_close_element(writer
);
1226 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1234 int save_kernel_session(struct config_writer
*writer
,
1235 struct ltt_session
*session
)
1238 struct ltt_kernel_channel
*kchan
;
1243 ret
= config_writer_write_element_string(writer
, config_element_type
,
1244 config_domain_type_kernel
);
1246 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1250 ret
= config_writer_write_element_string(writer
,
1251 config_element_buffer_type
, config_buffer_type_global
);
1253 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1257 ret
= config_writer_open_element(writer
,
1258 config_element_channels
);
1260 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1264 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1266 ret
= save_kernel_channel(writer
, kchan
);
1273 ret
= config_writer_close_element(writer
);
1275 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1283 const char *get_config_domain_str(enum lttng_domain_type domain
)
1285 const char *str_dom
;
1288 case LTTNG_DOMAIN_KERNEL
:
1289 str_dom
= config_domain_type_kernel
;
1291 case LTTNG_DOMAIN_UST
:
1292 str_dom
= config_domain_type_ust
;
1294 case LTTNG_DOMAIN_JUL
:
1295 str_dom
= config_domain_type_jul
;
1297 case LTTNG_DOMAIN_LOG4J
:
1298 str_dom
= config_domain_type_log4j
;
1300 case LTTNG_DOMAIN_PYTHON
:
1301 str_dom
= config_domain_type_python
;
1311 int save_pid_tracker(struct config_writer
*writer
,
1312 struct ltt_session
*sess
, int domain
)
1315 ssize_t nr_pids
= 0, i
;
1316 int32_t *pids
= NULL
;
1319 case LTTNG_DOMAIN_KERNEL
:
1321 nr_pids
= kernel_list_tracker_pids(sess
->kernel_session
, &pids
);
1323 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1328 case LTTNG_DOMAIN_UST
:
1330 nr_pids
= trace_ust_list_tracker_pids(sess
->ust_session
, &pids
);
1332 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1337 case LTTNG_DOMAIN_JUL
:
1338 case LTTNG_DOMAIN_LOG4J
:
1339 case LTTNG_DOMAIN_PYTHON
:
1341 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1345 /* Only create a pid_tracker if enabled or untrack all */
1346 if (nr_pids
!= 1 || (nr_pids
== 1 && pids
[0] != -1)) {
1347 ret
= config_writer_open_element(writer
,
1348 config_element_pid_tracker
);
1350 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1354 ret
= config_writer_open_element(writer
,
1355 config_element_targets
);
1357 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1361 for (i
= 0; i
< nr_pids
; i
++) {
1362 ret
= config_writer_open_element(writer
,
1363 config_element_target_pid
);
1365 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1369 ret
= config_writer_write_element_unsigned_int(writer
,
1370 config_element_pid
, pids
[i
]);
1372 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1377 ret
= config_writer_close_element(writer
);
1379 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1385 ret
= config_writer_close_element(writer
);
1387 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1392 ret
= config_writer_close_element(writer
);
1394 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1404 int save_ust_domain(struct config_writer
*writer
,
1405 struct ltt_session
*session
, enum lttng_domain_type domain
)
1408 struct ltt_ust_channel
*ust_chan
;
1409 const char *buffer_type_string
;
1410 struct lttng_ht_node_str
*node
;
1411 struct lttng_ht_iter iter
;
1412 const char *config_domain_name
;
1417 ret
= config_writer_open_element(writer
,
1418 config_element_domain
);
1420 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1424 config_domain_name
= get_config_domain_str(domain
);
1425 if (!config_domain_name
) {
1426 ret
= LTTNG_ERR_INVALID
;
1430 ret
= config_writer_write_element_string(writer
,
1431 config_element_type
, config_domain_name
);
1433 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1437 buffer_type_string
= get_buffer_type_string(
1438 session
->ust_session
->buffer_type
);
1439 if (!buffer_type_string
) {
1440 ERR("Unsupported buffer type.");
1441 ret
= LTTNG_ERR_INVALID
;
1445 ret
= config_writer_write_element_string(writer
,
1446 config_element_buffer_type
, buffer_type_string
);
1448 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1452 ret
= config_writer_open_element(writer
, config_element_channels
);
1454 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1459 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1460 &iter
.iter
, node
, node
) {
1461 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1462 if (domain
== ust_chan
->domain
) {
1463 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1473 ret
= config_writer_close_element(writer
);
1475 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1479 if (domain
== LTTNG_DOMAIN_UST
) {
1480 ret
= config_writer_open_element(writer
,
1481 config_element_trackers
);
1483 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1487 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_UST
);
1493 ret
= config_writer_close_element(writer
);
1500 ret
= config_writer_close_element(writer
);
1502 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1511 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1518 if (!session
->kernel_session
&& !session
->ust_session
) {
1522 ret
= config_writer_open_element(writer
, config_element_domains
);
1524 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1529 if (session
->kernel_session
) {
1530 ret
= config_writer_open_element(writer
,
1531 config_element_domain
);
1533 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1537 ret
= save_kernel_session(writer
, session
);
1542 ret
= config_writer_open_element(writer
,
1543 config_element_trackers
);
1545 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1549 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_KERNEL
);
1555 ret
= config_writer_close_element(writer
);
1557 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1561 ret
= config_writer_close_element(writer
);
1563 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1568 if (session
->ust_session
) {
1569 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_UST
);
1574 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_JUL
);
1579 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_LOG4J
);
1584 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_PYTHON
);
1591 ret
= config_writer_close_element(writer
);
1593 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1601 int save_consumer_output(struct config_writer
*writer
,
1602 struct consumer_output
*output
)
1609 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1611 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1615 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1618 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1622 ret
= config_writer_open_element(writer
, config_element_destination
);
1624 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1628 switch (output
->type
) {
1629 case CONSUMER_DST_LOCAL
:
1630 ret
= config_writer_write_element_string(writer
,
1631 config_element_path
, output
->dst
.trace_path
);
1633 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1637 case CONSUMER_DST_NET
:
1641 uri
= zmalloc(PATH_MAX
);
1643 ret
= LTTNG_ERR_NOMEM
;
1647 ret
= config_writer_open_element(writer
, config_element_net_output
);
1649 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1650 goto end_net_output
;
1653 if (output
->dst
.net
.control_isset
&&
1654 output
->dst
.net
.data_isset
) {
1655 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1657 ret
= LTTNG_ERR_INVALID
;
1658 goto end_net_output
;
1661 ret
= config_writer_write_element_string(writer
,
1662 config_element_control_uri
, uri
);
1664 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1665 goto end_net_output
;
1668 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1670 ret
= LTTNG_ERR_INVALID
;
1671 goto end_net_output
;
1674 ret
= config_writer_write_element_string(writer
,
1675 config_element_data_uri
, uri
);
1677 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1678 goto end_net_output
;
1687 ret
= !output
->dst
.net
.control_isset
?
1688 LTTNG_ERR_URL_CTRL_MISS
:
1689 LTTNG_ERR_URL_DATA_MISS
;
1694 ret
= config_writer_close_element(writer
);
1696 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1702 ERR("Unsupported consumer output type.");
1703 ret
= LTTNG_ERR_INVALID
;
1708 ret
= config_writer_close_element(writer
);
1710 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1714 /* /consumer_output */
1715 ret
= config_writer_close_element(writer
);
1717 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1725 int save_snapshot_outputs(struct config_writer
*writer
,
1726 struct snapshot
*snapshot
)
1729 struct lttng_ht_iter iter
;
1730 struct snapshot_output
*output
;
1735 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1737 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1742 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1744 ret
= config_writer_open_element(writer
,
1745 config_element_output
);
1747 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1751 ret
= config_writer_write_element_string(writer
,
1752 config_element_name
, output
->name
);
1754 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1758 ret
= config_writer_write_element_unsigned_int(writer
,
1759 config_element_max_size
, output
->max_size
);
1761 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1765 ret
= save_consumer_output(writer
, output
->consumer
);
1771 ret
= config_writer_close_element(writer
);
1773 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1779 /* /snapshot_outputs */
1780 ret
= config_writer_close_element(writer
);
1782 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1794 int save_session_output(struct config_writer
*writer
,
1795 struct ltt_session
*session
)
1802 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1803 (!session
->snapshot_mode
&& !session
->consumer
)) {
1804 /* Session is in no output mode */
1809 ret
= config_writer_open_element(writer
, config_element_output
);
1811 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1815 if (session
->snapshot_mode
) {
1816 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1821 if (session
->consumer
) {
1822 ret
= save_consumer_output(writer
, session
->consumer
);
1830 ret
= config_writer_close_element(writer
);
1832 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1840 * Save the given session.
1842 * Return 0 on success else a LTTNG_ERR* code.
1845 int save_session(struct ltt_session
*session
,
1846 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1849 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1850 char config_file_path
[PATH_MAX
];
1852 struct config_writer
*writer
= NULL
;
1853 size_t session_name_len
;
1854 const char *provided_path
;
1860 session_name_len
= strlen(session
->name
);
1861 memset(config_file_path
, 0, sizeof(config_file_path
));
1863 if (!session_access_ok(session
,
1864 LTTNG_SOCK_GET_UID_CRED(creds
),
1865 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1866 ret
= LTTNG_ERR_EPERM
;
1870 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1871 if (provided_path
) {
1872 DBG3("Save session in provided path %s", provided_path
);
1873 len
= strlen(provided_path
);
1874 if (len
>= sizeof(config_file_path
)) {
1875 ret
= LTTNG_ERR_SET_URL
;
1878 strncpy(config_file_path
, provided_path
, len
);
1881 char *home_dir
= utils_get_user_home_dir(
1882 LTTNG_SOCK_GET_UID_CRED(creds
));
1884 ret
= LTTNG_ERR_SET_URL
;
1888 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1889 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1892 PERROR("snprintf save session");
1893 ret
= LTTNG_ERR_SET_URL
;
1900 * Check the path fits in the config file path dst including the '/'
1901 * followed by trailing .lttng extension and the NULL terminated string.
1903 if ((len
+ session_name_len
+ 2 +
1904 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1905 > sizeof(config_file_path
)) {
1906 ret
= LTTNG_ERR_SET_URL
;
1910 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1911 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1913 ret
= LTTNG_ERR_SET_URL
;
1918 * At this point, we know that everything fits in the buffer. Validation
1919 * was done just above.
1921 config_file_path
[len
++] = '/';
1922 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1923 len
+= session_name_len
;
1924 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1925 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1926 config_file_path
[len
] = '\0';
1928 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1929 /* File exists, notify the user since the overwrite flag is off. */
1930 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1934 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1935 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1936 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1938 PERROR("Could not create configuration file");
1939 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1944 writer
= config_writer_create(fd
, 1);
1946 ret
= LTTNG_ERR_NOMEM
;
1950 ret
= config_writer_open_element(writer
, config_element_sessions
);
1952 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1956 ret
= config_writer_open_element(writer
, config_element_session
);
1958 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1962 ret
= config_writer_write_element_string(writer
, config_element_name
,
1965 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1969 if(session
->shm_path
[0] != '\0') {
1970 ret
= config_writer_write_element_string(writer
,
1971 config_element_shared_memory_path
,
1974 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1979 ret
= save_domains(writer
, session
);
1984 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1987 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1991 if (session
->snapshot_mode
|| session
->live_timer
) {
1992 ret
= config_writer_open_element(writer
, config_element_attributes
);
1994 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1998 if (session
->snapshot_mode
) {
1999 ret
= config_writer_write_element_bool(writer
,
2000 config_element_snapshot_mode
, 1);
2002 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2006 ret
= config_writer_write_element_unsigned_int(writer
,
2007 config_element_live_timer_interval
, session
->live_timer
);
2009 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2015 ret
= config_writer_close_element(writer
);
2017 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2022 ret
= save_session_output(writer
, session
);
2028 ret
= config_writer_close_element(writer
);
2030 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2035 ret
= config_writer_close_element(writer
);
2037 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2041 if (writer
&& config_writer_destroy(writer
)) {
2042 /* Preserve the original error code */
2043 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
2046 /* Delete file in case of error */
2047 if (file_opened
&& unlink(config_file_path
)) {
2048 PERROR("Unlinking XML session configuration.");
2055 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
2056 lttng_sock_cred
*creds
)
2059 const char *session_name
;
2060 struct ltt_session
*session
;
2062 session_lock_list();
2064 session_name
= lttng_save_session_attr_get_session_name(attr
);
2066 session
= session_find_by_name(session_name
);
2068 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
2072 session_lock(session
);
2073 ret
= save_session(session
, attr
, creds
);
2074 session_unlock(session
);
2079 struct ltt_session_list
*list
= session_get_list();
2081 cds_list_for_each_entry(session
, &list
->head
, list
) {
2082 session_lock(session
);
2083 ret
= save_session(session
, attr
, creds
);
2084 session_unlock(session
);
2086 /* Don't abort if we don't have the required permissions. */
2087 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
2095 session_unlock_list();