packets: New function eth_pop_vlan(), formerly dp_netdev_pop_vlan().
[openvswitch] / lib / packets.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef PACKETS_H
18 #define PACKETS_H 1
19
20 #include <inttypes.h>
21 #include <sys/types.h>
22 #include <netinet/in.h>
23 #include <stdint.h>
24 #include <string.h>
25 #include "compiler.h"
26 #include "openvswitch/types.h"
27 #include "random.h"
28 #include "util.h"
29
30 struct ofpbuf;
31 struct ds;
32
33 bool dpid_from_string(const char *s, uint64_t *dpidp);
34
35 #define ETH_ADDR_LEN           6
36
37 static const uint8_t eth_addr_broadcast[ETH_ADDR_LEN] OVS_UNUSED
38     = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
39
40 static const uint8_t eth_addr_stp[ETH_ADDR_LEN] OVS_UNUSED
41     = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x00 };
42
43 static const uint8_t eth_addr_lacp[ETH_ADDR_LEN] OVS_UNUSED
44     = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x02 };
45
46 static inline bool eth_addr_is_broadcast(const uint8_t ea[6])
47 {
48     return (ea[0] & ea[1] & ea[2] & ea[3] & ea[4] & ea[5]) == 0xff;
49 }
50
51 static inline bool eth_addr_is_multicast(const uint8_t ea[6])
52 {
53     return ea[0] & 1;
54 }
55 static inline bool eth_addr_is_local(const uint8_t ea[6])
56 {
57     /* Local if it is either a locally administered address or a Nicira random
58      * address. */
59     return ea[0] & 2
60        || (ea[0] == 0x00 && ea[1] == 0x23 && ea[2] == 0x20 && ea[3] & 0x80);
61 }
62 static inline bool eth_addr_is_zero(const uint8_t ea[6])
63 {
64     return !(ea[0] | ea[1] | ea[2] | ea[3] | ea[4] | ea[5]);
65 }
66 static inline int eth_addr_compare_3way(const uint8_t a[ETH_ADDR_LEN],
67                                         const uint8_t b[ETH_ADDR_LEN])
68 {
69     return memcmp(a, b, ETH_ADDR_LEN);
70 }
71 static inline bool eth_addr_equals(const uint8_t a[ETH_ADDR_LEN],
72                                    const uint8_t b[ETH_ADDR_LEN])
73 {
74     return !eth_addr_compare_3way(a, b);
75 }
76 static inline uint64_t eth_addr_to_uint64(const uint8_t ea[ETH_ADDR_LEN])
77 {
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)
83             | ea[5]);
84 }
85 static inline void eth_addr_from_uint64(uint64_t x, uint8_t ea[ETH_ADDR_LEN])
86 {
87     ea[0] = x >> 40;
88     ea[1] = x >> 32;
89     ea[2] = x >> 24;
90     ea[3] = x >> 16;
91     ea[4] = x >> 8;
92     ea[5] = x;
93 }
94 static inline void eth_addr_mark_random(uint8_t ea[ETH_ADDR_LEN])
95 {
96     ea[0] &= ~1;                /* Unicast. */
97     ea[0] |= 2;                 /* Private. */
98 }
99 static inline void eth_addr_random(uint8_t ea[ETH_ADDR_LEN])
100 {
101     random_bytes(ea, ETH_ADDR_LEN);
102     eth_addr_mark_random(ea);
103 }
104 static inline void eth_addr_nicira_random(uint8_t ea[ETH_ADDR_LEN])
105 {
106     eth_addr_random(ea);
107
108     /* Set the OUI to the Nicira one. */
109     ea[0] = 0x00;
110     ea[1] = 0x23;
111     ea[2] = 0x20;
112
113     /* Set the top bit to indicate random Nicira address. */
114     ea[3] |= 0x80;
115 }
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])
119 {
120     return (ea[0] == 0x01
121             && ea[1] == 0x80
122             && ea[2] == 0xc2
123             && ea[3] == 0x00
124             && ea[4] == 0x00
125             && (ea[5] & 0xf0) == 0x00);
126 }
127
128 bool eth_addr_from_string(const char *, uint8_t ea[ETH_ADDR_LEN]);
129
130 void compose_benign_packet(struct ofpbuf *, const char *tag,
131                            uint16_t snap_type,
132                            const uint8_t eth_src[ETH_ADDR_LEN]);
133
134 void eth_push_vlan(struct ofpbuf *, ovs_be16 tci);
135 void eth_pop_vlan(struct ofpbuf *);
136
137 /* Example:
138  *
139  * uint8_t mac[ETH_ADDR_LEN];
140  *    [...]
141  * printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
142  *
143  */
144 #define ETH_ADDR_FMT                                                    \
145     "%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
146 #define ETH_ADDR_ARGS(ea)                                   \
147     (ea)[0], (ea)[1], (ea)[2], (ea)[3], (ea)[4], (ea)[5]
148
149 /* Example:
150  *
151  * char *string = "1 00:11:22:33:44:55 2";
152  * uint8_t mac[ETH_ADDR_LEN];
153  * int a, b;
154  *
155  * if (sscanf(string, "%d"ETH_ADDR_SCAN_FMT"%d",
156  *     &a, ETH_ADDR_SCAN_ARGS(mac), &b) == 1 + ETH_ADDR_SCAN_COUNT + 1) {
157  *     ...
158  * }
159  */
160 #define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
161 #define ETH_ADDR_SCAN_ARGS(ea) \
162         &(ea)[0], &(ea)[1], &(ea)[2], &(ea)[3], &(ea)[4], &(ea)[5]
163 #define ETH_ADDR_SCAN_COUNT 6
164
165 #define ETH_TYPE_IP            0x0800
166 #define ETH_TYPE_ARP           0x0806
167 #define ETH_TYPE_VLAN          0x8100
168 #define ETH_TYPE_IPV6          0x86dd
169 #define ETH_TYPE_LACP          0x8809
170
171 /* Minimum value for an Ethernet type.  Values below this are IEEE 802.2 frame
172  * lengths. */
173 #define ETH_TYPE_MIN           0x600
174
175 #define ETH_HEADER_LEN 14
176 #define ETH_PAYLOAD_MIN 46
177 #define ETH_PAYLOAD_MAX 1500
178 #define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
179 #define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
180 #define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
181 struct eth_header {
182     uint8_t eth_dst[ETH_ADDR_LEN];
183     uint8_t eth_src[ETH_ADDR_LEN];
184     ovs_be16 eth_type;
185 } __attribute__((packed));
186 BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
187
188 #define LLC_DSAP_SNAP 0xaa
189 #define LLC_SSAP_SNAP 0xaa
190 #define LLC_CNTL_SNAP 3
191
192 #define LLC_HEADER_LEN 3
193 struct llc_header {
194     uint8_t llc_dsap;
195     uint8_t llc_ssap;
196     uint8_t llc_cntl;
197 } __attribute__((packed));
198 BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
199
200 #define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
201                                     sizeof(SNAP_ORG_ETHERNET) == 3. */
202 #define SNAP_HEADER_LEN 5
203 struct snap_header {
204     uint8_t snap_org[3];
205     ovs_be16 snap_type;
206 } __attribute__((packed));
207 BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
208
209 #define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
210 struct llc_snap_header {
211     struct llc_header llc;
212     struct snap_header snap;
213 } __attribute__((packed));
214 BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
215
216 #define VLAN_VID_MASK 0x0fff
217 #define VLAN_VID_SHIFT 0
218
219 #define VLAN_PCP_MASK 0xe000
220 #define VLAN_PCP_SHIFT 13
221
222 #define VLAN_CFI 0x1000
223
224 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
225  * returns the VLAN ID in host byte order. */
226 static inline uint16_t
227 vlan_tci_to_vid(ovs_be16 vlan_tci)
228 {
229     return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
230 }
231
232 /* Given the vlan_tci field from an 802.1Q header, in network byte order,
233  * returns the priority code point (PCP) in host byte order. */
234 static inline int
235 vlan_tci_to_pcp(ovs_be16 vlan_tci)
236 {
237     return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
238 }
239
240 #define VLAN_HEADER_LEN 4
241 struct vlan_header {
242     ovs_be16 vlan_tci;          /* Lowest 12 bits are VLAN ID. */
243     ovs_be16 vlan_next_type;
244 };
245 BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
246
247 #define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
248 struct vlan_eth_header {
249     uint8_t veth_dst[ETH_ADDR_LEN];
250     uint8_t veth_src[ETH_ADDR_LEN];
251     ovs_be16 veth_type;         /* Always htons(ETH_TYPE_VLAN). */
252     ovs_be16 veth_tci;          /* Lowest 12 bits are VLAN ID. */
253     ovs_be16 veth_next_type;
254 } __attribute__((packed));
255 BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
256
257 /* The "(void) (ip)[0]" below has no effect on the value, since it's the first
258  * argument of a comma expression, but it makes sure that 'ip' is a pointer.
259  * This is useful since a common mistake is to pass an integer instead of a
260  * pointer to IP_ARGS. */
261 #define IP_FMT "%"PRIu8".%"PRIu8".%"PRIu8".%"PRIu8
262 #define IP_ARGS(ip)                             \
263         ((void) (ip)[0], ((uint8_t *) ip)[0]),  \
264         ((uint8_t *) ip)[1],                    \
265         ((uint8_t *) ip)[2],                    \
266         ((uint8_t *) ip)[3]
267
268 /* Example:
269  *
270  * char *string = "1 33.44.55.66 2";
271  * ovs_be32 ip;
272  * int a, b;
273  *
274  * if (sscanf(string, "%d"IP_SCAN_FMT"%d",
275  *     &a, IP_SCAN_ARGS(&ip), &b) == 1 + IP_SCAN_COUNT + 1) {
276  *     ...
277  * }
278  */
279 #define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
280 #define IP_SCAN_ARGS(ip)                                    \
281         ((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]),    \
282         &((uint8_t *) ip)[1],                               \
283         &((uint8_t *) ip)[2],                               \
284         &((uint8_t *) ip)[3]
285 #define IP_SCAN_COUNT 4
286
287 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
288  * high-order 1-bits and 32-N low-order 0-bits. */
289 static inline bool
290 ip_is_cidr(ovs_be32 netmask)
291 {
292     uint32_t x = ~ntohl(netmask);
293     return !(x & (x + 1));
294 }
295 static inline bool
296 ip_is_multicast(ovs_be32 ip)
297 {
298     return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
299 }
300 int ip_count_cidr_bits(ovs_be32 netmask);
301 void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
302
303 #define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
304 #define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
305 #define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
306
307 /* TOS fields. */
308 #define IP_ECN_MASK 0x03
309 #define IP_DSCP_MASK 0xfc
310
311 #define IP_VERSION 4
312
313 #define IP_DONT_FRAGMENT  0x4000 /* Don't fragment. */
314 #define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
315 #define IP_FRAG_OFF_MASK  0x1fff /* Fragment offset. */
316 #define IP_IS_FRAGMENT(ip_frag_off) \
317         ((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
318
319 #define IP_HEADER_LEN 20
320 struct ip_header {
321     uint8_t ip_ihl_ver;
322     uint8_t ip_tos;
323     ovs_be16 ip_tot_len;
324     ovs_be16 ip_id;
325     ovs_be16 ip_frag_off;
326     uint8_t ip_ttl;
327     uint8_t ip_proto;
328     ovs_be16 ip_csum;
329     ovs_be32 ip_src;
330     ovs_be32 ip_dst;
331 };
332 BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
333
334 #define ICMP_HEADER_LEN 4
335 struct icmp_header {
336     uint8_t icmp_type;
337     uint8_t icmp_code;
338     ovs_be16 icmp_csum;
339 };
340 BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
341
342 #define UDP_HEADER_LEN 8
343 struct udp_header {
344     ovs_be16 udp_src;
345     ovs_be16 udp_dst;
346     ovs_be16 udp_len;
347     ovs_be16 udp_csum;
348 };
349 BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
350
351 #define TCP_FIN 0x01
352 #define TCP_SYN 0x02
353 #define TCP_RST 0x04
354 #define TCP_PSH 0x08
355 #define TCP_ACK 0x10
356 #define TCP_URG 0x20
357
358 #define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x003f)
359 #define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
360
361 #define TCP_HEADER_LEN 20
362 struct tcp_header {
363     ovs_be16 tcp_src;
364     ovs_be16 tcp_dst;
365     ovs_be32 tcp_seq;
366     ovs_be32 tcp_ack;
367     ovs_be16 tcp_ctl;
368     ovs_be16 tcp_winsz;
369     ovs_be16 tcp_csum;
370     ovs_be16 tcp_urg;
371 };
372 BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
373
374 #define ARP_HRD_ETHERNET 1
375 #define ARP_PRO_IP 0x0800
376 #define ARP_OP_REQUEST 1
377 #define ARP_OP_REPLY 2
378
379 #define ARP_ETH_HEADER_LEN 28
380 struct arp_eth_header {
381     /* Generic members. */
382     ovs_be16 ar_hrd;           /* Hardware type. */
383     ovs_be16 ar_pro;           /* Protocol type. */
384     uint8_t ar_hln;            /* Hardware address length. */
385     uint8_t ar_pln;            /* Protocol address length. */
386     ovs_be16 ar_op;            /* Opcode. */
387
388     /* Ethernet+IPv4 specific members. */
389     uint8_t ar_sha[ETH_ADDR_LEN]; /* Sender hardware address. */
390     ovs_be32 ar_spa;           /* Sender protocol address. */
391     uint8_t ar_tha[ETH_ADDR_LEN]; /* Target hardware address. */
392     ovs_be32 ar_tpa;           /* Target protocol address. */
393 } __attribute__((packed));
394 BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
395
396 /* The IPv6 flow label is in the lower 20 bits of the first 32-bit word. */
397 #define IPV6_LABEL_MASK 0x000fffff
398
399 /* Example:
400  *
401  * char *string = "1 ::1 2";
402  * char ipv6_s[IPV6_SCAN_LEN + 1];
403  * struct in6_addr ipv6;
404  *
405  * if (sscanf(string, "%d"IPV6_SCAN_FMT"%d", &a, ipv6_s, &b) == 3
406  *     && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
407  *     ...
408  * }
409  */
410 #define IPV6_SCAN_FMT "%46[0123456789abcdefABCDEF:.]"
411 #define IPV6_SCAN_LEN 46
412
413 extern const struct in6_addr in6addr_exact;
414 #define IN6ADDR_EXACT_INIT { { { 0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, \
415                                  0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff } } }
416
417 static inline bool ipv6_addr_equals(const struct in6_addr *a,
418                                     const struct in6_addr *b)
419 {
420 #ifdef IN6_ARE_ADDR_EQUAL
421     return IN6_ARE_ADDR_EQUAL(a, b);
422 #else
423     return !memcmp(a, b, sizeof(*a));
424 #endif
425 }
426
427 static inline bool ipv6_mask_is_any(const struct in6_addr *mask) {
428     return ipv6_addr_equals(mask, &in6addr_any);
429 }
430
431 static inline bool ipv6_mask_is_exact(const struct in6_addr *mask) {
432     return ipv6_addr_equals(mask, &in6addr_exact);
433 }
434
435 void format_ipv6_addr(char *addr_str, const struct in6_addr *addr);
436 void print_ipv6_addr(struct ds *string, const struct in6_addr *addr);
437 void print_ipv6_masked(struct ds *string, const struct in6_addr *addr,
438                        const struct in6_addr *mask);
439 struct in6_addr ipv6_addr_bitand(const struct in6_addr *src,
440                                  const struct in6_addr *mask);
441 struct in6_addr ipv6_create_mask(int mask);
442 int ipv6_count_cidr_bits(const struct in6_addr *netmask);
443 bool ipv6_is_cidr(const struct in6_addr *netmask);
444
445 void *eth_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
446                   const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
447                   size_t size);
448 void *snap_compose(struct ofpbuf *, const uint8_t eth_dst[ETH_ADDR_LEN],
449                    const uint8_t eth_src[ETH_ADDR_LEN],
450                    unsigned int oui, uint16_t snap_type, size_t size);
451
452 #endif /* packets.h */