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 = (ovs_be16 *)((char *)(packet->l2_5 ? packet->l2_5 : packet->l3) - 2);
 254         *p = eth_type;
 255     } else {
 256         eh->eth_type = eth_type;
 257     }
 258 }
 259
 260 static bool is_mpls(struct ofpbuf *packet)
 261 {
 262     return packet->l2_5 != NULL;
 263 }
 264
 265 /* Set time to live (TTL) of an MPLS label stack entry (LSE). */
 266 void
 267 set_mpls_lse_ttl(ovs_be32 *lse, uint8_t ttl)
 268 {
 269     *lse &= ~htonl(MPLS_TTL_MASK);
 270     *lse |= htonl((ttl << MPLS_TTL_SHIFT) & MPLS_TTL_MASK);
 271 }
 272
 273 /* Set traffic class (TC) of an MPLS label stack entry (LSE). */
 274 void
 275 set_mpls_lse_tc(ovs_be32 *lse, uint8_t tc)
 276 {
 277     *lse &= ~htonl(MPLS_TC_MASK);
 278     *lse |= htonl((tc << MPLS_TC_SHIFT) & MPLS_TC_MASK);
 279 }
 280
 281 /* Set label of an MPLS label stack entry (LSE). */
 282 void
 283 set_mpls_lse_label(ovs_be32 *lse, ovs_be32 label)
 284 {
 285     *lse &= ~htonl(MPLS_LABEL_MASK);
 286     *lse |= htonl((ntohl(label) << MPLS_LABEL_SHIFT) & MPLS_LABEL_MASK);
 287 }
 288
 289 /* Set bottom of stack (BoS) bit of an MPLS label stack entry (LSE). */
 290 void
 291 set_mpls_lse_bos(ovs_be32 *lse, uint8_t bos)
 292 {
 293     *lse &= ~htonl(MPLS_BOS_MASK);
 294     *lse |= htonl((bos << MPLS_BOS_SHIFT) & MPLS_BOS_MASK);
 295 }
 296
 297 /* Compose an MPLS label stack entry (LSE) from its components:
 298  * label, traffic class (TC), time to live (TTL) and
 299  * bottom of stack (BoS) bit. */
 300 ovs_be32
 301 set_mpls_lse_values(uint8_t ttl, uint8_t tc, uint8_t bos, ovs_be32 label)
 302 {
 303     ovs_be32 lse = htonl(0);
 304     set_mpls_lse_ttl(&lse, ttl);
 305     set_mpls_lse_tc(&lse, tc);
 306     set_mpls_lse_bos(&lse, bos);
 307     set_mpls_lse_label(&lse, label);
 308     return lse;
 309 }
 310
 311 /* Push an new MPLS stack entry onto the MPLS stack and adjust 'packet->l2' and
 312  * 'packet->l2_5' accordingly.  The new entry will be the outermost entry on
 313  * the stack.
 314  *
 315  * Previous to calling this function, 'packet->l2_5' must be set; if the MPLS
 316  * label to be pushed will be the first label in 'packet', then it should be
 317  * the same as 'packet->l3'. */
 318 static void
 319 push_mpls_lse(struct ofpbuf *packet, struct mpls_hdr *mh)
 320 {
 321     char * header;
 322     size_t len;
 323     header = ofpbuf_push_uninit(packet, MPLS_HLEN);
 324     len = (char *)packet->l2_5 - (char *)packet->l2;
 325     memmove(header, packet->l2, len);
 326     memcpy(header + len, mh, sizeof *mh);
 327     packet->l2 = (char*)packet->l2 - MPLS_HLEN;
 328     packet->l2_5 = (char*)packet->l2_5 - MPLS_HLEN;
 329 }
 330
 331 /* Set MPLS label stack entry to outermost MPLS header.*/
 332 void
 333 set_mpls_lse(struct ofpbuf *packet, ovs_be32 mpls_lse)
 334 {
 335     struct mpls_hdr *mh = packet->l2_5;
 336
 337     /* Packet type should be MPLS to set label stack entry. */
 338     if (is_mpls(packet)) {
 339         /* Update mpls label stack entry. */
 340         mh->mpls_lse = mpls_lse;
 341     }
 342 }
 343
 344 /* Push MPLS label stack entry 'lse' onto 'packet' as the the outermost MPLS
 345  * header.  If 'packet' does not already have any MPLS labels, then its
 346  * Ethertype is changed to 'ethtype' (which must be an MPLS Ethertype). */
 347 void
 348 push_mpls(struct ofpbuf *packet, ovs_be16 ethtype, ovs_be32 lse)
 349 {
 350     struct mpls_hdr mh;
 351
 352     if (!eth_type_mpls(ethtype)) {
 353         return;
 354     }
 355
 356     if (!is_mpls(packet)) {
 357         /* Set ethtype and MPLS label stack entry. */
 358         set_ethertype(packet, ethtype);
 359         packet->l2_5 = packet->l3;
 360     }
 361
 362     /* Push new MPLS shim header onto packet. */
 363     mh.mpls_lse = lse;
 364     push_mpls_lse(packet, &mh);
 365 }
 366
 367 /* If 'packet' is an MPLS packet, removes its outermost MPLS label stack entry.
 368  * If the label that was removed was the only MPLS label, changes 'packet''s
 369  * Ethertype to 'ethtype' (which ordinarily should not be an MPLS
 370  * Ethertype). */
 371 void
 372 pop_mpls(struct ofpbuf *packet, ovs_be16 ethtype)
 373 {
 374     struct mpls_hdr *mh = NULL;
 375
 376     if (is_mpls(packet)) {
 377         size_t len;
 378         mh = packet->l2_5;
 379         len = (char*)packet->l2_5 - (char*)packet->l2;
 380         set_ethertype(packet, ethtype);
 381         if (mh->mpls_lse & htonl(MPLS_BOS_MASK)) {
 382             packet->l2_5 = NULL;
 383         } else {
 384             packet->l2_5 = (char*)packet->l2_5 + MPLS_HLEN;
 385         }
 386         /* Shift the l2 header forward. */
 387         memmove((char*)packet->data + MPLS_HLEN, packet->data, len);
 388         packet->size -= MPLS_HLEN;
 389         packet->data = (char*)packet->data + MPLS_HLEN;
 390         packet->l2 = (char*)packet->l2 + MPLS_HLEN;
 391     }
 392 }
 393
 394 /* Converts hex digits in 'hex' to an Ethernet packet in '*packetp'.  The
 395  * caller must free '*packetp'.  On success, returns NULL.  On failure, returns
 396  * an error message and stores NULL in '*packetp'. */
 397 const char *
 398 eth_from_hex(const char *hex, struct ofpbuf **packetp)
 399 {
 400     struct ofpbuf *packet;
 401
 402     packet = *packetp = ofpbuf_new(strlen(hex) / 2);
 403
 404     if (ofpbuf_put_hex(packet, hex, NULL)[0] != '\0') {
 405         ofpbuf_delete(packet);
 406         *packetp = NULL;
 407         return "Trailing garbage in packet data";
 408     }
 409
 410     if (packet->size < ETH_HEADER_LEN) {
 411         ofpbuf_delete(packet);
 412         *packetp = NULL;
 413         return "Packet data too short for Ethernet";
 414     }
 415
 416     return NULL;
 417 }
 418
 419 void
 420 eth_format_masked(const uint8_t eth[ETH_ADDR_LEN],
 421                   const uint8_t mask[ETH_ADDR_LEN], struct ds *s)
 422 {
 423     ds_put_format(s, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth));
 424     if (mask && !eth_mask_is_exact(mask)) {
 425         ds_put_format(s, "/"ETH_ADDR_FMT, ETH_ADDR_ARGS(mask));
 426     }
 427 }
 428
 429 void
 430 eth_addr_bitand(const uint8_t src[ETH_ADDR_LEN],
 431                 const uint8_t mask[ETH_ADDR_LEN],
 432                 uint8_t dst[ETH_ADDR_LEN])
 433 {
 434     int i;
 435
 436     for (i = 0; i < ETH_ADDR_LEN; i++) {
 437         dst[i] = src[i] & mask[i];
 438     }
 439 }
 440
 441 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
 442  * that it specifies, that is, the number of 1-bits in 'netmask'.
 443  *
 444  * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
 445  * still be in the valid range but isn't otherwise meaningful. */
 446 int
 447 ip_count_cidr_bits(ovs_be32 netmask)
 448 {
 449     return 32 - ctz(ntohl(netmask));
 450 }
 451
 452 void
 453 ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *s)
 454 {
 455     ds_put_format(s, IP_FMT, IP_ARGS(ip));
 456     if (mask != htonl(UINT32_MAX)) {
 457         if (ip_is_cidr(mask)) {
 458             ds_put_format(s, "/%d", ip_count_cidr_bits(mask));
 459         } else {
 460             ds_put_format(s, "/"IP_FMT, IP_ARGS(mask));
 461         }
 462     }
 463 }
 464
 465
 466 /* Stores the string representation of the IPv6 address 'addr' into the
 467  * character array 'addr_str', which must be at least INET6_ADDRSTRLEN
 468  * bytes long. */
 469 void
 470 format_ipv6_addr(char *addr_str, const struct in6_addr *addr)
 471 {
 472     inet_ntop(AF_INET6, addr, addr_str, INET6_ADDRSTRLEN);
 473 }
 474
 475 void
 476 print_ipv6_addr(struct ds *string, const struct in6_addr *addr)
 477 {
 478     char *dst;
 479
 480     ds_reserve(string, string->length + INET6_ADDRSTRLEN);
 481
 482     dst = string->string + string->length;
 483     format_ipv6_addr(dst, addr);
 484     string->length += strlen(dst);
 485 }
 486
 487 void
 488 print_ipv6_masked(struct ds *s, const struct in6_addr *addr,
 489                   const struct in6_addr *mask)
 490 {
 491     print_ipv6_addr(s, addr);
 492     if (mask && !ipv6_mask_is_exact(mask)) {
 493         if (ipv6_is_cidr(mask)) {
 494             int cidr_bits = ipv6_count_cidr_bits(mask);
 495             ds_put_format(s, "/%d", cidr_bits);
 496         } else {
 497             ds_put_char(s, '/');
 498             print_ipv6_addr(s, mask);
 499         }
 500     }
 501 }
 502
 503 struct in6_addr ipv6_addr_bitand(const struct in6_addr *a,
 504                                  const struct in6_addr *b)
 505 {
 506     int i;
 507     struct in6_addr dst;
 508
 509 #ifdef s6_addr32
 510     for (i=0; i<4; i++) {
 511         dst.s6_addr32[i] = a->s6_addr32[i] & b->s6_addr32[i];
 512     }
 513 #else
 514     for (i=0; i<16; i++) {
 515         dst.s6_addr[i] = a->s6_addr[i] & b->s6_addr[i];
 516     }
 517 #endif
 518
 519     return dst;
 520 }
 521
 522 /* Returns an in6_addr consisting of 'mask' high-order 1-bits and 128-N
 523  * low-order 0-bits. */
 524 struct in6_addr
 525 ipv6_create_mask(int mask)
 526 {
 527     struct in6_addr netmask;
 528     uint8_t *netmaskp = &netmask.s6_addr[0];
 529
 530     memset(&netmask, 0, sizeof netmask);
 531     while (mask > 8) {
 532         *netmaskp = 0xff;
 533         netmaskp++;
 534         mask -= 8;
 535     }
 536
 537     if (mask) {
 538         *netmaskp = 0xff << (8 - mask);
 539     }
 540
 541     return netmask;
 542 }
 543
 544 /* Given the IPv6 netmask 'netmask', returns the number of bits of the IPv6
 545  * address that it specifies, that is, the number of 1-bits in 'netmask'.
 546  * 'netmask' must be a CIDR netmask (see ipv6_is_cidr()).
 547  *
 548  * If 'netmask' is not a CIDR netmask (see ipv6_is_cidr()), the return value
 549  * will still be in the valid range but isn't otherwise meaningful. */
 550 int
 551 ipv6_count_cidr_bits(const struct in6_addr *netmask)
 552 {
 553     int i;
 554     int count = 0;
 555     const uint8_t *netmaskp = &netmask->s6_addr[0];
 556
 557     for (i=0; i<16; i++) {
 558         if (netmaskp[i] == 0xff) {
 559             count += 8;
 560         } else {
 561             uint8_t nm;
 562
 563             for(nm = netmaskp[i]; nm; nm <<= 1) {
 564                 count++;
 565             }
 566             break;
 567         }
 568
 569     }
 570
 571     return count;
 572 }
 573
 574 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
 575  * high-order 1-bits and 128-N low-order 0-bits. */
 576 bool
 577 ipv6_is_cidr(const struct in6_addr *netmask)
 578 {
 579     const uint8_t *netmaskp = &netmask->s6_addr[0];
 580     int i;
 581
 582     for (i=0; i<16; i++) {
 583         if (netmaskp[i] != 0xff) {
 584             uint8_t x = ~netmaskp[i];
 585             if (x & (x + 1)) {
 586                 return false;
 587             }
 588             while (++i < 16) {
 589                 if (netmaskp[i]) {
 590                     return false;
 591                 }
 592             }
 593         }
 594     }
 595
 596     return true;
 597 }
 598
 599 /* Populates 'b' with an Ethernet II packet headed with the given 'eth_dst',
 600  * 'eth_src' and 'eth_type' parameters.  A payload of 'size' bytes is allocated
 601  * in 'b' and returned.  This payload may be populated with appropriate
 602  * information by the caller.  Sets 'b''s 'l2' and 'l3' pointers to the
 603  * Ethernet header and payload respectively.
 604  *
 605  * The returned packet has enough headroom to insert an 802.1Q VLAN header if
 606  * desired. */
 607 void *
 608 eth_compose(struct ofpbuf *b, const uint8_t eth_dst[ETH_ADDR_LEN],
 609             const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
 610             size_t size)
 611 {
 612     void *data;
 613     struct eth_header *eth;
 614
 615     ofpbuf_clear(b);
 616
 617     ofpbuf_prealloc_tailroom(b, ETH_HEADER_LEN + VLAN_HEADER_LEN + size);
 618     ofpbuf_reserve(b, VLAN_HEADER_LEN);
 619     eth = ofpbuf_put_uninit(b, ETH_HEADER_LEN);
 620     data = ofpbuf_put_uninit(b, size);
 621
 622     memcpy(eth->eth_dst, eth_dst, ETH_ADDR_LEN);
 623     memcpy(eth->eth_src, eth_src, ETH_ADDR_LEN);
 624     eth->eth_type = htons(eth_type);
 625
 626     b->l2 = eth;
 627     b->l3 = data;
 628
 629     return data;
 630 }
 631
 632 static void
 633 packet_set_ipv4_addr(struct ofpbuf *packet, ovs_be32 *addr, ovs_be32 new_addr)
 634 {
 635     struct ip_header *nh = packet->l3;
 636
 637     if (nh->ip_proto == IPPROTO_TCP && packet->l7) {
 638         struct tcp_header *th = packet->l4;
 639
 640         th->tcp_csum = recalc_csum32(th->tcp_csum, *addr, new_addr);
 641     } else if (nh->ip_proto == IPPROTO_UDP && packet->l7) {
 642         struct udp_header *uh = packet->l4;
 643
 644         if (uh->udp_csum) {
 645             uh->udp_csum = recalc_csum32(uh->udp_csum, *addr, new_addr);
 646             if (!uh->udp_csum) {
 647                 uh->udp_csum = htons(0xffff);
 648             }
 649         }
 650     }
 651     nh->ip_csum = recalc_csum32(nh->ip_csum, *addr, new_addr);
 652     *addr = new_addr;
 653 }
 654
 655 /* Returns true, if packet contains at least one routing header where
 656  * segements_left > 0.
 657  *
 658  * This function assumes that L3 and L4 markers are set in the packet. */
 659 static bool
 660 packet_rh_present(struct ofpbuf *packet)
 661 {
 662     const struct ip6_hdr *nh;
 663     int nexthdr;
 664     size_t len;
 665     size_t remaining;
 666     uint8_t *data = packet->l3;
 667
 668     remaining = (uint8_t *)packet->l4 - (uint8_t *)packet->l3;
 669
 670     if (remaining < sizeof *nh) {
 671         return false;
 672     }
 673     nh = (struct ip6_hdr *)data;
 674     data += sizeof *nh;
 675     remaining -= sizeof *nh;
 676     nexthdr = nh->ip6_nxt;
 677
 678     while (1) {
 679         if ((nexthdr != IPPROTO_HOPOPTS)
 680                 && (nexthdr != IPPROTO_ROUTING)
 681                 && (nexthdr != IPPROTO_DSTOPTS)
 682                 && (nexthdr != IPPROTO_AH)
 683                 && (nexthdr != IPPROTO_FRAGMENT)) {
 684             /* It's either a terminal header (e.g., TCP, UDP) or one we
 685              * don't understand.  In either case, we're done with the
 686              * packet, so use it to fill in 'nw_proto'. */
 687             break;
 688         }
 689
 690         /* We only verify that at least 8 bytes of the next header are
 691          * available, but many of these headers are longer.  Ensure that
 692          * accesses within the extension header are within those first 8
 693          * bytes. All extension headers are required to be at least 8
 694          * bytes. */
 695         if (remaining < 8) {
 696             return false;
 697         }
 698
 699         if (nexthdr == IPPROTO_AH) {
 700             /* A standard AH definition isn't available, but the fields
 701              * we care about are in the same location as the generic
 702              * option header--only the header length is calculated
 703              * differently. */
 704             const struct ip6_ext *ext_hdr = (struct ip6_ext *)data;
 705
 706             nexthdr = ext_hdr->ip6e_nxt;
 707             len = (ext_hdr->ip6e_len + 2) * 4;
 708         } else if (nexthdr == IPPROTO_FRAGMENT) {
 709             const struct ip6_frag *frag_hdr = (struct ip6_frag *)data;
 710
 711             nexthdr = frag_hdr->ip6f_nxt;
 712             len = sizeof *frag_hdr;
 713         } else if (nexthdr == IPPROTO_ROUTING) {
 714             const struct ip6_rthdr *rh = (struct ip6_rthdr *)data;
 715
 716             if (rh->ip6r_segleft > 0) {
 717                 return true;
 718             }
 719
 720             nexthdr = rh->ip6r_nxt;
 721             len = (rh->ip6r_len + 1) * 8;
 722         } else {
 723             const struct ip6_ext *ext_hdr = (struct ip6_ext *)data;
 724
 725             nexthdr = ext_hdr->ip6e_nxt;
 726             len = (ext_hdr->ip6e_len + 1) * 8;
 727         }
 728
 729         if (remaining < len) {
 730             return false;
 731         }
 732         remaining -= len;
 733         data += len;
 734     }
 735
 736     return false;
 737 }
 738
 739 static void
 740 packet_update_csum128(struct ofpbuf *packet, uint8_t proto,
 741                      ovs_be32 addr[4], const ovs_be32 new_addr[4])
 742 {
 743     if (proto == IPPROTO_TCP && packet->l7) {
 744         struct tcp_header *th = packet->l4;
 745
 746         th->tcp_csum = recalc_csum128(th->tcp_csum, addr, new_addr);
 747     } else if (proto == IPPROTO_UDP && packet->l7) {
 748         struct udp_header *uh = packet->l4;
 749
 750         if (uh->udp_csum) {
 751             uh->udp_csum = recalc_csum128(uh->udp_csum, addr, new_addr);
 752             if (!uh->udp_csum) {
 753                 uh->udp_csum = htons(0xffff);
 754             }
 755         }
 756     }
 757 }
 758
 759 static void
 760 packet_set_ipv6_addr(struct ofpbuf *packet, uint8_t proto,
 761                      struct in6_addr *addr, const ovs_be32 new_addr[4],
 762                      bool recalculate_csum)
 763 {
 764     if (recalculate_csum) {
 765         packet_update_csum128(packet, proto, (ovs_be32 *)addr, new_addr);
 766     }
 767     memcpy(addr, new_addr, sizeof(*addr));
 768 }
 769
 770 static void
 771 packet_set_ipv6_flow_label(ovs_be32 *flow_label, ovs_be32 flow_key)
 772 {
 773     *flow_label = (*flow_label & htonl(~IPV6_LABEL_MASK)) | flow_key;
 774 }
 775
 776 static void
 777 packet_set_ipv6_tc(ovs_be32 *flow_label, uint8_t tc)
 778 {
 779     *flow_label = (*flow_label & htonl(0xF00FFFFF)) | htonl(tc << 20);
 780 }
 781
 782 /* Modifies the IPv4 header fields of 'packet' to be consistent with 'src',
 783  * 'dst', 'tos', and 'ttl'.  Updates 'packet''s L4 checksums as appropriate.
 784  * 'packet' must contain a valid IPv4 packet with correctly populated l[347]
 785  * markers. */
 786 void
 787 packet_set_ipv4(struct ofpbuf *packet, ovs_be32 src, ovs_be32 dst,
 788                 uint8_t tos, uint8_t ttl)
 789 {
 790     struct ip_header *nh = packet->l3;
 791
 792     if (nh->ip_src != src) {
 793         packet_set_ipv4_addr(packet, &nh->ip_src, src);
 794     }
 795
 796     if (nh->ip_dst != dst) {
 797         packet_set_ipv4_addr(packet, &nh->ip_dst, dst);
 798     }
 799
 800     if (nh->ip_tos != tos) {
 801         uint8_t *field = &nh->ip_tos;
 802
 803         nh->ip_csum = recalc_csum16(nh->ip_csum, htons((uint16_t) *field),
 804                                     htons((uint16_t) tos));
 805         *field = tos;
 806     }
 807
 808     if (nh->ip_ttl != ttl) {
 809         uint8_t *field = &nh->ip_ttl;
 810
 811         nh->ip_csum = recalc_csum16(nh->ip_csum, htons(*field << 8),
 812                                     htons(ttl << 8));
 813         *field = ttl;
 814     }
 815 }
 816
 817 /* Modifies the IPv6 header fields of 'packet' to be consistent with 'src',
 818  * 'dst', 'traffic class', and 'next hop'.  Updates 'packet''s L4 checksums as
 819  * appropriate. 'packet' must contain a valid IPv6 packet with correctly
 820  * populated l[347] markers. */
 821 void
 822 packet_set_ipv6(struct ofpbuf *packet, uint8_t proto, const ovs_be32 src[4],
 823                 const ovs_be32 dst[4], uint8_t key_tc, ovs_be32 key_fl,
 824                 uint8_t key_hl)
 825 {
 826     struct ip6_hdr *nh = packet->l3;
 827
 828     if (memcmp(&nh->ip6_src, src, sizeof(ovs_be32[4]))) {
 829         packet_set_ipv6_addr(packet, proto, &nh->ip6_src, src, true);
 830     }
 831
 832     if (memcmp(&nh->ip6_dst, dst, sizeof(ovs_be32[4]))) {
 833         packet_set_ipv6_addr(packet, proto, &nh->ip6_dst, dst,
 834                              !packet_rh_present(packet));
 835     }
 836
 837     packet_set_ipv6_tc(&nh->ip6_flow, key_tc);
 838
 839     packet_set_ipv6_flow_label(&nh->ip6_flow, key_fl);
 840
 841     nh->ip6_hlim = key_hl;
 842 }
 843
 844 static void
 845 packet_set_port(ovs_be16 *port, ovs_be16 new_port, ovs_be16 *csum)
 846 {
 847     if (*port != new_port) {
 848         *csum = recalc_csum16(*csum, *port, new_port);
 849         *port = new_port;
 850     }
 851 }
 852
 853 /* Sets the TCP source and destination port ('src' and 'dst' respectively) of
 854  * the TCP header contained in 'packet'.  'packet' must be a valid TCP packet
 855  * with its l4 marker properly populated. */
 856 void
 857 packet_set_tcp_port(struct ofpbuf *packet, ovs_be16 src, ovs_be16 dst)
 858 {
 859     struct tcp_header *th = packet->l4;
 860
 861     packet_set_port(&th->tcp_src, src, &th->tcp_csum);
 862     packet_set_port(&th->tcp_dst, dst, &th->tcp_csum);
 863 }
 864
 865 /* Sets the UDP source and destination port ('src' and 'dst' respectively) of
 866  * the UDP header contained in 'packet'.  'packet' must be a valid UDP packet
 867  * with its l4 marker properly populated. */
 868 void
 869 packet_set_udp_port(struct ofpbuf *packet, ovs_be16 src, ovs_be16 dst)
 870 {
 871     struct udp_header *uh = packet->l4;
 872
 873     if (uh->udp_csum) {
 874         packet_set_port(&uh->udp_src, src, &uh->udp_csum);
 875         packet_set_port(&uh->udp_dst, dst, &uh->udp_csum);
 876
 877         if (!uh->udp_csum) {
 878             uh->udp_csum = htons(0xffff);
 879         }
 880     } else {
 881         uh->udp_src = src;
 882         uh->udp_dst = dst;
 883     }
 884 }
 885
 886 /* If 'packet' is a TCP packet, returns the TCP flags.  Otherwise, returns 0.
 887  *
 888  * 'flow' must be the flow corresponding to 'packet' and 'packet''s header
 889  * pointers must be properly initialized (e.g. with flow_extract()). */
 890 uint8_t
 891 packet_get_tcp_flags(const struct ofpbuf *packet, const struct flow *flow)
 892 {
 893     if (dl_type_is_ip_any(flow->dl_type) &&
 894         flow->nw_proto == IPPROTO_TCP && packet->l7) {
 895         const struct tcp_header *tcp = packet->l4;
 896         return TCP_FLAGS(tcp->tcp_ctl);
 897     } else {
 898         return 0;
 899     }
 900 }
 901
 902 /* Appends a string representation of the TCP flags value 'tcp_flags'
 903  * (e.g. obtained via packet_get_tcp_flags() or TCP_FLAGS) to 's', in the
 904  * format used by tcpdump. */
 905 void
 906 packet_format_tcp_flags(struct ds *s, uint8_t tcp_flags)
 907 {
 908     if (!tcp_flags) {
 909         ds_put_cstr(s, "none");
 910         return;
 911     }
 912
 913     if (tcp_flags & TCP_SYN) {
 914         ds_put_char(s, 'S');
 915     }
 916     if (tcp_flags & TCP_FIN) {
 917         ds_put_char(s, 'F');
 918     }
 919     if (tcp_flags & TCP_PSH) {
 920         ds_put_char(s, 'P');
 921     }
 922     if (tcp_flags & TCP_RST) {
 923         ds_put_char(s, 'R');
 924     }
 925     if (tcp_flags & TCP_URG) {
 926         ds_put_char(s, 'U');
 927     }
 928     if (tcp_flags & TCP_ACK) {
 929         ds_put_char(s, '.');
 930     }
 931     if (tcp_flags & 0x40) {
 932         ds_put_cstr(s, "[40]");
 933     }
 934     if (tcp_flags & 0x80) {
 935         ds_put_cstr(s, "[80]");
 936     }
 937 }