switch/table-linear.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 <config.h>
  35 #include "table.h"
  36 #include <stdlib.h>
  37 #include "flow.h"
  38 #include "list.h"
  39 #include "openflow/openflow.h"
  40 #include "switch-flow.h"
  41 #include "datapath.h"
  42
  43 struct sw_table_linear {
  44     struct sw_table swt;
  45
  46     unsigned int max_flows;
  47     unsigned int n_flows;
  48     struct list flows;
  49     struct list iter_flows;
  50     unsigned long int next_serial;
  51 };
  52
  53 static struct sw_flow *table_linear_lookup(struct sw_table *swt,
  54                                            const struct sw_flow_key *key)
  55 {
  56     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
  57     struct sw_flow *flow;
  58     LIST_FOR_EACH (flow, struct sw_flow, node, &tl->flows) {
  59         if (flow_matches_1wild(key, &flow->key))
  60             return flow;
  61     }
  62     return NULL;
  63 }
  64
  65 static int table_linear_insert(struct sw_table *swt, struct sw_flow *flow)
  66 {
  67     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
  68     struct sw_flow *f;
  69
  70     /* Loop through the existing list of entries.  New entries will
  71      * always be placed behind those with equal priority.  Just replace
  72      * any flows that match exactly.
  73      */
  74     LIST_FOR_EACH (f, struct sw_flow, node, &tl->flows) {
  75         if (f->priority == flow->priority
  76                 && f->key.wildcards == flow->key.wildcards
  77                 && flow_matches_2wild(&f->key, &flow->key)) {
  78             flow->serial = f->serial;
  79             list_replace(&flow->node, &f->node);
  80             list_replace(&flow->iter_node, &f->iter_node);
  81             flow_free(f);
  82             return 1;
  83         }
  84
  85         if (f->priority < flow->priority)
  86             break;
  87     }
  88
  89     /* Make sure there's room in the table. */
  90     if (tl->n_flows >= tl->max_flows) {
  91         return 0;
  92     }
  93     tl->n_flows++;
  94
  95     /* Insert the entry immediately in front of where we're pointing. */
  96     flow->serial = tl->next_serial++;
  97     list_insert(&f->node, &flow->node);
  98     list_push_front(&tl->iter_flows, &flow->iter_node);
  99
 100     return 1;
 101 }
 102
 103 static int table_linear_modify(struct sw_table *swt,
 104                 const struct sw_flow_key *key, uint16_t priority, int strict,
 105                 const struct ofp_action_header *actions, size_t actions_len)
 106 {
 107     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
 108     struct sw_flow *flow;
 109     unsigned int count = 0;
 110
 111     LIST_FOR_EACH (flow, struct sw_flow, node, &tl->flows) {
 112         if (flow_matches_desc(&flow->key, key, strict)
 113                 && (!strict || (flow->priority == priority))) {
 114             flow_replace_acts(flow, actions, actions_len);
 115             count++;
 116         }
 117     }
 118     return count;
 119 }
 120
 121 static void
 122 do_delete(struct sw_flow *flow)
 123 {
 124     list_remove(&flow->node);
 125     list_remove(&flow->iter_node);
 126     flow_free(flow);
 127 }
 128
 129 static int table_linear_delete(struct sw_table *swt,
 130                                const struct sw_flow_key *key,
 131                                uint16_t out_port,
 132                                uint16_t priority, int strict)
 133 {
 134     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
 135     struct sw_flow *flow, *n;
 136     unsigned int count = 0;
 137
 138     LIST_FOR_EACH_SAFE (flow, n, struct sw_flow, node, &tl->flows) {
 139         if (flow_matches_desc(&flow->key, key, strict)
 140                 && flow_has_out_port(flow, out_port)
 141                 && (!strict || (flow->priority == priority))) {
 142             do_delete(flow);
 143             count++;
 144         }
 145     }
 146     tl->n_flows -= count;
 147     return count;
 148 }
 149
 150 static void table_linear_timeout(struct sw_table *swt, struct list *deleted)
 151 {
 152     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
 153     struct sw_flow *flow, *n;
 154
 155     LIST_FOR_EACH_SAFE (flow, n, struct sw_flow, node, &tl->flows) {
 156         if (flow_timeout(flow)) {
 157             list_remove(&flow->node);
 158             list_remove(&flow->iter_node);
 159             list_push_back(deleted, &flow->node);
 160             tl->n_flows--;
 161         }
 162     }
 163 }
 164
 165 static void table_linear_destroy(struct sw_table *swt)
 166 {
 167     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
 168
 169     while (!list_is_empty(&tl->flows)) {
 170         struct sw_flow *flow = CONTAINER_OF(list_front(&tl->flows),
 171                                             struct sw_flow, node);
 172         list_remove(&flow->node);
 173         flow_free(flow);
 174     }
 175     free(tl);
 176 }
 177
 178 static int table_linear_iterate(struct sw_table *swt,
 179                                 const struct sw_flow_key *key,
 180                                 uint16_t out_port,
 181                                 struct sw_table_position *position,
 182                                 int (*callback)(struct sw_flow *, void *),
 183                                 void *private)
 184 {
 185     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
 186     struct sw_flow *flow;
 187     unsigned long start;
 188
 189     start = ~position->private[0];
 190     LIST_FOR_EACH (flow, struct sw_flow, iter_node, &tl->iter_flows) {
 191         if (flow->serial <= start
 192                 && flow_matches_2wild(key, &flow->key)
 193                 && flow_has_out_port(flow, out_port)) {
 194             int error = callback(flow, private);
 195             if (error) {
 196                 position->private[0] = ~(flow->serial - 1);
 197                 return error;
 198             }
 199         }
 200     }
 201     return 0;
 202 }
 203
 204 static void table_linear_stats(struct sw_table *swt,
 205                                struct sw_table_stats *stats)
 206 {
 207     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
 208     stats->name = "linear";
 209     stats->wildcards = OFPFW_ALL;
 210     stats->n_flows   = tl->n_flows;
 211     stats->max_flows = tl->max_flows;
 212     stats->n_lookup  = swt->n_lookup;
 213     stats->n_matched = swt->n_matched;
 214 }
 215
 216
 217 struct sw_table *table_linear_create(unsigned int max_flows)
 218 {
 219     struct sw_table_linear *tl;
 220     struct sw_table *swt;
 221
 222     tl = calloc(1, sizeof *tl);
 223     if (tl == NULL)
 224         return NULL;
 225
 226     swt = &tl->swt;
 227     swt->lookup = table_linear_lookup;
 228     swt->insert = table_linear_insert;
 229     swt->modify = table_linear_modify;
 230     swt->delete = table_linear_delete;
 231     swt->timeout = table_linear_timeout;
 232     swt->destroy = table_linear_destroy;
 233     swt->iterate = table_linear_iterate;
 234     swt->stats = table_linear_stats;
 235
 236     tl->max_flows = max_flows;
 237     tl->n_flows = 0;
 238     list_init(&tl->flows);
 239     list_init(&tl->iter_flows);
 240     tl->next_serial = 0;
 241
 242     return swt;
 243 }