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_int32_len(int32_t val);
  30 void ctdb_int32_push(int32_t val, uint8_t *buf);
  31 int ctdb_int32_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  32                     int32_t *out);
  33
  34 size_t ctdb_uint32_len(uint32_t val);
  35 void ctdb_uint32_push(uint32_t val, uint8_t *buf);
  36 int ctdb_uint32_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  37                      uint32_t *out);
  38
  39 size_t ctdb_uint64_len(uint64_t val);
  40 void ctdb_uint64_push(uint64_t val, uint8_t *buf);
  41 int ctdb_uint64_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  42                      uint64_t *out);
  43
  44 size_t ctdb_double_len(double val);
  45 void ctdb_double_push(double val, uint8_t *buf);
  46 int ctdb_double_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  47                      double *out);
  48
  49 size_t ctdb_string_len(const char *str);
  50 void ctdb_string_push(const char *str, uint8_t *buf);
  51 int ctdb_string_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  52                      const char **out);
  53
  54 size_t ctdb_stringn_len(const char *str);
  55 void ctdb_stringn_push(const char *str, uint8_t *buf);
  56 int ctdb_stringn_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  57                       const char **out);
  58
  59 size_t ctdb_pid_len(pid_t pid);
  60 void ctdb_pid_push(pid_t pid, uint8_t *buf);
  61 int ctdb_pid_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  62                   pid_t *out);
  63
  64 /*
  65  * From protocol/protocol_types.c
  66  */
  67
  68 size_t ctdb_statistics_len(struct ctdb_statistics *stats);
  69 void ctdb_statistics_push(struct ctdb_statistics *stats, uint8_t *buf);
  70 int ctdb_statistics_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  71                          struct ctdb_statistics **out);
  72
  73 size_t ctdb_statistics_list_len(struct ctdb_statistics_list *stats_list);
  74 void ctdb_statistics_list_push(struct ctdb_statistics_list *stats_list,
  75                                uint8_t *buf);
  76 int ctdb_statistics_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  77                               struct ctdb_statistics_list **out);
  78
  79 size_t ctdb_vnn_map_len(struct ctdb_vnn_map *vnnmap);
  80 void ctdb_vnn_map_push(struct ctdb_vnn_map *vnnmap, uint8_t *buf);
  81 int ctdb_vnn_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  82                       struct ctdb_vnn_map **out);
  83
  84 size_t ctdb_dbid_map_len(struct ctdb_dbid_map *dbmap);
  85 void ctdb_dbid_map_push(struct ctdb_dbid_map *dbmap, uint8_t *buf);
  86 int ctdb_dbid_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  87                        struct ctdb_dbid_map **out);
  88
  89 size_t ctdb_pulldb_len(struct ctdb_pulldb *pulldb);
  90 void ctdb_pulldb_push(struct ctdb_pulldb *pulldb, uint8_t *buf);
  91 int ctdb_pulldb_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  92                      struct ctdb_pulldb **out);
  93
  94 size_t ctdb_pulldb_ext_len(struct ctdb_pulldb_ext *pulldb);
  95 void ctdb_pulldb_ext_push(struct ctdb_pulldb_ext *pulldb, uint8_t *buf);
  96 int ctdb_pulldb_ext_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
  97                          struct ctdb_pulldb_ext **out);
  98
  99 size_t ctdb_traverse_start_len(struct ctdb_traverse_start *traverse);
 100 void ctdb_traverse_start_push(struct ctdb_traverse_start *traverse,
 101                               uint8_t *buf);
 102 int ctdb_traverse_start_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 103                              struct ctdb_traverse_start **out);
 104
 105 size_t ctdb_traverse_all_len(struct ctdb_traverse_all *traverse);
 106 void ctdb_traverse_all_push(struct ctdb_traverse_all *traverse, uint8_t *buf);
 107 int ctdb_traverse_all_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 108                            struct ctdb_traverse_all **out);
 109
 110 size_t ctdb_traverse_start_ext_len(struct ctdb_traverse_start_ext *traverse);
 111 void ctdb_traverse_start_ext_push(struct ctdb_traverse_start_ext *traverse,
 112                                   uint8_t *buf);
 113 int ctdb_traverse_start_ext_pull(uint8_t *buf, size_t buflen,
 114                                  TALLOC_CTX *mem_ctx,
 115                                  struct ctdb_traverse_start_ext **out);
 116
 117 size_t ctdb_traverse_all_ext_len(struct ctdb_traverse_all_ext *traverse);
 118 void ctdb_traverse_all_ext_push(struct ctdb_traverse_all_ext *traverse,
 119                                 uint8_t *buf);
 120 int ctdb_traverse_all_ext_pull(uint8_t *buf, size_t buflen,
 121                                TALLOC_CTX *mem_ctx,
 122                                struct ctdb_traverse_all_ext **out);
 123
 124 size_t ctdb_sock_addr_len(ctdb_sock_addr *addr);
 125 void ctdb_sock_addr_push(ctdb_sock_addr *addr, uint8_t *buf);
 126 int ctdb_sock_addr_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 127                         ctdb_sock_addr **out);
 128
 129 size_t ctdb_connection_len(struct ctdb_connection *conn);
 130 void ctdb_connection_push(struct ctdb_connection *conn, uint8_t *buf);
 131 int ctdb_connection_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 132                          struct ctdb_connection **out);
 133
 134 size_t ctdb_tunable_len(struct ctdb_tunable *tunable);
 135 void ctdb_tunable_push(struct ctdb_tunable *tunable, uint8_t *buf);
 136 int ctdb_tunable_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 137                       struct ctdb_tunable **out);
 138
 139 size_t ctdb_node_flag_change_len(struct ctdb_node_flag_change *flag_change);
 140 void ctdb_node_flag_change_push(struct ctdb_node_flag_change *flag_change,
 141                                 uint8_t *buf);
 142 int ctdb_node_flag_change_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 143                                struct ctdb_node_flag_change **out);
 144
 145 size_t ctdb_var_list_len(struct ctdb_var_list *var_list);
 146 void ctdb_var_list_push(struct ctdb_var_list *var_list, uint8_t *buf);
 147 int ctdb_var_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 148                        struct ctdb_var_list **out);
 149
 150 size_t ctdb_tunable_list_len(struct ctdb_tunable_list *tun_list);
 151 void ctdb_tunable_list_push(struct ctdb_tunable_list *tun_list, uint8_t *buf);
 152 int ctdb_tunable_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 153                            struct ctdb_tunable_list **out);
 154
 155 size_t ctdb_tickle_list_len(struct ctdb_tickle_list *tickles);
 156 void ctdb_tickle_list_push(struct ctdb_tickle_list *tickles, uint8_t *buf);
 157 int ctdb_tickle_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 158                           struct ctdb_tickle_list **out);
 159
 160 size_t ctdb_addr_info_len(struct ctdb_addr_info *addr_info);
 161 void ctdb_addr_info_push(struct ctdb_addr_info *addr_info, uint8_t *buf);
 162 int ctdb_addr_info_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 163                         struct ctdb_addr_info **out);
 164
 165 size_t ctdb_transdb_len(struct ctdb_transdb *transdb);
 166 void ctdb_transdb_push(struct ctdb_transdb *transdb, uint8_t *buf);
 167 int ctdb_transdb_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 168                      struct ctdb_transdb **out);
 169
 170 size_t ctdb_uptime_len(struct ctdb_uptime *uptime);
 171 void ctdb_uptime_push(struct ctdb_uptime *uptime, uint8_t *buf);
 172 int ctdb_uptime_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 173                      struct ctdb_uptime **out);
 174
 175 size_t ctdb_public_ip_len(struct ctdb_public_ip *public_ip);
 176 void ctdb_public_ip_push(struct ctdb_public_ip *public_ip, uint8_t *buf);
 177 int ctdb_public_ip_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 178                         struct ctdb_public_ip **out);
 179
 180 size_t ctdb_public_ip_list_len(struct ctdb_public_ip_list *pubip_list);
 181 void ctdb_public_ip_list_push(struct ctdb_public_ip_list *pubip_list,
 182                               uint8_t *buf);
 183 int ctdb_public_ip_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 184                              struct ctdb_public_ip_list **out);
 185
 186 size_t ctdb_node_and_flags_len(struct ctdb_node_and_flags *node);
 187 void ctdb_node_and_flags_push(struct ctdb_node_and_flags *node, uint8_t *buf);
 188 int ctdb_node_and_flags_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 189                              struct ctdb_node_and_flags **out);
 190
 191 size_t ctdb_node_map_len(struct ctdb_node_map *nodemap);
 192 void ctdb_node_map_push(struct ctdb_node_map *nodemap, uint8_t *buf);
 193 int ctdb_node_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 194                        struct ctdb_node_map **out);
 195
 196 size_t ctdb_script_len(struct ctdb_script *script);
 197 void ctdb_script_push(struct ctdb_script *script, uint8_t *buf);
 198 int ctdb_script_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 199                      struct ctdb_script **out);
 200
 201 size_t ctdb_script_list_len(struct ctdb_script_list *script_list);
 202 void ctdb_script_list_push(struct ctdb_script_list *script_list, uint8_t *buf);
 203 int ctdb_script_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 204                           struct ctdb_script_list **out);
 205
 206 size_t ctdb_ban_state_len(struct ctdb_ban_state *ban_state);
 207 void ctdb_ban_state_push(struct ctdb_ban_state *ban_state, uint8_t *buf);
 208 int ctdb_ban_state_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 209                         struct ctdb_ban_state **out);
 210
 211 size_t ctdb_notify_data_len(struct ctdb_notify_data *notify);
 212 void ctdb_notify_data_push(struct ctdb_notify_data *notify, uint8_t *buf);
 213 int ctdb_notify_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 214                           struct ctdb_notify_data **out);
 215
 216 size_t ctdb_iface_len(struct ctdb_iface *iface);
 217 void ctdb_iface_push(struct ctdb_iface *iface, uint8_t *buf);
 218 int ctdb_iface_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 219                     struct ctdb_iface **out);
 220
 221 size_t ctdb_iface_list_len(struct ctdb_iface_list *iface_list);
 222 void ctdb_iface_list_push(struct ctdb_iface_list *iface_list, uint8_t *buf);
 223 int ctdb_iface_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 224                          struct ctdb_iface_list **out);
 225
 226 size_t ctdb_public_ip_info_len(struct ctdb_public_ip_info *ipinfo);
 227 void ctdb_public_ip_info_push(struct ctdb_public_ip_info *ipinfo, uint8_t *buf);
 228 int ctdb_public_ip_info_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 229                              struct ctdb_public_ip_info **out);
 230
 231 size_t ctdb_key_data_len(struct ctdb_key_data *key);
 232 void ctdb_key_data_push(struct ctdb_key_data *key, uint8_t *buf);
 233 int ctdb_key_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 234                        struct ctdb_key_data **out);
 235
 236 size_t ctdb_db_statistics_len(struct ctdb_db_statistics *dbstats);
 237 void ctdb_db_statistics_push(struct ctdb_db_statistics *dbstats, void *buf);
 238 int ctdb_db_statistics_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 239                             struct ctdb_db_statistics **out);
 240
 241 size_t ctdb_election_message_len(struct ctdb_election_message *election);
 242 void ctdb_election_message_push(struct ctdb_election_message *election,
 243                                 uint8_t *buf);
 244 int ctdb_election_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 245                                struct ctdb_election_message **out);
 246
 247 size_t ctdb_srvid_message_len(struct ctdb_srvid_message *msg);
 248 void ctdb_srvid_message_push(struct ctdb_srvid_message *msg, uint8_t *buf);
 249 int ctdb_srvid_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 250                             struct ctdb_srvid_message **out);
 251
 252 size_t ctdb_tdb_data_len(TDB_DATA data);
 253 void ctdb_tdb_data_push(TDB_DATA data, uint8_t *buf);
 254 int ctdb_tdb_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 255                        TDB_DATA *out);
 256
 257 size_t ctdb_disable_message_len(struct ctdb_disable_message *disable);
 258 void ctdb_disable_message_push(struct ctdb_disable_message *disable,
 259                                uint8_t *buf);
 260 int ctdb_disable_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
 261                               struct ctdb_disable_message **out);
 262
 263 #endif /* __PROTOCOL_PRIVATE_H__ */