lib/packets.h

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