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