lib/packets.c

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