include/lttng/session-descriptor-internal.hpp

   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 <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>
  16 #include <stdbool.h>
  17
  18 struct lttng_payload;
  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(
  39                 const struct lttng_buffer_view *view,
  40                 struct lttng_session_descriptor **descriptor);
  41
  42 int lttng_session_descriptor_serialize(
  43                 const struct lttng_session_descriptor *descriptor, lttng_payload *payload);
  44
  45 enum lttng_session_descriptor_type
  46 lttng_session_descriptor_get_type(
  47                 const struct lttng_session_descriptor *descriptor);
  48
  49 enum lttng_session_descriptor_output_type
  50 lttng_session_descriptor_get_output_type(
  51                 const struct lttng_session_descriptor *descriptor);
  52
  53 void lttng_session_descriptor_get_local_output_uri(
  54                 const struct lttng_session_descriptor *descriptor,
  55                 struct lttng_uri *local_uri);
  56
  57 void lttng_session_descriptor_get_network_output_uris(
  58                 const struct lttng_session_descriptor *descriptor,
  59                 struct lttng_uri *control,
  60                 struct lttng_uri *data);
  61
  62 unsigned long long
  63 lttng_session_descriptor_live_get_timer_interval(
  64                 const struct lttng_session_descriptor *descriptor);
  65
  66 int lttng_session_descriptor_set_session_name(
  67                 struct lttng_session_descriptor *descriptor,
  68                 const char *name);
  69
  70 bool lttng_session_descriptor_is_output_destination_initialized(
  71                 const struct lttng_session_descriptor *descriptor);
  72
  73 bool lttng_session_descriptor_has_output_directory(
  74                 const struct lttng_session_descriptor *descriptor);
  75
  76 enum lttng_error_code lttng_session_descriptor_set_default_output(
  77                 struct lttng_session_descriptor *descriptor,
  78                 time_t *session_creation_time,
  79                 const char *absolute_home_path);
  80
  81 int lttng_session_descriptor_assign(
  82                 struct lttng_session_descriptor *dst_descriptor,
  83                 const struct lttng_session_descriptor *src_descriptor);
  84
  85 #endif /* LTTNG_SESSION_DESCRIPTOR_INTERNAL_H */