1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
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:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
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
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.
34 /* Individual switching tables. Generally grouped together in a chain (see
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_matched; /* Number of packets that have hit. */
57 /* Position within an iteration of a sw_table.
59 * The contents are private to the table implementation, except that a position
60 * initialized to all-zero-bits represents the start of a table. */
61 struct sw_table_position {
62 unsigned long private[4];
65 /* A single table of flows. */
67 /* Keep track of the number of packets that matched this table. To
68 * make this 100% accurate, it should be atomic. However, we're
69 * primarily concerned about speed. */
70 unsigned long int n_matched;
72 /* Searches 'table' for a flow matching 'key', which must not have any
73 * wildcard fields. Returns the flow if successful, a null pointer
75 struct sw_flow *(*lookup)(struct sw_table *table,
76 const struct sw_flow_key *key);
78 /* Inserts 'flow' into 'table', replacing any duplicate flow. Returns
79 * 0 if successful or a negative error. Error can be due to an
80 * over-capacity table or because the flow is not one of the kind that
83 * If successful, 'flow' becomes owned by 'table', otherwise it is
84 * retained by the caller. */
85 int (*insert)(struct sw_table *table, struct sw_flow *flow);
87 /* Modifies the actions in 'table' that match 'key'. If 'strict'
88 * set, wildcards and priority must match. Returns the number of flows
89 * that were modified. */
90 int (*modify)(struct sw_table *table, const struct sw_flow_key *key,
91 uint16_t priority, int strict,
92 const struct ofp_action *actions, int n_actions);
94 /* Deletes from 'table' any and all flows that match 'key' from
95 * 'table'. If 'strict' set, wildcards must match. Returns the
96 * number of flows that were deleted. */
97 int (*delete)(struct sw_table *table, const struct sw_flow_key *key,
98 uint16_t priority, int strict);
100 /* Performs timeout processing on all the flow entries in 'table'.
101 * Appends all the flow entries removed from 'table' to 'deleted' for the
103 void (*timeout)(struct sw_table *table, struct list *deleted);
105 /* Destroys 'table', which must not have any users. */
106 void (*destroy)(struct sw_table *table);
108 /* Iterates through the flow entries in 'table', passing each one
109 * matches 'key' to 'callback'. The callback function should return 0
110 * to continue iteration or a nonzero error code to stop. The iterator
111 * function returns either 0 if the table iteration completed or the
112 * value returned by the callback function otherwise.
114 * The iteration starts at 'position', which may be initialized to
115 * all-zero-bits to iterate from the beginning of the table. If the
116 * iteration terminates due to an error from the callback function,
117 * 'position' is updated to a value that can be passed back to the
118 * iterator function to resume iteration later with the following
120 int (*iterate)(struct sw_table *table,
121 const struct sw_flow_key *key,
122 struct sw_table_position *position,
123 int (*callback)(struct sw_flow *flow, void *private),
126 /* Dumps statistics for 'table' into 'stats'. */
127 void (*stats)(struct sw_table *table, struct sw_table_stats *stats);
130 struct sw_table *table_hash_create(unsigned int polynomial,
131 unsigned int n_buckets);
132 struct sw_table *table_hash2_create(unsigned int poly0, unsigned int buckets0,
133 unsigned int poly1, unsigned int buckets1);
134 struct sw_table *table_linear_create(unsigned int max_flows);