Files
openflow/switch/table.h
T
Justin Pettit d1d2f3f321 - On flow entries with wildcards, match priority field when doing a "strict" delete.
- Remove group_id from flow entries.
- Show priority when print flow mod messages.
2008-04-29 15:00:28 -07:00

107 lines
4.4 KiB
C

/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
* Junior University
*
* We are making the OpenFlow specification and associated documentation
* (Software) available for public use and benefit with the expectation
* that others will use, modify and enhance the Software and contribute
* those enhancements back to the community. However, since we would
* like to make the Software available for broadest use, with as few
* restrictions as possible permission is hereby granted, free of
* charge, to any person obtaining a copy of this Software to deal in
* the Software under the copyrights without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* The name and trademarks of copyright holder(s) may NOT be used in
* advertising or publicity pertaining to the Software or any
* derivatives without specific, written prior permission.
*/
/* Individual switching tables. Generally grouped together in a chain (see
* chain.h). */
#ifndef TABLE_H
#define TABLE_H 1
#include <stdint.h>
struct sw_flow;
struct sw_flow_key;
struct list;
/* Iterator through the flows stored in a table. */
struct swt_iterator {
struct sw_flow *flow; /* Current flow, for use by client. */
void *private;
};
/* Table statistics. */
struct sw_table_stats {
const char *name; /* Human-readable name. */
unsigned long int n_flows; /* Number of active flows. */
unsigned long int max_flows; /* Flow capacity. */
};
/* A single table of flows. */
struct sw_table {
/* Searches 'table' for a flow matching 'key', which must not have any
* wildcard fields. Returns the flow if successful, a null pointer
* otherwise. */
struct sw_flow *(*lookup)(struct sw_table *table,
const struct sw_flow_key *key);
/* Inserts 'flow' into 'table', replacing any duplicate flow. Returns
* 0 if successful or a negative error. Error can be due to an
* over-capacity table or because the flow is not one of the kind that
* the table accepts.
*
* If successful, 'flow' becomes owned by 'table', otherwise it is
* retained by the caller. */
int (*insert)(struct sw_table *table, struct sw_flow *flow);
/* Deletes from 'table' any and all flows that match 'key' from
* 'table'. If 'strict' set, wildcards must match. Returns the
* number of flows that were deleted. */
int (*delete)(struct sw_table *table, const struct sw_flow_key *key,
uint16_t priority, int strict);
/* Performs timeout processing on all the flow entries in 'table'.
* Appends all the flow entries removed from 'table' to 'deleted' for the
* caller to free. */
void (*timeout)(struct sw_table *table, struct list *deleted);
/* Destroys 'table', which must not have any users. */
void (*destroy)(struct sw_table *table);
int (*iterator)(struct sw_table *, struct swt_iterator *);
void (*iterator_next)(struct swt_iterator *);
void (*iterator_destroy)(struct swt_iterator *);
/* Dumps statistics for 'table' into 'stats'. */
void (*stats)(struct sw_table *table, struct sw_table_stats *stats);
};
struct sw_table *table_mac_create(unsigned int n_buckets,
unsigned int max_flows);
struct sw_table *table_hash_create(unsigned int polynomial,
unsigned int n_buckets);
struct sw_table *table_hash2_create(unsigned int poly0, unsigned int buckets0,
unsigned int poly1, unsigned int buckets1);
struct sw_table *table_linear_create(unsigned int max_flows);
#endif /* table.h */