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 #include <stdio.h>
  13
  14 #include <babeltrace2/babeltrace.h>
  15
  16 #include "common/macros.h"
  17 #include "compat/socket.h"
  18
  19 #define LTTNG_DEFAULT_NETWORK_VIEWER_PORT 5344
  20
  21 #define LTTNG_LIVE_MAJOR 2
  22 #define LTTNG_LIVE_MINOR 4
  23
  24 enum lttng_live_viewer_status
  25 {
  26     LTTNG_LIVE_VIEWER_STATUS_OK = 0,
  27     LTTNG_LIVE_VIEWER_STATUS_ERROR = -1,
  28     LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED = -2,
  29 };
  30
  31 enum lttng_live_get_one_metadata_status
  32 {
  33     /* The end of the metadata stream was reached. */
  34     LTTNG_LIVE_GET_ONE_METADATA_STATUS_END = 1,
  35     /* One metadata packet was received and written to file. */
  36     LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK = LTTNG_LIVE_VIEWER_STATUS_OK,
  37     /*
  38      * A critical error occurred when contacting the relay or while
  39      * handling its response.
  40      */
  41     LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR = LTTNG_LIVE_VIEWER_STATUS_ERROR,
  42
  43     LTTNG_LIVE_GET_ONE_METADATA_STATUS_INTERRUPTED = LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED,
  44
  45     /* The metadata stream was not found on the relay. */
  46     LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED = -3,
  47 };
  48
  49 struct lttng_live_component;
  50
  51 struct live_viewer_connection
  52 {
  53     bt_logging_level log_level;
  54     bt_self_component *self_comp;
  55     bt_self_component_class *self_comp_class;
  56
  57     GString *url;
  58
  59     GString *relay_hostname;
  60     GString *target_hostname;
  61     GString *session_name;
  62     GString *proto;
  63
  64     BT_SOCKET control_sock;
  65     int port;
  66
  67     int32_t major;
  68     int32_t minor;
  69
  70     bool in_query;
  71     struct lttng_live_msg_iter *lttng_live_msg_iter;
  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
  96 live_viewer_connection_create(bt_self_component *self_comp,
  97                               bt_self_component_class *self_comp_class, bt_logging_level log_level,
  98                               const char *url, bool in_query,
  99                               struct lttng_live_msg_iter *lttng_live_msg_iter,
 100                               struct live_viewer_connection **viewer_connection);
 101
 102 void live_viewer_connection_destroy(struct live_viewer_connection *conn);
 103
 104 enum lttng_live_viewer_status
 105 lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);
 106
 107 bt_component_class_query_method_status
 108 live_viewer_connection_list_sessions(struct live_viewer_connection *viewer_connection,
 109                                      const bt_value **user_result);
 110
 111 #endif /* LTTNG_LIVE_VIEWER_CONNECTION_H */