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