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