switch/table.h

   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 /* Individual switching tables.  Generally grouped together in a chain (see
  35  * chain.h). */
  36
  37 #ifndef TABLE_H
  38 #define TABLE_H 1
  39
  40 struct sw_flow;
  41 struct sw_flow_key;
  42 struct list;
  43
  44 /* Iterator through the flows stored in a table. */
  45 struct swt_iterator {
  46     struct sw_flow *flow;   /* Current flow, for use by client. */
  47     void *private;
  48 };
  49
  50 /* Table statistics. */
  51 struct sw_table_stats {
  52     const char *name;       /* Human-readable name. */
  53     unsigned long int n_flows; /* Number of active flows. */
  54     unsigned long int max_flows; /* Flow capacity. */
  55 };
  56
  57 /* A single table of flows.  */
  58 struct sw_table {
  59     /* Searches 'table' for a flow matching 'key', which must not have any
  60      * wildcard fields.  Returns the flow if successful, a null pointer
  61      * otherwise. */
  62     struct sw_flow *(*lookup)(struct sw_table *table,
  63                               const struct sw_flow_key *key);
  64
  65     /* Inserts 'flow' into 'table', replacing any duplicate flow.  Returns
  66      * 0 if successful or a negative error.  Error can be due to an
  67      * over-capacity table or because the flow is not one of the kind that
  68      * the table accepts.
  69      *
  70      * If successful, 'flow' becomes owned by 'table', otherwise it is
  71      * retained by the caller. */
  72     int (*insert)(struct sw_table *table, struct sw_flow *flow);
  73
  74     /* Deletes from 'table' any and all flows that match 'key' from
  75      * 'table'.  If 'strict' set, wildcards must match.  Returns the
  76      * number of flows that were deleted. */
  77     int (*delete)(struct sw_table *table, const struct sw_flow_key *key,
  78                   int strict);
  79
  80     /* Performs timeout processing on all the flow entries in 'table'.
  81      * Appends all the flow entries removed from 'table' to 'deleted' for the
  82      * caller to free. */
  83     void (*timeout)(struct sw_table *table, struct list *deleted);
  84
  85     /* Destroys 'table', which must not have any users. */
  86     void (*destroy)(struct sw_table *table);
  87
  88     int (*iterator)(struct sw_table *, struct swt_iterator *);
  89     void (*iterator_next)(struct swt_iterator *);
  90     void (*iterator_destroy)(struct swt_iterator *);
  91
  92     /* Dumps statistics for 'table' into 'stats'. */
  93     void (*stats)(struct sw_table *table, struct sw_table_stats *stats);
  94 };
  95
  96 struct sw_table *table_mac_create(unsigned int n_buckets,
  97                                   unsigned int max_flows);
  98 struct sw_table *table_hash_create(unsigned int polynomial,
  99                                    unsigned int n_buckets);
 100 struct sw_table *table_hash2_create(unsigned int poly0, unsigned int buckets0,
 101                                     unsigned int poly1, unsigned int buckets1);
 102 struct sw_table *table_linear_create(unsigned int max_flows);
 103
 104 #endif /* table.h */