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
;
236 context_type_string
= NULL
;
239 return context_type_string
;
243 const char *get_ust_context_type_string(
244 enum lttng_ust_context_type context_type
)
246 const char *context_type_string
;
248 switch (context_type
) {
249 case LTTNG_UST_CONTEXT_PROCNAME
:
250 context_type_string
= config_event_context_procname
;
252 case LTTNG_UST_CONTEXT_VPID
:
253 context_type_string
= config_event_context_vpid
;
255 case LTTNG_UST_CONTEXT_VTID
:
256 context_type_string
= config_event_context_vtid
;
258 case LTTNG_UST_CONTEXT_IP
:
259 context_type_string
= config_event_context_ip
;
261 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
262 context_type_string
= config_event_context_pthread_id
;
264 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
265 context_type_string
= config_event_context_app
;
267 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
269 * Error, should not be stored in the XML, perf contexts
270 * are stored as a node of type event_perf_context_type.
273 context_type_string
= NULL
;
277 return context_type_string
;
281 const char *get_buffer_type_string(
282 enum lttng_buffer_type buffer_type
)
284 const char *buffer_type_string
;
286 switch (buffer_type
) {
287 case LTTNG_BUFFER_PER_PID
:
288 buffer_type_string
= config_buffer_type_per_pid
;
290 case LTTNG_BUFFER_PER_UID
:
291 buffer_type_string
= config_buffer_type_per_uid
;
293 case LTTNG_BUFFER_GLOBAL
:
294 buffer_type_string
= config_buffer_type_global
;
297 buffer_type_string
= NULL
;
300 return buffer_type_string
;
304 const char *get_loglevel_type_string(
305 enum lttng_ust_loglevel_type loglevel_type
)
307 const char *loglevel_type_string
;
309 switch (loglevel_type
) {
310 case LTTNG_UST_LOGLEVEL_ALL
:
311 loglevel_type_string
= config_loglevel_type_all
;
313 case LTTNG_UST_LOGLEVEL_RANGE
:
314 loglevel_type_string
= config_loglevel_type_range
;
316 case LTTNG_UST_LOGLEVEL_SINGLE
:
317 loglevel_type_string
= config_loglevel_type_single
;
320 loglevel_type_string
= NULL
;
323 return loglevel_type_string
;
327 int save_kernel_event(struct config_writer
*writer
,
328 struct ltt_kernel_event
*event
)
331 const char *instrumentation_type
;
333 ret
= config_writer_open_element(writer
, config_element_event
);
335 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
339 if (event
->event
->name
[0]) {
340 ret
= config_writer_write_element_string(writer
,
341 config_element_name
, event
->event
->name
);
343 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
348 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
351 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
355 instrumentation_type
= get_kernel_instrumentation_string(
356 event
->event
->instrumentation
);
357 if (!instrumentation_type
) {
358 ret
= LTTNG_ERR_INVALID
;
362 ret
= config_writer_write_element_string(writer
, config_element_type
,
363 instrumentation_type
);
365 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
369 if (event
->filter_expression
) {
370 ret
= config_writer_write_element_string(writer
,
371 config_element_filter
,
372 event
->filter_expression
);
374 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
379 if (event
->event
->instrumentation
== LTTNG_KERNEL_FUNCTION
||
380 event
->event
->instrumentation
== LTTNG_KERNEL_KPROBE
||
381 event
->event
->instrumentation
== LTTNG_KERNEL_KRETPROBE
) {
383 ret
= config_writer_open_element(writer
,
384 config_element_attributes
);
386 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
390 switch (event
->event
->instrumentation
) {
391 case LTTNG_KERNEL_SYSCALL
:
392 case LTTNG_KERNEL_FUNCTION
:
393 ret
= config_writer_open_element(writer
,
394 config_element_function_attributes
);
396 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
400 ret
= config_writer_write_element_string(writer
,
402 event
->event
->u
.ftrace
.symbol_name
);
404 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
408 /* /function attributes */
409 ret
= config_writer_close_element(writer
);
411 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
415 case LTTNG_KERNEL_KPROBE
:
416 case LTTNG_KERNEL_KRETPROBE
:
418 const char *symbol_name
;
422 if (event
->event
->instrumentation
==
423 LTTNG_KERNEL_KPROBE
) {
425 * Comments in lttng-kernel.h mention that
426 * either addr or symbol_name are set, not both.
428 addr
= event
->event
->u
.kprobe
.addr
;
429 offset
= event
->event
->u
.kprobe
.offset
;
430 symbol_name
= addr
? NULL
:
431 event
->event
->u
.kprobe
.symbol_name
;
434 event
->event
->u
.kretprobe
.symbol_name
;
435 addr
= event
->event
->u
.kretprobe
.addr
;
436 offset
= event
->event
->u
.kretprobe
.offset
;
439 ret
= config_writer_open_element(writer
,
440 config_element_probe_attributes
);
442 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
447 ret
= config_writer_write_element_string(writer
,
448 config_element_symbol_name
,
451 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
457 ret
= config_writer_write_element_unsigned_int(
458 writer
, config_element_address
, addr
);
460 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
466 ret
= config_writer_write_element_unsigned_int(
467 writer
, config_element_offset
, offset
);
469 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
474 ret
= config_writer_close_element(writer
);
476 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
482 ERR("Unsupported kernel instrumentation type.");
483 ret
= LTTNG_ERR_INVALID
;
488 ret
= config_writer_close_element(writer
);
490 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
496 ret
= config_writer_close_element(writer
);
498 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
506 int save_kernel_events(struct config_writer
*writer
,
507 struct ltt_kernel_channel
*kchan
)
510 struct ltt_kernel_event
*event
;
512 ret
= config_writer_open_element(writer
, config_element_events
);
514 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
518 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
519 ret
= save_kernel_event(writer
, event
);
526 ret
= config_writer_close_element(writer
);
528 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
536 int save_ust_event(struct config_writer
*writer
,
537 struct ltt_ust_event
*event
)
540 const char *loglevel_type_string
;
542 ret
= config_writer_open_element(writer
, config_element_event
);
544 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
548 if (event
->attr
.name
[0]) {
549 ret
= config_writer_write_element_string(writer
,
550 config_element_name
, event
->attr
.name
);
552 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
557 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
560 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
564 if (event
->attr
.instrumentation
!= LTTNG_UST_TRACEPOINT
) {
565 ERR("Unsupported UST instrumentation type.");
566 ret
= LTTNG_ERR_INVALID
;
569 ret
= config_writer_write_element_string(writer
, config_element_type
,
570 config_event_type_tracepoint
);
572 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
576 loglevel_type_string
= get_loglevel_type_string(
577 event
->attr
.loglevel_type
);
578 if (!loglevel_type_string
) {
579 ERR("Unsupported UST loglevel type.");
580 ret
= LTTNG_ERR_INVALID
;
584 ret
= config_writer_write_element_string(writer
,
585 config_element_loglevel_type
, loglevel_type_string
);
587 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
591 /* The log level is irrelevant if no "filtering" is enabled */
592 if (event
->attr
.loglevel_type
!= LTTNG_UST_LOGLEVEL_ALL
) {
593 ret
= config_writer_write_element_signed_int(writer
,
594 config_element_loglevel
, event
->attr
.loglevel
);
596 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
601 if (event
->filter_expression
) {
602 ret
= config_writer_write_element_string(writer
,
603 config_element_filter
, event
->filter_expression
);
605 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
610 if (event
->exclusion
&& event
->exclusion
->count
) {
613 ret
= config_writer_open_element(writer
,
614 config_element_exclusions
);
616 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
620 for (i
= 0; i
< event
->exclusion
->count
; i
++) {
621 ret
= config_writer_write_element_string(writer
,
622 config_element_exclusion
,
623 LTTNG_EVENT_EXCLUSION_NAME_AT(
624 event
->exclusion
, i
));
626 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
632 ret
= config_writer_close_element(writer
);
634 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
640 ret
= config_writer_close_element(writer
);
642 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
650 int save_ust_events(struct config_writer
*writer
,
651 struct lttng_ht
*events
)
654 struct ltt_ust_event
*event
;
655 struct lttng_ht_node_str
*node
;
656 struct lttng_ht_iter iter
;
658 ret
= config_writer_open_element(writer
, config_element_events
);
660 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
665 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
666 event
= caa_container_of(node
, struct ltt_ust_event
, node
);
668 if (event
->internal
) {
669 /* Internal events must not be exposed to clients */
672 ret
= save_ust_event(writer
, event
);
681 ret
= config_writer_close_element(writer
);
683 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
691 int init_ust_event_from_agent_event(struct ltt_ust_event
*ust_event
,
692 struct agent_event
*agent_event
)
695 enum lttng_ust_loglevel_type ust_loglevel_type
;
697 ust_event
->enabled
= agent_event
->enabled
;
698 ust_event
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
699 strncpy(ust_event
->attr
.name
, agent_event
->name
, LTTNG_SYMBOL_NAME_LEN
);
700 switch (agent_event
->loglevel_type
) {
701 case LTTNG_EVENT_LOGLEVEL_ALL
:
702 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
704 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
705 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
707 case LTTNG_EVENT_LOGLEVEL_RANGE
:
708 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
711 ERR("Invalid agent_event loglevel_type.");
716 ust_event
->attr
.loglevel_type
= ust_loglevel_type
;
717 ust_event
->attr
.loglevel
= agent_event
->loglevel_value
;
718 ust_event
->filter_expression
= agent_event
->filter_expression
;
719 ust_event
->exclusion
= agent_event
->exclusion
;
725 int save_agent_events(struct config_writer
*writer
,
726 struct ltt_ust_channel
*chan
,
730 struct lttng_ht_iter iter
;
731 struct lttng_ht_node_str
*node
;
733 ret
= config_writer_open_element(writer
, config_element_events
);
735 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
740 cds_lfht_for_each_entry(agent
->events
->ht
, &iter
.iter
, node
, node
) {
742 struct agent_event
*agent_event
;
743 struct ltt_ust_event fake_event
;
745 memset(&fake_event
, 0, sizeof(fake_event
));
746 agent_event
= caa_container_of(node
, struct agent_event
, node
);
749 * Initialize a fake ust event to reuse the same serialization
750 * function since UST and agent events contain the same info
751 * (and one could wonder why they don't reuse the same
754 ret
= init_ust_event_from_agent_event(&fake_event
, agent_event
);
759 ret
= save_ust_event(writer
, &fake_event
);
768 ret
= config_writer_close_element(writer
);
770 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
778 int save_kernel_context(struct config_writer
*writer
,
779 struct lttng_kernel_context
*ctx
)
787 ret
= config_writer_open_element(writer
, config_element_context
);
789 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
793 if (ctx
->ctx
== LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER
) {
794 ret
= config_writer_open_element(writer
,
795 config_element_context_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_perf_thread_counter(struct config_writer
*writer
,
894 struct ltt_ust_context
*ctx
)
901 /* Perf contexts are saved as event_perf_context_type */
902 ret
= config_writer_open_element(writer
, config_element_context_perf
);
904 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
908 ret
= config_writer_write_element_unsigned_int(writer
,
909 config_element_type
, ctx
->ctx
.u
.perf_counter
.type
);
911 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
915 ret
= config_writer_write_element_unsigned_int(writer
,
916 config_element_config
, ctx
->ctx
.u
.perf_counter
.config
);
918 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
922 ret
= config_writer_write_element_string(writer
, config_element_name
,
923 ctx
->ctx
.u
.perf_counter
.name
);
925 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
930 ret
= config_writer_close_element(writer
);
932 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
940 int save_ust_context_app_ctx(struct config_writer
*writer
,
941 struct ltt_ust_context
*ctx
)
948 /* Application contexts are saved as application_context_type */
949 ret
= config_writer_open_element(writer
, config_element_context_app
);
951 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
955 ret
= config_writer_write_element_string(writer
,
956 config_element_context_app_provider_name
,
957 ctx
->ctx
.u
.app_ctx
.provider_name
);
959 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
963 ret
= config_writer_write_element_string(writer
,
964 config_element_context_app_ctx_name
,
965 ctx
->ctx
.u
.app_ctx
.ctx_name
);
967 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
972 ret
= config_writer_close_element(writer
);
974 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
982 int save_ust_context_generic(struct config_writer
*writer
,
983 struct ltt_ust_context
*ctx
)
986 const char *context_type_string
;
991 /* Save context as event_context_type_type */
992 context_type_string
= get_ust_context_type_string(
994 if (!context_type_string
) {
995 ERR("Unsupported UST context type.");
996 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1000 ret
= config_writer_write_element_string(writer
,
1001 config_element_type
, context_type_string
);
1003 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1011 int save_ust_context(struct config_writer
*writer
,
1012 struct cds_list_head
*ctx_list
)
1015 struct ltt_ust_context
*ctx
;
1020 ret
= config_writer_open_element(writer
, config_element_contexts
);
1022 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1026 cds_list_for_each_entry(ctx
, ctx_list
, list
) {
1027 ret
= config_writer_open_element(writer
,
1028 config_element_context
);
1030 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1034 switch (ctx
->ctx
.ctx
) {
1035 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
1036 ret
= save_ust_context_perf_thread_counter(writer
, ctx
);
1038 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
1039 ret
= save_ust_context_app_ctx(writer
, ctx
);
1042 /* Save generic context. */
1043 ret
= save_ust_context_generic(writer
, ctx
);
1050 ret
= config_writer_close_element(writer
);
1052 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1058 ret
= config_writer_close_element(writer
);
1060 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1068 int save_kernel_channel(struct config_writer
*writer
,
1069 struct ltt_kernel_channel
*kchan
)
1076 ret
= config_writer_open_element(writer
, config_element_channel
);
1078 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1082 ret
= config_writer_write_element_string(writer
, config_element_name
,
1083 kchan
->channel
->name
);
1085 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1089 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1090 kchan
->channel
->enabled
);
1092 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1096 ret
= save_kernel_channel_attributes(writer
, &kchan
->channel
->attr
);
1101 ret
= save_kernel_events(writer
, kchan
);
1106 ret
= save_kernel_contexts(writer
, kchan
);
1112 ret
= config_writer_close_element(writer
);
1114 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1122 int save_ust_channel(struct config_writer
*writer
,
1123 struct ltt_ust_channel
*ust_chan
,
1124 struct ltt_ust_session
*session
)
1132 ret
= config_writer_open_element(writer
, config_element_channel
);
1134 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1138 ret
= config_writer_write_element_string(writer
, config_element_name
,
1141 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1145 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1148 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1152 ret
= save_ust_channel_attributes(writer
, &ust_chan
->attr
);
1157 ret
= config_writer_write_element_unsigned_int(writer
,
1158 config_element_tracefile_size
, ust_chan
->tracefile_size
);
1160 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1164 ret
= config_writer_write_element_unsigned_int(writer
,
1165 config_element_tracefile_count
, ust_chan
->tracefile_count
);
1167 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1171 ret
= config_writer_write_element_unsigned_int(writer
,
1172 config_element_live_timer_interval
,
1173 session
->live_timer_interval
);
1175 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1179 if (ust_chan
->domain
== LTTNG_DOMAIN_UST
) {
1180 ret
= save_ust_events(writer
, ust_chan
->events
);
1185 struct agent
*agent
= NULL
;
1187 agent
= trace_ust_find_agent(session
, ust_chan
->domain
);
1189 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1190 ERR("Could not find agent associated to UST subdomain");
1195 * Channels associated with a UST sub-domain (such as JUL, Log4j
1196 * or Python) don't have any non-internal events. We retrieve
1197 * the "agent" events associated with this channel and serialize
1200 ret
= save_agent_events(writer
, ust_chan
, agent
);
1206 ret
= save_ust_context(writer
, &ust_chan
->ctx_list
);
1212 ret
= config_writer_close_element(writer
);
1214 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1222 int save_kernel_session(struct config_writer
*writer
,
1223 struct ltt_session
*session
)
1226 struct ltt_kernel_channel
*kchan
;
1231 ret
= config_writer_write_element_string(writer
, config_element_type
,
1232 config_domain_type_kernel
);
1234 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1238 ret
= config_writer_write_element_string(writer
,
1239 config_element_buffer_type
, config_buffer_type_global
);
1241 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1245 ret
= config_writer_open_element(writer
,
1246 config_element_channels
);
1248 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1252 cds_list_for_each_entry(kchan
, &session
->kernel_session
->channel_list
.head
,
1254 ret
= save_kernel_channel(writer
, kchan
);
1261 ret
= config_writer_close_element(writer
);
1263 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1271 const char *get_config_domain_str(enum lttng_domain_type domain
)
1273 const char *str_dom
;
1276 case LTTNG_DOMAIN_KERNEL
:
1277 str_dom
= config_domain_type_kernel
;
1279 case LTTNG_DOMAIN_UST
:
1280 str_dom
= config_domain_type_ust
;
1282 case LTTNG_DOMAIN_JUL
:
1283 str_dom
= config_domain_type_jul
;
1285 case LTTNG_DOMAIN_LOG4J
:
1286 str_dom
= config_domain_type_log4j
;
1288 case LTTNG_DOMAIN_PYTHON
:
1289 str_dom
= config_domain_type_python
;
1299 int save_pid_tracker(struct config_writer
*writer
,
1300 struct ltt_session
*sess
, int domain
)
1303 ssize_t nr_pids
= 0, i
;
1304 int32_t *pids
= NULL
;
1307 case LTTNG_DOMAIN_KERNEL
:
1309 nr_pids
= kernel_list_tracker_pids(sess
->kernel_session
, &pids
);
1311 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1316 case LTTNG_DOMAIN_UST
:
1318 nr_pids
= trace_ust_list_tracker_pids(sess
->ust_session
, &pids
);
1320 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1325 case LTTNG_DOMAIN_JUL
:
1326 case LTTNG_DOMAIN_LOG4J
:
1327 case LTTNG_DOMAIN_PYTHON
:
1329 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1333 /* Only create a pid_tracker if enabled or untrack all */
1334 if (nr_pids
!= 1 || (nr_pids
== 1 && pids
[0] != -1)) {
1335 ret
= config_writer_open_element(writer
,
1336 config_element_pid_tracker
);
1338 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1342 ret
= config_writer_open_element(writer
,
1343 config_element_targets
);
1345 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1349 for (i
= 0; i
< nr_pids
; i
++) {
1350 ret
= config_writer_open_element(writer
,
1351 config_element_target_pid
);
1353 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1357 ret
= config_writer_write_element_unsigned_int(writer
,
1358 config_element_pid
, pids
[i
]);
1360 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1365 ret
= config_writer_close_element(writer
);
1367 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1373 ret
= config_writer_close_element(writer
);
1375 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1380 ret
= config_writer_close_element(writer
);
1382 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1392 int save_ust_domain(struct config_writer
*writer
,
1393 struct ltt_session
*session
, enum lttng_domain_type domain
)
1396 struct ltt_ust_channel
*ust_chan
;
1397 const char *buffer_type_string
;
1398 struct lttng_ht_node_str
*node
;
1399 struct lttng_ht_iter iter
;
1400 const char *config_domain_name
;
1405 ret
= config_writer_open_element(writer
,
1406 config_element_domain
);
1408 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1412 config_domain_name
= get_config_domain_str(domain
);
1413 if (!config_domain_name
) {
1414 ret
= LTTNG_ERR_INVALID
;
1418 ret
= config_writer_write_element_string(writer
,
1419 config_element_type
, config_domain_name
);
1421 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1425 buffer_type_string
= get_buffer_type_string(
1426 session
->ust_session
->buffer_type
);
1427 if (!buffer_type_string
) {
1428 ERR("Unsupported buffer type.");
1429 ret
= LTTNG_ERR_INVALID
;
1433 ret
= config_writer_write_element_string(writer
,
1434 config_element_buffer_type
, buffer_type_string
);
1436 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1440 ret
= config_writer_open_element(writer
, config_element_channels
);
1442 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1447 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
1448 &iter
.iter
, node
, node
) {
1449 ust_chan
= caa_container_of(node
, struct ltt_ust_channel
, node
);
1450 if (domain
== ust_chan
->domain
) {
1451 ret
= save_ust_channel(writer
, ust_chan
, session
->ust_session
);
1461 ret
= config_writer_close_element(writer
);
1463 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1467 if (domain
== LTTNG_DOMAIN_UST
) {
1468 ret
= config_writer_open_element(writer
,
1469 config_element_trackers
);
1471 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1475 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_UST
);
1481 ret
= config_writer_close_element(writer
);
1488 ret
= config_writer_close_element(writer
);
1490 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1499 int save_domains(struct config_writer
*writer
, struct ltt_session
*session
)
1506 if (!session
->kernel_session
&& !session
->ust_session
) {
1510 ret
= config_writer_open_element(writer
, config_element_domains
);
1512 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1517 if (session
->kernel_session
) {
1518 ret
= config_writer_open_element(writer
,
1519 config_element_domain
);
1521 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1525 ret
= save_kernel_session(writer
, session
);
1530 ret
= config_writer_open_element(writer
,
1531 config_element_trackers
);
1533 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1537 ret
= save_pid_tracker(writer
, session
, LTTNG_DOMAIN_KERNEL
);
1543 ret
= config_writer_close_element(writer
);
1545 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1549 ret
= config_writer_close_element(writer
);
1551 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1556 if (session
->ust_session
) {
1557 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_UST
);
1562 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_JUL
);
1567 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_LOG4J
);
1572 ret
= save_ust_domain(writer
, session
, LTTNG_DOMAIN_PYTHON
);
1579 ret
= config_writer_close_element(writer
);
1581 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1589 int save_consumer_output(struct config_writer
*writer
,
1590 struct consumer_output
*output
)
1597 ret
= config_writer_open_element(writer
, config_element_consumer_output
);
1599 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1603 ret
= config_writer_write_element_bool(writer
, config_element_enabled
,
1606 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1610 ret
= config_writer_open_element(writer
, config_element_destination
);
1612 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1616 switch (output
->type
) {
1617 case CONSUMER_DST_LOCAL
:
1618 ret
= config_writer_write_element_string(writer
,
1619 config_element_path
, output
->dst
.trace_path
);
1621 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1625 case CONSUMER_DST_NET
:
1629 uri
= zmalloc(PATH_MAX
);
1631 ret
= LTTNG_ERR_NOMEM
;
1635 ret
= config_writer_open_element(writer
, config_element_net_output
);
1637 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1638 goto end_net_output
;
1641 if (output
->dst
.net
.control_isset
&&
1642 output
->dst
.net
.data_isset
) {
1643 ret
= uri_to_str_url(&output
->dst
.net
.control
, uri
, PATH_MAX
);
1645 ret
= LTTNG_ERR_INVALID
;
1646 goto end_net_output
;
1649 ret
= config_writer_write_element_string(writer
,
1650 config_element_control_uri
, uri
);
1652 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1653 goto end_net_output
;
1656 ret
= uri_to_str_url(&output
->dst
.net
.data
, uri
, PATH_MAX
);
1658 ret
= LTTNG_ERR_INVALID
;
1659 goto end_net_output
;
1662 ret
= config_writer_write_element_string(writer
,
1663 config_element_data_uri
, uri
);
1665 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1666 goto end_net_output
;
1675 ret
= !output
->dst
.net
.control_isset
?
1676 LTTNG_ERR_URL_CTRL_MISS
:
1677 LTTNG_ERR_URL_DATA_MISS
;
1682 ret
= config_writer_close_element(writer
);
1684 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1690 ERR("Unsupported consumer output type.");
1691 ret
= LTTNG_ERR_INVALID
;
1696 ret
= config_writer_close_element(writer
);
1698 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1702 /* /consumer_output */
1703 ret
= config_writer_close_element(writer
);
1705 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1713 int save_snapshot_outputs(struct config_writer
*writer
,
1714 struct snapshot
*snapshot
)
1717 struct lttng_ht_iter iter
;
1718 struct snapshot_output
*output
;
1723 ret
= config_writer_open_element(writer
, config_element_snapshot_outputs
);
1725 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1730 cds_lfht_for_each_entry(snapshot
->output_ht
->ht
, &iter
.iter
, output
,
1732 ret
= config_writer_open_element(writer
,
1733 config_element_output
);
1735 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1739 ret
= config_writer_write_element_string(writer
,
1740 config_element_name
, output
->name
);
1742 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1746 ret
= config_writer_write_element_unsigned_int(writer
,
1747 config_element_max_size
, output
->max_size
);
1749 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1753 ret
= save_consumer_output(writer
, output
->consumer
);
1759 ret
= config_writer_close_element(writer
);
1761 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1767 /* /snapshot_outputs */
1768 ret
= config_writer_close_element(writer
);
1770 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1782 int save_session_output(struct config_writer
*writer
,
1783 struct ltt_session
*session
)
1790 if ((session
->snapshot_mode
&& session
->snapshot
.nb_output
== 0) ||
1791 (!session
->snapshot_mode
&& !session
->consumer
)) {
1792 /* Session is in no output mode */
1797 ret
= config_writer_open_element(writer
, config_element_output
);
1799 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1803 if (session
->snapshot_mode
) {
1804 ret
= save_snapshot_outputs(writer
, &session
->snapshot
);
1809 if (session
->consumer
) {
1810 ret
= save_consumer_output(writer
, session
->consumer
);
1818 ret
= config_writer_close_element(writer
);
1820 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1828 * Save the given session.
1830 * Return 0 on success else a LTTNG_ERR* code.
1833 int save_session(struct ltt_session
*session
,
1834 struct lttng_save_session_attr
*attr
, lttng_sock_cred
*creds
)
1837 unsigned int file_opened
= 0; /* Indicate if the file has been opened */
1838 char config_file_path
[PATH_MAX
];
1840 struct config_writer
*writer
= NULL
;
1841 size_t session_name_len
;
1842 const char *provided_path
;
1848 session_name_len
= strlen(session
->name
);
1849 memset(config_file_path
, 0, sizeof(config_file_path
));
1851 if (!session_access_ok(session
,
1852 LTTNG_SOCK_GET_UID_CRED(creds
),
1853 LTTNG_SOCK_GET_GID_CRED(creds
))) {
1854 ret
= LTTNG_ERR_EPERM
;
1858 provided_path
= lttng_save_session_attr_get_output_url(attr
);
1859 if (provided_path
) {
1860 DBG3("Save session in provided path %s", provided_path
);
1861 len
= strlen(provided_path
);
1862 if (len
>= sizeof(config_file_path
)) {
1863 ret
= LTTNG_ERR_SET_URL
;
1866 strncpy(config_file_path
, provided_path
, len
);
1869 char *home_dir
= utils_get_user_home_dir(
1870 LTTNG_SOCK_GET_UID_CRED(creds
));
1872 ret
= LTTNG_ERR_SET_URL
;
1876 ret_len
= snprintf(config_file_path
, sizeof(config_file_path
),
1877 DEFAULT_SESSION_HOME_CONFIGPATH
, home_dir
);
1880 PERROR("snprintf save session");
1881 ret
= LTTNG_ERR_SET_URL
;
1888 * Check the path fits in the config file path dst including the '/'
1889 * followed by trailing .lttng extension and the NULL terminated string.
1891 if ((len
+ session_name_len
+ 2 +
1892 sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
))
1893 > sizeof(config_file_path
)) {
1894 ret
= LTTNG_ERR_SET_URL
;
1898 ret
= run_as_mkdir_recursive(config_file_path
, S_IRWXU
| S_IRWXG
,
1899 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1901 ret
= LTTNG_ERR_SET_URL
;
1906 * At this point, we know that everything fits in the buffer. Validation
1907 * was done just above.
1909 config_file_path
[len
++] = '/';
1910 strncpy(config_file_path
+ len
, session
->name
, session_name_len
);
1911 len
+= session_name_len
;
1912 strcpy(config_file_path
+ len
, DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1913 len
+= sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION
);
1914 config_file_path
[len
] = '\0';
1916 if (!access(config_file_path
, F_OK
) && !attr
->overwrite
) {
1917 /* File exists, notify the user since the overwrite flag is off. */
1918 ret
= LTTNG_ERR_SAVE_FILE_EXIST
;
1922 fd
= run_as_open(config_file_path
, O_CREAT
| O_WRONLY
| O_TRUNC
,
1923 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
,
1924 LTTNG_SOCK_GET_UID_CRED(creds
), LTTNG_SOCK_GET_GID_CRED(creds
));
1926 PERROR("Could not create configuration file");
1927 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1932 writer
= config_writer_create(fd
, 1);
1934 ret
= LTTNG_ERR_NOMEM
;
1938 ret
= config_writer_open_element(writer
, config_element_sessions
);
1940 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1944 ret
= config_writer_open_element(writer
, config_element_session
);
1946 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1950 ret
= config_writer_write_element_string(writer
, config_element_name
,
1953 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1957 if(session
->shm_path
[0] != '\0') {
1958 ret
= config_writer_write_element_string(writer
,
1959 config_element_shared_memory_path
,
1962 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1967 ret
= save_domains(writer
, session
);
1972 ret
= config_writer_write_element_bool(writer
, config_element_started
,
1975 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1979 if (session
->snapshot_mode
|| session
->live_timer
) {
1980 ret
= config_writer_open_element(writer
, config_element_attributes
);
1982 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1986 if (session
->snapshot_mode
) {
1987 ret
= config_writer_write_element_bool(writer
,
1988 config_element_snapshot_mode
, 1);
1990 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
1994 ret
= config_writer_write_element_unsigned_int(writer
,
1995 config_element_live_timer_interval
, session
->live_timer
);
1997 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2003 ret
= config_writer_close_element(writer
);
2005 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2010 ret
= save_session_output(writer
, session
);
2016 ret
= config_writer_close_element(writer
);
2018 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2023 ret
= config_writer_close_element(writer
);
2025 ret
= LTTNG_ERR_SAVE_IO_FAIL
;
2029 if (writer
&& config_writer_destroy(writer
)) {
2030 /* Preserve the original error code */
2031 ret
= ret
? ret
: LTTNG_ERR_SAVE_IO_FAIL
;
2034 /* Delete file in case of error */
2035 if (file_opened
&& unlink(config_file_path
)) {
2036 PERROR("Unlinking XML session configuration.");
2043 int cmd_save_sessions(struct lttng_save_session_attr
*attr
,
2044 lttng_sock_cred
*creds
)
2047 const char *session_name
;
2048 struct ltt_session
*session
;
2050 session_lock_list();
2052 session_name
= lttng_save_session_attr_get_session_name(attr
);
2054 session
= session_find_by_name(session_name
);
2056 ret
= LTTNG_ERR_SESS_NOT_FOUND
;
2060 session_lock(session
);
2061 ret
= save_session(session
, attr
, creds
);
2062 session_unlock(session
);
2067 struct ltt_session_list
*list
= session_get_list();
2069 cds_list_for_each_entry(session
, &list
->head
, list
) {
2070 session_lock(session
);
2071 ret
= save_session(session
, attr
, creds
);
2072 session_unlock(session
);
2074 /* Don't abort if we don't have the required permissions. */
2075 if (ret
&& ret
!= LTTNG_ERR_EPERM
) {
2083 session_unlock_list();