added storage of extended ltdb header information
[vlendec/samba-autobuild/.git] / ctdb / include / ctdb_private.h
1 /* 
2    ctdb database library
3
4    Copyright (C) Andrew Tridgell  2006
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2 of the License, or (at your option) any later version.
10
11    This library 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 GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with this library; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19 */
20
21
22 /*
23   an installed ctdb remote call
24 */
25 struct ctdb_registered_call {
26         struct ctdb_registered_call *next, *prev;
27         uint32_t id;
28         ctdb_fn_t fn;
29 };
30
31 /*
32   this address structure might need to be generalised later for some
33   transports
34 */
35 struct ctdb_address {
36         const char *address;
37         int port;
38 };
39
40 /*
41   state associated with one node
42 */
43 struct ctdb_node {
44         struct ctdb_context *ctdb;
45         struct ctdb_address address;
46         const char *name; /* for debug messages */
47         void *private; /* private to transport */
48         uint32_t vnn;
49 };
50
51 /*
52   transport specific methods
53 */
54 struct ctdb_methods {
55         int (*start)(struct ctdb_context *); /* start protocol processing */    
56         int (*add_node)(struct ctdb_node *); /* setup a new node */     
57         int (*queue_pkt)(struct ctdb_node *, uint8_t *data, uint32_t length);
58 };
59
60 /*
61   transport calls up to the ctdb layer
62 */
63 struct ctdb_upcalls {
64         /* recv_pkt is called when a packet comes in */
65         void (*recv_pkt)(struct ctdb_context *, uint8_t *data, uint32_t length);
66
67         /* node_dead is called when an attempt to send to a node fails */
68         void (*node_dead)(struct ctdb_node *);
69
70         /* node_connected is called when a connection to a node is established */
71         void (*node_connected)(struct ctdb_node *);
72 };
73
74 /* main state of the ctdb daemon */
75 struct ctdb_context {
76         struct event_context *ev;
77         struct ctdb_address address;
78         const char *name;
79         uint32_t vnn; /* our own vnn */
80         uint32_t num_nodes;
81         uint32_t num_connected;
82         unsigned flags;
83         struct idr_context *idr;
84         struct ctdb_node **nodes; /* array of nodes in the cluster - indexed by vnn */
85         struct ctdb_registered_call *calls; /* list of registered calls */
86         char *err_msg;
87         struct tdb_context *ltdb;
88         const struct ctdb_methods *methods; /* transport methods */
89         const struct ctdb_upcalls *upcalls; /* transport upcalls */
90         void *private; /* private to transport */
91 };
92
93 #define CTDB_NO_MEMORY(ctdb, p) do { if (!(p)) { \
94           ctdb_set_error(ctdb, "Out of memory at %s:%d", __FILE__, __LINE__); \
95           return -1; }} while (0)
96
97 #define CTDB_NO_MEMORY_NULL(ctdb, p) do { if (!(p)) { \
98           ctdb_set_error(ctdb, "Out of memory at %s:%d", __FILE__, __LINE__); \
99           return NULL; }} while (0)
100
101 /* arbitrary maximum timeout for ctdb operations */
102 #define CTDB_REQ_TIMEOUT 10
103
104 /*
105   the extended header for records in the ltdb
106 */
107 struct ctdb_ltdb_header {
108         uint64_t rsn;
109         uint32_t dmaster;
110         uint32_t laccessor;
111         uint32_t lacount;
112 };
113
114
115 /*
116   operation IDs
117 */
118 enum ctdb_operation {
119         CTDB_REQ_CALL   = 0,
120         CTDB_REPLY_CALL = 1,
121         CTDB_REPLY_REDIRECT = 2,
122         CTDB_REQ_DMASTER = 3,
123         CTDB_REPLY_DMASTER = 4,
124 };
125
126 /*
127   packet structures
128 */
129 struct ctdb_req_header {
130         uint32_t length;
131         uint32_t operation;
132         uint32_t destnode;
133         uint32_t srcnode;
134         uint32_t reqid;
135 };
136
137 struct ctdb_req_call {
138         struct ctdb_req_header hdr;
139         uint32_t callid;
140         uint32_t keylen;
141         uint32_t calldatalen;
142         uint8_t data[0]; /* key[] followed by calldata[] */
143 };
144
145 struct ctdb_reply_call {
146         struct ctdb_req_header hdr;
147         uint32_t datalen;
148         uint8_t  data[0];
149 };
150
151 /* internal prototypes */
152 void ctdb_set_error(struct ctdb_context *ctdb, const char *fmt, ...);
153 bool ctdb_same_address(struct ctdb_address *a1, struct ctdb_address *a2);
154 int ctdb_parse_address(struct ctdb_context *ctdb,
155                        TALLOC_CTX *mem_ctx, const char *str,
156                        struct ctdb_address *address);
157 uint32_t ctdb_hash(TDB_DATA *key);
158 void ctdb_request_call(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
159 void ctdb_reply_call(struct ctdb_context *ctdb, struct ctdb_req_header *hdr);
160
161 int ctdb_ltdb_fetch(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
162                     TDB_DATA key, struct ctdb_ltdb_header *header, TDB_DATA *data);
163 int ctdb_ltdb_store(struct ctdb_context *ctdb, TDB_DATA key, 
164                     struct ctdb_ltdb_header *header, TDB_DATA data);
165
166