]> git.proxmox.com Git - mirror_ovs.git/blob - lib/packets.h
datapath: add ipv6 'set' action
[mirror_ovs.git] / lib / packets.h
1 /*
2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #ifndef PACKETS_H
18 #define PACKETS_H 1
19
20 #include <inttypes.h>
21 #include <sys/types.h>
22 #include <netinet/in.h>
23 #include <stdint.h>
24 #include <string.h>
25 #include "compiler.h"
26 #include "openvswitch/types.h"
27 #include "random.h"
28 #include "util.h"
29
30 struct ofpbuf;
31 struct ds;
32 struct flow;
33
34 bool dpid_from_string(const char *s, uint64_t *dpidp);
35
36 #define ETH_ADDR_LEN 6
37
38 static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] OVS_UNUSED
39 = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
40
41 static const uint8_t eth_addr_stp[ETH_ADDR_LEN] OVS_UNUSED
42 = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x00 };
43
44 static const uint8_t eth_addr_lacp[ETH_ADDR_LEN] OVS_UNUSED
45 = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x02 };
46
47 static inline bool eth_addr_is_broadcast(const uint8_t ea[6])
48 {
49 return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
50 }
51
52 static inline bool eth_addr_is_multicast(const uint8_t ea[6])
53 {
54 return ea[0] & 1;
55 }
56 static inline bool eth_addr_is_local(const uint8_t ea[6])
57 {
58 /* Local if it is either a locally administered address or a Nicira random
59 * address. */
60 return ea[0] & 2
61 || (ea[0] == 0x00 && ea[1] == 0x23 && ea[2] == 0x20 && ea[3] & 0x80);
62 }
63 static inline bool eth_addr_is_zero(const uint8_t ea[6])
64 {
65 return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
66 }
67
68 static inline int eth_mask_is_exact(const uint8_t ea[ETH_ADDR_LEN])
69 {
70 return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
71 }
72
73 static inline int eth_addr_compare_3way(const uint8_t a[ETH_ADDR_LEN],
74 const uint8_t b[ETH_ADDR_LEN])
75 {
76 return memcmp(a, b, ETH_ADDR_LEN);
77 }
78 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
79 const uint8_t b[ETH_ADDR_LEN])
80 {
81 return !eth_addr_compare_3way(a, b);
82 }
83 static inline bool eth_addr_equal_except(const uint8_t a[ETH_ADDR_LEN],
84 const uint8_t b[ETH_ADDR_LEN],
85 const uint8_t mask[ETH_ADDR_LEN])
86 {
87 return !(((a[0] ^ b[0]) & mask[0])
88 || ((a[1] ^ b[1]) & mask[1])
89 || ((a[2] ^ b[2]) & mask[2])
90 || ((a[3] ^ b[3]) & mask[3])
91 || ((a[4] ^ b[4]) & mask[4])
92 || ((a[5] ^ b[5]) & mask[5]));
93 }
94 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
95 {
96 return (((uint64_t) ea[0] << 40)
97 | ((uint64_t) ea[1] << 32)
98 | ((uint64_t) ea[2] << 24)
99 | ((uint64_t) ea[3] << 16)
100 | ((uint64_t) ea[4] << 8)
101 | ea[5]);
102 }
103 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
104 {
105 ea[0] = x >> 40;
106 ea[1] = x >> 32;
107 ea[2] = x >> 24;
108 ea[3] = x >> 16;
109 ea[4] = x >> 8;
110 ea[5] = x;
111 }
112 static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
113 {
114 ea[0] &= ~1; /* Unicast. */
115 ea[0] |= 2; /* Private. */
116 }
117 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
118 {
119 random_bytes(ea, ETH_ADDR_LEN);
120 eth_addr_mark_random(ea);
121 }
122 static inline void eth_addr_nicira_random(uint8_t ea[ETH_ADDR_LEN])
123 {
124 eth_addr_random(ea);
125
126 /* Set the OUI to the Nicira one. */
127 ea[0] = 0x00;
128 ea[1] = 0x23;
129 ea[2] = 0x20;
130
131 /* Set the top bit to indicate random Nicira address. */
132 ea[3] |= 0x80;
133 }
134
135 bool eth_addr_is_reserved(const uint8_t ea[ETH_ADDR_LEN]);
136 bool eth_addr_from_string(const char *, uint8_t ea[ETH_ADDR_LEN]);
137
138 void compose_rarp(struct ofpbuf *, const uint8_t eth_src[ETH_ADDR_LEN]);
139
140 void eth_push_vlan(struct ofpbuf *, ovs_be16 tci);
141 void eth_pop_vlan(struct ofpbuf *);
142
143 const char *eth_from_hex(const char *hex, struct ofpbuf **packetp);
144 void eth_format_masked(const uint8_t eth[ETH_ADDR_LEN],
145 const uint8_t mask[ETH_ADDR_LEN], struct ds *s);
146 void eth_addr_bitand(const uint8_t src[ETH_ADDR_LEN],
147 const uint8_t mask[ETH_ADDR_LEN],
148 uint8_t dst[ETH_ADDR_LEN]);
149
150 /* Example:
151 *
152 * uint8_t mac[ETH_ADDR_LEN];
153 * [...]
154 * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
155 *
156 */
157 #define ETH_ADDR_FMT \
158 "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
159 #define ETH_ADDR_ARGS(ea) \
160 (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
161
162 /* Example:
163 *
164 * char *string = "1 00:11:22:33:44:55 2";
165 * uint8_t mac[ETH_ADDR_LEN];
166 * int a, b;
167 *
168 * if (sscanf(string, "%d"ETH_ADDR_SCAN_FMT"%d",
169 * &a, ETH_ADDR_SCAN_ARGS(mac), &b) == 1 + ETH_ADDR_SCAN_COUNT + 1) {
170 * ...
171 * }
172 */
173 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
174 #define ETH_ADDR_SCAN_ARGS(ea) \
175 &(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
176 #define ETH_ADDR_SCAN_COUNT 6
177
178 #define ETH_TYPE_IP 0x0800
179 #define ETH_TYPE_ARP 0x0806
180 #define ETH_TYPE_VLAN_8021Q 0x8100
181 #define ETH_TYPE_VLAN ETH_TYPE_VLAN_8021Q
182 #define ETH_TYPE_VLAN_8021AD 0x88a8
183 #define ETH_TYPE_IPV6 0x86dd
184 #define ETH_TYPE_LACP 0x8809
185 #define ETH_TYPE_RARP 0x8035
186 #define ETH_TYPE_MPLS 0x8847
187 #define ETH_TYPE_MPLS_MCAST 0x8848
188
189 /* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
190 * lengths. */
191 #define ETH_TYPE_MIN 0x600
192
193 #define ETH_HEADER_LEN 14
194 #define ETH_PAYLOAD_MIN 46
195 #define ETH_PAYLOAD_MAX 1500
196 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
197 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
198 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
199 struct eth_header {
200 uint8_t eth_dst[ETH_ADDR_LEN];
201 uint8_t eth_src[ETH_ADDR_LEN];
202 ovs_be16 eth_type;
203 } __attribute__((packed));
204 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
205
206 #define LLC_DSAP_SNAP 0xaa
207 #define LLC_SSAP_SNAP 0xaa
208 #define LLC_CNTL_SNAP 3
209
210 #define LLC_HEADER_LEN 3
211 struct llc_header {
212 uint8_t llc_dsap;
213 uint8_t llc_ssap;
214 uint8_t llc_cntl;
215 } __attribute__((packed));
216 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
217
218 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
219 sizeof(SNAP_ORG_ETHERNET) == 3. */
220 #define SNAP_HEADER_LEN 5
221 struct snap_header {
222 uint8_t snap_org[3];
223 ovs_be16 snap_type;
224 } __attribute__((packed));
225 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
226
227 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
228 struct llc_snap_header {
229 struct llc_header llc;
230 struct snap_header snap;
231 } __attribute__((packed));
232 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
233
234 #define VLAN_VID_MASK 0x0fff
235 #define VLAN_VID_SHIFT 0
236
237 #define VLAN_PCP_MASK 0xe000
238 #define VLAN_PCP_SHIFT 13
239
240 #define VLAN_CFI 0x1000
241
242 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
243 * returns the VLAN ID in host byte order. */
244 static inline uint16_t
245 vlan_tci_to_vid(ovs_be16 vlan_tci)
246 {
247 return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
248 }
249
250 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
251 * returns the priority code point (PCP) in host byte order. */
252 static inline int
253 vlan_tci_to_pcp(ovs_be16 vlan_tci)
254 {
255 return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
256 }
257
258 #define VLAN_HEADER_LEN 4
259 struct vlan_header {
260 ovs_be16 vlan_tci; /* Lowest 12 bits are VLAN ID. */
261 ovs_be16 vlan_next_type;
262 };
263 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
264
265 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
266 struct vlan_eth_header {
267 uint8_t veth_dst[ETH_ADDR_LEN];
268 uint8_t veth_src[ETH_ADDR_LEN];
269 ovs_be16 veth_type; /* Always htons(ETH_TYPE_VLAN). */
270 ovs_be16 veth_tci; /* Lowest 12 bits are VLAN ID. */
271 ovs_be16 veth_next_type;
272 } __attribute__((packed));
273 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
274
275 /* The "(void) (ip)[0]" below has no effect on the value, since it's the first
276 * argument of a comma expression, but it makes sure that 'ip' is a pointer.
277 * This is useful since a common mistake is to pass an integer instead of a
278 * pointer to IP_ARGS. */
279 #define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
280 #define IP_ARGS(ip) \
281 ((void) (ip)[0], ((uint8_t *) ip)[0]), \
282 ((uint8_t *) ip)[1], \
283 ((uint8_t *) ip)[2], \
284 ((uint8_t *) ip)[3]
285
286 /* Example:
287 *
288 * char *string = "1 33.44.55.66 2";
289 * ovs_be32 ip;
290 * int a, b;
291 *
292 * if (sscanf(string, "%d"IP_SCAN_FMT"%d",
293 * &a, IP_SCAN_ARGS(&ip), &b) == 1 + IP_SCAN_COUNT + 1) {
294 * ...
295 * }
296 */
297 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
298 #define IP_SCAN_ARGS(ip) \
299 ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]), \
300 &((uint8_t *) ip)[1], \
301 &((uint8_t *) ip)[2], \
302 &((uint8_t *) ip)[3]
303 #define IP_SCAN_COUNT 4
304
305 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
306 * high-order 1-bits and 32-N low-order 0-bits. */
307 static inline bool
308 ip_is_cidr(ovs_be32 netmask)
309 {
310 uint32_t x = ~ntohl(netmask);
311 return !(x & (x + 1));
312 }
313 static inline bool
314 ip_is_multicast(ovs_be32 ip)
315 {
316 return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
317 }
318 int ip_count_cidr_bits(ovs_be32 netmask);
319 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
320
321 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
322 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
323 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
324
325 #ifndef IPPROTO_SCTP
326 #define IPPROTO_SCTP 132
327 #endif
328
329 /* TOS fields. */
330 #define IP_ECN_NOT_ECT 0x0
331 #define IP_ECN_ECT_1 0x01
332 #define IP_ECN_ECT_0 0x02
333 #define IP_ECN_CE 0x03
334 #define IP_ECN_MASK 0x03
335 #define IP_DSCP_MASK 0xfc
336
337 #define IP_VERSION 4
338
339 #define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
340 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
341 #define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
342 #define IP_IS_FRAGMENT(ip_frag_off) \
343 ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
344
345 #define IP_HEADER_LEN 20
346 struct ip_header {
347 uint8_t ip_ihl_ver;
348 uint8_t ip_tos;
349 ovs_be16 ip_tot_len;
350 ovs_be16 ip_id;
351 ovs_be16 ip_frag_off;
352 uint8_t ip_ttl;
353 uint8_t ip_proto;
354 ovs_be16 ip_csum;
355 ovs_be32 ip_src;
356 ovs_be32 ip_dst;
357 };
358 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
359
360 #define ICMP_HEADER_LEN 8
361 struct icmp_header {
362 uint8_t icmp_type;
363 uint8_t icmp_code;
364 ovs_be16 icmp_csum;
365 union {
366 struct {
367 ovs_be16 id;
368 ovs_be16 seq;
369 } echo;
370 struct {
371 ovs_be16 empty;
372 ovs_be16 mtu;
373 } frag;
374 ovs_be32 gateway;
375 } icmp_fields;
376 uint8_t icmp_data[0];
377 };
378 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
379
380 #define UDP_HEADER_LEN 8
381 struct udp_header {
382 ovs_be16 udp_src;
383 ovs_be16 udp_dst;
384 ovs_be16 udp_len;
385 ovs_be16 udp_csum;
386 };
387 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
388
389 #define TCP_FIN 0x01
390 #define TCP_SYN 0x02
391 #define TCP_RST 0x04
392 #define TCP_PSH 0x08
393 #define TCP_ACK 0x10
394 #define TCP_URG 0x20
395
396 #define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
397 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x003f)
398 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
399
400 #define TCP_HEADER_LEN 20
401 struct tcp_header {
402 ovs_be16 tcp_src;
403 ovs_be16 tcp_dst;
404 ovs_be32 tcp_seq;
405 ovs_be32 tcp_ack;
406 ovs_be16 tcp_ctl;
407 ovs_be16 tcp_winsz;
408 ovs_be16 tcp_csum;
409 ovs_be16 tcp_urg;
410 };
411 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
412
413 #define ARP_HRD_ETHERNET 1
414 #define ARP_PRO_IP 0x0800
415 #define ARP_OP_REQUEST 1
416 #define ARP_OP_REPLY 2
417 #define ARP_OP_RARP 3
418
419 #define ARP_ETH_HEADER_LEN 28
420 struct arp_eth_header {
421 /* Generic members. */
422 ovs_be16 ar_hrd; /* Hardware type. */
423 ovs_be16 ar_pro; /* Protocol type. */
424 uint8_t ar_hln; /* Hardware address length. */
425 uint8_t ar_pln; /* Protocol address length. */
426 ovs_be16 ar_op; /* Opcode. */
427
428 /* Ethernet+IPv4 specific members. */
429 uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
430 ovs_be32 ar_spa; /* Sender protocol address. */
431 uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
432 ovs_be32 ar_tpa; /* Target protocol address. */
433 } __attribute__((packed));
434 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
435
436 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
437 #define IPV6_LABEL_MASK 0x000fffff
438
439 /* Example:
440 *
441 * char *string = "1 ::1 2";
442 * char ipv6_s[IPV6_SCAN_LEN + 1];
443 * struct in6_addr ipv6;
444 *
445 * if (sscanf(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b) == 3
446 * && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
447 * ...
448 * }
449 */
450 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
451 #define IPV6_SCAN_LEN 46
452
453 extern const struct in6_addr in6addr_exact;
454 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
455 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
456
457 static inline bool ipv6_addr_equals(const struct in6_addr *a,
458 const struct in6_addr *b)
459 {
460 #ifdef IN6_ARE_ADDR_EQUAL
461 return IN6_ARE_ADDR_EQUAL(a, b);
462 #else
463 return !memcmp(a, b, sizeof(*a));
464 #endif
465 }
466
467 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
468 return ipv6_addr_equals(mask, &in6addr_any);
469 }
470
471 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
472 return ipv6_addr_equals(mask, &in6addr_exact);
473 }
474
475 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
476 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
477 void print_ipv6_masked(struct ds *string, const struct in6_addr *addr,
478 const struct in6_addr *mask);
479 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
480 const struct in6_addr *mask);
481 struct in6_addr ipv6_create_mask(int mask);
482 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
483 bool ipv6_is_cidr(const struct in6_addr *netmask);
484
485 void *eth_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
486 const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
487 size_t size);
488 void *snap_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
489 const uint8_t eth_src[ETH_ADDR_LEN],
490 unsigned int oui, uint16_t snap_type, size_t size);
491 void packet_set_ipv4(struct ofpbuf *, ovs_be32 src, ovs_be32 dst, uint8_t tos,
492 uint8_t ttl);
493 void packet_set_ipv6(struct ofpbuf *, uint8_t proto, const ovs_be32 src[4],
494 const ovs_be32 dst[4], uint8_t tc,
495 uint32_t fl, uint8_t hlmit);
496 void packet_set_tcp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
497 void packet_set_udp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
498
499 uint8_t packet_get_tcp_flags(const struct ofpbuf *, const struct flow *);
500 void packet_format_tcp_flags(struct ds *, uint8_t);
501
502 #endif /* packets.h */