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