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 /* Stores the string representation of the IPv6 address 'addr' into the
 439  * character array 'addr_str', which must be at least INET6_ADDRSTRLEN
 440  * bytes long. */
 441 void
 442 format_ipv6_addr(char *addr_str, const struct in6_addr *addr)
 443 {
 444     inet_ntop(AF_INET6, addr, addr_str, INET6_ADDRSTRLEN);
 445 }
 446
 447 void
 448 print_ipv6_addr(struct ds *string, const struct in6_addr *addr)
 449 {
 450     char *dst;
 451
 452     ds_reserve(string, string->length + INET6_ADDRSTRLEN);
 453
 454     dst = string->string + string->length;
 455     format_ipv6_addr(dst, addr);
 456     string->length += strlen(dst);
 457 }
 458
 459 void
 460 print_ipv6_mapped(struct ds *s, const struct in6_addr *addr)
 461 {
 462     if (IN6_IS_ADDR_V4MAPPED(addr)) {
 463         ds_put_format(s, IP_FMT, addr->s6_addr[12], addr->s6_addr[13],
 464                                  addr->s6_addr[14], addr->s6_addr[15]);
 465     } else {
 466         print_ipv6_addr(s, addr);
 467     }
 468 }
 469
 470 void
 471 print_ipv6_masked(struct ds *s, const struct in6_addr *addr,
 472                   const struct in6_addr *mask)
 473 {
 474     print_ipv6_addr(s, addr);
 475     if (mask && !ipv6_mask_is_exact(mask)) {
 476         if (ipv6_is_cidr(mask)) {
 477             int cidr_bits = ipv6_count_cidr_bits(mask);
 478             ds_put_format(s, "/%d", cidr_bits);
 479         } else {
 480             ds_put_char(s, '/');
 481             print_ipv6_addr(s, mask);
 482         }
 483     }
 484 }
 485
 486 struct in6_addr ipv6_addr_bitand(const struct in6_addr *a,
 487                                  const struct in6_addr *b)
 488 {
 489     int i;
 490     struct in6_addr dst;
 491
 492 #ifdef s6_addr32
 493     for (i=0; i<4; i++) {
 494         dst.s6_addr32[i] = a->s6_addr32[i] & b->s6_addr32[i];
 495     }
 496 #else
 497     for (i=0; i<16; i++) {
 498         dst.s6_addr[i] = a->s6_addr[i] & b->s6_addr[i];
 499     }
 500 #endif
 501
 502     return dst;
 503 }
 504
 505 /* Returns an in6_addr consisting of 'mask' high-order 1-bits and 128-N
 506  * low-order 0-bits. */
 507 struct in6_addr
 508 ipv6_create_mask(int mask)
 509 {
 510     struct in6_addr netmask;
 511     uint8_t *netmaskp = &netmask.s6_addr[0];
 512
 513     memset(&netmask, 0, sizeof netmask);
 514     while (mask > 8) {
 515         *netmaskp = 0xff;
 516         netmaskp++;
 517         mask -= 8;
 518     }
 519
 520     if (mask) {
 521         *netmaskp = 0xff << (8 - mask);
 522     }
 523
 524     return netmask;
 525 }
 526
 527 /* Given the IPv6 netmask 'netmask', returns the number of bits of the IPv6
 528  * address that it specifies, that is, the number of 1-bits in 'netmask'.
 529  * 'netmask' must be a CIDR netmask (see ipv6_is_cidr()).
 530  *
 531  * If 'netmask' is not a CIDR netmask (see ipv6_is_cidr()), the return value
 532  * will still be in the valid range but isn't otherwise meaningful. */
 533 int
 534 ipv6_count_cidr_bits(const struct in6_addr *netmask)
 535 {
 536     int i;
 537     int count = 0;
 538     const uint8_t *netmaskp = &netmask->s6_addr[0];
 539
 540     for (i=0; i<16; i++) {
 541         if (netmaskp[i] == 0xff) {
 542             count += 8;
 543         } else {
 544             uint8_t nm;
 545
 546             for(nm = netmaskp[i]; nm; nm <<= 1) {
 547                 count++;
 548             }
 549             break;
 550         }
 551
 552     }
 553
 554     return count;
 555 }
 556
 557 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
 558  * high-order 1-bits and 128-N low-order 0-bits. */
 559 bool
 560 ipv6_is_cidr(const struct in6_addr *netmask)
 561 {
 562     const uint8_t *netmaskp = &netmask->s6_addr[0];
 563     int i;
 564
 565     for (i=0; i<16; i++) {
 566         if (netmaskp[i] != 0xff) {
 567             uint8_t x = ~netmaskp[i];
 568             if (x & (x + 1)) {
 569                 return false;
 570             }
 571             while (++i < 16) {
 572                 if (netmaskp[i]) {
 573                     return false;
 574                 }
 575             }
 576         }
 577     }
 578
 579     return true;
 580 }
 581
 582 /* Populates 'b' with an Ethernet II packet headed with the given 'eth_dst',
 583  * 'eth_src' and 'eth_type' parameters.  A payload of 'size' bytes is allocated
 584  * in 'b' and returned.  This payload may be populated with appropriate
 585  * information by the caller.  Sets 'b''s 'frame' pointer and 'l3' offset to
 586  * the Ethernet header and payload respectively.  Aligns b->l3 on a 32-bit
 587  * boundary.
 588  *
 589  * The returned packet has enough headroom to insert an 802.1Q VLAN header if
 590  * desired. */
 591 void *
 592 eth_compose(struct dp_packet *b, const struct eth_addr eth_dst,
 593             const struct eth_addr eth_src, uint16_t eth_type,
 594             size_t size)
 595 {
 596     void *data;
 597     struct eth_header *eth;
 598
 599     dp_packet_clear(b);
 600
 601     /* The magic 2 here ensures that the L3 header (when it is added later)
 602      * will be 32-bit aligned. */
 603     dp_packet_prealloc_tailroom(b, 2 + ETH_HEADER_LEN + VLAN_HEADER_LEN + size);
 604     dp_packet_reserve(b, 2 + VLAN_HEADER_LEN);
 605     eth = dp_packet_put_uninit(b, ETH_HEADER_LEN);
 606     data = dp_packet_put_uninit(b, size);
 607
 608     eth->eth_dst = eth_dst;
 609     eth->eth_src = eth_src;
 610     eth->eth_type = htons(eth_type);
 611
 612     dp_packet_reset_offsets(b);
 613     dp_packet_set_l3(b, data);
 614
 615     return data;
 616 }
 617
 618 static void
 619 packet_set_ipv4_addr(struct dp_packet *packet,
 620                      ovs_16aligned_be32 *addr, ovs_be32 new_addr)
 621 {
 622     struct ip_header *nh = dp_packet_l3(packet);
 623     ovs_be32 old_addr = get_16aligned_be32(addr);
 624     size_t l4_size = dp_packet_l4_size(packet);
 625
 626     if (nh->ip_proto == IPPROTO_TCP && l4_size >= TCP_HEADER_LEN) {
 627         struct tcp_header *th = dp_packet_l4(packet);
 628
 629         th->tcp_csum = recalc_csum32(th->tcp_csum, old_addr, new_addr);
 630     } else if (nh->ip_proto == IPPROTO_UDP && l4_size >= UDP_HEADER_LEN ) {
 631         struct udp_header *uh = dp_packet_l4(packet);
 632
 633         if (uh->udp_csum) {
 634             uh->udp_csum = recalc_csum32(uh->udp_csum, old_addr, new_addr);
 635             if (!uh->udp_csum) {
 636                 uh->udp_csum = htons(0xffff);
 637             }
 638         }
 639     }
 640     nh->ip_csum = recalc_csum32(nh->ip_csum, old_addr, new_addr);
 641     put_16aligned_be32(addr, new_addr);
 642 }
 643
 644 /* Returns true, if packet contains at least one routing header where
 645  * segements_left > 0.
 646  *
 647  * This function assumes that L3 and L4 offsets are set in the packet. */
 648 static bool
 649 packet_rh_present(struct dp_packet *packet)
 650 {
 651     const struct ovs_16aligned_ip6_hdr *nh;
 652     int nexthdr;
 653     size_t len;
 654     size_t remaining;
 655     uint8_t *data = dp_packet_l3(packet);
 656
 657     remaining = packet->l4_ofs - packet->l3_ofs;
 658
 659     if (remaining < sizeof *nh) {
 660         return false;
 661     }
 662     nh = ALIGNED_CAST(struct ovs_16aligned_ip6_hdr *, data);
 663     data += sizeof *nh;
 664     remaining -= sizeof *nh;
 665     nexthdr = nh->ip6_nxt;
 666
 667     while (1) {
 668         if ((nexthdr != IPPROTO_HOPOPTS)
 669                 && (nexthdr != IPPROTO_ROUTING)
 670                 && (nexthdr != IPPROTO_DSTOPTS)
 671                 && (nexthdr != IPPROTO_AH)
 672                 && (nexthdr != IPPROTO_FRAGMENT)) {
 673             /* It's either a terminal header (e.g., TCP, UDP) or one we
 674              * don't understand.  In either case, we're done with the
 675              * packet, so use it to fill in 'nw_proto'. */
 676             break;
 677         }
 678
 679         /* We only verify that at least 8 bytes of the next header are
 680          * available, but many of these headers are longer.  Ensure that
 681          * accesses within the extension header are within those first 8
 682          * bytes. All extension headers are required to be at least 8
 683          * bytes. */
 684         if (remaining < 8) {
 685             return false;
 686         }
 687
 688         if (nexthdr == IPPROTO_AH) {
 689             /* A standard AH definition isn't available, but the fields
 690              * we care about are in the same location as the generic
 691              * option header--only the header length is calculated
 692              * differently. */
 693             const struct ip6_ext *ext_hdr = (struct ip6_ext *)data;
 694
 695             nexthdr = ext_hdr->ip6e_nxt;
 696             len = (ext_hdr->ip6e_len + 2) * 4;
 697         } else if (nexthdr == IPPROTO_FRAGMENT) {
 698             const struct ovs_16aligned_ip6_frag *frag_hdr
 699                 = ALIGNED_CAST(struct ovs_16aligned_ip6_frag *, data);
 700
 701             nexthdr = frag_hdr->ip6f_nxt;
 702             len = sizeof *frag_hdr;
 703         } else if (nexthdr == IPPROTO_ROUTING) {
 704             const struct ip6_rthdr *rh = (struct ip6_rthdr *)data;
 705
 706             if (rh->ip6r_segleft > 0) {
 707                 return true;
 708             }
 709
 710             nexthdr = rh->ip6r_nxt;
 711             len = (rh->ip6r_len + 1) * 8;
 712         } else {
 713             const struct ip6_ext *ext_hdr = (struct ip6_ext *)data;
 714
 715             nexthdr = ext_hdr->ip6e_nxt;
 716             len = (ext_hdr->ip6e_len + 1) * 8;
 717         }
 718
 719         if (remaining < len) {
 720             return false;
 721         }
 722         remaining -= len;
 723         data += len;
 724     }
 725
 726     return false;
 727 }
 728
 729 static void
 730 packet_update_csum128(struct dp_packet *packet, uint8_t proto,
 731                      ovs_16aligned_be32 addr[4], const ovs_be32 new_addr[4])
 732 {
 733     size_t l4_size = dp_packet_l4_size(packet);
 734
 735     if (proto == IPPROTO_TCP && l4_size >= TCP_HEADER_LEN) {
 736         struct tcp_header *th = dp_packet_l4(packet);
 737
 738         th->tcp_csum = recalc_csum128(th->tcp_csum, addr, new_addr);
 739     } else if (proto == IPPROTO_UDP && l4_size >= UDP_HEADER_LEN) {
 740         struct udp_header *uh = dp_packet_l4(packet);
 741
 742         if (uh->udp_csum) {
 743             uh->udp_csum = recalc_csum128(uh->udp_csum, addr, new_addr);
 744             if (!uh->udp_csum) {
 745                 uh->udp_csum = htons(0xffff);
 746             }
 747         }
 748     } else if (proto == IPPROTO_ICMPV6 &&
 749                l4_size >= sizeof(struct icmp6_header)) {
 750         struct icmp6_header *icmp = dp_packet_l4(packet);
 751
 752         icmp->icmp6_cksum = recalc_csum128(icmp->icmp6_cksum, addr, new_addr);
 753     }
 754 }
 755
 756 static void
 757 packet_set_ipv6_addr(struct dp_packet *packet, uint8_t proto,
 758                      ovs_16aligned_be32 addr[4], const ovs_be32 new_addr[4],
 759                      bool recalculate_csum)
 760 {
 761     if (recalculate_csum) {
 762         packet_update_csum128(packet, proto, addr, new_addr);
 763     }
 764     memcpy(addr, new_addr, sizeof(ovs_be32[4]));
 765 }
 766
 767 static void
 768 packet_set_ipv6_flow_label(ovs_16aligned_be32 *flow_label, ovs_be32 flow_key)
 769 {
 770     ovs_be32 old_label = get_16aligned_be32(flow_label);
 771     ovs_be32 new_label = (old_label & htonl(~IPV6_LABEL_MASK)) | flow_key;
 772     put_16aligned_be32(flow_label, new_label);
 773 }
 774
 775 static void
 776 packet_set_ipv6_tc(ovs_16aligned_be32 *flow_label, uint8_t tc)
 777 {
 778     ovs_be32 old_label = get_16aligned_be32(flow_label);
 779     ovs_be32 new_label = (old_label & htonl(0xF00FFFFF)) | htonl(tc << 20);
 780     put_16aligned_be32(flow_label, new_label);
 781 }
 782
 783 /* Modifies the IPv4 header fields of 'packet' to be consistent with 'src',
 784  * 'dst', 'tos', and 'ttl'.  Updates 'packet''s L4 checksums as appropriate.
 785  * 'packet' must contain a valid IPv4 packet with correctly populated l[347]
 786  * markers. */
 787 void
 788 packet_set_ipv4(struct dp_packet *packet, ovs_be32 src, ovs_be32 dst,
 789                 uint8_t tos, uint8_t ttl)
 790 {
 791     struct ip_header *nh = dp_packet_l3(packet);
 792
 793     if (get_16aligned_be32(&nh->ip_src) != src) {
 794         packet_set_ipv4_addr(packet, &nh->ip_src, src);
 795     }
 796
 797     if (get_16aligned_be32(&nh->ip_dst) != dst) {
 798         packet_set_ipv4_addr(packet, &nh->ip_dst, dst);
 799     }
 800
 801     if (nh->ip_tos != tos) {
 802         uint8_t *field = &nh->ip_tos;
 803
 804         nh->ip_csum = recalc_csum16(nh->ip_csum, htons((uint16_t) *field),
 805                                     htons((uint16_t) tos));
 806         *field = tos;
 807     }
 808
 809     if (nh->ip_ttl != ttl) {
 810         uint8_t *field = &nh->ip_ttl;
 811
 812         nh->ip_csum = recalc_csum16(nh->ip_csum, htons(*field << 8),
 813                                     htons(ttl << 8));
 814         *field = ttl;
 815     }
 816 }
 817
 818 /* Modifies the IPv6 header fields of 'packet' to be consistent with 'src',
 819  * 'dst', 'traffic class', and 'next hop'.  Updates 'packet''s L4 checksums as
 820  * appropriate. 'packet' must contain a valid IPv6 packet with correctly
 821  * populated l[34] offsets. */
 822 void
 823 packet_set_ipv6(struct dp_packet *packet, uint8_t proto, const ovs_be32 src[4],
 824                 const ovs_be32 dst[4], uint8_t key_tc, ovs_be32 key_fl,
 825                 uint8_t key_hl)
 826 {
 827     struct ovs_16aligned_ip6_hdr *nh = dp_packet_l3(packet);
 828
 829     if (memcmp(&nh->ip6_src, src, sizeof(ovs_be32[4]))) {
 830         packet_set_ipv6_addr(packet, proto, nh->ip6_src.be32, src, true);
 831     }
 832
 833     if (memcmp(&nh->ip6_dst, dst, sizeof(ovs_be32[4]))) {
 834         packet_set_ipv6_addr(packet, proto, nh->ip6_dst.be32, dst,
 835                              !packet_rh_present(packet));
 836     }
 837
 838     packet_set_ipv6_tc(&nh->ip6_flow, key_tc);
 839
 840     packet_set_ipv6_flow_label(&nh->ip6_flow, key_fl);
 841
 842     nh->ip6_hlim = key_hl;
 843 }
 844
 845 static void
 846 packet_set_port(ovs_be16 *port, ovs_be16 new_port, ovs_be16 *csum)
 847 {
 848     if (*port != new_port) {
 849         *csum = recalc_csum16(*csum, *port, new_port);
 850         *port = new_port;
 851     }
 852 }
 853
 854 /* Sets the TCP source and destination port ('src' and 'dst' respectively) of
 855  * the TCP header contained in 'packet'.  'packet' must be a valid TCP packet
 856  * with its l4 offset properly populated. */
 857 void
 858 packet_set_tcp_port(struct dp_packet *packet, ovs_be16 src, ovs_be16 dst)
 859 {
 860     struct tcp_header *th = dp_packet_l4(packet);
 861
 862     packet_set_port(&th->tcp_src, src, &th->tcp_csum);
 863     packet_set_port(&th->tcp_dst, dst, &th->tcp_csum);
 864 }
 865
 866 /* Sets the UDP source and destination port ('src' and 'dst' respectively) of
 867  * the UDP header contained in 'packet'.  'packet' must be a valid UDP packet
 868  * with its l4 offset properly populated. */
 869 void
 870 packet_set_udp_port(struct dp_packet *packet, ovs_be16 src, ovs_be16 dst)
 871 {
 872     struct udp_header *uh = dp_packet_l4(packet);
 873
 874     if (uh->udp_csum) {
 875         packet_set_port(&uh->udp_src, src, &uh->udp_csum);
 876         packet_set_port(&uh->udp_dst, dst, &uh->udp_csum);
 877
 878         if (!uh->udp_csum) {
 879             uh->udp_csum = htons(0xffff);
 880         }
 881     } else {
 882         uh->udp_src = src;
 883         uh->udp_dst = dst;
 884     }
 885 }
 886
 887 /* Sets the SCTP source and destination port ('src' and 'dst' respectively) of
 888  * the SCTP header contained in 'packet'.  'packet' must be a valid SCTP packet
 889  * with its l4 offset properly populated. */
 890 void
 891 packet_set_sctp_port(struct dp_packet *packet, ovs_be16 src, ovs_be16 dst)
 892 {
 893     struct sctp_header *sh = dp_packet_l4(packet);
 894     ovs_be32 old_csum, old_correct_csum, new_csum;
 895     uint16_t tp_len = dp_packet_l4_size(packet);
 896
 897     old_csum = get_16aligned_be32(&sh->sctp_csum);
 898     put_16aligned_be32(&sh->sctp_csum, 0);
 899     old_correct_csum = crc32c((void *)sh, tp_len);
 900
 901     sh->sctp_src = src;
 902     sh->sctp_dst = dst;
 903
 904     new_csum = crc32c((void *)sh, tp_len);
 905     put_16aligned_be32(&sh->sctp_csum, old_csum ^ old_correct_csum ^ new_csum);
 906 }
 907
 908 /* Sets the ICMP type and code of the ICMP header contained in 'packet'.
 909  * 'packet' must be a valid ICMP packet with its l4 offset properly
 910  * populated. */
 911 void
 912 packet_set_icmp(struct dp_packet *packet, uint8_t type, uint8_t code)
 913 {
 914     struct icmp_header *ih = dp_packet_l4(packet);
 915     ovs_be16 orig_tc = htons(ih->icmp_type << 8 | ih->icmp_code);
 916     ovs_be16 new_tc = htons(type << 8 | code);
 917
 918     if (orig_tc != new_tc) {
 919         ih->icmp_type = type;
 920         ih->icmp_code = code;
 921
 922         ih->icmp_csum = recalc_csum16(ih->icmp_csum, orig_tc, new_tc);
 923     }
 924 }
 925
 926 void
 927 packet_set_nd(struct dp_packet *packet, const ovs_be32 target[4],
 928               const struct eth_addr sll, const struct eth_addr tll) {
 929     struct ovs_nd_msg *ns;
 930     struct ovs_nd_opt *nd_opt;
 931     int bytes_remain = dp_packet_l4_size(packet);
 932
 933     if (OVS_UNLIKELY(bytes_remain < sizeof(*ns))) {
 934         return;
 935     }
 936
 937     ns = dp_packet_l4(packet);
 938     nd_opt = &ns->options[0];
 939     bytes_remain -= sizeof(*ns);
 940
 941     if (memcmp(&ns->target, target, sizeof(ovs_be32[4]))) {
 942         packet_set_ipv6_addr(packet, IPPROTO_ICMPV6,
 943                              ns->target.be32,
 944                              target, true);
 945     }
 946
 947     while (bytes_remain >= ND_OPT_LEN && nd_opt->nd_opt_len != 0) {
 948         if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
 949             && nd_opt->nd_opt_len == 1) {
 950             if (!eth_addr_equals(nd_opt->nd_opt_mac, sll)) {
 951                 ovs_be16 *csum = &(ns->icmph.icmp6_cksum);
 952
 953                 *csum = recalc_csum48(*csum, nd_opt->nd_opt_mac, sll);
 954                 nd_opt->nd_opt_mac = sll;
 955             }
 956
 957             /* A packet can only contain one SLL or TLL option */
 958             break;
 959         } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
 960                    && nd_opt->nd_opt_len == 1) {
 961             if (!eth_addr_equals(nd_opt->nd_opt_mac, tll)) {
 962                 ovs_be16 *csum = &(ns->icmph.icmp6_cksum);
 963
 964                 *csum = recalc_csum48(*csum, nd_opt->nd_opt_mac, tll);
 965                 nd_opt->nd_opt_mac = tll;
 966             }
 967
 968             /* A packet can only contain one SLL or TLL option */
 969             break;
 970         }
 971
 972         nd_opt += nd_opt->nd_opt_len;
 973         bytes_remain -= nd_opt->nd_opt_len * ND_OPT_LEN;
 974     }
 975 }
 976
 977 const char *
 978 packet_tcp_flag_to_string(uint32_t flag)
 979 {
 980     switch (flag) {
 981     case TCP_FIN:
 982         return "fin";
 983     case TCP_SYN:
 984         return "syn";
 985     case TCP_RST:
 986         return "rst";
 987     case TCP_PSH:
 988         return "psh";
 989     case TCP_ACK:
 990         return "ack";
 991     case TCP_URG:
 992         return "urg";
 993     case TCP_ECE:
 994         return "ece";
 995     case TCP_CWR:
 996         return "cwr";
 997     case TCP_NS:
 998         return "ns";
 999     case 0x200:
1000         return "[200]";
1001     case 0x400:
1002         return "[400]";
1003     case 0x800:
1004         return "[800]";
1005     default:
1006         return NULL;
1007     }
1008 }
1009
1010 /* Appends a string representation of the TCP flags value 'tcp_flags'
1011  * (e.g. from struct flow.tcp_flags or obtained via TCP_FLAGS) to 's', in the
1012  * format used by tcpdump. */
1013 void
1014 packet_format_tcp_flags(struct ds *s, uint16_t tcp_flags)
1015 {
1016     if (!tcp_flags) {
1017         ds_put_cstr(s, "none");
1018         return;
1019     }
1020
1021     if (tcp_flags & TCP_SYN) {
1022         ds_put_char(s, 'S');
1023     }
1024     if (tcp_flags & TCP_FIN) {
1025         ds_put_char(s, 'F');
1026     }
1027     if (tcp_flags & TCP_PSH) {
1028         ds_put_char(s, 'P');
1029     }
1030     if (tcp_flags & TCP_RST) {
1031         ds_put_char(s, 'R');
1032     }
1033     if (tcp_flags & TCP_URG) {
1034         ds_put_char(s, 'U');
1035     }
1036     if (tcp_flags & TCP_ACK) {
1037         ds_put_char(s, '.');
1038     }
1039     if (tcp_flags & TCP_ECE) {
1040         ds_put_cstr(s, "E");
1041     }
1042     if (tcp_flags & TCP_CWR) {
1043         ds_put_cstr(s, "C");
1044     }
1045     if (tcp_flags & TCP_NS) {
1046         ds_put_cstr(s, "N");
1047     }
1048     if (tcp_flags & 0x200) {
1049         ds_put_cstr(s, "[200]");
1050     }
1051     if (tcp_flags & 0x400) {
1052         ds_put_cstr(s, "[400]");
1053     }
1054     if (tcp_flags & 0x800) {
1055         ds_put_cstr(s, "[800]");
1056     }
1057 }
1058
1059 #define ARP_PACKET_SIZE  (2 + ETH_HEADER_LEN + VLAN_HEADER_LEN + \
1060                           ARP_ETH_HEADER_LEN)
1061
1062 /* Clears 'b' and replaces its contents by an ARP frame with the specified
1063  * 'arp_op', 'arp_sha', 'arp_tha', 'arp_spa', and 'arp_tpa'.  The outer
1064  * Ethernet frame is initialized with Ethernet source 'arp_sha' and destination
1065  * 'arp_tha', except that destination ff:ff:ff:ff:ff:ff is used instead if
1066  * 'broadcast' is true. */
1067 void
1068 compose_arp(struct dp_packet *b, uint16_t arp_op,
1069             const struct eth_addr arp_sha, const struct eth_addr arp_tha,
1070             bool broadcast, ovs_be32 arp_spa, ovs_be32 arp_tpa)
1071 {
1072     struct eth_header *eth;
1073     struct arp_eth_header *arp;
1074
1075     dp_packet_clear(b);
1076     dp_packet_prealloc_tailroom(b, ARP_PACKET_SIZE);
1077     dp_packet_reserve(b, 2 + VLAN_HEADER_LEN);
1078
1079     eth = dp_packet_put_uninit(b, sizeof *eth);
1080     eth->eth_dst = broadcast ? eth_addr_broadcast : arp_tha;
1081     eth->eth_src = arp_sha;
1082     eth->eth_type = htons(ETH_TYPE_ARP);
1083
1084     arp = dp_packet_put_uninit(b, sizeof *arp);
1085     arp->ar_hrd = htons(ARP_HRD_ETHERNET);
1086     arp->ar_pro = htons(ARP_PRO_IP);
1087     arp->ar_hln = sizeof arp->ar_sha;
1088     arp->ar_pln = sizeof arp->ar_spa;
1089     arp->ar_op = htons(arp_op);
1090     arp->ar_sha = arp_sha;
1091     arp->ar_tha = arp_tha;
1092
1093     put_16aligned_be32(&arp->ar_spa, arp_spa);
1094     put_16aligned_be32(&arp->ar_tpa, arp_tpa);
1095
1096     dp_packet_reset_offsets(b);
1097     dp_packet_set_l3(b, arp);
1098 }
1099
1100 uint32_t
1101 packet_csum_pseudoheader(const struct ip_header *ip)
1102 {
1103     uint32_t partial = 0;
1104
1105     partial = csum_add32(partial, get_16aligned_be32(&ip->ip_src));
1106     partial = csum_add32(partial, get_16aligned_be32(&ip->ip_dst));
1107     partial = csum_add16(partial, htons(ip->ip_proto));
1108     partial = csum_add16(partial, htons(ntohs(ip->ip_tot_len) -
1109                                         IP_IHL(ip->ip_ihl_ver) * 4));
1110
1111     return partial;
1112 }
1113