Merge branch "partner", to simplify partner integration.
[openvswitch] / switch / table-linear.c
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 #include <config.h>
35 #include "table.h"
36 #include <stdlib.h>
37 #include "flow.h"
38 #include "list.h"
39 #include "openflow.h"
40 #include "switch-flow.h"
41 #include "datapath.h"
42
43 struct sw_table_linear {
44     struct sw_table swt;
45
46     unsigned int max_flows;
47     unsigned int n_flows;
48     struct list flows;
49     struct list iter_flows;
50     unsigned long int next_serial;
51 };
52
53 static struct sw_flow *table_linear_lookup(struct sw_table *swt,
54                                            const struct sw_flow_key *key)
55 {
56     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
57     struct sw_flow *flow;
58     LIST_FOR_EACH (flow, struct sw_flow, node, &tl->flows) {
59         if (flow_matches_1wild(key, &flow->key))
60             return flow;
61     }
62     return NULL;
63 }
64
65 static int table_linear_insert(struct sw_table *swt, struct sw_flow *flow)
66 {
67     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
68     struct sw_flow *f;
69
70     /* Loop through the existing list of entries.  New entries will
71      * always be placed behind those with equal priority.  Just replace 
72      * any flows that match exactly.
73      */
74     LIST_FOR_EACH (f, struct sw_flow, node, &tl->flows) {
75         if (f->priority == flow->priority
76                 && f->key.wildcards == flow->key.wildcards
77                 && flow_matches_2wild(&f->key, &flow->key)) {
78             /* Keep stats from the original flow */
79             flow->used = f->used;
80             flow->created = f->created;
81             flow->packet_count = f->packet_count;
82             flow->byte_count = f->byte_count;
83
84             flow->serial = f->serial;
85             list_replace(&flow->node, &f->node);
86             list_replace(&flow->iter_node, &f->iter_node);
87             flow_free(f);
88             return 1;
89         }
90
91         if (f->priority < flow->priority)
92             break;
93     }
94
95     /* Make sure there's room in the table. */
96     if (tl->n_flows >= tl->max_flows) {
97         return 0;
98     }
99     tl->n_flows++;
100
101     /* Insert the entry immediately in front of where we're pointing. */
102     flow->serial = tl->next_serial++;
103     list_insert(&f->node, &flow->node);
104     list_push_front(&tl->iter_flows, &flow->iter_node);
105
106     return 1;
107 }
108
109 static void
110 do_delete(struct sw_flow *flow) 
111 {
112     list_remove(&flow->node);
113     list_remove(&flow->iter_node);
114     flow_free(flow);
115 }
116
117 static int table_linear_delete(struct sw_table *swt,
118                                const struct sw_flow_key *key, 
119                                uint16_t priority, int strict)
120 {
121     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
122     struct sw_flow *flow, *n;
123     unsigned int count = 0;
124
125     LIST_FOR_EACH_SAFE (flow, n, struct sw_flow, node, &tl->flows) {
126         if (flow_del_matches(&flow->key, key, strict)
127                 && (!strict || (flow->priority == priority))) {
128             do_delete(flow);
129             count++;
130         }
131     }
132     tl->n_flows -= count;
133     return count;
134 }
135
136 static void table_linear_timeout(struct sw_table *swt, struct list *deleted)
137 {
138     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
139     struct sw_flow *flow, *n;
140
141     LIST_FOR_EACH_SAFE (flow, n, struct sw_flow, node, &tl->flows) {
142         if (flow_timeout(flow)) {
143             list_remove(&flow->node);
144             list_remove(&flow->iter_node);
145             list_push_back(deleted, &flow->node);
146             tl->n_flows--;
147         }
148     }
149 }
150
151 static void table_linear_destroy(struct sw_table *swt)
152 {
153     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
154
155     while (!list_is_empty(&tl->flows)) {
156         struct sw_flow *flow = CONTAINER_OF(list_front(&tl->flows),
157                                             struct sw_flow, node);
158         list_remove(&flow->node);
159         flow_free(flow);
160     }
161     free(tl);
162 }
163
164 static int table_linear_iterate(struct sw_table *swt,
165                                 const struct sw_flow_key *key,
166                                 struct sw_table_position *position,
167                                 int (*callback)(struct sw_flow *, void *),
168                                 void *private)
169 {
170     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
171     struct sw_flow *flow;
172     unsigned long start;
173
174     start = ~position->private[0];
175     LIST_FOR_EACH (flow, struct sw_flow, iter_node, &tl->iter_flows) {
176         if (flow->serial <= start && flow_matches_2wild(key, &flow->key)) {
177             int error = callback(flow, private);
178             if (error) {
179                 position->private[0] = ~(flow->serial - 1);
180                 return error;
181             }
182         }
183     }
184     return 0;
185 }
186
187 static void table_linear_stats(struct sw_table *swt,
188                                struct sw_table_stats *stats)
189 {
190     struct sw_table_linear *tl = (struct sw_table_linear *) swt;
191     stats->name = "linear";
192     stats->wildcards = OFPFW_ALL;
193     stats->n_flows   = tl->n_flows;
194     stats->max_flows = tl->max_flows;
195     stats->n_matched = swt->n_matched;
196 }
197
198
199 struct sw_table *table_linear_create(unsigned int max_flows)
200 {
201     struct sw_table_linear *tl;
202     struct sw_table *swt;
203
204     tl = calloc(1, sizeof *tl);
205     if (tl == NULL)
206         return NULL;
207
208     swt = &tl->swt;
209     swt->lookup = table_linear_lookup;
210     swt->insert = table_linear_insert;
211     swt->delete = table_linear_delete;
212     swt->timeout = table_linear_timeout;
213     swt->destroy = table_linear_destroy;
214     swt->iterate = table_linear_iterate;
215     swt->stats = table_linear_stats;
216
217     tl->max_flows = max_flows;
218     tl->n_flows = 0;
219     list_init(&tl->flows);
220     list_init(&tl->iter_flows);
221     tl->next_serial = 0;
222
223     return swt;
224 }