lib/packets.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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 #include <config.h>
  18 #include "packets.h"
  19 #include <arpa/inet.h>
  20 #include <sys/socket.h>
  21 #include <netinet/in.h>
  22 #include <netinet/ip6.h>
  23 #include <netinet/icmp6.h>
  24 #include <stdlib.h>
  25 #include "byte-order.h"
  26 #include "csum.h"
  27 #include "crc32c.h"
  28 #include "flow.h"
  29 #include "hmap.h"
  30 #include "dynamic-string.h"
  31 #include "ovs-thread.h"
  32 #include "odp-util.h"
  33 #include "dp-packet.h"
  34 #include "unaligned.h"
  35
  36 const struct in6_addr in6addr_exact = IN6ADDR_EXACT_INIT;
  37 const struct in6_addr in6addr_all_hosts = IN6ADDR_ALL_HOSTS_INIT;
  38
  39 /* Parses 's' as a 16-digit hexadecimal number representing a datapath ID.  On
  40  * success stores the dpid into '*dpidp' and returns true, on failure stores 0
  41  * into '*dpidp' and returns false.
  42  *
  43  * Rejects an all-zeros dpid as invalid. */
  44 bool
  45 dpid_from_string(const char *s, uint64_t *dpidp)
  46 {
  47     *dpidp = (strlen(s) == 16 && strspn(s, "0123456789abcdefABCDEF") == 16
  48               ? strtoull(s, NULL, 16)
  49               : 0);
  50     return *dpidp != 0;
  51 }
  52
  53 /* Returns true if 'ea' is a reserved address, that a bridge must never
  54  * forward, false otherwise.
  55  *
  56  * If you change this function's behavior, please update corresponding
  57  * documentation in vswitch.xml at the same time. */
  58 bool
  59 eth_addr_is_reserved(const struct eth_addr ea)
  60 {
  61     struct eth_addr_node {
  62         struct hmap_node hmap_node;
  63         const uint64_t ea64;
  64     };
  65
  66     static struct eth_addr_node nodes[] = {
  67         /* STP, IEEE pause frames, and other reserved protocols. */
  68         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000000ULL },
  69         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000001ULL },
  70         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000002ULL },
  71         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000003ULL },
  72         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000004ULL },
  73         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000005ULL },
  74         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000006ULL },
  75         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000007ULL },
  76         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000008ULL },
  77         { HMAP_NODE_NULL_INITIALIZER, 0x0180c2000009ULL },
  78         { HMAP_NODE_NULL_INITIALIZER, 0x0180c200000aULL },
  79         { HMAP_NODE_NULL_INITIALIZER, 0x0180c200000bULL },
  80         { HMAP_NODE_NULL_INITIALIZER, 0x0180c200000cULL },
  81         { HMAP_NODE_NULL_INITIALIZER, 0x0180c200000dULL },
  82         { HMAP_NODE_NULL_INITIALIZER, 0x0180c200000eULL },
  83         { HMAP_NODE_NULL_INITIALIZER, 0x0180c200000fULL },
  84
  85         /* Extreme protocols. */
  86         { HMAP_NODE_NULL_INITIALIZER, 0x00e02b000000ULL }, /* EDP. */
  87         { HMAP_NODE_NULL_INITIALIZER, 0x00e02b000004ULL }, /* EAPS. */
  88         { HMAP_NODE_NULL_INITIALIZER, 0x00e02b000006ULL }, /* EAPS. */
  89
  90         /* Cisco protocols. */
  91         { HMAP_NODE_NULL_INITIALIZER, 0x01000c000000ULL }, /* ISL. */
  92         { HMAP_NODE_NULL_INITIALIZER, 0x01000cccccccULL }, /* PAgP, UDLD, CDP,
  93                                                             * DTP, VTP. */
  94         { HMAP_NODE_NULL_INITIALIZER, 0x01000ccccccdULL }, /* PVST+. */
  95         { HMAP_NODE_NULL_INITIALIZER, 0x01000ccdcdcdULL }, /* STP Uplink Fast,
  96                                                             * FlexLink. */
  97
  98         /* Cisco CFM. */
  99         { HMAP_NODE_NULL_INITIALIZER, 0x01000cccccc0ULL },
 100         { HMAP_NODE_NULL_INITIALIZER, 0x01000cccccc1ULL },
 101         { HMAP_NODE_NULL_INITIALIZER, 0x01000cccccc2ULL },
 102         { HMAP_NODE_NULL_INITIALIZER, 0x01000cccccc3ULL },
 103         { HMAP_NODE_NULL_INITIALIZER, 0x01000cccccc4ULL },
 104         { HMAP_NODE_NULL_INITIALIZER, 0x01000cccccc5ULL },
 105         { HMAP_NODE_NULL_INITIALIZER, 0x01000cccccc6ULL },
 106         { HMAP_NODE_NULL_INITIALIZER, 0x01000cccccc7ULL },
 107     };
 108
 109     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 110     struct eth_addr_node *node;
 111     static struct hmap addrs;
 112     uint64_t ea64;
 113
 114     if (ovsthread_once_start(&once)) {
 115         hmap_init(&addrs);
 116         for (node = nodes; node < &nodes[ARRAY_SIZE(nodes)]; node++) {
 117             hmap_insert(&addrs, &node->hmap_node, hash_uint64(node->ea64));
 118         }
 119         ovsthread_once_done(&once);
 120     }
 121
 122     ea64 = eth_addr_to_uint64(ea);
 123     HMAP_FOR_EACH_IN_BUCKET (node, hmap_node, hash_uint64(ea64), &addrs) {
 124         if (node->ea64 == ea64) {
 125             return true;
 126         }
 127     }
 128     return false;
 129 }
 130
 131 bool
 132 eth_addr_from_string(const char *s, struct eth_addr *ea)
 133 {
 134     if (ovs_scan(s, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(*ea))) {
 135         return true;
 136     } else {
 137         *ea = eth_addr_zero;
 138         return false;
 139     }
 140 }
 141
 142 /* Fills 'b' with a Reverse ARP packet with Ethernet source address 'eth_src'.
 143  * This function is used by Open vSwitch to compose packets in cases where
 144  * context is important but content doesn't (or shouldn't) matter.
 145  *
 146  * The returned packet has enough headroom to insert an 802.1Q VLAN header if
 147  * desired. */
 148 void
 149 compose_rarp(struct dp_packet *b, const struct eth_addr eth_src)
 150 {
 151     struct eth_header *eth;
 152     struct arp_eth_header *arp;
 153
 154     dp_packet_clear(b);
 155     dp_packet_prealloc_tailroom(b, 2 + ETH_HEADER_LEN + VLAN_HEADER_LEN
 156                              + ARP_ETH_HEADER_LEN);
 157     dp_packet_reserve(b, 2 + VLAN_HEADER_LEN);
 158     eth = dp_packet_put_uninit(b, sizeof *eth);
 159     eth->eth_dst = eth_addr_broadcast;
 160     eth->eth_src = eth_src;
 161     eth->eth_type = htons(ETH_TYPE_RARP);
 162
 163     arp = dp_packet_put_uninit(b, sizeof *arp);
 164     arp->ar_hrd = htons(ARP_HRD_ETHERNET);
 165     arp->ar_pro = htons(ARP_PRO_IP);
 166     arp->ar_hln = sizeof arp->ar_sha;
 167     arp->ar_pln = sizeof arp->ar_spa;
 168     arp->ar_op = htons(ARP_OP_RARP);
 169     arp->ar_sha = eth_src;
 170     put_16aligned_be32(&arp->ar_spa, htonl(0));
 171     arp->ar_tha = eth_src;
 172     put_16aligned_be32(&arp->ar_tpa, htonl(0));
 173
 174     dp_packet_reset_offsets(b);
 175     dp_packet_set_l3(b, arp);
 176 }
 177
 178 /* Insert VLAN header according to given TCI. Packet passed must be Ethernet
 179  * packet.  Ignores the CFI bit of 'tci' using 0 instead.
 180  *
 181  * Also adjusts the layer offsets accordingly. */
 182 void
 183 eth_push_vlan(struct dp_packet *packet, ovs_be16 tpid, ovs_be16 tci)
 184 {
 185     struct vlan_eth_header *veh;
 186
 187     /* Insert new 802.1Q header. */
 188     veh = dp_packet_resize_l2(packet, VLAN_HEADER_LEN);
 189     memmove(veh, (char *)veh + VLAN_HEADER_LEN, 2 * ETH_ADDR_LEN);
 190     veh->veth_type = tpid;
 191     veh->veth_tci = tci & htons(~VLAN_CFI);
 192 }
 193
 194 /* Removes outermost VLAN header (if any is present) from 'packet'.
 195  *
 196  * 'packet->l2_5' should initially point to 'packet''s outer-most VLAN header
 197  * or may be NULL if there are no VLAN headers. */
 198 void
 199 eth_pop_vlan(struct dp_packet *packet)
 200 {
 201     struct vlan_eth_header *veh = dp_packet_l2(packet);
 202
 203     if (veh && dp_packet_size(packet) >= sizeof *veh
 204         && eth_type_vlan(veh->veth_type)) {
 205
 206         memmove((char *)veh + VLAN_HEADER_LEN, veh, 2 * ETH_ADDR_LEN);
 207         dp_packet_resize_l2(packet, -VLAN_HEADER_LEN);
 208     }
 209 }
 210
 211 /* Set ethertype of the packet. */
 212 static void
 213 set_ethertype(struct dp_packet *packet, ovs_be16 eth_type)
 214 {
 215     struct eth_header *eh = dp_packet_l2(packet);
 216
 217     if (!eh) {
 218         return;
 219     }
 220
 221     if (eth_type_vlan(eh->eth_type)) {
 222         ovs_be16 *p;
 223         char *l2_5 = dp_packet_l2_5(packet);
 224
 225         p = ALIGNED_CAST(ovs_be16 *,
 226                          (l2_5 ? l2_5 : (char *)dp_packet_l3(packet)) - 2);
 227         *p = eth_type;
 228     } else {
 229         eh->eth_type = eth_type;
 230     }
 231 }
 232
 233 static bool is_mpls(struct dp_packet *packet)
 234 {
 235     return packet->l2_5_ofs != UINT16_MAX;
 236 }
 237
 238 /* Set time to live (TTL) of an MPLS label stack entry (LSE). */
 239 void
 240 set_mpls_lse_ttl(ovs_be32 *lse, uint8_t ttl)
 241 {
 242     *lse &= ~htonl(MPLS_TTL_MASK);
 243     *lse |= htonl((ttl << MPLS_TTL_SHIFT) & MPLS_TTL_MASK);
 244 }
 245
 246 /* Set traffic class (TC) of an MPLS label stack entry (LSE). */
 247 void
 248 set_mpls_lse_tc(ovs_be32 *lse, uint8_t tc)
 249 {
 250     *lse &= ~htonl(MPLS_TC_MASK);
 251     *lse |= htonl((tc << MPLS_TC_SHIFT) & MPLS_TC_MASK);
 252 }
 253
 254 /* Set label of an MPLS label stack entry (LSE). */
 255 void
 256 set_mpls_lse_label(ovs_be32 *lse, ovs_be32 label)
 257 {
 258     *lse &= ~htonl(MPLS_LABEL_MASK);
 259     *lse |= htonl((ntohl(label) << MPLS_LABEL_SHIFT) & MPLS_LABEL_MASK);
 260 }
 261
 262 /* Set bottom of stack (BoS) bit of an MPLS label stack entry (LSE). */
 263 void
 264 set_mpls_lse_bos(ovs_be32 *lse, uint8_t bos)
 265 {
 266     *lse &= ~htonl(MPLS_BOS_MASK);
 267     *lse |= htonl((bos << MPLS_BOS_SHIFT) & MPLS_BOS_MASK);
 268 }
 269
 270 /* Compose an MPLS label stack entry (LSE) from its components:
 271  * label, traffic class (TC), time to live (TTL) and
 272  * bottom of stack (BoS) bit. */
 273 ovs_be32
 274 set_mpls_lse_values(uint8_t ttl, uint8_t tc, uint8_t bos, ovs_be32 label)
 275 {
 276     ovs_be32 lse = htonl(0);
 277     set_mpls_lse_ttl(&lse, ttl);
 278     set_mpls_lse_tc(&lse, tc);
 279     set_mpls_lse_bos(&lse, bos);
 280     set_mpls_lse_label(&lse, label);
 281     return lse;
 282 }
 283
 284 /* Set MPLS label stack entry to outermost MPLS header.*/
 285 void
 286 set_mpls_lse(struct dp_packet *packet, ovs_be32 mpls_lse)
 287 {
 288     /* Packet type should be MPLS to set label stack entry. */
 289     if (is_mpls(packet)) {
 290         struct mpls_hdr *mh = dp_packet_l2_5(packet);
 291
 292         /* Update mpls label stack entry. */
 293         put_16aligned_be32(&mh->mpls_lse, mpls_lse);
 294     }
 295 }
 296
 297 /* Push MPLS label stack entry 'lse' onto 'packet' as the outermost MPLS
 298  * header.  If 'packet' does not already have any MPLS labels, then its
 299  * Ethertype is changed to 'ethtype' (which must be an MPLS Ethertype). */
 300 void
 301 push_mpls(struct dp_packet *packet, ovs_be16 ethtype, ovs_be32 lse)
 302 {
 303     char * header;
 304     size_t len;
 305
 306     if (!eth_type_mpls(ethtype)) {
 307         return;
 308     }
 309
 310     if (!is_mpls(packet)) {
 311         /* Set MPLS label stack offset. */
 312         packet->l2_5_ofs = packet->l3_ofs;
 313     }
 314
 315     set_ethertype(packet, ethtype);
 316
 317     /* Push new MPLS shim header onto packet. */
 318     len = packet->l2_5_ofs;
 319     header = dp_packet_resize_l2_5(packet, MPLS_HLEN);
 320     memmove(header, header + MPLS_HLEN, len);
 321     memcpy(header + len, &lse, sizeof lse);
 322 }
 323
 324 /* If 'packet' is an MPLS packet, removes its outermost MPLS label stack entry.
 325  * If the label that was removed was the only MPLS label, changes 'packet''s
 326  * Ethertype to 'ethtype' (which ordinarily should not be an MPLS
 327  * Ethertype). */
 328 void
 329 pop_mpls(struct dp_packet *packet, ovs_be16 ethtype)
 330 {
 331     if (is_mpls(packet)) {
 332         struct mpls_hdr *mh = dp_packet_l2_5(packet);
 333         size_t len = packet->l2_5_ofs;
 334
 335         set_ethertype(packet, ethtype);
 336         if (get_16aligned_be32(&mh->mpls_lse) & htonl(MPLS_BOS_MASK)) {
 337             dp_packet_set_l2_5(packet, NULL);
 338         }
 339         /* Shift the l2 header forward. */
 340         memmove((char*)dp_packet_data(packet) + MPLS_HLEN, dp_packet_data(packet), len);
 341         dp_packet_resize_l2_5(packet, -MPLS_HLEN);
 342     }
 343 }
 344
 345 /* Converts hex digits in 'hex' to an Ethernet packet in '*packetp'.  The
 346  * caller must free '*packetp'.  On success, returns NULL.  On failure, returns
 347  * an error message and stores NULL in '*packetp'.
 348  *
 349  * Aligns the L3 header of '*packetp' on a 32-bit boundary. */
 350 const char *
 351 eth_from_hex(const char *hex, struct dp_packet **packetp)
 352 {
 353     struct dp_packet *packet;
 354
 355     /* Use 2 bytes of headroom to 32-bit align the L3 header. */
 356     packet = *packetp = dp_packet_new_with_headroom(strlen(hex) / 2, 2);
 357
 358     if (dp_packet_put_hex(packet, hex, NULL)[0] != '\0') {
 359         dp_packet_delete(packet);
 360         *packetp = NULL;
 361         return "Trailing garbage in packet data";
 362     }
 363
 364     if (dp_packet_size(packet) < ETH_HEADER_LEN) {
 365         dp_packet_delete(packet);
 366         *packetp = NULL;
 367         return "Packet data too short for Ethernet";
 368     }
 369
 370     return NULL;
 371 }
 372
 373 void
 374 eth_format_masked(const struct eth_addr eth,
 375                   const struct eth_addr *mask, struct ds *s)
 376 {
 377     ds_put_format(s, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth));
 378     if (mask && !eth_mask_is_exact(*mask)) {
 379         ds_put_format(s, "/"ETH_ADDR_FMT, ETH_ADDR_ARGS(*mask));
 380     }
 381 }
 382
 383 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
 384  * that it specifies, that is, the number of 1-bits in 'netmask'.
 385  *
 386  * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
 387  * still be in the valid range but isn't otherwise meaningful. */
 388 int
 389 ip_count_cidr_bits(ovs_be32 netmask)
 390 {
 391     return 32 - ctz32(ntohl(netmask));
 392 }
 393
 394 void
 395 ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *s)
 396 {
 397     ds_put_format(s, IP_FMT, IP_ARGS(ip));
 398     if (mask != OVS_BE32_MAX) {
 399         if (ip_is_cidr(mask)) {
 400             ds_put_format(s, "/%d", ip_count_cidr_bits(mask));
 401         } else {
 402             ds_put_format(s, "/"IP_FMT, IP_ARGS(mask));
 403         }
 404     }
 405 }
 406
 407 /* Parses string 's', which must be an IP address with an optional netmask or
 408  * CIDR prefix length.  Stores the IP address into '*ip' and the netmask into
 409  * '*mask'.  (If 's' does not contain a netmask, 255.255.255.255 is
 410  * assumed.)
 411  *
 412  * Returns NULL if successful, otherwise an error message that the caller must
 413  * free(). */
 414 char * OVS_WARN_UNUSED_RESULT
 415 ip_parse_masked(const char *s, ovs_be32 *ip, ovs_be32 *mask)
 416 {
 417     int prefix;
 418     int n;
 419
 420     if (ovs_scan(s, IP_SCAN_FMT"/"IP_SCAN_FMT"%n",
 421                  IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask), &n) && !s[n]) {
 422         /* OK. */
 423     } else if (ovs_scan(s, IP_SCAN_FMT"/%d%n", IP_SCAN_ARGS(ip), &prefix, &n)
 424                && !s[n]) {
 425         if (prefix <= 0 || prefix > 32) {
 426             return xasprintf("%s: network prefix bits not between 0 and "
 427                              "32", s);
 428         }
 429         *mask = be32_prefix_mask(prefix);
 430     } else if (ovs_scan(s, IP_SCAN_FMT"%n", IP_SCAN_ARGS(ip), &n) && !s[n]) {
 431         *mask = OVS_BE32_MAX;
 432     } else {
 433         return xasprintf("%s: invalid IP address", s);
 434     }
 435     return NULL;
 436 }
 437
 438 void
 439 ipv6_format_addr(const struct in6_addr *addr, struct ds *s)
 440 {
 441     char *dst;
 442
 443     ds_reserve(s, s->length + INET6_ADDRSTRLEN);
 444
 445     dst = s->string + s->length;
 446     inet_ntop(AF_INET6, addr, dst, INET6_ADDRSTRLEN);
 447     s->length += strlen(dst);
 448 }
 449
 450 void
 451 ipv6_format_mapped(const struct in6_addr *addr, struct ds *s)
 452 {
 453     if (IN6_IS_ADDR_V4MAPPED(addr)) {
 454         ds_put_format(s, IP_FMT, addr->s6_addr[12], addr->s6_addr[13],
 455                                  addr->s6_addr[14], addr->s6_addr[15]);
 456     } else {
 457         ipv6_format_addr(addr, s);
 458     }
 459 }
 460
 461 void
 462 ipv6_format_masked(const struct in6_addr *addr, const struct in6_addr *mask,
 463                    struct ds *s)
 464 {
 465     ipv6_format_addr(addr, s);
 466     if (mask && !ipv6_mask_is_exact(mask)) {
 467         if (ipv6_is_cidr(mask)) {
 468             int cidr_bits = ipv6_count_cidr_bits(mask);
 469             ds_put_format(s, "/%d", cidr_bits);
 470         } else {
 471             ds_put_char(s, '/');
 472             ipv6_format_addr(mask, s);
 473         }
 474     }
 475 }
 476
 477 struct in6_addr ipv6_addr_bitand(const struct in6_addr *a,
 478                                  const struct in6_addr *b)
 479 {
 480     int i;
 481     struct in6_addr dst;
 482
 483 #ifdef s6_addr32
 484     for (i=0; i<4; i++) {
 485         dst.s6_addr32[i] = a->s6_addr32[i] & b->s6_addr32[i];
 486     }
 487 #else
 488     for (i=0; i<16; i++) {
 489         dst.s6_addr[i] = a->s6_addr[i] & b->s6_addr[i];
 490     }
 491 #endif
 492
 493     return dst;
 494 }
 495
 496 /* Returns an in6_addr consisting of 'mask' high-order 1-bits and 128-N
 497  * low-order 0-bits. */
 498 struct in6_addr
 499 ipv6_create_mask(int mask)
 500 {
 501     struct in6_addr netmask;
 502     uint8_t *netmaskp = &netmask.s6_addr[0];
 503
 504     memset(&netmask, 0, sizeof netmask);
 505     while (mask > 8) {
 506         *netmaskp = 0xff;
 507         netmaskp++;
 508         mask -= 8;
 509     }
 510
 511     if (mask) {
 512         *netmaskp = 0xff << (8 - mask);
 513     }
 514
 515     return netmask;
 516 }
 517
 518 /* Given the IPv6 netmask 'netmask', returns the number of bits of the IPv6
 519  * address that it specifies, that is, the number of 1-bits in 'netmask'.
 520  * 'netmask' must be a CIDR netmask (see ipv6_is_cidr()).
 521  *
 522  * If 'netmask' is not a CIDR netmask (see ipv6_is_cidr()), the return value
 523  * will still be in the valid range but isn't otherwise meaningful. */
 524 int
 525 ipv6_count_cidr_bits(const struct in6_addr *netmask)
 526 {
 527     int i;
 528     int count = 0;
 529     const uint8_t *netmaskp = &netmask->s6_addr[0];
 530
 531     for (i=0; i<16; i++) {
 532         if (netmaskp[i] == 0xff) {
 533             count += 8;
 534         } else {
 535             uint8_t nm;
 536
 537             for(nm = netmaskp[i]; nm; nm <<= 1) {
 538                 count++;
 539             }
 540             break;
 541         }
 542
 543     }
 544
 545     return count;
 546 }
 547
 548 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
 549  * high-order 1-bits and 128-N low-order 0-bits. */
 550 bool
 551 ipv6_is_cidr(const struct in6_addr *netmask)
 552 {
 553     const uint8_t *netmaskp = &netmask->s6_addr[0];
 554     int i;
 555
 556     for (i=0; i<16; i++) {
 557         if (netmaskp[i] != 0xff) {
 558             uint8_t x = ~netmaskp[i];
 559             if (x & (x + 1)) {
 560                 return false;
 561             }
 562             while (++i < 16) {
 563                 if (netmaskp[i]) {
 564                     return false;
 565                 }
 566             }
 567         }
 568     }
 569
 570     return true;
 571 }
 572
 573 /* Populates 'b' with an Ethernet II packet headed with the given 'eth_dst',
 574  * 'eth_src' and 'eth_type' parameters.  A payload of 'size' bytes is allocated
 575  * in 'b' and returned.  This payload may be populated with appropriate
 576  * information by the caller.  Sets 'b''s 'frame' pointer and 'l3' offset to
 577  * the Ethernet header and payload respectively.  Aligns b->l3 on a 32-bit
 578  * boundary.
 579  *
 580  * The returned packet has enough headroom to insert an 802.1Q VLAN header if
 581  * desired. */
 582 void *
 583 eth_compose(struct dp_packet *b, const struct eth_addr eth_dst,
 584             const struct eth_addr eth_src, uint16_t eth_type,
 585             size_t size)
 586 {
 587     void *data;
 588     struct eth_header *eth;
 589
 590     dp_packet_clear(b);
 591
 592     /* The magic 2 here ensures that the L3 header (when it is added later)
 593      * will be 32-bit aligned. */
 594     dp_packet_prealloc_tailroom(b, 2 + ETH_HEADER_LEN + VLAN_HEADER_LEN + size);
 595     dp_packet_reserve(b, 2 + VLAN_HEADER_LEN);
 596     eth = dp_packet_put_uninit(b, ETH_HEADER_LEN);
 597     data = dp_packet_put_uninit(b, size);
 598
 599     eth->eth_dst = eth_dst;
 600     eth->eth_src = eth_src;
 601     eth->eth_type = htons(eth_type);
 602
 603     dp_packet_reset_offsets(b);
 604     dp_packet_set_l3(b, data);
 605
 606     return data;
 607 }
 608
 609 static void
 610 packet_set_ipv4_addr(struct dp_packet *packet,
 611                      ovs_16aligned_be32 *addr, ovs_be32 new_addr)
 612 {
 613     struct ip_header *nh = dp_packet_l3(packet);
 614     ovs_be32 old_addr = get_16aligned_be32(addr);
 615     size_t l4_size = dp_packet_l4_size(packet);
 616
 617     if (nh->ip_proto == IPPROTO_TCP && l4_size >= TCP_HEADER_LEN) {
 618         struct tcp_header *th = dp_packet_l4(packet);
 619
 620         th->tcp_csum = recalc_csum32(th->tcp_csum, old_addr, new_addr);
 621     } else if (nh->ip_proto == IPPROTO_UDP && l4_size >= UDP_HEADER_LEN ) {
 622         struct udp_header *uh = dp_packet_l4(packet);
 623
 624         if (uh->udp_csum) {
 625             uh->udp_csum = recalc_csum32(uh->udp_csum, old_addr, new_addr);
 626             if (!uh->udp_csum) {
 627                 uh->udp_csum = htons(0xffff);
 628             }
 629         }
 630     }
 631     nh->ip_csum = recalc_csum32(nh->ip_csum, old_addr, new_addr);
 632     put_16aligned_be32(addr, new_addr);
 633 }
 634
 635 /* Returns true, if packet contains at least one routing header where
 636  * segements_left > 0.
 637  *
 638  * This function assumes that L3 and L4 offsets are set in the packet. */
 639 static bool
 640 packet_rh_present(struct dp_packet *packet)
 641 {
 642     const struct ovs_16aligned_ip6_hdr *nh;
 643     int nexthdr;
 644     size_t len;
 645     size_t remaining;
 646     uint8_t *data = dp_packet_l3(packet);
 647
 648     remaining = packet->l4_ofs - packet->l3_ofs;
 649
 650     if (remaining < sizeof *nh) {
 651         return false;
 652     }
 653     nh = ALIGNED_CAST(struct ovs_16aligned_ip6_hdr *, data);
 654     data += sizeof *nh;
 655     remaining -= sizeof *nh;
 656     nexthdr = nh->ip6_nxt;
 657
 658     while (1) {
 659         if ((nexthdr != IPPROTO_HOPOPTS)
 660                 && (nexthdr != IPPROTO_ROUTING)
 661                 && (nexthdr != IPPROTO_DSTOPTS)
 662                 && (nexthdr != IPPROTO_AH)
 663                 && (nexthdr != IPPROTO_FRAGMENT)) {
 664             /* It's either a terminal header (e.g., TCP, UDP) or one we
 665              * don't understand.  In either case, we're done with the
 666              * packet, so use it to fill in 'nw_proto'. */
 667             break;
 668         }
 669
 670         /* We only verify that at least 8 bytes of the next header are
 671          * available, but many of these headers are longer.  Ensure that
 672          * accesses within the extension header are within those first 8
 673          * bytes. All extension headers are required to be at least 8
 674          * bytes. */
 675         if (remaining < 8) {
 676             return false;
 677         }
 678
 679         if (nexthdr == IPPROTO_AH) {
 680             /* A standard AH definition isn't available, but the fields
 681              * we care about are in the same location as the generic
 682              * option header--only the header length is calculated
 683              * differently. */
 684             const struct ip6_ext *ext_hdr = (struct ip6_ext *)data;
 685
 686             nexthdr = ext_hdr->ip6e_nxt;
 687             len = (ext_hdr->ip6e_len + 2) * 4;
 688         } else if (nexthdr == IPPROTO_FRAGMENT) {
 689             const struct ovs_16aligned_ip6_frag *frag_hdr
 690                 = ALIGNED_CAST(struct ovs_16aligned_ip6_frag *, data);
 691
 692             nexthdr = frag_hdr->ip6f_nxt;
 693             len = sizeof *frag_hdr;
 694         } else if (nexthdr == IPPROTO_ROUTING) {
 695             const struct ip6_rthdr *rh = (struct ip6_rthdr *)data;
 696
 697             if (rh->ip6r_segleft > 0) {
 698                 return true;
 699             }
 700
 701             nexthdr = rh->ip6r_nxt;
 702             len = (rh->ip6r_len + 1) * 8;
 703         } else {
 704             const struct ip6_ext *ext_hdr = (struct ip6_ext *)data;
 705
 706             nexthdr = ext_hdr->ip6e_nxt;
 707             len = (ext_hdr->ip6e_len + 1) * 8;
 708         }
 709
 710         if (remaining < len) {
 711             return false;
 712         }
 713         remaining -= len;
 714         data += len;
 715     }
 716
 717     return false;
 718 }
 719
 720 static void
 721 packet_update_csum128(struct dp_packet *packet, uint8_t proto,
 722                      ovs_16aligned_be32 addr[4], const ovs_be32 new_addr[4])
 723 {
 724     size_t l4_size = dp_packet_l4_size(packet);
 725
 726     if (proto == IPPROTO_TCP && l4_size >= TCP_HEADER_LEN) {
 727         struct tcp_header *th = dp_packet_l4(packet);
 728
 729         th->tcp_csum = recalc_csum128(th->tcp_csum, addr, new_addr);
 730     } else if (proto == IPPROTO_UDP && l4_size >= UDP_HEADER_LEN) {
 731         struct udp_header *uh = dp_packet_l4(packet);
 732
 733         if (uh->udp_csum) {
 734             uh->udp_csum = recalc_csum128(uh->udp_csum, addr, new_addr);
 735             if (!uh->udp_csum) {
 736                 uh->udp_csum = htons(0xffff);
 737             }
 738         }
 739     } else if (proto == IPPROTO_ICMPV6 &&
 740                l4_size >= sizeof(struct icmp6_header)) {
 741         struct icmp6_header *icmp = dp_packet_l4(packet);
 742
 743         icmp->icmp6_cksum = recalc_csum128(icmp->icmp6_cksum, addr, new_addr);
 744     }
 745 }
 746
 747 static void
 748 packet_set_ipv6_addr(struct dp_packet *packet, uint8_t proto,
 749                      ovs_16aligned_be32 addr[4], const ovs_be32 new_addr[4],
 750                      bool recalculate_csum)
 751 {
 752     if (recalculate_csum) {
 753         packet_update_csum128(packet, proto, addr, new_addr);
 754     }
 755     memcpy(addr, new_addr, sizeof(ovs_be32[4]));
 756 }
 757
 758 static void
 759 packet_set_ipv6_flow_label(ovs_16aligned_be32 *flow_label, ovs_be32 flow_key)
 760 {
 761     ovs_be32 old_label = get_16aligned_be32(flow_label);
 762     ovs_be32 new_label = (old_label & htonl(~IPV6_LABEL_MASK)) | flow_key;
 763     put_16aligned_be32(flow_label, new_label);
 764 }
 765
 766 static void
 767 packet_set_ipv6_tc(ovs_16aligned_be32 *flow_label, uint8_t tc)
 768 {
 769     ovs_be32 old_label = get_16aligned_be32(flow_label);
 770     ovs_be32 new_label = (old_label & htonl(0xF00FFFFF)) | htonl(tc << 20);
 771     put_16aligned_be32(flow_label, new_label);
 772 }
 773
 774 /* Modifies the IPv4 header fields of 'packet' to be consistent with 'src',
 775  * 'dst', 'tos', and 'ttl'.  Updates 'packet''s L4 checksums as appropriate.
 776  * 'packet' must contain a valid IPv4 packet with correctly populated l[347]
 777  * markers. */
 778 void
 779 packet_set_ipv4(struct dp_packet *packet, ovs_be32 src, ovs_be32 dst,
 780                 uint8_t tos, uint8_t ttl)
 781 {
 782     struct ip_header *nh = dp_packet_l3(packet);
 783
 784     if (get_16aligned_be32(&nh->ip_src) != src) {
 785         packet_set_ipv4_addr(packet, &nh->ip_src, src);
 786     }
 787
 788     if (get_16aligned_be32(&nh->ip_dst) != dst) {
 789         packet_set_ipv4_addr(packet, &nh->ip_dst, dst);
 790     }
 791
 792     if (nh->ip_tos != tos) {
 793         uint8_t *field = &nh->ip_tos;
 794
 795         nh->ip_csum = recalc_csum16(nh->ip_csum, htons((uint16_t) *field),
 796                                     htons((uint16_t) tos));
 797         *field = tos;
 798     }
 799
 800     if (nh->ip_ttl != ttl) {
 801         uint8_t *field = &nh->ip_ttl;
 802
 803         nh->ip_csum = recalc_csum16(nh->ip_csum, htons(*field << 8),
 804                                     htons(ttl << 8));
 805         *field = ttl;
 806     }
 807 }
 808
 809 /* Modifies the IPv6 header fields of 'packet' to be consistent with 'src',
 810  * 'dst', 'traffic class', and 'next hop'.  Updates 'packet''s L4 checksums as
 811  * appropriate. 'packet' must contain a valid IPv6 packet with correctly
 812  * populated l[34] offsets. */
 813 void
 814 packet_set_ipv6(struct dp_packet *packet, uint8_t proto, const ovs_be32 src[4],
 815                 const ovs_be32 dst[4], uint8_t key_tc, ovs_be32 key_fl,
 816                 uint8_t key_hl)
 817 {
 818     struct ovs_16aligned_ip6_hdr *nh = dp_packet_l3(packet);
 819
 820     if (memcmp(&nh->ip6_src, src, sizeof(ovs_be32[4]))) {
 821         packet_set_ipv6_addr(packet, proto, nh->ip6_src.be32, src, true);
 822     }
 823
 824     if (memcmp(&nh->ip6_dst, dst, sizeof(ovs_be32[4]))) {
 825         packet_set_ipv6_addr(packet, proto, nh->ip6_dst.be32, dst,
 826                              !packet_rh_present(packet));
 827     }
 828
 829     packet_set_ipv6_tc(&nh->ip6_flow, key_tc);
 830
 831     packet_set_ipv6_flow_label(&nh->ip6_flow, key_fl);
 832
 833     nh->ip6_hlim = key_hl;
 834 }
 835
 836 static void
 837 packet_set_port(ovs_be16 *port, ovs_be16 new_port, ovs_be16 *csum)
 838 {
 839     if (*port != new_port) {
 840         *csum = recalc_csum16(*csum, *port, new_port);
 841         *port = new_port;
 842     }
 843 }
 844
 845 /* Sets the TCP source and destination port ('src' and 'dst' respectively) of
 846  * the TCP header contained in 'packet'.  'packet' must be a valid TCP packet
 847  * with its l4 offset properly populated. */
 848 void
 849 packet_set_tcp_port(struct dp_packet *packet, ovs_be16 src, ovs_be16 dst)
 850 {
 851     struct tcp_header *th = dp_packet_l4(packet);
 852
 853     packet_set_port(&th->tcp_src, src, &th->tcp_csum);
 854     packet_set_port(&th->tcp_dst, dst, &th->tcp_csum);
 855 }
 856
 857 /* Sets the UDP source and destination port ('src' and 'dst' respectively) of
 858  * the UDP header contained in 'packet'.  'packet' must be a valid UDP packet
 859  * with its l4 offset properly populated. */
 860 void
 861 packet_set_udp_port(struct dp_packet *packet, ovs_be16 src, ovs_be16 dst)
 862 {
 863     struct udp_header *uh = dp_packet_l4(packet);
 864
 865     if (uh->udp_csum) {
 866         packet_set_port(&uh->udp_src, src, &uh->udp_csum);
 867         packet_set_port(&uh->udp_dst, dst, &uh->udp_csum);
 868
 869         if (!uh->udp_csum) {
 870             uh->udp_csum = htons(0xffff);
 871         }
 872     } else {
 873         uh->udp_src = src;
 874         uh->udp_dst = dst;
 875     }
 876 }
 877
 878 /* Sets the SCTP source and destination port ('src' and 'dst' respectively) of
 879  * the SCTP header contained in 'packet'.  'packet' must be a valid SCTP packet
 880  * with its l4 offset properly populated. */
 881 void
 882 packet_set_sctp_port(struct dp_packet *packet, ovs_be16 src, ovs_be16 dst)
 883 {
 884     struct sctp_header *sh = dp_packet_l4(packet);
 885     ovs_be32 old_csum, old_correct_csum, new_csum;
 886     uint16_t tp_len = dp_packet_l4_size(packet);
 887
 888     old_csum = get_16aligned_be32(&sh->sctp_csum);
 889     put_16aligned_be32(&sh->sctp_csum, 0);
 890     old_correct_csum = crc32c((void *)sh, tp_len);
 891
 892     sh->sctp_src = src;
 893     sh->sctp_dst = dst;
 894
 895     new_csum = crc32c((void *)sh, tp_len);
 896     put_16aligned_be32(&sh->sctp_csum, old_csum ^ old_correct_csum ^ new_csum);
 897 }
 898
 899 /* Sets the ICMP type and code of the ICMP header contained in 'packet'.
 900  * 'packet' must be a valid ICMP packet with its l4 offset properly
 901  * populated. */
 902 void
 903 packet_set_icmp(struct dp_packet *packet, uint8_t type, uint8_t code)
 904 {
 905     struct icmp_header *ih = dp_packet_l4(packet);
 906     ovs_be16 orig_tc = htons(ih->icmp_type << 8 | ih->icmp_code);
 907     ovs_be16 new_tc = htons(type << 8 | code);
 908
 909     if (orig_tc != new_tc) {
 910         ih->icmp_type = type;
 911         ih->icmp_code = code;
 912
 913         ih->icmp_csum = recalc_csum16(ih->icmp_csum, orig_tc, new_tc);
 914     }
 915 }
 916
 917 void
 918 packet_set_nd(struct dp_packet *packet, const ovs_be32 target[4],
 919               const struct eth_addr sll, const struct eth_addr tll) {
 920     struct ovs_nd_msg *ns;
 921     struct ovs_nd_opt *nd_opt;
 922     int bytes_remain = dp_packet_l4_size(packet);
 923
 924     if (OVS_UNLIKELY(bytes_remain < sizeof(*ns))) {
 925         return;
 926     }
 927
 928     ns = dp_packet_l4(packet);
 929     nd_opt = &ns->options[0];
 930     bytes_remain -= sizeof(*ns);
 931
 932     if (memcmp(&ns->target, target, sizeof(ovs_be32[4]))) {
 933         packet_set_ipv6_addr(packet, IPPROTO_ICMPV6,
 934                              ns->target.be32,
 935                              target, true);
 936     }
 937
 938     while (bytes_remain >= ND_OPT_LEN && nd_opt->nd_opt_len != 0) {
 939         if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
 940             && nd_opt->nd_opt_len == 1) {
 941             if (!eth_addr_equals(nd_opt->nd_opt_mac, sll)) {
 942                 ovs_be16 *csum = &(ns->icmph.icmp6_cksum);
 943
 944                 *csum = recalc_csum48(*csum, nd_opt->nd_opt_mac, sll);
 945                 nd_opt->nd_opt_mac = sll;
 946             }
 947
 948             /* A packet can only contain one SLL or TLL option */
 949             break;
 950         } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
 951                    && nd_opt->nd_opt_len == 1) {
 952             if (!eth_addr_equals(nd_opt->nd_opt_mac, tll)) {
 953                 ovs_be16 *csum = &(ns->icmph.icmp6_cksum);
 954
 955                 *csum = recalc_csum48(*csum, nd_opt->nd_opt_mac, tll);
 956                 nd_opt->nd_opt_mac = tll;
 957             }
 958
 959             /* A packet can only contain one SLL or TLL option */
 960             break;
 961         }
 962
 963         nd_opt += nd_opt->nd_opt_len;
 964         bytes_remain -= nd_opt->nd_opt_len * ND_OPT_LEN;
 965     }
 966 }
 967
 968 const char *
 969 packet_tcp_flag_to_string(uint32_t flag)
 970 {
 971     switch (flag) {
 972     case TCP_FIN:
 973         return "fin";
 974     case TCP_SYN:
 975         return "syn";
 976     case TCP_RST:
 977         return "rst";
 978     case TCP_PSH:
 979         return "psh";
 980     case TCP_ACK:
 981         return "ack";
 982     case TCP_URG:
 983         return "urg";
 984     case TCP_ECE:
 985         return "ece";
 986     case TCP_CWR:
 987         return "cwr";
 988     case TCP_NS:
 989         return "ns";
 990     case 0x200:
 991         return "[200]";
 992     case 0x400:
 993         return "[400]";
 994     case 0x800:
 995         return "[800]";
 996     default:
 997         return NULL;
 998     }
 999 }
