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_ROUTE_REQ = 0x0E,
65 SVP_R_ROUTE_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 VL2->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 * SVP_R_BULK_REQ requests a bulk dump of data. Currently we have two kinds of
128 * data tables that we need to dump: VL3->VL2 mappings and VL2->UL3 mappings.
129 * The kind that we want is indicated using the svbr_type member.
130 */
131 typedef enum svp_bulk_type {
132 SVP_BULK_VL2 = 0x01,
133 SVP_BULK_VL3 = 0x02
134 } svp_bulk_type_t;
135
136 typedef struct svp_bulk_req {
137 uint32_t svbr_type;
138 } svp_bulk_req_t;
139
140 /*
141 * When replying to a bulk request (SVP_R_BULK_ACK), data is streamed back
142 * across. The format of the data is currently undefined and as we work on the
143 * system, we'll get a better understanding of what this should look like. A
144 * client may need to stream such a request to disk, or the format will need to
145 * be in a streamable format that allows the client to construct data.
146 */
147 typedef struct svp_bulk_ack {
148 uint32_t svba_status;
149 uint32_t svba_type;
150 uint8_t svba_data[];
151 } svp_bulk_ack_t;
152
153 /*
154 * SVP_R_LOG_REQ requests a log entries from the specified log from the server.
155 * The total number of bytes that the user is ready to receive is in svlr_count.
156 * However, the server should not block for data if none is available and thus
157 * may return less than svlr_count bytes back. We identify the IP address of the
158 * underlay to use here explicitly.
159 */
160 typedef struct svp_log_req {
161 uint32_t svlr_count;
162 uint8_t svlr_ip[16];
163 } svp_log_req_t;
164
165 /*
166 * The server replies to a log request by sending a series of log entries.
167 * These log entries may be a mixture of both vl2 and vl3 records. The reply is
168 * a stream of bytes after the status message whose length is determined baseed
169 * on the header itself. Each entry begins with a uint32_t that describes its
170 * type and then is followed by the remaining data payload. The next entry
171 * follows immediately which again begins with the uint32_t word that describes
172 * what it should be.
173 */
174 typedef enum svp_log_type {
175 SVP_LOG_VL2 = 0x01,
176 SVP_LOG_VL3 = 0x02,
177 SVP_LOG_ROUTE = 0x03
178 } svp_log_type_t;
179
180 typedef struct svp_log_vl2 {
181 uint32_t svl2_type; /* Should be SVP_LOG_VL2 */
182 uint8_t svl2_id[16]; /* 16-byte UUID */
183 uint8_t svl2_mac[ETHERADDRL];
184 uint8_t svl2_pad[2];
185 uint32_t svl2_vnetid;
186 } svp_log_vl2_t;
187
188 typedef struct svp_log_vl3 {
189 uint32_t svl3_type; /* Should be SVP_LOG_VL3 */
190 uint8_t svl3_id[16]; /* 16-byte UUID */
191 uint8_t svl3_ip[16];
192 uint8_t svl3_pad[2];
193 uint16_t svl3_vlan;
194 uint32_t svl3_vnetid;
195 } svp_log_vl3_t;
196
197 typedef struct svp_log_route {
198 uint32_t svlr_type; /* Should be SVP_LOG_ROUTE */
199 uint8_t svlr_id[16]; /* 16-byte UUID */
200 uint32_t svlr_src_vnetid; /* Source VXLAN vnetid. */
201 uint32_t svlr_dst_vnetid; /* Dest. VXLAN vnetid. */
202 uint32_t svlr_dcid; /* Remote/dest Data Center ID. */
203 uint8_t svlr_srcip[16]; /* Source IP address base. */
204 uint8_t svlr_dstip[16]; /* Destination IP address base. */
205 uint16_t svlr_dst_vlan; /* Source VLAN id. */
206 uint16_t svlr_src_vlan; /* Destination VLAN id. */
207 uint8_t svlr_src_prefixlen; /* Source IP prefix length. */
208 uint8_t svlr_dst_prefixlen; /* Dest. IP prefix length. */
209 uint16_t svlr_pad; /* So we can be aligned... */
210 } svp_log_route_t;
211
212 typedef struct svp_log_ack {
213 uint32_t svla_status;
214 uint8_t svla_data[];
215 } svp_log_ack_t;
216
217 /*
218 * SVP_R_LOG_RM is used after the client successfully processes a series of the
219 * log stream. It replies to tell the server that it can remove those IDs from
220 * processing. The IDs used are the same IDs that were in the individual
221 * SVP_R_LOG_ACK entries.
222 */
223 typedef struct svp_lrm_req {
224 uint32_t svrr_count;
225 uint8_t svrr_ids[];
226 } svp_lrm_req_t;
227
228 /*
229 * SVP_R_LOG_RM_ACK is used to indicate that a log entry has been successfully
230 * deleted and at this point it makes sense to go and ask for another
231 * SVP_R_LOG_REQ.
232 */
233 typedef struct svp_lrm_ack {
234 uint32_t svra_status;
235 } svp_lrm_ack_t;
236
237 /*
238 * A shootdown (SVP_R_SHOOTDOWN) is used by a CN to reply to another CN that it
239 * sent an invalid entry that could not be processed. This should be a
240 * relatively infrequent occurrence. Unlike the rest of the messages, there is
241 * no reply to it. It's a single request to try and help get us out there. When
242 * a node receives this, it will issue a conditional revocation ioctl, that
243 * removes the entry if and only if, it matches the IP. That way if we've
244 * already gotten an updated entry for this, we don't remove it again.
245 */
246 typedef struct svp_shootdown {
247 uint8_t svsd_mac[ETHERADDRL];
248 uint8_t svsd_pad[2];
249 uint32_t svsd_vnetid;
250 } svp_shootdown_t;
251
252 /*
253 * A route-request (SVP_R_ROUTE_REQ) queries the local SVP server to get a
254 * far-remote (i.e. another Triton Data Center, nee. SDC) SVP server for
255 * far-remote networks. Modern overlay modules will request IP destinations
256 * for remote-Triton networks, but they must know how to reach the
257 * remote-Triton SVP server.
258 */
259 typedef struct svp_route_req {
260 uint32_t srr_vnetid; /* Requester's vnet ID. */
261 uint16_t srr_vlan; /* Requester's VLAN ID. */
262 uint16_t srr_pad; /* Zero on xmit, ignore on receipt. */
263 uint8_t srr_srcip[16]; /* VL3 Source IP. */
264 uint8_t srr_dstip[16]; /* VL3 Destination IP. */
265 } svp_route_req_t;
266
267 /*
268 * The far-remote Triton Data Center will answer with the requisite information
269 * to send overlay packets to the appropriate far-remote CNs.
270 */
271 typedef struct svp_route_ack {
272 uint32_t sra_status; /* Status. */
273 uint32_t sra_dcid; /* Far-remote Data Center ID. */
274 uint32_t sra_vnetid; /* Far-remote vnet ID. */
275 uint16_t sra_vlan; /* Far-remote VLAN ID. */
276 uint16_t sra_port; /* Destination UL3 port. */
277 uint8_t sra_ip[16]; /* Destination UL3 address. */
278 uint8_t sra_srcmac[ETHERADDRL]; /* Far-remote VL2 source. */
279 uint8_t sra_dstmac[ETHERADDRL]; /* Far-remote VL2 dest. */
280 uint8_t sra_src_pfx; /* Far-remote VL3 source prefix */
281 uint8_t sra_dst_pfx; /* Far-remote VL3 dest. prefix */
282 } svp_route_ack_t;
283
284 #ifdef __cplusplus
285 }
286 #endif
287
288 #endif /* _LIBVARPD_SVP_PROT_H */