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 "buffer.h"
  40 #include "hash.h"
  41 #include "openflow.h"
  42 #include "packets.h"
  43
  44 #include "vlog.h"
  45 #define THIS_MODULE VLM_flow
  46
  47 struct ip_header *
  48 pull_ip(struct buffer *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 buffer_pull(packet, ip_len);
  55         }
  56     }
  57     return NULL;
  58 }
  59
  60 struct tcp_header *
  61 pull_tcp(struct buffer *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 buffer_pull(packet, tcp_len);
  68         }
  69     }
  70     return NULL;
  71 }
  72
  73 struct udp_header *
  74 pull_udp(struct buffer *packet)
  75 {
  76     return buffer_try_pull(packet, UDP_HEADER_LEN);
  77 }
  78
  79 struct eth_header *
  80 pull_eth(struct buffer *packet)
  81 {
  82     return buffer_try_pull(packet, ETH_HEADER_LEN);
  83 }
  84
  85 void
  86 flow_extract(struct buffer *packet, uint16_t in_port, struct flow *flow)
  87 {
  88     struct buffer b = *packet;
  89     struct eth_header *eth;
  90
  91     if (b.size < ETH_TOTAL_MIN) {
  92         /* This message is not too useful since there are various ways that we
  93          * can end up with runt frames, e.g. frames that only ever passed
  94          * through virtual network devices and never touched a physical
  95          * Ethernet. */
  96         VLOG_DBG("packet length %zu less than minimum size %d",
  97                  b.size, ETH_TOTAL_MIN);
  98     }
  99
 100     memset(flow, 0, sizeof *flow);
 101     flow->in_port = htons(in_port);
 102
 103     packet->l2 = b.data;
 104     packet->l3 = NULL;
 105     packet->l4 = NULL;
 106     packet->l7 = NULL;
 107
 108     eth = pull_eth(&b);
 109     if (eth) {
 110         if (ntohs(eth->eth_type) >= OFP_DL_TYPE_ETH2_CUTOFF) {
 111             /* This is an Ethernet II frame */
 112             flow->dl_type = eth->eth_type;
 113         } else {
 114             /* This is an 802.2 frame */
 115             struct llc_snap_header *h = buffer_at(&b, 0, sizeof *h);
 116             if (h == NULL) {
 117                 return;
 118             }
 119             if (h->llc.llc_dsap == LLC_DSAP_SNAP
 120                 && h->llc.llc_ssap == LLC_SSAP_SNAP
 121                 && h->llc.llc_cntl == LLC_CNTL_SNAP
 122                 && !memcmp(h->snap.snap_org, SNAP_ORG_ETHERNET,
 123                            sizeof h->snap.snap_org)) {
 124                 flow->dl_type = h->snap.snap_type;
 125                 buffer_pull(&b, sizeof *h);
 126             } else {
 127                 flow->dl_type = OFP_DL_TYPE_NOT_ETH_TYPE;
 128                 buffer_pull(&b, sizeof(struct llc_header));
 129             }
 130         }
 131
 132         /* Check for a VLAN tag */
 133         if (flow->dl_type != htons(ETH_TYPE_VLAN)) {
 134             flow->dl_vlan = htons(OFP_VLAN_NONE);
 135         } else {
 136             struct vlan_header *vh = buffer_at(&b, 0, sizeof *vh);
 137             flow->dl_type = vh->vlan_next_type;
 138             flow->dl_vlan = vh->vlan_tci & htons(VLAN_VID);
 139             buffer_pull(&b, sizeof *vh);
 140         }
 141         memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
 142         memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
 143
 144         packet->l3 = b.data;
 145         if (flow->dl_type == htons(ETH_TYPE_IP)) {
 146             const struct ip_header *nh = pull_ip(&b);
 147             if (nh) {
 148                 flow->nw_src = nh->ip_src;
 149                 flow->nw_dst = nh->ip_dst;
 150                 flow->nw_proto = nh->ip_proto;
 151                 packet->l4 = b.data;
 152                 if (flow->nw_proto == IP_TYPE_TCP) {
 153                     const struct tcp_header *tcp = pull_tcp(&b);
 154                     if (tcp) {
 155                         flow->tp_src = tcp->tcp_src;
 156                         flow->tp_dst = tcp->tcp_dst;
 157                         packet->l7 = b.data;
 158                     } else {
 159                         /* Avoid tricking other code into thinking that this
 160                          * packet has an L4 header. */
 161                         flow->nw_proto = 0;
 162                     }
 163                 } else if (flow->nw_proto == IP_TYPE_UDP) {
 164                     const struct udp_header *udp = pull_udp(&b);
 165                     if (udp) {
 166                         flow->tp_src = udp->udp_src;
 167                         flow->tp_dst = udp->udp_dst;
 168                         packet->l7 = b.data;
 169                     } else {
 170                         /* Avoid tricking other code into thinking that this
 171                          * packet has an L4 header. */
 172                         flow->nw_proto = 0;
 173                     }
 174                 }
 175             }
 176         }
 177     }
 178 }
 179
 180 void
 181 flow_print(FILE *stream, const struct flow *flow)
 182 {
 183     fprintf(stream,
 184             "port%04x:vlan%04x mac"ETH_ADDR_FMT"->"ETH_ADDR_FMT" "
 185             "proto%04x ip"IP_FMT"->"IP_FMT" port%d->%d",
 186             ntohs(flow->in_port), ntohs(flow->dl_vlan),
 187             ETH_ADDR_ARGS(flow->dl_src), ETH_ADDR_ARGS(flow->dl_dst),
 188             ntohs(flow->dl_type),
 189             IP_ARGS(&flow->nw_src), IP_ARGS(&flow->nw_dst),
 190             ntohs(flow->tp_src), ntohs(flow->tp_dst));
 191 }
 192
 193 int
 194 flow_compare(const struct flow *a, const struct flow *b)
 195 {
 196     return memcmp(a, b, sizeof *a);
 197 }
 198
 199 unsigned long int
 200 flow_hash(const struct flow *flow, uint32_t basis)
 201 {
 202     return hash_fnv(flow, sizeof *flow, basis);
 203 }