Print this page
Version bump SVP to 2
| 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 */
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,
|
↓ open down ↓ |
117 lines elided |
↑ open up ↑ |
118 118 SVP_CS_CONNECTING = 0x02,
119 119 SVP_CS_BACKOFF = 0x03,
120 120 SVP_CS_ACTIVE = 0x04,
121 121 SVP_CS_WINDDOWN = 0x05
122 122 } svp_conn_state_t;
123 123
124 124 typedef enum svp_conn_error {
125 125 SVP_CE_NONE = 0x00,
126 126 SVP_CE_ASSOCIATE = 0x01,
127 127 SVP_CE_NOPOLLOUT = 0x02,
128 - SVP_CE_SOCKET = 0x03
128 + SVP_CE_SOCKET = 0x03,
129 + SVP_CE_VERSION_PONG = 0x04
129 130 } svp_conn_error_t;
130 131
131 132 typedef enum svp_conn_flags {
132 133 SVP_CF_ADDED = 0x01,
133 134 SVP_CF_DEGRADED = 0x02,
134 135 SVP_CF_REAP = 0x04,
135 136 SVP_CF_TEARDOWN = 0x08,
136 137 SVP_CF_UFLAG = 0x0c,
137 138 SVP_CF_USER = 0x10
138 139 } svp_conn_flags_t;
139 140
140 141 typedef struct svp_conn_out {
141 142 svp_query_t *sco_query;
142 143 size_t sco_offset;
143 144 } svp_conn_out_t;
144 145
145 146 typedef struct svp_conn_in {
146 147 svp_query_t *sci_query;
147 148 svp_req_t sci_req;
148 149 size_t sci_offset;
149 150 } svp_conn_in_t;
150 151
151 152 struct svp_conn {
152 153 svp_remote_t *sc_remote; /* RO */
153 154 struct in6_addr sc_addr; /* RO */
154 155 list_node_t sc_rlist; /* svp_remote_t`sr_lock */
155 156 mutex_t sc_lock;
156 157 svp_event_t sc_event;
157 158 svp_timer_t sc_btimer;
158 159 svp_timer_t sc_qtimer;
|
↓ open down ↓ |
20 lines elided |
↑ open up ↑ |
159 160 int sc_socket;
160 161 uint_t sc_gen;
161 162 uint_t sc_nbackoff;
162 163 svp_conn_flags_t sc_flags;
163 164 svp_conn_state_t sc_cstate;
164 165 svp_conn_error_t sc_error;
165 166 int sc_errno;
166 167 list_t sc_queries;
167 168 svp_conn_out_t sc_output;
168 169 svp_conn_in_t sc_input;
170 + uint_t sc_version;
169 171 };
170 172
171 173 typedef enum svp_remote_state {
172 174 SVP_RS_LOOKUP_SCHEDULED = 0x01, /* On the DNS Queue */
173 175 SVP_RS_LOOKUP_INPROGRESS = 0x02, /* Doing a DNS lookup */
174 176 SVP_RS_LOOKUP_VALID = 0x04 /* addrinfo valid */
175 177 } svp_remote_state_t;
176 178
177 179 /*
178 180 * These series of bit-based flags should be ordered such that the most severe
179 181 * is first. We only can set one message that user land can see, so if more than
180 182 * one is set we want to make sure that one is there.
181 183 */
182 184 typedef enum svp_degrade_state {
183 185 SVP_RD_DNS_FAIL = 0x01, /* DNS Resolution Failure */
184 186 SVP_RD_REMOTE_FAIL = 0x02, /* cannot reach any remote peers */
185 187 SVP_RD_ALL = 0x03 /* Only suitable for restore */
186 188 } svp_degrade_state_t;
187 189
188 190 typedef enum svp_shootdown_flags {
189 191 SVP_SD_RUNNING = 0x01,
190 192 SVP_SD_QUIESCE = 0x02,
191 193 SVP_SD_DORM = 0x04
192 194 } svp_shootdown_flags_t;
193 195
194 196 /*
195 197 * There is a single svp_sdlog_t per svp_remote_t. It maintains its own lock and
196 198 * condition variables. See the big theory statement for more information on how
197 199 * it's used.
198 200 */
199 201 typedef struct svp_sdlog {
200 202 mutex_t sdl_lock;
201 203 cond_t sdl_cond;
202 204 uint_t sdl_ref;
203 205 svp_timer_t sdl_timer;
204 206 svp_shootdown_flags_t sdl_flags;
205 207 svp_query_t sdl_query;
206 208 void *sdl_logack;
207 209 void *sdl_logrm;
208 210 void *sdl_remote;
209 211 } svp_sdlog_t;
210 212
211 213 struct svp_remote {
212 214 char *sr_hostname; /* RO */
213 215 uint16_t sr_rport; /* RO */
214 216 struct in6_addr sr_uip; /* RO */
215 217 avl_node_t sr_gnode; /* svp_remote_lock */
216 218 svp_remote_t *sr_nexthost; /* svp_host_lock */
217 219 mutex_t sr_lock;
218 220 cond_t sr_cond;
219 221 svp_remote_state_t sr_state;
220 222 svp_degrade_state_t sr_degrade;
221 223 struct addrinfo *sr_addrinfo;
222 224 avl_tree_t sr_tree;
223 225 uint_t sr_count; /* active count */
224 226 uint_t sr_gen;
225 227 uint_t sr_tconns; /* total conns + dconns */
226 228 uint_t sr_ndconns; /* number of degraded conns */
227 229 list_t sr_conns; /* all conns */
228 230 svp_sdlog_t sr_shoot;
229 231 };
230 232
231 233 /*
232 234 * We have a bunch of different things that we get back from the API at the
233 235 * plug-in layer. These include:
234 236 *
235 237 * o OOB Shootdowns
236 238 * o VL3->VL2 Lookups
237 239 * o VL2->UL3 Lookups
238 240 * o VL2 Log invalidations
239 241 * o VL3 Log injections
240 242 */
241 243 typedef void (*svp_vl2_lookup_f)(svp_t *, svp_status_t, const struct in6_addr *,
242 244 const uint16_t, void *);
243 245 typedef void (*svp_vl3_lookup_f)(svp_t *, svp_status_t, const uint8_t *,
244 246 const struct in6_addr *, const uint16_t, void *);
245 247 typedef void (*svp_vl2_invalidation_f)(svp_t *, const uint8_t *);
246 248 typedef void (*svp_vl3_inject_f)(svp_t *, const uint16_t,
247 249 const struct in6_addr *, const uint8_t *, const uint8_t *);
248 250 typedef void (*svp_shootdown_f)(svp_t *, const uint8_t *,
249 251 const struct in6_addr *, const uint16_t uport);
250 252 typedef void (*svp_route_lookup_f)(svp_t *, svp_status_t, uint32_t, uint32_t,
251 253 uint16_t, uint8_t *, uint8_t *, uint16_t, uint8_t *, uint8_t, uint8_t,
252 254 void *);
253 255
254 256 typedef struct svp_cb {
255 257 svp_vl2_lookup_f scb_vl2_lookup;
256 258 svp_vl3_lookup_f scb_vl3_lookup;
257 259 svp_vl2_invalidation_f scb_vl2_invalidate;
258 260 svp_vl3_inject_f scb_vl3_inject;
259 261 svp_shootdown_f scb_shootdown;
260 262 svp_route_lookup_f scb_route_lookup;
261 263 } svp_cb_t;
262 264
263 265 /*
264 266 * Core implementation structure.
265 267 */
266 268 struct svp {
267 269 overlay_plugin_dest_t svp_dest; /* RO */
268 270 varpd_provider_handle_t *svp_hdl; /* RO */
269 271 svp_cb_t svp_cb; /* RO */
270 272 uint64_t svp_vid; /* RO */
271 273 avl_node_t svp_rlink; /* Owned by svp_remote */
272 274 svp_remote_t *svp_remote; /* RO iff started */
273 275 mutex_t svp_lock;
274 276 char *svp_host; /* svp_lock */
275 277 uint16_t svp_port; /* svp_lock */
276 278 uint16_t svp_uport; /* svp_lock */
277 279 uint32_t svp_dcid; /* svp_lock (but write-once?) */
278 280 boolean_t svp_huip; /* svp_lock */
279 281 struct in6_addr svp_uip; /* svp_lock */
280 282 /* NOTE: lower-3 bytes are 0s. */
281 283 uint8_t svp_router_oui[6]; /* svp_lock (but write-once?) */
282 284 };
283 285
284 286 extern bunyan_logger_t *svp_bunyan;
285 287
286 288 extern int svp_remote_find(char *, uint16_t, struct in6_addr *,
287 289 svp_remote_t **);
288 290 extern int svp_remote_attach(svp_remote_t *, svp_t *);
289 291 extern void svp_remote_detach(svp_t *);
290 292 extern void svp_remote_release(svp_remote_t *);
291 293 extern void svp_remote_vl3_lookup(svp_t *, svp_query_t *,
292 294 const struct sockaddr *, void *);
293 295 extern void svp_remote_vl2_lookup(svp_t *, svp_query_t *, const uint8_t *,
294 296 void *);
295 297 extern void svp_remote_route_lookup(svp_t *, svp_query_t *,
296 298 const struct in6_addr *, const struct in6_addr *, uint32_t,
297 299 uint16_t, void *);
298 300
299 301
300 302 /*
301 303 * Init functions
302 304 */
303 305 extern int svp_remote_init(void);
304 306 extern void svp_remote_fini(void);
305 307 extern int svp_event_init(void);
306 308 extern int svp_event_timer_init(svp_event_t *);
307 309 extern void svp_event_fini(void);
308 310 extern int svp_host_init(void);
309 311 extern int svp_timer_init(void);
310 312
311 313 /*
312 314 * Timers
313 315 */
314 316 extern int svp_tickrate;
315 317 extern void svp_timer_add(svp_timer_t *);
316 318 extern void svp_timer_remove(svp_timer_t *);
317 319
318 320 /*
319 321 * Event loop management
320 322 */
321 323 extern int svp_event_associate(svp_event_t *, int);
322 324 extern int svp_event_dissociate(svp_event_t *, int);
323 325 extern int svp_event_inject(svp_event_t *);
324 326
325 327 /*
326 328 * Connection manager
327 329 */
328 330 extern int svp_conn_create(svp_remote_t *, const struct in6_addr *);
329 331 extern void svp_conn_destroy(svp_conn_t *);
330 332 extern void svp_conn_fallout(svp_conn_t *);
331 333 extern void svp_conn_queue(svp_conn_t *, svp_query_t *);
332 334
333 335 /*
334 336 * FMA related
335 337 */
336 338 extern void svp_remote_degrade(svp_remote_t *, svp_degrade_state_t);
337 339 extern void svp_remote_restore(svp_remote_t *, svp_degrade_state_t);
338 340
339 341 /*
340 342 * Misc.
341 343 */
342 344 extern int svp_comparator(const void *, const void *);
343 345 extern void svp_remote_reassign(svp_remote_t *, svp_conn_t *);
344 346 extern void svp_remote_resolved(svp_remote_t *, struct addrinfo *);
345 347 extern void svp_host_queue(svp_remote_t *);
346 348 extern void svp_query_release(svp_query_t *);
347 349 extern void svp_query_crc32(svp_req_t *, void *, size_t);
348 350
349 351 /*
350 352 * Shootdown related
351 353 */
352 354 extern void svp_remote_shootdown_vl3(svp_remote_t *, svp_log_vl3_t *,
353 355 svp_sdlog_t *);
354 356 extern void svp_remote_shootdown_vl2(svp_remote_t *, svp_log_vl2_t *);
355 357 extern void svp_remote_log_request(svp_remote_t *, svp_query_t *, void *,
356 358 size_t);
357 359 extern void svp_remote_lrm_request(svp_remote_t *, svp_query_t *, void *,
358 360 size_t);
359 361 extern void svp_shootdown_logr_cb(svp_remote_t *, svp_status_t, void *, size_t);
360 362 extern void svp_shootdown_lrm_cb(svp_remote_t *, svp_status_t);
361 363 extern void svp_shootdown_vl3_cb(svp_status_t, svp_log_vl3_t *, svp_sdlog_t *);
362 364 extern int svp_shootdown_init(svp_remote_t *);
363 365 extern void svp_shootdown_fini(svp_remote_t *);
364 366 extern void svp_shootdown_start(svp_remote_t *);
365 367
366 368 #ifdef __cplusplus
367 369 }
368 370 #endif
369 371
370 372 #endif /* _LIBVARPD_SVP_H */
|
↓ open down ↓ |
192 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX