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