2 * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_SESSION_DESCRIPTOR_INTERNAL_H
9 #define LTTNG_SESSION_DESCRIPTOR_INTERNAL_H
11 #include <lttng/session-descriptor.h>
12 #include <lttng/lttng-error.h>
13 #include <common/uri.hpp>
14 #include <common/dynamic-buffer.hpp>
15 #include <common/buffer-view.hpp>
18 /* Note that these enums are used as part of the lttnctl protocol. */
19 enum lttng_session_descriptor_type {
20 LTTNG_SESSION_DESCRIPTOR_TYPE_UNKNOWN = -1,
22 * The output type determines whether this is a no-output, local,
23 * or networked tracing session.
25 LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR = 1,
26 LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT = 2,
27 LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE = 3,
30 enum lttng_session_descriptor_output_type {
31 LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE = 0,
32 LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL = 1,
33 LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK = 2,
36 ssize_t lttng_session_descriptor_create_from_buffer(
37 const struct lttng_buffer_view *view,
38 struct lttng_session_descriptor **descriptor);
40 int lttng_session_descriptor_serialize(
41 const struct lttng_session_descriptor *descriptor,
42 struct lttng_dynamic_buffer *buffer);
44 enum lttng_session_descriptor_type
45 lttng_session_descriptor_get_type(
46 const struct lttng_session_descriptor *descriptor);
48 enum lttng_session_descriptor_output_type
49 lttng_session_descriptor_get_output_type(
50 const struct lttng_session_descriptor *descriptor);
52 void lttng_session_descriptor_get_local_output_uri(
53 const struct lttng_session_descriptor *descriptor,
54 struct lttng_uri *local_uri);
56 void lttng_session_descriptor_get_network_output_uris(
57 const struct lttng_session_descriptor *descriptor,
58 struct lttng_uri *control,
59 struct lttng_uri *data);
62 lttng_session_descriptor_live_get_timer_interval(
63 const struct lttng_session_descriptor *descriptor);
65 int lttng_session_descriptor_set_session_name(
66 struct lttng_session_descriptor *descriptor,
69 bool lttng_session_descriptor_is_output_destination_initialized(
70 const struct lttng_session_descriptor *descriptor);
72 bool lttng_session_descriptor_has_output_directory(
73 const struct lttng_session_descriptor *descriptor);
75 enum lttng_error_code lttng_session_descriptor_set_default_output(
76 struct lttng_session_descriptor *descriptor,
77 time_t *session_creation_time,
78 const char *absolute_home_path);
80 int lttng_session_descriptor_assign(
81 struct lttng_session_descriptor *dst_descriptor,
82 const struct lttng_session_descriptor *src_descriptor);
84 #endif /* LTTNG_SESSION_DESCRIPTOR_INTERNAL_H */