1000
1001 /* Appends a string representation of the TCP flags value 'tcp_flags'
1002  * (e.g. from struct flow.tcp_flags or obtained via TCP_FLAGS) to 's', in the
1003  * format used by tcpdump. */
1004 void
1005 packet_format_tcp_flags(struct ds *s, uint16_t tcp_flags)
1006 {
1007     if (!tcp_flags) {
1008         ds_put_cstr(s, "none");
1009         return;
1010     }
1011
1012     if (tcp_flags & TCP_SYN) {
1013         ds_put_char(s, 'S');
1014     }
1015     if (tcp_flags & TCP_FIN) {
1016         ds_put_char(s, 'F');
1017     }
1018     if (tcp_flags & TCP_PSH) {
1019         ds_put_char(s, 'P');
1020     }
1021     if (tcp_flags & TCP_RST) {
1022         ds_put_char(s, 'R');
1023     }
1024     if (tcp_flags & TCP_URG) {
1025         ds_put_char(s, 'U');
1026     }
1027     if (tcp_flags & TCP_ACK) {
1028         ds_put_char(s, '.');
1029     }
1030     if (tcp_flags & TCP_ECE) {
1031         ds_put_cstr(s, "E");
1032     }
1033     if (tcp_flags & TCP_CWR) {
1034         ds_put_cstr(s, "C");
1035     }
1036     if (tcp_flags & TCP_NS) {
1037         ds_put_cstr(s, "N");
1038     }
1039     if (tcp_flags & 0x200) {
1040         ds_put_cstr(s, "[200]");
1041     }
1042     if (tcp_flags & 0x400) {
1043         ds_put_cstr(s, "[400]");
1044     }
1045     if (tcp_flags & 0x800) {
1046         ds_put_cstr(s, "[800]");
1047     }
1048 }
1049
1050 #define ARP_PACKET_SIZE  (2 + ETH_HEADER_LEN + VLAN_HEADER_LEN + \
1051                           ARP_ETH_HEADER_LEN)
1052
1053 /* Clears 'b' and replaces its contents by an ARP frame with the specified
1054  * 'arp_op', 'arp_sha', 'arp_tha', 'arp_spa', and 'arp_tpa'.  The outer
1055  * Ethernet frame is initialized with Ethernet source 'arp_sha' and destination
1056  * 'arp_tha', except that destination ff:ff:ff:ff:ff:ff is used instead if
1057  * 'broadcast' is true. */
1058 void
1059 compose_arp(struct dp_packet *b, uint16_t arp_op,
1060             const struct eth_addr arp_sha, const struct eth_addr arp_tha,
1061             bool broadcast, ovs_be32 arp_spa, ovs_be32 arp_tpa)
1062 {
1063     struct eth_header *eth;
1064     struct arp_eth_header *arp;
1065
1066     dp_packet_clear(b);
1067     dp_packet_prealloc_tailroom(b, ARP_PACKET_SIZE);
1068     dp_packet_reserve(b, 2 + VLAN_HEADER_LEN);
1069
1070     eth = dp_packet_put_uninit(b, sizeof *eth);
1071     eth->eth_dst = broadcast ? eth_addr_broadcast : arp_tha;
1072     eth->eth_src = arp_sha;
1073     eth->eth_type = htons(ETH_TYPE_ARP);
1074
1075     arp = dp_packet_put_uninit(b, sizeof *arp);
1076     arp->ar_hrd = htons(ARP_HRD_ETHERNET);
1077     arp->ar_pro = htons(ARP_PRO_IP);
1078     arp->ar_hln = sizeof arp->ar_sha;
1079     arp->ar_pln = sizeof arp->ar_spa;
1080     arp->ar_op = htons(arp_op);
1081     arp->ar_sha = arp_sha;
1082     arp->ar_tha = arp_tha;
1083
1084     put_16aligned_be32(&arp->ar_spa, arp_spa);
1085     put_16aligned_be32(&arp->ar_tpa, arp_tpa);
1086
1087     dp_packet_reset_offsets(b);
1088     dp_packet_set_l3(b, arp);
1089 }
1090
1091 uint32_t
1092 packet_csum_pseudoheader(const struct ip_header *ip)
1093 {
1094     uint32_t partial = 0;
1095
1096     partial = csum_add32(partial, get_16aligned_be32(&ip->ip_src));
1097     partial = csum_add32(partial, get_16aligned_be32(&ip->ip_dst));
1098     partial = csum_add16(partial, htons(ip->ip_proto));
1099     partial = csum_add16(partial, htons(ntohs(ip->ip_tot_len) -
1100                                         IP_IHL(ip->ip_ihl_ver) * 4));
1101
1102     return partial;
1103 }
1104