Print this page
Try versioning as a new state
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/lib/varpd/svp/common/libvarpd_svp.h
+++ new/usr/src/lib/varpd/svp/common/libvarpd_svp.h
1 1 /*
2 2 * This file and its contents are supplied under the terms of the
3 3 * Common Development and Distribution License ("CDDL"), version 1.0.
4 4 * You may only use this file in accordance with the terms of version
5 5 * 1.0 of the CDDL.
6 6 *
7 7 * A full copy of the text of the CDDL should have accompanied this
8 8 * source. A copy of the CDDL is also available via the Internet at
9 9 * http://www.illumos.org/license/CDDL.
10 10 */
11 11
12 12 /*
13 13 * Copyright 2018 Joyent, Inc.
14 14 */
15 15
16 16 #ifndef _LIBVARPD_SVP_H
17 17 #define _LIBVARPD_SVP_H
18 18
19 19 /*
20 20 * Implementation details of the SVP plugin and the SVP protocol.
21 21 */
22 22
23 23 #include <netinet/in.h>
24 24 #include <sys/ethernet.h>
25 25 #include <thread.h>
26 26 #include <synch.h>
27 27 #include <libvarpd_provider.h>
28 28 #include <sys/avl.h>
29 29 #include <port.h>
30 30 #include <sys/list.h>
31 31 #include <bunyan.h>
32 32
33 33 #include <libvarpd_svp_prot.h>
34 34
35 35 #ifdef __cplusplus
36 36 extern "C" {
37 37 #endif
38 38
39 39 typedef struct svp svp_t;
40 40 typedef struct svp_remote svp_remote_t;
41 41 typedef struct svp_conn svp_conn_t;
42 42 typedef struct svp_query svp_query_t;
43 43
44 44 typedef void (*svp_event_f)(port_event_t *, void *);
45 45
46 46 typedef struct svp_event {
47 47 svp_event_f se_func;
48 48 void *se_arg;
49 49 int se_events;
50 50 } svp_event_t;
51 51
52 52 typedef void (*svp_timer_f)(void *);
53 53
54 54 typedef struct svp_timer {
55 55 svp_timer_f st_func; /* Timer callback function */
56 56 void *st_arg; /* Timer callback arg */
57 57 boolean_t st_oneshot; /* Is timer a one shot? */
58 58 uint32_t st_value; /* periodic or one-shot time */
59 59 /* Fields below here are private to the svp_timer implementaiton */
60 60 uint64_t st_expire; /* Next expiration */
61 61 boolean_t st_delivering; /* Are we currently delivering this */
62 62 avl_node_t st_link;
63 63 } svp_timer_t;
64 64
65 65 /*
66 66 * Note, both the svp_log_ack_t and svp_lrm_req_t are not part of this structure
67 67 * as they are rather variable sized data and we don't want to constrain their
68 68 * size. Instead, the rdata and wdata members must be set appropriately.
69 69 */
70 70 typedef union svp_query_data {
71 71 svp_vl2_req_t sqd_vl2r;
72 72 svp_vl2_ack_t sqd_vl2a;
73 73 svp_vl3_req_t sdq_vl3r;
74 74 svp_vl3_ack_t sdq_vl3a;
75 75 svp_log_req_t sdq_logr;
76 76 svp_lrm_ack_t sdq_lrma;
77 77 svp_route_req_t sqd_rr;
78 78 svp_route_ack_t sqd_ra;
79 79 } svp_query_data_t;
80 80
81 81 typedef void (*svp_query_f)(svp_query_t *, void *);
82 82
83 83 typedef enum svp_query_state {
84 84 SVP_QUERY_INIT = 0x00,
85 85 SVP_QUERY_WRITING = 0x01,
86 86 SVP_QUERY_READING = 0x02,
87 87 SVP_QUERY_FINISHED = 0x03
88 88 } svp_query_state_t;
89 89
90 90 /*
91 91 * The query structure is usable for all forms of svp queries that end up
92 92 * getting passed across. Right now it's optimized for the fixed size data
93 93 * requests as opposed to requests whose responses will always be streaming in
94 94 * nature. Though, the streaming requests are the less common ones we have. We
95 95 * may need to make additional changes for those.
96 96 */
97 97 struct svp_query {
98 98 list_node_t sq_lnode; /* List entry */
99 99 svp_query_f sq_func; /* Callback function */
100 100 svp_query_state_t sq_state; /* Query state */
101 101 void *sq_arg; /* Callback function arg */
102 102 svp_t *sq_svp; /* Pointer back to svp_t */
103 103 svp_req_t sq_header; /* Header for the query */
104 104 svp_query_data_t sq_rdun; /* Union for read data */
105 105 svp_query_data_t sq_wdun; /* Union for write data */
106 106 svp_status_t sq_status; /* Query response status */
107 107 size_t sq_size; /* Query response size */
108 108 void *sq_rdata; /* Read data pointer */
109 109 size_t sq_rsize; /* Read data size */
110 110 void *sq_wdata; /* Write data pointer */
|
↓ open down ↓ |
110 lines elided |
↑ open up ↑ |
111 111 size_t sq_wsize; /* Write data size */
112 112 hrtime_t sq_acttime; /* Last I/O activity time */
113 113 };
114 114
115 115 typedef enum svp_conn_state {
116 116 SVP_CS_ERROR = 0x00,
117 117 SVP_CS_INITIAL = 0x01,
118 118 SVP_CS_CONNECTING = 0x02,
119 119 SVP_CS_BACKOFF = 0x03,
120 120 SVP_CS_ACTIVE = 0x04,
121 - SVP_CS_WINDDOWN = 0x05
121 + SVP_CS_WINDDOWN = 0x05,
122 + SVP_CS_VERSIONING = 0x06
122 123 } svp_conn_state_t;
123 124
124 125 typedef enum svp_conn_error {
125 126 SVP_CE_NONE = 0x00,
126 127 SVP_CE_ASSOCIATE = 0x01,
127 128 SVP_CE_NOPOLLOUT = 0x02,
128 129 SVP_CE_SOCKET = 0x03,
129 130 SVP_CE_VERSION_PONG = 0x04
130 131 } svp_conn_error_t;
131 132
132 133 typedef enum svp_conn_flags {
133 134 SVP_CF_ADDED = 0x01,
134 135 SVP_CF_DEGRADED = 0x02,
135 136 SVP_CF_REAP = 0x04,
136 137 SVP_CF_TEARDOWN = 0x08,
137 138 SVP_CF_UFLAG = 0x0c,
138 139 SVP_CF_USER = 0x10
139 140 } svp_conn_flags_t;
140 141
141 142 typedef struct svp_conn_out {
142 143 svp_query_t *sco_query;
143 144 size_t sco_offset;
144 145 } svp_conn_out_t;
145 146
146 147 typedef struct svp_conn_in {
147 148 svp_query_t *sci_query;
148 149 svp_req_t sci_req;
149 150 size_t sci_offset;
150 151 } svp_conn_in_t;
151 152
152 153 struct svp_conn {
153 154 svp_remote_t *sc_remote; /* RO */
154 155 struct in6_addr sc_addr; /* RO */
155 156 list_node_t sc_rlist; /* svp_remote_t`sr_lock */
156 157 mutex_t sc_lock;
157 158 svp_event_t sc_event;
158 159 svp_timer_t sc_btimer;
159 160 svp_timer_t sc_qtimer;
160 161 int sc_socket;
161 162 uint_t sc_gen;
162 163 uint_t sc_nbackoff;
163 164 svp_conn_flags_t sc_flags;
164 165 svp_conn_state_t sc_cstate;
165 166 svp_conn_error_t sc_error;
166 167 int sc_errno;
167 168 list_t sc_queries;
168 169 svp_conn_out_t sc_output;
169 170 svp_conn_in_t sc_input;
170 171 uint_t sc_version;
171 172 };
172 173
173 174 typedef enum svp_remote_state {
174 175 SVP_RS_LOOKUP_SCHEDULED = 0x01, /* On the DNS Queue */
175 176 SVP_RS_LOOKUP_INPROGRESS = 0x02, /* Doing a DNS lookup */
176 177 SVP_RS_LOOKUP_VALID = 0x04 /* addrinfo valid */
177 178 } svp_remote_state_t;
178 179
179 180 /*
180 181 * These series of bit-based flags should be ordered such that the most severe
181 182 * is first. We only can set one message that user land can see, so if more than
182 183 * one is set we want to make sure that one is there.
183 184 */
184 185 typedef enum svp_degrade_state {
185 186 SVP_RD_DNS_FAIL = 0x01, /* DNS Resolution Failure */
186 187 SVP_RD_REMOTE_FAIL = 0x02, /* cannot reach any remote peers */
187 188 SVP_RD_ALL = 0x03 /* Only suitable for restore */
188 189 } svp_degrade_state_t;
189 190
190 191 typedef enum svp_shootdown_flags {
191 192 SVP_SD_RUNNING = 0x01,
192 193 SVP_SD_QUIESCE = 0x02,
193 194 SVP_SD_DORM = 0x04
194 195 } svp_shootdown_flags_t;
195 196
196 197 /*
197 198 * There is a single svp_sdlog_t per svp_remote_t. It maintains its own lock and
198 199 * condition variables. See the big theory statement for more information on how
199 200 * it's used.
200 201 */
201 202 typedef struct svp_sdlog {
202 203 mutex_t sdl_lock;
203 204 cond_t sdl_cond;
204 205 uint_t sdl_ref;
205 206 svp_timer_t sdl_timer;
206 207 svp_shootdown_flags_t sdl_flags;
207 208 svp_query_t sdl_query;
208 209 void *sdl_logack;
209 210 void *sdl_logrm;
210 211 void *sdl_remote;
211 212 } svp_sdlog_t;
212 213
213 214 struct svp_remote {
214 215 char *sr_hostname; /* RO */
215 216 uint16_t sr_rport; /* RO */
216 217 struct in6_addr sr_uip; /* RO */
217 218 avl_node_t sr_gnode; /* svp_remote_lock */
218 219 svp_remote_t *sr_nexthost; /* svp_host_lock */
219 220 mutex_t sr_lock;
220 221 cond_t sr_cond;
221 222 svp_remote_state_t sr_state;
222 223 svp_degrade_state_t sr_degrade;
223 224 struct addrinfo *sr_addrinfo;
224 225 avl_tree_t sr_tree;
225 226 uint_t sr_count; /* active count */
226 227 uint_t sr_gen;
227 228 uint_t sr_tconns; /* total conns + dconns */
228 229 uint_t sr_ndconns; /* number of degraded conns */
229 230 list_t sr_conns; /* all conns */
230 231 svp_sdlog_t sr_shoot;
231 232 };
232 233
233 234 /*
234 235 * We have a bunch of different things that we get back from the API at the
235 236 * plug-in layer. These include:
236 237 *
237 238 * o OOB Shootdowns
238 239 * o VL3->VL2 Lookups
239 240 * o VL2->UL3 Lookups
240 241 * o VL2 Log invalidations
241 242 * o VL3 Log injections
242 243 */
243 244 typedef void (*svp_vl2_lookup_f)(svp_t *, svp_status_t, const struct in6_addr *,
244 245 const uint16_t, void *);
245 246 typedef void (*svp_vl3_lookup_f)(svp_t *, svp_status_t, const uint8_t *,
246 247 const struct in6_addr *, const uint16_t, void *);
247 248 typedef void (*svp_vl2_invalidation_f)(svp_t *, const uint8_t *);
248 249 typedef void (*svp_vl3_inject_f)(svp_t *, const uint16_t,
249 250 const struct in6_addr *, const uint8_t *, const uint8_t *);
250 251 typedef void (*svp_shootdown_f)(svp_t *, const uint8_t *,
251 252 const struct in6_addr *, const uint16_t uport);
252 253 typedef void (*svp_route_lookup_f)(svp_t *, svp_status_t, uint32_t, uint32_t,
253 254 uint16_t, uint8_t *, uint8_t *, uint16_t, uint8_t *, uint8_t, uint8_t,
254 255 void *);
255 256
256 257 typedef struct svp_cb {
257 258 svp_vl2_lookup_f scb_vl2_lookup;
258 259 svp_vl3_lookup_f scb_vl3_lookup;
259 260 svp_vl2_invalidation_f scb_vl2_invalidate;
260 261 svp_vl3_inject_f scb_vl3_inject;
261 262 svp_shootdown_f scb_shootdown;
262 263 svp_route_lookup_f scb_route_lookup;
263 264 } svp_cb_t;
264 265
265 266 /*
266 267 * Core implementation structure.
267 268 */
268 269 struct svp {
269 270 overlay_plugin_dest_t svp_dest; /* RO */
270 271 varpd_provider_handle_t *svp_hdl; /* RO */
271 272 svp_cb_t svp_cb; /* RO */
272 273 uint64_t svp_vid; /* RO */
273 274 avl_node_t svp_rlink; /* Owned by svp_remote */
274 275 svp_remote_t *svp_remote; /* RO iff started */
275 276 mutex_t svp_lock;
276 277 char *svp_host; /* svp_lock */
277 278 uint16_t svp_port; /* svp_lock */
278 279 uint16_t svp_uport; /* svp_lock */
279 280 uint32_t svp_dcid; /* svp_lock (but write-once?) */
280 281 boolean_t svp_huip; /* svp_lock */
281 282 struct in6_addr svp_uip; /* svp_lock */
282 283 /* NOTE: lower-3 bytes are 0s. */
283 284 uint8_t svp_router_oui[6]; /* svp_lock (but write-once?) */
284 285 };
285 286
286 287 extern bunyan_logger_t *svp_bunyan;
287 288
288 289 extern int svp_remote_find(char *, uint16_t, struct in6_addr *,
289 290 svp_remote_t **);
290 291 extern int svp_remote_attach(svp_remote_t *, svp_t *);
291 292 extern void svp_remote_detach(svp_t *);
292 293 extern void svp_remote_release(svp_remote_t *);
293 294 extern void svp_remote_vl3_lookup(svp_t *, svp_query_t *,
294 295 const struct sockaddr *, void *);
295 296 extern void svp_remote_vl2_lookup(svp_t *, svp_query_t *, const uint8_t *,
296 297 void *);
297 298 extern void svp_remote_route_lookup(svp_t *, svp_query_t *,
298 299 const struct in6_addr *, const struct in6_addr *, uint32_t,
299 300 uint16_t, void *);
300 301
301 302
302 303 /*
303 304 * Init functions
304 305 */
305 306 extern int svp_remote_init(void);
306 307 extern void svp_remote_fini(void);
307 308 extern int svp_event_init(void);
308 309 extern int svp_event_timer_init(svp_event_t *);
309 310 extern void svp_event_fini(void);
310 311 extern int svp_host_init(void);
311 312 extern int svp_timer_init(void);
312 313
313 314 /*
314 315 * Timers
315 316 */
316 317 extern int svp_tickrate;
317 318 extern void svp_timer_add(svp_timer_t *);
318 319 extern void svp_timer_remove(svp_timer_t *);
319 320
320 321 /*
321 322 * Event loop management
322 323 */
323 324 extern int svp_event_associate(svp_event_t *, int);
324 325 extern int svp_event_dissociate(svp_event_t *, int);
325 326 extern int svp_event_inject(svp_event_t *);
326 327
327 328 /*
328 329 * Connection manager
329 330 */
330 331 extern int svp_conn_create(svp_remote_t *, const struct in6_addr *);
331 332 extern void svp_conn_destroy(svp_conn_t *);
332 333 extern void svp_conn_fallout(svp_conn_t *);
333 334 extern void svp_conn_queue(svp_conn_t *, svp_query_t *);
334 335
335 336 /*
336 337 * FMA related
337 338 */
338 339 extern void svp_remote_degrade(svp_remote_t *, svp_degrade_state_t);
339 340 extern void svp_remote_restore(svp_remote_t *, svp_degrade_state_t);
|
↓ open down ↓ |
208 lines elided |
↑ open up ↑ |
340 341
341 342 /*
342 343 * Misc.
343 344 */
344 345 extern int svp_comparator(const void *, const void *);
345 346 extern void svp_remote_reassign(svp_remote_t *, svp_conn_t *);
346 347 extern void svp_remote_resolved(svp_remote_t *, struct addrinfo *);
347 348 extern void svp_host_queue(svp_remote_t *);
348 349 extern void svp_query_release(svp_query_t *);
349 350 extern void svp_query_crc32(svp_req_t *, void *, size_t);
351 +extern id_t svp_id_alloc(void);
350 352
351 353 /*
352 354 * Shootdown related
353 355 */
354 356 extern void svp_remote_shootdown_vl3(svp_remote_t *, svp_log_vl3_t *,
355 357 svp_sdlog_t *);
356 358 extern void svp_remote_shootdown_vl2(svp_remote_t *, svp_log_vl2_t *);
357 359 extern void svp_remote_log_request(svp_remote_t *, svp_query_t *, void *,
358 360 size_t);
359 361 extern void svp_remote_lrm_request(svp_remote_t *, svp_query_t *, void *,
360 362 size_t);
361 363 extern void svp_shootdown_logr_cb(svp_remote_t *, svp_status_t, void *, size_t);
362 364 extern void svp_shootdown_lrm_cb(svp_remote_t *, svp_status_t);
363 365 extern void svp_shootdown_vl3_cb(svp_status_t, svp_log_vl3_t *, svp_sdlog_t *);
364 366 extern int svp_shootdown_init(svp_remote_t *);
365 367 extern void svp_shootdown_fini(svp_remote_t *);
366 368 extern void svp_shootdown_start(svp_remote_t *);
367 369
368 370 #ifdef __cplusplus
369 371 }
370 372 #endif
371 373
372 374 #endif /* _LIBVARPD_SVP_H */
|
↓ open down ↓ |
13 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX