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>
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 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 uint16_t eth_mpls_depth(const struct ofpbuf *packet);
145 void set_ethertype(struct ofpbuf *packet, ovs_be16 eth_type);
147 const char *eth_from_hex(const char *hex, struct ofpbuf **packetp);
148 void eth_format_masked(const uint8_t eth[ETH_ADDR_LEN],
149 const uint8_t mask[ETH_ADDR_LEN], struct ds *s);
150 void eth_addr_bitand(const uint8_t src[ETH_ADDR_LEN],
151 const uint8_t mask[ETH_ADDR_LEN],
152 uint8_t dst[ETH_ADDR_LEN]);
154 void set_mpls_lse(struct ofpbuf *, ovs_be32 label);
155 void push_mpls(struct ofpbuf *packet, ovs_be16 ethtype, ovs_be32 lse);
156 void pop_mpls(struct ofpbuf *, ovs_be16 ethtype);
158 void set_mpls_lse_ttl(ovs_be32 *lse, uint8_t ttl);
159 void set_mpls_lse_tc(ovs_be32 *lse, uint8_t tc);
160 void set_mpls_lse_label(ovs_be32 *lse, ovs_be32 label);
161 void set_mpls_lse_bos(ovs_be32 *lse, uint8_t bos);
162 ovs_be32 set_mpls_lse_values(uint8_t ttl, uint8_t tc, uint8_t bos,
167 * uint8_t mac[ETH_ADDR_LEN];
169 * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
172 #define ETH_ADDR_FMT \
173 "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
174 #define ETH_ADDR_ARGS(ea) \
175 (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
179 * char *string = "1 00:11:22:33:44:55 2";
180 * uint8_t mac[ETH_ADDR_LEN];
183 * if (sscanf(string, "%d"ETH_ADDR_SCAN_FMT"%d",
184 * &a, ETH_ADDR_SCAN_ARGS(mac), &b) == 1 + ETH_ADDR_SCAN_COUNT + 1) {
188 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
189 #define ETH_ADDR_SCAN_ARGS(ea) \
190 &(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
191 #define ETH_ADDR_SCAN_COUNT 6
193 #define ETH_TYPE_IP 0x0800
194 #define ETH_TYPE_ARP 0x0806
195 #define ETH_TYPE_VLAN_8021Q 0x8100
196 #define ETH_TYPE_VLAN ETH_TYPE_VLAN_8021Q
197 #define ETH_TYPE_VLAN_8021AD 0x88a8
198 #define ETH_TYPE_IPV6 0x86dd
199 #define ETH_TYPE_LACP 0x8809
200 #define ETH_TYPE_RARP 0x8035
201 #define ETH_TYPE_MPLS 0x8847
202 #define ETH_TYPE_MPLS_MCAST 0x8848
204 static inline bool eth_type_mpls(ovs_be16 eth_type)
206 return eth_type == htons(ETH_TYPE_MPLS) ||
207 eth_type == htons(ETH_TYPE_MPLS_MCAST);
210 /* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
212 #define ETH_TYPE_MIN 0x600
214 #define ETH_HEADER_LEN 14
215 #define ETH_PAYLOAD_MIN 46
216 #define ETH_PAYLOAD_MAX 1500
217 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
218 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
219 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
221 uint8_t eth_dst[ETH_ADDR_LEN];
222 uint8_t eth_src[ETH_ADDR_LEN];
224 } __attribute__((packed));
225 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
227 #define LLC_DSAP_SNAP 0xaa
228 #define LLC_SSAP_SNAP 0xaa
229 #define LLC_CNTL_SNAP 3
231 #define LLC_HEADER_LEN 3
236 } __attribute__((packed));
237 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
239 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
240 sizeof(SNAP_ORG_ETHERNET) == 3. */
241 #define SNAP_HEADER_LEN 5
245 } __attribute__((packed));
246 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
248 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
249 struct llc_snap_header {
250 struct llc_header llc;
251 struct snap_header snap;
252 } __attribute__((packed));
253 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
255 #define VLAN_VID_MASK 0x0fff
256 #define VLAN_VID_SHIFT 0
258 #define VLAN_PCP_MASK 0xe000
259 #define VLAN_PCP_SHIFT 13
261 #define VLAN_CFI 0x1000
263 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
264 * returns the VLAN ID in host byte order. */
265 static inline uint16_t
266 vlan_tci_to_vid(ovs_be16 vlan_tci)
268 return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
271 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
272 * returns the priority code point (PCP) in host byte order. */
274 vlan_tci_to_pcp(ovs_be16 vlan_tci)
276 return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
279 #define VLAN_HEADER_LEN 4
281 ovs_be16 vlan_tci; /* Lowest 12 bits are VLAN ID. */
282 ovs_be16 vlan_next_type;
284 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
286 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
287 struct vlan_eth_header {
288 uint8_t veth_dst[ETH_ADDR_LEN];
289 uint8_t veth_src[ETH_ADDR_LEN];
290 ovs_be16 veth_type; /* Always htons(ETH_TYPE_VLAN). */
291 ovs_be16 veth_tci; /* Lowest 12 bits are VLAN ID. */
292 ovs_be16 veth_next_type;
293 } __attribute__((packed));
294 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
296 /* MPLS related definitions */
297 #define MPLS_TTL_MASK 0x000000ff
298 #define MPLS_TTL_SHIFT 0
300 #define MPLS_BOS_MASK 0x00000100
301 #define MPLS_BOS_SHIFT 8
303 #define MPLS_TC_MASK 0x00000e00
304 #define MPLS_TC_SHIFT 9
306 #define MPLS_LABEL_MASK 0xfffff000
307 #define MPLS_LABEL_SHIFT 12
314 BUILD_ASSERT_DECL(MPLS_HLEN == sizeof(struct mpls_hdr));
316 /* Given a mpls label stack entry in network byte order
317 * return mpls label in host byte order */
318 static inline uint32_t
319 mpls_lse_to_label(ovs_be32 mpls_lse)
321 return (ntohl(mpls_lse) & MPLS_LABEL_MASK) >> MPLS_LABEL_SHIFT;
324 /* Given a mpls label stack entry in network byte order
326 static inline uint8_t
327 mpls_lse_to_tc(ovs_be32 mpls_lse)
329 return (ntohl(mpls_lse) & MPLS_TC_MASK) >> MPLS_TC_SHIFT;
332 /* Given a mpls label stack entry in network byte order
334 static inline uint8_t
335 mpls_lse_to_ttl(ovs_be32 mpls_lse)
337 return (ntohl(mpls_lse) & MPLS_TTL_MASK) >> MPLS_TTL_SHIFT;
340 /* Set TTL in mpls lse. */
342 flow_set_mpls_lse_ttl(ovs_be32 *mpls_lse, uint8_t ttl)
344 *mpls_lse &= ~htonl(MPLS_TTL_MASK);
345 *mpls_lse |= htonl(ttl << MPLS_TTL_SHIFT);
348 /* Given a mpls label stack entry in network byte order
349 * return mpls BoS bit */
350 static inline uint8_t
351 mpls_lse_to_bos(ovs_be32 mpls_lse)
353 return (mpls_lse & htonl(MPLS_BOS_MASK)) != 0;
356 #define IP_FMT "%"PRIu32".%"PRIu32".%"PRIu32".%"PRIu32
357 #define IP_ARGS(ip) \
359 (ntohl(ip) >> 16) & 0xff, \
360 (ntohl(ip) >> 8) & 0xff, \
365 * char *string = "1 33.44.55.66 2";
369 * if (sscanf(string, "%d"IP_SCAN_FMT"%d",
370 * &a, IP_SCAN_ARGS(&ip), &b) == 1 + IP_SCAN_COUNT + 1) {
374 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
375 #define IP_SCAN_ARGS(ip) \
376 ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]), \
377 &((uint8_t *) ip)[1], \
378 &((uint8_t *) ip)[2], \
380 #define IP_SCAN_COUNT 4
382 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
383 * high-order 1-bits and 32-N low-order 0-bits. */
385 ip_is_cidr(ovs_be32 netmask)
387 uint32_t x = ~ntohl(netmask);
388 return !(x & (x + 1));
391 ip_is_multicast(ovs_be32 ip)
393 return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
395 int ip_count_cidr_bits(ovs_be32 netmask);
396 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
398 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
399 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
400 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
403 #define IPPROTO_SCTP 132
407 #define IP_ECN_NOT_ECT 0x0
408 #define IP_ECN_ECT_1 0x01
409 #define IP_ECN_ECT_0 0x02
410 #define IP_ECN_CE 0x03
411 #define IP_ECN_MASK 0x03
412 #define IP_DSCP_MASK 0xfc
416 #define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
417 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
418 #define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
419 #define IP_IS_FRAGMENT(ip_frag_off) \
420 ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
422 #define IP_HEADER_LEN 20
428 ovs_be16 ip_frag_off;
435 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
437 #define ICMP_HEADER_LEN 8
453 uint8_t icmp_data[0];
455 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
457 #define UDP_HEADER_LEN 8
464 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
473 #define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
474 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x003f)
475 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
477 #define TCP_HEADER_LEN 20
488 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
490 #define ARP_HRD_ETHERNET 1
491 #define ARP_PRO_IP 0x0800
492 #define ARP_OP_REQUEST 1
493 #define ARP_OP_REPLY 2
494 #define ARP_OP_RARP 3
496 #define ARP_ETH_HEADER_LEN 28
497 struct arp_eth_header {
498 /* Generic members. */
499 ovs_be16 ar_hrd; /* Hardware type. */
500 ovs_be16 ar_pro; /* Protocol type. */
501 uint8_t ar_hln; /* Hardware address length. */
502 uint8_t ar_pln; /* Protocol address length. */
503 ovs_be16 ar_op; /* Opcode. */
505 /* Ethernet+IPv4 specific members. */
506 uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
507 ovs_be32 ar_spa; /* Sender protocol address. */
508 uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
509 ovs_be32 ar_tpa; /* Target protocol address. */
510 } __attribute__((packed));
511 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
513 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
514 #define IPV6_LABEL_MASK 0x000fffff
518 * char *string = "1 ::1 2";
519 * char ipv6_s[IPV6_SCAN_LEN + 1];
520 * struct in6_addr ipv6;
522 * if (sscanf(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b) == 3
523 * && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
527 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
528 #define IPV6_SCAN_LEN 46
530 extern const struct in6_addr in6addr_exact;
531 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
532 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
534 static inline bool ipv6_addr_equals(const struct in6_addr *a,
535 const struct in6_addr *b)
537 #ifdef IN6_ARE_ADDR_EQUAL
538 return IN6_ARE_ADDR_EQUAL(a, b);
540 return !memcmp(a, b, sizeof(*a));
544 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
545 return ipv6_addr_equals(mask, &in6addr_any);
548 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
549 return ipv6_addr_equals(mask, &in6addr_exact);
552 static inline bool dl_type_is_ip_any(ovs_be16 dl_type)
554 return dl_type == htons(ETH_TYPE_IP)
555 || dl_type == htons(ETH_TYPE_IPV6);
558 static inline bool is_ip_any(const struct flow *flow)
560 return dl_type_is_ip_any(flow->dl_type);
563 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
564 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
565 void print_ipv6_masked(struct ds *string, const struct in6_addr *addr,
566 const struct in6_addr *mask);
567 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
568 const struct in6_addr *mask);
569 struct in6_addr ipv6_create_mask(int mask);
570 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
571 bool ipv6_is_cidr(const struct in6_addr *netmask);
573 void *eth_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
574 const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
576 void *snap_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
577 const uint8_t eth_src[ETH_ADDR_LEN],
578 unsigned int oui, uint16_t snap_type, size_t size);
579 void packet_set_ipv4(struct ofpbuf *, ovs_be32 src, ovs_be32 dst, uint8_t tos,
581 void packet_set_ipv6(struct ofpbuf *, uint8_t proto, const ovs_be32 src[4],
582 const ovs_be32 dst[4], uint8_t tc,
583 ovs_be32 fl, uint8_t hlmit);
584 void packet_set_tcp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
585 void packet_set_udp_port(struct ofpbuf *, ovs_be16 src, ovs_be16 dst);
587 uint8_t packet_get_tcp_flags(const struct ofpbuf *, const struct flow *);
588 void packet_format_tcp_flags(struct ds *, uint8_t);
590 #endif /* packets.h */