2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 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"
30 #include "tun-metadata.h"
31 #include "unaligned.h"
37 /* Tunnel information used in flow key and metadata. */
49 uint8_t pad1[5]; /* Pad to 64 bits. */
50 struct tun_metadata metadata;
53 /* Some flags are exposed through OpenFlow while others are used only
57 #define FLOW_TNL_F_OAM (1 << 0)
59 #define FLOW_TNL_PUB_F_MASK ((1 << 1) - 1)
62 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 1)
63 #define FLOW_TNL_F_CSUM (1 << 2)
64 #define FLOW_TNL_F_KEY (1 << 3)
66 #define FLOW_TNL_F_MASK ((1 << 4) - 1)
68 /* Purely internal to OVS userspace. These flags should never be exposed to
69 * the outside world and so aren't included in the flags mask. */
71 /* Tunnel information is in userspace datapath format. */
72 #define FLOW_TNL_F_UDPIF (1 << 4)
74 /* Returns an offset to 'src' covering all the meaningful fields in 'src'. */
76 flow_tnl_size(const struct flow_tnl *src)
79 /* Covers ip_dst only. */
80 return offsetof(struct flow_tnl, ip_src);
82 if (src->flags & FLOW_TNL_F_UDPIF) {
83 /* Datapath format, cover all options we have. */
84 return offsetof(struct flow_tnl, metadata.opts)
85 + src->metadata.present.len;
87 if (!src->metadata.present.map) {
88 /* No TLVs, opts is irrelevant. */
89 return offsetof(struct flow_tnl, metadata.opts);
91 /* Have decoded TLVs, opts is relevant. */
95 /* Copy flow_tnl, but avoid copying unused portions of tun_metadata. Unused
96 * data in 'dst' is NOT cleared, so this must not be used in cases where the
97 * uninitialized portion may be hashed over. */
99 flow_tnl_copy__(struct flow_tnl *dst, const struct flow_tnl *src)
101 memcpy(dst, src, flow_tnl_size(src));
105 flow_tnl_equal(const struct flow_tnl *a, const struct flow_tnl *b)
107 size_t a_size = flow_tnl_size(a);
109 return a_size == flow_tnl_size(b) && !memcmp(a, b, a_size);
112 /* Unfortunately, a "struct flow" sometimes has to handle OpenFlow port
113 * numbers and other times datapath (dpif) port numbers. This union allows
120 /* Datapath packet metadata */
121 struct pkt_metadata {
122 uint32_t recirc_id; /* Recirculation id carried with the
123 recirculating packets. 0 for packets
124 received from the wire. */
125 uint32_t dp_hash; /* hash value computed by the recirculation
127 uint32_t skb_priority; /* Packet priority for QoS. */
128 uint32_t pkt_mark; /* Packet mark. */
129 union flow_in_port in_port; /* Input port. */
130 struct flow_tnl tunnel; /* Encapsulating tunnel parameters. Note that
131 * if 'ip_dst' == 0, the rest of the fields may
132 * be uninitialized. */
136 pkt_metadata_init(struct pkt_metadata *md, odp_port_t port)
138 /* It can be expensive to zero out all of the tunnel metadata. However,
139 * we can just zero out ip_dst and the rest of the data will never be
141 memset(md, 0, offsetof(struct pkt_metadata, tunnel));
142 md->tunnel.ip_dst = 0;
144 md->in_port.odp_port = port;
147 bool dpid_from_string(const char *s, uint64_t *dpidp);
149 #define ETH_ADDR_LEN 6
151 static const struct eth_addr eth_addr_broadcast OVS_UNUSED
152 = { { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } } };
154 static const struct eth_addr eth_addr_exact OVS_UNUSED
155 = { { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } } };
157 static const struct eth_addr eth_addr_zero OVS_UNUSED
158 = { { { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } } };
160 static const struct eth_addr eth_addr_stp OVS_UNUSED
161 = { { { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x00 } } };
163 static const struct eth_addr eth_addr_lacp OVS_UNUSED
164 = { { { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x02 } } };
166 static const struct eth_addr eth_addr_bfd OVS_UNUSED
167 = { { { 0x00, 0x23, 0x20, 0x00, 0x00, 0x01 } } };
169 static inline bool eth_addr_is_broadcast(const struct eth_addr a)
171 return (a.be16[0] & a.be16[1] & a.be16[2]) == htons(0xffff);
174 static inline bool eth_addr_is_multicast(const struct eth_addr a)
179 static inline bool eth_addr_is_local(const struct eth_addr a)
181 /* Local if it is either a locally administered address or a Nicira random
184 || (a.be16[0] == htons(0x0023)
185 && (a.be16[1] & htons(0xff80)) == htons(0x2080));
187 static inline bool eth_addr_is_zero(const struct eth_addr a)
189 return !(a.be16[0] | a.be16[1] | a.be16[2]);
192 static inline int eth_mask_is_exact(const struct eth_addr a)
194 return (a.be16[0] & a.be16[1] & a.be16[2]) == htons(0xffff);
197 static inline int eth_addr_compare_3way(const struct eth_addr a,
198 const struct eth_addr b)
200 return memcmp(&a, &b, sizeof a);
203 static inline bool eth_addr_equals(const struct eth_addr a,
204 const struct eth_addr b)
206 return !eth_addr_compare_3way(a, b);
209 static inline bool eth_addr_equal_except(const struct eth_addr a,
210 const struct eth_addr b,
211 const struct eth_addr mask)
213 return !(((a.be16[0] ^ b.be16[0]) & mask.be16[0])
214 || ((a.be16[1] ^ b.be16[1]) & mask.be16[1])
215 || ((a.be16[2] ^ b.be16[2]) & mask.be16[2]));
218 static inline uint64_t eth_addr_to_uint64(const struct eth_addr ea)
220 return (((uint64_t) ntohs(ea.be16[0]) << 32)
221 | ((uint64_t) ntohs(ea.be16[1]) << 16)
222 | ntohs(ea.be16[2]));
225 static inline uint64_t eth_addr_vlan_to_uint64(const struct eth_addr ea,
228 return (((uint64_t)vlan << 48) | eth_addr_to_uint64(ea));
231 static inline void eth_addr_from_uint64(uint64_t x, struct eth_addr *ea)
233 ea->be16[0] = htons(x >> 32);
234 ea->be16[1] = htons((x & 0xFFFF0000) >> 16);
235 ea->be16[2] = htons(x & 0xFFFF);
238 static inline struct eth_addr eth_addr_invert(const struct eth_addr src)
242 for (int i = 0; i < ARRAY_SIZE(src.be16); i++) {
243 dst.be16[i] = ~src.be16[i];
249 static inline void eth_addr_mark_random(struct eth_addr *ea)
251 ea->ea[0] &= ~1; /* Unicast. */
252 ea->ea[0] |= 2; /* Private. */
255 static inline void eth_addr_random(struct eth_addr *ea)
257 random_bytes((uint8_t *)ea, sizeof *ea);
258 eth_addr_mark_random(ea);
261 static inline void eth_addr_nicira_random(struct eth_addr *ea)
265 /* Set the OUI to the Nicira one. */
270 /* Set the top bit to indicate random Nicira address. */
273 static inline uint32_t hash_mac(const struct eth_addr ea,
274 const uint16_t vlan, const uint32_t basis)
276 return hash_uint64_basis(eth_addr_vlan_to_uint64(ea, vlan), basis);
279 bool eth_addr_is_reserved(const struct eth_addr);
280 bool eth_addr_from_string(const char *, struct eth_addr *);
282 void compose_rarp(struct dp_packet *, const struct eth_addr);
284 void eth_push_vlan(struct dp_packet *, ovs_be16 tpid, ovs_be16 tci);
285 void eth_pop_vlan(struct dp_packet *);
287 const char *eth_from_hex(const char *hex, struct dp_packet **packetp);
288 void eth_format_masked(const struct eth_addr ea,
289 const struct eth_addr *mask, struct ds *s);
291 void set_mpls_lse(struct dp_packet *, ovs_be32 label);
292 void push_mpls(struct dp_packet *packet, ovs_be16 ethtype, ovs_be32 lse);
293 void pop_mpls(struct dp_packet *, ovs_be16 ethtype);
295 void set_mpls_lse_ttl(ovs_be32 *lse, uint8_t ttl);
296 void set_mpls_lse_tc(ovs_be32 *lse, uint8_t tc);
297 void set_mpls_lse_label(ovs_be32 *lse, ovs_be32 label);
298 void set_mpls_lse_bos(ovs_be32 *lse, uint8_t bos);
299 ovs_be32 set_mpls_lse_values(uint8_t ttl, uint8_t tc, uint8_t bos,
304 * struct eth_addr mac;
306 * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
309 #define ETH_ADDR_FMT \
310 "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
311 #define ETH_ADDR_ARGS(EA) ETH_ADDR_BYTES_ARGS((EA).ea)
312 #define ETH_ADDR_BYTES_ARGS(EAB) \
313 (EAB)[0], (EAB)[1], (EAB)[2], (EAB)[3], (EAB)[4], (EAB)[5]
317 * char *string = "1 00:11:22:33:44:55 2";
318 * struct eth_addr mac;
321 * if (ovs_scan(string, "%d"ETH_ADDR_SCAN_FMT"%d",
322 * &a, ETH_ADDR_SCAN_ARGS(mac), &b)) {
326 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
327 #define ETH_ADDR_SCAN_ARGS(EA) \
328 &(EA).ea[0], &(EA).ea[1], &(EA).ea[2], &(EA).ea[3], &(EA).ea[4], &(EA).ea[5]
330 #define ETH_TYPE_IP 0x0800
331 #define ETH_TYPE_ARP 0x0806
332 #define ETH_TYPE_TEB 0x6558
333 #define ETH_TYPE_VLAN_8021Q 0x8100
334 #define ETH_TYPE_VLAN ETH_TYPE_VLAN_8021Q
335 #define ETH_TYPE_VLAN_8021AD 0x88a8
336 #define ETH_TYPE_IPV6 0x86dd
337 #define ETH_TYPE_LACP 0x8809
338 #define ETH_TYPE_RARP 0x8035
339 #define ETH_TYPE_MPLS 0x8847
340 #define ETH_TYPE_MPLS_MCAST 0x8848
342 static inline bool eth_type_mpls(ovs_be16 eth_type)
344 return eth_type == htons(ETH_TYPE_MPLS) ||
345 eth_type == htons(ETH_TYPE_MPLS_MCAST);
348 static inline bool eth_type_vlan(ovs_be16 eth_type)
350 return eth_type == htons(ETH_TYPE_VLAN_8021Q) ||
351 eth_type == htons(ETH_TYPE_VLAN_8021AD);
355 /* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
357 #define ETH_TYPE_MIN 0x600
359 #define ETH_HEADER_LEN 14
360 #define ETH_PAYLOAD_MIN 46
361 #define ETH_PAYLOAD_MAX 1500
362 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
363 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
364 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
367 struct eth_addr eth_dst;
368 struct eth_addr eth_src;
371 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
373 #define LLC_DSAP_SNAP 0xaa
374 #define LLC_SSAP_SNAP 0xaa
375 #define LLC_CNTL_SNAP 3
377 #define LLC_HEADER_LEN 3
384 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
386 /* LLC field values used for STP frames. */
387 #define STP_LLC_SSAP 0x42
388 #define STP_LLC_DSAP 0x42
389 #define STP_LLC_CNTL 0x03
391 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
392 sizeof(SNAP_ORG_ETHERNET) == 3. */
393 #define SNAP_HEADER_LEN 5
399 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
401 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
403 struct llc_snap_header {
404 struct llc_header llc;
405 struct snap_header snap;
407 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
409 #define VLAN_VID_MASK 0x0fff
410 #define VLAN_VID_SHIFT 0
412 #define VLAN_PCP_MASK 0xe000
413 #define VLAN_PCP_SHIFT 13
415 #define VLAN_CFI 0x1000
416 #define VLAN_CFI_SHIFT 12
418 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
419 * returns the VLAN ID in host byte order. */
420 static inline uint16_t
421 vlan_tci_to_vid(ovs_be16 vlan_tci)
423 return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
426 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
427 * returns the priority code point (PCP) in host byte order. */
429 vlan_tci_to_pcp(ovs_be16 vlan_tci)
431 return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
434 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
435 * returns the Canonical Format Indicator (CFI). */
437 vlan_tci_to_cfi(ovs_be16 vlan_tci)
439 return (vlan_tci & htons(VLAN_CFI)) != 0;
442 #define VLAN_HEADER_LEN 4
444 ovs_be16 vlan_tci; /* Lowest 12 bits are VLAN ID. */
445 ovs_be16 vlan_next_type;
447 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
449 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
451 struct vlan_eth_header {
452 struct eth_addr veth_dst;
453 struct eth_addr veth_src;
454 ovs_be16 veth_type; /* Always htons(ETH_TYPE_VLAN). */
455 ovs_be16 veth_tci; /* Lowest 12 bits are VLAN ID. */
456 ovs_be16 veth_next_type;
458 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
460 /* MPLS related definitions */
461 #define MPLS_TTL_MASK 0x000000ff
462 #define MPLS_TTL_SHIFT 0
464 #define MPLS_BOS_MASK 0x00000100
465 #define MPLS_BOS_SHIFT 8
467 #define MPLS_TC_MASK 0x00000e00
468 #define MPLS_TC_SHIFT 9
470 #define MPLS_LABEL_MASK 0xfffff000
471 #define MPLS_LABEL_SHIFT 12
476 ovs_16aligned_be32 mpls_lse;
478 BUILD_ASSERT_DECL(MPLS_HLEN == sizeof(struct mpls_hdr));
480 /* Given a mpls label stack entry in network byte order
481 * return mpls label in host byte order */
482 static inline uint32_t
483 mpls_lse_to_label(ovs_be32 mpls_lse)
485 return (ntohl(mpls_lse) & MPLS_LABEL_MASK) >> MPLS_LABEL_SHIFT;
488 /* Given a mpls label stack entry in network byte order
490 static inline uint8_t
491 mpls_lse_to_tc(ovs_be32 mpls_lse)
493 return (ntohl(mpls_lse) & MPLS_TC_MASK) >> MPLS_TC_SHIFT;
496 /* Given a mpls label stack entry in network byte order
498 static inline uint8_t
499 mpls_lse_to_ttl(ovs_be32 mpls_lse)
501 return (ntohl(mpls_lse) & MPLS_TTL_MASK) >> MPLS_TTL_SHIFT;
504 /* Set TTL in mpls lse. */
506 flow_set_mpls_lse_ttl(ovs_be32 *mpls_lse, uint8_t ttl)
508 *mpls_lse &= ~htonl(MPLS_TTL_MASK);
509 *mpls_lse |= htonl(ttl << MPLS_TTL_SHIFT);
512 /* Given a mpls label stack entry in network byte order
513 * return mpls BoS bit */
514 static inline uint8_t
515 mpls_lse_to_bos(ovs_be32 mpls_lse)
517 return (mpls_lse & htonl(MPLS_BOS_MASK)) != 0;
520 #define IP_FMT "%"PRIu32".%"PRIu32".%"PRIu32".%"PRIu32
521 #define IP_ARGS(ip) \
523 (ntohl(ip) >> 16) & 0xff, \
524 (ntohl(ip) >> 8) & 0xff, \
529 * char *string = "1 33.44.55.66 2";
533 * if (ovs_scan(string, "%d"IP_SCAN_FMT"%d", &a, IP_SCAN_ARGS(&ip), &b)) {
537 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
538 #define IP_SCAN_ARGS(ip) \
539 ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]), \
540 &((uint8_t *) ip)[1], \
541 &((uint8_t *) ip)[2], \
544 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
545 * high-order 1-bits and 32-N low-order 0-bits. */
547 ip_is_cidr(ovs_be32 netmask)
549 uint32_t x = ~ntohl(netmask);
550 return !(x & (x + 1));
553 ip_is_multicast(ovs_be32 ip)
555 return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
558 ip_is_local_multicast(ovs_be32 ip)
560 return (ip & htonl(0xffffff00)) == htonl(0xe0000000);
562 int ip_count_cidr_bits(ovs_be32 netmask);
563 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
565 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
566 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
567 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
570 #define IPPROTO_SCTP 132
574 #define IP_ECN_NOT_ECT 0x0
575 #define IP_ECN_ECT_1 0x01
576 #define IP_ECN_ECT_0 0x02
577 #define IP_ECN_CE 0x03
578 #define IP_ECN_MASK 0x03
579 #define IP_DSCP_MASK 0xfc
583 #define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
584 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
585 #define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
586 #define IP_IS_FRAGMENT(ip_frag_off) \
587 ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
589 #define IP_HEADER_LEN 20
595 ovs_be16 ip_frag_off;
599 ovs_16aligned_be32 ip_src;
600 ovs_16aligned_be32 ip_dst;
603 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
605 #define ICMP_HEADER_LEN 8
619 ovs_16aligned_be32 gateway;
622 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
624 #define IGMP_HEADER_LEN 8
629 ovs_16aligned_be32 group;
631 BUILD_ASSERT_DECL(IGMP_HEADER_LEN == sizeof(struct igmp_header));
633 #define IGMPV3_HEADER_LEN 8
634 struct igmpv3_header {
641 BUILD_ASSERT_DECL(IGMPV3_HEADER_LEN == sizeof(struct igmpv3_header));
643 #define IGMPV3_RECORD_LEN 8
644 struct igmpv3_record {
648 ovs_16aligned_be32 maddr;
650 BUILD_ASSERT_DECL(IGMPV3_RECORD_LEN == sizeof(struct igmpv3_record));
652 #define IGMP_HOST_MEMBERSHIP_QUERY 0x11 /* From RFC1112 */
653 #define IGMP_HOST_MEMBERSHIP_REPORT 0x12 /* Ditto */
654 #define IGMPV2_HOST_MEMBERSHIP_REPORT 0x16 /* V2 version of 0x12 */
655 #define IGMP_HOST_LEAVE_MESSAGE 0x17
656 #define IGMPV3_HOST_MEMBERSHIP_REPORT 0x22 /* V3 version of 0x12 */
659 * IGMPv3 and MLDv2 use the same codes.
661 #define IGMPV3_MODE_IS_INCLUDE 1
662 #define IGMPV3_MODE_IS_EXCLUDE 2
663 #define IGMPV3_CHANGE_TO_INCLUDE_MODE 3
664 #define IGMPV3_CHANGE_TO_EXCLUDE_MODE 4
665 #define IGMPV3_ALLOW_NEW_SOURCES 5
666 #define IGMPV3_BLOCK_OLD_SOURCES 6
668 #define SCTP_HEADER_LEN 12
672 ovs_16aligned_be32 sctp_vtag;
673 ovs_16aligned_be32 sctp_csum;
675 BUILD_ASSERT_DECL(SCTP_HEADER_LEN == sizeof(struct sctp_header));
677 #define UDP_HEADER_LEN 8
684 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
686 #define TCP_FIN 0x001
687 #define TCP_SYN 0x002
688 #define TCP_RST 0x004
689 #define TCP_PSH 0x008
690 #define TCP_ACK 0x010
691 #define TCP_URG 0x020
692 #define TCP_ECE 0x040
693 #define TCP_CWR 0x080
696 #define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
697 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x0fff)
698 #define TCP_FLAGS_BE16(tcp_ctl) ((tcp_ctl) & htons(0x0fff))
699 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
701 #define TCP_HEADER_LEN 20
705 ovs_16aligned_be32 tcp_seq;
706 ovs_16aligned_be32 tcp_ack;
712 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
714 #define ARP_HRD_ETHERNET 1
715 #define ARP_PRO_IP 0x0800
716 #define ARP_OP_REQUEST 1
717 #define ARP_OP_REPLY 2
718 #define ARP_OP_RARP 3
720 #define ARP_ETH_HEADER_LEN 28
721 struct arp_eth_header {
722 /* Generic members. */
723 ovs_be16 ar_hrd; /* Hardware type. */
724 ovs_be16 ar_pro; /* Protocol type. */
725 uint8_t ar_hln; /* Hardware address length. */
726 uint8_t ar_pln; /* Protocol address length. */
727 ovs_be16 ar_op; /* Opcode. */
729 /* Ethernet+IPv4 specific members. */
730 struct eth_addr ar_sha; /* Sender hardware address. */
731 ovs_16aligned_be32 ar_spa; /* Sender protocol address. */
732 struct eth_addr ar_tha; /* Target hardware address. */
733 ovs_16aligned_be32 ar_tpa; /* Target protocol address. */
735 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
737 /* Like struct in6_addr, but whereas that struct requires 32-bit alignment on
738 * most implementations, this one only requires 16-bit alignment. */
739 union ovs_16aligned_in6_addr {
741 ovs_16aligned_be32 be32[4];
744 /* Like struct in6_hdr, but whereas that struct requires 32-bit alignment, this
745 * one only requires 16-bit alignment. */
746 struct ovs_16aligned_ip6_hdr {
748 struct ovs_16aligned_ip6_hdrctl {
749 ovs_16aligned_be32 ip6_un1_flow;
750 ovs_be16 ip6_un1_plen;
752 uint8_t ip6_un1_hlim;
756 union ovs_16aligned_in6_addr ip6_src;
757 union ovs_16aligned_in6_addr ip6_dst;
760 /* Like struct in6_frag, but whereas that struct requires 32-bit alignment,
761 * this one only requires 16-bit alignment. */
762 struct ovs_16aligned_ip6_frag {
764 uint8_t ip6f_reserved;
766 ovs_16aligned_be32 ip6f_ident;
769 #define ICMP6_HEADER_LEN 4
770 struct icmp6_header {
773 ovs_be16 icmp6_cksum;
775 BUILD_ASSERT_DECL(ICMP6_HEADER_LEN == sizeof(struct icmp6_header));
777 /* Neighbor Discovery option field.
778 * ND options are always a multiple of 8 bytes in size. */
781 uint8_t nd_opt_type; /* Values defined in icmp6.h */
782 uint8_t nd_opt_len; /* in units of 8 octets (the size of this struct) */
783 struct eth_addr nd_opt_mac; /* Ethernet address in the case of SLL or TLL options */
785 BUILD_ASSERT_DECL(ND_OPT_LEN == sizeof(struct ovs_nd_opt));
787 /* Like struct nd_msg (from ndisc.h), but whereas that struct requires 32-bit
788 * alignment, this one only requires 16-bit alignment. */
789 #define ND_MSG_LEN 24
791 struct icmp6_header icmph;
792 ovs_16aligned_be32 rco_flags;
793 union ovs_16aligned_in6_addr target;
794 struct ovs_nd_opt options[0];
796 BUILD_ASSERT_DECL(ND_MSG_LEN == sizeof(struct ovs_nd_msg));
799 * Use the same struct for MLD and MLD2, naming members as the defined fields in
800 * in the corresponding version of the protocol, though they are reserved in the
803 #define MLD_HEADER_LEN 8
811 BUILD_ASSERT_DECL(MLD_HEADER_LEN == sizeof(struct mld_header));
813 #define MLD2_RECORD_LEN 20
818 union ovs_16aligned_in6_addr maddr;
820 BUILD_ASSERT_DECL(MLD2_RECORD_LEN == sizeof(struct mld2_record));
822 #define MLD_QUERY 130
823 #define MLD_REPORT 131
825 #define MLD2_REPORT 143
827 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
828 #define IPV6_LABEL_MASK 0x000fffff
832 * char *string = "1 ::1 2";
833 * char ipv6_s[IPV6_SCAN_LEN + 1];
834 * struct in6_addr ipv6;
836 * if (ovs_scan(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b)
837 * && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
841 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
842 #define IPV6_SCAN_LEN 46
844 extern const struct in6_addr in6addr_exact;
845 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
846 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
848 extern const struct in6_addr in6addr_all_hosts;
849 #define IN6ADDR_ALL_HOSTS_INIT { { { 0xff,0x02,0x00,0x00,0x00,0x00,0x00,0x00, \
850 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x01 } } }
852 static inline bool ipv6_addr_equals(const struct in6_addr *a,
853 const struct in6_addr *b)
855 #ifdef IN6_ARE_ADDR_EQUAL
856 return IN6_ARE_ADDR_EQUAL(a, b);
858 return !memcmp(a, b, sizeof(*a));
862 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
863 return ipv6_addr_equals(mask, &in6addr_any);
866 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
867 return ipv6_addr_equals(mask, &in6addr_exact);
870 static inline bool ipv6_is_all_hosts(const struct in6_addr *addr) {
871 return ipv6_addr_equals(addr, &in6addr_all_hosts);
874 static inline bool ipv6_addr_is_set(const struct in6_addr *addr) {
875 return !ipv6_addr_equals(addr, &in6addr_any);
878 static inline bool ipv6_addr_is_multicast(const struct in6_addr *ip) {
879 return ip->s6_addr[0] == 0xff;
883 in6_addr_set_mapped_ipv4(struct in6_addr *addr, ovs_be32 ip4)
885 union ovs_16aligned_in6_addr *taddr = (void *) addr;
886 memset(taddr->be16, 0, sizeof(taddr->be16));
887 taddr->be16[5] = OVS_BE16_MAX;
888 put_16aligned_be32(&taddr->be32[3], ip4);
891 static inline ovs_be32
892 in6_addr_get_mapped_ipv4(const struct in6_addr *addr)
894 union ovs_16aligned_in6_addr *taddr = (void *) addr;
895 if (IN6_IS_ADDR_V4MAPPED(addr)) {
896 return get_16aligned_be32(&taddr->be32[3]);
902 static inline bool dl_type_is_ip_any(ovs_be16 dl_type)
904 return dl_type == htons(ETH_TYPE_IP)
905 || dl_type == htons(ETH_TYPE_IPV6);
910 /* GRE protocol header */
911 struct gre_base_hdr {
916 #define GRE_CSUM 0x8000
917 #define GRE_ROUTING 0x4000
918 #define GRE_KEY 0x2000
919 #define GRE_SEQ 0x1000
920 #define GRE_STRICT 0x0800
921 #define GRE_REC 0x0700
922 #define GRE_FLAGS 0x00F8
923 #define GRE_VERSION 0x0007
925 /* VXLAN protocol header */
927 ovs_16aligned_be32 vx_flags;
928 ovs_16aligned_be32 vx_vni;
931 #define VXLAN_FLAGS 0x08000000 /* struct vxlanhdr.vx_flags required value. */
933 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
934 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
935 void print_ipv6_mapped(struct ds *string, const struct in6_addr *addr);
936 void print_ipv6_masked(struct ds *string, const struct in6_addr *addr,
937 const struct in6_addr *mask);
938 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
939 const struct in6_addr *mask);
940 struct in6_addr ipv6_create_mask(int mask);
941 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
942 bool ipv6_is_cidr(const struct in6_addr *netmask);
944 void *eth_compose(struct dp_packet *, const struct eth_addr eth_dst,
945 const struct eth_addr eth_src, uint16_t eth_type,
947 void *snap_compose(struct dp_packet *, const struct eth_addr eth_dst,
948 const struct eth_addr eth_src,
949 unsigned int oui, uint16_t snap_type, size_t size);
950 void packet_set_ipv4(struct dp_packet *, ovs_be32 src, ovs_be32 dst, uint8_t tos,
952 void packet_set_ipv6(struct dp_packet *, uint8_t proto, const ovs_be32 src[4],
953 const ovs_be32 dst[4], uint8_t tc,
954 ovs_be32 fl, uint8_t hlmit);
955 void packet_set_tcp_port(struct dp_packet *, ovs_be16 src, ovs_be16 dst);
956 void packet_set_udp_port(struct dp_packet *, ovs_be16 src, ovs_be16 dst);
957 void packet_set_sctp_port(struct dp_packet *, ovs_be16 src, ovs_be16 dst);
958 void packet_set_nd(struct dp_packet *, const ovs_be32 target[4],
959 const struct eth_addr sll, const struct eth_addr tll);
961 void packet_format_tcp_flags(struct ds *, uint16_t);
962 const char *packet_tcp_flag_to_string(uint32_t flag);
963 void compose_arp(struct dp_packet *, uint16_t arp_op,
964 const struct eth_addr arp_sha,
965 const struct eth_addr arp_tha, bool broadcast,
966 ovs_be32 arp_spa, ovs_be32 arp_tpa);
967 uint32_t packet_csum_pseudoheader(const struct ip_header *);
969 #endif /* packets.h */