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.h>
14 #include <common/dynamic-buffer.h>
15 #include <common/buffer-view.h>
22 /* Note that these enums are used as part of the lttnctl protocol. */
23 enum lttng_session_descriptor_type
{
24 LTTNG_SESSION_DESCRIPTOR_TYPE_UNKNOWN
= -1,
26 * The output type determines whether this is a no-output, local,
27 * or networked tracing session.
29 LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
= 1,
30 LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
= 2,
31 LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
= 3,
34 enum lttng_session_descriptor_output_type
{
35 LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
= 0,
36 LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
= 1,
37 LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
= 2,
40 ssize_t
lttng_session_descriptor_create_from_buffer(
41 const struct lttng_buffer_view
*view
,
42 struct lttng_session_descriptor
**descriptor
);
44 int lttng_session_descriptor_serialize(
45 const struct lttng_session_descriptor
*descriptor
,
46 struct lttng_dynamic_buffer
*buffer
);
48 enum lttng_session_descriptor_type
49 lttng_session_descriptor_get_type(
50 const struct lttng_session_descriptor
*descriptor
);
52 enum lttng_session_descriptor_output_type
53 lttng_session_descriptor_get_output_type(
54 const struct lttng_session_descriptor
*descriptor
);
56 void lttng_session_descriptor_get_local_output_uri(
57 const struct lttng_session_descriptor
*descriptor
,
58 struct lttng_uri
*local_uri
);
60 void lttng_session_descriptor_get_network_output_uris(
61 const struct lttng_session_descriptor
*descriptor
,
62 struct lttng_uri
*control
,
63 struct lttng_uri
*data
);
66 lttng_session_descriptor_live_get_timer_interval(
67 const struct lttng_session_descriptor
*descriptor
);
69 int lttng_session_descriptor_set_session_name(
70 struct lttng_session_descriptor
*descriptor
,
73 bool lttng_session_descriptor_is_output_destination_initialized(
74 const struct lttng_session_descriptor
*descriptor
);
76 bool lttng_session_descriptor_has_output_directory(
77 const struct lttng_session_descriptor
*descriptor
);
79 enum lttng_error_code
lttng_session_descriptor_set_default_output(
80 struct lttng_session_descriptor
*descriptor
,
81 time_t *session_creation_time
,
82 const char *absolute_home_path
);
84 int lttng_session_descriptor_assign(
85 struct lttng_session_descriptor
*dst_descriptor
,
86 const struct lttng_session_descriptor
*src_descriptor
);
92 #endif /* LTTNG_SESSION_DESCRIPTOR_INTERNAL_H */