src/common/sessiond-comm/relayd.h

   1 /*
   2  * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
   3  *                      Julien Desfossez <julien.desfossez@efficios.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License, version 2 only,
   7  * as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #ifndef _RELAYD_COMM
  20 #define _RELAYD_COMM
  21
  22 #include <limits.h>
  23 #include <stdint.h>
  24
  25 #include <lttng/lttng.h>
  26 #include <common/defaults.h>
  27 #include <common/index/ctf-index.h>
  28
  29 #define RELAYD_VERSION_COMM_MAJOR             VERSION_MAJOR
  30 #define RELAYD_VERSION_COMM_MINOR             VERSION_MINOR
  31
  32 #define RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4     64
  33 #define RELAYD_COMM_LTTNG_NAME_MAX_2_4  255
  34 #define RELAYD_COMM_LTTNG_PATH_MAX      4096
  35 #define RELAYD_COMM_DEFAULT_STREAM_NAME_LEN     264 /* 256 + 8 */
  36
  37 /*
  38  * lttng-relayd communication header.
  39  */
  40 struct lttcomm_relayd_hdr {
  41         /* Circuit ID not used for now so always ignored */
  42         uint64_t circuit_id;
  43         uint64_t data_size;             /* data size following this header */
  44         uint32_t cmd;                   /* enum lttcomm_relayd_command */
  45         uint32_t cmd_version;   /* command version */
  46 } LTTNG_PACKED;
  47
  48 /*
  49  * lttng-relayd data header.
  50  */
  51 struct lttcomm_relayd_data_hdr {
  52         /* Circuit ID not used for now so always ignored */
  53         uint64_t circuit_id;
  54         uint64_t stream_id;     /* Stream ID known by the relayd */
  55         uint64_t net_seq_num;   /* Network sequence number, per stream. */
  56         uint32_t data_size;     /* data size following this header */
  57         uint32_t padding_size;  /* Size of 0 padding the data */
  58 } LTTNG_PACKED;
  59
  60 /*
  61  * Reply from a create session command.
  62  */
  63 struct lttcomm_relayd_status_session {
  64         uint64_t session_id;
  65         uint32_t ret_code;
  66 } LTTNG_PACKED;
  67
  68 /*
  69  * Used to add a stream on the relay daemon.
  70  */
  71 struct lttcomm_relayd_add_stream {
  72         char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
  73         char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
  74 } LTTNG_PACKED;
  75
  76 /*
  77  * Used to add a stream on the relay daemon.
  78  * Protocol version 2.2
  79  */
  80 struct lttcomm_relayd_add_stream_2_2 {
  81         char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
  82         char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
  83         uint64_t tracefile_size;
  84         uint64_t tracefile_count;
  85 } LTTNG_PACKED;
  86
  87 struct lttcomm_relayd_add_stream_2_11 {
  88         uint32_t channel_name_len;
  89         uint32_t pathname_len;
  90         uint64_t tracefile_size;
  91         uint64_t tracefile_count;
  92         uint64_t trace_archive_id;
  93         char names[];
  94 } LTTNG_PACKED;
  95
  96 /*
  97  * Answer from an add stream command.
  98  */
  99 struct lttcomm_relayd_status_stream {
 100         uint64_t handle;
 101         uint32_t ret_code;
 102 } LTTNG_PACKED;
 103
 104 /*
 105  * Used to return command code for command not needing special data.
 106  */
 107 struct lttcomm_relayd_generic_reply {
 108         uint32_t ret_code;
 109 } LTTNG_PACKED;
 110
 111 /*
 112  * Version command.
 113  */
 114 struct lttcomm_relayd_version {
 115         uint32_t major;
 116         uint32_t minor;
 117 } LTTNG_PACKED;
 118
 119 /*
 120  * Metadata payload used when metadata command is sent.
 121  */
 122 struct lttcomm_relayd_metadata_payload {
 123         uint64_t stream_id;
 124         uint32_t padding_size;
 125         char payload[];
 126 } LTTNG_PACKED;
 127
 128 /*
 129  * Used to indicate that a specific stream id can now be closed.
 130  */
 131 struct lttcomm_relayd_close_stream {
 132         uint64_t stream_id;
 133         uint64_t last_net_seq_num;      /* sequence number of last packet */
 134 } LTTNG_PACKED;
 135
 136 /*
 137  * Used to test if for a given stream id the data is pending on the relayd side
 138  * for reading.
 139  */
 140 struct lttcomm_relayd_data_pending {
 141         uint64_t stream_id;
 142         uint64_t last_net_seq_num; /* Sequence number of the last packet */
 143 } LTTNG_PACKED;
 144
 145 struct lttcomm_relayd_begin_data_pending {
 146         uint64_t session_id;
 147 } LTTNG_PACKED;
 148
 149 struct lttcomm_relayd_end_data_pending {
 150         uint64_t session_id;
 151 } LTTNG_PACKED;
 152
 153 struct lttcomm_relayd_quiescent_control {
 154         uint64_t stream_id;
 155 } LTTNG_PACKED;
 156
 157 /*
 158  * Index data.
 159  */
 160 struct lttcomm_relayd_index {
 161         uint64_t relay_stream_id;
 162         uint64_t net_seq_num;
 163         uint64_t packet_size;
 164         uint64_t content_size;
 165         uint64_t timestamp_begin;
 166         uint64_t timestamp_end;
 167         uint64_t events_discarded;
 168         uint64_t stream_id;
 169         /* 2.8+ */
 170         uint64_t stream_instance_id;
 171         uint64_t packet_seq_num;
 172 } LTTNG_PACKED;
 173
 174 static inline size_t lttcomm_relayd_index_len(uint32_t major, uint32_t minor)
 175 {
 176         if (major == 1) {
 177                 switch (minor) {
 178                 case 0:
 179                         return offsetof(struct lttcomm_relayd_index, stream_id)
 180                                 + member_sizeof(struct lttcomm_relayd_index,
 181                                                 stream_id);
 182                 case 1:
 183                         return offsetof(struct lttcomm_relayd_index, packet_seq_num)
 184                                 + member_sizeof(struct lttcomm_relayd_index,
 185                                                 packet_seq_num);
 186                 default:
 187                         abort();
 188                 }
 189         }
 190         abort();
 191 }
 192
 193 /*
 194  * Create session in 2.4 adds additionnal parameters for live reading.
 195  */
 196 struct lttcomm_relayd_create_session_2_4 {
 197         char session_name[RELAYD_COMM_LTTNG_NAME_MAX_2_4];
 198         char hostname[RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4];
 199         uint32_t live_timer;
 200         uint32_t snapshot;
 201 } LTTNG_PACKED;
 202
 203 struct lttcomm_relayd_create_session_2_11 {
 204         uint32_t session_name_len;
 205         uint32_t hostname_len;
 206         uint32_t live_timer;
 207         uint8_t snapshot;
 208         /* Contains the session_name and hostname */
 209         char names[];
 210 } LTTNG_PACKED;
 211
 212 /*
 213  * Used to ask the relay to reset the metadata trace file (regeneration).
 214  * Send the new version of the metadata (starts at 0).
 215  */
 216 struct lttcomm_relayd_reset_metadata {
 217         uint64_t stream_id;
 218         uint64_t version;
 219 } LTTNG_PACKED;
 220
 221 struct lttcomm_relayd_rotate_stream {
 222         uint64_t stream_id;
 223         /* Ignored for metadata streams. */
 224         uint64_t rotate_at_seq_num;
 225         uint64_t new_chunk_id;
 226         /* Includes trailing NULL. */
 227         uint32_t pathname_length;
 228         /* Must be the last member of this structure. */
 229         char new_pathname[];
 230 } LTTNG_PACKED;
 231
 232 struct lttcomm_relayd_rotate_rename {
 233         uint32_t old_path_length;
 234         uint32_t new_path_length;
 235         /* Concatenation of the old and new paths, separated by \0. */
 236         char paths[];
 237 } LTTNG_PACKED;
 238
 239 struct lttcomm_relayd_rotate_pending {
 240         uint64_t chunk_id;
 241 } LTTNG_PACKED;
 242
 243 struct lttcomm_relayd_rotate_pending_reply {
 244         struct lttcomm_relayd_generic_reply generic;
 245         /* Valid values are [0, 1]. */
 246         uint8_t is_pending;
 247 } LTTNG_PACKED;
 248
 249 struct lttcomm_relayd_mkdir {
 250         /* Includes trailing NULL */
 251         uint32_t length;
 252         char path[];
 253 } LTTNG_PACKED;
 254
 255 #endif  /* _RELAYD_COMM */