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 #define _GNU_SOURCE
  23
  24 #include <limits.h>
  25 #include <stdint.h>
  26
  27 #include <lttng/lttng.h>
  28 #include <common/defaults.h>
  29 #include <config.h>
  30
  31 #define RELAYD_VERSION_COMM_MAJOR             VERSION_MAJOR
  32 #define RELAYD_VERSION_COMM_MINOR             VERSION_MINOR
  33
  34 /*
  35  * lttng-relayd communication header.
  36  */
  37 struct lttcomm_relayd_hdr {
  38         /* Circuit ID not used for now so always ignored */
  39         uint64_t circuit_id;
  40         uint64_t data_size;             /* data size following this header */
  41         uint32_t cmd;                   /* enum lttcomm_relayd_command */
  42         uint32_t cmd_version;   /* command version */
  43 } LTTNG_PACKED;
  44
  45 /*
  46  * lttng-relayd data header.
  47  */
  48 struct lttcomm_relayd_data_hdr {
  49         /* Circuit ID not used for now so always ignored */
  50         uint64_t circuit_id;
  51         uint64_t stream_id;     /* Stream ID known by the relayd */
  52         uint64_t net_seq_num;   /* Network sequence number, per stream. */
  53         uint32_t data_size;     /* data size following this header */
  54         uint32_t padding_size;  /* Size of 0 padding the data */
  55 } LTTNG_PACKED;
  56
  57 /*
  58  * Reply from a create session command.
  59  */
  60 struct lttcomm_relayd_status_session {
  61         uint64_t session_id;
  62         uint32_t ret_code;
  63 } LTTNG_PACKED;
  64
  65 /*
  66  * Used to add a stream on the relay daemon.
  67  */
  68 struct lttcomm_relayd_add_stream {
  69         char channel_name[DEFAULT_STREAM_NAME_LEN];
  70         char pathname[PATH_MAX];
  71 } LTTNG_PACKED;
  72
  73 /*
  74  * Used to add a stream on the relay daemon.
  75  * Protocol version 2.2
  76  */
  77 struct lttcomm_relayd_add_stream_2_2 {
  78         char channel_name[DEFAULT_STREAM_NAME_LEN];
  79         char pathname[PATH_MAX];
  80         uint64_t tracefile_size;
  81         uint64_t tracefile_count;
  82 } LTTNG_PACKED;
  83
  84 /*
  85  * Answer from an add stream command.
  86  */
  87 struct lttcomm_relayd_status_stream {
  88         uint64_t handle;
  89         uint32_t ret_code;
  90 } LTTNG_PACKED;
  91
  92 /*
  93  * Used to return command code for command not needing special data.
  94  */
  95 struct lttcomm_relayd_generic_reply {
  96         uint32_t ret_code;
  97 } LTTNG_PACKED;
  98
  99 /*
 100  * Used to update synchronization information.
 101  */
 102 struct lttcomm_relayd_update_sync_info {
 103         /* TODO: fill the structure. Feature not implemented yet */
 104 } LTTNG_PACKED;
 105
 106 /*
 107  * Version command.
 108  */
 109 struct lttcomm_relayd_version {
 110         uint32_t major;
 111         uint32_t minor;
 112 } LTTNG_PACKED;
 113
 114 /*
 115  * Metadata payload used when metadata command is sent.
 116  */
 117 struct lttcomm_relayd_metadata_payload {
 118         uint64_t stream_id;
 119         uint32_t padding_size;
 120         char payload[];
 121 } LTTNG_PACKED;
 122
 123 /*
 124  * Used to indicate that a specific stream id can now be closed.
 125  */
 126 struct lttcomm_relayd_close_stream {
 127         uint64_t stream_id;
 128         uint64_t last_net_seq_num;      /* sequence number of last packet */
 129 } LTTNG_PACKED;
 130
 131 /*
 132  * Used to test if for a given stream id the data is pending on the relayd side
 133  * for reading.
 134  */
 135 struct lttcomm_relayd_data_pending {
 136         uint64_t stream_id;
 137         uint64_t last_net_seq_num; /* Sequence number of the last packet */
 138 } LTTNG_PACKED;
 139
 140 struct lttcomm_relayd_begin_data_pending {
 141         uint64_t session_id;
 142 } LTTNG_PACKED;
 143
 144 struct lttcomm_relayd_end_data_pending {
 145         uint64_t session_id;
 146 } LTTNG_PACKED;
 147
 148 struct lttcomm_relayd_quiescent_control {
 149         uint64_t stream_id;
 150 } LTTNG_PACKED;
 151
 152 #endif  /* _RELAYD_COMM */