lib/flow.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 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 #include <config.h>
  17 #include <sys/types.h>
  18 #include "flow.h"
  19 #include <inttypes.h>
  20 #include <netinet/in.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include "coverage.h"
  24 #include "dynamic-string.h"
  25 #include "hash.h"
  26 #include "ofpbuf.h"
  27 #include "openflow/openflow.h"
  28 #include "openvswitch/datapath-protocol.h"
  29 #include "packets.h"
  30 #include "unaligned.h"
  31 #include "vlog.h"
  32 #include "xtoxll.h"
  33
  34 VLOG_DEFINE_THIS_MODULE(flow)
  35
  36 static struct arp_eth_header *
  37 pull_arp(struct ofpbuf *packet)
  38 {
  39     return ofpbuf_try_pull(packet, ARP_ETH_HEADER_LEN);
  40 }
  41
  42 static struct ip_header *
  43 pull_ip(struct ofpbuf *packet)
  44 {
  45     if (packet->size >= IP_HEADER_LEN) {
  46         struct ip_header *ip = packet->data;
  47         int ip_len = IP_IHL(ip->ip_ihl_ver) * 4;
  48         if (ip_len >= IP_HEADER_LEN && packet->size >= ip_len) {
  49             return ofpbuf_pull(packet, ip_len);
  50         }
  51     }
  52     return NULL;
  53 }
  54
  55 static struct tcp_header *
  56 pull_tcp(struct ofpbuf *packet)
  57 {
  58     if (packet->size >= TCP_HEADER_LEN) {
  59         struct tcp_header *tcp = packet->data;
  60         int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
  61         if (tcp_len >= TCP_HEADER_LEN && packet->size >= tcp_len) {
  62             return ofpbuf_pull(packet, tcp_len);
  63         }
  64     }
  65     return NULL;
  66 }
  67
  68 static struct udp_header *
  69 pull_udp(struct ofpbuf *packet)
  70 {
  71     return ofpbuf_try_pull(packet, UDP_HEADER_LEN);
  72 }
  73
  74 static struct icmp_header *
  75 pull_icmp(struct ofpbuf *packet)
  76 {
  77     return ofpbuf_try_pull(packet, ICMP_HEADER_LEN);
  78 }
  79
  80 static void
  81 parse_vlan(struct ofpbuf *b, flow_t *flow)
  82 {
  83     struct qtag_prefix {
  84         uint16_t eth_type;      /* ETH_TYPE_VLAN */
  85         uint16_t tci;
  86     };
  87
  88     if (b->size >= sizeof(struct qtag_prefix) + sizeof(uint16_t)) {
  89         struct qtag_prefix *qp = ofpbuf_pull(b, sizeof *qp);
  90         flow->dl_vlan = qp->tci & htons(VLAN_VID_MASK);
  91         flow->dl_vlan_pcp = (ntohs(qp->tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
  92     }
  93 }
  94
  95 static uint16_t
  96 parse_ethertype(struct ofpbuf *b)
  97 {
  98     struct llc_snap_header *llc;
  99     uint16_t proto;
 100
 101     proto = *(uint16_t *) ofpbuf_pull(b, sizeof proto);
 102     if (ntohs(proto) >= ODP_DL_TYPE_ETH2_CUTOFF) {
 103         return proto;
 104     }
 105
 106     if (b->size < sizeof *llc) {
 107         return htons(ODP_DL_TYPE_NOT_ETH_TYPE);
 108     }
 109
 110     llc = b->data;
 111     if (llc->llc.llc_dsap != LLC_DSAP_SNAP
 112         || llc->llc.llc_ssap != LLC_SSAP_SNAP
 113         || llc->llc.llc_cntl != LLC_CNTL_SNAP
 114         || memcmp(llc->snap.snap_org, SNAP_ORG_ETHERNET,
 115                   sizeof llc->snap.snap_org)) {
 116         return htons(ODP_DL_TYPE_NOT_ETH_TYPE);
 117     }
 118
 119     ofpbuf_pull(b, sizeof *llc);
 120     return llc->snap.snap_type;
 121 }
 122
 123 /* Returns 1 if 'packet' is an IP fragment, 0 otherwise.
 124  * 'tun_id' is in network byte order, while 'in_port' is in host byte order.
 125  * These byte orders are the same as they are in struct odp_flow_key. */
 126 int
 127 flow_extract(struct ofpbuf *packet, uint32_t tun_id, uint16_t in_port,
 128              flow_t *flow)
 129 {
 130     struct ofpbuf b = *packet;
 131     struct eth_header *eth;
 132     int retval = 0;
 133
 134     COVERAGE_INC(flow_extract);
 135
 136     memset(flow, 0, sizeof *flow);
 137     flow->tun_id = tun_id;
 138     flow->in_port = in_port;
 139     flow->dl_vlan = htons(OFP_VLAN_NONE);
 140
 141     packet->l2 = b.data;
 142     packet->l3 = NULL;
 143     packet->l4 = NULL;
 144     packet->l7 = NULL;
 145
 146     if (b.size < sizeof *eth) {
 147         return 0;
 148     }
 149
 150     /* Link layer. */
 151     eth = b.data;
 152     memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
 153     memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
 154
 155     /* dl_type, dl_vlan, dl_vlan_pcp. */
 156     ofpbuf_pull(&b, ETH_ADDR_LEN * 2);
 157     if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
 158         parse_vlan(&b, flow);
 159     }
 160     flow->dl_type = parse_ethertype(&b);
 161
 162     /* Network layer. */
 163     packet->l3 = b.data;
 164     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 165         const struct ip_header *nh = pull_ip(&b);
 166         if (nh) {
 167             flow->nw_src = get_unaligned_u32(&nh->ip_src);
 168             flow->nw_dst = get_unaligned_u32(&nh->ip_dst);
 169             flow->nw_tos = nh->ip_tos & IP_DSCP_MASK;
 170             flow->nw_proto = nh->ip_proto;
 171             packet->l4 = b.data;
 172             if (!IP_IS_FRAGMENT(nh->ip_frag_off)) {
 173                 if (flow->nw_proto == IP_TYPE_TCP) {
 174                     const struct tcp_header *tcp = pull_tcp(&b);
 175                     if (tcp) {
 176                         flow->tp_src = tcp->tcp_src;
 177                         flow->tp_dst = tcp->tcp_dst;
 178                         packet->l7 = b.data;
 179                     } else {
 180                         /* Avoid tricking other code into thinking that
 181                          * this packet has an L4 header. */
 182                         flow->nw_proto = 0;
 183                     }
 184                 } else if (flow->nw_proto == IP_TYPE_UDP) {
 185                     const struct udp_header *udp = pull_udp(&b);
 186                     if (udp) {
 187                         flow->tp_src = udp->udp_src;
 188                         flow->tp_dst = udp->udp_dst;
 189                         packet->l7 = b.data;
 190                     } else {
 191                         /* Avoid tricking other code into thinking that
 192                          * this packet has an L4 header. */
 193                         flow->nw_proto = 0;
 194                     }
 195                 } else if (flow->nw_proto == IP_TYPE_ICMP) {
 196                     const struct icmp_header *icmp = pull_icmp(&b);
 197                     if (icmp) {
 198                         flow->icmp_type = htons(icmp->icmp_type);
 199                         flow->icmp_code = htons(icmp->icmp_code);
 200                         packet->l7 = b.data;
 201                     } else {
 202                         /* Avoid tricking other code into thinking that
 203                          * this packet has an L4 header. */
 204                         flow->nw_proto = 0;
 205                     }
 206                 }
 207             } else {
 208                 retval = 1;
 209             }
 210         }
 211     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
 212         const struct arp_eth_header *arp = pull_arp(&b);
 213         if (arp && arp->ar_hrd == htons(1)
 214             && arp->ar_pro == htons(ETH_TYPE_IP)
 215             && arp->ar_hln == ETH_ADDR_LEN
 216             && arp->ar_pln == 4) {
 217             /* We only match on the lower 8 bits of the opcode. */
 218             if (ntohs(arp->ar_op) <= 0xff) {
 219                 flow->nw_proto = ntohs(arp->ar_op);
 220             }
 221
 222             if ((flow->nw_proto == ARP_OP_REQUEST)
 223                 || (flow->nw_proto == ARP_OP_REPLY)) {
 224                 flow->nw_src = arp->ar_spa;
 225                 flow->nw_dst = arp->ar_tpa;
 226             }
 227         }
 228     }
 229     return retval;
 230 }
 231
 232 /* Extracts the flow stats for a packet.  The 'flow' and 'packet'
 233  * arguments must have been initialized through a call to flow_extract().
 234  */
 235 void
 236 flow_extract_stats(const flow_t *flow, struct ofpbuf *packet,
 237         struct odp_flow_stats *stats)
 238 {
 239     memset(stats, '\0', sizeof(*stats));
 240
 241     if ((flow->dl_type == htons(ETH_TYPE_IP)) && packet->l4) {
 242         if ((flow->nw_proto == IP_TYPE_TCP) && packet->l7) {
 243             struct tcp_header *tcp = packet->l4;
 244             stats->tcp_flags = TCP_FLAGS(tcp->tcp_ctl);
 245         }
 246     }
 247
 248     stats->n_bytes = packet->size;
 249     stats->n_packets = 1;
 250 }
 251
 252 /* Extract 'flow' with 'wildcards' into the OpenFlow match structure
 253  * 'match'. */
 254 void
 255 flow_to_match(const flow_t *flow, uint32_t wildcards, bool tun_id_from_cookie,
 256               struct ofp_match *match)
 257 {
 258     if (!tun_id_from_cookie) {
 259         wildcards &= OFPFW_ALL;
 260     }
 261     match->wildcards = htonl(wildcards);
 262
 263     match->in_port = htons(flow->in_port == ODPP_LOCAL ? OFPP_LOCAL
 264                            : flow->in_port);
 265     match->dl_vlan = flow->dl_vlan;
 266     match->dl_vlan_pcp = flow->dl_vlan_pcp;
 267     memcpy(match->dl_src, flow->dl_src, ETH_ADDR_LEN);
 268     memcpy(match->dl_dst, flow->dl_dst, ETH_ADDR_LEN);
 269     match->dl_type = flow->dl_type;
 270     match->nw_src = flow->nw_src;
 271     match->nw_dst = flow->nw_dst;
 272     match->nw_tos = flow->nw_tos;
 273     match->nw_proto = flow->nw_proto;
 274     match->tp_src = flow->tp_src;
 275     match->tp_dst = flow->tp_dst;
 276     memset(match->pad1, '\0', sizeof match->pad1);
 277     memset(match->pad2, '\0', sizeof match->pad2);
 278 }
 279
 280 void
 281 flow_from_match(const struct ofp_match *match, bool tun_id_from_cookie,
 282                 uint64_t cookie, flow_t *flow, uint32_t *flow_wildcards)
 283 {
 284         uint32_t wildcards = ntohl(match->wildcards);
 285
 286     flow->nw_src = match->nw_src;
 287     flow->nw_dst = match->nw_dst;
 288     if (tun_id_from_cookie && !(wildcards & NXFW_TUN_ID)) {
 289         flow->tun_id = htonl(ntohll(cookie) >> 32);
 290     } else {
 291         wildcards |= NXFW_TUN_ID;
 292         flow->tun_id = 0;
 293     }
 294     flow->in_port = (match->in_port == htons(OFPP_LOCAL) ? ODPP_LOCAL
 295                      : ntohs(match->in_port));
 296     flow->dl_vlan = match->dl_vlan;
 297     flow->dl_vlan_pcp = match->dl_vlan_pcp;
 298     flow->dl_type = match->dl_type;
 299     flow->tp_src = match->tp_src;
 300     flow->tp_dst = match->tp_dst;
 301     memcpy(flow->dl_src, match->dl_src, ETH_ADDR_LEN);
 302     memcpy(flow->dl_dst, match->dl_dst, ETH_ADDR_LEN);
 303     flow->nw_tos = match->nw_tos;
 304     flow->nw_proto = match->nw_proto;
 305     memset(flow->reserved, 0, sizeof flow->reserved);
 306
 307     if (flow_wildcards) {
 308         *flow_wildcards = wildcards;
 309     }
 310 }
 311
 312 char *
 313 flow_to_string(const flow_t *flow)
 314 {
 315     struct ds ds = DS_EMPTY_INITIALIZER;
 316     flow_format(&ds, flow);
 317     return ds_cstr(&ds);
 318 }
 319
 320 void
 321 flow_format(struct ds *ds, const flow_t *flow)
 322 {
 323     ds_put_format(ds, "tunnel%08"PRIx32":in_port%04"PRIx16
 324                       ":vlan%"PRIu16":pcp%"PRIu8
 325                       " mac"ETH_ADDR_FMT"->"ETH_ADDR_FMT
 326                       " type%04"PRIx16
 327                       " proto%"PRIu8
 328                       " tos%"PRIu8
 329                       " ip"IP_FMT"->"IP_FMT
 330                       " port%"PRIu16"->%"PRIu16,
 331                   ntohl(flow->tun_id),
 332                   flow->in_port,
 333                   ntohs(flow->dl_vlan),
 334                   flow->dl_vlan_pcp,
 335                   ETH_ADDR_ARGS(flow->dl_src),
 336                   ETH_ADDR_ARGS(flow->dl_dst),
 337                   ntohs(flow->dl_type),
 338                   flow->nw_proto,
 339                   flow->nw_tos,
 340                   IP_ARGS(&flow->nw_src),
 341                   IP_ARGS(&flow->nw_dst),
 342                   ntohs(flow->tp_src),
 343                   ntohs(flow->tp_dst));
 344 }
 345
 346 void
 347 flow_print(FILE *stream, const flow_t *flow)
 348 {
 349     char *s = flow_to_string(flow);
 350     fputs(s, stream);
 351     free(s);
 352 }