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