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 #include "protocol_basic.h"
  25
  26 /*
  27  * From protocol/protocol_types.c
  28  */
  29
  30 size_t ctdb_tdb_data_len(TDB_DATA *in);
  31 void ctdb_tdb_data_push(TDB_DATA *in, uint8_t *buf, size_t *npush);
  32 int ctdb_tdb_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  33                        TDB_DATA *out, size_t *npull);
  34
  35 size_t ctdb_tdb_datan_len(TDB_DATA *in);
  36 void ctdb_tdb_datan_push(TDB_DATA *in, uint8_t *buf, size_t *npush);
  37 int ctdb_tdb_datan_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  38                         TDB_DATA *out, size_t *npull);
  39
  40 size_t ctdb_latency_counter_len(struct ctdb_latency_counter *in);
  41 void ctdb_latency_counter_push(struct ctdb_latency_counter *in, uint8_t *buf,
  42                                size_t *npush);
  43 int ctdb_latency_counter_pull(uint8_t *buf, size_t buflen,
  44                               struct ctdb_latency_counter *out, size_t *npull);
  45
  46 size_t ctdb_statistics_len(struct ctdb_statistics *in);
  47 void ctdb_statistics_push(struct ctdb_statistics *in, uint8_t *buf,
  48                           size_t *npush);
  49 int ctdb_statistics_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  50                          struct ctdb_statistics **out, size_t *npull);
  51
  52 size_t ctdb_statistics_list_len(struct ctdb_statistics_list *in);
  53 void ctdb_statistics_list_push(struct ctdb_statistics_list *in,
  54                                uint8_t *buf, size_t *npull);
  55 int ctdb_statistics_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  56                               struct ctdb_statistics_list **out,
  57                               size_t *npull);
  58
  59 size_t ctdb_vnn_map_len(struct ctdb_vnn_map *in);
  60 void ctdb_vnn_map_push(struct ctdb_vnn_map *in, uint8_t *buf, size_t *npush);
  61 int ctdb_vnn_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  62                       struct ctdb_vnn_map **out, size_t  *npull);
  63
  64 size_t ctdb_dbid_len(struct ctdb_dbid *in);
  65 void ctdb_dbid_push(struct ctdb_dbid *in, uint8_t *buf, size_t *npush);
  66 int ctdb_dbid_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  67                    struct ctdb_dbid **out, size_t *npull);
  68
  69 size_t ctdb_dbid_map_len(struct ctdb_dbid_map *in);
  70 void ctdb_dbid_map_push(struct ctdb_dbid_map *in, uint8_t *buf,
  71                         size_t *npush);
  72 int ctdb_dbid_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  73                        struct ctdb_dbid_map **out, size_t *npull);
  74
  75 size_t ctdb_pulldb_len(struct ctdb_pulldb *in);
  76 void ctdb_pulldb_push(struct ctdb_pulldb *in, uint8_t *buf, size_t *npush);
  77 int ctdb_pulldb_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  78                      struct ctdb_pulldb **out, size_t *npull);
  79
  80 size_t ctdb_pulldb_ext_len(struct ctdb_pulldb_ext *in);
  81 void ctdb_pulldb_ext_push(struct ctdb_pulldb_ext *in, uint8_t *buf,
  82                           size_t *npush);
  83 int ctdb_pulldb_ext_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  84                          struct ctdb_pulldb_ext **out, size_t *npull);
  85
  86 size_t ctdb_db_vacuum_len(struct ctdb_db_vacuum *in);
  87 void ctdb_db_vacuum_push(struct ctdb_db_vacuum *in,
  88                          uint8_t *buf,
  89                          size_t *npush);
  90 int ctdb_db_vacuum_pull(uint8_t *buf,
  91                         size_t buflen,
  92                         TALLOC_CTX *mem_ctx,
  93                         struct ctdb_db_vacuum **out,
  94                         size_t *npull);
  95
  96 size_t ctdb_echo_data_len(struct ctdb_echo_data *in);
  97 void ctdb_echo_data_push(struct ctdb_echo_data *in,
  98                          uint8_t *buf,
  99                          size_t *npush);
 100 int ctdb_echo_data_pull(uint8_t *buf,
 101                         size_t buflen,
 102                         TALLOC_CTX *mem_ctx,
 103                         struct ctdb_echo_data **out,
 104                         size_t *npull);
 105
 106 size_t ctdb_traverse_start_len(struct ctdb_traverse_start *in);
 107 void ctdb_traverse_start_push(struct ctdb_traverse_start *in, uint8_t *buf,
 108                               size_t *npush);
 109 int ctdb_traverse_start_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 110                              struct ctdb_traverse_start **out, size_t *npull);
 111
 112 size_t ctdb_traverse_all_len(struct ctdb_traverse_all *in);
 113 void ctdb_traverse_all_push(struct ctdb_traverse_all *in, uint8_t *buf,
 114                             size_t *npush);
 115 int ctdb_traverse_all_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 116                            struct ctdb_traverse_all **out, size_t *npull);
 117
 118 size_t ctdb_traverse_start_ext_len(struct ctdb_traverse_start_ext *in);
 119 void ctdb_traverse_start_ext_push(struct ctdb_traverse_start_ext *in,
 120                                   uint8_t *buf, size_t *npush);
 121 int ctdb_traverse_start_ext_pull(uint8_t *buf, size_t buflen,
 122                                  TALLOC_CTX *mem_ctx,
 123                                  struct ctdb_traverse_start_ext **out,
 124                                  size_t *npull);
 125
 126 size_t ctdb_traverse_all_ext_len(struct ctdb_traverse_all_ext *in);
 127 void ctdb_traverse_all_ext_push(struct ctdb_traverse_all_ext *in,
 128                                 uint8_t *buf, size_t *npush);
 129 int ctdb_traverse_all_ext_pull(uint8_t *buf, size_t buflen,
 130                                TALLOC_CTX *mem_ctx,
 131                                struct ctdb_traverse_all_ext **out,
 132                                size_t *npull);
 133
 134 size_t ctdb_sock_addr_len(ctdb_sock_addr *in);
 135 void ctdb_sock_addr_push(ctdb_sock_addr *in, uint8_t *buf, size_t *npush);
 136 int ctdb_sock_addr_pull_elems(uint8_t *buf, size_t buflen,
 137                               TALLOC_CTX *mem_ctx, ctdb_sock_addr *out,
 138                               size_t *npull);
 139 int ctdb_sock_addr_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 140                         ctdb_sock_addr **out, size_t *npull);
 141
 142 size_t ctdb_connection_len(struct ctdb_connection *in);
 143 void ctdb_connection_push(struct ctdb_connection *in, uint8_t *buf,
 144                           size_t *npush);
 145 int ctdb_connection_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 146                          struct ctdb_connection **out, size_t *npull);
 147
 148 size_t ctdb_connection_list_len(struct ctdb_connection_list *in);
 149 void ctdb_connection_list_push(struct ctdb_connection_list *in, uint8_t *buf,
 150                                size_t *npush);
 151 int ctdb_connection_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 152                               struct ctdb_connection_list **out, size_t *npull);
 153
 154 size_t ctdb_tunable_len(struct ctdb_tunable *in);
 155 void ctdb_tunable_push(struct ctdb_tunable *in, uint8_t *buf, size_t *npush);
 156 int ctdb_tunable_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 157                       struct ctdb_tunable **out, size_t *npull);
 158
 159 size_t ctdb_node_flag_change_len(struct ctdb_node_flag_change *in);
 160 void ctdb_node_flag_change_push(struct ctdb_node_flag_change *in,
 161                                 uint8_t *buf, size_t *npush);
 162 int ctdb_node_flag_change_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 163                                struct ctdb_node_flag_change **out,
 164                                size_t *npull);
 165
 166 size_t ctdb_var_list_len(struct ctdb_var_list *in);
 167 void ctdb_var_list_push(struct ctdb_var_list *in, uint8_t *buf, size_t *npush);
 168 int ctdb_var_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 169                        struct ctdb_var_list **out, size_t *npull);
 170
 171 size_t ctdb_tunable_list_len(struct ctdb_tunable_list *in);
 172 void ctdb_tunable_list_push(struct ctdb_tunable_list *in, uint8_t *buf,
 173                             size_t *npush);
 174 int ctdb_tunable_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 175                            struct ctdb_tunable_list **out, size_t *npull);
 176
 177 size_t ctdb_tickle_list_len(struct ctdb_tickle_list *in);
 178 void ctdb_tickle_list_push(struct ctdb_tickle_list *in, uint8_t *buf,
 179                            size_t *npush);
 180 int ctdb_tickle_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 181                           struct ctdb_tickle_list **out, size_t *npull);
 182
 183 size_t ctdb_addr_info_len(struct ctdb_addr_info *in);
 184 void ctdb_addr_info_push(struct ctdb_addr_info *in, uint8_t *buf,
 185                          size_t *npush);
 186 int ctdb_addr_info_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 187                         struct ctdb_addr_info **out, size_t *npull);
 188
 189 size_t ctdb_transdb_len(struct ctdb_transdb *in);
 190 void ctdb_transdb_push(struct ctdb_transdb *in, uint8_t *buf, size_t *npush);
 191 int ctdb_transdb_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 192                      struct ctdb_transdb **out, size_t *npull);
 193
 194 size_t ctdb_uptime_len(struct ctdb_uptime *in);
 195 void ctdb_uptime_push(struct ctdb_uptime *in, uint8_t *buf, size_t *npush);
 196 int ctdb_uptime_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 197                      struct ctdb_uptime **out, size_t *npull);
 198
 199 size_t ctdb_public_ip_len(struct ctdb_public_ip *in);
 200 void ctdb_public_ip_push(struct ctdb_public_ip *in, uint8_t *buf,
 201                          size_t *npush);
 202 int ctdb_public_ip_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 203                         struct ctdb_public_ip **out, size_t *npull);
 204
 205 size_t ctdb_public_ip_list_len(struct ctdb_public_ip_list *in);
 206 void ctdb_public_ip_list_push(struct ctdb_public_ip_list *in, uint8_t *buf,
 207                               size_t *npush);
 208 int ctdb_public_ip_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 209                              struct ctdb_public_ip_list **out, size_t *npull);
 210
 211 size_t ctdb_node_and_flags_len(struct ctdb_node_and_flags *in);
 212 void ctdb_node_and_flags_push(struct ctdb_node_and_flags *in, uint8_t *buf,
 213                               size_t *npush);
 214 int ctdb_node_and_flags_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 215                              struct ctdb_node_and_flags **out, size_t *npull);
 216
 217 size_t ctdb_node_map_len(struct ctdb_node_map *in);
 218 void ctdb_node_map_push(struct ctdb_node_map *in, uint8_t *buf, size_t *npush);
 219 int ctdb_node_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 220                        struct ctdb_node_map **out, size_t *npull);
 221
 222 size_t ctdb_script_len(struct ctdb_script *in);
 223 void ctdb_script_push(struct ctdb_script *in, uint8_t *buf, size_t *npush);
 224 int ctdb_script_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 225                      struct ctdb_script **out, size_t *npull);
 226
 227 size_t ctdb_script_list_len(struct ctdb_script_list *in);
 228 void ctdb_script_list_push(struct ctdb_script_list *in, uint8_t *buf,
 229                            size_t *npush);
 230 int ctdb_script_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 231                           struct ctdb_script_list **out, size_t *npull);
 232
 233 size_t ctdb_ban_state_len(struct ctdb_ban_state *in);
 234 void ctdb_ban_state_push(struct ctdb_ban_state *in, uint8_t *buf,
 235                          size_t *npush);
 236 int ctdb_ban_state_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 237                         struct ctdb_ban_state **out, size_t *npull);
 238
 239 size_t ctdb_notify_data_len(struct ctdb_notify_data *in);
 240 void ctdb_notify_data_push(struct ctdb_notify_data *in, uint8_t *buf,
 241                            size_t *npush);
 242 int ctdb_notify_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 243                           struct ctdb_notify_data **out, size_t *npull);
 244
 245 size_t ctdb_iface_len(struct ctdb_iface *in);
 246 void ctdb_iface_push(struct ctdb_iface *in, uint8_t *buf, size_t *npush);
 247 int ctdb_iface_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 248                     struct ctdb_iface **out, size_t *npull);
 249
 250 size_t ctdb_iface_list_len(struct ctdb_iface_list *in);
 251 void ctdb_iface_list_push(struct ctdb_iface_list *in, uint8_t *buf,
 252                           size_t *npush);
 253 int ctdb_iface_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 254                          struct ctdb_iface_list **out, size_t *npull);
 255
 256 size_t ctdb_public_ip_info_len(struct ctdb_public_ip_info *in);
 257 void ctdb_public_ip_info_push(struct ctdb_public_ip_info *in, uint8_t *buf,
 258                               size_t *npush);
 259 int ctdb_public_ip_info_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 260                              struct ctdb_public_ip_info **out, size_t *npull);
 261
 262 size_t ctdb_key_data_len(struct ctdb_key_data *in);
 263 void ctdb_key_data_push(struct ctdb_key_data *in, uint8_t *buf, size_t *npush);
 264 int ctdb_key_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 265                        struct ctdb_key_data **out, size_t *npull);
 266
 267 size_t ctdb_db_statistics_len(struct ctdb_db_statistics *in);
 268 void ctdb_db_statistics_push(struct ctdb_db_statistics *in, uint8_t *buf,
 269                              size_t *npush);
 270 int ctdb_db_statistics_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 271                             struct ctdb_db_statistics **out, size_t *npull);
 272
 273 size_t ctdb_pid_srvid_len(struct ctdb_pid_srvid *in);
 274 void ctdb_pid_srvid_push(struct ctdb_pid_srvid *in, uint8_t *buf,
 275                          size_t *npush);
 276 int ctdb_pid_srvid_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 277                         struct ctdb_pid_srvid **out, size_t *npull);
 278
 279 size_t ctdb_election_message_len(struct ctdb_election_message *in);
 280 void ctdb_election_message_push(struct ctdb_election_message *in,
 281                                 uint8_t *buf, size_t *npush);
 282 int ctdb_election_message_pull(uint8_t *buf, size_t buflen,
 283                                TALLOC_CTX *mem_ctx,
 284                                struct ctdb_election_message **out,
 285                                size_t *npull);
 286
 287 size_t ctdb_srvid_message_len(struct ctdb_srvid_message *in);
 288 void ctdb_srvid_message_push(struct ctdb_srvid_message *in, uint8_t *buf,
 289                              size_t *npush);
 290 int ctdb_srvid_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 291                             struct ctdb_srvid_message **out, size_t *npull);
 292
 293 size_t ctdb_disable_message_len(struct ctdb_disable_message *in);
 294 void ctdb_disable_message_push(struct ctdb_disable_message *in, uint8_t *buf,
 295                                size_t *npush);
 296 int ctdb_disable_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 297                               struct ctdb_disable_message **out,
 298                               size_t *npull);
 299
 300 #endif /* __PROTOCOL_PRIVATE_H__ */