lib/packets.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
   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 <assert.h>
  20 #include <arpa/inet.h>
  21 #include <netinet/in.h>
  22 #include <stdlib.h>
  23 #include "byte-order.h"
  24 #include "dynamic-string.h"
  25 #include "ofpbuf.h"
  26
  27 const struct in6_addr in6addr_exact = IN6ADDR_EXACT_INIT;
  28
  29 /* Parses 's' as a 16-digit hexadecimal number representing a datapath ID.  On
  30  * success stores the dpid into '*dpidp' and returns true, on failure stores 0
  31  * into '*dpidp' and returns false.
  32  *
  33  * Rejects an all-zeros dpid as invalid. */
  34 bool
  35 dpid_from_string(const char *s, uint64_t *dpidp)
  36 {
  37     *dpidp = (strlen(s) == 16 && strspn(s, "0123456789abcdefABCDEF") == 16
  38               ? strtoull(s, NULL, 16)
  39               : 0);
  40     return *dpidp != 0;
  41 }
  42
  43 bool
  44 eth_addr_from_string(const char *s, uint8_t ea[ETH_ADDR_LEN])
  45 {
  46     if (sscanf(s, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(ea))
  47         == ETH_ADDR_SCAN_COUNT) {
  48         return true;
  49     } else {
  50         memset(ea, 0, ETH_ADDR_LEN);
  51         return false;
  52     }
  53 }
  54
  55 /* Fills 'b' with an 802.2 SNAP packet with Ethernet source address 'eth_src',
  56  * the Nicira OUI as SNAP organization and 'snap_type' as SNAP type.  The text
  57  * string in 'tag' is enclosed as the packet payload.
  58  *
  59  * This function is used by Open vSwitch to compose packets in cases where
  60  * context is important but content doesn't (or shouldn't) matter.  For this
  61  * purpose, 'snap_type' should be a random number and 'tag' should be an
  62  * English phrase that explains the purpose of the packet.  (The English phrase
  63  * gives hapless admins running Wireshark the opportunity to figure out what's
  64  * going on.) */
  65 void
  66 compose_benign_packet(struct ofpbuf *b, const char *tag, uint16_t snap_type,
  67                       const uint8_t eth_src[ETH_ADDR_LEN])
  68 {
  69     size_t tag_size = strlen(tag) + 1;
  70     char *payload;
  71
  72     payload = snap_compose(b, eth_addr_broadcast, eth_src, 0x002320, snap_type,
  73                            tag_size + ETH_ADDR_LEN);
  74     memcpy(payload, tag, tag_size);
  75     memcpy(payload + tag_size, eth_src, ETH_ADDR_LEN);
  76 }
  77
  78 /* Insert VLAN header according to given TCI. Packet passed must be Ethernet
  79  * packet.
  80  *
  81  * Also sets 'packet->l2' to point to the new Ethernet header. */
  82 void
  83 eth_push_vlan(struct ofpbuf *packet, ovs_be16 tci)
  84 {
  85     struct eth_header *eh = packet->data;
  86     struct vlan_eth_header *veh;
  87
  88     /* Insert new 802.1Q header. */
  89     struct vlan_eth_header tmp;
  90     memcpy(tmp.veth_dst, eh->eth_dst, ETH_ADDR_LEN);
  91     memcpy(tmp.veth_src, eh->eth_src, ETH_ADDR_LEN);
  92     tmp.veth_type = htons(ETH_TYPE_VLAN);
  93     tmp.veth_tci = tci;
  94     tmp.veth_next_type = eh->eth_type;
  95
  96     veh = ofpbuf_push_uninit(packet, VLAN_HEADER_LEN);
  97     memcpy(veh, &tmp, sizeof tmp);
  98
  99     packet->l2 = packet->data;
 100 }
 101
 102 /* Stores the string representation of the IPv6 address 'addr' into the
 103  * character array 'addr_str', which must be at least INET6_ADDRSTRLEN
 104  * bytes long. */
 105 void
 106 format_ipv6_addr(char *addr_str, const struct in6_addr *addr)
 107 {
 108     inet_ntop(AF_INET6, addr, addr_str, INET6_ADDRSTRLEN);
 109 }
 110
 111 void
 112 print_ipv6_addr(struct ds *string, const struct in6_addr *addr)
 113 {
 114     char addr_str[INET6_ADDRSTRLEN];
 115
 116     format_ipv6_addr(addr_str, addr);
 117     ds_put_format(string, "%s", addr_str);
 118 }
 119
 120 struct in6_addr ipv6_addr_bitand(const struct in6_addr *a,
 121                                  const struct in6_addr *b)
 122 {
 123     int i;
 124     struct in6_addr dst;
 125
 126 #ifdef s6_addr32
 127     for (i=0; i<4; i++) {
 128         dst.s6_addr32[i] = a->s6_addr32[i] & b->s6_addr32[i];
 129     }
 130 #else
 131     for (i=0; i<16; i++) {
 132         dst.s6_addr[i] = a->s6_addr[i] & b->s6_addr[i];
 133     }
 134 #endif
 135
 136     return dst;
 137 }
 138
 139 /* Returns an in6_addr consisting of 'mask' high-order 1-bits and 128-N
 140  * low-order 0-bits. */
 141 struct in6_addr
 142 ipv6_create_mask(int mask)
 143 {
 144     struct in6_addr netmask;
 145     uint8_t *netmaskp = &netmask.s6_addr[0];
 146
 147     memset(&netmask, 0, sizeof netmask);
 148     while (mask > 8) {
 149         *netmaskp = 0xff;
 150         netmaskp++;
 151         mask -= 8;
 152     }
 153
 154     if (mask) {
 155         *netmaskp = 0xff << (8 - mask);
 156     }
 157
 158     return netmask;
 159 }
 160
 161 /* Given the IPv6 netmask 'netmask', returns the number of bits of the
 162  * IPv6 address that it wildcards.  'netmask' must be a CIDR netmask (see
 163  * ipv6_is_cidr()). */
 164 int
 165 ipv6_count_cidr_bits(const struct in6_addr *netmask)
 166 {
 167     int i;
 168     int count = 0;
 169     const uint8_t *netmaskp = &netmask->s6_addr[0];
 170
 171     assert(ipv6_is_cidr(netmask));
 172
 173     for (i=0; i<16; i++) {
 174         if (netmaskp[i] == 0xff) {
 175             count += 8;
 176         } else {
 177             uint8_t nm;
 178
 179             for(nm = netmaskp[i]; nm; nm <<= 1) {
 180                 count++;
 181             }
 182             break;
 183         }
 184
 185     }
 186
 187     return count;
 188 }
 189
 190 /* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
 191  * high-order 1-bits and 128-N low-order 0-bits. */
 192 bool
 193 ipv6_is_cidr(const struct in6_addr *netmask)
 194 {
 195     const uint8_t *netmaskp = &netmask->s6_addr[0];
 196     int i;
 197
 198     for (i=0; i<16; i++) {
 199         if (netmaskp[i] != 0xff) {
 200             uint8_t x = ~netmaskp[i];
 201             if (x & (x + 1)) {
 202                 return false;
 203             }
 204             while (++i < 16) {
 205                 if (netmaskp[i]) {
 206                     return false;
 207                 }
 208             }
 209         }
 210     }
 211
 212     return true;
 213 }
 214
 215 /* Populates 'b' with an Ethernet II packet headed with the given 'eth_dst',
 216  * 'eth_src' and 'eth_type' parameters.  A payload of 'size' bytes is allocated
 217  * in 'b' and returned.  This payload may be populated with appropriate
 218  * information by the caller.
 219  *
 220  * The returned packet has enough headroom to insert an 802.1Q VLAN header if
 221  * desired. */
 222 void *
 223 eth_compose(struct ofpbuf *b, const uint8_t eth_dst[ETH_ADDR_LEN],
 224             const uint8_t eth_src[ETH_ADDR_LEN], uint16_t eth_type,
 225             size_t size)
 226 {
 227     void *data;
 228     struct eth_header *eth;
 229
 230     ofpbuf_clear(b);
 231
 232     ofpbuf_prealloc_tailroom(b, ETH_HEADER_LEN + VLAN_HEADER_LEN + size);
 233     ofpbuf_reserve(b, VLAN_HEADER_LEN);
 234     eth = ofpbuf_put_uninit(b, ETH_HEADER_LEN);
 235     data = ofpbuf_put_uninit(b, size);
 236
 237     memcpy(eth->eth_dst, eth_dst, ETH_ADDR_LEN);
 238     memcpy(eth->eth_src, eth_src, ETH_ADDR_LEN);
 239     eth->eth_type = htons(eth_type);
 240
 241     return data;
 242 }
 243
 244 /* Populates 'b' with an Ethernet LLC+SNAP packet headed with the given
 245  * 'eth_dst', 'eth_src', 'snap_org', and 'snap_type'.  A payload of 'size'
 246  * bytes is allocated in 'b' and returned.  This payload may be populated with
 247  * appropriate information by the caller.
 248  *
 249  * The returned packet has enough headroom to insert an 802.1Q VLAN header if
 250  * desired. */
 251 void *
 252 snap_compose(struct ofpbuf *b, const uint8_t eth_dst[ETH_ADDR_LEN],
 253              const uint8_t eth_src[ETH_ADDR_LEN],
 254              unsigned int oui, uint16_t snap_type, size_t size)
 255 {
 256     struct eth_header *eth;
 257     struct llc_snap_header *llc_snap;
 258     void *payload;
 259
 260     /* Compose basic packet structure.  (We need the payload size to stick into
 261      * the 802.2 header.) */
 262     ofpbuf_clear(b);
 263     ofpbuf_prealloc_tailroom(b, ETH_HEADER_LEN + VLAN_HEADER_LEN
 264                              + LLC_SNAP_HEADER_LEN + size);
 265     ofpbuf_reserve(b, VLAN_HEADER_LEN);
 266     eth = ofpbuf_put_zeros(b, ETH_HEADER_LEN);
 267     llc_snap = ofpbuf_put_zeros(b, LLC_SNAP_HEADER_LEN);
 268     payload = ofpbuf_put_uninit(b, size);
 269
 270     /* Compose 802.2 header. */
 271     memcpy(eth->eth_dst, eth_dst, ETH_ADDR_LEN);
 272     memcpy(eth->eth_src, eth_src, ETH_ADDR_LEN);
 273     eth->eth_type = htons(b->size - ETH_HEADER_LEN);
 274
 275     /* Compose LLC, SNAP headers. */
 276     llc_snap->llc.llc_dsap = LLC_DSAP_SNAP;
 277     llc_snap->llc.llc_ssap = LLC_SSAP_SNAP;
 278     llc_snap->llc.llc_cntl = LLC_CNTL_SNAP;
 279     llc_snap->snap.snap_org[0] = oui >> 16;
 280     llc_snap->snap.snap_org[1] = oui >> 8;
 281     llc_snap->snap.snap_org[2] = oui;
 282     llc_snap->snap.snap_type = htons(snap_type);
 283
 284     return payload;
 285 }