src/bin/lttng-relayd/lttng-viewer-abi.h

   1 #ifndef LTTNG_VIEWER_H
   2 #define LTTNG_VIEWER_H
   3
   4 /*
   5  * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
   6  *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   7  *                      David Goulet <dgoulet@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  */
  27
  28 #include <limits.h>
  29
  30 #define LTTNG_VIEWER_PATH_MAX           4096
  31 #define LTTNG_VIEWER_NAME_MAX           255
  32 #define LTTNG_VIEWER_HOST_NAME_MAX      64
  33
  34 /* Flags in reply to get_next_index and get_packet. */
  35 enum {
  36         /* New metadata is required to read this packet. */
  37         LTTNG_VIEWER_FLAG_NEW_METADATA  = (1 << 0),
  38         /* New stream got added to the trace. */
  39         LTTNG_VIEWER_FLAG_NEW_STREAM    = (1 << 1),
  40 };
  41
  42 enum lttng_viewer_command {
  43         LTTNG_VIEWER_CONNECT            = 1,
  44         LTTNG_VIEWER_LIST_SESSIONS      = 2,
  45         LTTNG_VIEWER_ATTACH_SESSION     = 3,
  46         LTTNG_VIEWER_GET_NEXT_INDEX     = 4,
  47         LTTNG_VIEWER_GET_PACKET         = 5,
  48         LTTNG_VIEWER_GET_METADATA       = 6,
  49         LTTNG_VIEWER_GET_NEW_STREAMS    = 7,
  50         LTTNG_VIEWER_CREATE_SESSION     = 8,
  51 };
  52
  53 enum lttng_viewer_attach_return_code {
  54         LTTNG_VIEWER_ATTACH_OK          = 1, /* The attach command succeeded. */
  55         LTTNG_VIEWER_ATTACH_ALREADY     = 2, /* A viewer is already attached. */
  56         LTTNG_VIEWER_ATTACH_UNK         = 3, /* The session ID is unknown. */
  57         LTTNG_VIEWER_ATTACH_NOT_LIVE    = 4, /* The session is not live. */
  58         LTTNG_VIEWER_ATTACH_SEEK_ERR    = 5, /* Seek error. */
  59         LTTNG_VIEWER_ATTACH_NO_SESSION  = 6, /* No viewer session created. */
  60 };
  61
  62 enum lttng_viewer_next_index_return_code {
  63         LTTNG_VIEWER_INDEX_OK           = 1, /* Index is available. */
  64         LTTNG_VIEWER_INDEX_RETRY        = 2, /* Index not yet available. */
  65         LTTNG_VIEWER_INDEX_HUP          = 3, /* Index closed (trace destroyed). */
  66         LTTNG_VIEWER_INDEX_ERR          = 4, /* Unknow error. */
  67         LTTNG_VIEWER_INDEX_INACTIVE     = 5, /* Inactive stream beacon. */
  68         LTTNG_VIEWER_INDEX_EOF          = 6, /* End of index file. */
  69 };
  70
  71 enum lttng_viewer_get_packet_return_code {
  72         LTTNG_VIEWER_GET_PACKET_OK      = 1,
  73         LTTNG_VIEWER_GET_PACKET_RETRY   = 2,
  74         LTTNG_VIEWER_GET_PACKET_ERR     = 3,
  75         LTTNG_VIEWER_GET_PACKET_EOF     = 4,
  76 };
  77
  78 enum lttng_viewer_get_metadata_return_code {
  79         LTTNG_VIEWER_METADATA_OK        = 1,
  80         LTTNG_VIEWER_NO_NEW_METADATA    = 2,
  81         LTTNG_VIEWER_METADATA_ERR       = 3,
  82 };
  83
  84 enum lttng_viewer_connection_type {
  85         LTTNG_VIEWER_CLIENT_COMMAND             = 1,
  86         LTTNG_VIEWER_CLIENT_NOTIFICATION        = 2,
  87 };
  88
  89 enum lttng_viewer_seek {
  90         /* Receive the trace packets from the beginning. */
  91         LTTNG_VIEWER_SEEK_BEGINNING     = 1,
  92         /* Receive the trace packets from now. */
  93         LTTNG_VIEWER_SEEK_LAST          = 2,
  94 };
  95
  96 enum lttng_viewer_new_streams_return_code {
  97         LTTNG_VIEWER_NEW_STREAMS_OK           = 1, /* If new streams are being sent. */
  98         LTTNG_VIEWER_NEW_STREAMS_NO_NEW       = 2, /* If no new streams are available. */
  99         LTTNG_VIEWER_NEW_STREAMS_ERR          = 3, /* Error. */
 100 };
 101
 102 enum lttng_viewer_create_session_return_code {
 103         LTTNG_VIEWER_CREATE_SESSION_OK          = 1,
 104         LTTNG_VIEWER_CREATE_SESSION_ERR         = 2,
 105 };
 106
 107 struct lttng_viewer_session {
 108         uint64_t id;
 109         uint32_t live_timer;
 110         uint32_t clients;
 111         uint32_t streams;
 112         char hostname[LTTNG_VIEWER_HOST_NAME_MAX];
 113         char session_name[LTTNG_VIEWER_NAME_MAX];
 114 } __attribute__((__packed__));
 115
 116 struct lttng_viewer_stream {
 117         uint64_t id;
 118         uint64_t ctf_trace_id;
 119         int metadata_flag;
 120         char path_name[LTTNG_VIEWER_PATH_MAX];
 121         char channel_name[LTTNG_VIEWER_NAME_MAX];
 122 } __attribute__((__packed__));
 123
 124 struct lttng_viewer_cmd {
 125         uint64_t data_size;     /* data size following this header */
 126         uint32_t cmd;           /* enum lttcomm_relayd_command */
 127         uint32_t cmd_version;   /* command version */
 128 } __attribute__((__packed__));
 129
 130 /*
 131  * LTTNG_VIEWER_CONNECT payload.
 132  */
 133 struct lttng_viewer_connect {
 134         /* session ID assigned by the relay for command connections */
 135         uint64_t viewer_session_id;
 136         uint32_t major;
 137         uint32_t minor;
 138         uint32_t type;          /* enum lttng_viewer_connection_type */
 139 } __attribute__((__packed__));
 140
 141 /*
 142  * LTTNG_VIEWER_LIST_SESSIONS payload.
 143  */
 144 struct lttng_viewer_list_sessions {
 145         uint32_t sessions_count;
 146         char session_list[];    /* struct lttng_viewer_session */
 147 } __attribute__((__packed__));
 148
 149 /*
 150  * LTTNG_VIEWER_ATTACH_SESSION payload.
 151  */
 152 struct lttng_viewer_attach_session_request {
 153         uint64_t session_id;
 154         uint64_t offset;        /* unused for now */
 155         uint32_t seek;          /* enum lttng_viewer_seek */
 156 } __attribute__((__packed__));
 157
 158 struct lttng_viewer_attach_session_response {
 159         /* enum lttng_viewer_attach_return_code */
 160         uint32_t status;
 161         uint32_t streams_count;
 162         /* struct lttng_viewer_stream */
 163         char stream_list[];
 164 } __attribute__((__packed__));
 165
 166 /*
 167  * LTTNG_VIEWER_GET_NEXT_INDEX payload.
 168  */
 169 struct lttng_viewer_get_next_index {
 170         uint64_t stream_id;
 171 } __attribute__ ((__packed__));
 172
 173 struct lttng_viewer_index {
 174         uint64_t offset;
 175         uint64_t packet_size;
 176         uint64_t content_size;
 177         uint64_t timestamp_begin;
 178         uint64_t timestamp_end;
 179         uint64_t events_discarded;
 180         uint64_t stream_id;
 181         uint32_t status;        /* enum lttng_viewer_next_index_return_code */
 182         uint32_t flags;         /* LTTNG_VIEWER_FLAG_* */
 183 } __attribute__ ((__packed__));
 184
 185 /*
 186  * LTTNG_VIEWER_GET_PACKET payload.
 187  */
 188 struct lttng_viewer_get_packet {
 189         uint64_t stream_id;
 190         uint64_t offset;
 191         uint32_t len;
 192 } __attribute__((__packed__));
 193
 194 struct lttng_viewer_trace_packet {
 195         uint32_t status;        /* enum lttng_viewer_get_packet_return_code */
 196         uint32_t len;
 197         uint32_t flags;         /* LTTNG_VIEWER_FLAG_* */
 198         char data[];
 199 } __attribute__((__packed__));
 200
 201 /*
 202  * LTTNG_VIEWER_GET_METADATA payload.
 203  */
 204 struct lttng_viewer_get_metadata {
 205         uint64_t stream_id;
 206 } __attribute__((__packed__));
 207
 208 struct lttng_viewer_metadata_packet {
 209         uint64_t len;
 210         uint32_t status;        /* enum lttng_viewer_get_metadata_return_code */
 211         char data[];
 212 } __attribute__((__packed__));
 213
 214 /*
 215  * LTTNG_VIEWER_GET_NEW_STREAMS payload.
 216  */
 217 struct lttng_viewer_new_streams_request {
 218         uint64_t session_id;
 219 } __attribute__((__packed__));
 220
 221 struct lttng_viewer_new_streams_response {
 222         /* enum lttng_viewer_new_streams_return_code */
 223         uint32_t status;
 224         uint32_t streams_count;
 225         /* struct lttng_viewer_stream */
 226         char stream_list[];
 227 } __attribute__((__packed__));
 228
 229 struct lttng_viewer_create_session_response {
 230         /* enum lttng_viewer_create_session_return_code */
 231         uint32_t status;
 232 } __attribute__((__packed__));
 233
 234 #endif /* LTTNG_VIEWER_H */