lib/packets.c

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