switch/switch-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
  34 #include "switch-flow.h"
  35 #include <arpa/inet.h>
  36 #include <assert.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include "buffer.h"
  40 #include "openflow.h"
  41 #include "packets.h"
  42
  43 /* Internal function used to compare fields in flow. */
  44 static inline
  45 int flow_fields_match(const struct flow *a, const struct flow *b, uint16_t w)
  46 {
  47     return ((w & OFPFW_IN_PORT || a->in_port == b->in_port)
  48             && (w & OFPFW_DL_VLAN || a->dl_vlan == b->dl_vlan)
  49             && (w & OFPFW_DL_SRC || !memcmp(a->dl_src, b->dl_src, ETH_ADDR_LEN))
  50             && (w & OFPFW_DL_DST || !memcmp(a->dl_dst, b->dl_dst, ETH_ADDR_LEN))
  51             && (w & OFPFW_DL_TYPE || a->dl_type == b->dl_type)
  52             && (w & OFPFW_NW_SRC || a->nw_src == b->nw_src)
  53             && (w & OFPFW_NW_DST || a->nw_dst == b->nw_dst)
  54             && (w & OFPFW_NW_PROTO || a->nw_proto == b->nw_proto)
  55             && (w & OFPFW_TP_SRC || a->tp_src == b->tp_src)
  56             && (w & OFPFW_TP_DST || a->tp_dst == b->tp_dst));
  57 }
  58
  59 /* Returns nonzero if 'a' and 'b' match, that is, if their fields are equal
  60  * modulo wildcards, zero otherwise. */
  61 inline
  62 int flow_matches(const struct sw_flow_key *a, const struct sw_flow_key *b)
  63 {
  64     return flow_fields_match(&a->flow, &b->flow, a->wildcards | b->wildcards);
  65 }
  66
  67 /* Returns nonzero if 't' (the table entry's key) and 'd' (the key
  68  * describing the deletion) match, that is, if their fields are
  69  * equal modulo wildcards, zero otherwise.  If 'strict' is nonzero, the
  70  * wildcards must match in both 't_key' and 'd_key'.  Note that the
  71  * table's wildcards are ignored unless 'strict' is set. */
  72 inline
  73 int flow_del_matches(const struct sw_flow_key *t, const struct sw_flow_key *d, int strict)
  74 {
  75     if (strict && t->wildcards != d->wildcards)
  76         return 0;
  77
  78     return flow_fields_match(&t->flow, &d->flow, d->wildcards);
  79 }
  80
  81 void flow_extract_match(struct sw_flow_key* to, const struct ofp_match* from)
  82 {
  83     to->wildcards = ntohs(from->wildcards) & OFPFW_ALL;
  84     to->flow.reserved = 0;
  85     to->flow.in_port = from->in_port;
  86     to->flow.dl_vlan = from->dl_vlan;
  87     memcpy(to->flow.dl_src, from->dl_src, ETH_ADDR_LEN);
  88     memcpy(to->flow.dl_dst, from->dl_dst, ETH_ADDR_LEN);
  89     to->flow.dl_type = from->dl_type;
  90
  91     to->flow.nw_src = to->flow.nw_dst = to->flow.nw_proto = 0;
  92     to->flow.tp_src = to->flow.tp_dst = 0;
  93
  94 #define OFPFW_TP (OFPFW_TP_SRC | OFPFW_TP_DST)
  95 #define OFPFW_NW (OFPFW_NW_SRC | OFPFW_NW_DST | OFPFW_NW_PROTO)
  96     if (to->wildcards & OFPFW_DL_TYPE) {
  97         /* Can't sensibly match on network or transport headers if the
  98          * data link type is unknown. */
  99         to->wildcards |= OFPFW_NW | OFPFW_TP;
 100     } else if (from->dl_type == htons(ETH_TYPE_IP)) {
 101         to->flow.nw_src   = from->nw_src;
 102         to->flow.nw_dst   = from->nw_dst;
 103         to->flow.nw_proto = from->nw_proto;
 104
 105         if (to->wildcards & OFPFW_NW_PROTO) {
 106             /* Can't sensibly match on transport headers if the network
 107              * protocol is unknown. */
 108             to->wildcards |= OFPFW_TP;
 109         } else if (from->nw_proto == IPPROTO_TCP
 110                 || from->nw_proto == IPPROTO_UDP) {
 111             to->flow.tp_src = from->tp_src;
 112             to->flow.tp_dst = from->tp_dst;
 113         } else {
 114             /* Transport layer fields are undefined.  Mark them as
 115              * exact-match to allow such flows to reside in table-hash,
 116              * instead of falling into table-linear. */
 117             to->wildcards &= ~OFPFW_TP;
 118         }
 119     } else {
 120         /* Network and transport layer fields are undefined.  Mark them
 121          * as exact-match to allow such flows to reside in table-hash,
 122          * instead of falling into table-linear. */
 123         to->wildcards &= ~(OFPFW_NW | OFPFW_TP);
 124     }
 125 }
 126
 127 void flow_fill_match(struct ofp_match* to, const struct sw_flow_key* from)
 128 {
 129     to->wildcards = htons(from->wildcards);
 130     to->in_port   = from->flow.in_port;
 131     to->dl_vlan   = from->flow.dl_vlan;
 132     memcpy(to->dl_src, from->flow.dl_src, ETH_ADDR_LEN);
 133     memcpy(to->dl_dst, from->flow.dl_dst, ETH_ADDR_LEN);
 134     to->dl_type   = from->flow.dl_type;
 135     to->nw_src        = from->flow.nw_src;
 136     to->nw_dst        = from->flow.nw_dst;
 137     to->nw_proto  = from->flow.nw_proto;
 138     to->tp_src        = from->flow.tp_src;
 139     to->tp_dst        = from->flow.tp_dst;
 140     memset(to->pad, '\0', sizeof(to->pad));
 141 }
 142
 143 /* Allocates and returns a new flow with 'n_actions' action, using allocation
 144  * flags 'flags'.  Returns the new flow or a null pointer on failure. */
 145 struct sw_flow *flow_alloc(int n_actions)
 146 {
 147     struct sw_flow *flow = malloc(sizeof *flow);
 148     if (!flow)
 149         return NULL;
 150
 151     flow->n_actions = n_actions;
 152     flow->actions = malloc(n_actions * sizeof *flow->actions);
 153     if (!flow->actions && n_actions > 0) {
 154         free(flow);
 155         return NULL;
 156     }
 157     return flow;
 158 }
 159
 160 /* Frees 'flow' immediately. */
 161 void flow_free(struct sw_flow *flow)
 162 {
 163     if (!flow) {
 164         return;
 165     }
 166     free(flow->actions);
 167     free(flow);
 168 }
 169
 170 /* Prints a representation of 'key' to the kernel log. */
 171 void print_flow(const struct sw_flow_key *key)
 172 {
 173     const struct flow *f = &key->flow;
 174     printf("wild%04x port%04x:vlan%04x mac%02x:%02x:%02x:%02x:%02x:%02x"
 175            "->%02x:%02x:%02x:%02x:%02x:%02x "
 176            "proto%04x ip%u.%u.%u.%u->%u.%u.%u.%u port%d->%d\n",
 177            key->wildcards, ntohs(f->in_port), ntohs(f->dl_vlan),
 178            f->dl_src[0], f->dl_src[1], f->dl_src[2],
 179            f->dl_src[3], f->dl_src[4], f->dl_src[5],
 180            f->dl_dst[0], f->dl_dst[1], f->dl_dst[2],
 181            f->dl_dst[3], f->dl_dst[4], f->dl_dst[5],
 182            ntohs(f->dl_type),
 183            ((unsigned char *)&f->nw_src)[0],
 184            ((unsigned char *)&f->nw_src)[1],
 185            ((unsigned char *)&f->nw_src)[2],
 186            ((unsigned char *)&f->nw_src)[3],
 187            ((unsigned char *)&f->nw_dst)[0],
 188            ((unsigned char *)&f->nw_dst)[1],
 189            ((unsigned char *)&f->nw_dst)[2],
 190            ((unsigned char *)&f->nw_dst)[3],
 191            ntohs(f->tp_src), ntohs(f->tp_dst));
 192 }
 193
 194 int flow_timeout(struct sw_flow *flow)
 195 {
 196     if (flow->max_idle == OFP_FLOW_PERMANENT)
 197         return 0;
 198
 199     /* FIXME */
 200     return time(0) > flow->timeout;
 201 }
 202
 203 void flow_used(struct sw_flow *flow, struct buffer *buffer)
 204 {
 205     if (flow->max_idle != OFP_FLOW_PERMANENT)
 206         flow->timeout = time(0) + flow->max_idle;
 207
 208     flow->packet_count++;
 209     flow->byte_count += buffer->size;
 210 }