1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
42 #define ETH_ADDR_LEN 6
44 static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] UNUSED
45 = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
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;
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])
59 static inline bool eth_addr_is_zero(const uint8_t ea[6])
61 return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
63 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
64 const uint8_t b[ETH_ADDR_LEN])
66 return !memcmp(a, b, ETH_ADDR_LEN);
68 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
70 return (((uint64_t) ea[0] << 40)
71 | ((uint64_t) ea[1] << 32)
72 | ((uint64_t) ea[2] << 24)
73 | ((uint64_t) ea[3] << 16)
74 | ((uint64_t) ea[4] << 8)
77 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
86 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
88 random_bytes(ea, ETH_ADDR_LEN);
91 #define ETH_ADDR_FMT \
92 "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
93 #define ETH_ADDR_ARGS(ea) \
94 (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
96 #define ETH_TYPE_IP 0x0800
97 #define ETH_TYPE_ARP 0x0806
98 #define ETH_TYPE_VLAN 0x8100
100 #define ETH_HEADER_LEN 14
101 #define ETH_PAYLOAD_MIN 46
102 #define ETH_PAYLOAD_MAX 1500
103 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
104 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
105 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
107 uint8_t eth_dst[ETH_ADDR_LEN];
108 uint8_t eth_src[ETH_ADDR_LEN];
110 } __attribute__((packed));
111 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
113 #define LLC_DSAP_SNAP 0xaa
114 #define LLC_SSAP_SNAP 0xaa
115 #define LLC_CNTL_SNAP 3
117 #define LLC_HEADER_LEN 3
122 } __attribute__((packed));
123 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
125 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
126 sizeof(SNAP_ORG_ETHERNET) == 3. */
127 #define SNAP_HEADER_LEN 5
131 } __attribute__((packed));
132 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
134 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
135 struct llc_snap_header {
136 struct llc_header llc;
137 struct snap_header snap;
138 } __attribute__((packed));
139 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
141 #define VLAN_VID 0x0fff
143 #define VLAN_HEADER_LEN 4
145 uint16_t vlan_tci; /* Lowest 12 bits are VLAN ID. */
146 uint16_t vlan_next_type;
148 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
150 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
151 struct vlan_eth_header {
152 uint8_t veth_dst[ETH_ADDR_LEN];
153 uint8_t veth_src[ETH_ADDR_LEN];
154 uint16_t veth_type; /* Always htons(ETH_TYPE_VLAN). */
155 uint16_t veth_tci; /* Lowest 12 bits are VLAN ID. */
156 uint16_t veth_next_type;
157 } __attribute__((packed));
158 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
160 #define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
161 #define IP_ARGS(ip) \
162 ((uint8_t *) ip)[0], \
163 ((uint8_t *) ip)[1], \
164 ((uint8_t *) ip)[2], \
167 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
168 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
169 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
171 #define IP_TYPE_ICMP 1
172 #define IP_TYPE_TCP 6
173 #define IP_TYPE_UDP 17
177 #define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
178 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
179 #define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
180 #define IP_IS_FRAGMENT(ip_frag_off) \
181 ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
183 #define IP_HEADER_LEN 20
189 uint16_t ip_frag_off;
196 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
198 #define UDP_HEADER_LEN 8
205 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
214 #define TCP_FLAGS(tcp_ctl) (htons(tcp_ctl) & 0x003f)
215 #define TCP_OFFSET(tcp_ctl) (htons(tcp_ctl) >> 12)
217 #define TCP_HEADER_LEN 20
228 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
230 #define ARP_HRD_ETHERNET 1
231 #define ARP_PRO_IP 0x0800
232 #define ARP_OP_REQUEST 1
233 #define ARP_OP_REPLY 2
235 #define ARP_ETH_HEADER_LEN 28
236 struct arp_eth_header {
237 /* Generic members. */
238 uint16_t ar_hrd; /* Hardware type. */
239 uint16_t ar_pro; /* Protocol type. */
240 uint8_t ar_hln; /* Hardware address length. */
241 uint8_t ar_pln; /* Protocol address length. */
242 uint16_t ar_op; /* Opcode. */
244 /* Ethernet+IPv4 specific members. */
245 uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
246 uint32_t ar_spa; /* Sender protocol address. */
247 uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
248 uint32_t ar_tpa; /* Target protocol address. */
249 } __attribute__((packed));
250 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
252 #endif /* packets.h */