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