2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <sys/types.h>
22 #include <netinet/in.h>
27 #include "openvswitch/types.h"
34 bool dpid_from_string(const char *s, uint64_t *dpidp);
36 #define ETH_ADDR_LEN 6
38 static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] OVS_UNUSED
39 = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
41 static const uint8_t eth_addr_stp[ETH_ADDR_LEN] OVS_UNUSED
42 = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x00 };
44 static const uint8_t eth_addr_lacp[ETH_ADDR_LEN] OVS_UNUSED
45 = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x02 };
47 static const uint8_t eth_addr_bfd[ETH_ADDR_LEN] OVS_UNUSED
48 = { 0x00, 0x23, 0x20, 0x00, 0x00, 0x01 };
50 static inline bool eth_addr_is_broadcast(const uint8_t ea[6])
52 return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
55 static inline bool eth_addr_is_multicast(const uint8_t ea[6])
59 static inline bool eth_addr_is_local(const uint8_t ea[6])
61 /* Local if it is either a locally administered address or a Nicira random
64 || (ea[0] == 0x00 && ea[1] == 0x23 && ea[2] == 0x20 && ea[3] & 0x80);
66 static inline bool eth_addr_is_zero(const uint8_t ea[6])
68 return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
71 static inline int eth_mask_is_exact(const uint8_t ea[ETH_ADDR_LEN])
73 return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
76 static inline int eth_addr_compare_3way(const uint8_t a[ETH_ADDR_LEN],
77 const uint8_t b[ETH_ADDR_LEN])
79 return memcmp(a, b, ETH_ADDR_LEN);
81 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
82 const uint8_t b[ETH_ADDR_LEN])
84 return !eth_addr_compare_3way(a, b);
86 static inline bool eth_addr_equal_except(const uint8_t a[ETH_ADDR_LEN],
87 const uint8_t b[ETH_ADDR_LEN],
88 const uint8_t mask[ETH_ADDR_LEN])
90 return !(((a[0] ^ b[0]) & mask[0])
91 || ((a[1] ^ b[1]) & mask[1])
92 || ((a[2] ^ b[2]) & mask[2])
93 || ((a[3] ^ b[3]) & mask[3])
94 || ((a[4] ^ b[4]) & mask[4])
95 || ((a[5] ^ b[5]) & mask[5]));
97 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
99 return (((uint64_t) ea[0] << 40)
100 | ((uint64_t) ea[1] << 32)
101 | ((uint64_t) ea[2] << 24)
102 | ((uint64_t) ea[3] << 16)
103 | ((uint64_t) ea[4] << 8)
106 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
115 static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
117 ea[0] &= ~1; /* Unicast. */
118 ea[0] |= 2; /* Private. */
120 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
122 random_bytes(ea, ETH_ADDR_LEN);
123 eth_addr_mark_random(ea);
125 static inline void eth_addr_nicira_random(uint8_t ea[ETH_ADDR_LEN])
129 /* Set the OUI to the Nicira one. */
134 /* Set the top bit to indicate random Nicira address. */
138 bool eth_addr_is_reserved(const uint8_t ea[ETH_ADDR_LEN]);
139 bool eth_addr_from_string(const char *, uint8_t ea[ETH_ADDR_LEN]);
141 void compose_rarp(struct ofpbuf *, const uint8_t eth_src[ETH_ADDR_LEN]);
143 void eth_push_vlan(struct ofpbuf *, ovs_be16 tci);
144 void eth_pop_vlan(struct ofpbuf *);
146 void set_ethertype(struct ofpbuf *packet, ovs_be16 eth_type);
148 const char *eth_from_hex(const char *hex, struct ofpbuf **packetp);
149 void eth_format_masked(const uint8_t eth[ETH_ADDR_LEN],
150 const uint8_t mask[ETH_ADDR_LEN], struct ds *s);
151 void eth_addr_bitand(const uint8_t src[ETH_ADDR_LEN],
152 const uint8_t mask[ETH_ADDR_LEN],
153 uint8_t dst[ETH_ADDR_LEN]);
155 void set_mpls_lse(struct ofpbuf *, ovs_be32 label);
156 void push_mpls(struct ofpbuf *packet, ovs_be16 ethtype, ovs_be32 lse);
157 void pop_mpls(struct ofpbuf *, ovs_be16 ethtype);
159 void set_mpls_lse_ttl(ovs_be32 *lse, uint8_t ttl);
160 void set_mpls_lse_tc(ovs_be32 *lse, uint8_t tc);
161 void set_mpls_lse_label(ovs_be32 *lse, ovs_be32 label);
162 void set_mpls_lse_bos(ovs_be32 *lse, uint8_t bos);
163 ovs_be32 set_mpls_lse_values(uint8_t ttl, uint8_t tc, uint8_t bos,
168 * uint8_t mac[ETH_ADDR_LEN];
170 * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
173 #define ETH_ADDR_FMT \
174 "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
175 #define ETH_ADDR_ARGS(ea) \
176 (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
180 * char *string = "1 00:11:22:33:44:55 2";
181 * uint8_t mac[ETH_ADDR_LEN];
184 * if (sscanf(string, "%d"ETH_ADDR_SCAN_FMT"%d",
185 * &a, ETH_ADDR_SCAN_ARGS(mac), &b) == 1 + ETH_ADDR_SCAN_COUNT + 1) {
189 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
190 #define ETH_ADDR_SCAN_ARGS(ea) \
191 &(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
192 #define ETH_ADDR_SCAN_COUNT 6
194 #define ETH_TYPE_IP 0x0800
195 #define ETH_TYPE_ARP 0x0806
196 #define ETH_TYPE_VLAN_8021Q 0x8100
197 #define ETH_TYPE_VLAN ETH_TYPE_VLAN_8021Q
198 #define ETH_TYPE_VLAN_8021AD 0x88a8
199 #define ETH_TYPE_IPV6 0x86dd
200 #define ETH_TYPE_LACP 0x8809
201 #define ETH_TYPE_RARP 0x8035
202 #define ETH_TYPE_MPLS 0x8847
203 #define ETH_TYPE_MPLS_MCAST 0x8848
205 static inline bool eth_type_mpls(ovs_be16 eth_type)
207 return eth_type == htons(ETH_TYPE_MPLS) ||
208 eth_type == htons(ETH_TYPE_MPLS_MCAST);
211 /* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
213 #define ETH_TYPE_MIN 0x600
215 #define ETH_HEADER_LEN 14
216 #define ETH_PAYLOAD_MIN 46
217 #define ETH_PAYLOAD_MAX 1500
218 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
219 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
220 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
223 uint8_t eth_dst[ETH_ADDR_LEN];
224 uint8_t eth_src[ETH_ADDR_LEN];
227 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
229 #define LLC_DSAP_SNAP 0xaa
230 #define LLC_SSAP_SNAP 0xaa
231 #define LLC_CNTL_SNAP 3
233 #define LLC_HEADER_LEN 3
240 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
242 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
243 sizeof(SNAP_ORG_ETHERNET) == 3. */
244 #define SNAP_HEADER_LEN 5
250 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
252 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
254 struct llc_snap_header {
255 struct llc_header llc;
256 struct snap_header snap;
258 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
260 #define VLAN_VID_MASK 0x0fff
261 #define VLAN_VID_SHIFT 0
263 #define VLAN_PCP_MASK 0xe000
264 #define VLAN_PCP_SHIFT 13
266 #define VLAN_CFI 0x1000
267 #define VLAN_CFI_SHIFT 12
269 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
270 * returns the VLAN ID in host byte order. */
271 static inline uint16_t
272 vlan_tci_to_vid(ovs_be16 vlan_tci)
274 return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
277 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
278 * returns the priority code point (PCP) in host byte order. */
280 vlan_tci_to_pcp(ovs_be16 vlan_tci)
282 return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
285 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
286 * returns the Canonical Format Indicator (CFI). */
288 vlan_tci_to_cfi(ovs_be16 vlan_tci)
290 return (vlan_tci & htons(VLAN_CFI)) != 0;
293 #define VLAN_HEADER_LEN 4
295 ovs_be16 vlan_tci; /* Lowest 12 bits are VLAN ID. */
296 ovs_be16 vlan_next_type;
298 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
300 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
302 struct vlan_eth_header {
303 uint8_t veth_dst[ETH_ADDR_LEN];
304 uint8_t veth_src[ETH_ADDR_LEN];
305 ovs_be16 veth_type; /* Always htons(ETH_TYPE_VLAN). */
306 ovs_be16 veth_tci; /* Lowest 12 bits are VLAN ID. */
307 ovs_be16 veth_next_type;
309 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
311 /* MPLS related definitions */
312 #define MPLS_TTL_MASK 0x000000ff
313 #define MPLS_TTL_SHIFT 0
315 #define MPLS_BOS_MASK 0x00000100
316 #define MPLS_BOS_SHIFT 8
318 #define MPLS_TC_MASK 0x00000e00
319 #define MPLS_TC_SHIFT 9
321 #define MPLS_LABEL_MASK 0xfffff000
322 #define MPLS_LABEL_SHIFT 12
329 BUILD_ASSERT_DECL(MPLS_HLEN == sizeof(struct mpls_hdr));
331 /* Given a mpls label stack entry in network byte order
332 * return mpls label in host byte order */
333 static inline uint32_t
334 mpls_lse_to_label(ovs_be32 mpls_lse)
336 return (ntohl(mpls_lse) & MPLS_LABEL_MASK) >> MPLS_LABEL_SHIFT;
339 /* Given a mpls label stack entry in network byte order
341 static inline uint8_t
342 mpls_lse_to_tc(ovs_be32 mpls_lse)
344 return (ntohl(mpls_lse) & MPLS_TC_MASK) >> MPLS_TC_SHIFT;
347 /* Given a mpls label stack entry in network byte order
349 static inline uint8_t
350 mpls_lse_to_ttl(ovs_be32 mpls_lse)
352 return (ntohl(mpls_lse) & MPLS_TTL_MASK) >> MPLS_TTL_SHIFT;
355 /* Set TTL in mpls lse. */
357 flow_set_mpls_lse_ttl(ovs_be32 *mpls_lse, uint8_t ttl)
359 *mpls_lse &= ~htonl(MPLS_TTL_MASK);
360 *mpls_lse |= htonl(ttl << MPLS_TTL_SHIFT);
363 /* Given a mpls label stack entry in network byte order
364 * return mpls BoS bit */
365 static inline uint8_t
366 mpls_lse_to_bos(ovs_be32 mpls_lse)
368 return (mpls_lse & htonl(MPLS_BOS_MASK)) != 0;
371 #define IP_FMT "%"PRIu32".%"PRIu32".%"PRIu32".%"PRIu32
372 #define IP_ARGS(ip) \
374 (ntohl(ip) >> 16) & 0xff, \
375 (ntohl(ip) >> 8) & 0xff, \
380 * char *string = "1 33.44.55.66 2";
384 * if (sscanf(string, "%d"IP_SCAN_FMT"%d",
385 * &a, IP_SCAN_ARGS(&ip), &b) == 1 + IP_SCAN_COUNT + 1) {
389 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
390 #define IP_SCAN_ARGS(ip) \
391 ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]), \
392 &((uint8_t *) ip)[1], \
393 &((uint8_t *) ip)[2], \
395 #define IP_SCAN_COUNT 4
397 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
398 * high-order 1-bits and 32-N low-order 0-bits. */
400 ip_is_cidr(ovs_be32 netmask)
402 uint32_t x = ~ntohl(netmask);
403 return !(x & (x + 1));
406 ip_is_multicast(ovs_be32 ip)
408 return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
410 int ip_count_cidr_bits(ovs_be32 netmask);
411 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
413 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
414 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
415 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
418 #define IPPROTO_SCTP 132
422 #define IP_ECN_NOT_ECT 0x0
423 #define IP_ECN_ECT_1 0x01
424 #define IP_ECN_ECT_0 0x02
425 #define IP_ECN_CE 0x03
426 #define IP_ECN_MASK 0x03
427 #define IP_DSCP_MASK 0xfc
431 #define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
432 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
433 #define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
434 #define IP_IS_FRAGMENT(ip_frag_off) \
435 ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
437 #define IP_HEADER_LEN 20
443 ovs_be16 ip_frag_off;
447 ovs_16aligned_be32 ip_src;
448 ovs_16aligned_be32 ip_dst;
450 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
452 #define ICMP_HEADER_LEN 8
466 ovs_16aligned_be32 gateway;
468 uint8_t icmp_data[0];
470 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
472 #define SCTP_HEADER_LEN 12
479 BUILD_ASSERT_DECL(SCTP_HEADER_LEN == sizeof(struct sctp_header));
481 #define UDP_HEADER_LEN 8
488 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
490 #define TCP_FIN 0x001
491 #define TCP_SYN 0x002
492 #define TCP_RST 0x004
493 #define TCP_PSH 0x008
494 #define TCP_ACK 0x010
495 #define TCP_URG 0x020
496 #define TCP_ECE 0x040
497 #define TCP_CWR 0x080
500 #define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
501 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x0fff)
502 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
504 #define TCP_HEADER_LEN 20
508 ovs_16aligned_be32 tcp_seq;
509 ovs_16aligned_be32 tcp_ack;
515 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
517 #define ARP_HRD_ETHERNET 1
518 #define ARP_PRO_IP 0x0800
519 #define ARP_OP_REQUEST 1
520 #define ARP_OP_REPLY 2
521 #define ARP_OP_RARP 3
523 #define ARP_ETH_HEADER_LEN 28
524 struct arp_eth_header {
525 /* Generic members. */
526 ovs_be16 ar_hrd; /* Hardware type. */
527 ovs_be16 ar_pro; /* Protocol type. */
528 uint8_t ar_hln; /* Hardware address length. */
529 uint8_t ar_pln; /* Protocol address length. */
530 ovs_be16 ar_op; /* Opcode. */
532 /* Ethernet+IPv4 specific members. */
533 uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
534 ovs_16aligned_be32 ar_spa; /* Sender protocol address. */
535 uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
536 ovs_16aligned_be32 ar_tpa; /* Target protocol address. */
538 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
540 /* Like struct in6_addr, but whereas that struct requires 32-bit alignment on
541 * most implementations, this one only requires 16-bit alignment. */
542 union ovs_16aligned_in6_addr {
544 ovs_16aligned_be32 be32[4];
547 /* Like struct in6_hdr, but whereas that struct requires 32-bit alignment, this
548 * one only requires 16-bit alignment. */
549 struct ovs_16aligned_ip6_hdr {
551 struct ovs_16aligned_ip6_hdrctl {
552 ovs_16aligned_be32 ip6_un1_flow;
553 ovs_be16 ip6_un1_plen;
555 uint8_t ip6_un1_hlim;
559 union ovs_16aligned_in6_addr ip6_src;
560 union ovs_16aligned_in6_addr ip6_dst;
563 /* Like struct in6_frag, but whereas that struct requires 32-bit alignment,
564 * this one only requires 16-bit alignment. */
565 struct ovs_16aligned_ip6_frag {
567 uint8_t ip6f_reserved;
569 ovs_16aligned_be32 ip6f_ident;
572 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
573 #define IPV6_LABEL_MASK 0x000fffff
577 * char *string = "1 ::1 2";
578 * char ipv6_s[IPV6_SCAN_LEN + 1];
579 * struct in6_addr ipv6;
581 * if (sscanf(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b) == 3
582 * && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
586 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
587 #define IPV6_SCAN_LEN 46
589 extern const struct in6_addr in6addr_exact;
590 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
591 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
593 static inline bool ipv6_addr_equals(const struct in6_addr *a,
594 const struct in6_addr *b)
596 #ifdef IN6_ARE_ADDR_EQUAL
597 return IN6_ARE_ADDR_EQUAL(a, b);
599 return !memcmp(a, b, sizeof(*a));
603 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
604 return ipv6_addr_equals(mask, &in6addr_any);
607 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
608 return ipv6_addr_equals(mask, &in6addr_exact);
611 static inline bool dl_type_is_ip_any(ovs_be16 dl_type)
613 return dl_type == htons(ETH_TYPE_IP)
614 || dl_type == htons(ETH_TYPE_IPV6);
617 static inline bool is_ip_any(const struct flow *flow)
619 return dl_type_is_ip_any(flow->dl_type);
622 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
623 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
624 void print_ipv6_masked(struct ds *string, const struct in6_addr *addr,
625 const struct in6_addr *mask);
626 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
627 const struct in6_addr *mask);
628 struct in6_addr ipv6_create_mask(int mask);
629 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
630 bool ipv6_is_cidr(const struct in6_addr *netmask);
632 void *eth_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
633 const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
635 void *snap_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
636 const uint8_t eth_src[ETH_ADDR_LEN],
637 unsigned int oui, uint16_t snap_type, size_t size);
638 void packet_set_ipv4(struct ofpbuf *, ovs_be32 src, ovs_be32 dst, uint8_t tos,
640 void packet_set_ipv6(struct ofpbuf *, uint8_t proto, const ovs_be32 src[4],
641 const ovs_be32 dst[4], uint8_t tc,
642 ovs_be32 fl, uint8_t hlmit);
643 void packet_set_tcp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
644 void packet_set_udp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
645 void packet_set_sctp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
647 uint16_t packet_get_tcp_flags(const struct ofpbuf *, const struct flow *);
648 void packet_format_tcp_flags(struct ds *, uint16_t);
650 #endif /* packets.h */