src/plugins/ctf/lttng-live/viewer-connection.hpp

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   5  */
   6
   7 #ifndef LTTNG_LIVE_VIEWER_CONNECTION_H
   8 #define LTTNG_LIVE_VIEWER_CONNECTION_H
   9
  10 #include <glib.h>
  11 #include <stdint.h>
  12
  13 #include <babeltrace2/babeltrace.h>
  14
  15 #include "compat/socket.hpp"
  16 #include "cpp-common/bt2c/logging.hpp"
  17
  18 #define LTTNG_DEFAULT_NETWORK_VIEWER_PORT 5344
  19
  20 #define LTTNG_LIVE_MAJOR 2
  21 #define LTTNG_LIVE_MINOR 4
  22
  23 enum lttng_live_viewer_status
  24 {
  25     LTTNG_LIVE_VIEWER_STATUS_OK = 0,
  26     LTTNG_LIVE_VIEWER_STATUS_ERROR = -1,
  27     LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED = -2,
  28 };
  29
  30 enum lttng_live_get_one_metadata_status
  31 {
  32     /* The end of the metadata stream was reached. */
  33     LTTNG_LIVE_GET_ONE_METADATA_STATUS_END = 1,
  34     /* One metadata packet was received and written to file. */
  35     LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK = LTTNG_LIVE_VIEWER_STATUS_OK,
  36     /*
  37      * A critical error occurred when contacting the relay or while
  38      * handling its response.
  39      */
  40     LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR = LTTNG_LIVE_VIEWER_STATUS_ERROR,
  41
  42     LTTNG_LIVE_GET_ONE_METADATA_STATUS_INTERRUPTED = LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED,
  43
  44     /* The metadata stream was not found on the relay. */
  45     LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED = -3,
  46 };
  47
  48 struct live_viewer_connection
  49 {
  50     explicit live_viewer_connection(const bt2c::Logger& parentLogger) :
  51         logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/VIEWER"}
  52     {
  53     }
  54
  55     bt2c::Logger logger;
  56
  57     GString *url = nullptr;
  58
  59     GString *relay_hostname = nullptr;
  60     GString *target_hostname = nullptr;
  61     GString *session_name = nullptr;
  62     GString *proto = nullptr;
  63
  64     BT_SOCKET control_sock {};
  65     int port = 0;
  66
  67     int32_t major = 0;
  68     int32_t minor = 0;
  69
  70     bool in_query = false;
  71     struct lttng_live_msg_iter *lttng_live_msg_iter = nullptr;
  72 };
  73
  74 struct packet_index_time
  75 {
  76     uint64_t timestamp_begin;
  77     uint64_t timestamp_end;
  78 };
  79
  80 struct packet_index
  81 {
  82     off_t offset;          /* offset of the packet in the file, in bytes */
  83     int64_t data_offset;   /* offset of data within the packet, in bits */
  84     uint64_t packet_size;  /* packet size, in bits */
  85     uint64_t content_size; /* content size, in bits */
  86     uint64_t events_discarded;
  87     uint64_t events_discarded_len;      /* length of the field, in bits */
  88     struct packet_index_time ts_cycles; /* timestamp in cycles */
  89     struct packet_index_time ts_real;   /* realtime timestamp */
  90     /* CTF_INDEX 1.0 limit */
  91     uint64_t stream_instance_id; /* ID of the channel instance */
  92     uint64_t packet_seq_num;     /* packet sequence number */
  93 };
  94
  95 enum lttng_live_viewer_status live_viewer_connection_create(
  96     const char *url, bool in_query, struct lttng_live_msg_iter *lttng_live_msg_iter,
  97     const bt2c::Logger& parentLogger, struct live_viewer_connection **viewer);
  98
  99 void live_viewer_connection_destroy(struct live_viewer_connection *conn);
 100
 101 enum lttng_live_viewer_status
 102 lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);
 103
 104 bt_component_class_query_method_status
 105 live_viewer_connection_list_sessions(struct live_viewer_connection *viewer_connection,
 106                                      const bt_value **user_result);
 107
 108 #endif /* LTTNG_LIVE_VIEWER_CONNECTION_H */