ofp-util: Work on decoding OF1.1 flow_mods.
[openvswitch] / 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          0x8100
181 #define ETH_TYPE_IPV6          0x86dd
182 #define ETH_TYPE_LACP          0x8809
183 #define ETH_TYPE_RARP          0x8035
184 #define ETH_TYPE_MPLS          0x8847
185 #define ETH_TYPE_MPLS_MCAST    0x8848
186
187 /* Minimum value for an Ethernet type.  Values below this are IEEE 802.2 frame
188  * lengths. */
189 #define ETH_TYPE_MIN           0x600
190
191 #define ETH_HEADER_LEN 14
192 #define ETH_PAYLOAD_MIN 46
193 #define ETH_PAYLOAD_MAX 1500
194 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
195 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
196 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
197 struct eth_header {
198     uint8_t eth_dst[ETH_ADDR_LEN];
199     uint8_t eth_src[ETH_ADDR_LEN];
200     ovs_be16 eth_type;
201 } __attribute__((packed));
202 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
203
204 #define LLC_DSAP_SNAP 0xaa
205 #define LLC_SSAP_SNAP 0xaa
206 #define LLC_CNTL_SNAP 3
207
208 #define LLC_HEADER_LEN 3
209 struct llc_header {
210     uint8_t llc_dsap;
211     uint8_t llc_ssap;
212     uint8_t llc_cntl;
213 } __attribute__((packed));
214 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
215
216 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
217                                     sizeof(SNAP_ORG_ETHERNET) == 3. */
218 #define SNAP_HEADER_LEN 5
219 struct snap_header {
220     uint8_t snap_org[3];
221     ovs_be16 snap_type;
222 } __attribute__((packed));
223 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
224
225 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
226 struct llc_snap_header {
227     struct llc_header llc;
228     struct snap_header snap;
229 } __attribute__((packed));
230 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
231
232 #define ARP_HTYPE_ETH 0x0001
233 #define RARP_REQUEST_REVERSE 0x0003
234
235 #define RARP_HEADER_LEN 28
236 /* RARP header only for Ethernet-IP. */
237 struct rarp_header {
238     ovs_be16 hw_addr_space;        /* ARP_HTYPE_ETH. */
239     ovs_be16 proto_addr_space;     /* ETH_TYPE_IP. */
240     uint8_t hw_addr_length;        /* ETH_ADDR_LEN. */
241     uint8_t proto_addr_length;     /* IPV4_ADDR_LEN. */
242     ovs_be16 opcode;               /* RARP_REQUEST_REVERSE. */
243     uint8_t src_hw_addr[ETH_ADDR_LEN];
244     ovs_be32 src_proto_addr;
245     uint8_t target_hw_addr[ETH_ADDR_LEN];
246     ovs_be32 target_proto_addr;
247 } __attribute__((packed));
248 BUILD_ASSERT_DECL(RARP_HEADER_LEN == sizeof(struct rarp_header));
249
250
251 #define VLAN_VID_MASK 0x0fff
252 #define VLAN_VID_SHIFT 0
253
254 #define VLAN_PCP_MASK 0xe000
255 #define VLAN_PCP_SHIFT 13
256
257 #define VLAN_CFI 0x1000
258
259 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
260  * returns the VLAN ID in host byte order. */
261 static inline uint16_t
262 vlan_tci_to_vid(ovs_be16 vlan_tci)
263 {
264     return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
265 }
266
267 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
268  * returns the priority code point (PCP) in host byte order. */
269 static inline int
270 vlan_tci_to_pcp(ovs_be16 vlan_tci)
271 {
272     return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
273 }
274
275 #define VLAN_HEADER_LEN 4
276 struct vlan_header {
277     ovs_be16 vlan_tci;          /* Lowest 12 bits are VLAN ID. */
278     ovs_be16 vlan_next_type;
279 };
280 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
281
282 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
283 struct vlan_eth_header {
284     uint8_t veth_dst[ETH_ADDR_LEN];
285     uint8_t veth_src[ETH_ADDR_LEN];
286     ovs_be16 veth_type;         /* Always htons(ETH_TYPE_VLAN). */
287     ovs_be16 veth_tci;          /* Lowest 12 bits are VLAN ID. */
288     ovs_be16 veth_next_type;
289 } __attribute__((packed));
290 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
291
292 /* The "(void) (ip)[0]" below has no effect on the value, since it's the first
293  * argument of a comma expression, but it makes sure that 'ip' is a pointer.
294  * This is useful since a common mistake is to pass an integer instead of a
295  * pointer to IP_ARGS. */
296 #define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
297 #define IP_ARGS(ip)                             \
298         ((void) (ip)[0], ((uint8_t *) ip)[0]),  \
299         ((uint8_t *) ip)[1],                    \
300         ((uint8_t *) ip)[2],                    \
301         ((uint8_t *) ip)[3]
302
303 /* Example:
304  *
305  * char *string = "1 33.44.55.66 2";
306  * ovs_be32 ip;
307  * int a, b;
308  *
309  * if (sscanf(string, "%d"IP_SCAN_FMT"%d",
310  *     &a, IP_SCAN_ARGS(&ip), &b) == 1 + IP_SCAN_COUNT + 1) {
311  *     ...
312  * }
313  */
314 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
315 #define IP_SCAN_ARGS(ip)                                    \
316         ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]),    \
317         &((uint8_t *) ip)[1],                               \
318         &((uint8_t *) ip)[2],                               \
319         &((uint8_t *) ip)[3]
320 #define IP_SCAN_COUNT 4
321
322 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
323  * high-order 1-bits and 32-N low-order 0-bits. */
324 static inline bool
325 ip_is_cidr(ovs_be32 netmask)
326 {
327     uint32_t x = ~ntohl(netmask);
328     return !(x & (x + 1));
329 }
330 static inline bool
331 ip_is_multicast(ovs_be32 ip)
332 {
333     return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
334 }
335 int ip_count_cidr_bits(ovs_be32 netmask);
336 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
337
338 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
339 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
340 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
341
342 #ifndef IPPROTO_SCTP
343 #define IPPROTO_SCTP 132
344 #endif
345
346 /* TOS fields. */
347 #define IP_ECN_MASK 0x03
348 #define IP_DSCP_MASK 0xfc
349
350 #define IP_VERSION 4
351
352 #define IP_DONT_FRAGMENT  0x4000 /* Don't fragment. */
353 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
354 #define IP_FRAG_OFF_MASK  0x1fff /* Fragment offset. */
355 #define IP_IS_FRAGMENT(ip_frag_off) \
356         ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
357
358 #define IP_HEADER_LEN 20
359 struct ip_header {
360     uint8_t ip_ihl_ver;
361     uint8_t ip_tos;
362     ovs_be16 ip_tot_len;
363     ovs_be16 ip_id;
364     ovs_be16 ip_frag_off;
365     uint8_t ip_ttl;
366     uint8_t ip_proto;
367     ovs_be16 ip_csum;
368     ovs_be32 ip_src;
369     ovs_be32 ip_dst;
370 };
371 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
372
373 #define ICMP_HEADER_LEN 8
374 struct icmp_header {
375     uint8_t icmp_type;
376     uint8_t icmp_code;
377     ovs_be16 icmp_csum;
378     union {
379         struct {
380             ovs_be16 id;
381             ovs_be16 seq;
382         } echo;
383         struct {
384             ovs_be16 empty;
385             ovs_be16 mtu;
386         } frag;
387         ovs_be32 gateway;
388     } icmp_fields;
389     uint8_t icmp_data[0];
390 };
391 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
392
393 #define UDP_HEADER_LEN 8
394 struct udp_header {
395     ovs_be16 udp_src;
396     ovs_be16 udp_dst;
397     ovs_be16 udp_len;
398     ovs_be16 udp_csum;
399 };
400 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
401
402 #define TCP_FIN 0x01
403 #define TCP_SYN 0x02
404 #define TCP_RST 0x04
405 #define TCP_PSH 0x08
406 #define TCP_ACK 0x10
407 #define TCP_URG 0x20
408
409 #define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
410 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x003f)
411 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
412
413 #define TCP_HEADER_LEN 20
414 struct tcp_header {
415     ovs_be16 tcp_src;
416     ovs_be16 tcp_dst;
417     ovs_be32 tcp_seq;
418     ovs_be32 tcp_ack;
419     ovs_be16 tcp_ctl;
420     ovs_be16 tcp_winsz;
421     ovs_be16 tcp_csum;
422     ovs_be16 tcp_urg;
423 };
424 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
425
426 #define ARP_HRD_ETHERNET 1
427 #define ARP_PRO_IP 0x0800
428 #define ARP_OP_REQUEST 1
429 #define ARP_OP_REPLY 2
430
431 #define ARP_ETH_HEADER_LEN 28
432 struct arp_eth_header {
433     /* Generic members. */
434     ovs_be16 ar_hrd;           /* Hardware type. */
435     ovs_be16 ar_pro;           /* Protocol type. */
436     uint8_t ar_hln;            /* Hardware address length. */
437     uint8_t ar_pln;            /* Protocol address length. */
438     ovs_be16 ar_op;            /* Opcode. */
439
440     /* Ethernet+IPv4 specific members. */
441     uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
442     ovs_be32 ar_spa;           /* Sender protocol address. */
443     uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
444     ovs_be32 ar_tpa;           /* Target protocol address. */
445 } __attribute__((packed));
446 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
447
448 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
449 #define IPV6_LABEL_MASK 0x000fffff
450
451 /* Example:
452  *
453  * char *string = "1 ::1 2";
454  * char ipv6_s[IPV6_SCAN_LEN + 1];
455  * struct in6_addr ipv6;
456  *
457  * if (sscanf(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b) == 3
458  *     && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
459  *     ...
460  * }
461  */
462 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
463 #define IPV6_SCAN_LEN 46
464
465 extern const struct in6_addr in6addr_exact;
466 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
467                                  0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
468
469 static inline bool ipv6_addr_equals(const struct in6_addr *a,
470                                     const struct in6_addr *b)
471 {
472 #ifdef IN6_ARE_ADDR_EQUAL
473     return IN6_ARE_ADDR_EQUAL(a, b);
474 #else
475     return !memcmp(a, b, sizeof(*a));
476 #endif
477 }
478
479 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
480     return ipv6_addr_equals(mask, &in6addr_any);
481 }
482
483 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
484     return ipv6_addr_equals(mask, &in6addr_exact);
485 }
486
487 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
488 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
489 void print_ipv6_masked(struct ds *string, const struct in6_addr *addr,
490                        const struct in6_addr *mask);
491 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
492                                  const struct in6_addr *mask);
493 struct in6_addr ipv6_create_mask(int mask);
494 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
495 bool ipv6_is_cidr(const struct in6_addr *netmask);
496
497 void *eth_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
498                   const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
499                   size_t size);
500 void *snap_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
501                    const uint8_t eth_src[ETH_ADDR_LEN],
502                    unsigned int oui, uint16_t snap_type, size_t size);
503 void packet_set_ipv4(struct ofpbuf *, ovs_be32 src, ovs_be32 dst, uint8_t tos,
504                      uint8_t ttl);
505 void packet_set_tcp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
506 void packet_set_udp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
507
508 uint8_t packet_get_tcp_flags(const struct ofpbuf *, const struct flow *);
509 void packet_format_tcp_flags(struct ds *, uint8_t);
510
511 #endif /* packets.h */