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 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
187 /* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
189 #define ETH_TYPE_MIN 0x600
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)
198 uint8_t eth_dst[ETH_ADDR_LEN];
199 uint8_t eth_src[ETH_ADDR_LEN];
201 } __attribute__((packed));
202 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
204 #define LLC_DSAP_SNAP 0xaa
205 #define LLC_SSAP_SNAP 0xaa
206 #define LLC_CNTL_SNAP 3
208 #define LLC_HEADER_LEN 3
213 } __attribute__((packed));
214 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
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
222 } __attribute__((packed));
223 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
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));
232 #define ARP_HTYPE_ETH 0x0001
233 #define RARP_REQUEST_REVERSE 0x0003
235 #define RARP_HEADER_LEN 28
236 /* RARP header only for Ethernet-IP. */
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));
251 #define VLAN_VID_MASK 0x0fff
252 #define VLAN_VID_SHIFT 0
254 #define VLAN_PCP_MASK 0xe000
255 #define VLAN_PCP_SHIFT 13
257 #define VLAN_CFI 0x1000
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)
264 return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
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. */
270 vlan_tci_to_pcp(ovs_be16 vlan_tci)
272 return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
275 #define VLAN_HEADER_LEN 4
277 ovs_be16 vlan_tci; /* Lowest 12 bits are VLAN ID. */
278 ovs_be16 vlan_next_type;
280 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
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));
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], \
305 * char *string = "1 33.44.55.66 2";
309 * if (sscanf(string, "%d"IP_SCAN_FMT"%d",
310 * &a, IP_SCAN_ARGS(&ip), &b) == 1 + IP_SCAN_COUNT + 1) {
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], \
320 #define IP_SCAN_COUNT 4
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. */
325 ip_is_cidr(ovs_be32 netmask)
327 uint32_t x = ~ntohl(netmask);
328 return !(x & (x + 1));
331 ip_is_multicast(ovs_be32 ip)
333 return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
335 int ip_count_cidr_bits(ovs_be32 netmask);
336 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
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))
343 #define IPPROTO_SCTP 132
347 #define IP_ECN_MASK 0x03
348 #define IP_DSCP_MASK 0xfc
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))
358 #define IP_HEADER_LEN 20
364 ovs_be16 ip_frag_off;
371 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
373 #define ICMP_HEADER_LEN 8
389 uint8_t icmp_data[0];
391 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
393 #define UDP_HEADER_LEN 8
400 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
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)
413 #define TCP_HEADER_LEN 20
424 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
426 #define ARP_HRD_ETHERNET 1
427 #define ARP_PRO_IP 0x0800
428 #define ARP_OP_REQUEST 1
429 #define ARP_OP_REPLY 2
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. */
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));
448 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
449 #define IPV6_LABEL_MASK 0x000fffff
453 * char *string = "1 ::1 2";
454 * char ipv6_s[IPV6_SCAN_LEN + 1];
455 * struct in6_addr ipv6;
457 * if (sscanf(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b) == 3
458 * && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
462 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
463 #define IPV6_SCAN_LEN 46
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 } } }
469 static inline bool ipv6_addr_equals(const struct in6_addr *a,
470 const struct in6_addr *b)
472 #ifdef IN6_ARE_ADDR_EQUAL
473 return IN6_ARE_ADDR_EQUAL(a, b);
475 return !memcmp(a, b, sizeof(*a));
479 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
480 return ipv6_addr_equals(mask, &in6addr_any);
483 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
484 return ipv6_addr_equals(mask, &in6addr_exact);
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);
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,
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,
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);
508 uint8_t packet_get_tcp_flags(const struct ofpbuf *, const struct flow *);
509 void packet_format_tcp_flags(struct ds *, uint8_t);
511 #endif /* packets.h */