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