switch/chain.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 "chain.h"
  35 #include <assert.h>
  36 #include <errno.h>
  37 #include <stdlib.h>
  38 #include "switch-flow.h"
  39 #include "table.h"
  40
  41 #define THIS_MODULE VLM_chain
  42 #include "vlog.h"
  43
  44 /* Attempts to append 'table' to the set of tables in 'chain'.  Returns 0 or
  45  * negative error.  If 'table' is null it is assumed that table creation failed
  46  * due to out-of-memory. */
  47 static int add_table(struct sw_chain *chain, struct sw_table *table)
  48 {
  49     if (table == NULL)
  50         return -ENOMEM;
  51     if (chain->n_tables >= CHAIN_MAX_TABLES) {
  52         VLOG_ERR("too many tables in chain\n");
  53         table->destroy(table);
  54         return -ENOBUFS;
  55     }
  56     chain->tables[chain->n_tables++] = table;
  57     return 0;
  58 }
  59
  60 /* Creates and returns a new chain.  Returns NULL if the chain cannot be
  61  * created. */
  62 struct sw_chain *chain_create(void)
  63 {
  64     struct sw_chain *chain = calloc(1, sizeof *chain);
  65     if (chain == NULL)
  66         return NULL;
  67
  68     if (add_table(chain, table_hash2_create(0x1EDC6F41, TABLE_HASH_MAX_FLOWS,
  69                                                0x741B8CD7, TABLE_HASH_MAX_FLOWS))
  70         || add_table(chain, table_linear_create(TABLE_LINEAR_MAX_FLOWS))) {
  71         chain_destroy(chain);
  72         return NULL;
  73     }
  74
  75     return chain;
  76 }
  77
  78 /* Searches 'chain' for a flow matching 'key', which must not have any wildcard
  79  * fields.  Returns the flow if successful, otherwise a null pointer. */
  80 struct sw_flow *
  81 chain_lookup(struct sw_chain *chain, const struct sw_flow_key *key)
  82 {
  83     int i;
  84
  85     assert(!key->wildcards);
  86     for (i = 0; i < chain->n_tables; i++) {
  87         struct sw_table *t = chain->tables[i];
  88         struct sw_flow *flow = t->lookup(t, key);
  89         if (flow)
  90             return flow;
  91     }
  92     return NULL;
  93 }
  94
  95 /* Inserts 'flow' into 'chain', replacing any duplicate flow.  Returns 0 if
  96  * successful or a negative error.
  97  *
  98  * If successful, 'flow' becomes owned by the chain, otherwise it is retained
  99  * by the caller. */
 100 int
 101 chain_insert(struct sw_chain *chain, struct sw_flow *flow)
 102 {
 103     int i;
 104
 105     for (i = 0; i < chain->n_tables; i++) {
 106         struct sw_table *t = chain->tables[i];
 107         if (t->insert(t, flow))
 108             return 0;
 109     }
 110
 111     return -ENOBUFS;
 112 }
 113
 114 /* Deletes from 'chain' any and all flows that match 'key'.  Returns the number
 115  * of flows that were deleted.
 116  *
 117  * Expensive in the general case as currently implemented, since it requires
 118  * iterating through the entire contents of each table for keys that contain
 119  * wildcards.  Relatively cheap for fully specified keys. */
 120 int
 121 chain_delete(struct sw_chain *chain, const struct sw_flow_key *key,
 122              uint16_t priority, int strict)
 123 {
 124     int count = 0;
 125     int i;
 126
 127     for (i = 0; i < chain->n_tables; i++) {
 128         struct sw_table *t = chain->tables[i];
 129         count += t->delete(t, key, priority, strict);
 130     }
 131
 132     return count;
 133
 134 }
 135
 136 /* Deletes timed-out flow entries from all the tables in 'chain' and appends
 137  * the deleted flows to 'deleted'.
 138  *
 139  * Expensive as currently implemented, since it iterates through the entire
 140  * contents of each table. */
 141 void
 142 chain_timeout(struct sw_chain *chain, struct list *deleted)
 143 {
 144     int i;
 145
 146     for (i = 0; i < chain->n_tables; i++) {
 147         struct sw_table *t = chain->tables[i];
 148         t->timeout(t, deleted);
 149     }
 150 }
 151
 152 /* Destroys 'chain', which must not have any users. */
 153 void
 154 chain_destroy(struct sw_chain *chain)
 155 {
 156     int i;
 157
 158     for (i = 0; i < chain->n_tables; i++) {
 159         struct sw_table *t = chain->tables[i];
 160         t->destroy(t);
 161     }
 162     free(chain);
 163 }
 164
 165 /* Prints statistics for each of the tables in 'chain'. */
 166 void
 167 chain_print_stats(struct sw_chain *chain)
 168 {
 169     int i;
 170
 171     printf("\n");
 172     for (i = 0; i < chain->n_tables; i++) {
 173         struct sw_table *t = chain->tables[i];
 174         struct sw_table_stats stats;
 175         t->stats(t, &stats);
 176         printf("%s: %lu/%lu flows\n",
 177                stats.name, stats.n_flows, stats.max_flows);
 178     }
 179 }