2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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>
26 #include "openvswitch/geneve.h"
27 #include "openvswitch/types.h"
28 #include "odp-netlink.h"
31 #include "tun-metadata.h"
32 #include "unaligned.h"
38 /* Tunnel information used in flow key and metadata. */
41 struct in6_addr ipv6_dst
;
43 struct in6_addr ipv6_src
;
52 uint8_t pad1
[5]; /* Pad to 64 bits. */
53 struct tun_metadata metadata
;
56 /* Some flags are exposed through OpenFlow while others are used only
60 #define FLOW_TNL_F_OAM (1 << 0)
62 #define FLOW_TNL_PUB_F_MASK ((1 << 1) - 1)
65 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 1)
66 #define FLOW_TNL_F_CSUM (1 << 2)
67 #define FLOW_TNL_F_KEY (1 << 3)
69 #define FLOW_TNL_F_MASK ((1 << 4) - 1)
71 /* Purely internal to OVS userspace. These flags should never be exposed to
72 * the outside world and so aren't included in the flags mask. */
74 /* Tunnel information is in userspace datapath format. */
75 #define FLOW_TNL_F_UDPIF (1 << 4)
77 static inline bool ipv6_addr_is_set(const struct in6_addr
*addr
);
80 flow_tnl_dst_is_set(const struct flow_tnl
*tnl
)
82 return tnl
->ip_dst
|| ipv6_addr_is_set(&tnl
->ipv6_dst
);
85 struct in6_addr
flow_tnl_dst(const struct flow_tnl
*tnl
);
86 struct in6_addr
flow_tnl_src(const struct flow_tnl
*tnl
);
88 /* Returns an offset to 'src' covering all the meaningful fields in 'src'. */
90 flow_tnl_size(const struct flow_tnl
*src
)
92 if (!flow_tnl_dst_is_set(src
)) {
93 /* Covers ip_dst and ipv6_dst only. */
94 return offsetof(struct flow_tnl
, ip_src
);
96 if (src
->flags
& FLOW_TNL_F_UDPIF
) {
97 /* Datapath format, cover all options we have. */
98 return offsetof(struct flow_tnl
, metadata
.opts
)
99 + src
->metadata
.present
.len
;
101 if (!src
->metadata
.present
.map
) {
102 /* No TLVs, opts is irrelevant. */
103 return offsetof(struct flow_tnl
, metadata
.opts
);
105 /* Have decoded TLVs, opts is relevant. */
109 /* Copy flow_tnl, but avoid copying unused portions of tun_metadata. Unused
110 * data in 'dst' is NOT cleared, so this must not be used in cases where the
111 * uninitialized portion may be hashed over. */
113 flow_tnl_copy__(struct flow_tnl
*dst
, const struct flow_tnl
*src
)
115 memcpy(dst
, src
, flow_tnl_size(src
));
119 flow_tnl_equal(const struct flow_tnl
*a
, const struct flow_tnl
*b
)
121 size_t a_size
= flow_tnl_size(a
);
123 return a_size
== flow_tnl_size(b
) && !memcmp(a
, b
, a_size
);
126 /* Unfortunately, a "struct flow" sometimes has to handle OpenFlow port
127 * numbers and other times datapath (dpif) port numbers. This union allows
134 /* Datapath packet metadata */
135 struct pkt_metadata
{
136 uint32_t recirc_id
; /* Recirculation id carried with the
137 recirculating packets. 0 for packets
138 received from the wire. */
139 uint32_t dp_hash
; /* hash value computed by the recirculation
141 uint32_t skb_priority
; /* Packet priority for QoS. */
142 uint32_t pkt_mark
; /* Packet mark. */
143 uint16_t ct_state
; /* Connection state. */
144 uint16_t ct_zone
; /* Connection zone. */
145 uint32_t ct_mark
; /* Connection mark. */
146 ovs_u128 ct_label
; /* Connection label. */
147 union flow_in_port in_port
; /* Input port. */
148 struct flow_tnl tunnel
; /* Encapsulating tunnel parameters. Note that
149 * if 'ip_dst' == 0, the rest of the fields may
150 * be uninitialized. */
154 pkt_metadata_init(struct pkt_metadata
*md
, odp_port_t port
)
156 /* It can be expensive to zero out all of the tunnel metadata. However,
157 * we can just zero out ip_dst and the rest of the data will never be
159 memset(md
, 0, offsetof(struct pkt_metadata
, in_port
));
160 md
->tunnel
.ip_dst
= 0;
161 md
->tunnel
.ipv6_dst
= in6addr_any
;
163 md
->in_port
.odp_port
= port
;
166 /* This function prefetches the cachelines touched by pkt_metadata_init()
167 * For performance reasons the two functions should be kept in sync. */
169 pkt_metadata_prefetch_init(struct pkt_metadata
*md
)
171 ovs_prefetch_range(md
, offsetof(struct pkt_metadata
, tunnel
.ip_src
));
174 bool dpid_from_string(const char *s
, uint64_t *dpidp
);
176 #define ETH_ADDR_LEN 6
178 static const struct eth_addr eth_addr_broadcast OVS_UNUSED
179 = { { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } } };
181 static const struct eth_addr eth_addr_exact OVS_UNUSED
182 = { { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } } };
184 static const struct eth_addr eth_addr_zero OVS_UNUSED
185 = { { { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } } };
187 static const struct eth_addr eth_addr_stp OVS_UNUSED
188 = { { { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x00 } } };
190 static const struct eth_addr eth_addr_lacp OVS_UNUSED
191 = { { { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x02 } } };
193 static const struct eth_addr eth_addr_bfd OVS_UNUSED
194 = { { { 0x00, 0x23, 0x20, 0x00, 0x00, 0x01 } } };
196 static inline bool eth_addr_is_broadcast(const struct eth_addr a
)
198 return (a
.be16
[0] & a
.be16
[1] & a
.be16
[2]) == htons(0xffff);
201 static inline bool eth_addr_is_multicast(const struct eth_addr a
)
206 static inline bool eth_addr_is_local(const struct eth_addr a
)
208 /* Local if it is either a locally administered address or a Nicira random
211 || (a
.be16
[0] == htons(0x0023)
212 && (a
.be16
[1] & htons(0xff80)) == htons(0x2080));
214 static inline bool eth_addr_is_zero(const struct eth_addr a
)
216 return !(a
.be16
[0] | a
.be16
[1] | a
.be16
[2]);
219 static inline int eth_mask_is_exact(const struct eth_addr a
)
221 return (a
.be16
[0] & a
.be16
[1] & a
.be16
[2]) == htons(0xffff);
224 static inline int eth_addr_compare_3way(const struct eth_addr a
,
225 const struct eth_addr b
)
227 return memcmp(&a
, &b
, sizeof a
);
230 static inline bool eth_addr_equals(const struct eth_addr a
,
231 const struct eth_addr b
)
233 return !eth_addr_compare_3way(a
, b
);
236 static inline bool eth_addr_equal_except(const struct eth_addr a
,
237 const struct eth_addr b
,
238 const struct eth_addr mask
)
240 return !(((a
.be16
[0] ^ b
.be16
[0]) & mask
.be16
[0])
241 || ((a
.be16
[1] ^ b
.be16
[1]) & mask
.be16
[1])
242 || ((a
.be16
[2] ^ b
.be16
[2]) & mask
.be16
[2]));
245 static inline uint64_t eth_addr_to_uint64(const struct eth_addr ea
)
247 return (((uint64_t) ntohs(ea
.be16
[0]) << 32)
248 | ((uint64_t) ntohs(ea
.be16
[1]) << 16)
249 | ntohs(ea
.be16
[2]));
252 static inline uint64_t eth_addr_vlan_to_uint64(const struct eth_addr ea
,
255 return (((uint64_t)vlan
<< 48) | eth_addr_to_uint64(ea
));
258 static inline void eth_addr_from_uint64(uint64_t x
, struct eth_addr
*ea
)
260 ea
->be16
[0] = htons(x
>> 32);
261 ea
->be16
[1] = htons((x
& 0xFFFF0000) >> 16);
262 ea
->be16
[2] = htons(x
& 0xFFFF);
265 static inline struct eth_addr
eth_addr_invert(const struct eth_addr src
)
269 for (int i
= 0; i
< ARRAY_SIZE(src
.be16
); i
++) {
270 dst
.be16
[i
] = ~src
.be16
[i
];
276 static inline void eth_addr_mark_random(struct eth_addr
*ea
)
278 ea
->ea
[0] &= ~1; /* Unicast. */
279 ea
->ea
[0] |= 2; /* Private. */
282 static inline void eth_addr_random(struct eth_addr
*ea
)
284 random_bytes((uint8_t *)ea
, sizeof *ea
);
285 eth_addr_mark_random(ea
);
288 static inline void eth_addr_nicira_random(struct eth_addr
*ea
)
292 /* Set the OUI to the Nicira one. */
297 /* Set the top bit to indicate random Nicira address. */
300 static inline uint32_t hash_mac(const struct eth_addr ea
,
301 const uint16_t vlan
, const uint32_t basis
)
303 return hash_uint64_basis(eth_addr_vlan_to_uint64(ea
, vlan
), basis
);
306 bool eth_addr_is_reserved(const struct eth_addr
);
307 bool eth_addr_from_string(const char *, struct eth_addr
*);
309 void compose_rarp(struct dp_packet
*, const struct eth_addr
);
311 void eth_push_vlan(struct dp_packet
*, ovs_be16 tpid
, ovs_be16 tci
);
312 void eth_pop_vlan(struct dp_packet
*);
314 const char *eth_from_hex(const char *hex
, struct dp_packet
**packetp
);
315 void eth_format_masked(const struct eth_addr ea
,
316 const struct eth_addr
*mask
, struct ds
*s
);
318 void set_mpls_lse(struct dp_packet
*, ovs_be32 label
);
319 void push_mpls(struct dp_packet
*packet
, ovs_be16 ethtype
, ovs_be32 lse
);
320 void pop_mpls(struct dp_packet
*, ovs_be16 ethtype
);
322 void set_mpls_lse_ttl(ovs_be32
*lse
, uint8_t ttl
);
323 void set_mpls_lse_tc(ovs_be32
*lse
, uint8_t tc
);
324 void set_mpls_lse_label(ovs_be32
*lse
, ovs_be32 label
);
325 void set_mpls_lse_bos(ovs_be32
*lse
, uint8_t bos
);
326 ovs_be32
set_mpls_lse_values(uint8_t ttl
, uint8_t tc
, uint8_t bos
,
331 * struct eth_addr mac;
333 * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
336 #define ETH_ADDR_FMT \
337 "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
338 #define ETH_ADDR_ARGS(EA) ETH_ADDR_BYTES_ARGS((EA).ea)
339 #define ETH_ADDR_BYTES_ARGS(EAB) \
340 (EAB)[0], (EAB)[1], (EAB)[2], (EAB)[3], (EAB)[4], (EAB)[5]
341 #define ETH_ADDR_STRLEN 17
345 * char *string = "1 00:11:22:33:44:55 2";
346 * struct eth_addr mac;
349 * if (ovs_scan(string, "%d"ETH_ADDR_SCAN_FMT"%d",
350 * &a, ETH_ADDR_SCAN_ARGS(mac), &b)) {
354 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
355 #define ETH_ADDR_SCAN_ARGS(EA) \
356 &(EA).ea[0], &(EA).ea[1], &(EA).ea[2], &(EA).ea[3], &(EA).ea[4], &(EA).ea[5]
358 #define ETH_TYPE_IP 0x0800
359 #define ETH_TYPE_ARP 0x0806
360 #define ETH_TYPE_TEB 0x6558
361 #define ETH_TYPE_VLAN_8021Q 0x8100
362 #define ETH_TYPE_VLAN ETH_TYPE_VLAN_8021Q
363 #define ETH_TYPE_VLAN_8021AD 0x88a8
364 #define ETH_TYPE_IPV6 0x86dd
365 #define ETH_TYPE_LACP 0x8809
366 #define ETH_TYPE_RARP 0x8035
367 #define ETH_TYPE_MPLS 0x8847
368 #define ETH_TYPE_MPLS_MCAST 0x8848
370 static inline bool eth_type_mpls(ovs_be16 eth_type
)
372 return eth_type
== htons(ETH_TYPE_MPLS
) ||
373 eth_type
== htons(ETH_TYPE_MPLS_MCAST
);
376 static inline bool eth_type_vlan(ovs_be16 eth_type
)
378 return eth_type
== htons(ETH_TYPE_VLAN_8021Q
) ||
379 eth_type
== htons(ETH_TYPE_VLAN_8021AD
);
383 /* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
385 #define ETH_TYPE_MIN 0x600
387 #define ETH_HEADER_LEN 14
388 #define ETH_PAYLOAD_MIN 46
389 #define ETH_PAYLOAD_MAX 1500
390 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
391 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
392 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
395 struct eth_addr eth_dst
;
396 struct eth_addr eth_src
;
399 BUILD_ASSERT_DECL(ETH_HEADER_LEN
== sizeof(struct eth_header
));
401 #define LLC_DSAP_SNAP 0xaa
402 #define LLC_SSAP_SNAP 0xaa
403 #define LLC_CNTL_SNAP 3
405 #define LLC_HEADER_LEN 3
412 BUILD_ASSERT_DECL(LLC_HEADER_LEN
== sizeof(struct llc_header
));
414 /* LLC field values used for STP frames. */
415 #define STP_LLC_SSAP 0x42
416 #define STP_LLC_DSAP 0x42
417 #define STP_LLC_CNTL 0x03
419 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
420 sizeof(SNAP_ORG_ETHERNET) == 3. */
421 #define SNAP_HEADER_LEN 5
427 BUILD_ASSERT_DECL(SNAP_HEADER_LEN
== sizeof(struct snap_header
));
429 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
431 struct llc_snap_header
{
432 struct llc_header llc
;
433 struct snap_header snap
;
435 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN
== sizeof(struct llc_snap_header
));
437 #define VLAN_VID_MASK 0x0fff
438 #define VLAN_VID_SHIFT 0
440 #define VLAN_PCP_MASK 0xe000
441 #define VLAN_PCP_SHIFT 13
443 #define VLAN_CFI 0x1000
444 #define VLAN_CFI_SHIFT 12
446 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
447 * returns the VLAN ID in host byte order. */
448 static inline uint16_t
449 vlan_tci_to_vid(ovs_be16 vlan_tci
)
451 return (ntohs(vlan_tci
) & VLAN_VID_MASK
) >> VLAN_VID_SHIFT
;
454 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
455 * returns the priority code point (PCP) in host byte order. */
457 vlan_tci_to_pcp(ovs_be16 vlan_tci
)
459 return (ntohs(vlan_tci
) & VLAN_PCP_MASK
) >> VLAN_PCP_SHIFT
;
462 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
463 * returns the Canonical Format Indicator (CFI). */
465 vlan_tci_to_cfi(ovs_be16 vlan_tci
)
467 return (vlan_tci
& htons(VLAN_CFI
)) != 0;
470 #define VLAN_HEADER_LEN 4
472 ovs_be16 vlan_tci
; /* Lowest 12 bits are VLAN ID. */
473 ovs_be16 vlan_next_type
;
475 BUILD_ASSERT_DECL(VLAN_HEADER_LEN
== sizeof(struct vlan_header
));
477 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
479 struct vlan_eth_header
{
480 struct eth_addr veth_dst
;
481 struct eth_addr veth_src
;
482 ovs_be16 veth_type
; /* Always htons(ETH_TYPE_VLAN). */
483 ovs_be16 veth_tci
; /* Lowest 12 bits are VLAN ID. */
484 ovs_be16 veth_next_type
;
486 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN
== sizeof(struct vlan_eth_header
));
488 /* MPLS related definitions */
489 #define MPLS_TTL_MASK 0x000000ff
490 #define MPLS_TTL_SHIFT 0
492 #define MPLS_BOS_MASK 0x00000100
493 #define MPLS_BOS_SHIFT 8
495 #define MPLS_TC_MASK 0x00000e00
496 #define MPLS_TC_SHIFT 9
498 #define MPLS_LABEL_MASK 0xfffff000
499 #define MPLS_LABEL_SHIFT 12
504 ovs_16aligned_be32 mpls_lse
;
506 BUILD_ASSERT_DECL(MPLS_HLEN
== sizeof(struct mpls_hdr
));
508 /* Given a mpls label stack entry in network byte order
509 * return mpls label in host byte order */
510 static inline uint32_t
511 mpls_lse_to_label(ovs_be32 mpls_lse
)
513 return (ntohl(mpls_lse
) & MPLS_LABEL_MASK
) >> MPLS_LABEL_SHIFT
;
516 /* Given a mpls label stack entry in network byte order
518 static inline uint8_t
519 mpls_lse_to_tc(ovs_be32 mpls_lse
)
521 return (ntohl(mpls_lse
) & MPLS_TC_MASK
) >> MPLS_TC_SHIFT
;
524 /* Given a mpls label stack entry in network byte order
526 static inline uint8_t
527 mpls_lse_to_ttl(ovs_be32 mpls_lse
)
529 return (ntohl(mpls_lse
) & MPLS_TTL_MASK
) >> MPLS_TTL_SHIFT
;
532 /* Set TTL in mpls lse. */
534 flow_set_mpls_lse_ttl(ovs_be32
*mpls_lse
, uint8_t ttl
)
536 *mpls_lse
&= ~htonl(MPLS_TTL_MASK
);
537 *mpls_lse
|= htonl(ttl
<< MPLS_TTL_SHIFT
);
540 /* Given a mpls label stack entry in network byte order
541 * return mpls BoS bit */
542 static inline uint8_t
543 mpls_lse_to_bos(ovs_be32 mpls_lse
)
545 return (mpls_lse
& htonl(MPLS_BOS_MASK
)) != 0;
548 #define IP_FMT "%"PRIu32".%"PRIu32".%"PRIu32".%"PRIu32
549 #define IP_ARGS(ip) \
551 (ntohl(ip) >> 16) & 0xff, \
552 (ntohl(ip) >> 8) & 0xff, \
557 * char *string = "1 33.44.55.66 2";
561 * if (ovs_scan(string, "%d"IP_SCAN_FMT"%d", &a, IP_SCAN_ARGS(&ip), &b)) {
565 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
566 #define IP_SCAN_ARGS(ip) \
567 ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]), \
568 &((uint8_t *) ip)[1], \
569 &((uint8_t *) ip)[2], \
572 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
573 * high-order 1-bits and 32-N low-order 0-bits. */
575 ip_is_cidr(ovs_be32 netmask
)
577 uint32_t x
= ~ntohl(netmask
);
578 return !(x
& (x
+ 1));
581 ip_is_multicast(ovs_be32 ip
)
583 return (ip
& htonl(0xf0000000)) == htonl(0xe0000000);
586 ip_is_local_multicast(ovs_be32 ip
)
588 return (ip
& htonl(0xffffff00)) == htonl(0xe0000000);
590 int ip_count_cidr_bits(ovs_be32 netmask
);
591 void ip_format_masked(ovs_be32 ip
, ovs_be32 mask
, struct ds
*);
592 bool ip_parse(const char *s
, ovs_be32
*ip
);
593 char *ip_parse_masked(const char *s
, ovs_be32
*ip
, ovs_be32
*mask
)
594 OVS_WARN_UNUSED_RESULT
;
595 char *ip_parse_cidr(const char *s
, ovs_be32
*ip
, unsigned int *plen
)
596 OVS_WARN_UNUSED_RESULT
;
597 char *ip_parse_masked_len(const char *s
, int *n
, ovs_be32
*ip
, ovs_be32
*mask
)
598 OVS_WARN_UNUSED_RESULT
;
599 char *ip_parse_cidr_len(const char *s
, int *n
, ovs_be32
*ip
,
601 OVS_WARN_UNUSED_RESULT
;
603 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
604 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
605 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
608 #define IPPROTO_SCTP 132
612 #define IP_ECN_NOT_ECT 0x0
613 #define IP_ECN_ECT_1 0x01
614 #define IP_ECN_ECT_0 0x02
615 #define IP_ECN_CE 0x03
616 #define IP_ECN_MASK 0x03
617 #define IP_DSCP_MASK 0xfc
621 #define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
622 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
623 #define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
624 #define IP_IS_FRAGMENT(ip_frag_off) \
625 ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
627 #define IP_HEADER_LEN 20
633 ovs_be16 ip_frag_off
;
637 ovs_16aligned_be32 ip_src
;
638 ovs_16aligned_be32 ip_dst
;
641 BUILD_ASSERT_DECL(IP_HEADER_LEN
== sizeof(struct ip_header
));
643 #define ICMP_HEADER_LEN 8
657 ovs_16aligned_be32 gateway
;
660 BUILD_ASSERT_DECL(ICMP_HEADER_LEN
== sizeof(struct icmp_header
));
662 #define IGMP_HEADER_LEN 8
667 ovs_16aligned_be32 group
;
669 BUILD_ASSERT_DECL(IGMP_HEADER_LEN
== sizeof(struct igmp_header
));
671 #define IGMPV3_HEADER_LEN 8
672 struct igmpv3_header
{
679 BUILD_ASSERT_DECL(IGMPV3_HEADER_LEN
== sizeof(struct igmpv3_header
));
681 #define IGMPV3_RECORD_LEN 8
682 struct igmpv3_record
{
686 ovs_16aligned_be32 maddr
;
688 BUILD_ASSERT_DECL(IGMPV3_RECORD_LEN
== sizeof(struct igmpv3_record
));
690 #define IGMP_HOST_MEMBERSHIP_QUERY 0x11 /* From RFC1112 */
691 #define IGMP_HOST_MEMBERSHIP_REPORT 0x12 /* Ditto */
692 #define IGMPV2_HOST_MEMBERSHIP_REPORT 0x16 /* V2 version of 0x12 */
693 #define IGMP_HOST_LEAVE_MESSAGE 0x17
694 #define IGMPV3_HOST_MEMBERSHIP_REPORT 0x22 /* V3 version of 0x12 */
697 * IGMPv3 and MLDv2 use the same codes.
699 #define IGMPV3_MODE_IS_INCLUDE 1
700 #define IGMPV3_MODE_IS_EXCLUDE 2
701 #define IGMPV3_CHANGE_TO_INCLUDE_MODE 3
702 #define IGMPV3_CHANGE_TO_EXCLUDE_MODE 4
703 #define IGMPV3_ALLOW_NEW_SOURCES 5
704 #define IGMPV3_BLOCK_OLD_SOURCES 6
706 #define SCTP_HEADER_LEN 12
710 ovs_16aligned_be32 sctp_vtag
;
711 ovs_16aligned_be32 sctp_csum
;
713 BUILD_ASSERT_DECL(SCTP_HEADER_LEN
== sizeof(struct sctp_header
));
715 #define UDP_HEADER_LEN 8
722 BUILD_ASSERT_DECL(UDP_HEADER_LEN
== sizeof(struct udp_header
));
724 #define TCP_FIN 0x001
725 #define TCP_SYN 0x002
726 #define TCP_RST 0x004
727 #define TCP_PSH 0x008
728 #define TCP_ACK 0x010
729 #define TCP_URG 0x020
730 #define TCP_ECE 0x040
731 #define TCP_CWR 0x080
734 #define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
735 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x0fff)
736 #define TCP_FLAGS_BE16(tcp_ctl) ((tcp_ctl) & htons(0x0fff))
737 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
739 #define TCP_HEADER_LEN 20
743 ovs_16aligned_be32 tcp_seq
;
744 ovs_16aligned_be32 tcp_ack
;
750 BUILD_ASSERT_DECL(TCP_HEADER_LEN
== sizeof(struct tcp_header
));
752 /* Connection states */
755 CS_ESTABLISHED_BIT
= 1,
757 CS_REPLY_DIR_BIT
= 3,
765 CS_NEW
= (1 << CS_NEW_BIT
),
766 CS_ESTABLISHED
= (1 << CS_ESTABLISHED_BIT
),
767 CS_RELATED
= (1 << CS_RELATED_BIT
),
768 CS_REPLY_DIR
= (1 << CS_REPLY_DIR_BIT
),
769 CS_INVALID
= (1 << CS_INVALID_BIT
),
770 CS_TRACKED
= (1 << CS_TRACKED_BIT
),
771 CS_SRC_NAT
= (1 << CS_SRC_NAT_BIT
),
772 CS_DST_NAT
= (1 << CS_DST_NAT_BIT
),
775 /* Undefined connection state bits. */
776 #define CS_SUPPORTED_MASK (CS_NEW | CS_ESTABLISHED | CS_RELATED \
777 | CS_INVALID | CS_REPLY_DIR | CS_TRACKED \
778 | CS_SRC_NAT | CS_DST_NAT)
779 #define CS_UNSUPPORTED_MASK (~(uint32_t)CS_SUPPORTED_MASK)
781 #define ARP_HRD_ETHERNET 1
782 #define ARP_PRO_IP 0x0800
783 #define ARP_OP_REQUEST 1
784 #define ARP_OP_REPLY 2
785 #define ARP_OP_RARP 3
787 #define ARP_ETH_HEADER_LEN 28
788 struct arp_eth_header
{
789 /* Generic members. */
790 ovs_be16 ar_hrd
; /* Hardware type. */
791 ovs_be16 ar_pro
; /* Protocol type. */
792 uint8_t ar_hln
; /* Hardware address length. */
793 uint8_t ar_pln
; /* Protocol address length. */
794 ovs_be16 ar_op
; /* Opcode. */
796 /* Ethernet+IPv4 specific members. */
797 struct eth_addr ar_sha
; /* Sender hardware address. */
798 ovs_16aligned_be32 ar_spa
; /* Sender protocol address. */
799 struct eth_addr ar_tha
; /* Target hardware address. */
800 ovs_16aligned_be32 ar_tpa
; /* Target protocol address. */
802 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN
== sizeof(struct arp_eth_header
));
804 #define IPV6_HEADER_LEN 40
806 /* Like struct in6_addr, but whereas that struct requires 32-bit alignment on
807 * most implementations, this one only requires 16-bit alignment. */
808 union ovs_16aligned_in6_addr
{
810 ovs_16aligned_be32 be32
[4];
813 /* Like struct in6_hdr, but whereas that struct requires 32-bit alignment, this
814 * one only requires 16-bit alignment. */
815 struct ovs_16aligned_ip6_hdr
{
817 struct ovs_16aligned_ip6_hdrctl
{
818 ovs_16aligned_be32 ip6_un1_flow
;
819 ovs_be16 ip6_un1_plen
;
821 uint8_t ip6_un1_hlim
;
825 union ovs_16aligned_in6_addr ip6_src
;
826 union ovs_16aligned_in6_addr ip6_dst
;
829 /* Like struct in6_frag, but whereas that struct requires 32-bit alignment,
830 * this one only requires 16-bit alignment. */
831 struct ovs_16aligned_ip6_frag
{
833 uint8_t ip6f_reserved
;
835 ovs_16aligned_be32 ip6f_ident
;
838 #define ICMP6_HEADER_LEN 4
839 struct icmp6_header
{
842 ovs_be16 icmp6_cksum
;
844 BUILD_ASSERT_DECL(ICMP6_HEADER_LEN
== sizeof(struct icmp6_header
));
846 uint32_t packet_csum_pseudoheader6(const struct ovs_16aligned_ip6_hdr
*);
848 /* Neighbor Discovery option field.
849 * ND options are always a multiple of 8 bytes in size. */
852 uint8_t nd_opt_type
; /* Values defined in icmp6.h */
853 uint8_t nd_opt_len
; /* in units of 8 octets (the size of this struct) */
854 struct eth_addr nd_opt_mac
; /* Ethernet address in the case of SLL or TLL options */
856 BUILD_ASSERT_DECL(ND_OPT_LEN
== sizeof(struct ovs_nd_opt
));
858 /* Like struct nd_msg (from ndisc.h), but whereas that struct requires 32-bit
859 * alignment, this one only requires 16-bit alignment. */
860 #define ND_MSG_LEN 24
862 struct icmp6_header icmph
;
863 ovs_16aligned_be32 rco_flags
;
864 union ovs_16aligned_in6_addr target
;
865 struct ovs_nd_opt options
[0];
867 BUILD_ASSERT_DECL(ND_MSG_LEN
== sizeof(struct ovs_nd_msg
));
870 * Use the same struct for MLD and MLD2, naming members as the defined fields in
871 * in the corresponding version of the protocol, though they are reserved in the
874 #define MLD_HEADER_LEN 8
882 BUILD_ASSERT_DECL(MLD_HEADER_LEN
== sizeof(struct mld_header
));
884 #define MLD2_RECORD_LEN 20
889 union ovs_16aligned_in6_addr maddr
;
891 BUILD_ASSERT_DECL(MLD2_RECORD_LEN
== sizeof(struct mld2_record
));
893 #define MLD_QUERY 130
894 #define MLD_REPORT 131
896 #define MLD2_REPORT 143
898 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
899 #define IPV6_LABEL_MASK 0x000fffff
903 * char *string = "1 ::1 2";
904 * char ipv6_s[IPV6_SCAN_LEN + 1];
905 * struct in6_addr ipv6;
907 * if (ovs_scan(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b)
908 * && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
912 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
913 #define IPV6_SCAN_LEN 46
915 extern const struct in6_addr in6addr_exact
;
916 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
917 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
919 extern const struct in6_addr in6addr_all_hosts
;
920 #define IN6ADDR_ALL_HOSTS_INIT { { { 0xff,0x02,0x00,0x00,0x00,0x00,0x00,0x00, \
921 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x01 } } }
923 static inline bool ipv6_addr_equals(const struct in6_addr
*a
,
924 const struct in6_addr
*b
)
926 #ifdef IN6_ARE_ADDR_EQUAL
927 return IN6_ARE_ADDR_EQUAL(a
, b
);
929 return !memcmp(a
, b
, sizeof(*a
));
933 static inline bool ipv6_mask_is_any(const struct in6_addr
*mask
) {
934 return ipv6_addr_equals(mask
, &in6addr_any
);
937 static inline bool ipv6_mask_is_exact(const struct in6_addr
*mask
) {
938 return ipv6_addr_equals(mask
, &in6addr_exact
);
941 static inline bool ipv6_is_all_hosts(const struct in6_addr
*addr
) {
942 return ipv6_addr_equals(addr
, &in6addr_all_hosts
);
945 static inline bool ipv6_addr_is_set(const struct in6_addr
*addr
) {
946 return !ipv6_addr_equals(addr
, &in6addr_any
);
949 static inline bool ipv6_addr_is_multicast(const struct in6_addr
*ip
) {
950 return ip
->s6_addr
[0] == 0xff;
953 static inline struct in6_addr
954 in6_addr_mapped_ipv4(ovs_be32 ip4
)
956 struct in6_addr ip6
= { .s6_addr
= { [10] = 0xff, [11] = 0xff } };
957 memcpy(&ip6
.s6_addr
[12], &ip4
, 4);
962 in6_addr_set_mapped_ipv4(struct in6_addr
*ip6
, ovs_be32 ip4
)
964 *ip6
= in6_addr_mapped_ipv4(ip4
);
967 static inline ovs_be32
968 in6_addr_get_mapped_ipv4(const struct in6_addr
*addr
)
970 union ovs_16aligned_in6_addr
*taddr
= (void *) addr
;
971 if (IN6_IS_ADDR_V4MAPPED(addr
)) {
972 return get_16aligned_be32(&taddr
->be32
[3]);
979 in6_addr_solicited_node(struct in6_addr
*addr
, const struct in6_addr
*ip6
)
981 union ovs_16aligned_in6_addr
*taddr
= (void *) addr
;
982 memset(taddr
->be16
, 0, sizeof(taddr
->be16
));
983 taddr
->be16
[0] = htons(0xff02);
984 taddr
->be16
[5] = htons(0x1);
985 taddr
->be16
[6] = htons(0xff00);
986 memcpy(&addr
->s6_addr
[13], &ip6
->s6_addr
[13], 3);
990 * Generates ipv6 link local address from the given eth addr
991 * with prefix 'fe80::/64' and stores it in 'lla'
994 in6_generate_lla(struct eth_addr ea
, struct in6_addr
*lla
)
996 union ovs_16aligned_in6_addr
*taddr
= (void *) lla
;
997 memset(taddr
->be16
, 0, sizeof(taddr
->be16
));
998 taddr
->be16
[0] = htons(0xfe80);
999 taddr
->be16
[4] = htons(((ea
.ea
[0] ^ 0x02) << 8) | ea
.ea
[1]);
1000 taddr
->be16
[5] = htons(ea
.ea
[2] << 8 | 0x00ff);
1001 taddr
->be16
[6] = htons(0xfe << 8 | ea
.ea
[3]);
1002 taddr
->be16
[7] = ea
.be16
[2];
1006 ipv6_multicast_to_ethernet(struct eth_addr
*eth
, const struct in6_addr
*ip6
)
1010 eth
->ea
[2] = ip6
->s6_addr
[12];
1011 eth
->ea
[3] = ip6
->s6_addr
[13];
1012 eth
->ea
[4] = ip6
->s6_addr
[14];
1013 eth
->ea
[5] = ip6
->s6_addr
[15];
1016 static inline bool dl_type_is_ip_any(ovs_be16 dl_type
)
1018 return dl_type
== htons(ETH_TYPE_IP
)
1019 || dl_type
== htons(ETH_TYPE_IPV6
);
1024 /* GRE protocol header */
1025 struct gre_base_hdr
{
1030 #define GRE_CSUM 0x8000
1031 #define GRE_ROUTING 0x4000
1032 #define GRE_KEY 0x2000
1033 #define GRE_SEQ 0x1000
1034 #define GRE_STRICT 0x0800
1035 #define GRE_REC 0x0700
1036 #define GRE_FLAGS 0x00F8
1037 #define GRE_VERSION 0x0007
1039 /* VXLAN protocol header */
1041 ovs_16aligned_be32 vx_flags
;
1042 ovs_16aligned_be32 vx_vni
;
1045 #define VXLAN_FLAGS 0x08000000 /* struct vxlanhdr.vx_flags required value. */
1047 void ipv6_format_addr(const struct in6_addr
*addr
, struct ds
*);
1048 void ipv6_format_addr_bracket(const struct in6_addr
*addr
, struct ds
*,
1050 void ipv6_format_mapped(const struct in6_addr
*addr
, struct ds
*);
1051 void ipv6_format_masked(const struct in6_addr
*addr
,
1052 const struct in6_addr
*mask
, struct ds
*);
1053 const char * ipv6_string_mapped(char *addr_str
, const struct in6_addr
*addr
);
1054 struct in6_addr
ipv6_addr_bitand(const struct in6_addr
*src
,
1055 const struct in6_addr
*mask
);
1056 struct in6_addr
ipv6_create_mask(int mask
);
1057 int ipv6_count_cidr_bits(const struct in6_addr
*netmask
);
1058 bool ipv6_is_cidr(const struct in6_addr
*netmask
);
1060 bool ipv6_parse(const char *s
, struct in6_addr
*ip
);
1061 char *ipv6_parse_masked(const char *s
, struct in6_addr
*ipv6
,
1062 struct in6_addr
*mask
);
1063 char *ipv6_parse_cidr(const char *s
, struct in6_addr
*ip
, unsigned int *plen
)
1064 OVS_WARN_UNUSED_RESULT
;
1065 char *ipv6_parse_masked_len(const char *s
, int *n
, struct in6_addr
*ipv6
,
1066 struct in6_addr
*mask
);
1067 char *ipv6_parse_cidr_len(const char *s
, int *n
, struct in6_addr
*ip
,
1069 OVS_WARN_UNUSED_RESULT
;
1071 void *eth_compose(struct dp_packet
*, const struct eth_addr eth_dst
,
1072 const struct eth_addr eth_src
, uint16_t eth_type
,
1074 void *snap_compose(struct dp_packet
*, const struct eth_addr eth_dst
,
1075 const struct eth_addr eth_src
,
1076 unsigned int oui
, uint16_t snap_type
, size_t size
);
1077 void packet_set_ipv4(struct dp_packet
*, ovs_be32 src
, ovs_be32 dst
, uint8_t tos
,
1079 void packet_set_ipv6(struct dp_packet
*, uint8_t proto
, const ovs_be32 src
[4],
1080 const ovs_be32 dst
[4], uint8_t tc
,
1081 ovs_be32 fl
, uint8_t hlmit
);
1082 void packet_set_tcp_port(struct dp_packet
*, ovs_be16 src
, ovs_be16 dst
);
1083 void packet_set_udp_port(struct dp_packet
*, ovs_be16 src
, ovs_be16 dst
);
1084 void packet_set_sctp_port(struct dp_packet
*, ovs_be16 src
, ovs_be16 dst
);
1085 void packet_set_icmp(struct dp_packet
*, uint8_t type
, uint8_t code
);
1086 void packet_set_nd(struct dp_packet
*, const ovs_be32 target
[4],
1087 const struct eth_addr sll
, const struct eth_addr tll
);
1089 void packet_format_tcp_flags(struct ds
*, uint16_t);
1090 const char *packet_tcp_flag_to_string(uint32_t flag
);
1091 void compose_arp__(struct dp_packet
*);
1092 void compose_arp(struct dp_packet
*, uint16_t arp_op
,
1093 const struct eth_addr arp_sha
,
1094 const struct eth_addr arp_tha
, bool broadcast
,
1095 ovs_be32 arp_spa
, ovs_be32 arp_tpa
);
1096 void compose_nd(struct dp_packet
*, const struct eth_addr eth_src
,
1097 struct in6_addr
*, struct in6_addr
*);
1098 uint32_t packet_csum_pseudoheader(const struct ip_header
*);
1100 #endif /* packets.h */