1f50270fd77a0478168695272271f522d62ae517
[vlendec/samba-autobuild/.git] / 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 *stats_list);
115 void ctdb_statistics_list_push(struct ctdb_statistics_list *stats_list,
116                                uint8_t *buf);
117 int ctdb_statistics_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
118                               struct ctdb_statistics_list **out);
119
120 size_t ctdb_vnn_map_len(struct ctdb_vnn_map *in);
121 void ctdb_vnn_map_push(struct ctdb_vnn_map *in, uint8_t *buf, size_t *npush);
122 int ctdb_vnn_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
123                       struct ctdb_vnn_map **out, size_t  *npull);
124
125 size_t ctdb_dbid_len(struct ctdb_dbid *in);
126 void ctdb_dbid_push(struct ctdb_dbid *in, uint8_t *buf, size_t *npush);
127 int ctdb_dbid_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
128                    struct ctdb_dbid **out, size_t *npull);
129
130 size_t ctdb_dbid_map_len(struct ctdb_dbid_map *in);
131 void ctdb_dbid_map_push(struct ctdb_dbid_map *in, uint8_t *buf,
132                         size_t *npush);
133 int ctdb_dbid_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
134                        struct ctdb_dbid_map **out, size_t *npull);
135
136 size_t ctdb_pulldb_len(struct ctdb_pulldb *in);
137 void ctdb_pulldb_push(struct ctdb_pulldb *in, uint8_t *buf, size_t *npush);
138 int ctdb_pulldb_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
139                      struct ctdb_pulldb **out, size_t *npull);
140
141 size_t ctdb_pulldb_ext_len(struct ctdb_pulldb_ext *in);
142 void ctdb_pulldb_ext_push(struct ctdb_pulldb_ext *in, uint8_t *buf,
143                           size_t *npush);
144 int ctdb_pulldb_ext_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
145                          struct ctdb_pulldb_ext **out, size_t *npull);
146
147 size_t ctdb_traverse_start_len(struct ctdb_traverse_start *in);
148 void ctdb_traverse_start_push(struct ctdb_traverse_start *in, uint8_t *buf,
149                               size_t *npush);
150 int ctdb_traverse_start_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
151                              struct ctdb_traverse_start **out, size_t *npull);
152
153 size_t ctdb_traverse_all_len(struct ctdb_traverse_all *in);
154 void ctdb_traverse_all_push(struct ctdb_traverse_all *in, uint8_t *buf,
155                             size_t *npush);
156 int ctdb_traverse_all_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
157                            struct ctdb_traverse_all **out, size_t *npull);
158
159 size_t ctdb_traverse_start_ext_len(struct ctdb_traverse_start_ext *in);
160 void ctdb_traverse_start_ext_push(struct ctdb_traverse_start_ext *in,
161                                   uint8_t *buf, size_t *npush);
162 int ctdb_traverse_start_ext_pull(uint8_t *buf, size_t buflen,
163                                  TALLOC_CTX *mem_ctx,
164                                  struct ctdb_traverse_start_ext **out,
165                                  size_t *npull);
166
167 size_t ctdb_traverse_all_ext_len(struct ctdb_traverse_all_ext *in);
168 void ctdb_traverse_all_ext_push(struct ctdb_traverse_all_ext *in,
169                                 uint8_t *buf, size_t *npush);
170 int ctdb_traverse_all_ext_pull(uint8_t *buf, size_t buflen,
171                                TALLOC_CTX *mem_ctx,
172                                struct ctdb_traverse_all_ext **out,
173                                size_t *npull);
174
175 size_t ctdb_sock_addr_len(ctdb_sock_addr *in);
176 void ctdb_sock_addr_push(ctdb_sock_addr *in, uint8_t *buf, size_t *npush);
177 int ctdb_sock_addr_pull_elems(uint8_t *buf, size_t buflen,
178                               TALLOC_CTX *mem_ctx, ctdb_sock_addr *out,
179                               size_t *npull);
180 int ctdb_sock_addr_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
181                         ctdb_sock_addr **out, size_t *npull);
182
183 size_t ctdb_connection_len(struct ctdb_connection *in);
184 void ctdb_connection_push(struct ctdb_connection *in, uint8_t *buf,
185                           size_t *npush);
186 int ctdb_connection_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
187                          struct ctdb_connection **out, size_t *npull);
188
189 size_t ctdb_tunable_len(struct ctdb_tunable *in);
190 void ctdb_tunable_push(struct ctdb_tunable *in, uint8_t *buf, size_t *npush);
191 int ctdb_tunable_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
192                       struct ctdb_tunable **out, size_t *npull);
193
194 size_t ctdb_node_flag_change_len(struct ctdb_node_flag_change *in);
195 void ctdb_node_flag_change_push(struct ctdb_node_flag_change *in,
196                                 uint8_t *buf, size_t *npush);
197 int ctdb_node_flag_change_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
198                                struct ctdb_node_flag_change **out,
199                                size_t *npull);
200
201 size_t ctdb_var_list_len(struct ctdb_var_list *in);
202 void ctdb_var_list_push(struct ctdb_var_list *in, uint8_t *buf, size_t *npush);
203 int ctdb_var_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
204                        struct ctdb_var_list **out, size_t *npull);
205
206 size_t ctdb_tunable_list_len(struct ctdb_tunable_list *in);
207 void ctdb_tunable_list_push(struct ctdb_tunable_list *in, uint8_t *buf,
208                             size_t *npush);
209 int ctdb_tunable_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
210                            struct ctdb_tunable_list **out, size_t *npull);
211
212 size_t ctdb_tickle_list_len(struct ctdb_tickle_list *in);
213 void ctdb_tickle_list_push(struct ctdb_tickle_list *in, uint8_t *buf,
214                            size_t *npush);
215 int ctdb_tickle_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
216                           struct ctdb_tickle_list **out, size_t *npull);
217
218 size_t ctdb_addr_info_len(struct ctdb_addr_info *in);
219 void ctdb_addr_info_push(struct ctdb_addr_info *in, uint8_t *buf,
220                          size_t *npush);
221 int ctdb_addr_info_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
222                         struct ctdb_addr_info **out, size_t *npull);
223
224 size_t ctdb_transdb_len(struct ctdb_transdb *in);
225 void ctdb_transdb_push(struct ctdb_transdb *in, uint8_t *buf, size_t *npush);
226 int ctdb_transdb_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
227                      struct ctdb_transdb **out, size_t *npull);
228
229 size_t ctdb_uptime_len(struct ctdb_uptime *in);
230 void ctdb_uptime_push(struct ctdb_uptime *in, uint8_t *buf, size_t *npush);
231 int ctdb_uptime_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
232                      struct ctdb_uptime **out, size_t *npull);
233
234 size_t ctdb_public_ip_len(struct ctdb_public_ip *in);
235 void ctdb_public_ip_push(struct ctdb_public_ip *in, uint8_t *buf,
236                          size_t *npush);
237 int ctdb_public_ip_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
238                         struct ctdb_public_ip **out, size_t *npull);
239
240 size_t ctdb_public_ip_list_len(struct ctdb_public_ip_list *in);
241 void ctdb_public_ip_list_push(struct ctdb_public_ip_list *in, uint8_t *buf,
242                               size_t *npush);
243 int ctdb_public_ip_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
244                              struct ctdb_public_ip_list **out, size_t *npull);
245
246 size_t ctdb_node_and_flags_len(struct ctdb_node_and_flags *in);
247 void ctdb_node_and_flags_push(struct ctdb_node_and_flags *in, uint8_t *buf,
248                               size_t *npush);
249 int ctdb_node_and_flags_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
250                              struct ctdb_node_and_flags **out, size_t *npull);
251
252 size_t ctdb_node_map_len(struct ctdb_node_map *in);
253 void ctdb_node_map_push(struct ctdb_node_map *in, uint8_t *buf, size_t *npush);
254 int ctdb_node_map_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
255                        struct ctdb_node_map **out, size_t *npull);
256
257 size_t ctdb_script_len(struct ctdb_script *in);
258 void ctdb_script_push(struct ctdb_script *in, uint8_t *buf, size_t *npush);
259 int ctdb_script_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
260                      struct ctdb_script **out, size_t *npull);
261
262 size_t ctdb_script_list_len(struct ctdb_script_list *in);
263 void ctdb_script_list_push(struct ctdb_script_list *in, uint8_t *buf,
264                            size_t *npush);
265 int ctdb_script_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
266                           struct ctdb_script_list **out, size_t *npull);
267
268 size_t ctdb_ban_state_len(struct ctdb_ban_state *in);
269 void ctdb_ban_state_push(struct ctdb_ban_state *in, uint8_t *buf,
270                          size_t *npush);
271 int ctdb_ban_state_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
272                         struct ctdb_ban_state **out, size_t *npull);
273
274 size_t ctdb_notify_data_len(struct ctdb_notify_data *in);
275 void ctdb_notify_data_push(struct ctdb_notify_data *in, uint8_t *buf,
276                            size_t *npush);
277 int ctdb_notify_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
278                           struct ctdb_notify_data **out, size_t *npull);
279
280 size_t ctdb_iface_len(struct ctdb_iface *in);
281 void ctdb_iface_push(struct ctdb_iface *in, uint8_t *buf, size_t *npush);
282 int ctdb_iface_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
283                     struct ctdb_iface **out, size_t *npull);
284
285 size_t ctdb_iface_list_len(struct ctdb_iface_list *iface_list);
286 void ctdb_iface_list_push(struct ctdb_iface_list *iface_list, uint8_t *buf);
287 int ctdb_iface_list_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
288                          struct ctdb_iface_list **out);
289
290 size_t ctdb_public_ip_info_len(struct ctdb_public_ip_info *ipinfo);
291 void ctdb_public_ip_info_push(struct ctdb_public_ip_info *ipinfo, uint8_t *buf);
292 int ctdb_public_ip_info_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
293                              struct ctdb_public_ip_info **out);
294
295 size_t ctdb_key_data_len(struct ctdb_key_data *key);
296 void ctdb_key_data_push(struct ctdb_key_data *key, uint8_t *buf);
297 int ctdb_key_data_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
298                        struct ctdb_key_data **out);
299
300 size_t ctdb_db_statistics_len(struct ctdb_db_statistics *dbstats);
301 void ctdb_db_statistics_push(struct ctdb_db_statistics *dbstats, void *buf);
302 int ctdb_db_statistics_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
303                             struct ctdb_db_statistics **out);
304
305 size_t ctdb_election_message_len(struct ctdb_election_message *election);
306 void ctdb_election_message_push(struct ctdb_election_message *election,
307                                 uint8_t *buf);
308 int ctdb_election_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
309                                struct ctdb_election_message **out);
310
311 size_t ctdb_srvid_message_len(struct ctdb_srvid_message *msg);
312 void ctdb_srvid_message_push(struct ctdb_srvid_message *msg, uint8_t *buf);
313 int ctdb_srvid_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
314                             struct ctdb_srvid_message **out);
315
316 size_t ctdb_disable_message_len(struct ctdb_disable_message *disable);
317 void ctdb_disable_message_push(struct ctdb_disable_message *disable,
318                                uint8_t *buf);
319 int ctdb_disable_message_pull(uint8_t *buf, size_t buflen, TALLOC_CTX *mem_ctx,
320                               struct ctdb_disable_message **out);
321
322 #endif /* __PROTOCOL_PRIVATE_H__ */