1 /*
2 * This file and its contents are supplied under the terms of the
3 * Common Development and Distribution License ("CDDL"), version 1.0.
4 * You may only use this file in accordance with the terms of version
5 * 1.0 of the CDDL.
6 *
7 * A full copy of the text of the CDDL should have accompanied this
8 * source. A copy of the CDDL is also available via the Internet at
9 * http://www.illumos.org/license/CDDL.
10 */
11
12 /*
13 * Copyright 2018 Joyent, Inc.
14 */
15
16 #ifndef _LIBVARPD_SVP_PROT_H
17 #define _LIBVARPD_SVP_PROT_H
18
19 /*
20 * SVP protocol Definitions
21 */
22
23 #include <sys/types.h>
24 #include <inttypes.h>
25 #include <sys/ethernet.h>
26 #include <netinet/in.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /*
33 * SDC VXLAN Protocol Definitions
34 */
35
36 #define SVP_VERSION_ONE 1
37 #define SVP_VERSION_TWO 2
38 /* XXX KEBE SAYS -- we are not yet ready to bump this. */
39 #define SVP_CURRENT_VERSION SVP_VERSION_ONE
40
41 typedef struct svp_req {
42 uint16_t svp_ver;
43 uint16_t svp_op;
44 uint32_t svp_size;
45 uint32_t svp_id;
46 uint32_t svp_crc32;
47 } svp_req_t;
48
49 typedef enum svp_op {
50 SVP_R_UNKNOWN = 0x00,
51 SVP_R_PING = 0x01,
52 SVP_R_PONG = 0x02,
53 SVP_R_VL2_REQ = 0x03,
54 SVP_R_VL2_ACK = 0x04,
55 SVP_R_VL3_REQ = 0x05,
56 SVP_R_VL3_ACK = 0x06,
57 SVP_R_BULK_REQ = 0x07,
58 SVP_R_BULK_ACK = 0x08,
59 SVP_R_LOG_REQ = 0x09,
60 SVP_R_LOG_ACK = 0x0A,
61 SVP_R_LOG_RM = 0x0B,
62 SVP_R_LOG_RM_ACK = 0x0C,
63 SVP_R_SHOOTDOWN = 0x0D,
64 SVP_R_REMOTE_VL3_REQ = 0x0E,
65 SVP_R_REMOTE_VL3_ACK = 0x0F
66 } svp_op_t;
67
68 typedef enum svp_status {
69 SVP_S_OK = 0x00, /* Everything OK */
70 SVP_S_FATAL = 0x01, /* Fatal error, close connection */
71 SVP_S_NOTFOUND = 0x02, /* Entry not found */
72 SVP_S_BADL3TYPE = 0x03, /* Unknown svp_vl3_type_t */
73 SVP_S_BADBULK = 0x04 /* Unknown svp_bulk_type_t */
74 } svp_status_t;
75
76 /*
77 * A client issues the SVP_R_VL2_REQ whenever it needs to perform a VLS->UL3
78 * lookup. Requests have the following structure:
79 */
80 typedef struct svp_vl2_req {
81 uint8_t sl2r_mac[ETHERADDRL];
82 uint8_t sl2r_pad[2];
83 uint32_t sl2r_vnetid;
84 } svp_vl2_req_t;
85
86 /*
87 * This is the message a server uses to reply to the SVP_R_VL2_REQ. If the
88 * destination on the underlay is an IPv4 address, it should be encoded as an
89 * IPv4-mapped IPv6 address.
90 */
91 typedef struct svp_vl2_ack {
92 uint16_t sl2a_status;
93 uint16_t sl2a_port;
94 uint8_t sl2a_addr[16];
95 } svp_vl2_ack_t;
96
97
98 /*
99 * A client issues the SVP_R_VL3_REQ request whenever it needs to perform a
100 * VL3->VL2 lookup. Note, that this also implicitly performs a VL2->UL3 lookup
101 * as well. The sl3r_type member is used to indicate the kind of lookup type
102 * that we're performing, eg. is it a L3 or L2.
103 */
104 typedef enum svp_vl3_type {
105 SVP_VL3_IP = 0x01,
106 SVP_VL3_IPV6 = 0x02
107 } svp_vl3_type_t;
108
109 typedef struct svp_vl3_req {
110 uint8_t sl3r_ip[16];
111 uint32_t sl3r_type;
112 uint32_t sl3r_vnetid;
113 } svp_vl3_req_t;
114
115 /*
116 * This response, corresponding to the SVP_R_VL3_ACK, includes an answer to both
117 * the VL3->VL2 and the VL2->UL3 requests.
118 */
119 typedef struct svp_vl3_ack {
120 uint32_t sl3a_status;
121 uint8_t sl3a_mac[ETHERADDRL];
122 uint16_t sl3a_uport;
123 uint8_t sl3a_uip[16];
124 } svp_vl3_ack_t;
125
126 /*
127 * A client issues the SVP_R_REMOTE_VL3_REQ for a far-remote (cross-DC) VL3 IP
128 * address. The server may take longer because it may query cross-DC to get
129 * the answer for our response.
130 */
131 typedef struct svp_rvl3_req {
132 uint8_t srl3r_srcip[16];
133 uint8_t srl3r_dstip[16];
134 uint32_t srl3r_type; /* Same as SVP_R_VL3_REQ */
135 uint32_t srl3r_vnetid;
136 uint16_t srl3r_vlan;
137 uint16_t srl3r_pad; /* XXX KEBE ASKS, necessary? */
138 } svp_rvl3_req_t;
139
140 /*
141 * The remote-VL3 response contains more than the regular VL3 one, because
142 * overlay needs to rewrite the MAC header completely.
143 */
144 typedef struct svp_rvl3_ack {
145 uint32_t srl3a_status;
146 uint8_t srl3a_dstmac[ETHERADDRL]; /* MAC of the target. */
147 uint8_t srl3a_srcmac[ETHERADDRL]; /* MAC of the target's rtr */
148 uint16_t srl3a_vlanid;
149 uint16_t srl3a_uport;
150 uint32_t srl3a_dcid; /* Remote Data Center ID. */
151 uint8_t srl3a_uip[16];
152 } svp_rvl3_ack_t;
153
154 /*
155 * SVP_R_BULK_REQ requests a bulk dump of data. Currently we have two kinds of
156 * data tables that we need to dump: VL3->VL2 mappings and VL2->UL3 mappings.
157 * The kind that we want is indicated using the svbr_type member.
158 */
159 typedef enum svp_bulk_type {
160 SVP_BULK_VL2 = 0x01,
161 SVP_BULK_VL3 = 0x02
162 } svp_bulk_type_t;
163
164 typedef struct svp_bulk_req {
165 uint32_t svbr_type;
166 } svp_bulk_req_t;
167
168 /*
169 * When replying to a bulk request (SVP_R_BULK_ACK), data is streamed back
170 * across. The format of the data is currently undefined and as we work on the
171 * system, we'll get a better understanding of what this should look like. A
172 * client may need to stream such a request to disk, or the format will need to
173 * be in a streamable format that allows the client to construct data.
174 */
175 typedef struct svp_bulk_ack {
176 uint32_t svba_status;
177 uint32_t svba_type;
178 uint8_t svba_data[];
179 } svp_bulk_ack_t;
180
181 /*
182 * SVP_R_LOG_REQ requests a log entries from the specified log from the server.
183 * The total number of bytes that the user is ready to receive is in svlr_count.
184 * However, the server should not block for data if none is available and thus
185 * may return less than svlr_count bytes back. We identify the IP address of the
186 * underlay to use here explicitly.
187 */
188 typedef struct svp_log_req {
189 uint32_t svlr_count;
190 uint8_t svlr_ip[16];
191 } svp_log_req_t;
192
193 /*
194 * The server replies to a log request by sending a series of log entries.
195 * These log entries may be a mixture of both vl2 and vl3 records. The reply is
196 * a stream of bytes after the status message whose length is determined baseed
197 * on the header itself. Each entry begins with a uint32_t that describes its
198 * type and then is followed by the remaining data payload. The next entry
199 * follows immediately which again begins with the uint32_t word that describes
200 * what it should be.
201 */
202 typedef enum svp_log_type {
203 SVP_LOG_VL2 = 0x01,
204 SVP_LOG_VL3 = 0x02
205 } svp_log_type_t;
206
207 typedef struct svp_log_vl2 {
208 uint32_t svl2_type; /* Should be SVP_LOG_VL2 */
209 uint8_t svl2_id[16]; /* 16-byte UUID */
210 uint8_t svl2_mac[ETHERADDRL];
211 uint8_t svl2_pad[2];
212 uint32_t svl2_vnetid;
213 } svp_log_vl2_t;
214
215 typedef struct svp_log_vl3 {
216 uint32_t svl3_type; /* Should be SVP_LOG_VL3 */
217 uint8_t svl3_id[16]; /* 16-byte UUID */
218 uint8_t svl3_ip[16];
219 uint8_t svl3_pad[2];
220 uint16_t svl3_vlan;
221 uint32_t svl3_vnetid;
222 } svp_log_vl3_t;
223
224 typedef struct svp_log_ack {
225 uint32_t svla_status;
226 uint8_t svla_data[];
227 } svp_log_ack_t;
228
229 /*
230 * SVP_R_LOG_RM is used after the client successfully processes a series of the
231 * log stream. It replies to tell the server that it can remove those IDs from
232 * processing. The IDs used are the same IDs that were in the individual
233 * SVP_R_LOG_ACK entries.
234 */
235 typedef struct svp_lrm_req {
236 uint32_t svrr_count;
237 uint8_t svrr_ids[];
238 } svp_lrm_req_t;
239
240 /*
241 * SVP_R_LOG_RM_ACK is used to indicate that a log entry has been successfully
242 * deleted and at this point it makes sense to go and ask for another
243 * SVP_R_LOG_REQ.
244 */
245 typedef struct svp_lrm_ack {
246 uint32_t svra_status;
247 } svp_lrm_ack_t;
248
249 /*
250 * A shootdown (SVP_R_SHOOTDOWN) is used by a CN to reply to another CN that it
251 * sent an invalid entry that could not be processed. This should be a
252 * relatively infrequent occurrence. Unlike the rest of the messages, there is
253 * no reply to it. It's a single request to try and help get us out there. When
254 * a node receives this, it will issue a conditional revocation ioctl, that
255 * removes the entry if and only if, it matches the IP. That way if we've
256 * already gotten an updated entry for this, we don't remove it again.
257 */
258 typedef struct svp_shootdown {
259 uint8_t svsd_mac[ETHERADDRL];
260 uint8_t svsd_pad[2];
261 uint32_t svsd_vnetid;
262 } svp_shootdown_t;
263
264 #ifdef __cplusplus
265 }
266 #endif
267
268 #endif /* _LIBVARPD_SVP_PROT_H */