2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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/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 inline bool eth_addr_is_broadcast(const uint8_t ea[6])
49 return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
52 static inline bool eth_addr_is_multicast(const uint8_t ea[6])
56 static inline bool eth_addr_is_local(const uint8_t ea[6])
58 /* Local if it is either a locally administered address or a Nicira random
61 || (ea[0] == 0x00 && ea[1] == 0x23 && ea[2] == 0x20 && ea[3] & 0x80);
63 static inline bool eth_addr_is_zero(const uint8_t ea[6])
65 return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
68 static inline int eth_mask_is_exact(const uint8_t ea[ETH_ADDR_LEN])
70 return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
73 static inline int eth_addr_compare_3way(const uint8_t a[ETH_ADDR_LEN],
74 const uint8_t b[ETH_ADDR_LEN])
76 return memcmp(a, b, ETH_ADDR_LEN);
78 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
79 const uint8_t b[ETH_ADDR_LEN])
81 return !eth_addr_compare_3way(a, b);
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])
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]));
94 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
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)
103 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
112 static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
114 ea[0] &= ~1; /* Unicast. */
115 ea[0] |= 2; /* Private. */
117 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
119 random_bytes(ea, ETH_ADDR_LEN);
120 eth_addr_mark_random(ea);
122 static inline void eth_addr_nicira_random(uint8_t ea[ETH_ADDR_LEN])
126 /* Set the OUI to the Nicira one. */
131 /* Set the top bit to indicate random Nicira address. */
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]);
138 void compose_rarp(struct ofpbuf *, const uint8_t eth_src[ETH_ADDR_LEN]);
140 void eth_push_vlan(struct ofpbuf *, ovs_be16 tci);
141 void eth_pop_vlan(struct ofpbuf *);
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]);
152 * uint8_t mac[ETH_ADDR_LEN];
154 * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
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]
164 * char *string = "1 00:11:22:33:44:55 2";
165 * uint8_t mac[ETH_ADDR_LEN];
168 * if (sscanf(string, "%d"ETH_ADDR_SCAN_FMT"%d",
169 * &a, ETH_ADDR_SCAN_ARGS(mac), &b) == 1 + ETH_ADDR_SCAN_COUNT + 1) {
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
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
189 /* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
191 #define ETH_TYPE_MIN 0x600
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)
200 uint8_t eth_dst[ETH_ADDR_LEN];
201 uint8_t eth_src[ETH_ADDR_LEN];
203 } __attribute__((packed));
204 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
206 #define LLC_DSAP_SNAP 0xaa
207 #define LLC_SSAP_SNAP 0xaa
208 #define LLC_CNTL_SNAP 3
210 #define LLC_HEADER_LEN 3
215 } __attribute__((packed));
216 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
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
224 } __attribute__((packed));
225 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
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));
234 #define VLAN_VID_MASK 0x0fff
235 #define VLAN_VID_SHIFT 0
237 #define VLAN_PCP_MASK 0xe000
238 #define VLAN_PCP_SHIFT 13
240 #define VLAN_CFI 0x1000
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)
247 return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
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. */
253 vlan_tci_to_pcp(ovs_be16 vlan_tci)
255 return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
258 #define VLAN_HEADER_LEN 4
260 ovs_be16 vlan_tci; /* Lowest 12 bits are VLAN ID. */
261 ovs_be16 vlan_next_type;
263 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
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));
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], \
288 * char *string = "1 33.44.55.66 2";
292 * if (sscanf(string, "%d"IP_SCAN_FMT"%d",
293 * &a, IP_SCAN_ARGS(&ip), &b) == 1 + IP_SCAN_COUNT + 1) {
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], \
303 #define IP_SCAN_COUNT 4
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. */
308 ip_is_cidr(ovs_be32 netmask)
310 uint32_t x = ~ntohl(netmask);
311 return !(x & (x + 1));
314 ip_is_multicast(ovs_be32 ip)
316 return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
318 int ip_count_cidr_bits(ovs_be32 netmask);
319 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
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))
326 #define IPPROTO_SCTP 132
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
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))
345 #define IP_HEADER_LEN 20
351 ovs_be16 ip_frag_off;
358 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
360 #define ICMP_HEADER_LEN 8
376 uint8_t icmp_data[0];
378 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
380 #define UDP_HEADER_LEN 8
387 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
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)
400 #define TCP_HEADER_LEN 20
411 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
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
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. */
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));
436 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
437 #define IPV6_LABEL_MASK 0x000fffff
441 * char *string = "1 ::1 2";
442 * char ipv6_s[IPV6_SCAN_LEN + 1];
443 * struct in6_addr ipv6;
445 * if (sscanf(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b) == 3
446 * && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
450 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
451 #define IPV6_SCAN_LEN 46
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 } } }
457 static inline bool ipv6_addr_equals(const struct in6_addr *a,
458 const struct in6_addr *b)
460 #ifdef IN6_ARE_ADDR_EQUAL
461 return IN6_ARE_ADDR_EQUAL(a, b);
463 return !memcmp(a, b, sizeof(*a));
467 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
468 return ipv6_addr_equals(mask, &in6addr_any);
471 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
472 return ipv6_addr_equals(mask, &in6addr_exact);
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);
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,
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,
493 void packet_set_tcp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
494 void packet_set_udp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
496 uint8_t packet_get_tcp_flags(const struct ofpbuf *, const struct flow *);
497 void packet_format_tcp_flags(struct ds *, uint8_t);
499 #endif /* packets.h */