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 #include <stdint.h>
  41
  42 struct sw_flow;
  43 struct sw_flow_key;
  44 struct ofp_action;
  45 struct list;
  46
  47 /* Table statistics. */
  48 struct sw_table_stats {
  49     const char *name;            /* Human-readable name. */
  50     uint32_t wildcards;          /* Bitmap of OFPFW_* wildcards that are
  51                                     supported by the table. */
  52     unsigned int n_flows;        /* Number of active flows. */
  53     unsigned int max_flows;      /* Flow capacity. */
  54     unsigned long int n_lookup;  /* Number of packets looked up. */
  55     unsigned long int n_matched; /* Number of packets that have hit. */
  56 };
  57
  58 /* Position within an iteration of a sw_table.
  59  *
  60  * The contents are private to the table implementation, except that a position
  61  * initialized to all-zero-bits represents the start of a table. */
  62 struct sw_table_position {
  63     unsigned long private[4];
  64 };
  65
  66 /* A single table of flows.  */
  67 struct sw_table {
  68     /* The number of packets that have been looked up and matched,
  69      * respecitvely.  To make these 100% accurate, they should be atomic.
  70      * However, we're primarily concerned about speed. */
  71     unsigned long long n_lookup;
  72     unsigned long long n_matched;
  73
  74     /* Searches 'table' for a flow matching 'key', which must not have any
  75      * wildcard fields.  Returns the flow if successful, a null pointer
  76      * otherwise. */
  77     struct sw_flow *(*lookup)(struct sw_table *table,
  78                               const struct sw_flow_key *key);
  79
  80     /* Inserts 'flow' into 'table', replacing any duplicate flow.  Returns
  81      * 0 if successful or a negative error.  Error can be due to an
  82      * over-capacity table or because the flow is not one of the kind that
  83      * the table accepts.
  84      *
  85      * If successful, 'flow' becomes owned by 'table', otherwise it is
  86      * retained by the caller. */
  87     int (*insert)(struct sw_table *table, struct sw_flow *flow);
  88
  89     /* Modifies the actions in 'table' that match 'key'.  If 'strict'
  90      * set, wildcards and priority must match.  Returns the number of flows
  91      * that were modified. */
  92     int (*modify)(struct sw_table *table, const struct sw_flow_key *key,
  93             uint16_t priority, int strict,
  94             const struct ofp_action *actions, int n_actions);
  95
  96     /* Deletes from 'table' any and all flows that match 'key' from
  97      * 'table'.  If 'strict' set, wildcards must match.  Returns the
  98      * number of flows that were deleted. */
  99     int (*delete)(struct sw_table *table, const struct sw_flow_key *key,
 100                   uint16_t priority, int strict);
 101
 102     /* Performs timeout processing on all the flow entries in 'table'.
 103      * Appends all the flow entries removed from 'table' to 'deleted' for the
 104      * caller to free. */
 105     void (*timeout)(struct sw_table *table, struct list *deleted);
 106
 107     /* Destroys 'table', which must not have any users. */
 108     void (*destroy)(struct sw_table *table);
 109
 110     /* Iterates through the flow entries in 'table', passing each one
 111      * matches 'key' to 'callback'.  The callback function should return 0
 112      * to continue iteration or a nonzero error code to stop.  The iterator
 113      * function returns either 0 if the table iteration completed or the
 114      * value returned by the callback function otherwise.
 115      *
 116      * The iteration starts at 'position', which may be initialized to
 117      * all-zero-bits to iterate from the beginning of the table.  If the
 118      * iteration terminates due to an error from the callback function,
 119      * 'position' is updated to a value that can be passed back to the
 120      * iterator function to resume iteration later with the following
 121      * flow. */
 122     int (*iterate)(struct sw_table *table,
 123                const struct sw_flow_key *key,
 124                struct sw_table_position *position,
 125                int (*callback)(struct sw_flow *flow, void *private),
 126                void *private);
 127
 128     /* Dumps statistics for 'table' into 'stats'. */
 129     void (*stats)(struct sw_table *table, struct sw_table_stats *stats);
 130 };
 131
 132 struct sw_table *table_hash_create(unsigned int polynomial,
 133                                    unsigned int n_buckets);
 134 struct sw_table *table_hash2_create(unsigned int poly0, unsigned int buckets0,
 135                                     unsigned int poly1, unsigned int buckets1);
 136 struct sw_table *table_linear_create(unsigned int max_flows);
 137
 138 #endif /* table.h */