lib/flow.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33 #include <config.h>
  34 #include <sys/types.h>
  35 #include "flow.h"
  36 #include <inttypes.h>
  37 #include <netinet/in.h>
  38 #include <string.h>
  39 #include "hash.h"
  40 #include "ofpbuf.h"
  41 #include "openflow/openflow.h"
  42 #include "packets.h"
  43
  44 #include "vlog.h"
  45 #define THIS_MODULE VLM_flow
  46
  47 static struct ip_header *
  48 pull_ip(struct ofpbuf *packet)
  49 {
  50     if (packet->size >= IP_HEADER_LEN) {
  51         struct ip_header *ip = packet->data;
  52         int ip_len = IP_IHL(ip->ip_ihl_ver) * 4;
  53         if (ip_len >= IP_HEADER_LEN && packet->size >= ip_len) {
  54             return ofpbuf_pull(packet, ip_len);
  55         }
  56     }
  57     return NULL;
  58 }
  59
  60 static struct tcp_header *
  61 pull_tcp(struct ofpbuf *packet)
  62 {
  63     if (packet->size >= TCP_HEADER_LEN) {
  64         struct tcp_header *tcp = packet->data;
  65         int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
  66         if (tcp_len >= TCP_HEADER_LEN && packet->size >= tcp_len) {
  67             return ofpbuf_pull(packet, tcp_len);
  68         }
  69     }
  70     return NULL;
  71 }
  72
  73 static struct udp_header *
  74 pull_udp(struct ofpbuf *packet)
  75 {
  76     return ofpbuf_try_pull(packet, UDP_HEADER_LEN);
  77 }
  78
  79 static struct eth_header *
  80 pull_eth(struct ofpbuf *packet)
  81 {
  82     return ofpbuf_try_pull(packet, ETH_HEADER_LEN);
  83 }
  84
  85 static struct vlan_header *
  86 pull_vlan(struct ofpbuf *packet)
  87 {
  88     return ofpbuf_try_pull(packet, VLAN_HEADER_LEN);
  89 }
  90
  91 /* Returns 1 if 'packet' is an IP fragment, 0 otherwise. */
  92 int
  93 flow_extract(struct ofpbuf *packet, uint16_t in_port, struct flow *flow)
  94 {
  95     struct ofpbuf b = *packet;
  96     struct eth_header *eth;
  97     int retval = 0;
  98
  99     if (b.size < ETH_TOTAL_MIN) {
 100         /* This message is not too useful since there are various ways that we
 101          * can end up with runt frames, e.g. frames that only ever passed
 102          * through virtual network devices and never touched a physical
 103          * Ethernet. */
 104         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 60);
 105         VLOG_DBG_RL(&rl, "packet length %zu less than minimum size %d",
 106                     b.size, ETH_TOTAL_MIN);
 107     }
 108
 109     memset(flow, 0, sizeof *flow);
 110     flow->dl_vlan = htons(OFP_VLAN_NONE);
 111     flow->in_port = htons(in_port);
 112
 113     packet->l2 = b.data;
 114     packet->l3 = NULL;
 115     packet->l4 = NULL;
 116     packet->l7 = NULL;
 117
 118     eth = pull_eth(&b);
 119     if (eth) {
 120         if (ntohs(eth->eth_type) >= OFP_DL_TYPE_ETH2_CUTOFF) {
 121             /* This is an Ethernet II frame */
 122             flow->dl_type = eth->eth_type;
 123         } else {
 124             /* This is an 802.2 frame */
 125             struct llc_snap_header *h = ofpbuf_at(&b, 0, sizeof *h);
 126             if (h == NULL) {
 127                 return 0;
 128             }
 129             if (h->llc.llc_dsap == LLC_DSAP_SNAP
 130                 && h->llc.llc_ssap == LLC_SSAP_SNAP
 131                 && h->llc.llc_cntl == LLC_CNTL_SNAP
 132                 && !memcmp(h->snap.snap_org, SNAP_ORG_ETHERNET,
 133                            sizeof h->snap.snap_org)) {
 134                 flow->dl_type = h->snap.snap_type;
 135                 ofpbuf_pull(&b, sizeof *h);
 136             } else {
 137                 flow->dl_type = htons(OFP_DL_TYPE_NOT_ETH_TYPE);
 138                 ofpbuf_pull(&b, sizeof(struct llc_header));
 139             }
 140         }
 141
 142         /* Check for a VLAN tag */
 143         if (flow->dl_type == htons(ETH_TYPE_VLAN)) {
 144             struct vlan_header *vh = pull_vlan(&b);
 145             if (vh) {
 146                 flow->dl_type = vh->vlan_next_type;
 147                 flow->dl_vlan = vh->vlan_tci & htons(VLAN_VID_MASK);
 148             }
 149         }
 150         memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
 151         memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
 152
 153         packet->l3 = b.data;
 154         if (flow->dl_type == htons(ETH_TYPE_IP)) {
 155             const struct ip_header *nh = pull_ip(&b);
 156             if (nh) {
 157                 flow->nw_src = nh->ip_src;
 158                 flow->nw_dst = nh->ip_dst;
 159                 flow->nw_proto = nh->ip_proto;
 160                 packet->l4 = b.data;
 161                 if (!IP_IS_FRAGMENT(nh->ip_frag_off)) {
 162                     if (flow->nw_proto == IP_TYPE_TCP) {
 163                         const struct tcp_header *tcp = pull_tcp(&b);
 164                         if (tcp) {
 165                             flow->tp_src = tcp->tcp_src;
 166                             flow->tp_dst = tcp->tcp_dst;
 167                             packet->l7 = b.data;
 168                         } else {
 169                             /* Avoid tricking other code into thinking that
 170                              * this packet has an L4 header. */
 171                             flow->nw_proto = 0;
 172                         }
 173                     } else if (flow->nw_proto == IP_TYPE_UDP) {
 174                         const struct udp_header *udp = pull_udp(&b);
 175                         if (udp) {
 176                             flow->tp_src = udp->udp_src;
 177                             flow->tp_dst = udp->udp_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                     }
 185                 } else {
 186                     retval = 1;
 187                 }
 188             }
 189         }
 190     }
 191     return retval;
 192 }
 193
 194 void
 195 flow_print(FILE *stream, const struct flow *flow)
 196 {
 197     fprintf(stream,
 198             "port%04x:vlan%04x mac"ETH_ADDR_FMT"->"ETH_ADDR_FMT" "
 199             "proto%04x ip"IP_FMT"->"IP_FMT" port%d->%d",
 200             ntohs(flow->in_port), ntohs(flow->dl_vlan),
 201             ETH_ADDR_ARGS(flow->dl_src), ETH_ADDR_ARGS(flow->dl_dst),
 202             ntohs(flow->dl_type),
 203             IP_ARGS(&flow->nw_src), IP_ARGS(&flow->nw_dst),
 204             ntohs(flow->tp_src), ntohs(flow->tp_dst));
 205 }
 206
 207 int
 208 flow_compare(const struct flow *a, const struct flow *b)
 209 {
 210     return memcmp(a, b, sizeof *a);
 211 }
 212
 213 unsigned long int
 214 flow_hash(const struct flow *flow, uint32_t basis)
 215 {
 216     return hash_fnv(flow, sizeof *flow, basis);
 217 }