2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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"
33 bool dpid_from_string(const char *s, uint64_t *dpidp);
35 #define ETH_ADDR_LEN 6
37 static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] OVS_UNUSED
38 = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
40 static const uint8_t eth_addr_stp[ETH_ADDR_LEN] OVS_UNUSED
41 = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x01 };
43 static const uint8_t eth_addr_lacp[ETH_ADDR_LEN] OVS_UNUSED
44 = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x02 };
46 static inline bool eth_addr_is_broadcast(const uint8_t ea[6])
48 return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
51 static inline bool eth_addr_is_multicast(const uint8_t ea[6])
55 static inline bool eth_addr_is_local(const uint8_t ea[6])
57 /* Local if it is either a locally administered address or a Nicira random
60 || (ea[0] == 0x00 && ea[1] == 0x23 && ea[2] == 0x20 && !!(ea[3] & 0x80));
62 static inline bool eth_addr_is_zero(const uint8_t ea[6])
64 return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
66 static inline int eth_addr_compare_3way(const uint8_t a[ETH_ADDR_LEN],
67 const uint8_t b[ETH_ADDR_LEN])
69 return memcmp(a, b, ETH_ADDR_LEN);
71 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
72 const uint8_t b[ETH_ADDR_LEN])
74 return !eth_addr_compare_3way(a, b);
76 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
78 return (((uint64_t) ea[0] << 40)
79 | ((uint64_t) ea[1] << 32)
80 | ((uint64_t) ea[2] << 24)
81 | ((uint64_t) ea[3] << 16)
82 | ((uint64_t) ea[4] << 8)
85 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
94 static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
96 ea[0] &= ~1; /* Unicast. */
97 ea[0] |= 2; /* Private. */
99 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
101 random_bytes(ea, ETH_ADDR_LEN);
102 eth_addr_mark_random(ea);
104 static inline void eth_addr_nicira_random(uint8_t ea[ETH_ADDR_LEN])
108 /* Set the OUI to the Nicira one. */
113 /* Set the top bit to indicate random Nicira address. */
116 /* Returns true if 'ea' is a reserved multicast address, that a bridge must
117 * never forward, false otherwise. */
118 static inline bool eth_addr_is_reserved(const uint8_t ea[ETH_ADDR_LEN])
120 return (ea[0] == 0x01
125 && (ea[5] & 0xf0) == 0x00);
128 bool eth_addr_from_string(const char *, uint8_t ea[ETH_ADDR_LEN]);
130 void compose_benign_packet(struct ofpbuf *, const char *tag,
132 const uint8_t eth_src[ETH_ADDR_LEN]);
136 * uint8_t mac[ETH_ADDR_LEN];
138 * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
141 #define ETH_ADDR_FMT \
142 "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
143 #define ETH_ADDR_ARGS(ea) \
144 (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
148 * char *string = "1 00:11:22:33:44:55 2";
149 * uint8_t mac[ETH_ADDR_LEN];
152 * if (sscanf(string, "%d"ETH_ADDR_SCAN_FMT"%d",
153 * &a, ETH_ADDR_SCAN_ARGS(mac), &b) == 1 + ETH_ADDR_SCAN_COUNT + 1) {
157 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
158 #define ETH_ADDR_SCAN_ARGS(ea) \
159 &(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
160 #define ETH_ADDR_SCAN_COUNT 6
162 #define ETH_TYPE_IP 0x0800
163 #define ETH_TYPE_ARP 0x0806
164 #define ETH_TYPE_VLAN 0x8100
165 #define ETH_TYPE_IPV6 0x86dd
166 #define ETH_TYPE_LACP 0x8809
168 /* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
170 #define ETH_TYPE_MIN 0x600
172 #define ETH_HEADER_LEN 14
173 #define ETH_PAYLOAD_MIN 46
174 #define ETH_PAYLOAD_MAX 1500
175 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
176 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
177 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
179 uint8_t eth_dst[ETH_ADDR_LEN];
180 uint8_t eth_src[ETH_ADDR_LEN];
182 } __attribute__((packed));
183 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
185 #define LLC_DSAP_SNAP 0xaa
186 #define LLC_SSAP_SNAP 0xaa
187 #define LLC_CNTL_SNAP 3
189 #define LLC_HEADER_LEN 3
194 } __attribute__((packed));
195 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
197 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
198 sizeof(SNAP_ORG_ETHERNET) == 3. */
199 #define SNAP_HEADER_LEN 5
203 } __attribute__((packed));
204 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
206 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
207 struct llc_snap_header {
208 struct llc_header llc;
209 struct snap_header snap;
210 } __attribute__((packed));
211 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
213 #define VLAN_VID_MASK 0x0fff
214 #define VLAN_VID_SHIFT 0
216 #define VLAN_PCP_MASK 0xe000
217 #define VLAN_PCP_SHIFT 13
219 #define VLAN_CFI 0x1000
221 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
222 * returns the VLAN ID in host byte order. */
223 static inline uint16_t
224 vlan_tci_to_vid(ovs_be16 vlan_tci)
226 return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
229 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
230 * returns the priority code point (PCP) in host byte order. */
232 vlan_tci_to_pcp(ovs_be16 vlan_tci)
234 return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
237 #define VLAN_HEADER_LEN 4
239 ovs_be16 vlan_tci; /* Lowest 12 bits are VLAN ID. */
240 ovs_be16 vlan_next_type;
242 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
244 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
245 struct vlan_eth_header {
246 uint8_t veth_dst[ETH_ADDR_LEN];
247 uint8_t veth_src[ETH_ADDR_LEN];
248 ovs_be16 veth_type; /* Always htons(ETH_TYPE_VLAN). */
249 ovs_be16 veth_tci; /* Lowest 12 bits are VLAN ID. */
250 ovs_be16 veth_next_type;
251 } __attribute__((packed));
252 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
254 /* The "(void) (ip)[0]" below has no effect on the value, since it's the first
255 * argument of a comma expression, but it makes sure that 'ip' is a pointer.
256 * This is useful since a common mistake is to pass an integer instead of a
257 * pointer to IP_ARGS. */
258 #define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
259 #define IP_ARGS(ip) \
260 ((void) (ip)[0], ((uint8_t *) ip)[0]), \
261 ((uint8_t *) ip)[1], \
262 ((uint8_t *) ip)[2], \
265 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
266 * high-order 1-bits and 32-N low-order 0-bits. */
268 ip_is_cidr(ovs_be32 netmask)
270 uint32_t x = ~ntohl(netmask);
271 return !(x & (x + 1));
274 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
275 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
276 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
279 #define IP_ECN_MASK 0x03
280 #define IP_DSCP_MASK 0xfc
284 #define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
285 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
286 #define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
287 #define IP_IS_FRAGMENT(ip_frag_off) \
288 ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
290 #define IP_HEADER_LEN 20
296 ovs_be16 ip_frag_off;
303 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
305 #define ICMP_HEADER_LEN 4
311 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
313 #define UDP_HEADER_LEN 8
320 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
329 #define TCP_FLAGS(tcp_ctl) (htons(tcp_ctl) & 0x003f)
330 #define TCP_OFFSET(tcp_ctl) (htons(tcp_ctl) >> 12)
332 #define TCP_HEADER_LEN 20
343 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
345 #define ARP_HRD_ETHERNET 1
346 #define ARP_PRO_IP 0x0800
347 #define ARP_OP_REQUEST 1
348 #define ARP_OP_REPLY 2
350 #define ARP_ETH_HEADER_LEN 28
351 struct arp_eth_header {
352 /* Generic members. */
353 ovs_be16 ar_hrd; /* Hardware type. */
354 ovs_be16 ar_pro; /* Protocol type. */
355 uint8_t ar_hln; /* Hardware address length. */
356 uint8_t ar_pln; /* Protocol address length. */
357 ovs_be16 ar_op; /* Opcode. */
359 /* Ethernet+IPv4 specific members. */
360 uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
361 ovs_be32 ar_spa; /* Sender protocol address. */
362 uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
363 ovs_be32 ar_tpa; /* Target protocol address. */
364 } __attribute__((packed));
365 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
367 extern const struct in6_addr in6addr_exact;
368 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
369 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
371 static inline bool ipv6_addr_equals(const struct in6_addr *a,
372 const struct in6_addr *b)
374 #ifdef IN6_ARE_ADDR_EQUAL
375 return IN6_ARE_ADDR_EQUAL(a, b);
377 return !memcmp(a, b, sizeof(*a));
381 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
382 return ipv6_addr_equals(mask, &in6addr_any);
385 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
386 return ipv6_addr_equals(mask, &in6addr_exact);
389 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
390 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
391 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
392 const struct in6_addr *mask);
393 struct in6_addr ipv6_create_mask(int mask);
394 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
395 bool ipv6_is_cidr(const struct in6_addr *netmask);
398 compose_packet(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
399 const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
402 /* Masks for lacp_info state member. */
403 #define LACP_STATE_ACT 0x01 /* Activity. Active or passive? */
404 #define LACP_STATE_TIME 0x02 /* Timeout. Short or long timeout? */
405 #define LACP_STATE_AGG 0x04 /* Aggregation. Is the link is bondable? */
406 #define LACP_STATE_SYNC 0x08 /* Synchronization. Is the link in up to date? */
407 #define LACP_STATE_COL 0x10 /* Collecting. Is the link receiving frames? */
408 #define LACP_STATE_DIST 0x20 /* Distributing. Is the link sending frames? */
409 #define LACP_STATE_DEF 0x40 /* Defaulted. Using default partner info? */
410 #define LACP_STATE_EXP 0x80 /* Expired. Using expired partner info? */
412 #define LACP_FAST_TIME_TX 1000 /* Fast transmission rate. */
413 #define LACP_SLOW_TIME_TX 30000 /* Slow transmission rate. */
414 #define LACP_FAST_TIME_RX (LACP_FAST_TIME_TX * 3) /* Fast receive rate. */
415 #define LACP_SLOW_TIME_RX (LACP_SLOW_TIME_TX * 3) /* Slow receive rate. */
417 #define LACP_INFO_LEN 15
419 ovs_be16 sys_priority; /* System priority. */
420 uint8_t sys_id[ETH_ADDR_LEN]; /* System ID. */
421 ovs_be16 key; /* Operational key. */
422 ovs_be16 port_priority; /* Port priority. */
423 ovs_be16 port_id; /* Port ID. */
424 uint8_t state; /* State mask. See LACP_STATE macros. */
425 } __attribute__((packed));
426 BUILD_ASSERT_DECL(LACP_INFO_LEN == sizeof(struct lacp_info));
428 #define LACP_PDU_LEN 110
430 uint8_t subtype; /* Always 1. */
431 uint8_t version; /* Always 1. */
433 uint8_t actor_type; /* Always 1. */
434 uint8_t actor_len; /* Always 20. */
435 struct lacp_info actor; /* LACP actor information. */
436 uint8_t z1[3]; /* Reserved. Always 0. */
438 uint8_t partner_type; /* Always 2. */
439 uint8_t partner_len; /* Always 20. */
440 struct lacp_info partner; /* LACP partner information. */
441 uint8_t z2[3]; /* Reserved. Always 0. */
443 uint8_t collector_type; /* Always 3. */
444 uint8_t collector_len; /* Always 16. */
445 ovs_be16 collector_delay; /* Maximum collector delay. Set to UINT16_MAX. */
446 uint8_t z3[64]; /* Combination of several fields. Always 0. */
447 } __attribute__((packed));
448 BUILD_ASSERT_DECL(LACP_PDU_LEN == sizeof(struct lacp_pdu));
450 void compose_lacp_pdu(const struct lacp_info *actor,
451 const struct lacp_info *partner, struct lacp_pdu *);
453 const struct lacp_pdu *parse_lacp_packet(const struct ofpbuf *);
455 #endif /* packets.h */