2 * Copyright (c) 2008, 2009 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.
26 #define ETH_ADDR_LEN 6
28 static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] UNUSED
29 = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
31 static inline bool eth_addr_is_broadcast(const uint8_t ea[6])
33 return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
36 /* Returns true if 'ea' is an Ethernet address used for virtual interfaces
37 * under XenServer. Generally the actual Ethernet address is FE:FF:FF:FF:FF:FF
38 * but it can be FE:FE:FE:FE:FE:FE in some cases. */
39 static inline bool eth_addr_is_vif(const uint8_t ea[6])
41 return ea[0] == 0xfe && (ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) >= 0xfe;
44 static inline bool eth_addr_is_multicast(const uint8_t ea[6])
48 static inline bool eth_addr_is_local(const uint8_t ea[6])
52 static inline bool eth_addr_is_zero(const uint8_t ea[6])
54 return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
56 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
57 const uint8_t b[ETH_ADDR_LEN])
59 return !memcmp(a, b, ETH_ADDR_LEN);
61 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
63 return (((uint64_t) ea[0] << 40)
64 | ((uint64_t) ea[1] << 32)
65 | ((uint64_t) ea[2] << 24)
66 | ((uint64_t) ea[3] << 16)
67 | ((uint64_t) ea[4] << 8)
70 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
79 static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
81 ea[0] &= ~1; /* Unicast. */
82 ea[0] |= 2; /* Private. */
84 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
86 random_bytes(ea, ETH_ADDR_LEN);
87 eth_addr_mark_random(ea);
89 /* Returns true if 'ea' is a reserved multicast address, that a bridge must
90 * never forward, false otherwise. */
91 static inline bool eth_addr_is_reserved(const uint8_t ea[ETH_ADDR_LEN])
98 && (ea[5] & 0xf0) == 0x00);
103 * uint8_t mac[ETH_ADDR_LEN];
105 * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
108 #define ETH_ADDR_FMT \
109 "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
110 #define ETH_ADDR_ARGS(ea) \
111 (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
115 * char *string = "1 00:11:22:33:44:55 2";
116 * uint8_t mac[ETH_ADDR_LEN];
119 * if (sscanf(string, "%d"ETH_ADDR_SCAN_FMT"%d",
120 * &a, ETH_ADDR_SCAN_ARGS(mac), &b) == 1 + ETH_ADDR_SCAN_COUNT + 1) {
124 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
125 #define ETH_ADDR_SCAN_ARGS(ea) \
126 &(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
127 #define ETH_ADDR_SCAN_COUNT 6
129 #define ETH_TYPE_IP 0x0800
130 #define ETH_TYPE_ARP 0x0806
131 #define ETH_TYPE_VLAN 0x8100
133 #define ETH_HEADER_LEN 14
134 #define ETH_PAYLOAD_MIN 46
135 #define ETH_PAYLOAD_MAX 1500
136 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
137 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
138 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
140 uint8_t eth_dst[ETH_ADDR_LEN];
141 uint8_t eth_src[ETH_ADDR_LEN];
143 } __attribute__((packed));
144 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
146 #define LLC_DSAP_SNAP 0xaa
147 #define LLC_SSAP_SNAP 0xaa
148 #define LLC_CNTL_SNAP 3
150 #define LLC_HEADER_LEN 3
155 } __attribute__((packed));
156 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
158 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
159 sizeof(SNAP_ORG_ETHERNET) == 3. */
160 #define SNAP_HEADER_LEN 5
164 } __attribute__((packed));
165 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
167 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
168 struct llc_snap_header {
169 struct llc_header llc;
170 struct snap_header snap;
171 } __attribute__((packed));
172 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
174 #define VLAN_VID_MASK 0x0fff
175 #define VLAN_PCP_MASK 0xe000
177 #define VLAN_HEADER_LEN 4
179 uint16_t vlan_tci; /* Lowest 12 bits are VLAN ID. */
180 uint16_t vlan_next_type;
182 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
184 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
185 struct vlan_eth_header {
186 uint8_t veth_dst[ETH_ADDR_LEN];
187 uint8_t veth_src[ETH_ADDR_LEN];
188 uint16_t veth_type; /* Always htons(ETH_TYPE_VLAN). */
189 uint16_t veth_tci; /* Lowest 12 bits are VLAN ID. */
190 uint16_t veth_next_type;
191 } __attribute__((packed));
192 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
194 /* The "(void) (ip)[0]" below has no effect on the value, since it's the first
195 * argument of a comma expression, but it makes sure that 'ip' is a pointer.
196 * This is useful since a common mistake is to pass an integer instead of a
197 * pointer to IP_ARGS. */
198 #define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
199 #define IP_ARGS(ip) \
200 ((void) (ip)[0], ((uint8_t *) ip)[0]), \
201 ((uint8_t *) ip)[1], \
202 ((uint8_t *) ip)[2], \
205 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
206 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
207 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
209 #define IP_TYPE_ICMP 1
210 #define IP_TYPE_TCP 6
211 #define IP_TYPE_UDP 17
215 #define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
216 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
217 #define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
218 #define IP_IS_FRAGMENT(ip_frag_off) \
219 ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
221 #define IP_HEADER_LEN 20
227 uint16_t ip_frag_off;
234 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
236 #define ICMP_HEADER_LEN 4
242 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
244 #define UDP_HEADER_LEN 8
251 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
260 #define TCP_FLAGS(tcp_ctl) (htons(tcp_ctl) & 0x003f)
261 #define TCP_OFFSET(tcp_ctl) (htons(tcp_ctl) >> 12)
263 #define TCP_HEADER_LEN 20
274 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
276 #define ARP_HRD_ETHERNET 1
277 #define ARP_PRO_IP 0x0800
278 #define ARP_OP_REQUEST 1
279 #define ARP_OP_REPLY 2
281 #define ARP_ETH_HEADER_LEN 28
282 struct arp_eth_header {
283 /* Generic members. */
284 uint16_t ar_hrd; /* Hardware type. */
285 uint16_t ar_pro; /* Protocol type. */
286 uint8_t ar_hln; /* Hardware address length. */
287 uint8_t ar_pln; /* Protocol address length. */
288 uint16_t ar_op; /* Opcode. */
290 /* Ethernet+IPv4 specific members. */
291 uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
292 uint32_t ar_spa; /* Sender protocol address. */
293 uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
294 uint32_t ar_tpa; /* Target protocol address. */
295 } __attribute__((packed));
296 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
298 #endif /* packets.h */