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