ctdb/protocol/protocol_private.h

   1 /*
   2    CTDB protocol marshalling
   3
   4    Copyright (C) Amitay Isaacs  2015
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef __PROTOCOL_PRIVATE_H__
  21 #define __PROTOCOL_PRIVATE_H__
  22
  23 #include "protocol.h"
  24
  25 /*
  26  * From protocol/protocol_basic.c
  27  */
  28
  29 size_t ctdb_uint8_len(uint8_t *in);
  30 void ctdb_uint8_push(uint8_t *in, uint8_t *buf, size_t *npush);
  31 int ctdb_uint8_pull(uint8_t *buf, size_t buflen, uint8_t *out, size_t *npull);
  32
  33 size_t ctdb_uint16_len(uint16_t *in);
  34 void ctdb_uint16_push(uint16_t *in, uint8_t *buf, size_t *npush);
  35 int ctdb_uint16_pull(uint8_t *buf, size_t buflen, uint16_t *out,
  36                      size_t *npull);
  37
  38 size_t ctdb_int32_len(int32_t *in);
  39 void ctdb_int32_push(int32_t *in, uint8_t *buf, size_t *npush);
  40 int ctdb_int32_pull(uint8_t *buf, size_t buflen, int32_t *out, size_t *npull);
  41
  42 size_t ctdb_uint32_len(uint32_t *in);
  43 void ctdb_uint32_push(uint32_t *in, uint8_t *buf, size_t *npush);
  44 int ctdb_uint32_pull(uint8_t *buf, size_t buflen, uint32_t *out,
  45                      size_t *npull);
  46
  47 size_t ctdb_uint64_len(uint64_t *in);
  48 void ctdb_uint64_push(uint64_t *in, uint8_t *buf, size_t *npush);
  49 int ctdb_uint64_pull(uint8_t *buf, size_t buflen, uint64_t *out,
  50                      size_t *npull);
  51
  52 size_t ctdb_double_len(double *in);
  53 void ctdb_double_push(double *in, uint8_t *buf, size_t *npush);
  54 int ctdb_double_pull(uint8_t *buf, size_t buflen, double *out, size_t *npull);
  55
  56 size_t ctdb_bool_len(bool *in);
  57 void ctdb_bool_push(bool *in, uint8_t *buf, size_t *npush);
  58 int ctdb_bool_pull(uint8_t *buf, size_t buflen, bool *out, size_t *npull);
  59
  60 size_t ctdb_chararray_len(char *in, size_t len);
  61 void ctdb_chararray_push(char *in, size_t len, uint8_t *buf, size_t *npush);
  62 int ctdb_chararray_pull(uint8_t *buf, size_t buflen, char *out, size_t len,
  63                         size_t *npull);
  64
  65 size_t ctdb_string_len(const char **in);
  66 void ctdb_string_push(const char **in, uint8_t *buf, size_t *npush);
  67 int ctdb_string_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  68                      const char **out, size_t *npull);
  69
  70 size_t ctdb_stringn_len(const char **in);
  71 void ctdb_stringn_push(const char **in, uint8_t *buf, size_t *npush);
  72 int ctdb_stringn_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  73                       const char **out, size_t *npull);
  74
  75 size_t ctdb_pid_len(pid_t *in);
  76 void ctdb_pid_push(pid_t *in, uint8_t *buf, size_t *npush);
  77 int ctdb_pid_pull(uint8_t *buf, size_t buflen, pid_t *out, size_t *npull);
  78
  79 size_t ctdb_timeval_len(struct timeval *in);
  80 void ctdb_timeval_push(struct timeval *in, uint8_t *buf, size_t *npush);
  81 int ctdb_timeval_pull(uint8_t *buf, size_t buflen, struct timeval *out,
  82                       size_t *npull);
  83
  84 size_t ctdb_padding_len(int count);
  85 void ctdb_padding_push(int count, uint8_t *buf, size_t *npush);
  86 int ctdb_padding_pull(uint8_t *buf, size_t buflen, int count, size_t *npull);
  87
  88 /*
  89  * From protocol/protocol_types.c
  90  */
  91
  92 size_t ctdb_tdb_data_len(TDB_DATA *in);
  93 void ctdb_tdb_data_push(TDB_DATA *in, uint8_t *buf, size_t *npush);
  94 int ctdb_tdb_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  95                        TDB_DATA *out, size_t *npull);
  96
  97 size_t ctdb_tdb_datan_len(TDB_DATA *in);
  98 void ctdb_tdb_datan_push(TDB_DATA *in, uint8_t *buf, size_t *npush);
  99 int ctdb_tdb_datan_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 100                         TDB_DATA *out, size_t *npull);
 101
 102 size_t ctdb_latency_counter_len(struct ctdb_latency_counter *in);
 103 void ctdb_latency_counter_push(struct ctdb_latency_counter *in, uint8_t *buf,
 104                                size_t *npush);
 105 int ctdb_latency_counter_pull(uint8_t *buf, size_t buflen,
 106                               struct ctdb_latency_counter *out, size_t *npull);
 107
 108 size_t ctdb_statistics_len(struct ctdb_statistics *in);
 109 void ctdb_statistics_push(struct ctdb_statistics *in, uint8_t *buf,
 110                           size_t *npush);
 111 int ctdb_statistics_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 112                          struct ctdb_statistics **out, size_t *npull);
 113
 114 size_t ctdb_statistics_list_len(struct ctdb_statistics_list *in);
 115 void ctdb_statistics_list_push(struct ctdb_statistics_list *in,
 116                                uint8_t *buf, size_t *npull);
 117 int ctdb_statistics_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 118                               struct ctdb_statistics_list **out,
 119                               size_t *npull);
 120
 121 size_t ctdb_vnn_map_len(struct ctdb_vnn_map *in);
 122 void ctdb_vnn_map_push(struct ctdb_vnn_map *in, uint8_t *buf, size_t *npush);
 123 int ctdb_vnn_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 124                       struct ctdb_vnn_map **out, size_t  *npull);
 125
 126 size_t ctdb_dbid_len(struct ctdb_dbid *in);
 127 void ctdb_dbid_push(struct ctdb_dbid *in, uint8_t *buf, size_t *npush);
 128 int ctdb_dbid_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 129                    struct ctdb_dbid **out, size_t *npull);
 130
 131 size_t ctdb_dbid_map_len(struct ctdb_dbid_map *in);
 132 void ctdb_dbid_map_push(struct ctdb_dbid_map *in, uint8_t *buf,
 133                         size_t *npush);
 134 int ctdb_dbid_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 135                        struct ctdb_dbid_map **out, size_t *npull);
 136
 137 size_t ctdb_pulldb_len(struct ctdb_pulldb *in);
 138 void ctdb_pulldb_push(struct ctdb_pulldb *in, uint8_t *buf, size_t *npush);
 139 int ctdb_pulldb_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 140                      struct ctdb_pulldb **out, size_t *npull);
 141
 142 size_t ctdb_pulldb_ext_len(struct ctdb_pulldb_ext *in);
 143 void ctdb_pulldb_ext_push(struct ctdb_pulldb_ext *in, uint8_t *buf,
 144                           size_t *npush);
 145 int ctdb_pulldb_ext_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 146                          struct ctdb_pulldb_ext **out, size_t *npull);
 147
 148 size_t ctdb_traverse_start_len(struct ctdb_traverse_start *in);
 149 void ctdb_traverse_start_push(struct ctdb_traverse_start *in, uint8_t *buf,
 150                               size_t *npush);
 151 int ctdb_traverse_start_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 152                              struct ctdb_traverse_start **out, size_t *npull);
 153
 154 size_t ctdb_traverse_all_len(struct ctdb_traverse_all *in);
 155 void ctdb_traverse_all_push(struct ctdb_traverse_all *in, uint8_t *buf,
 156                             size_t *npush);
 157 int ctdb_traverse_all_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 158                            struct ctdb_traverse_all **out, size_t *npull);
 159
 160 size_t ctdb_traverse_start_ext_len(struct ctdb_traverse_start_ext *in);
 161 void ctdb_traverse_start_ext_push(struct ctdb_traverse_start_ext *in,
 162                                   uint8_t *buf, size_t *npush);
 163 int ctdb_traverse_start_ext_pull(uint8_t *buf, size_t buflen,
 164                                  TALLOC_CTX *mem_ctx,
 165                                  struct ctdb_traverse_start_ext **out,
 166                                  size_t *npull);
 167
 168 size_t ctdb_traverse_all_ext_len(struct ctdb_traverse_all_ext *in);
 169 void ctdb_traverse_all_ext_push(struct ctdb_traverse_all_ext *in,
 170                                 uint8_t *buf, size_t *npush);
 171 int ctdb_traverse_all_ext_pull(uint8_t *buf, size_t buflen,
 172                                TALLOC_CTX *mem_ctx,
 173                                struct ctdb_traverse_all_ext **out,
 174                                size_t *npull);
 175
 176 size_t ctdb_sock_addr_len(ctdb_sock_addr *in);
 177 void ctdb_sock_addr_push(ctdb_sock_addr *in, uint8_t *buf, size_t *npush);
 178 int ctdb_sock_addr_pull_elems(uint8_t *buf, size_t buflen,
 179                               TALLOC_CTX *mem_ctx, ctdb_sock_addr *out,
 180                               size_t *npull);
 181 int ctdb_sock_addr_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 182                         ctdb_sock_addr **out, size_t *npull);
 183
 184 size_t ctdb_connection_len(struct ctdb_connection *in);
 185 void ctdb_connection_push(struct ctdb_connection *in, uint8_t *buf,
 186                           size_t *npush);
 187 int ctdb_connection_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 188                          struct ctdb_connection **out, size_t *npull);
 189
 190 size_t ctdb_tunable_len(struct ctdb_tunable *in);
 191 void ctdb_tunable_push(struct ctdb_tunable *in, uint8_t *buf, size_t *npush);
 192 int ctdb_tunable_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 193                       struct ctdb_tunable **out, size_t *npull);
 194
 195 size_t ctdb_node_flag_change_len(struct ctdb_node_flag_change *in);
 196 void ctdb_node_flag_change_push(struct ctdb_node_flag_change *in,
 197                                 uint8_t *buf, size_t *npush);
 198 int ctdb_node_flag_change_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 199                                struct ctdb_node_flag_change **out,
 200                                size_t *npull);
 201
 202 size_t ctdb_var_list_len(struct ctdb_var_list *in);
 203 void ctdb_var_list_push(struct ctdb_var_list *in, uint8_t *buf, size_t *npush);
 204 int ctdb_var_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 205                        struct ctdb_var_list **out, size_t *npull);
 206
 207 size_t ctdb_tunable_list_len(struct ctdb_tunable_list *in);
 208 void ctdb_tunable_list_push(struct ctdb_tunable_list *in, uint8_t *buf,
 209                             size_t *npush);
 210 int ctdb_tunable_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 211                            struct ctdb_tunable_list **out, size_t *npull);
 212
 213 size_t ctdb_tickle_list_len(struct ctdb_tickle_list *in);
 214 void ctdb_tickle_list_push(struct ctdb_tickle_list *in, uint8_t *buf,
 215                            size_t *npush);
 216 int ctdb_tickle_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 217                           struct ctdb_tickle_list **out, size_t *npull);
 218
 219 size_t ctdb_addr_info_len(struct ctdb_addr_info *in);
 220 void ctdb_addr_info_push(struct ctdb_addr_info *in, uint8_t *buf,
 221                          size_t *npush);
 222 int ctdb_addr_info_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 223                         struct ctdb_addr_info **out, size_t *npull);
 224
 225 size_t ctdb_transdb_len(struct ctdb_transdb *in);
 226 void ctdb_transdb_push(struct ctdb_transdb *in, uint8_t *buf, size_t *npush);
 227 int ctdb_transdb_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 228                      struct ctdb_transdb **out, size_t *npull);
 229
 230 size_t ctdb_uptime_len(struct ctdb_uptime *in);
 231 void ctdb_uptime_push(struct ctdb_uptime *in, uint8_t *buf, size_t *npush);
 232 int ctdb_uptime_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 233                      struct ctdb_uptime **out, size_t *npull);
 234
 235 size_t ctdb_public_ip_len(struct ctdb_public_ip *in);
 236 void ctdb_public_ip_push(struct ctdb_public_ip *in, uint8_t *buf,
 237                          size_t *npush);
 238 int ctdb_public_ip_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 239                         struct ctdb_public_ip **out, size_t *npull);
 240
 241 size_t ctdb_public_ip_list_len(struct ctdb_public_ip_list *in);
 242 void ctdb_public_ip_list_push(struct ctdb_public_ip_list *in, uint8_t *buf,
 243                               size_t *npush);
 244 int ctdb_public_ip_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 245                              struct ctdb_public_ip_list **out, size_t *npull);
 246
 247 size_t ctdb_node_and_flags_len(struct ctdb_node_and_flags *in);
 248 void ctdb_node_and_flags_push(struct ctdb_node_and_flags *in, uint8_t *buf,
 249                               size_t *npush);
 250 int ctdb_node_and_flags_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 251                              struct ctdb_node_and_flags **out, size_t *npull);
 252
 253 size_t ctdb_node_map_len(struct ctdb_node_map *in);
 254 void ctdb_node_map_push(struct ctdb_node_map *in, uint8_t *buf, size_t *npush);
 255 int ctdb_node_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 256                        struct ctdb_node_map **out, size_t *npull);
 257
 258 size_t ctdb_script_len(struct ctdb_script *in);
 259 void ctdb_script_push(struct ctdb_script *in, uint8_t *buf, size_t *npush);
 260 int ctdb_script_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 261                      struct ctdb_script **out, size_t *npull);
 262
 263 size_t ctdb_script_list_len(struct ctdb_script_list *in);
 264 void ctdb_script_list_push(struct ctdb_script_list *in, uint8_t *buf,
 265                            size_t *npush);
 266 int ctdb_script_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 267                           struct ctdb_script_list **out, size_t *npull);
 268
 269 size_t ctdb_ban_state_len(struct ctdb_ban_state *in);
 270 void ctdb_ban_state_push(struct ctdb_ban_state *in, uint8_t *buf,
 271                          size_t *npush);
 272 int ctdb_ban_state_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 273                         struct ctdb_ban_state **out, size_t *npull);
 274
 275 size_t ctdb_notify_data_len(struct ctdb_notify_data *in);
 276 void ctdb_notify_data_push(struct ctdb_notify_data *in, uint8_t *buf,
 277                            size_t *npush);
 278 int ctdb_notify_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 279                           struct ctdb_notify_data **out, size_t *npull);
 280
 281 size_t ctdb_iface_len(struct ctdb_iface *in);
 282 void ctdb_iface_push(struct ctdb_iface *in, uint8_t *buf, size_t *npush);
 283 int ctdb_iface_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 284                     struct ctdb_iface **out, size_t *npull);
 285
 286 size_t ctdb_iface_list_len(struct ctdb_iface_list *in);
 287 void ctdb_iface_list_push(struct ctdb_iface_list *in, uint8_t *buf,
 288                           size_t *npush);
 289 int ctdb_iface_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 290                          struct ctdb_iface_list **out, size_t *npull);
 291
 292 size_t ctdb_public_ip_info_len(struct ctdb_public_ip_info *in);
 293 void ctdb_public_ip_info_push(struct ctdb_public_ip_info *in, uint8_t *buf,
 294                               size_t *npush);
 295 int ctdb_public_ip_info_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 296                              struct ctdb_public_ip_info **out, size_t *npull);
 297
 298 size_t ctdb_key_data_len(struct ctdb_key_data *key);
 299 void ctdb_key_data_push(struct ctdb_key_data *key, uint8_t *buf);
 300 int ctdb_key_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 301                        struct ctdb_key_data **out);
 302
 303 size_t ctdb_db_statistics_len(struct ctdb_db_statistics *dbstats);
 304 void ctdb_db_statistics_push(struct ctdb_db_statistics *dbstats, void *buf);
 305 int ctdb_db_statistics_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 306                             struct ctdb_db_statistics **out);
 307
 308 size_t ctdb_election_message_len(struct ctdb_election_message *election);
 309 void ctdb_election_message_push(struct ctdb_election_message *election,
 310                                 uint8_t *buf);
 311 int ctdb_election_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 312                                struct ctdb_election_message **out);
 313
 314 size_t ctdb_srvid_message_len(struct ctdb_srvid_message *msg);
 315 void ctdb_srvid_message_push(struct ctdb_srvid_message *msg, uint8_t *buf);
 316 int ctdb_srvid_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 317                             struct ctdb_srvid_message **out);
 318
 319 size_t ctdb_disable_message_len(struct ctdb_disable_message *disable);
 320 void ctdb_disable_message_push(struct ctdb_disable_message *disable,
 321                                uint8_t *buf);
 322 int ctdb_disable_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 323                               struct ctdb_disable_message **out);
 324
 325 #endif /* __PROTOCOL_PRIVATE_H__ */