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_mac_create(TABLE_MAC_NUM_BUCKETS,
  69                                           TABLE_MAC_MAX_FLOWS))
  70         || add_table(chain, table_hash2_create(0x1EDC6F41, TABLE_HASH_MAX_FLOWS,
  71                                                0x741B8CD7, TABLE_HASH_MAX_FLOWS))
  72         || add_table(chain, table_linear_create(TABLE_LINEAR_MAX_FLOWS))) {
  73         chain_destroy(chain);
  74         return NULL;
  75     }
  76
  77     return chain;
  78 }
  79
  80 /* Searches 'chain' for a flow matching 'key', which must not have any wildcard
  81  * fields.  Returns the flow if successful, otherwise a null pointer. */
  82 struct sw_flow *
  83 chain_lookup(struct sw_chain *chain, const struct sw_flow_key *key)
  84 {
  85     int i;
  86
  87     assert(!key->wildcards);
  88     for (i = 0; i < chain->n_tables; i++) {
  89         struct sw_table *t = chain->tables[i];
  90         struct sw_flow *flow = t->lookup(t, key);
  91         if (flow)
  92             return flow;
  93     }
  94     return NULL;
  95 }
  96
  97 /* Inserts 'flow' into 'chain', replacing any duplicate flow.  Returns 0 if
  98  * successful or a negative error.
  99  *
 100  * If successful, 'flow' becomes owned by the chain, otherwise it is retained
 101  * by the caller. */
 102 int
 103 chain_insert(struct sw_chain *chain, struct sw_flow *flow)
 104 {
 105     int i;
 106
 107     for (i = 0; i < chain->n_tables; i++) {
 108         struct sw_table *t = chain->tables[i];
 109         if (t->insert(t, flow))
 110             return 0;
 111     }
 112
 113     return -ENOBUFS;
 114 }
 115
 116 /* Deletes from 'chain' any and all flows that match 'key'.  Returns the number
 117  * of flows that were deleted.
 118  *
 119  * Expensive in the general case as currently implemented, since it requires
 120  * iterating through the entire contents of each table for keys that contain
 121  * wildcards.  Relatively cheap for fully specified keys. */
 122 int
 123 chain_delete(struct sw_chain *chain, const struct sw_flow_key *key,
 124              uint16_t priority, int strict)
 125 {
 126     int count = 0;
 127     int i;
 128
 129     for (i = 0; i < chain->n_tables; i++) {
 130         struct sw_table *t = chain->tables[i];
 131         count += t->delete(t, key, priority, strict);
 132     }
 133
 134     return count;
 135
 136 }
 137
 138 /* Deletes timed-out flow entries from all the tables in 'chain' and appends
 139  * the deleted flows to 'deleted'.
 140  *
 141  * Expensive as currently implemented, since it iterates through the entire
 142  * contents of each table. */
 143 void
 144 chain_timeout(struct sw_chain *chain, struct list *deleted)
 145 {
 146     int i;
 147
 148     for (i = 0; i < chain->n_tables; i++) {
 149         struct sw_table *t = chain->tables[i];
 150         t->timeout(t, deleted);
 151     }
 152 }
 153
 154 /* Destroys 'chain', which must not have any users. */
 155 void
 156 chain_destroy(struct sw_chain *chain)
 157 {
 158     int i;
 159
 160     for (i = 0; i < chain->n_tables; i++) {
 161         struct sw_table *t = chain->tables[i];
 162         t->destroy(t);
 163     }
 164     free(chain);
 165 }
 166
 167 /* Prints statistics for each of the tables in 'chain'. */
 168 void
 169 chain_print_stats(struct sw_chain *chain)
 170 {
 171     int i;
 172
 173     printf("\n");
 174     for (i = 0; i < chain->n_tables; i++) {
 175         struct sw_table *t = chain->tables[i];
 176         struct sw_table_stats stats;
 177         t->stats(t, &stats);
 178         printf("%s: %lu/%lu flows\n",
 179                stats.name, stats.n_flows, stats.max_flows);
 180     }
 181 }