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

   1 #ifndef LTTNG_LIVE_VIEWER_CONNECTION_H
   2 #define LTTNG_LIVE_VIEWER_CONNECTION_H
   3
   4 /*
   5  * Copyright 2016 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <stdbool.h>
  27 #include <stdio.h>
  28 #include <glib.h>
  29
  30 #include "common/macros.h"
  31 #include "compat/socket.h"
  32
  33 /*
  34  * FIXME: This is an internal Babeltrace library header; it is not meant
  35  * to be generic as it is now. Make sure this included code does not
  36  * log because it won't find our local log level.
  37  */
  38 #define BT_OBJECT_DONT_LOG
  39 #include "lib/object.h"
  40
  41 #define LTTNG_DEFAULT_NETWORK_VIEWER_PORT       5344
  42
  43 #define LTTNG_LIVE_MAJOR                        2
  44 #define LTTNG_LIVE_MINOR                        4
  45
  46 struct lttng_live_component;
  47
  48 struct live_viewer_connection {
  49         bt_object obj;
  50         bt_logging_level log_level;
  51         bt_self_component *self_comp;
  52
  53         GString *url;
  54
  55         GString *relay_hostname;
  56         GString *target_hostname;
  57         GString *session_name;
  58
  59         BT_SOCKET control_sock;
  60         int port;
  61
  62         int32_t major;
  63         int32_t minor;
  64
  65         bool in_query;
  66         struct lttng_live_msg_iter *lttng_live_msg_iter;
  67 };
  68
  69 struct packet_index_time {
  70         uint64_t timestamp_begin;
  71         uint64_t timestamp_end;
  72 };
  73
  74 struct packet_index {
  75         off_t offset;           /* offset of the packet in the file, in bytes */
  76         int64_t data_offset;    /* offset of data within the packet, in bits */
  77         uint64_t packet_size;   /* packet size, in bits */
  78         uint64_t content_size;  /* content size, in bits */
  79         uint64_t events_discarded;
  80         uint64_t events_discarded_len;  /* length of the field, in bits */
  81         struct packet_index_time ts_cycles;     /* timestamp in cycles */
  82         struct packet_index_time ts_real;       /* realtime timestamp */
  83         /* CTF_INDEX 1.0 limit */
  84         uint64_t stream_instance_id;    /* ID of the channel instance */
  85         uint64_t packet_seq_num;        /* packet sequence number */
  86 };
  87
  88 struct live_viewer_connection * live_viewer_connection_create(
  89                 const char *url, bool in_query,
  90                 struct lttng_live_msg_iter *lttng_live_msg_iter,
  91                 bt_logging_level log_level);
  92
  93 void live_viewer_connection_destroy(
  94                 struct live_viewer_connection *conn);
  95
  96 bt_component_class_query_method_status live_viewer_connection_list_sessions(
  97                 struct live_viewer_connection *viewer_connection,
  98                 const bt_value **user_result);
  99
 100 #endif /* LTTNG_LIVE_VIEWER_CONNECTION_H */