ctdb/include/ctdb_protocol.h

   1 /*
   2    ctdb database library
   3
   4    Copyright (C) Andrew Tridgell  2006
   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 _CTDB_PROTOCOL_H
  21 #define _CTDB_PROTOCOL_H
  22
  23 #include <sys/socket.h>
  24 #include "protocol/protocol.h"
  25
  26 /* define ctdb port number */
  27 #define CTDB_PORT 4379
  28
  29 /* we must align packets to ensure ctdb works on all architectures (eg. sparc) */
  30 #define CTDB_DS_ALIGNMENT 8
  31
  32 /*
  33   structure passed to a ctdb call backend function
  34 */
  35 struct ctdb_call_info {
  36         TDB_DATA key;          /* record key */
  37         struct ctdb_ltdb_header *header;
  38         TDB_DATA record_data;  /* current data in the record */
  39         TDB_DATA *new_data;    /* optionally updated record data */
  40         TDB_DATA *call_data;   /* optionally passed from caller */
  41         TDB_DATA *reply_data;  /* optionally returned by function */
  42         uint32_t status;       /* optional reply status - defaults to zero */
  43 };
  44
  45 /*
  46   ctdb flags
  47 */
  48 #define CTDB_FLAG_TORTURE      (1<<1)
  49
  50 struct ctdb_script_list_old {
  51         uint32_t num_scripts;
  52         struct ctdb_script scripts[1];
  53 };
  54
  55 /* Mapping from enum to names. */
  56 extern const char *ctdb_eventscript_call_names[];
  57
  58 /*
  59   packet structures
  60 */
  61 struct ctdb_req_call_old {
  62         struct ctdb_req_header hdr;
  63         uint32_t flags;
  64         uint32_t db_id;
  65         uint32_t callid;
  66         uint32_t hopcount;
  67         uint32_t keylen;
  68         uint32_t calldatalen;
  69         uint8_t data[1]; /* key[] followed by calldata[] */
  70 };
  71
  72 struct ctdb_reply_call_old {
  73         struct ctdb_req_header hdr;
  74         uint32_t status;
  75         uint32_t datalen;
  76         uint8_t  data[1];
  77 };
  78
  79 struct ctdb_reply_error_old {
  80         struct ctdb_req_header hdr;
  81         uint32_t status;
  82         uint32_t msglen;
  83         uint8_t  msg[1];
  84 };
  85
  86 struct ctdb_req_dmaster_old {
  87         struct ctdb_req_header hdr;
  88         uint32_t db_id;
  89         uint64_t rsn;
  90         uint32_t dmaster;
  91         uint32_t keylen;
  92         uint32_t datalen;
  93         uint8_t  data[1];
  94 };
  95
  96 struct ctdb_reply_dmaster_old {
  97         struct ctdb_req_header hdr;
  98         uint32_t db_id;
  99         uint64_t rsn;
 100         uint32_t keylen;
 101         uint32_t datalen;
 102         uint8_t  data[1];
 103 };
 104
 105 struct ctdb_req_message_old {
 106         struct ctdb_req_header hdr;
 107         uint64_t srvid;
 108         uint32_t datalen;
 109         uint8_t data[1];
 110 };
 111
 112 struct ctdb_req_control_old {
 113         struct ctdb_req_header hdr;
 114         uint32_t opcode;
 115         uint32_t pad;
 116         uint64_t srvid;
 117         uint32_t client_id;
 118         uint32_t flags;
 119         uint32_t datalen;
 120         uint8_t data[1];
 121 };
 122
 123 struct ctdb_reply_control_old {
 124         struct ctdb_req_header hdr;
 125         int32_t  status;
 126         uint32_t datalen;
 127         uint32_t errorlen;
 128         uint8_t data[1];
 129 };
 130
 131 struct ctdb_req_keepalive_old {
 132         struct ctdb_req_header hdr;
 133         uint32_t version;
 134         uint32_t uptime;
 135 };
 136
 137 /*
 138    Structure used for a nodemap.
 139    The nodemap is the structure containing a list of all nodes
 140    known to the cluster and their associated flags.
 141 */
 142 struct ctdb_node_map_old {
 143         uint32_t num;
 144         struct ctdb_node_and_flags nodes[1];
 145 };
 146
 147 struct ctdb_public_ip_list_old {
 148         uint32_t num;
 149         struct ctdb_public_ip ips[1];
 150 };
 151
 152 /*
 153   structure used to pass record data between the child and parent
 154  */
 155 struct ctdb_rec_data_old {
 156         uint32_t length;
 157         uint32_t reqid;
 158         uint32_t keylen;
 159         uint32_t datalen;
 160         uint8_t  data[1];
 161 };
 162
 163 /*
 164  * wire format for statistics history
 165  */
 166 struct ctdb_statistics_list_old {
 167         uint32_t num;
 168         struct ctdb_statistics stats[1];
 169 };
 170
 171 /*
 172  * db statistics
 173  */
 174 struct ctdb_db_statistics_old {
 175         struct {
 176                 uint32_t num_calls;
 177                 uint32_t num_current;
 178                 uint32_t num_pending;
 179                 uint32_t num_failed;
 180                 struct ctdb_latency_counter latency;
 181                 uint32_t buckets[MAX_COUNT_BUCKETS];
 182         } locks;
 183         struct {
 184                 struct ctdb_latency_counter latency;
 185         } vacuum;
 186         uint32_t db_ro_delegations;
 187         uint32_t db_ro_revokes;
 188         uint32_t hop_count_bucket[MAX_COUNT_BUCKETS];
 189         uint32_t num_hot_keys;
 190         struct {
 191                 uint32_t count;
 192                 TDB_DATA key;
 193         } hot_keys[MAX_HOT_KEYS];
 194         char hot_keys_wire[1];
 195 };
 196
 197 /*
 198    a wire representation of the vnn map
 199  */
 200 struct ctdb_vnn_map_wire {
 201         uint32_t generation;
 202         uint32_t size;
 203         uint32_t map[1];
 204 };
 205
 206 struct ctdb_notify_data_old {
 207         uint64_t srvid;
 208         uint32_t len;
 209         uint8_t notify_data[1];
 210 };
 211
 212 /* table that contains a list of all dbids on a node
 213  */
 214 struct ctdb_dbid_map_old {
 215         uint32_t num;
 216         struct ctdb_dbid dbs[1];
 217 };
 218
 219 /* the list of tcp tickles used by get/set tcp tickle list */
 220 struct ctdb_tickle_list_old {
 221         ctdb_sock_addr addr;
 222         uint32_t num;
 223         struct ctdb_connection connections[1];
 224 };
 225
 226 /*
 227   struct holding a ctdb_sock_addr and an interface name,
 228   used to add/remove public addresses and grat arp
 229  */
 230 struct ctdb_addr_info_old {
 231         ctdb_sock_addr addr;
 232         uint32_t mask;
 233         uint32_t len;
 234         char iface[1];
 235 };
 236
 237 /* structure used for sending lists of records */
 238 struct ctdb_marshall_buffer {
 239         uint32_t db_id;
 240         uint32_t count;
 241         uint8_t data[1];
 242 };
 243
 244 /*
 245   structure for setting a tunable
 246  */
 247 struct ctdb_tunable_old {
 248         uint32_t value;
 249         uint32_t length;
 250         uint8_t  name[1];
 251 };
 252
 253 /*
 254   structure for getting a tunable
 255  */
 256 struct ctdb_control_get_tunable {
 257         uint32_t length;
 258         uint8_t  name[1];
 259 };
 260
 261 /*
 262   structure for listing tunables
 263  */
 264 struct ctdb_control_list_tunable {
 265         uint32_t length;
 266         /* returns a : separated list of tunable names */
 267         uint8_t  data[1];
 268 };
 269
 270
 271 struct ctdb_public_ip_info_old {
 272         struct ctdb_public_ip ip;
 273         uint32_t active_idx;
 274         uint32_t num;
 275         struct ctdb_iface ifaces[1];
 276 };
 277
 278 struct ctdb_iface_list_old {
 279         uint32_t num;
 280         struct ctdb_iface ifaces[1];
 281 };
 282
 283 /**
 284  * structure to pass to a schedule_for_deletion_control
 285  */
 286 struct ctdb_control_schedule_for_deletion {
 287         uint32_t db_id;
 288         struct ctdb_ltdb_header hdr;
 289         uint32_t keylen;
 290         uint8_t key[1]; /* key[] */
 291 };
 292
 293 #endif