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         char names[];
  93 } LTTNG_PACKED;
  94
  95 /*
  96  * Answer from an add stream command.
  97  */
  98 struct lttcomm_relayd_status_stream {
  99         uint64_t handle;
 100         uint32_t ret_code;
 101 } LTTNG_PACKED;
 102
 103 /*
 104  * Used to return command code for command not needing special data.
 105  */
 106 struct lttcomm_relayd_generic_reply {
 107         uint32_t ret_code;
 108 } LTTNG_PACKED;
 109
 110 /*
 111  * Version command.
 112  */
 113 struct lttcomm_relayd_version {
 114         uint32_t major;
 115         uint32_t minor;
 116 } LTTNG_PACKED;
 117
 118 /*
 119  * Metadata payload used when metadata command is sent.
 120  */
 121 struct lttcomm_relayd_metadata_payload {
 122         uint64_t stream_id;
 123         uint32_t padding_size;
 124         char payload[];
 125 } LTTNG_PACKED;
 126
 127 /*
 128  * Used to indicate that a specific stream id can now be closed.
 129  */
 130 struct lttcomm_relayd_close_stream {
 131         uint64_t stream_id;
 132         uint64_t last_net_seq_num;      /* sequence number of last packet */
 133 } LTTNG_PACKED;
 134
 135 /*
 136  * Used to test if for a given stream id the data is pending on the relayd side
 137  * for reading.
 138  */
 139 struct lttcomm_relayd_data_pending {
 140         uint64_t stream_id;
 141         uint64_t last_net_seq_num; /* Sequence number of the last packet */
 142 } LTTNG_PACKED;
 143
 144 struct lttcomm_relayd_begin_data_pending {
 145         uint64_t session_id;
 146 } LTTNG_PACKED;
 147
 148 struct lttcomm_relayd_end_data_pending {
 149         uint64_t session_id;
 150 } LTTNG_PACKED;
 151
 152 struct lttcomm_relayd_quiescent_control {
 153         uint64_t stream_id;
 154 } LTTNG_PACKED;
 155
 156 /*
 157  * Index data.
 158  */
 159 struct lttcomm_relayd_index {
 160         uint64_t relay_stream_id;
 161         uint64_t net_seq_num;
 162         uint64_t packet_size;
 163         uint64_t content_size;
 164         uint64_t timestamp_begin;
 165         uint64_t timestamp_end;
 166         uint64_t events_discarded;
 167         uint64_t stream_id;
 168         /* 2.8+ */
 169         uint64_t stream_instance_id;
 170         uint64_t packet_seq_num;
 171 } LTTNG_PACKED;
 172
 173 static inline size_t lttcomm_relayd_index_len(uint32_t major, uint32_t minor)
 174 {
 175         if (major == 1) {
 176                 switch (minor) {
 177                 case 0:
 178                         return offsetof(struct lttcomm_relayd_index, stream_id)
 179                                 + member_sizeof(struct lttcomm_relayd_index,
 180                                                 stream_id);
 181                 case 1:
 182                         return offsetof(struct lttcomm_relayd_index, packet_seq_num)
 183                                 + member_sizeof(struct lttcomm_relayd_index,
 184                                                 packet_seq_num);
 185                 default:
 186                         abort();
 187                 }
 188         }
 189         abort();
 190 }
 191
 192 /*
 193  * Create session in 2.4 adds additionnal parameters for live reading.
 194  */
 195 struct lttcomm_relayd_create_session_2_4 {
 196         char session_name[RELAYD_COMM_LTTNG_NAME_MAX_2_4];
 197         char hostname[RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4];
 198         uint32_t live_timer;
 199         uint32_t snapshot;
 200 } LTTNG_PACKED;
 201
 202 struct lttcomm_relayd_create_session_2_11 {
 203         uint32_t session_name_len;
 204         uint32_t hostname_len;
 205         uint32_t live_timer;
 206         uint8_t snapshot;
 207         /* Contains the session_name and hostname */
 208         char names[];
 209 } LTTNG_PACKED;
 210
 211 /*
 212  * Used to ask the relay to reset the metadata trace file (regeneration).
 213  * Send the new version of the metadata (starts at 0).
 214  */
 215 struct lttcomm_relayd_reset_metadata {
 216         uint64_t stream_id;
 217         uint64_t version;
 218 } LTTNG_PACKED;
 219
 220 struct lttcomm_relayd_rotate_stream {
 221         uint64_t stream_id;
 222         /* Ignored for metadata streams. */
 223         uint64_t rotate_at_seq_num;
 224         uint64_t new_chunk_id;
 225         /* Includes trailing NULL. */
 226         uint32_t pathname_length;
 227         /* Must be the last member of this structure. */
 228         char new_pathname[];
 229 } LTTNG_PACKED;
 230
 231 struct lttcomm_relayd_rotate_rename {
 232         uint32_t old_path_length;
 233         uint32_t new_path_length;
 234         /* Concatenation of the old and new paths, separated by \0. */
 235         char paths[];
 236 } LTTNG_PACKED;
 237
 238 struct lttcomm_relayd_rotate_pending {
 239         uint64_t chunk_id;
 240 } LTTNG_PACKED;
 241
 242 struct lttcomm_relayd_rotate_pending_reply {
 243         struct lttcomm_relayd_generic_reply generic;
 244         /* Valid values are [0, 1]. */
 245         uint8_t is_pending;
 246 } LTTNG_PACKED;
 247
 248 struct lttcomm_relayd_mkdir {
 249         /* Includes trailing NULL */
 250         uint32_t length;
 251         char path[];
 252 } LTTNG_PACKED;
 253
 254 #endif  /* _RELAYD_COMM */