13c20b3e25e0caf84075c63ed07538b722861aaa
[cascardo/ovs.git] / ofproto / ofproto.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3  * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #include <config.h>
19 #include "ofproto.h"
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <stdbool.h>
23 #include <stdlib.h>
24 #include <unistd.h>
25 #include "bitmap.h"
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connmgr.h"
29 #include "coverage.h"
30 #include "dynamic-string.h"
31 #include "hash.h"
32 #include "hmap.h"
33 #include "meta-flow.h"
34 #include "netdev.h"
35 #include "nx-match.h"
36 #include "ofp-actions.h"
37 #include "ofp-errors.h"
38 #include "ofp-msgs.h"
39 #include "ofp-print.h"
40 #include "ofp-util.h"
41 #include "ofpbuf.h"
42 #include "ofproto-provider.h"
43 #include "openflow/nicira-ext.h"
44 #include "openflow/openflow.h"
45 #include "packets.h"
46 #include "pinsched.h"
47 #include "pktbuf.h"
48 #include "poll-loop.h"
49 #include "random.h"
50 #include "shash.h"
51 #include "simap.h"
52 #include "sset.h"
53 #include "timeval.h"
54 #include "unaligned.h"
55 #include "unixctl.h"
56 #include "vlog.h"
57
58 VLOG_DEFINE_THIS_MODULE(ofproto);
59
60 COVERAGE_DEFINE(ofproto_error);
61 COVERAGE_DEFINE(ofproto_flush);
62 COVERAGE_DEFINE(ofproto_no_packet_in);
63 COVERAGE_DEFINE(ofproto_packet_out);
64 COVERAGE_DEFINE(ofproto_queue_req);
65 COVERAGE_DEFINE(ofproto_recv_openflow);
66 COVERAGE_DEFINE(ofproto_reinit_ports);
67 COVERAGE_DEFINE(ofproto_uninstallable);
68 COVERAGE_DEFINE(ofproto_update_port);
69
70 enum ofproto_state {
71     S_OPENFLOW,                 /* Processing OpenFlow commands. */
72     S_EVICT,                    /* Evicting flows from over-limit tables. */
73     S_FLUSH,                    /* Deleting all flow table rules. */
74 };
75
76 enum ofoperation_type {
77     OFOPERATION_ADD,
78     OFOPERATION_DELETE,
79     OFOPERATION_MODIFY,
80     OFOPERATION_REPLACE
81 };
82
83 /* A single OpenFlow request can execute any number of operations.  The
84  * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
85  * ofconn to which an error reply should be sent if necessary.
86  *
87  * ofproto initiates some operations internally.  These operations are still
88  * assigned to groups but will not have an associated ofconn. */
89 struct ofopgroup {
90     struct ofproto *ofproto;    /* Owning ofproto. */
91     struct list ofproto_node;   /* In ofproto's "pending" list. */
92     struct list ops;            /* List of "struct ofoperation"s. */
93     int n_running;              /* Number of ops still pending. */
94
95     /* Data needed to send OpenFlow reply on failure or to send a buffered
96      * packet on success.
97      *
98      * If list_is_empty(ofconn_node) then this ofopgroup never had an
99      * associated ofconn or its ofconn's connection dropped after it initiated
100      * the operation.  In the latter case 'ofconn' is a wild pointer that
101      * refers to freed memory, so the 'ofconn' member must be used only if
102      * !list_is_empty(ofconn_node).
103      */
104     struct list ofconn_node;    /* In ofconn's list of pending opgroups. */
105     struct ofconn *ofconn;      /* ofconn for reply (but see note above). */
106     struct ofp_header *request; /* Original request (truncated at 64 bytes). */
107     uint32_t buffer_id;         /* Buffer id from original request. */
108 };
109
110 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
111 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
112                                           const struct ofp_header *,
113                                           uint32_t buffer_id);
114 static void ofopgroup_submit(struct ofopgroup *);
115 static void ofopgroup_complete(struct ofopgroup *);
116
117 /* A single flow table operation. */
118 struct ofoperation {
119     struct ofopgroup *group;    /* Owning group. */
120     struct list group_node;     /* In ofopgroup's "ops" list. */
121     struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
122     struct rule *rule;          /* Rule being operated upon. */
123     enum ofoperation_type type; /* Type of operation. */
124
125     /* OFOPERATION_MODIFY, OFOPERATION_REPLACE: The old actions, if the actions
126      * are changing. */
127     struct rule_actions *actions;
128
129     /* OFOPERATION_DELETE. */
130     enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
131
132     ovs_be64 flow_cookie;       /* Rule's old flow cookie. */
133     uint16_t idle_timeout;      /* Rule's old idle timeout. */
134     uint16_t hard_timeout;      /* Rule's old hard timeout. */
135     bool send_flow_removed;     /* Rule's old 'send_flow_removed'. */
136     enum ofperr error;          /* 0 if no error. */
137 };
138
139 static struct ofoperation *ofoperation_create(struct ofopgroup *,
140                                               struct rule *,
141                                               enum ofoperation_type,
142                                               enum ofp_flow_removed_reason);
143 static void ofoperation_destroy(struct ofoperation *);
144
145 /* oftable. */
146 static void oftable_init(struct oftable *);
147 static void oftable_destroy(struct oftable *);
148
149 static void oftable_set_name(struct oftable *, const char *name);
150
151 static void oftable_disable_eviction(struct oftable *);
152 static void oftable_enable_eviction(struct oftable *,
153                                     const struct mf_subfield *fields,
154                                     size_t n_fields);
155
156 static void oftable_remove_rule(struct rule *rule) OVS_REQUIRES(ofproto_mutex);
157 static void oftable_remove_rule__(struct ofproto *, struct rule *)
158     OVS_REQUIRES(ofproto_mutex);
159 static void oftable_insert_rule(struct rule *);
160
161 /* A set of rules within a single OpenFlow table (oftable) that have the same
162  * values for the oftable's eviction_fields.  A rule to be evicted, when one is
163  * needed, is taken from the eviction group that contains the greatest number
164  * of rules.
165  *
166  * An oftable owns any number of eviction groups, each of which contains any
167  * number of rules.
168  *
169  * Membership in an eviction group is imprecise, based on the hash of the
170  * oftable's eviction_fields (in the eviction_group's id_node.hash member).
171  * That is, if two rules have different eviction_fields, but those
172  * eviction_fields hash to the same value, then they will belong to the same
173  * eviction_group anyway.
174  *
175  * (When eviction is not enabled on an oftable, we don't track any eviction
176  * groups, to save time and space.) */
177 struct eviction_group {
178     struct hmap_node id_node;   /* In oftable's "eviction_groups_by_id". */
179     struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
180     struct heap rules;          /* Contains "struct rule"s. */
181 };
182
183 static bool choose_rule_to_evict(struct oftable *table, struct rule **rulep);
184 static void ofproto_evict(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
185 static uint32_t rule_eviction_priority(struct rule *);
186 static void eviction_group_add_rule(struct rule *);
187 static void eviction_group_remove_rule(struct rule *);
188
189 /* Criteria that flow_mod and other operations use for selecting rules on
190  * which to operate. */
191 struct rule_criteria {
192     /* An OpenFlow table or 255 for all tables. */
193     uint8_t table_id;
194
195     /* OpenFlow matching criteria.  Interpreted different in "loose" way by
196      * collect_rules_loose() and "strict" way by collect_rules_strict(), as
197      * defined in the OpenFlow spec. */
198     struct cls_rule cr;
199
200     /* Matching criteria for the OpenFlow cookie.  Consider a bit B in a rule's
201      * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
202      * The rule will not be selected if M is 1 and B != C.  */
203     ovs_be64 cookie;
204     ovs_be64 cookie_mask;
205
206     /* Selection based on actions within a rule:
207      *
208      * If out_port != OFPP_ANY, selects only rules that output to out_port. */
209     ofp_port_t out_port;
210 };
211
212 static void rule_criteria_init(struct rule_criteria *, uint8_t table_id,
213                                const struct match *match,
214                                unsigned int priority,
215                                ovs_be64 cookie, ovs_be64 cookie_mask,
216                                ofp_port_t out_port);
217 static void rule_criteria_destroy(struct rule_criteria *);
218
219 /* A packet that needs to be passed to rule_execute().
220  *
221  * (We can't do this immediately from ofopgroup_complete() because that holds
222  * ofproto_mutex, which rule_execute() needs released.) */
223 struct rule_execute {
224     struct list list_node;      /* In struct ofproto's "rule_executes" list. */
225     struct rule *rule;          /* Owns a reference to the rule. */
226     ofp_port_t in_port;
227     struct ofpbuf *packet;      /* Owns the packet. */
228 };
229
230 static void run_rule_executes(struct ofproto *) OVS_EXCLUDED(ofproto_mutex);
231 static void destroy_rule_executes(struct ofproto *);
232
233 /* ofport. */
234 static void ofport_destroy__(struct ofport *) OVS_EXCLUDED(ofproto_mutex);
235 static void ofport_destroy(struct ofport *);
236
237 static void update_port(struct ofproto *, const char *devname);
238 static int init_ports(struct ofproto *);
239 static void reinit_ports(struct ofproto *);
240
241 /* rule. */
242 static void ofproto_rule_destroy__(struct rule *);
243 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
244 static bool rule_is_modifiable(const struct rule *);
245
246 /* OpenFlow. */
247 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
248                             struct ofputil_flow_mod *,
249                             const struct ofp_header *);
250 static enum ofperr modify_flows__(struct ofproto *, struct ofconn *,
251                                   struct ofputil_flow_mod *,
252                                   const struct ofp_header *,
253                                   const struct rule_collection *);
254 static void delete_flow__(struct rule *rule, struct ofopgroup *,
255                           enum ofp_flow_removed_reason)
256     OVS_REQUIRES(ofproto_mutex);
257 static bool handle_openflow(struct ofconn *, const struct ofpbuf *);
258 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
259                                      struct ofputil_flow_mod *,
260                                      const struct ofp_header *)
261     OVS_EXCLUDED(ofproto_mutex);
262 static void calc_duration(long long int start, long long int now,
263                           uint32_t *sec, uint32_t *nsec);
264
265 /* ofproto. */
266 static uint64_t pick_datapath_id(const struct ofproto *);
267 static uint64_t pick_fallback_dpid(void);
268 static void ofproto_destroy__(struct ofproto *);
269 static void update_mtu(struct ofproto *, struct ofport *);
270 static void meter_delete(struct ofproto *, uint32_t first, uint32_t last);
271
272 /* unixctl. */
273 static void ofproto_unixctl_init(void);
274
275 /* All registered ofproto classes, in probe order. */
276 static const struct ofproto_class **ofproto_classes;
277 static size_t n_ofproto_classes;
278 static size_t allocated_ofproto_classes;
279
280 /* Global lock that protects all flow table operations. */
281 struct ovs_mutex ofproto_mutex = OVS_MUTEX_INITIALIZER;
282
283 unsigned flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT;
284 unsigned n_handler_threads;
285 enum ofproto_flow_miss_model flow_miss_model = OFPROTO_HANDLE_MISS_AUTO;
286
287 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
288 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
289
290 /* Initial mappings of port to OpenFlow number mappings. */
291 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
292
293 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
294
295 /* The default value of true waits for flow restore. */
296 static bool flow_restore_wait = true;
297
298 /* Must be called to initialize the ofproto library.
299  *
300  * The caller may pass in 'iface_hints', which contains an shash of
301  * "iface_hint" elements indexed by the interface's name.  The provider
302  * may use these hints to describe the startup configuration in order to
303  * reinitialize its state.  The caller owns the provided data, so a
304  * provider will make copies of anything required.  An ofproto provider
305  * will remove any existing state that is not described by the hint, and
306  * may choose to remove it all. */
307 void
308 ofproto_init(const struct shash *iface_hints)
309 {
310     struct shash_node *node;
311     size_t i;
312
313     ofproto_class_register(&ofproto_dpif_class);
314
315     /* Make a local copy, since we don't own 'iface_hints' elements. */
316     SHASH_FOR_EACH(node, iface_hints) {
317         const struct iface_hint *orig_hint = node->data;
318         struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
319         const char *br_type = ofproto_normalize_type(orig_hint->br_type);
320
321         new_hint->br_name = xstrdup(orig_hint->br_name);
322         new_hint->br_type = xstrdup(br_type);
323         new_hint->ofp_port = orig_hint->ofp_port;
324
325         shash_add(&init_ofp_ports, node->name, new_hint);
326     }
327
328     for (i = 0; i < n_ofproto_classes; i++) {
329         ofproto_classes[i]->init(&init_ofp_ports);
330     }
331 }
332
333 /* 'type' should be a normalized datapath type, as returned by
334  * ofproto_normalize_type().  Returns the corresponding ofproto_class
335  * structure, or a null pointer if there is none registered for 'type'. */
336 static const struct ofproto_class *
337 ofproto_class_find__(const char *type)
338 {
339     size_t i;
340
341     for (i = 0; i < n_ofproto_classes; i++) {
342         const struct ofproto_class *class = ofproto_classes[i];
343         struct sset types;
344         bool found;
345
346         sset_init(&types);
347         class->enumerate_types(&types);
348         found = sset_contains(&types, type);
349         sset_destroy(&types);
350
351         if (found) {
352             return class;
353         }
354     }
355     VLOG_WARN("unknown datapath type %s", type);
356     return NULL;
357 }
358
359 /* Registers a new ofproto class.  After successful registration, new ofprotos
360  * of that type can be created using ofproto_create(). */
361 int
362 ofproto_class_register(const struct ofproto_class *new_class)
363 {
364     size_t i;
365
366     for (i = 0; i < n_ofproto_classes; i++) {
367         if (ofproto_classes[i] == new_class) {
368             return EEXIST;
369         }
370     }
371
372     if (n_ofproto_classes >= allocated_ofproto_classes) {
373         ofproto_classes = x2nrealloc(ofproto_classes,
374                                      &allocated_ofproto_classes,
375                                      sizeof *ofproto_classes);
376     }
377     ofproto_classes[n_ofproto_classes++] = new_class;
378     return 0;
379 }
380
381 /* Unregisters a datapath provider.  'type' must have been previously
382  * registered and not currently be in use by any ofprotos.  After
383  * unregistration new datapaths of that type cannot be opened using
384  * ofproto_create(). */
385 int
386 ofproto_class_unregister(const struct ofproto_class *class)
387 {
388     size_t i;
389
390     for (i = 0; i < n_ofproto_classes; i++) {
391         if (ofproto_classes[i] == class) {
392             for (i++; i < n_ofproto_classes; i++) {
393                 ofproto_classes[i - 1] = ofproto_classes[i];
394             }
395             n_ofproto_classes--;
396             return 0;
397         }
398     }
399     VLOG_WARN("attempted to unregister an ofproto class that is not "
400               "registered");
401     return EAFNOSUPPORT;
402 }
403
404 /* Clears 'types' and enumerates all registered ofproto types into it.  The
405  * caller must first initialize the sset. */
406 void
407 ofproto_enumerate_types(struct sset *types)
408 {
409     size_t i;
410
411     for (i = 0; i < n_ofproto_classes; i++) {
412         ofproto_classes[i]->enumerate_types(types);
413     }
414 }
415
416 /* Returns the fully spelled out name for the given ofproto 'type'.
417  *
418  * Normalized type string can be compared with strcmp().  Unnormalized type
419  * string might be the same even if they have different spellings. */
420 const char *
421 ofproto_normalize_type(const char *type)
422 {
423     return type && type[0] ? type : "system";
424 }
425
426 /* Clears 'names' and enumerates the names of all known created ofprotos with
427  * the given 'type'.  The caller must first initialize the sset.  Returns 0 if
428  * successful, otherwise a positive errno value.
429  *
430  * Some kinds of datapaths might not be practically enumerable.  This is not
431  * considered an error. */
432 int
433 ofproto_enumerate_names(const char *type, struct sset *names)
434 {
435     const struct ofproto_class *class = ofproto_class_find__(type);
436     return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
437  }
438
439 int
440 ofproto_create(const char *datapath_name, const char *datapath_type,
441                struct ofproto **ofprotop)
442 {
443     const struct ofproto_class *class;
444     struct ofproto *ofproto;
445     int error;
446     int i;
447
448     *ofprotop = NULL;
449
450     ofproto_unixctl_init();
451
452     datapath_type = ofproto_normalize_type(datapath_type);
453     class = ofproto_class_find__(datapath_type);
454     if (!class) {
455         VLOG_WARN("could not create datapath %s of unknown type %s",
456                   datapath_name, datapath_type);
457         return EAFNOSUPPORT;
458     }
459
460     ofproto = class->alloc();
461     if (!ofproto) {
462         VLOG_ERR("failed to allocate datapath %s of type %s",
463                  datapath_name, datapath_type);
464         return ENOMEM;
465     }
466
467     /* Initialize. */
468     ovs_mutex_lock(&ofproto_mutex);
469     memset(ofproto, 0, sizeof *ofproto);
470     ofproto->ofproto_class = class;
471     ofproto->name = xstrdup(datapath_name);
472     ofproto->type = xstrdup(datapath_type);
473     hmap_insert(&all_ofprotos, &ofproto->hmap_node,
474                 hash_string(ofproto->name, 0));
475     ofproto->datapath_id = 0;
476     ofproto->forward_bpdu = false;
477     ofproto->fallback_dpid = pick_fallback_dpid();
478     ofproto->mfr_desc = NULL;
479     ofproto->hw_desc = NULL;
480     ofproto->sw_desc = NULL;
481     ofproto->serial_desc = NULL;
482     ofproto->dp_desc = NULL;
483     ofproto->frag_handling = OFPC_FRAG_NORMAL;
484     hmap_init(&ofproto->ports);
485     shash_init(&ofproto->port_by_name);
486     simap_init(&ofproto->ofp_requests);
487     ofproto->max_ports = ofp_to_u16(OFPP_MAX);
488     ofproto->eviction_group_timer = LLONG_MIN;
489     ofproto->tables = NULL;
490     ofproto->n_tables = 0;
491     hindex_init(&ofproto->cookies);
492     list_init(&ofproto->expirable);
493     ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
494     ofproto->state = S_OPENFLOW;
495     list_init(&ofproto->pending);
496     ofproto->n_pending = 0;
497     hmap_init(&ofproto->deletions);
498     guarded_list_init(&ofproto->rule_executes);
499     ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
500     ofproto->first_op = ofproto->last_op = LLONG_MIN;
501     ofproto->next_op_report = LLONG_MAX;
502     ofproto->op_backoff = LLONG_MIN;
503     ofproto->vlan_bitmap = NULL;
504     ofproto->vlans_changed = false;
505     ofproto->min_mtu = INT_MAX;
506     ovs_mutex_unlock(&ofproto_mutex);
507
508     error = ofproto->ofproto_class->construct(ofproto);
509     if (error) {
510         VLOG_ERR("failed to open datapath %s: %s",
511                  datapath_name, ovs_strerror(error));
512         ofproto_destroy__(ofproto);
513         return error;
514     }
515
516     /* The "max_ports" member should have been set by ->construct(ofproto).
517      * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
518     ofproto->ofp_port_ids = bitmap_allocate(ofproto->max_ports);
519     bitmap_set1(ofproto->ofp_port_ids, 0);
520
521     /* Check that hidden tables, if any, are at the end. */
522     ovs_assert(ofproto->n_tables);
523     for (i = 0; i + 1 < ofproto->n_tables; i++) {
524         enum oftable_flags flags = ofproto->tables[i].flags;
525         enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
526
527         ovs_assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
528     }
529
530     ofproto->datapath_id = pick_datapath_id(ofproto);
531     init_ports(ofproto);
532
533     /* Initialize meters table. */
534     if (ofproto->ofproto_class->meter_get_features) {
535         ofproto->ofproto_class->meter_get_features(ofproto,
536                                                    &ofproto->meter_features);
537     } else {
538         memset(&ofproto->meter_features, 0, sizeof ofproto->meter_features);
539     }
540     ofproto->meters = xzalloc((ofproto->meter_features.max_meters + 1)
541                               * sizeof(struct meter *));
542
543     *ofprotop = ofproto;
544     return 0;
545 }
546
547 /* Must be called (only) by an ofproto implementation in its constructor
548  * function.  See the large comment on 'construct' in struct ofproto_class for
549  * details. */
550 void
551 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
552 {
553     struct oftable *table;
554
555     ovs_assert(!ofproto->n_tables);
556     ovs_assert(n_tables >= 1 && n_tables <= 255);
557
558     ofproto->n_tables = n_tables;
559     ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
560     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
561         oftable_init(table);
562     }
563 }
564
565 /* To be optionally called (only) by an ofproto implementation in its
566  * constructor function.  See the large comment on 'construct' in struct
567  * ofproto_class for details.
568  *
569  * Sets the maximum number of ports to 'max_ports'.  The ofproto generic layer
570  * will then ensure that actions passed into the ofproto implementation will
571  * not refer to OpenFlow ports numbered 'max_ports' or higher.  If this
572  * function is not called, there will be no such restriction.
573  *
574  * Reserved ports numbered OFPP_MAX and higher are special and not subject to
575  * the 'max_ports' restriction. */
576 void
577 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
578 {
579     ovs_assert(max_ports <= ofp_to_u16(OFPP_MAX));
580     ofproto->max_ports = max_ports;
581 }
582
583 uint64_t
584 ofproto_get_datapath_id(const struct ofproto *ofproto)
585 {
586     return ofproto->datapath_id;
587 }
588
589 void
590 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
591 {
592     uint64_t old_dpid = p->datapath_id;
593     p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
594     if (p->datapath_id != old_dpid) {
595         /* Force all active connections to reconnect, since there is no way to
596          * notify a controller that the datapath ID has changed. */
597         ofproto_reconnect_controllers(p);
598     }
599 }
600
601 void
602 ofproto_set_controllers(struct ofproto *p,
603                         const struct ofproto_controller *controllers,
604                         size_t n_controllers, uint32_t allowed_versions)
605 {
606     connmgr_set_controllers(p->connmgr, controllers, n_controllers,
607                             allowed_versions);
608 }
609
610 void
611 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
612 {
613     connmgr_set_fail_mode(p->connmgr, fail_mode);
614 }
615
616 /* Drops the connections between 'ofproto' and all of its controllers, forcing
617  * them to reconnect. */
618 void
619 ofproto_reconnect_controllers(struct ofproto *ofproto)
620 {
621     connmgr_reconnect(ofproto->connmgr);
622 }
623
624 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
625  * in-band control should guarantee access, in the same way that in-band
626  * control guarantees access to OpenFlow controllers. */
627 void
628 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
629                                   const struct sockaddr_in *extras, size_t n)
630 {
631     connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
632 }
633
634 /* Sets the OpenFlow queue used by flows set up by in-band control on
635  * 'ofproto' to 'queue_id'.  If 'queue_id' is negative, then in-band control
636  * flows will use the default queue. */
637 void
638 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
639 {
640     connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
641 }
642
643 /* Sets the number of flows at which eviction from the kernel flow table
644  * will occur. */
645 void
646 ofproto_set_flow_eviction_threshold(unsigned threshold)
647 {
648     flow_eviction_threshold = MAX(OFPROTO_FLOW_EVICTION_THRESHOLD_MIN,
649                                   threshold);
650 }
651
652 /* Sets the path for handling flow misses. */
653 void
654 ofproto_set_flow_miss_model(unsigned model)
655 {
656     flow_miss_model = model;
657 }
658
659 /* If forward_bpdu is true, the NORMAL action will forward frames with
660  * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
661  * the NORMAL action will drop these frames. */
662 void
663 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
664 {
665     bool old_val = ofproto->forward_bpdu;
666     ofproto->forward_bpdu = forward_bpdu;
667     if (old_val != ofproto->forward_bpdu) {
668         if (ofproto->ofproto_class->forward_bpdu_changed) {
669             ofproto->ofproto_class->forward_bpdu_changed(ofproto);
670         }
671     }
672 }
673
674 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
675  * 'idle_time', in seconds, and the maximum number of MAC table entries to
676  * 'max_entries'. */
677 void
678 ofproto_set_mac_table_config(struct ofproto *ofproto, unsigned idle_time,
679                              size_t max_entries)
680 {
681     if (ofproto->ofproto_class->set_mac_table_config) {
682         ofproto->ofproto_class->set_mac_table_config(ofproto, idle_time,
683                                                      max_entries);
684     }
685 }
686
687 /* Sets number of upcall handler threads.  The default is
688  * (number of online cores - 2). */
689 void
690 ofproto_set_n_handler_threads(unsigned limit)
691 {
692     if (limit) {
693         n_handler_threads = limit;
694     } else {
695         int n_proc = sysconf(_SC_NPROCESSORS_ONLN);
696         n_handler_threads = n_proc > 2 ? n_proc - 2 : 1;
697     }
698 }
699
700 void
701 ofproto_set_dp_desc(struct ofproto *p, const char *dp_desc)
702 {
703     free(p->dp_desc);
704     p->dp_desc = dp_desc ? xstrdup(dp_desc) : NULL;
705 }
706
707 int
708 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
709 {
710     return connmgr_set_snoops(ofproto->connmgr, snoops);
711 }
712
713 int
714 ofproto_set_netflow(struct ofproto *ofproto,
715                     const struct netflow_options *nf_options)
716 {
717     if (nf_options && sset_is_empty(&nf_options->collectors)) {
718         nf_options = NULL;
719     }
720
721     if (ofproto->ofproto_class->set_netflow) {
722         return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
723     } else {
724         return nf_options ? EOPNOTSUPP : 0;
725     }
726 }
727
728 int
729 ofproto_set_sflow(struct ofproto *ofproto,
730                   const struct ofproto_sflow_options *oso)
731 {
732     if (oso && sset_is_empty(&oso->targets)) {
733         oso = NULL;
734     }
735
736     if (ofproto->ofproto_class->set_sflow) {
737         return ofproto->ofproto_class->set_sflow(ofproto, oso);
738     } else {
739         return oso ? EOPNOTSUPP : 0;
740     }
741 }
742
743 int
744 ofproto_set_ipfix(struct ofproto *ofproto,
745                   const struct ofproto_ipfix_bridge_exporter_options *bo,
746                   const struct ofproto_ipfix_flow_exporter_options *fo,
747                   size_t n_fo)
748 {
749     if (ofproto->ofproto_class->set_ipfix) {
750         return ofproto->ofproto_class->set_ipfix(ofproto, bo, fo, n_fo);
751     } else {
752         return (bo || fo) ? EOPNOTSUPP : 0;
753     }
754 }
755
756 void
757 ofproto_set_flow_restore_wait(bool flow_restore_wait_db)
758 {
759     flow_restore_wait = flow_restore_wait_db;
760 }
761
762 bool
763 ofproto_get_flow_restore_wait(void)
764 {
765     return flow_restore_wait;
766 }
767
768 \f
769 /* Spanning Tree Protocol (STP) configuration. */
770
771 /* Configures STP on 'ofproto' using the settings defined in 's'.  If
772  * 's' is NULL, disables STP.
773  *
774  * Returns 0 if successful, otherwise a positive errno value. */
775 int
776 ofproto_set_stp(struct ofproto *ofproto,
777                 const struct ofproto_stp_settings *s)
778 {
779     return (ofproto->ofproto_class->set_stp
780             ? ofproto->ofproto_class->set_stp(ofproto, s)
781             : EOPNOTSUPP);
782 }
783
784 /* Retrieves STP status of 'ofproto' and stores it in 's'.  If the
785  * 'enabled' member of 's' is false, then the other members are not
786  * meaningful.
787  *
788  * Returns 0 if successful, otherwise a positive errno value. */
789 int
790 ofproto_get_stp_status(struct ofproto *ofproto,
791                        struct ofproto_stp_status *s)
792 {
793     return (ofproto->ofproto_class->get_stp_status
794             ? ofproto->ofproto_class->get_stp_status(ofproto, s)
795             : EOPNOTSUPP);
796 }
797
798 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
799  * in 's'.  The caller is responsible for assigning STP port numbers
800  * (using the 'port_num' member in the range of 1 through 255, inclusive)
801  * and ensuring there are no duplicates.  If the 's' is NULL, then STP
802  * is disabled on the port.
803  *
804  * Returns 0 if successful, otherwise a positive errno value.*/
805 int
806 ofproto_port_set_stp(struct ofproto *ofproto, ofp_port_t ofp_port,
807                      const struct ofproto_port_stp_settings *s)
808 {
809     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
810     if (!ofport) {
811         VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
812                   ofproto->name, ofp_port);
813         return ENODEV;
814     }
815
816     return (ofproto->ofproto_class->set_stp_port
817             ? ofproto->ofproto_class->set_stp_port(ofport, s)
818             : EOPNOTSUPP);
819 }
820
821 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
822  * 's'.  If the 'enabled' member in 's' is false, then the other members
823  * are not meaningful.
824  *
825  * Returns 0 if successful, otherwise a positive errno value.*/
826 int
827 ofproto_port_get_stp_status(struct ofproto *ofproto, ofp_port_t ofp_port,
828                             struct ofproto_port_stp_status *s)
829 {
830     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
831     if (!ofport) {
832         VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
833                      "port %"PRIu16, ofproto->name, ofp_port);
834         return ENODEV;
835     }
836
837     return (ofproto->ofproto_class->get_stp_port_status
838             ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
839             : EOPNOTSUPP);
840 }
841 \f
842 /* Queue DSCP configuration. */
843
844 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
845  * 'queues' attached to 'ofport'.  This data is not intended to be sufficient
846  * to implement QoS.  Instead, it is used to implement features which require
847  * knowledge of what queues exist on a port, and some basic information about
848  * them.
849  *
850  * Returns 0 if successful, otherwise a positive errno value. */
851 int
852 ofproto_port_set_queues(struct ofproto *ofproto, ofp_port_t ofp_port,
853                         const struct ofproto_port_queue *queues,
854                         size_t n_queues)
855 {
856     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
857
858     if (!ofport) {
859         VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
860                   ofproto->name, ofp_port);
861         return ENODEV;
862     }
863
864     return (ofproto->ofproto_class->set_queues
865             ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
866             : EOPNOTSUPP);
867 }
868 \f
869 /* Connectivity Fault Management configuration. */
870
871 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
872 void
873 ofproto_port_clear_cfm(struct ofproto *ofproto, ofp_port_t ofp_port)
874 {
875     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
876     if (ofport && ofproto->ofproto_class->set_cfm) {
877         ofproto->ofproto_class->set_cfm(ofport, NULL);
878     }
879 }
880
881 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'.  Takes
882  * basic configuration from the configuration members in 'cfm', and the remote
883  * maintenance point ID from  remote_mpid.  Ignores the statistics members of
884  * 'cfm'.
885  *
886  * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
887 void
888 ofproto_port_set_cfm(struct ofproto *ofproto, ofp_port_t ofp_port,
889                      const struct cfm_settings *s)
890 {
891     struct ofport *ofport;
892     int error;
893
894     ofport = ofproto_get_port(ofproto, ofp_port);
895     if (!ofport) {
896         VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
897                   ofproto->name, ofp_port);
898         return;
899     }
900
901     /* XXX: For configuration simplicity, we only support one remote_mpid
902      * outside of the CFM module.  It's not clear if this is the correct long
903      * term solution or not. */
904     error = (ofproto->ofproto_class->set_cfm
905              ? ofproto->ofproto_class->set_cfm(ofport, s)
906              : EOPNOTSUPP);
907     if (error) {
908         VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
909                   ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
910                   ovs_strerror(error));
911     }
912 }
913
914 /* Configures BFD on 'ofp_port' in 'ofproto'.  This function has no effect if
915  * 'ofproto' does not have a port 'ofp_port'. */
916 void
917 ofproto_port_set_bfd(struct ofproto *ofproto, ofp_port_t ofp_port,
918                      const struct smap *cfg)
919 {
920     struct ofport *ofport;
921     int error;
922
923     ofport = ofproto_get_port(ofproto, ofp_port);
924     if (!ofport) {
925         VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16,
926                   ofproto->name, ofp_port);
927         return;
928     }
929
930     error = (ofproto->ofproto_class->set_bfd
931              ? ofproto->ofproto_class->set_bfd(ofport, cfg)
932              : EOPNOTSUPP);
933     if (error) {
934         VLOG_WARN("%s: bfd configuration on port %"PRIu16" (%s) failed (%s)",
935                   ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
936                   ovs_strerror(error));
937     }
938 }
939
940 /* Populates 'status' with key value pairs indicating the status of the BFD
941  * session on 'ofp_port'.  This information is intended to be populated in the
942  * OVS database.  Has no effect if 'ofp_port' is not na OpenFlow port in
943  * 'ofproto'. */
944 int
945 ofproto_port_get_bfd_status(struct ofproto *ofproto, ofp_port_t ofp_port,
946                             struct smap *status)
947 {
948     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
949     return (ofport && ofproto->ofproto_class->get_bfd_status
950             ? ofproto->ofproto_class->get_bfd_status(ofport, status)
951             : EOPNOTSUPP);
952 }
953
954 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
955  * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
956  * 0 if LACP partner information is not current (generally indicating a
957  * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
958 int
959 ofproto_port_is_lacp_current(struct ofproto *ofproto, ofp_port_t ofp_port)
960 {
961     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
962     return (ofport && ofproto->ofproto_class->port_is_lacp_current
963             ? ofproto->ofproto_class->port_is_lacp_current(ofport)
964             : -1);
965 }
966 \f
967 /* Bundles. */
968
969 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
970  * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
971  * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
972  * configuration plus, if there is more than one slave, a bonding
973  * configuration.
974  *
975  * If 'aux' is already registered then this function updates its configuration
976  * to 's'.  Otherwise, this function registers a new bundle.
977  *
978  * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
979  * port. */
980 int
981 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
982                         const struct ofproto_bundle_settings *s)
983 {
984     return (ofproto->ofproto_class->bundle_set
985             ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
986             : EOPNOTSUPP);
987 }
988
989 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
990  * If no such bundle has been registered, this has no effect. */
991 int
992 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
993 {
994     return ofproto_bundle_register(ofproto, aux, NULL);
995 }
996
997 \f
998 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
999  * If 'aux' is already registered then this function updates its configuration
1000  * to 's'.  Otherwise, this function registers a new mirror. */
1001 int
1002 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
1003                         const struct ofproto_mirror_settings *s)
1004 {
1005     return (ofproto->ofproto_class->mirror_set
1006             ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
1007             : EOPNOTSUPP);
1008 }
1009
1010 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1011  * If no mirror has been registered, this has no effect. */
1012 int
1013 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
1014 {
1015     return ofproto_mirror_register(ofproto, aux, NULL);
1016 }
1017
1018 /* Retrieves statistics from mirror associated with client data pointer
1019  * 'aux' in 'ofproto'.  Stores packet and byte counts in 'packets' and
1020  * 'bytes', respectively.  If a particular counters is not supported,
1021  * the appropriate argument is set to UINT64_MAX. */
1022 int
1023 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
1024                          uint64_t *packets, uint64_t *bytes)
1025 {
1026     if (!ofproto->ofproto_class->mirror_get_stats) {
1027         *packets = *bytes = UINT64_MAX;
1028         return EOPNOTSUPP;
1029     }
1030
1031     return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
1032                                                     packets, bytes);
1033 }
1034
1035 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1036  * which all packets are flooded, instead of using MAC learning.  If
1037  * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1038  *
1039  * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1040  * port. */
1041 int
1042 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
1043 {
1044     return (ofproto->ofproto_class->set_flood_vlans
1045             ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
1046             : EOPNOTSUPP);
1047 }
1048
1049 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1050  * output for a mirror. */
1051 bool
1052 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
1053 {
1054     return (ofproto->ofproto_class->is_mirror_output_bundle
1055             ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
1056             : false);
1057 }
1058 \f
1059 /* Configuration of OpenFlow tables. */
1060
1061 /* Returns the number of OpenFlow tables in 'ofproto'. */
1062 int
1063 ofproto_get_n_tables(const struct ofproto *ofproto)
1064 {
1065     return ofproto->n_tables;
1066 }
1067
1068 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1069  * settings from 's'.  'table_id' must be in the range 0 through the number of
1070  * OpenFlow tables in 'ofproto' minus 1, inclusive.
1071  *
1072  * For read-only tables, only the name may be configured. */
1073 void
1074 ofproto_configure_table(struct ofproto *ofproto, int table_id,
1075                         const struct ofproto_table_settings *s)
1076 {
1077     struct oftable *table;
1078
1079     ovs_assert(table_id >= 0 && table_id < ofproto->n_tables);
1080     table = &ofproto->tables[table_id];
1081
1082     oftable_set_name(table, s->name);
1083
1084     if (table->flags & OFTABLE_READONLY) {
1085         return;
1086     }
1087
1088     if (s->groups) {
1089         oftable_enable_eviction(table, s->groups, s->n_groups);
1090     } else {
1091         oftable_disable_eviction(table);
1092     }
1093
1094     table->max_flows = s->max_flows;
1095     ovs_rwlock_rdlock(&table->cls.rwlock);
1096     if (classifier_count(&table->cls) > table->max_flows
1097         && table->eviction_fields) {
1098         /* 'table' contains more flows than allowed.  We might not be able to
1099          * evict them right away because of the asynchronous nature of flow
1100          * table changes.  Schedule eviction for later. */
1101         switch (ofproto->state) {
1102         case S_OPENFLOW:
1103             ofproto->state = S_EVICT;
1104             break;
1105         case S_EVICT:
1106         case S_FLUSH:
1107             /* We're already deleting flows, nothing more to do. */
1108             break;
1109         }
1110     }
1111     ovs_rwlock_unlock(&table->cls.rwlock);
1112 }
1113 \f
1114 bool
1115 ofproto_has_snoops(const struct ofproto *ofproto)
1116 {
1117     return connmgr_has_snoops(ofproto->connmgr);
1118 }
1119
1120 void
1121 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
1122 {
1123     connmgr_get_snoops(ofproto->connmgr, snoops);
1124 }
1125
1126 static void
1127 ofproto_rule_delete__(struct ofproto *ofproto, struct rule *rule,
1128                       uint8_t reason)
1129     OVS_REQUIRES(ofproto_mutex)
1130 {
1131     struct ofopgroup *group;
1132
1133     ovs_assert(!rule->pending);
1134
1135     group = ofopgroup_create_unattached(ofproto);
1136     delete_flow__(rule, group, reason);
1137     ofopgroup_submit(group);
1138 }
1139
1140 /* Deletes 'rule' from 'cls' within 'ofproto'.
1141  *
1142  * Within an ofproto implementation, this function allows an ofproto
1143  * implementation to destroy any rules that remain when its ->destruct()
1144  * function is called.  This function is not suitable for use elsewhere in an
1145  * ofproto implementation.
1146  *
1147  * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1148  * Cycle" in ofproto-provider.h. */
1149 void
1150 ofproto_rule_delete(struct ofproto *ofproto, struct rule *rule)
1151     OVS_EXCLUDED(ofproto_mutex)
1152 {
1153     struct ofopgroup *group;
1154
1155     ovs_mutex_lock(&ofproto_mutex);
1156     ovs_assert(!rule->pending);
1157
1158     group = ofopgroup_create_unattached(ofproto);
1159     ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1160     oftable_remove_rule__(ofproto, rule);
1161     ofproto->ofproto_class->rule_delete(rule);
1162     ofopgroup_submit(group);
1163
1164     ovs_mutex_unlock(&ofproto_mutex);
1165 }
1166
1167 static void
1168 ofproto_flush__(struct ofproto *ofproto)
1169     OVS_EXCLUDED(ofproto_mutex)
1170 {
1171     struct oftable *table;
1172
1173     if (ofproto->ofproto_class->flush) {
1174         ofproto->ofproto_class->flush(ofproto);
1175     }
1176
1177     ovs_mutex_lock(&ofproto_mutex);
1178     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1179         struct rule *rule, *next_rule;
1180         struct cls_cursor cursor;
1181
1182         if (table->flags & OFTABLE_HIDDEN) {
1183             continue;
1184         }
1185
1186         ovs_rwlock_rdlock(&table->cls.rwlock);
1187         cls_cursor_init(&cursor, &table->cls, NULL);
1188         ovs_rwlock_unlock(&table->cls.rwlock);
1189         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1190             if (!rule->pending) {
1191                 ofproto_rule_delete__(ofproto, rule, OFPRR_DELETE);
1192             }
1193         }
1194     }
1195     ovs_mutex_unlock(&ofproto_mutex);
1196 }
1197
1198 static void
1199 ofproto_destroy__(struct ofproto *ofproto)
1200     OVS_EXCLUDED(ofproto_mutex)
1201 {
1202     struct oftable *table;
1203
1204     ovs_assert(list_is_empty(&ofproto->pending));
1205
1206     destroy_rule_executes(ofproto);
1207     guarded_list_destroy(&ofproto->rule_executes);
1208
1209     connmgr_destroy(ofproto->connmgr);
1210
1211     hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1212     free(ofproto->name);
1213     free(ofproto->type);
1214     free(ofproto->mfr_desc);
1215     free(ofproto->hw_desc);
1216     free(ofproto->sw_desc);
1217     free(ofproto->serial_desc);
1218     free(ofproto->dp_desc);
1219     hmap_destroy(&ofproto->ports);
1220     shash_destroy(&ofproto->port_by_name);
1221     bitmap_free(ofproto->ofp_port_ids);
1222     simap_destroy(&ofproto->ofp_requests);
1223
1224     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1225         oftable_destroy(table);
1226     }
1227     free(ofproto->tables);
1228
1229     hmap_destroy(&ofproto->deletions);
1230
1231     free(ofproto->vlan_bitmap);
1232
1233     ofproto->ofproto_class->dealloc(ofproto);
1234 }
1235
1236 void
1237 ofproto_destroy(struct ofproto *p)
1238     OVS_EXCLUDED(ofproto_mutex)
1239 {
1240     struct ofport *ofport, *next_ofport;
1241
1242     if (!p) {
1243         return;
1244     }
1245
1246     if (p->meters) {
1247         meter_delete(p, 1, p->meter_features.max_meters);
1248         p->meter_features.max_meters = 0;
1249         free(p->meters);
1250         p->meters = NULL;
1251     }
1252
1253     ofproto_flush__(p);
1254     HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1255         ofport_destroy(ofport);
1256     }
1257
1258     p->ofproto_class->destruct(p);
1259     ofproto_destroy__(p);
1260 }
1261
1262 /* Destroys the datapath with the respective 'name' and 'type'.  With the Linux
1263  * kernel datapath, for example, this destroys the datapath in the kernel, and
1264  * with the netdev-based datapath, it tears down the data structures that
1265  * represent the datapath.
1266  *
1267  * The datapath should not be currently open as an ofproto. */
1268 int
1269 ofproto_delete(const char *name, const char *type)
1270 {
1271     const struct ofproto_class *class = ofproto_class_find__(type);
1272     return (!class ? EAFNOSUPPORT
1273             : !class->del ? EACCES
1274             : class->del(type, name));
1275 }
1276
1277 static void
1278 process_port_change(struct ofproto *ofproto, int error, char *devname)
1279 {
1280     if (error == ENOBUFS) {
1281         reinit_ports(ofproto);
1282     } else if (!error) {
1283         update_port(ofproto, devname);
1284         free(devname);
1285     }
1286 }
1287
1288 int
1289 ofproto_type_run(const char *datapath_type)
1290 {
1291     const struct ofproto_class *class;
1292     int error;
1293
1294     datapath_type = ofproto_normalize_type(datapath_type);
1295     class = ofproto_class_find__(datapath_type);
1296
1297     error = class->type_run ? class->type_run(datapath_type) : 0;
1298     if (error && error != EAGAIN) {
1299         VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1300                     datapath_type, ovs_strerror(error));
1301     }
1302     return error;
1303 }
1304
1305 int
1306 ofproto_type_run_fast(const char *datapath_type)
1307 {
1308     const struct ofproto_class *class;
1309     int error;
1310
1311     datapath_type = ofproto_normalize_type(datapath_type);
1312     class = ofproto_class_find__(datapath_type);
1313
1314     error = class->type_run_fast ? class->type_run_fast(datapath_type) : 0;
1315     if (error && error != EAGAIN) {
1316         VLOG_ERR_RL(&rl, "%s: type_run_fast failed (%s)",
1317                     datapath_type, ovs_strerror(error));
1318     }
1319     return error;
1320 }
1321
1322 void
1323 ofproto_type_wait(const char *datapath_type)
1324 {
1325     const struct ofproto_class *class;
1326
1327     datapath_type = ofproto_normalize_type(datapath_type);
1328     class = ofproto_class_find__(datapath_type);
1329
1330     if (class->type_wait) {
1331         class->type_wait(datapath_type);
1332     }
1333 }
1334
1335 static bool
1336 any_pending_ops(const struct ofproto *p)
1337     OVS_EXCLUDED(ofproto_mutex)
1338 {
1339     bool b;
1340
1341     ovs_mutex_lock(&ofproto_mutex);
1342     b = !list_is_empty(&p->pending);
1343     ovs_mutex_unlock(&ofproto_mutex);
1344
1345     return b;
1346 }
1347
1348 int
1349 ofproto_run(struct ofproto *p)
1350 {
1351     struct sset changed_netdevs;
1352     const char *changed_netdev;
1353     struct ofport *ofport;
1354     int error;
1355
1356     error = p->ofproto_class->run(p);
1357     if (error && error != EAGAIN) {
1358         VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, ovs_strerror(error));
1359     }
1360
1361     run_rule_executes(p);
1362
1363     /* Restore the eviction group heap invariant occasionally. */
1364     if (p->eviction_group_timer < time_msec()) {
1365         size_t i;
1366
1367         p->eviction_group_timer = time_msec() + 1000;
1368
1369         for (i = 0; i < p->n_tables; i++) {
1370             struct oftable *table = &p->tables[i];
1371             struct eviction_group *evg;
1372             struct cls_cursor cursor;
1373             struct rule *rule;
1374
1375             if (!table->eviction_fields) {
1376                 continue;
1377             }
1378
1379             ovs_mutex_lock(&ofproto_mutex);
1380             HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
1381                 heap_rebuild(&evg->rules);
1382             }
1383
1384             ovs_rwlock_rdlock(&table->cls.rwlock);
1385             cls_cursor_init(&cursor, &table->cls, NULL);
1386             CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1387                 if (!rule->eviction_group
1388                     && (rule->idle_timeout || rule->hard_timeout)) {
1389                     eviction_group_add_rule(rule);
1390                 }
1391             }
1392             ovs_rwlock_unlock(&table->cls.rwlock);
1393             ovs_mutex_unlock(&ofproto_mutex);
1394         }
1395     }
1396
1397     if (p->ofproto_class->port_poll) {
1398         char *devname;
1399
1400         while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1401             process_port_change(p, error, devname);
1402         }
1403     }
1404
1405     /* Update OpenFlow port status for any port whose netdev has changed.
1406      *
1407      * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1408      * destroyed, so it's not safe to update ports directly from the
1409      * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE.  Instead, we
1410      * need this two-phase approach. */
1411     sset_init(&changed_netdevs);
1412     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1413         unsigned int change_seq = netdev_change_seq(ofport->netdev);
1414         if (ofport->change_seq != change_seq) {
1415             ofport->change_seq = change_seq;
1416             sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1417         }
1418     }
1419     SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1420         update_port(p, changed_netdev);
1421     }
1422     sset_destroy(&changed_netdevs);
1423
1424     switch (p->state) {
1425     case S_OPENFLOW:
1426         connmgr_run(p->connmgr, handle_openflow);
1427         break;
1428
1429     case S_EVICT:
1430         connmgr_run(p->connmgr, NULL);
1431         ofproto_evict(p);
1432         if (!any_pending_ops(p)) {
1433             p->state = S_OPENFLOW;
1434         }
1435         break;
1436
1437     case S_FLUSH:
1438         connmgr_run(p->connmgr, NULL);
1439         ofproto_flush__(p);
1440         if (!any_pending_ops(p)) {
1441             connmgr_flushed(p->connmgr);
1442             p->state = S_OPENFLOW;
1443         }
1444         break;
1445
1446     default:
1447         NOT_REACHED();
1448     }
1449
1450     if (time_msec() >= p->next_op_report) {
1451         long long int ago = (time_msec() - p->first_op) / 1000;
1452         long long int interval = (p->last_op - p->first_op) / 1000;
1453         struct ds s;
1454
1455         ds_init(&s);
1456         ds_put_format(&s, "%d flow_mods ",
1457                       p->n_add + p->n_delete + p->n_modify);
1458         if (interval == ago) {
1459             ds_put_format(&s, "in the last %lld s", ago);
1460         } else if (interval) {
1461             ds_put_format(&s, "in the %lld s starting %lld s ago",
1462                           interval, ago);
1463         } else {
1464             ds_put_format(&s, "%lld s ago", ago);
1465         }
1466
1467         ds_put_cstr(&s, " (");
1468         if (p->n_add) {
1469             ds_put_format(&s, "%d adds, ", p->n_add);
1470         }
1471         if (p->n_delete) {
1472             ds_put_format(&s, "%d deletes, ", p->n_delete);
1473         }
1474         if (p->n_modify) {
1475             ds_put_format(&s, "%d modifications, ", p->n_modify);
1476         }
1477         s.length -= 2;
1478         ds_put_char(&s, ')');
1479
1480         VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1481         ds_destroy(&s);
1482
1483         p->n_add = p->n_delete = p->n_modify = 0;
1484         p->next_op_report = LLONG_MAX;
1485     }
1486
1487     return error;
1488 }
1489
1490 /* Performs periodic activity required by 'ofproto' that needs to be done
1491  * with the least possible latency.
1492  *
1493  * It makes sense to call this function a couple of times per poll loop, to
1494  * provide a significant performance boost on some benchmarks with the
1495  * ofproto-dpif implementation. */
1496 int
1497 ofproto_run_fast(struct ofproto *p)
1498 {
1499     int error;
1500
1501     error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1502     if (error && error != EAGAIN) {
1503         VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1504                     p->name, ovs_strerror(error));
1505     }
1506     return error;
1507 }
1508
1509 void
1510 ofproto_wait(struct ofproto *p)
1511 {
1512     struct ofport *ofport;
1513
1514     p->ofproto_class->wait(p);
1515     if (p->ofproto_class->port_poll_wait) {
1516         p->ofproto_class->port_poll_wait(p);
1517     }
1518
1519     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1520         if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1521             poll_immediate_wake();
1522         }
1523     }
1524
1525     switch (p->state) {
1526     case S_OPENFLOW:
1527         connmgr_wait(p->connmgr, true);
1528         break;
1529
1530     case S_EVICT:
1531     case S_FLUSH:
1532         connmgr_wait(p->connmgr, false);
1533         if (!any_pending_ops(p)) {
1534             poll_immediate_wake();
1535         }
1536         break;
1537     }
1538 }
1539
1540 bool
1541 ofproto_is_alive(const struct ofproto *p)
1542 {
1543     return connmgr_has_controllers(p->connmgr);
1544 }
1545
1546 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1547  * memory_report(). */
1548 void
1549 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1550 {
1551     const struct oftable *table;
1552     unsigned int n_rules;
1553
1554     simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1555
1556     ovs_mutex_lock(&ofproto_mutex);
1557     simap_increase(usage, "ops",
1558                    ofproto->n_pending + hmap_count(&ofproto->deletions));
1559     ovs_mutex_unlock(&ofproto_mutex);
1560
1561     n_rules = 0;
1562     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1563         ovs_rwlock_rdlock(&table->cls.rwlock);
1564         n_rules += classifier_count(&table->cls);
1565         ovs_rwlock_unlock(&table->cls.rwlock);
1566     }
1567     simap_increase(usage, "rules", n_rules);
1568
1569     if (ofproto->ofproto_class->get_memory_usage) {
1570         ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1571     }
1572
1573     connmgr_get_memory_usage(ofproto->connmgr, usage);
1574 }
1575
1576 void
1577 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1578                                     struct shash *info)
1579 {
1580     connmgr_get_controller_info(ofproto->connmgr, info);
1581 }
1582
1583 void
1584 ofproto_free_ofproto_controller_info(struct shash *info)
1585 {
1586     connmgr_free_controller_info(info);
1587 }
1588
1589 /* Makes a deep copy of 'old' into 'port'. */
1590 void
1591 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1592 {
1593     port->name = xstrdup(old->name);
1594     port->type = xstrdup(old->type);
1595     port->ofp_port = old->ofp_port;
1596 }
1597
1598 /* Frees memory allocated to members of 'ofproto_port'.
1599  *
1600  * Do not call this function on an ofproto_port obtained from
1601  * ofproto_port_dump_next(): that function retains ownership of the data in the
1602  * ofproto_port. */
1603 void
1604 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1605 {
1606     free(ofproto_port->name);
1607     free(ofproto_port->type);
1608 }
1609
1610 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1611  *
1612  * This function provides no status indication.  An error status for the entire
1613  * dump operation is provided when it is completed by calling
1614  * ofproto_port_dump_done().
1615  */
1616 void
1617 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1618                         const struct ofproto *ofproto)
1619 {
1620     dump->ofproto = ofproto;
1621     dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1622                                                           &dump->state);
1623 }
1624
1625 /* Attempts to retrieve another port from 'dump', which must have been created
1626  * with ofproto_port_dump_start().  On success, stores a new ofproto_port into
1627  * 'port' and returns true.  On failure, returns false.
1628  *
1629  * Failure might indicate an actual error or merely that the last port has been
1630  * dumped.  An error status for the entire dump operation is provided when it
1631  * is completed by calling ofproto_port_dump_done().
1632  *
1633  * The ofproto owns the data stored in 'port'.  It will remain valid until at
1634  * least the next time 'dump' is passed to ofproto_port_dump_next() or
1635  * ofproto_port_dump_done(). */
1636 bool
1637 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1638                        struct ofproto_port *port)
1639 {
1640     const struct ofproto *ofproto = dump->ofproto;
1641
1642     if (dump->error) {
1643         return false;
1644     }
1645
1646     dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1647                                                          port);
1648     if (dump->error) {
1649         ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1650         return false;
1651     }
1652     return true;
1653 }
1654
1655 /* Completes port table dump operation 'dump', which must have been created
1656  * with ofproto_port_dump_start().  Returns 0 if the dump operation was
1657  * error-free, otherwise a positive errno value describing the problem. */
1658 int
1659 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1660 {
1661     const struct ofproto *ofproto = dump->ofproto;
1662     if (!dump->error) {
1663         dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1664                                                              dump->state);
1665     }
1666     return dump->error == EOF ? 0 : dump->error;
1667 }
1668
1669 /* Returns the type to pass to netdev_open() when a datapath of type
1670  * 'datapath_type' has a port of type 'port_type', for a few special
1671  * cases when a netdev type differs from a port type.  For example, when
1672  * using the userspace datapath, a port of type "internal" needs to be
1673  * opened as "tap".
1674  *
1675  * Returns either 'type' itself or a string literal, which must not be
1676  * freed. */
1677 const char *
1678 ofproto_port_open_type(const char *datapath_type, const char *port_type)
1679 {
1680     const struct ofproto_class *class;
1681
1682     datapath_type = ofproto_normalize_type(datapath_type);
1683     class = ofproto_class_find__(datapath_type);
1684     if (!class) {
1685         return port_type;
1686     }
1687
1688     return (class->port_open_type
1689             ? class->port_open_type(datapath_type, port_type)
1690             : port_type);
1691 }
1692
1693 /* Attempts to add 'netdev' as a port on 'ofproto'.  If 'ofp_portp' is
1694  * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1695  * the port's OpenFlow port number.
1696  *
1697  * If successful, returns 0 and sets '*ofp_portp' to the new port's
1698  * OpenFlow port number (if 'ofp_portp' is non-null).  On failure,
1699  * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1700  * 'ofp_portp' is non-null). */
1701 int
1702 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1703                  ofp_port_t *ofp_portp)
1704 {
1705     ofp_port_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1706     int error;
1707
1708     error = ofproto->ofproto_class->port_add(ofproto, netdev);
1709     if (!error) {
1710         const char *netdev_name = netdev_get_name(netdev);
1711
1712         simap_put(&ofproto->ofp_requests, netdev_name,
1713                   ofp_to_u16(ofp_port));
1714         update_port(ofproto, netdev_name);
1715     }
1716     if (ofp_portp) {
1717         struct ofproto_port ofproto_port;
1718
1719         ofproto_port_query_by_name(ofproto, netdev_get_name(netdev),
1720                                    &ofproto_port);
1721         *ofp_portp = error ? OFPP_NONE : ofproto_port.ofp_port;
1722         ofproto_port_destroy(&ofproto_port);
1723     }
1724     return error;
1725 }
1726
1727 /* Looks up a port named 'devname' in 'ofproto'.  On success, returns 0 and
1728  * initializes '*port' appropriately; on failure, returns a positive errno
1729  * value.
1730  *
1731  * The caller owns the data in 'ofproto_port' and must free it with
1732  * ofproto_port_destroy() when it is no longer needed. */
1733 int
1734 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1735                            struct ofproto_port *port)
1736 {
1737     int error;
1738
1739     error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1740     if (error) {
1741         memset(port, 0, sizeof *port);
1742     }
1743     return error;
1744 }
1745
1746 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1747  * Returns 0 if successful, otherwise a positive errno. */
1748 int
1749 ofproto_port_del(struct ofproto *ofproto, ofp_port_t ofp_port)
1750 {
1751     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1752     const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1753     struct simap_node *ofp_request_node;
1754     int error;
1755
1756     ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1757     if (ofp_request_node) {
1758         simap_delete(&ofproto->ofp_requests, ofp_request_node);
1759     }
1760
1761     error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1762     if (!error && ofport) {
1763         /* 'name' is the netdev's name and update_port() is going to close the
1764          * netdev.  Just in case update_port() refers to 'name' after it
1765          * destroys 'ofport', make a copy of it around the update_port()
1766          * call. */
1767         char *devname = xstrdup(name);
1768         update_port(ofproto, devname);
1769         free(devname);
1770     }
1771     return error;
1772 }
1773
1774 static int
1775 simple_flow_mod(struct ofproto *ofproto,
1776                 const struct match *match, unsigned int priority,
1777                 const struct ofpact *ofpacts, size_t ofpacts_len,
1778                 enum ofp_flow_mod_command command)
1779 {
1780     struct ofputil_flow_mod fm;
1781
1782     memset(&fm, 0, sizeof fm);
1783     fm.match = *match;
1784     fm.priority = priority;
1785     fm.cookie = 0;
1786     fm.new_cookie = 0;
1787     fm.modify_cookie = false;
1788     fm.table_id = 0;
1789     fm.command = command;
1790     fm.idle_timeout = 0;
1791     fm.hard_timeout = 0;
1792     fm.buffer_id = UINT32_MAX;
1793     fm.out_port = OFPP_ANY;
1794     fm.flags = 0;
1795     fm.ofpacts = CONST_CAST(struct ofpact *, ofpacts);
1796     fm.ofpacts_len = ofpacts_len;
1797
1798     return handle_flow_mod__(ofproto, NULL, &fm, NULL);
1799 }
1800
1801 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1802  * performs the 'n_actions' actions in 'actions'.  The new flow will not
1803  * timeout.
1804  *
1805  * If cls_rule->priority is in the range of priorities supported by OpenFlow
1806  * (0...65535, inclusive) then the flow will be visible to OpenFlow
1807  * controllers; otherwise, it will be hidden.
1808  *
1809  * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1810  *
1811  * This is a helper function for in-band control and fail-open. */
1812 void
1813 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1814                  unsigned int priority,
1815                  const struct ofpact *ofpacts, size_t ofpacts_len)
1816     OVS_EXCLUDED(ofproto_mutex)
1817 {
1818     const struct rule *rule;
1819     bool must_add;
1820
1821     /* First do a cheap check whether the rule we're looking for already exists
1822      * with the actions that we want.  If it does, then we're done. */
1823     ovs_rwlock_rdlock(&ofproto->tables[0].cls.rwlock);
1824     rule = rule_from_cls_rule(classifier_find_match_exactly(
1825                                   &ofproto->tables[0].cls, match, priority));
1826     if (rule) {
1827         ovs_mutex_lock(&rule->mutex);
1828         must_add = !ofpacts_equal(rule->actions->ofpacts,
1829                                   rule->actions->ofpacts_len,
1830                                   ofpacts, ofpacts_len);
1831         ovs_mutex_unlock(&rule->mutex);
1832     } else {
1833         must_add = true;
1834     }
1835     ovs_rwlock_unlock(&ofproto->tables[0].cls.rwlock);
1836
1837     /* If there's no such rule or the rule doesn't have the actions we want,
1838      * fall back to a executing a full flow mod.  We can't optimize this at
1839      * all because we didn't take enough locks above to ensure that the flow
1840      * table didn't already change beneath us.  */
1841     if (must_add) {
1842         simple_flow_mod(ofproto, match, priority, ofpacts, ofpacts_len,
1843                         OFPFC_MODIFY_STRICT);
1844     }
1845 }
1846
1847 /* Executes the flow modification specified in 'fm'.  Returns 0 on success, an
1848  * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1849  * operation cannot be initiated now but may be retried later.
1850  *
1851  * This is a helper function for in-band control and fail-open and the "learn"
1852  * action. */
1853 int
1854 ofproto_flow_mod(struct ofproto *ofproto, struct ofputil_flow_mod *fm)
1855     OVS_EXCLUDED(ofproto_mutex)
1856 {
1857     return handle_flow_mod__(ofproto, NULL, fm, NULL);
1858 }
1859
1860 /* Searches for a rule with matching criteria exactly equal to 'target' in
1861  * ofproto's table 0 and, if it finds one, deletes it.
1862  *
1863  * This is a helper function for in-band control and fail-open. */
1864 bool
1865 ofproto_delete_flow(struct ofproto *ofproto,
1866                     const struct match *target, unsigned int priority)
1867     OVS_EXCLUDED(ofproto_mutex)
1868 {
1869     struct classifier *cls = &ofproto->tables[0].cls;
1870     struct rule *rule;
1871
1872     /* First do a cheap check whether the rule we're looking for has already
1873      * been deleted.  If so, then we're done. */
1874     ovs_rwlock_rdlock(&cls->rwlock);
1875     rule = rule_from_cls_rule(classifier_find_match_exactly(cls, target,
1876                                                             priority));
1877     ovs_rwlock_unlock(&cls->rwlock);
1878     if (!rule) {
1879         return true;
1880     }
1881
1882     /* Fall back to a executing a full flow mod.  We can't optimize this at all
1883      * because we didn't take enough locks above to ensure that the flow table
1884      * didn't already change beneath us.  */
1885     return simple_flow_mod(ofproto, target, priority, NULL, 0,
1886                            OFPFC_DELETE_STRICT) != OFPROTO_POSTPONE;
1887 }
1888
1889 /* Starts the process of deleting all of the flows from all of ofproto's flow
1890  * tables and then reintroducing the flows required by in-band control and
1891  * fail-open.  The process will complete in a later call to ofproto_run(). */
1892 void
1893 ofproto_flush_flows(struct ofproto *ofproto)
1894 {
1895     COVERAGE_INC(ofproto_flush);
1896     ofproto->state = S_FLUSH;
1897 }
1898 \f
1899 static void
1900 reinit_ports(struct ofproto *p)
1901 {
1902     struct ofproto_port_dump dump;
1903     struct sset devnames;
1904     struct ofport *ofport;
1905     struct ofproto_port ofproto_port;
1906     const char *devname;
1907
1908     COVERAGE_INC(ofproto_reinit_ports);
1909
1910     sset_init(&devnames);
1911     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1912         sset_add(&devnames, netdev_get_name(ofport->netdev));
1913     }
1914     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1915         sset_add(&devnames, ofproto_port.name);
1916     }
1917
1918     SSET_FOR_EACH (devname, &devnames) {
1919         update_port(p, devname);
1920     }
1921     sset_destroy(&devnames);
1922 }
1923
1924 static ofp_port_t
1925 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
1926 {
1927     uint16_t port_idx;
1928
1929     port_idx = simap_get(&ofproto->ofp_requests, netdev_name);
1930     port_idx = port_idx ? port_idx : UINT16_MAX;
1931
1932     if (port_idx >= ofproto->max_ports
1933         || bitmap_is_set(ofproto->ofp_port_ids, port_idx)) {
1934         uint16_t end_port_no = ofproto->alloc_port_no;
1935
1936         /* Search for a free OpenFlow port number.  We try not to
1937          * immediately reuse them to prevent problems due to old
1938          * flows. */
1939         for (;;) {
1940             if (++ofproto->alloc_port_no >= ofproto->max_ports) {
1941                 ofproto->alloc_port_no = 0;
1942             }
1943             if (!bitmap_is_set(ofproto->ofp_port_ids,
1944                                ofproto->alloc_port_no)) {
1945                 port_idx = ofproto->alloc_port_no;
1946                 break;
1947             }
1948             if (ofproto->alloc_port_no == end_port_no) {
1949                 return OFPP_NONE;
1950             }
1951         }
1952     }
1953     bitmap_set1(ofproto->ofp_port_ids, port_idx);
1954     return u16_to_ofp(port_idx);
1955 }
1956
1957 static void
1958 dealloc_ofp_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
1959 {
1960     if (ofp_to_u16(ofp_port) < ofproto->max_ports) {
1961         bitmap_set0(ofproto->ofp_port_ids, ofp_to_u16(ofp_port));
1962     }
1963 }
1964
1965 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1966  * pointer if the netdev cannot be opened.  On success, also fills in
1967  * 'opp'.  */
1968 static struct netdev *
1969 ofport_open(struct ofproto *ofproto,
1970             struct ofproto_port *ofproto_port,
1971             struct ofputil_phy_port *pp)
1972 {
1973     enum netdev_flags flags;
1974     struct netdev *netdev;
1975     int error;
1976
1977     error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1978     if (error) {
1979         VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1980                      "cannot be opened (%s)",
1981                      ofproto->name,
1982                      ofproto_port->name, ofproto_port->ofp_port,
1983                      ofproto_port->name, ovs_strerror(error));
1984         return NULL;
1985     }
1986
1987     if (ofproto_port->ofp_port == OFPP_NONE) {
1988         if (!strcmp(ofproto->name, ofproto_port->name)) {
1989             ofproto_port->ofp_port = OFPP_LOCAL;
1990         } else {
1991             ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1992                                                     ofproto_port->name);
1993         }
1994     }
1995     pp->port_no = ofproto_port->ofp_port;
1996     netdev_get_etheraddr(netdev, pp->hw_addr);
1997     ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1998     netdev_get_flags(netdev, &flags);
1999     pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
2000     pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
2001     netdev_get_features(netdev, &pp->curr, &pp->advertised,
2002                         &pp->supported, &pp->peer);
2003     pp->curr_speed = netdev_features_to_bps(pp->curr, 0) / 1000;
2004     pp->max_speed = netdev_features_to_bps(pp->supported, 0) / 1000;
2005
2006     return netdev;
2007 }
2008
2009 /* Returns true if most fields of 'a' and 'b' are equal.  Differences in name,
2010  * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
2011  * disregarded. */
2012 static bool
2013 ofport_equal(const struct ofputil_phy_port *a,
2014              const struct ofputil_phy_port *b)
2015 {
2016     return (eth_addr_equals(a->hw_addr, b->hw_addr)
2017             && a->state == b->state
2018             && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
2019             && a->curr == b->curr
2020             && a->advertised == b->advertised
2021             && a->supported == b->supported
2022             && a->peer == b->peer
2023             && a->curr_speed == b->curr_speed
2024             && a->max_speed == b->max_speed);
2025 }
2026
2027 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2028  * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2029  * one with the same name or port number). */
2030 static void
2031 ofport_install(struct ofproto *p,
2032                struct netdev *netdev, const struct ofputil_phy_port *pp)
2033 {
2034     const char *netdev_name = netdev_get_name(netdev);
2035     struct ofport *ofport;
2036     int error;
2037
2038     /* Create ofport. */
2039     ofport = p->ofproto_class->port_alloc();
2040     if (!ofport) {
2041         error = ENOMEM;
2042         goto error;
2043     }
2044     ofport->ofproto = p;
2045     ofport->netdev = netdev;
2046     ofport->change_seq = netdev_change_seq(netdev);
2047     ofport->pp = *pp;
2048     ofport->ofp_port = pp->port_no;
2049     ofport->created = time_msec();
2050
2051     /* Add port to 'p'. */
2052     hmap_insert(&p->ports, &ofport->hmap_node,
2053                 hash_ofp_port(ofport->ofp_port));
2054     shash_add(&p->port_by_name, netdev_name, ofport);
2055
2056     update_mtu(p, ofport);
2057
2058     /* Let the ofproto_class initialize its private data. */
2059     error = p->ofproto_class->port_construct(ofport);
2060     if (error) {
2061         goto error;
2062     }
2063     connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
2064     return;
2065
2066 error:
2067     VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
2068                  p->name, netdev_name, ovs_strerror(error));
2069     if (ofport) {
2070         ofport_destroy__(ofport);
2071     } else {
2072         netdev_close(netdev);
2073     }
2074 }
2075
2076 /* Removes 'ofport' from 'p' and destroys it. */
2077 static void
2078 ofport_remove(struct ofport *ofport)
2079 {
2080     connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
2081                              OFPPR_DELETE);
2082     ofport_destroy(ofport);
2083 }
2084
2085 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2086  * destroys it. */
2087 static void
2088 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
2089 {
2090     struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
2091     if (port) {
2092         ofport_remove(port);
2093     }
2094 }
2095
2096 /* Updates 'port' with new 'pp' description.
2097  *
2098  * Does not handle a name or port number change.  The caller must implement
2099  * such a change as a delete followed by an add.  */
2100 static void
2101 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
2102 {
2103     memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2104     port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
2105                         | (pp->config & OFPUTIL_PC_PORT_DOWN));
2106     port->pp.state = ((port->pp.state & ~OFPUTIL_PS_LINK_DOWN)
2107                       | (pp->state & OFPUTIL_PS_LINK_DOWN));
2108     port->pp.curr = pp->curr;
2109     port->pp.advertised = pp->advertised;
2110     port->pp.supported = pp->supported;
2111     port->pp.peer = pp->peer;
2112     port->pp.curr_speed = pp->curr_speed;
2113     port->pp.max_speed = pp->max_speed;
2114
2115     connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
2116 }
2117
2118 /* Update OpenFlow 'state' in 'port' and notify controller. */
2119 void
2120 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
2121 {
2122     if (port->pp.state != state) {
2123         port->pp.state = state;
2124         connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
2125                                  OFPPR_MODIFY);
2126     }
2127 }
2128
2129 void
2130 ofproto_port_unregister(struct ofproto *ofproto, ofp_port_t ofp_port)
2131 {
2132     struct ofport *port = ofproto_get_port(ofproto, ofp_port);
2133     if (port) {
2134         if (port->ofproto->ofproto_class->set_realdev) {
2135             port->ofproto->ofproto_class->set_realdev(port, 0, 0);
2136         }
2137         if (port->ofproto->ofproto_class->set_stp_port) {
2138             port->ofproto->ofproto_class->set_stp_port(port, NULL);
2139         }
2140         if (port->ofproto->ofproto_class->set_cfm) {
2141             port->ofproto->ofproto_class->set_cfm(port, NULL);
2142         }
2143         if (port->ofproto->ofproto_class->bundle_remove) {
2144             port->ofproto->ofproto_class->bundle_remove(port);
2145         }
2146     }
2147 }
2148
2149 static void
2150 ofport_destroy__(struct ofport *port)
2151 {
2152     struct ofproto *ofproto = port->ofproto;
2153     const char *name = netdev_get_name(port->netdev);
2154
2155     hmap_remove(&ofproto->ports, &port->hmap_node);
2156     shash_delete(&ofproto->port_by_name,
2157                  shash_find(&ofproto->port_by_name, name));
2158
2159     netdev_close(port->netdev);
2160     ofproto->ofproto_class->port_dealloc(port);
2161 }
2162
2163 static void
2164 ofport_destroy(struct ofport *port)
2165 {
2166     if (port) {
2167         dealloc_ofp_port(port->ofproto, port->ofp_port);
2168         port->ofproto->ofproto_class->port_destruct(port);
2169         ofport_destroy__(port);
2170      }
2171 }
2172
2173 struct ofport *
2174 ofproto_get_port(const struct ofproto *ofproto, ofp_port_t ofp_port)
2175 {
2176     struct ofport *port;
2177
2178     HMAP_FOR_EACH_IN_BUCKET (port, hmap_node, hash_ofp_port(ofp_port),
2179                              &ofproto->ports) {
2180         if (port->ofp_port == ofp_port) {
2181             return port;
2182         }
2183     }
2184     return NULL;
2185 }
2186
2187 int
2188 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
2189 {
2190     struct ofproto *ofproto = port->ofproto;
2191     int error;
2192
2193     if (ofproto->ofproto_class->port_get_stats) {
2194         error = ofproto->ofproto_class->port_get_stats(port, stats);
2195     } else {
2196         error = EOPNOTSUPP;
2197     }
2198
2199     return error;
2200 }
2201
2202 static void
2203 update_port(struct ofproto *ofproto, const char *name)
2204 {
2205     struct ofproto_port ofproto_port;
2206     struct ofputil_phy_port pp;
2207     struct netdev *netdev;
2208     struct ofport *port;
2209
2210     COVERAGE_INC(ofproto_update_port);
2211
2212     /* Fetch 'name''s location and properties from the datapath. */
2213     netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
2214               ? ofport_open(ofproto, &ofproto_port, &pp)
2215               : NULL);
2216
2217     if (netdev) {
2218         port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
2219         if (port && !strcmp(netdev_get_name(port->netdev), name)) {
2220             struct netdev *old_netdev = port->netdev;
2221
2222             /* 'name' hasn't changed location.  Any properties changed? */
2223             if (!ofport_equal(&port->pp, &pp)) {
2224                 ofport_modified(port, &pp);
2225             }
2226
2227             update_mtu(ofproto, port);
2228
2229             /* Install the newly opened netdev in case it has changed.
2230              * Don't close the old netdev yet in case port_modified has to
2231              * remove a retained reference to it.*/
2232             port->netdev = netdev;
2233             port->change_seq = netdev_change_seq(netdev);
2234
2235             if (port->ofproto->ofproto_class->port_modified) {
2236                 port->ofproto->ofproto_class->port_modified(port);
2237             }
2238
2239             netdev_close(old_netdev);
2240         } else {
2241             /* If 'port' is nonnull then its name differs from 'name' and thus
2242              * we should delete it.  If we think there's a port named 'name'
2243              * then its port number must be wrong now so delete it too. */
2244             if (port) {
2245                 ofport_remove(port);
2246             }
2247             ofport_remove_with_name(ofproto, name);
2248             ofport_install(ofproto, netdev, &pp);
2249         }
2250     } else {
2251         /* Any port named 'name' is gone now. */
2252         ofport_remove_with_name(ofproto, name);
2253     }
2254     ofproto_port_destroy(&ofproto_port);
2255 }
2256
2257 static int
2258 init_ports(struct ofproto *p)
2259 {
2260     struct ofproto_port_dump dump;
2261     struct ofproto_port ofproto_port;
2262     struct shash_node *node, *next;
2263
2264     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
2265         const char *name = ofproto_port.name;
2266
2267         if (shash_find(&p->port_by_name, name)) {
2268             VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
2269                          p->name, name);
2270         } else {
2271             struct ofputil_phy_port pp;
2272             struct netdev *netdev;
2273
2274             /* Check if an OpenFlow port number had been requested. */
2275             node = shash_find(&init_ofp_ports, name);
2276             if (node) {
2277                 const struct iface_hint *iface_hint = node->data;
2278                 simap_put(&p->ofp_requests, name,
2279                           ofp_to_u16(iface_hint->ofp_port));
2280             }
2281
2282             netdev = ofport_open(p, &ofproto_port, &pp);
2283             if (netdev) {
2284                 ofport_install(p, netdev, &pp);
2285                 if (ofp_to_u16(ofproto_port.ofp_port) < p->max_ports) {
2286                     p->alloc_port_no = MAX(p->alloc_port_no,
2287                                            ofp_to_u16(ofproto_port.ofp_port));
2288                 }
2289             }
2290         }
2291     }
2292
2293     SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
2294         struct iface_hint *iface_hint = node->data;
2295
2296         if (!strcmp(iface_hint->br_name, p->name)) {
2297             free(iface_hint->br_name);
2298             free(iface_hint->br_type);
2299             free(iface_hint);
2300             shash_delete(&init_ofp_ports, node);
2301         }
2302     }
2303
2304     return 0;
2305 }
2306
2307 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2308  * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2309 static int
2310 find_min_mtu(struct ofproto *p)
2311 {
2312     struct ofport *ofport;
2313     int mtu = 0;
2314
2315     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2316         struct netdev *netdev = ofport->netdev;
2317         int dev_mtu;
2318
2319         /* Skip any internal ports, since that's what we're trying to
2320          * set. */
2321         if (!strcmp(netdev_get_type(netdev), "internal")) {
2322             continue;
2323         }
2324
2325         if (netdev_get_mtu(netdev, &dev_mtu)) {
2326             continue;
2327         }
2328         if (!mtu || dev_mtu < mtu) {
2329             mtu = dev_mtu;
2330         }
2331     }
2332
2333     return mtu ? mtu: ETH_PAYLOAD_MAX;
2334 }
2335
2336 /* Update MTU of all datapath devices on 'p' to the minimum of the
2337  * non-datapath ports in event of 'port' added or changed. */
2338 static void
2339 update_mtu(struct ofproto *p, struct ofport *port)
2340 {
2341     struct ofport *ofport;
2342     struct netdev *netdev = port->netdev;
2343     int dev_mtu, old_min;
2344
2345     if (netdev_get_mtu(netdev, &dev_mtu)) {
2346         port->mtu = 0;
2347         return;
2348     }
2349     if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2350         if (dev_mtu > p->min_mtu) {
2351            if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2352                dev_mtu = p->min_mtu;
2353            }
2354         }
2355         port->mtu = dev_mtu;
2356         return;
2357     }
2358
2359     /* For non-internal port find new min mtu. */
2360     old_min = p->min_mtu;
2361     port->mtu = dev_mtu;
2362     p->min_mtu = find_min_mtu(p);
2363     if (p->min_mtu == old_min) {
2364         return;
2365     }
2366
2367     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2368         struct netdev *netdev = ofport->netdev;
2369
2370         if (!strcmp(netdev_get_type(netdev), "internal")) {
2371             if (!netdev_set_mtu(netdev, p->min_mtu)) {
2372                 ofport->mtu = p->min_mtu;
2373             }
2374         }
2375     }
2376 }
2377 \f
2378 void
2379 ofproto_rule_ref(struct rule *rule)
2380 {
2381     if (rule) {
2382         unsigned int orig;
2383
2384         atomic_add(&rule->ref_count, 1, &orig);
2385         ovs_assert(orig != 0);
2386     }
2387 }
2388
2389 void
2390 ofproto_rule_unref(struct rule *rule)
2391 {
2392     if (rule) {
2393         unsigned int orig;
2394
2395         atomic_sub(&rule->ref_count, 1, &orig);
2396         if (orig == 1) {
2397             rule->ofproto->ofproto_class->rule_destruct(rule);
2398             ofproto_rule_destroy__(rule);
2399         } else {
2400             ovs_assert(orig != 0);
2401         }
2402     }
2403 }
2404
2405 struct rule_actions *
2406 rule_get_actions(const struct rule *rule)
2407     OVS_EXCLUDED(rule->mutex)
2408 {
2409     struct rule_actions *actions;
2410
2411     ovs_mutex_lock(&rule->mutex);
2412     actions = rule_get_actions__(rule);
2413     ovs_mutex_unlock(&rule->mutex);
2414
2415     return actions;
2416 }
2417
2418 struct rule_actions *
2419 rule_get_actions__(const struct rule *rule)
2420     OVS_REQUIRES(rule->mutex)
2421 {
2422     rule_actions_ref(rule->actions);
2423     return rule->actions;
2424 }
2425
2426 static void
2427 ofproto_rule_destroy__(struct rule *rule)
2428     OVS_NO_THREAD_SAFETY_ANALYSIS
2429 {
2430     cls_rule_destroy(CONST_CAST(struct cls_rule *, &rule->cr));
2431     rule_actions_unref(rule->actions);
2432     ovs_mutex_destroy(&rule->mutex);
2433     rule->ofproto->ofproto_class->rule_dealloc(rule);
2434 }
2435
2436 /* Creates and returns a new 'struct rule_actions', with a ref_count of 1,
2437  * whose actions are a copy of from the 'ofpacts_len' bytes of 'ofpacts'. */
2438 struct rule_actions *
2439 rule_actions_create(const struct ofpact *ofpacts, size_t ofpacts_len)
2440 {
2441     struct rule_actions *actions;
2442
2443     actions = xmalloc(sizeof *actions);
2444     atomic_init(&actions->ref_count, 1);
2445     actions->ofpacts = xmemdup(ofpacts, ofpacts_len);
2446     actions->ofpacts_len = ofpacts_len;
2447     actions->meter_id = ofpacts_get_meter(ofpacts, ofpacts_len);
2448     return actions;
2449 }
2450
2451 /* Increments 'actions''s ref_count. */
2452 void
2453 rule_actions_ref(struct rule_actions *actions)
2454 {
2455     if (actions) {
2456         unsigned int orig;
2457
2458         atomic_add(&actions->ref_count, 1, &orig);
2459         ovs_assert(orig != 0);
2460     }
2461 }
2462
2463 /* Decrements 'actions''s ref_count and frees 'actions' if the ref_count
2464  * reaches 0. */
2465 void
2466 rule_actions_unref(struct rule_actions *actions)
2467 {
2468     if (actions) {
2469         unsigned int orig;
2470
2471         atomic_sub(&actions->ref_count, 1, &orig);
2472         if (orig == 1) {
2473             free(actions->ofpacts);
2474             free(actions);
2475         } else {
2476             ovs_assert(orig != 0);
2477         }
2478     }
2479 }
2480
2481 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2482  * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2483 static bool
2484 ofproto_rule_has_out_port(const struct rule *rule, ofp_port_t port)
2485     OVS_REQUIRES(ofproto_mutex)
2486 {
2487     return (port == OFPP_ANY
2488             || ofpacts_output_to_port(rule->actions->ofpacts,
2489                                       rule->actions->ofpacts_len, port));
2490 }
2491
2492 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2493  * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2494 bool
2495 ofoperation_has_out_port(const struct ofoperation *op, ofp_port_t out_port)
2496     OVS_REQUIRES(ofproto_mutex)
2497 {
2498     if (ofproto_rule_has_out_port(op->rule, out_port)) {
2499         return true;
2500     }
2501
2502     switch (op->type) {
2503     case OFOPERATION_ADD:
2504     case OFOPERATION_DELETE:
2505         return false;
2506
2507     case OFOPERATION_MODIFY:
2508     case OFOPERATION_REPLACE:
2509         return ofpacts_output_to_port(op->actions->ofpacts,
2510                                       op->actions->ofpacts_len, out_port);
2511     }
2512
2513     NOT_REACHED();
2514 }
2515
2516 static void
2517 rule_execute_destroy(struct rule_execute *e)
2518 {
2519     ofproto_rule_unref(e->rule);
2520     list_remove(&e->list_node);
2521     free(e);
2522 }
2523
2524 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2525  * by passing them to the ofproto provider. */
2526 static void
2527 run_rule_executes(struct ofproto *ofproto)
2528     OVS_EXCLUDED(ofproto_mutex)
2529 {
2530     struct rule_execute *e, *next;
2531     struct list executes;
2532
2533     guarded_list_pop_all(&ofproto->rule_executes, &executes);
2534     LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2535         union flow_in_port in_port_;
2536         struct flow flow;
2537
2538         in_port_.ofp_port = e->in_port;
2539         flow_extract(e->packet, 0, 0, NULL, &in_port_, &flow);
2540         ofproto->ofproto_class->rule_execute(e->rule, &flow, e->packet);
2541
2542         rule_execute_destroy(e);
2543     }
2544 }
2545
2546 /* Destroys and discards all "rule_execute" operations queued up in
2547  * ofproto->rule_executes. */
2548 static void
2549 destroy_rule_executes(struct ofproto *ofproto)
2550 {
2551     struct rule_execute *e, *next;
2552     struct list executes;
2553
2554     guarded_list_pop_all(&ofproto->rule_executes, &executes);
2555     LIST_FOR_EACH_SAFE (e, next, list_node, &executes) {
2556         ofpbuf_delete(e->packet);
2557         rule_execute_destroy(e);
2558     }
2559 }
2560
2561 /* Returns true if 'rule' should be hidden from the controller.
2562  *
2563  * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2564  * (e.g. by in-band control) and are intentionally hidden from the
2565  * controller. */
2566 static bool
2567 ofproto_rule_is_hidden(const struct rule *rule)
2568 {
2569     return rule->cr.priority > UINT16_MAX;
2570 }
2571
2572 static enum oftable_flags
2573 rule_get_flags(const struct rule *rule)
2574 {
2575     return rule->ofproto->tables[rule->table_id].flags;
2576 }
2577
2578 static bool
2579 rule_is_modifiable(const struct rule *rule)
2580 {
2581     return !(rule_get_flags(rule) & OFTABLE_READONLY);
2582 }
2583 \f
2584 static enum ofperr
2585 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2586 {
2587     ofconn_send_reply(ofconn, make_echo_reply(oh));
2588     return 0;
2589 }
2590
2591 static enum ofperr
2592 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2593 {
2594     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2595     struct ofputil_switch_features features;
2596     struct ofport *port;
2597     bool arp_match_ip;
2598     struct ofpbuf *b;
2599     int n_tables;
2600     int i;
2601
2602     ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2603                                          &features.actions);
2604     ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2605
2606     /* Count only non-hidden tables in the number of tables.  (Hidden tables,
2607      * if present, are always at the end.) */
2608     n_tables = ofproto->n_tables;
2609     for (i = 0; i < ofproto->n_tables; i++) {
2610         if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2611             n_tables = i;
2612             break;
2613         }
2614     }
2615
2616     features.datapath_id = ofproto->datapath_id;
2617     features.n_buffers = pktbuf_capacity();
2618     features.n_tables = n_tables;
2619     features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2620                              OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2621     if (arp_match_ip) {
2622         features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2623     }
2624     /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2625     features.auxiliary_id = 0;
2626     b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2627                                        oh->xid);
2628     HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2629         ofputil_put_switch_features_port(&port->pp, b);
2630     }
2631
2632     ofconn_send_reply(ofconn, b);
2633     return 0;
2634 }
2635
2636 static enum ofperr
2637 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2638 {
2639     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2640     struct ofp_switch_config *osc;
2641     enum ofp_config_flags flags;
2642     struct ofpbuf *buf;
2643
2644     /* Send reply. */
2645     buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2646     osc = ofpbuf_put_uninit(buf, sizeof *osc);
2647     flags = ofproto->frag_handling;
2648     /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2649     if (oh->version < OFP13_VERSION
2650         && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2651         flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2652     }
2653     osc->flags = htons(flags);
2654     osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2655     ofconn_send_reply(ofconn, buf);
2656
2657     return 0;
2658 }
2659
2660 static enum ofperr
2661 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2662 {
2663     const struct ofp_switch_config *osc = ofpmsg_body(oh);
2664     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2665     uint16_t flags = ntohs(osc->flags);
2666
2667     if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2668         || ofconn_get_role(ofconn) != OFPCR12_ROLE_SLAVE) {
2669         enum ofp_config_flags cur = ofproto->frag_handling;
2670         enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2671
2672         ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2673         if (cur != next) {
2674             if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2675                 ofproto->frag_handling = next;
2676             } else {
2677                 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2678                              ofproto->name,
2679                              ofputil_frag_handling_to_string(next));
2680             }
2681         }
2682     }
2683     /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2684     ofconn_set_invalid_ttl_to_controller(ofconn,
2685              (oh->version < OFP13_VERSION
2686               && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2687
2688     ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2689
2690     return 0;
2691 }
2692
2693 /* Checks whether 'ofconn' is a slave controller.  If so, returns an OpenFlow
2694  * error message code for the caller to propagate upward.  Otherwise, returns
2695  * 0.
2696  *
2697  * The log message mentions 'msg_type'. */
2698 static enum ofperr
2699 reject_slave_controller(struct ofconn *ofconn)
2700 {
2701     if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2702         && ofconn_get_role(ofconn) == OFPCR12_ROLE_SLAVE) {
2703         return OFPERR_OFPBRC_EPERM;
2704     } else {
2705         return 0;
2706     }
2707 }
2708
2709 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are appropriate
2710  * for a packet with the prerequisites satisfied by 'flow' in table 'table_id'.
2711  * 'flow' may be temporarily modified, but is restored at return.
2712  */
2713 static enum ofperr
2714 ofproto_check_ofpacts(struct ofproto *ofproto,
2715                       const struct ofpact ofpacts[], size_t ofpacts_len,
2716                       struct flow *flow, uint8_t table_id)
2717 {
2718     enum ofperr error;
2719     uint32_t mid;
2720
2721     error = ofpacts_check(ofpacts, ofpacts_len, flow,
2722                           u16_to_ofp(ofproto->max_ports), table_id);
2723     if (error) {
2724         return error;
2725     }
2726
2727     mid = ofpacts_get_meter(ofpacts, ofpacts_len);
2728     if (mid && ofproto_get_provider_meter_id(ofproto, mid) == UINT32_MAX) {
2729         return OFPERR_OFPMMFC_INVALID_METER;
2730     }
2731     return 0;
2732 }
2733
2734 static enum ofperr
2735 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2736 {
2737     struct ofproto *p = ofconn_get_ofproto(ofconn);
2738     struct ofputil_packet_out po;
2739     struct ofpbuf *payload;
2740     uint64_t ofpacts_stub[1024 / 8];
2741     struct ofpbuf ofpacts;
2742     struct flow flow;
2743     union flow_in_port in_port_;
2744     enum ofperr error;
2745
2746     COVERAGE_INC(ofproto_packet_out);
2747
2748     error = reject_slave_controller(ofconn);
2749     if (error) {
2750         goto exit;
2751     }
2752
2753     /* Decode message. */
2754     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2755     error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2756     if (error) {
2757         goto exit_free_ofpacts;
2758     }
2759     if (ofp_to_u16(po.in_port) >= p->max_ports
2760         && ofp_to_u16(po.in_port) < ofp_to_u16(OFPP_MAX)) {
2761         error = OFPERR_OFPBRC_BAD_PORT;
2762         goto exit_free_ofpacts;
2763     }
2764
2765
2766     /* Get payload. */
2767     if (po.buffer_id != UINT32_MAX) {
2768         error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2769         if (error || !payload) {
2770             goto exit_free_ofpacts;
2771         }
2772     } else {
2773         /* Ensure that the L3 header is 32-bit aligned. */
2774         payload = ofpbuf_clone_data_with_headroom(po.packet, po.packet_len, 2);
2775     }
2776
2777     /* Verify actions against packet, then send packet if successful. */
2778     in_port_.ofp_port = po.in_port;
2779     flow_extract(payload, 0, 0, NULL, &in_port_, &flow);
2780     error = ofproto_check_ofpacts(p, po.ofpacts, po.ofpacts_len, &flow, 0);
2781     if (!error) {
2782         error = p->ofproto_class->packet_out(p, payload, &flow,
2783                                              po.ofpacts, po.ofpacts_len);
2784     }
2785     ofpbuf_delete(payload);
2786
2787 exit_free_ofpacts:
2788     ofpbuf_uninit(&ofpacts);
2789 exit:
2790     return error;
2791 }
2792
2793 static void
2794 update_port_config(struct ofport *port,
2795                    enum ofputil_port_config config,
2796                    enum ofputil_port_config mask)
2797 {
2798     enum ofputil_port_config old_config = port->pp.config;
2799     enum ofputil_port_config toggle;
2800
2801     toggle = (config ^ port->pp.config) & mask;
2802     if (toggle & OFPUTIL_PC_PORT_DOWN) {
2803         if (config & OFPUTIL_PC_PORT_DOWN) {
2804             netdev_turn_flags_off(port->netdev, NETDEV_UP, NULL);
2805         } else {
2806             netdev_turn_flags_on(port->netdev, NETDEV_UP, NULL);
2807         }
2808         toggle &= ~OFPUTIL_PC_PORT_DOWN;
2809     }
2810
2811     port->pp.config ^= toggle;
2812     if (port->pp.config != old_config) {
2813         port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2814     }
2815 }
2816
2817 static enum ofperr
2818 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2819 {
2820     struct ofproto *p = ofconn_get_ofproto(ofconn);
2821     struct ofputil_port_mod pm;
2822     struct ofport *port;
2823     enum ofperr error;
2824
2825     error = reject_slave_controller(ofconn);
2826     if (error) {
2827         return error;
2828     }
2829
2830     error = ofputil_decode_port_mod(oh, &pm);
2831     if (error) {
2832         return error;
2833     }
2834
2835     port = ofproto_get_port(p, pm.port_no);
2836     if (!port) {
2837         return OFPERR_OFPPMFC_BAD_PORT;
2838     } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2839         return OFPERR_OFPPMFC_BAD_HW_ADDR;
2840     } else {
2841         update_port_config(port, pm.config, pm.mask);
2842         if (pm.advertise) {
2843             netdev_set_advertisements(port->netdev, pm.advertise);
2844         }
2845     }
2846     return 0;
2847 }
2848
2849 static enum ofperr
2850 handle_desc_stats_request(struct ofconn *ofconn,
2851                           const struct ofp_header *request)
2852 {
2853     static const char *default_mfr_desc = "Nicira, Inc.";
2854     static const char *default_hw_desc = "Open vSwitch";
2855     static const char *default_sw_desc = VERSION;
2856     static const char *default_serial_desc = "None";
2857     static const char *default_dp_desc = "None";
2858
2859     struct ofproto *p = ofconn_get_ofproto(ofconn);
2860     struct ofp_desc_stats *ods;
2861     struct ofpbuf *msg;
2862
2863     msg = ofpraw_alloc_stats_reply(request, 0);
2864     ods = ofpbuf_put_zeros(msg, sizeof *ods);
2865     ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
2866                 sizeof ods->mfr_desc);
2867     ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
2868                 sizeof ods->hw_desc);
2869     ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
2870                 sizeof ods->sw_desc);
2871     ovs_strlcpy(ods->serial_num,
2872                 p->serial_desc ? p->serial_desc : default_serial_desc,
2873                 sizeof ods->serial_num);
2874     ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
2875                 sizeof ods->dp_desc);
2876     ofconn_send_reply(ofconn, msg);
2877
2878     return 0;
2879 }
2880
2881 static enum ofperr
2882 handle_table_stats_request(struct ofconn *ofconn,
2883                            const struct ofp_header *request)
2884 {
2885     struct ofproto *p = ofconn_get_ofproto(ofconn);
2886     struct ofp12_table_stats *ots;
2887     struct ofpbuf *msg;
2888     int n_tables;
2889     size_t i;
2890
2891     /* Set up default values.
2892      *
2893      * ofp12_table_stats is used as a generic structure as
2894      * it is able to hold all the fields for ofp10_table_stats
2895      * and ofp11_table_stats (and of course itself).
2896      */
2897     ots = xcalloc(p->n_tables, sizeof *ots);
2898     for (i = 0; i < p->n_tables; i++) {
2899         ots[i].table_id = i;
2900         sprintf(ots[i].name, "table%zu", i);
2901         ots[i].match = htonll(OFPXMT12_MASK);
2902         ots[i].wildcards = htonll(OFPXMT12_MASK);
2903         ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2904         ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2905         ots[i].write_setfields = htonll(OFPXMT12_MASK);
2906         ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2907         ots[i].metadata_match = htonll(UINT64_MAX);
2908         ots[i].metadata_write = htonll(UINT64_MAX);
2909         ots[i].instructions = htonl(OFPIT11_ALL);
2910         ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2911         ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2912         ovs_rwlock_rdlock(&p->tables[i].cls.rwlock);
2913         ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2914         ovs_rwlock_unlock(&p->tables[i].cls.rwlock);
2915     }
2916
2917     p->ofproto_class->get_tables(p, ots);
2918
2919     /* Post-process the tables, dropping hidden tables. */
2920     n_tables = p->n_tables;
2921     for (i = 0; i < p->n_tables; i++) {
2922         const struct oftable *table = &p->tables[i];
2923
2924         if (table->flags & OFTABLE_HIDDEN) {
2925             n_tables = i;
2926             break;
2927         }
2928
2929         if (table->name) {
2930             ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2931         }
2932
2933         if (table->max_flows < ntohl(ots[i].max_entries)) {
2934             ots[i].max_entries = htonl(table->max_flows);
2935         }
2936     }
2937
2938     msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2939     ofconn_send_reply(ofconn, msg);
2940
2941     free(ots);
2942
2943     return 0;
2944 }
2945
2946 static void
2947 append_port_stat(struct ofport *port, struct list *replies)
2948 {
2949     struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2950
2951     calc_duration(port->created, time_msec(),
2952                   &ops.duration_sec, &ops.duration_nsec);
2953
2954     /* Intentionally ignore return value, since errors will set
2955      * 'stats' to all-1s, which is correct for OpenFlow, and
2956      * netdev_get_stats() will log errors. */
2957     ofproto_port_get_stats(port, &ops.stats);
2958
2959     ofputil_append_port_stat(replies, &ops);
2960 }
2961
2962 static enum ofperr
2963 handle_port_stats_request(struct ofconn *ofconn,
2964                           const struct ofp_header *request)
2965 {
2966     struct ofproto *p = ofconn_get_ofproto(ofconn);
2967     struct ofport *port;
2968     struct list replies;
2969     ofp_port_t port_no;
2970     enum ofperr error;
2971
2972     error = ofputil_decode_port_stats_request(request, &port_no);
2973     if (error) {
2974         return error;
2975     }
2976
2977     ofpmp_init(&replies, request);
2978     if (port_no != OFPP_ANY) {
2979         port = ofproto_get_port(p, port_no);
2980         if (port) {
2981             append_port_stat(port, &replies);
2982         }
2983     } else {
2984         HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2985             append_port_stat(port, &replies);
2986         }
2987     }
2988
2989     ofconn_send_replies(ofconn, &replies);
2990     return 0;
2991 }
2992
2993 static enum ofperr
2994 handle_port_desc_stats_request(struct ofconn *ofconn,
2995                                const struct ofp_header *request)
2996 {
2997     struct ofproto *p = ofconn_get_ofproto(ofconn);
2998     enum ofp_version version;
2999     struct ofport *port;
3000     struct list replies;
3001
3002     ofpmp_init(&replies, request);
3003
3004     version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
3005     HMAP_FOR_EACH (port, hmap_node, &p->ports) {
3006         ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
3007     }
3008
3009     ofconn_send_replies(ofconn, &replies);
3010     return 0;
3011 }
3012
3013 static uint32_t
3014 hash_cookie(ovs_be64 cookie)
3015 {
3016     return hash_2words((OVS_FORCE uint64_t)cookie >> 32,
3017                        (OVS_FORCE uint64_t)cookie);
3018 }
3019
3020 static void
3021 cookies_insert(struct ofproto *ofproto, struct rule *rule)
3022     OVS_REQUIRES(ofproto_mutex)
3023 {
3024     hindex_insert(&ofproto->cookies, &rule->cookie_node,
3025                   hash_cookie(rule->flow_cookie));
3026 }
3027
3028 static void
3029 cookies_remove(struct ofproto *ofproto, struct rule *rule)
3030     OVS_REQUIRES(ofproto_mutex)
3031 {
3032     hindex_remove(&ofproto->cookies, &rule->cookie_node);
3033 }
3034
3035 static void
3036 ofproto_rule_change_cookie(struct ofproto *ofproto, struct rule *rule,
3037                            ovs_be64 new_cookie)
3038     OVS_REQUIRES(ofproto_mutex)
3039 {
3040     if (new_cookie != rule->flow_cookie) {
3041         cookies_remove(ofproto, rule);
3042
3043         ovs_mutex_lock(&rule->mutex);
3044         rule->flow_cookie = new_cookie;
3045         ovs_mutex_unlock(&rule->mutex);
3046
3047         cookies_insert(ofproto, rule);
3048     }
3049 }
3050
3051 static void
3052 calc_duration(long long int start, long long int now,
3053               uint32_t *sec, uint32_t *nsec)
3054 {
3055     long long int msecs = now - start;
3056     *sec = msecs / 1000;
3057     *nsec = (msecs % 1000) * (1000 * 1000);
3058 }
3059
3060 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'.  Returns
3061  * 0 if 'table_id' is OK, otherwise an OpenFlow error code.  */
3062 static enum ofperr
3063 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
3064 {
3065     return (table_id == 0xff || table_id < ofproto->n_tables
3066             ? 0
3067             : OFPERR_OFPBRC_BAD_TABLE_ID);
3068
3069 }
3070
3071 static struct oftable *
3072 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
3073 {
3074     struct oftable *table;
3075
3076     for (table = &ofproto->tables[table_id];
3077          table < &ofproto->tables[ofproto->n_tables];
3078          table++) {
3079         if (!(table->flags & OFTABLE_HIDDEN)) {
3080             return table;
3081         }
3082     }
3083
3084     return NULL;
3085 }
3086
3087 static struct oftable *
3088 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
3089 {
3090     if (table_id == 0xff) {
3091         return next_visible_table(ofproto, 0);
3092     } else if (table_id < ofproto->n_tables) {
3093         return &ofproto->tables[table_id];
3094     } else {
3095         return NULL;
3096     }
3097 }
3098
3099 static struct oftable *
3100 next_matching_table(const struct ofproto *ofproto,
3101                     const struct oftable *table, uint8_t table_id)
3102 {
3103     return (table_id == 0xff
3104             ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
3105             : NULL);
3106 }
3107
3108 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3109  *
3110  *   - If TABLE_ID is 0xff, this iterates over every classifier table in
3111  *     OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3112  *
3113  *   - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3114  *     only once, for that table.  (This can be used to access tables marked
3115  *     OFTABLE_HIDDEN.)
3116  *
3117  *   - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3118  *     entered at all.  (Perhaps you should have validated TABLE_ID with
3119  *     check_table_id().)
3120  *
3121  * All parameters are evaluated multiple times.
3122  */
3123 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO)         \
3124     for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID);       \
3125          (TABLE) != NULL;                                         \
3126          (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3127
3128 /* Initializes 'criteria' in a straightforward way based on the other
3129  * parameters.
3130  *
3131  * For "loose" matching, the 'priority' parameter is unimportant and may be
3132  * supplied as 0. */
3133 static void
3134 rule_criteria_init(struct rule_criteria *criteria, uint8_t table_id,
3135                    const struct match *match, unsigned int priority,
3136                    ovs_be64 cookie, ovs_be64 cookie_mask,
3137                    ofp_port_t out_port)
3138 {
3139     criteria->table_id = table_id;
3140     cls_rule_init(&criteria->cr, match, priority);
3141     criteria->cookie = cookie;
3142     criteria->cookie_mask = cookie_mask;
3143     criteria->out_port = out_port;
3144 }
3145
3146 static void
3147 rule_criteria_destroy(struct rule_criteria *criteria)
3148 {
3149     cls_rule_destroy(&criteria->cr);
3150 }
3151
3152 void
3153 rule_collection_init(struct rule_collection *rules)
3154 {
3155     rules->rules = rules->stub;
3156     rules->n = 0;
3157     rules->capacity = ARRAY_SIZE(rules->stub);
3158 }
3159
3160 void
3161 rule_collection_add(struct rule_collection *rules, struct rule *rule)
3162 {
3163     if (rules->n >= rules->capacity) {
3164         size_t old_size, new_size;
3165
3166         old_size = rules->capacity * sizeof *rules->rules;
3167         rules->capacity *= 2;
3168         new_size = rules->capacity * sizeof *rules->rules;
3169
3170         if (rules->rules == rules->stub) {
3171             rules->rules = xmalloc(new_size);
3172             memcpy(rules->rules, rules->stub, old_size);
3173         } else {
3174             rules->rules = xrealloc(rules->rules, new_size);
3175         }
3176     }
3177
3178     rules->rules[rules->n++] = rule;
3179 }
3180
3181 void
3182 rule_collection_ref(struct rule_collection *rules)
3183     OVS_REQUIRES(ofproto_mutex)
3184 {
3185     size_t i;
3186
3187     for (i = 0; i < rules->n; i++) {
3188         ofproto_rule_ref(rules->rules[i]);
3189     }
3190 }
3191
3192 void
3193 rule_collection_unref(struct rule_collection *rules)
3194 {
3195     size_t i;
3196
3197     for (i = 0; i < rules->n; i++) {
3198         ofproto_rule_unref(rules->rules[i]);
3199     }
3200 }
3201
3202 void
3203 rule_collection_destroy(struct rule_collection *rules)
3204 {
3205     if (rules->rules != rules->stub) {
3206         free(rules->rules);
3207     }
3208 }
3209
3210 static enum ofperr
3211 collect_rule(struct rule *rule, const struct rule_criteria *c,
3212              struct rule_collection *rules)
3213     OVS_REQUIRES(ofproto_mutex)
3214 {
3215     /* We ordinarily want to skip hidden rules, but there has to be a way for
3216      * code internal to OVS to modify and delete them, so if the criteria
3217      * specify a priority that can only be for a hidden flow, then allow hidden
3218      * rules to be selected.  (This doesn't allow OpenFlow clients to meddle
3219      * with hidden flows because OpenFlow uses only a 16-bit field to specify
3220      * priority.) */
3221     if (ofproto_rule_is_hidden(rule) && c->cr.priority <= UINT16_MAX) {
3222         return 0;
3223     } else if (rule->pending) {
3224         return OFPROTO_POSTPONE;
3225     } else {
3226         if ((c->table_id == rule->table_id || c->table_id == 0xff)
3227             && ofproto_rule_has_out_port(rule, c->out_port)
3228             && !((rule->flow_cookie ^ c->cookie) & c->cookie_mask)) {
3229             rule_collection_add(rules, rule);
3230         }
3231         return 0;
3232     }
3233 }
3234
3235 /* Searches 'ofproto' for rules that match the criteria in 'criteria'.  Matches
3236  * on classifiers rules are done in the "loose" way required for OpenFlow
3237  * OFPFC_MODIFY and OFPFC_DELETE requests.  Puts the selected rules on list
3238  * 'rules'.
3239  *
3240  * Hidden rules are always omitted.
3241  *
3242  * Returns 0 on success, otherwise an OpenFlow error code. */
3243 static enum ofperr
3244 collect_rules_loose(struct ofproto *ofproto,
3245                     const struct rule_criteria *criteria,
3246                     struct rule_collection *rules)
3247     OVS_REQUIRES(ofproto_mutex)
3248 {
3249     struct oftable *table;
3250     enum ofperr error;
3251
3252     rule_collection_init(rules);
3253
3254     error = check_table_id(ofproto, criteria->table_id);
3255     if (error) {
3256         goto exit;
3257     }
3258
3259     if (criteria->cookie_mask == htonll(UINT64_MAX)) {
3260         struct rule *rule;
3261
3262         HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3263                                    hash_cookie(criteria->cookie),
3264                                    &ofproto->cookies) {
3265             if (cls_rule_is_loose_match(&rule->cr, &criteria->cr.match)) {
3266                 error = collect_rule(rule, criteria, rules);
3267                 if (error) {
3268                     break;
3269                 }
3270             }
3271         }
3272     } else {
3273         FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3274             struct cls_cursor cursor;
3275             struct rule *rule;
3276
3277             ovs_rwlock_rdlock(&table->cls.rwlock);
3278             cls_cursor_init(&cursor, &table->cls, &criteria->cr);
3279             CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3280                 error = collect_rule(rule, criteria, rules);
3281                 if (error) {
3282                     break;
3283                 }
3284             }
3285             ovs_rwlock_unlock(&table->cls.rwlock);
3286         }
3287     }
3288
3289 exit:
3290     if (error) {
3291         rule_collection_destroy(rules);
3292     }
3293     return error;
3294 }
3295
3296 /* Searches 'ofproto' for rules that match the criteria in 'criteria'.  Matches
3297  * on classifiers rules are done in the "strict" way required for OpenFlow
3298  * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests.  Puts the selected
3299  * rules on list 'rules'.
3300  *
3301  * Hidden rules are always omitted.
3302  *
3303  * Returns 0 on success, otherwise an OpenFlow error code. */
3304 static enum ofperr
3305 collect_rules_strict(struct ofproto *ofproto,
3306                      const struct rule_criteria *criteria,
3307                      struct rule_collection *rules)
3308     OVS_REQUIRES(ofproto_mutex)
3309 {
3310     struct oftable *table;
3311     int error;
3312
3313     rule_collection_init(rules);
3314
3315     error = check_table_id(ofproto, criteria->table_id);
3316     if (error) {
3317         goto exit;
3318     }
3319
3320     if (criteria->cookie_mask == htonll(UINT64_MAX)) {
3321         struct rule *rule;
3322
3323         HINDEX_FOR_EACH_WITH_HASH (rule, cookie_node,
3324                                    hash_cookie(criteria->cookie),
3325                                    &ofproto->cookies) {
3326             if (cls_rule_equal(&rule->cr, &criteria->cr)) {
3327                 error = collect_rule(rule, criteria, rules);
3328                 if (error) {
3329                     break;
3330                 }
3331             }
3332         }
3333     } else {
3334         FOR_EACH_MATCHING_TABLE (table, criteria->table_id, ofproto) {
3335             struct rule *rule;
3336
3337             ovs_rwlock_rdlock(&table->cls.rwlock);
3338             rule = rule_from_cls_rule(classifier_find_rule_exactly(
3339                                           &table->cls, &criteria->cr));
3340             ovs_rwlock_unlock(&table->cls.rwlock);
3341             if (rule) {
3342                 error = collect_rule(rule, criteria, rules);
3343                 if (error) {
3344                     break;
3345                 }
3346             }
3347         }
3348     }
3349
3350 exit:
3351     if (error) {
3352         rule_collection_destroy(rules);
3353     }
3354     return error;
3355 }
3356
3357 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3358  * forced into the range of a uint16_t. */
3359 static int
3360 age_secs(long long int age_ms)
3361 {
3362     return (age_ms < 0 ? 0
3363             : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
3364             : (unsigned int) age_ms / 1000);
3365 }
3366
3367 static enum ofperr
3368 handle_flow_stats_request(struct ofconn *ofconn,
3369                           const struct ofp_header *request)
3370     OVS_EXCLUDED(ofproto_mutex)
3371 {
3372     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3373     struct ofputil_flow_stats_request fsr;
3374     struct rule_criteria criteria;
3375     struct rule_collection rules;
3376     struct list replies;
3377     enum ofperr error;
3378     size_t i;
3379
3380     error = ofputil_decode_flow_stats_request(&fsr, request);
3381     if (error) {
3382         return error;
3383     }
3384
3385     rule_criteria_init(&criteria, fsr.table_id, &fsr.match, 0, fsr.cookie,
3386                        fsr.cookie_mask, fsr.out_port);
3387
3388     ovs_mutex_lock(&ofproto_mutex);
3389     error = collect_rules_loose(ofproto, &criteria, &rules);
3390     rule_criteria_destroy(&criteria);
3391     if (!error) {
3392         rule_collection_ref(&rules);
3393     }
3394     ovs_mutex_unlock(&ofproto_mutex);
3395
3396     if (error) {
3397         return error;
3398     }
3399
3400     ofpmp_init(&replies, request);
3401     for (i = 0; i < rules.n; i++) {
3402         struct rule *rule = rules.rules[i];
3403         long long int now = time_msec();
3404         struct ofputil_flow_stats fs;
3405         long long int created, used, modified;
3406         struct rule_actions *actions;
3407         bool send_flow_removed;
3408
3409         ovs_mutex_lock(&rule->mutex);
3410         fs.cookie = rule->flow_cookie;
3411         fs.idle_timeout = rule->idle_timeout;
3412         fs.hard_timeout = rule->hard_timeout;
3413         created = rule->created;
3414         used = rule->used;
3415         modified = rule->modified;
3416         actions = rule_get_actions__(rule);
3417         send_flow_removed = rule->send_flow_removed;
3418         ovs_mutex_unlock(&rule->mutex);
3419
3420         minimatch_expand(&rule->cr.match, &fs.match);
3421         fs.table_id = rule->table_id;
3422         calc_duration(created, now, &fs.duration_sec, &fs.duration_nsec);
3423         fs.priority = rule->cr.priority;
3424         fs.idle_age = age_secs(now - used);
3425         fs.hard_age = age_secs(now - modified);
3426         ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
3427                                                &fs.byte_count, true);
3428         fs.ofpacts = actions->ofpacts;
3429         fs.ofpacts_len = actions->ofpacts_len;
3430
3431         fs.flags = 0;
3432         if (send_flow_removed) {
3433             fs.flags |= OFPUTIL_FF_SEND_FLOW_REM;
3434             /* FIXME: Implement OFPUTIL_FF_NO_PKT_COUNTS and
3435                OFPUTIL_FF_NO_BYT_COUNTS. */
3436         }
3437         ofputil_append_flow_stats_reply(&fs, &replies);
3438
3439         rule_actions_unref(actions);
3440     }
3441
3442     rule_collection_unref(&rules);
3443     rule_collection_destroy(&rules);
3444
3445     ofconn_send_replies(ofconn, &replies);
3446
3447     return 0;
3448 }
3449
3450 static void
3451 flow_stats_ds(struct rule *rule, struct ds *results)
3452 {
3453     uint64_t packet_count, byte_count;
3454     struct rule_actions *actions;
3455     long long int created;
3456
3457     rule->ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3458                                                  &byte_count, true);
3459
3460     ovs_mutex_lock(&rule->mutex);
3461     actions = rule_get_actions__(rule);
3462     created = rule->created;
3463     ovs_mutex_unlock(&rule->mutex);
3464
3465     if (rule->table_id != 0) {
3466         ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
3467     }
3468     ds_put_format(results, "duration=%llds, ", (time_msec() - created) / 1000);
3469     ds_put_format(results, "priority=%u, ", rule->cr.priority);
3470     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
3471     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
3472     cls_rule_format(&rule->cr, results);
3473     ds_put_char(results, ',');
3474
3475     ofpacts_format(actions->ofpacts, actions->ofpacts_len, results);
3476
3477     ds_put_cstr(results, "\n");
3478
3479     rule_actions_unref(actions);
3480 }
3481
3482 /* Adds a pretty-printed description of all flows to 'results', including
3483  * hidden flows (e.g., set up by in-band control). */
3484 void
3485 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
3486 {
3487     struct oftable *table;
3488
3489     OFPROTO_FOR_EACH_TABLE (table, p) {
3490         struct cls_cursor cursor;
3491         struct rule *rule;
3492
3493         ovs_rwlock_rdlock(&table->cls.rwlock);
3494         cls_cursor_init(&cursor, &table->cls, NULL);
3495         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3496             flow_stats_ds(rule, results);
3497         }
3498         ovs_rwlock_unlock(&table->cls.rwlock);
3499     }
3500 }
3501
3502 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3503  * '*engine_type' and '*engine_id', respectively. */
3504 void
3505 ofproto_get_netflow_ids(const struct ofproto *ofproto,
3506                         uint8_t *engine_type, uint8_t *engine_id)
3507 {
3508     ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
3509 }
3510
3511 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.  Returns
3512  * true if the port's CFM status was successfully stored into '*status'.
3513  * Returns false if the port did not have CFM configured, in which case
3514  * '*status' is indeterminate.
3515  *
3516  * The caller must provide and owns '*status', and must free 'status->rmps'. */
3517 bool
3518 ofproto_port_get_cfm_status(const struct ofproto *ofproto, ofp_port_t ofp_port,
3519                             struct ofproto_cfm_status *status)
3520 {
3521     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
3522     return (ofport
3523             && ofproto->ofproto_class->get_cfm_status
3524             && ofproto->ofproto_class->get_cfm_status(ofport, status));
3525 }
3526
3527 static enum ofperr
3528 handle_aggregate_stats_request(struct ofconn *ofconn,
3529                                const struct ofp_header *oh)
3530     OVS_EXCLUDED(ofproto_mutex)
3531 {
3532     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3533     struct ofputil_flow_stats_request request;
3534     struct ofputil_aggregate_stats stats;
3535     bool unknown_packets, unknown_bytes;
3536     struct rule_criteria criteria;
3537     struct rule_collection rules;
3538     struct ofpbuf *reply;
3539     enum ofperr error;
3540     size_t i;
3541
3542     error = ofputil_decode_flow_stats_request(&request, oh);
3543     if (error) {
3544         return error;
3545     }
3546
3547     rule_criteria_init(&criteria, request.table_id, &request.match, 0,
3548                        request.cookie, request.cookie_mask,
3549                        request.out_port);
3550
3551     ovs_mutex_lock(&ofproto_mutex);
3552     error = collect_rules_loose(ofproto, &criteria, &rules);
3553     rule_criteria_destroy(&criteria);
3554     if (!error) {
3555         rule_collection_ref(&rules);
3556     }
3557     ovs_mutex_unlock(&ofproto_mutex);
3558
3559     if (error) {
3560         return error;
3561     }
3562
3563     memset(&stats, 0, sizeof stats);
3564     unknown_packets = unknown_bytes = false;
3565     for (i = 0; i < rules.n; i++) {
3566         struct rule *rule = rules.rules[i];
3567         uint64_t packet_count;
3568         uint64_t byte_count;
3569
3570         ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
3571                                                &byte_count, true);
3572
3573         if (packet_count == UINT64_MAX) {
3574             unknown_packets = true;
3575         } else {
3576             stats.packet_count += packet_count;
3577         }
3578
3579         if (byte_count == UINT64_MAX) {
3580             unknown_bytes = true;
3581         } else {
3582             stats.byte_count += byte_count;
3583         }
3584
3585         stats.flow_count++;
3586     }
3587     if (unknown_packets) {
3588         stats.packet_count = UINT64_MAX;
3589     }
3590     if (unknown_bytes) {
3591         stats.byte_count = UINT64_MAX;
3592     }
3593
3594     rule_collection_unref(&rules);
3595     rule_collection_destroy(&rules);
3596
3597     reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
3598     ofconn_send_reply(ofconn, reply);
3599
3600     return 0;
3601 }
3602
3603 struct queue_stats_cbdata {
3604     struct ofport *ofport;
3605     struct list replies;
3606     long long int now;
3607 };
3608
3609 static void
3610 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
3611                 const struct netdev_queue_stats *stats)
3612 {
3613     struct ofputil_queue_stats oqs;
3614
3615     oqs.port_no = cbdata->ofport->pp.port_no;
3616     oqs.queue_id = queue_id;
3617     oqs.tx_bytes = stats->tx_bytes;
3618     oqs.tx_packets = stats->tx_packets;
3619     oqs.tx_errors = stats->tx_errors;
3620     if (stats->created != LLONG_MIN) {
3621         calc_duration(stats->created, cbdata->now,
3622                       &oqs.duration_sec, &oqs.duration_nsec);
3623     } else {
3624         oqs.duration_sec = oqs.duration_nsec = UINT32_MAX;
3625     }
3626     ofputil_append_queue_stat(&cbdata->replies, &oqs);
3627 }
3628
3629 static void
3630 handle_queue_stats_dump_cb(uint32_t queue_id,
3631                            struct netdev_queue_stats *stats,
3632                            void *cbdata_)
3633 {
3634     struct queue_stats_cbdata *cbdata = cbdata_;
3635
3636     put_queue_stats(cbdata, queue_id, stats);
3637 }
3638
3639 static enum ofperr
3640 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
3641                             struct queue_stats_cbdata *cbdata)
3642 {
3643     cbdata->ofport = port;
3644     if (queue_id == OFPQ_ALL) {
3645         netdev_dump_queue_stats(port->netdev,
3646                                 handle_queue_stats_dump_cb, cbdata);
3647     } else {
3648         struct netdev_queue_stats stats;
3649
3650         if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3651             put_queue_stats(cbdata, queue_id, &stats);
3652         } else {
3653             return OFPERR_OFPQOFC_BAD_QUEUE;
3654         }
3655     }
3656     return 0;
3657 }
3658
3659 static enum ofperr
3660 handle_queue_stats_request(struct ofconn *ofconn,
3661                            const struct ofp_header *rq)
3662 {
3663     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3664     struct queue_stats_cbdata cbdata;
3665     struct ofport *port;
3666     enum ofperr error;
3667     struct ofputil_queue_stats_request oqsr;
3668
3669     COVERAGE_INC(ofproto_queue_req);
3670
3671     ofpmp_init(&cbdata.replies, rq);
3672     cbdata.now = time_msec();
3673
3674     error = ofputil_decode_queue_stats_request(rq, &oqsr);
3675     if (error) {
3676         return error;
3677     }
3678
3679     if (oqsr.port_no == OFPP_ANY) {
3680         error = OFPERR_OFPQOFC_BAD_QUEUE;
3681         HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3682             if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3683                 error = 0;
3684             }
3685         }
3686     } else {
3687         port = ofproto_get_port(ofproto, oqsr.port_no);
3688         error = (port
3689                  ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3690                  : OFPERR_OFPQOFC_BAD_PORT);
3691     }
3692     if (!error) {
3693         ofconn_send_replies(ofconn, &cbdata.replies);
3694     } else {
3695         ofpbuf_list_delete(&cbdata.replies);
3696     }
3697
3698     return error;
3699 }
3700
3701 static bool
3702 is_flow_deletion_pending(const struct ofproto *ofproto,
3703                          const struct cls_rule *cls_rule,
3704                          uint8_t table_id)
3705     OVS_REQUIRES(ofproto_mutex)
3706 {
3707     if (!hmap_is_empty(&ofproto->deletions)) {
3708         struct ofoperation *op;
3709
3710         HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3711                                  cls_rule_hash(cls_rule, table_id),
3712                                  &ofproto->deletions) {
3713             if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3714                 return true;
3715             }
3716         }
3717     }
3718
3719     return false;
3720 }
3721
3722 static bool
3723 should_evict_a_rule(struct oftable *table, unsigned int extra_space)
3724     OVS_REQUIRES(ofproto_mutex)
3725     OVS_NO_THREAD_SAFETY_ANALYSIS
3726 {
3727     return classifier_count(&table->cls) + extra_space > table->max_flows;
3728 }
3729
3730 static enum ofperr
3731 evict_rules_from_table(struct ofproto *ofproto, struct oftable *table,
3732                        unsigned int extra_space)
3733     OVS_REQUIRES(ofproto_mutex)
3734 {
3735     while (should_evict_a_rule(table, extra_space)) {
3736         struct rule *rule;
3737
3738         if (!choose_rule_to_evict(table, &rule)) {
3739             return OFPERR_OFPFMFC_TABLE_FULL;
3740         } else if (rule->pending) {
3741             return OFPROTO_POSTPONE;
3742         } else {
3743             struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3744             delete_flow__(rule, group, OFPRR_EVICTION);
3745             ofopgroup_submit(group);
3746         }
3747     }
3748
3749     return 0;
3750 }
3751
3752 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3753  * in which no matching flow already exists in the flow table.
3754  *
3755  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3756  * ofp_actions, to the ofproto's flow table.  Returns 0 on success, an OpenFlow
3757  * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3758  * initiated now but may be retried later.
3759  *
3760  * The caller retains ownership of 'fm->ofpacts'.
3761  *
3762  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3763  * if any. */
3764 static enum ofperr
3765 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3766          struct ofputil_flow_mod *fm, const struct ofp_header *request)
3767     OVS_REQUIRES(ofproto_mutex)
3768 {
3769     struct oftable *table;
3770     struct ofopgroup *group;
3771     struct cls_rule cr;
3772     struct rule *rule;
3773     uint8_t table_id;
3774     int error;
3775
3776     error = check_table_id(ofproto, fm->table_id);
3777     if (error) {
3778         return error;
3779     }
3780
3781     /* Pick table. */
3782     if (fm->table_id == 0xff) {
3783         if (ofproto->ofproto_class->rule_choose_table) {
3784             error = ofproto->ofproto_class->rule_choose_table(ofproto,
3785                                                               &fm->match,
3786                                                               &table_id);
3787             if (error) {
3788                 return error;
3789             }
3790             ovs_assert(table_id < ofproto->n_tables);
3791         } else {
3792             table_id = 0;
3793         }
3794     } else if (fm->table_id < ofproto->n_tables) {
3795         table_id = fm->table_id;
3796     } else {
3797         return OFPERR_OFPBRC_BAD_TABLE_ID;
3798     }
3799
3800     table = &ofproto->tables[table_id];
3801
3802     if (table->flags & OFTABLE_READONLY) {
3803         return OFPERR_OFPBRC_EPERM;
3804     }
3805
3806     cls_rule_init(&cr, &fm->match, fm->priority);
3807
3808     /* Transform "add" into "modify" if there's an existing identical flow. */
3809     ovs_rwlock_rdlock(&table->cls.rwlock);
3810     rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls, &cr));
3811     ovs_rwlock_unlock(&table->cls.rwlock);
3812     if (rule) {
3813         cls_rule_destroy(&cr);
3814         if (!rule_is_modifiable(rule)) {
3815             return OFPERR_OFPBRC_EPERM;
3816         } else if (rule->pending) {
3817             return OFPROTO_POSTPONE;
3818         } else {
3819             struct rule_collection rules;
3820
3821             rule_collection_init(&rules);
3822             rule_collection_add(&rules, rule);
3823             fm->modify_cookie = true;
3824             error = modify_flows__(ofproto, ofconn, fm, request, &rules);
3825             rule_collection_destroy(&rules);
3826
3827             return error;
3828         }
3829     }
3830
3831     /* Verify actions. */
3832     error = ofproto_check_ofpacts(ofproto, fm->ofpacts, fm->ofpacts_len,
3833                                   &fm->match.flow, table_id);
3834     if (error) {
3835         cls_rule_destroy(&cr);
3836         return error;
3837     }
3838
3839     /* Serialize against pending deletion. */
3840     if (is_flow_deletion_pending(ofproto, &cr, table_id)) {
3841         cls_rule_destroy(&cr);
3842         return OFPROTO_POSTPONE;
3843     }
3844
3845     /* Check for overlap, if requested. */
3846     if (fm->flags & OFPUTIL_FF_CHECK_OVERLAP) {
3847         bool overlaps;
3848
3849         ovs_rwlock_rdlock(&table->cls.rwlock);
3850         overlaps = classifier_rule_overlaps(&table->cls, &cr);
3851         ovs_rwlock_unlock(&table->cls.rwlock);
3852
3853         if (overlaps) {
3854             cls_rule_destroy(&cr);
3855             return OFPERR_OFPFMFC_OVERLAP;
3856         }
3857     }
3858
3859     /* If necessary, evict an existing rule to clear out space. */
3860     error = evict_rules_from_table(ofproto, table, 1);
3861     if (error) {
3862         cls_rule_destroy(&cr);
3863         return error;
3864     }
3865
3866     /* Allocate new rule. */
3867     rule = ofproto->ofproto_class->rule_alloc();
3868     if (!rule) {
3869         cls_rule_destroy(&cr);
3870         VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3871                      ofproto->name, ovs_strerror(error));
3872         return ENOMEM;
3873     }
3874
3875     /* Initialize base state. */
3876     *CONST_CAST(struct ofproto **, &rule->ofproto) = ofproto;
3877     cls_rule_move(CONST_CAST(struct cls_rule *, &rule->cr), &cr);
3878     atomic_init(&rule->ref_count, 1);
3879     rule->pending = NULL;
3880     rule->flow_cookie = fm->new_cookie;
3881     rule->created = rule->modified = rule->used = time_msec();
3882
3883     ovs_mutex_init(&rule->mutex);
3884     ovs_mutex_lock(&rule->mutex);
3885     rule->idle_timeout = fm->idle_timeout;
3886     rule->hard_timeout = fm->hard_timeout;
3887     ovs_mutex_unlock(&rule->mutex);
3888
3889     *CONST_CAST(uint8_t *, &rule->table_id) = table - ofproto->tables;
3890     rule->send_flow_removed = (fm->flags & OFPUTIL_FF_SEND_FLOW_REM) != 0;
3891     rule->actions = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
3892     list_init(&rule->meter_list_node);
3893     rule->eviction_group = NULL;
3894     list_init(&rule->expirable);
3895     rule->monitor_flags = 0;
3896     rule->add_seqno = 0;
3897     rule->modify_seqno = 0;
3898
3899     /* Construct rule, initializing derived state. */
3900     error = ofproto->ofproto_class->rule_construct(rule);
3901     if (error) {
3902         ofproto_rule_destroy__(rule);
3903         return error;
3904     }
3905
3906     /* Insert rule. */
3907     oftable_insert_rule(rule);
3908
3909     group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3910     ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3911     ofproto->ofproto_class->rule_insert(rule);
3912     ofopgroup_submit(group);
3913
3914     return error;
3915 }
3916 \f
3917 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3918
3919 /* Modifies the rules listed in 'rules', changing their actions to match those
3920  * in 'fm'.
3921  *
3922  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3923  * if any.
3924  *
3925  * Returns 0 on success, otherwise an OpenFlow error code. */
3926 static enum ofperr
3927 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3928                struct ofputil_flow_mod *fm, const struct ofp_header *request,
3929                const struct rule_collection *rules)
3930     OVS_REQUIRES(ofproto_mutex)
3931 {
3932     enum ofoperation_type type;
3933     struct ofopgroup *group;
3934     enum ofperr error;
3935     size_t i;
3936
3937     type = fm->command == OFPFC_ADD ? OFOPERATION_REPLACE : OFOPERATION_MODIFY;
3938     group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3939     error = OFPERR_OFPBRC_EPERM;
3940     for (i = 0; i < rules->n; i++) {
3941         struct rule *rule = rules->rules[i];
3942         struct ofoperation *op;
3943         bool actions_changed;
3944         bool reset_counters;
3945
3946         /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
3947
3948         if (rule_is_modifiable(rule)) {
3949             /* At least one rule is modifiable, don't report EPERM error. */
3950             error = 0;
3951         } else {
3952             continue;
3953         }
3954
3955         /* Verify actions. */
3956         error = ofproto_check_ofpacts(ofproto, fm->ofpacts, fm->ofpacts_len,
3957                                       &fm->match.flow, rule->table_id);
3958         if (error) {
3959             return error;
3960         }
3961
3962         actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3963                                          rule->actions->ofpacts,
3964                                          rule->actions->ofpacts_len);
3965
3966         op = ofoperation_create(group, rule, type, 0);
3967
3968         if (fm->modify_cookie && fm->new_cookie != htonll(UINT64_MAX)) {
3969             ofproto_rule_change_cookie(ofproto, rule, fm->new_cookie);
3970         }
3971         if (type == OFOPERATION_REPLACE) {
3972             ovs_mutex_lock(&rule->mutex);
3973             rule->idle_timeout = fm->idle_timeout;
3974             rule->hard_timeout = fm->hard_timeout;
3975             ovs_mutex_unlock(&rule->mutex);
3976
3977             rule->send_flow_removed = (fm->flags
3978                                        & OFPUTIL_FF_SEND_FLOW_REM) != 0;
3979
3980             if (fm->idle_timeout || fm->hard_timeout) {
3981                 if (!rule->eviction_group) {
3982                     eviction_group_add_rule(rule);
3983                 }
3984             } else {
3985                 eviction_group_remove_rule(rule);
3986             }
3987         }
3988
3989         reset_counters = (fm->flags & OFPUTIL_FF_RESET_COUNTS) != 0;
3990         if (actions_changed || reset_counters) {
3991             struct rule_actions *new_actions;
3992
3993             op->actions = rule->actions;
3994             new_actions = rule_actions_create(fm->ofpacts, fm->ofpacts_len);
3995
3996             ovs_mutex_lock(&rule->mutex);
3997             rule->actions = new_actions;
3998             ovs_mutex_unlock(&rule->mutex);
3999
4000             rule->ofproto->ofproto_class->rule_modify_actions(rule,
4001                                                               reset_counters);
4002         } else {
4003             ofoperation_complete(op, 0);
4004         }
4005     }
4006     ofopgroup_submit(group);
4007
4008     return error;
4009 }
4010
4011 static enum ofperr
4012 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
4013                  struct ofputil_flow_mod *fm, const struct ofp_header *request)
4014     OVS_REQUIRES(ofproto_mutex)
4015 {
4016     if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
4017         return 0;
4018     }
4019     return add_flow(ofproto, ofconn, fm, request);
4020 }
4021
4022 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code on
4023  * failure.
4024  *
4025  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4026  * if any. */
4027 static enum ofperr
4028 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4029                    struct ofputil_flow_mod *fm,
4030                    const struct ofp_header *request)
4031     OVS_REQUIRES(ofproto_mutex)
4032 {
4033     struct rule_criteria criteria;
4034     struct rule_collection rules;
4035     int error;
4036
4037     rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4038                        fm->cookie, fm->cookie_mask, OFPP_ANY);
4039     error = collect_rules_loose(ofproto, &criteria, &rules);
4040     rule_criteria_destroy(&criteria);
4041
4042     if (!error) {
4043         error = (rules.n > 0
4044                  ? modify_flows__(ofproto, ofconn, fm, request, &rules)
4045                  : modify_flows_add(ofproto, ofconn, fm, request));
4046     }
4047
4048     rule_collection_destroy(&rules);
4049
4050     return error;
4051 }
4052
4053 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
4054  * code on failure.
4055  *
4056  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4057  * if any. */
4058 static enum ofperr
4059 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4060                    struct ofputil_flow_mod *fm,
4061                    const struct ofp_header *request)
4062     OVS_REQUIRES(ofproto_mutex)
4063 {
4064     struct rule_criteria criteria;
4065     struct rule_collection rules;
4066     int error;
4067
4068     rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4069                        fm->cookie, fm->cookie_mask, OFPP_ANY);
4070     error = collect_rules_strict(ofproto, &criteria, &rules);
4071     rule_criteria_destroy(&criteria);
4072
4073     if (!error) {
4074         if (rules.n == 0) {
4075             error =  modify_flows_add(ofproto, ofconn, fm, request);
4076         } else if (rules.n == 1) {
4077             error = modify_flows__(ofproto, ofconn, fm, request, &rules);
4078         }
4079     }
4080
4081     rule_collection_destroy(&rules);
4082
4083     return error;
4084 }
4085 \f
4086 /* OFPFC_DELETE implementation. */
4087
4088 static void
4089 delete_flow__(struct rule *rule, struct ofopgroup *group,
4090               enum ofp_flow_removed_reason reason)
4091     OVS_REQUIRES(ofproto_mutex)
4092 {
4093     struct ofproto *ofproto = rule->ofproto;
4094
4095     ofproto_rule_send_removed(rule, reason);
4096
4097     ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
4098     oftable_remove_rule(rule);
4099     ofproto->ofproto_class->rule_delete(rule);
4100 }
4101
4102 /* Deletes the rules listed in 'rules'.
4103  *
4104  * Returns 0 on success, otherwise an OpenFlow error code. */
4105 static enum ofperr
4106 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
4107                const struct ofp_header *request,
4108                const struct rule_collection *rules,
4109                enum ofp_flow_removed_reason reason)
4110     OVS_REQUIRES(ofproto_mutex)
4111 {
4112     struct ofopgroup *group;
4113     size_t i;
4114
4115     group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
4116     for (i = 0; i < rules->n; i++) {
4117         delete_flow__(rules->rules[i], group, reason);
4118     }
4119     ofopgroup_submit(group);
4120
4121     return 0;
4122 }
4123
4124 /* Implements OFPFC_DELETE. */
4125 static enum ofperr
4126 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
4127                    const struct ofputil_flow_mod *fm,
4128                    const struct ofp_header *request)
4129     OVS_REQUIRES(ofproto_mutex)
4130 {
4131     struct rule_criteria criteria;
4132     struct rule_collection rules;
4133     enum ofperr error;
4134
4135     rule_criteria_init(&criteria, fm->table_id, &fm->match, 0,
4136                        fm->cookie, fm->cookie_mask,
4137                        fm->out_port);
4138     error = collect_rules_loose(ofproto, &criteria, &rules);
4139     rule_criteria_destroy(&criteria);
4140
4141     if (!error && rules.n > 0) {
4142         error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4143     }
4144     rule_collection_destroy(&rules);
4145
4146     return error;
4147 }
4148
4149 /* Implements OFPFC_DELETE_STRICT. */
4150 static enum ofperr
4151 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
4152                    const struct ofputil_flow_mod *fm,
4153                    const struct ofp_header *request)
4154     OVS_REQUIRES(ofproto_mutex)
4155 {
4156     struct rule_criteria criteria;
4157     struct rule_collection rules;
4158     enum ofperr error;
4159
4160     rule_criteria_init(&criteria, fm->table_id, &fm->match, fm->priority,
4161                        fm->cookie, fm->cookie_mask, fm->out_port);
4162     error = collect_rules_strict(ofproto, &criteria, &rules);
4163     rule_criteria_destroy(&criteria);
4164
4165     if (!error && rules.n > 0) {
4166         error = delete_flows__(ofproto, ofconn, request, &rules, OFPRR_DELETE);
4167     }
4168     rule_collection_destroy(&rules);
4169
4170     return error;
4171 }
4172
4173 static void
4174 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
4175     OVS_REQUIRES(ofproto_mutex)
4176 {
4177     struct ofputil_flow_removed fr;
4178
4179     if (ofproto_rule_is_hidden(rule) || !rule->send_flow_removed) {
4180         return;
4181     }
4182
4183     minimatch_expand(&rule->cr.match, &fr.match);
4184     fr.priority = rule->cr.priority;
4185     fr.cookie = rule->flow_cookie;
4186     fr.reason = reason;
4187     fr.table_id = rule->table_id;
4188     calc_duration(rule->created, time_msec(),
4189                   &fr.duration_sec, &fr.duration_nsec);
4190     ovs_mutex_lock(&rule->mutex);
4191     fr.idle_timeout = rule->idle_timeout;
4192     fr.hard_timeout = rule->hard_timeout;
4193     ovs_mutex_unlock(&rule->mutex);
4194     rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
4195                                                  &fr.byte_count, false);
4196
4197     connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
4198 }
4199
4200 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4201  * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4202  * ofproto.
4203  *
4204  * 'rule' must not have a pending operation (that is, 'rule->pending' must be
4205  * NULL).
4206  *
4207  * ofproto implementation ->run() functions should use this function to expire
4208  * OpenFlow flows. */
4209 void
4210 ofproto_rule_expire(struct rule *rule, uint8_t reason)
4211     OVS_REQUIRES(ofproto_mutex)
4212 {
4213     struct ofproto *ofproto = rule->ofproto;
4214
4215     ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT
4216                || reason == OFPRR_DELETE);
4217
4218     ofproto_rule_delete__(ofproto, rule, reason);
4219 }
4220
4221 /* Reduces '*timeout' to no more than 'max'.  A value of zero in either case
4222  * means "infinite". */
4223 static void
4224 reduce_timeout(uint16_t max, uint16_t *timeout)
4225 {
4226     if (max && (!*timeout || *timeout > max)) {
4227         *timeout = max;
4228     }
4229 }
4230
4231 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4232  * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4233  * 'idle_timeout' seconds.  Similarly for 'hard_timeout'.
4234  *
4235  * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4236 void
4237 ofproto_rule_reduce_timeouts(struct rule *rule,
4238                              uint16_t idle_timeout, uint16_t hard_timeout)
4239     OVS_EXCLUDED(ofproto_mutex, rule->mutex)
4240 {
4241     if (!idle_timeout && !hard_timeout) {
4242         return;
4243     }
4244
4245     ovs_mutex_lock(&ofproto_mutex);
4246     if (list_is_empty(&rule->expirable)) {
4247         list_insert(&rule->ofproto->expirable, &rule->expirable);
4248     }
4249     ovs_mutex_unlock(&ofproto_mutex);
4250
4251     ovs_mutex_lock(&rule->mutex);
4252     reduce_timeout(idle_timeout, &rule->idle_timeout);
4253     reduce_timeout(hard_timeout, &rule->hard_timeout);
4254     ovs_mutex_unlock(&rule->mutex);
4255 }
4256 \f
4257 static enum ofperr
4258 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4259     OVS_EXCLUDED(ofproto_mutex)
4260 {
4261     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4262     struct ofputil_flow_mod fm;
4263     uint64_t ofpacts_stub[1024 / 8];
4264     struct ofpbuf ofpacts;
4265     enum ofperr error;
4266     long long int now;
4267
4268     error = reject_slave_controller(ofconn);
4269     if (error) {
4270         goto exit;
4271     }
4272
4273     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
4274     error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
4275                                     &ofpacts);
4276     if (!error) {
4277         error = handle_flow_mod__(ofproto, ofconn, &fm, oh);
4278     }
4279     if (error) {
4280         goto exit_free_ofpacts;
4281     }
4282
4283     /* Record the operation for logging a summary report. */
4284     switch (fm.command) {
4285     case OFPFC_ADD:
4286         ofproto->n_add++;
4287         break;
4288
4289     case OFPFC_MODIFY:
4290     case OFPFC_MODIFY_STRICT:
4291         ofproto->n_modify++;
4292         break;
4293
4294     case OFPFC_DELETE:
4295     case OFPFC_DELETE_STRICT:
4296         ofproto->n_delete++;
4297         break;
4298     }
4299
4300     now = time_msec();
4301     if (ofproto->next_op_report == LLONG_MAX) {
4302         ofproto->first_op = now;
4303         ofproto->next_op_report = MAX(now + 10 * 1000,
4304                                       ofproto->op_backoff);
4305         ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
4306     }
4307     ofproto->last_op = now;
4308
4309 exit_free_ofpacts:
4310     ofpbuf_uninit(&ofpacts);
4311 exit:
4312     return error;
4313 }
4314
4315 static enum ofperr
4316 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
4317                   struct ofputil_flow_mod *fm, const struct ofp_header *oh)
4318     OVS_EXCLUDED(ofproto_mutex)
4319 {
4320     enum ofperr error;
4321
4322     ovs_mutex_lock(&ofproto_mutex);
4323     if (ofproto->n_pending < 50) {
4324         switch (fm->command) {
4325         case OFPFC_ADD:
4326             error = add_flow(ofproto, ofconn, fm, oh);
4327             break;
4328
4329         case OFPFC_MODIFY:
4330             error = modify_flows_loose(ofproto, ofconn, fm, oh);
4331             break;
4332
4333         case OFPFC_MODIFY_STRICT:
4334             error = modify_flow_strict(ofproto, ofconn, fm, oh);
4335             break;
4336
4337         case OFPFC_DELETE:
4338             error = delete_flows_loose(ofproto, ofconn, fm, oh);
4339             break;
4340
4341         case OFPFC_DELETE_STRICT:
4342             error = delete_flow_strict(ofproto, ofconn, fm, oh);
4343             break;
4344
4345         default:
4346             if (fm->command > 0xff) {
4347                 VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
4348                              "flow_mod_table_id extension is not enabled",
4349                              ofproto->name);
4350             }
4351             error = OFPERR_OFPFMFC_BAD_COMMAND;
4352             break;
4353         }
4354     } else {
4355         ovs_assert(!list_is_empty(&ofproto->pending));
4356         error = OFPROTO_POSTPONE;
4357     }
4358     ovs_mutex_unlock(&ofproto_mutex);
4359
4360     run_rule_executes(ofproto);
4361     return error;
4362 }
4363
4364 static enum ofperr
4365 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
4366 {
4367     struct ofputil_role_request request;
4368     struct ofputil_role_request reply;
4369     struct ofpbuf *buf;
4370     enum ofperr error;
4371
4372     error = ofputil_decode_role_message(oh, &request);
4373     if (error) {
4374         return error;
4375     }
4376
4377     if (request.role != OFPCR12_ROLE_NOCHANGE) {
4378         if (ofconn_get_role(ofconn) != request.role
4379             && ofconn_has_pending_opgroups(ofconn)) {
4380             return OFPROTO_POSTPONE;
4381         }
4382
4383         if (request.have_generation_id
4384             && !ofconn_set_master_election_id(ofconn, request.generation_id)) {
4385                 return OFPERR_OFPRRFC_STALE;
4386         }
4387
4388         ofconn_set_role(ofconn, request.role);
4389     }
4390
4391     reply.role = ofconn_get_role(ofconn);
4392     reply.have_generation_id = ofconn_get_master_election_id(
4393         ofconn, &reply.generation_id);
4394     buf = ofputil_encode_role_reply(oh, &reply);
4395     ofconn_send_reply(ofconn, buf);
4396
4397     return 0;
4398 }
4399
4400 static enum ofperr
4401 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
4402                              const struct ofp_header *oh)
4403 {
4404     const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
4405     enum ofputil_protocol cur, next;
4406
4407     cur = ofconn_get_protocol(ofconn);
4408     next = ofputil_protocol_set_tid(cur, msg->set != 0);
4409     ofconn_set_protocol(ofconn, next);
4410
4411     return 0;
4412 }
4413
4414 static enum ofperr
4415 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
4416 {
4417     const struct nx_set_flow_format *msg = ofpmsg_body(oh);
4418     enum ofputil_protocol cur, next;
4419     enum ofputil_protocol next_base;
4420
4421     next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
4422     if (!next_base) {
4423         return OFPERR_OFPBRC_EPERM;
4424     }
4425
4426     cur = ofconn_get_protocol(ofconn);
4427     next = ofputil_protocol_set_base(cur, next_base);
4428     if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
4429         /* Avoid sending async messages in surprising protocol. */
4430         return OFPROTO_POSTPONE;
4431     }
4432
4433     ofconn_set_protocol(ofconn, next);
4434     return 0;
4435 }
4436
4437 static enum ofperr
4438 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
4439                                 const struct ofp_header *oh)
4440 {
4441     const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
4442     uint32_t format;
4443
4444     format = ntohl(msg->format);
4445     if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
4446         return OFPERR_OFPBRC_EPERM;
4447     }
4448
4449     if (format != ofconn_get_packet_in_format(ofconn)
4450         && ofconn_has_pending_opgroups(ofconn)) {
4451         /* Avoid sending async message in surprsing packet in format. */
4452         return OFPROTO_POSTPONE;
4453     }
4454
4455     ofconn_set_packet_in_format(ofconn, format);
4456     return 0;
4457 }
4458
4459 static enum ofperr
4460 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
4461 {
4462     const struct nx_async_config *msg = ofpmsg_body(oh);
4463     uint32_t master[OAM_N_TYPES];
4464     uint32_t slave[OAM_N_TYPES];
4465
4466     master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
4467     master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
4468     master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
4469
4470     slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
4471     slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
4472     slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
4473
4474     ofconn_set_async_config(ofconn, master, slave);
4475     if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
4476         !ofconn_get_miss_send_len(ofconn)) {
4477         ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
4478     }
4479
4480     return 0;
4481 }
4482
4483 static enum ofperr
4484 handle_nxt_set_controller_id(struct ofconn *ofconn,
4485                              const struct ofp_header *oh)
4486 {
4487     const struct nx_controller_id *nci = ofpmsg_body(oh);
4488
4489     if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
4490         return OFPERR_NXBRC_MUST_BE_ZERO;
4491     }
4492
4493     ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
4494     return 0;
4495 }
4496
4497 static enum ofperr
4498 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
4499 {
4500     struct ofpbuf *buf;
4501
4502     if (ofconn_has_pending_opgroups(ofconn)) {
4503         return OFPROTO_POSTPONE;
4504     }
4505
4506     buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
4507                               ? OFPRAW_OFPT10_BARRIER_REPLY
4508                               : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
4509     ofconn_send_reply(ofconn, buf);
4510     return 0;
4511 }
4512
4513 static void
4514 ofproto_compose_flow_refresh_update(const struct rule *rule,
4515                                     enum nx_flow_monitor_flags flags,
4516                                     struct list *msgs)
4517     OVS_REQUIRES(ofproto_mutex)
4518 {
4519     struct ofoperation *op = rule->pending;
4520     const struct rule_actions *actions;
4521     struct ofputil_flow_update fu;
4522     struct match match;
4523
4524     if (op && op->type == OFOPERATION_ADD) {
4525         /* We'll report the final flow when the operation completes.  Reporting
4526          * it now would cause a duplicate report later. */
4527         return;
4528     }
4529
4530     fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
4531                 ? NXFME_ADDED : NXFME_MODIFIED);
4532     fu.reason = 0;
4533     ovs_mutex_lock(&rule->mutex);
4534     fu.idle_timeout = rule->idle_timeout;
4535     fu.hard_timeout = rule->hard_timeout;
4536     ovs_mutex_unlock(&rule->mutex);
4537     fu.table_id = rule->table_id;
4538     fu.cookie = rule->flow_cookie;
4539     minimatch_expand(&rule->cr.match, &match);
4540     fu.match = &match;
4541     fu.priority = rule->cr.priority;
4542
4543     if (!(flags & NXFMF_ACTIONS)) {
4544         actions = NULL;
4545     } else if (!op) {
4546         actions = rule->actions;
4547     } else {
4548         /* An operation is in progress.  Use the previous version of the flow's
4549          * actions, so that when the operation commits we report the change. */
4550         switch (op->type) {
4551         case OFOPERATION_ADD:
4552             NOT_REACHED();
4553
4554         case OFOPERATION_MODIFY:
4555         case OFOPERATION_REPLACE:
4556             actions = op->actions ? op->actions : rule->actions;
4557             break;
4558
4559         case OFOPERATION_DELETE:
4560             actions = rule->actions;
4561             break;
4562
4563         default:
4564             NOT_REACHED();
4565         }
4566     }
4567     fu.ofpacts = actions ? actions->ofpacts : NULL;
4568     fu.ofpacts_len = actions ? actions->ofpacts_len : 0;
4569
4570     if (list_is_empty(msgs)) {
4571         ofputil_start_flow_update(msgs);
4572     }
4573     ofputil_append_flow_update(&fu, msgs);
4574 }
4575
4576 void
4577 ofmonitor_compose_refresh_updates(struct rule_collection *rules,
4578                                   struct list *msgs)
4579     OVS_REQUIRES(ofproto_mutex)
4580 {
4581     size_t i;
4582
4583     for (i = 0; i < rules->n; i++) {
4584         struct rule *rule = rules->rules[i];
4585         enum nx_flow_monitor_flags flags = rule->monitor_flags;
4586         rule->monitor_flags = 0;
4587
4588         ofproto_compose_flow_refresh_update(rule, flags, msgs);
4589     }
4590 }
4591
4592 static void
4593 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
4594                                        struct rule *rule, uint64_t seqno,
4595                                        struct rule_collection *rules)
4596     OVS_REQUIRES(ofproto_mutex)
4597 {
4598     enum nx_flow_monitor_flags update;
4599
4600     if (ofproto_rule_is_hidden(rule)) {
4601         return;
4602     }
4603
4604     if (!(rule->pending
4605           ? ofoperation_has_out_port(rule->pending, m->out_port)
4606           : ofproto_rule_has_out_port(rule, m->out_port))) {
4607         return;
4608     }
4609
4610     if (seqno) {
4611         if (rule->add_seqno > seqno) {
4612             update = NXFMF_ADD | NXFMF_MODIFY;
4613         } else if (rule->modify_seqno > seqno) {
4614             update = NXFMF_MODIFY;
4615         } else {
4616             return;
4617         }
4618
4619         if (!(m->flags & update)) {
4620             return;
4621         }
4622     } else {
4623         update = NXFMF_INITIAL;
4624     }
4625
4626     if (!rule->monitor_flags) {
4627         rule_collection_add(rules, rule);
4628     }
4629     rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
4630 }
4631
4632 static void
4633 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
4634                                         uint64_t seqno,
4635                                         struct rule_collection *rules)
4636     OVS_REQUIRES(ofproto_mutex)
4637 {
4638     const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
4639     const struct ofoperation *op;
4640     const struct oftable *table;
4641     struct cls_rule target;
4642
4643     cls_rule_init_from_minimatch(&target, &m->match, 0);
4644     FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
4645         struct cls_cursor cursor;
4646         struct rule *rule;
4647
4648         ovs_rwlock_rdlock(&table->cls.rwlock);
4649         cls_cursor_init(&cursor, &table->cls, &target);
4650         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4651             ovs_assert(!rule->pending); /* XXX */
4652             ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4653         }
4654         ovs_rwlock_unlock(&table->cls.rwlock);
4655     }
4656
4657     HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
4658         struct rule *rule = op->rule;
4659
4660         if (((m->table_id == 0xff
4661               ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
4662               : m->table_id == rule->table_id))
4663             && cls_rule_is_loose_match(&rule->cr, &target.match)) {
4664             ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
4665         }
4666     }
4667     cls_rule_destroy(&target);
4668 }
4669
4670 static void
4671 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
4672                                         struct rule_collection *rules)
4673     OVS_REQUIRES(ofproto_mutex)
4674 {
4675     if (m->flags & NXFMF_INITIAL) {
4676         ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
4677     }
4678 }
4679
4680 void
4681 ofmonitor_collect_resume_rules(struct ofmonitor *m,
4682                                uint64_t seqno, struct rule_collection *rules)
4683     OVS_REQUIRES(ofproto_mutex)
4684 {
4685     ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
4686 }
4687
4688 static enum ofperr
4689 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
4690     OVS_EXCLUDED(ofproto_mutex)
4691 {
4692     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4693     struct ofmonitor **monitors;
4694     size_t n_monitors, allocated_monitors;
4695     struct rule_collection rules;
4696     struct list replies;
4697     enum ofperr error;
4698     struct ofpbuf b;
4699     size_t i;
4700
4701     error = 0;
4702     ofpbuf_use_const(&b, oh, ntohs(oh->length));
4703     monitors = NULL;
4704     n_monitors = allocated_monitors = 0;
4705
4706     ovs_mutex_lock(&ofproto_mutex);
4707     for (;;) {
4708         struct ofputil_flow_monitor_request request;
4709         struct ofmonitor *m;
4710         int retval;
4711
4712         retval = ofputil_decode_flow_monitor_request(&request, &b);
4713         if (retval == EOF) {
4714             break;
4715         } else if (retval) {
4716             error = retval;
4717             goto error;
4718         }
4719
4720         if (request.table_id != 0xff
4721             && request.table_id >= ofproto->n_tables) {
4722             error = OFPERR_OFPBRC_BAD_TABLE_ID;
4723             goto error;
4724         }
4725
4726         error = ofmonitor_create(&request, ofconn, &m);
4727         if (error) {
4728             goto error;
4729         }
4730
4731         if (n_monitors >= allocated_monitors) {
4732             monitors = x2nrealloc(monitors, &allocated_monitors,
4733                                   sizeof *monitors);
4734         }
4735         monitors[n_monitors++] = m;
4736     }
4737
4738     rule_collection_init(&rules);
4739     for (i = 0; i < n_monitors; i++) {
4740         ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
4741     }
4742
4743     ofpmp_init(&replies, oh);
4744     ofmonitor_compose_refresh_updates(&rules, &replies);
4745     ovs_mutex_unlock(&ofproto_mutex);
4746
4747     rule_collection_destroy(&rules);
4748
4749     ofconn_send_replies(ofconn, &replies);
4750     free(monitors);
4751
4752     return 0;
4753
4754 error:
4755     for (i = 0; i < n_monitors; i++) {
4756         ofmonitor_destroy(monitors[i]);
4757     }
4758     free(monitors);
4759     ovs_mutex_unlock(&ofproto_mutex);
4760
4761     return error;
4762 }
4763
4764 static enum ofperr
4765 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
4766     OVS_EXCLUDED(ofproto_mutex)
4767 {
4768     struct ofmonitor *m;
4769     enum ofperr error;
4770     uint32_t id;
4771
4772     id = ofputil_decode_flow_monitor_cancel(oh);
4773
4774     ovs_mutex_lock(&ofproto_mutex);
4775     m = ofmonitor_lookup(ofconn, id);
4776     if (m) {
4777         ofmonitor_destroy(m);
4778         error = 0;
4779     } else {
4780         error = OFPERR_NXBRC_FM_BAD_ID;
4781     }
4782     ovs_mutex_unlock(&ofproto_mutex);
4783
4784     return error;
4785 }
4786
4787 /* Meters implementation.
4788  *
4789  * Meter table entry, indexed by the OpenFlow meter_id.
4790  * These are always dynamically allocated to allocate enough space for
4791  * the bands.
4792  * 'created' is used to compute the duration for meter stats.
4793  * 'list rules' is needed so that we can delete the dependent rules when the
4794  * meter table entry is deleted.
4795  * 'provider_meter_id' is for the provider's private use.
4796  */
4797 struct meter {
4798     long long int created;      /* Time created. */
4799     struct list rules;          /* List of "struct rule_dpif"s. */
4800     ofproto_meter_id provider_meter_id;
4801     uint16_t flags;             /* Meter flags. */
4802     uint16_t n_bands;           /* Number of meter bands. */
4803     struct ofputil_meter_band *bands;
4804 };
4805
4806 /*
4807  * This is used in instruction validation at flow set-up time,
4808  * as flows may not use non-existing meters.
4809  * This is also used by ofproto-providers to translate OpenFlow meter_ids
4810  * in METER instructions to the corresponding provider meter IDs.
4811  * Return value of UINT32_MAX signifies an invalid meter.
4812  */
4813 uint32_t
4814 ofproto_get_provider_meter_id(const struct ofproto * ofproto,
4815                               uint32_t of_meter_id)
4816 {
4817     if (of_meter_id && of_meter_id <= ofproto->meter_features.max_meters) {
4818         const struct meter *meter = ofproto->meters[of_meter_id];
4819         if (meter) {
4820             return meter->provider_meter_id.uint32;
4821         }
4822     }
4823     return UINT32_MAX;
4824 }
4825
4826 static void
4827 meter_update(struct meter *meter, const struct ofputil_meter_config *config)
4828 {
4829     free(meter->bands);
4830
4831     meter->flags = config->flags;
4832     meter->n_bands = config->n_bands;
4833     meter->bands = xmemdup(config->bands,
4834                            config->n_bands * sizeof *meter->bands);
4835 }
4836
4837 static struct meter *
4838 meter_create(const struct ofputil_meter_config *config,
4839              ofproto_meter_id provider_meter_id)
4840 {
4841     struct meter *meter;
4842
4843     meter = xzalloc(sizeof *meter);
4844     meter->provider_meter_id = provider_meter_id;
4845     meter->created = time_msec();
4846     list_init(&meter->rules);
4847
4848     meter_update(meter, config);
4849
4850     return meter;
4851 }
4852
4853 static void
4854 meter_delete(struct ofproto *ofproto, uint32_t first, uint32_t last)
4855     OVS_REQUIRES(ofproto_mutex)
4856 {
4857     uint32_t mid;
4858     for (mid = first; mid <= last; ++mid) {
4859         struct meter *meter = ofproto->meters[mid];
4860         if (meter) {
4861             ofproto->meters[mid] = NULL;
4862             ofproto->ofproto_class->meter_del(ofproto,
4863                                               meter->provider_meter_id);
4864             free(meter->bands);
4865             free(meter);
4866         }
4867     }
4868 }
4869
4870 static enum ofperr
4871 handle_add_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4872 {
4873     ofproto_meter_id provider_meter_id = { UINT32_MAX };
4874     struct meter **meterp = &ofproto->meters[mm->meter.meter_id];
4875     enum ofperr error;
4876
4877     if (*meterp) {
4878         return OFPERR_OFPMMFC_METER_EXISTS;
4879     }
4880
4881     error = ofproto->ofproto_class->meter_set(ofproto, &provider_meter_id,
4882                                               &mm->meter);
4883     if (!error) {
4884         ovs_assert(provider_meter_id.uint32 != UINT32_MAX);
4885         *meterp = meter_create(&mm->meter, provider_meter_id);
4886     }
4887     return 0;
4888 }
4889
4890 static enum ofperr
4891 handle_modify_meter(struct ofproto *ofproto, struct ofputil_meter_mod *mm)
4892 {
4893     struct meter *meter = ofproto->meters[mm->meter.meter_id];
4894     enum ofperr error;
4895
4896     if (!meter) {
4897         return OFPERR_OFPMMFC_UNKNOWN_METER;
4898     }
4899
4900     error = ofproto->ofproto_class->meter_set(ofproto,
4901                                               &meter->provider_meter_id,
4902                                               &mm->meter);
4903     ovs_assert(meter->provider_meter_id.uint32 != UINT32_MAX);
4904     if (!error) {
4905         meter_update(meter, &mm->meter);
4906     }
4907     return error;
4908 }
4909
4910 static enum ofperr
4911 handle_delete_meter(struct ofconn *ofconn, const struct ofp_header *oh,
4912                     struct ofputil_meter_mod *mm)
4913     OVS_EXCLUDED(ofproto_mutex)
4914 {
4915     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4916     uint32_t meter_id = mm->meter.meter_id;
4917     struct rule_collection rules;
4918     enum ofperr error = 0;
4919     uint32_t first, last;
4920
4921     if (meter_id == OFPM13_ALL) {
4922         first = 1;
4923         last = ofproto->meter_features.max_meters;
4924     } else {
4925         if (!meter_id || meter_id > ofproto->meter_features.max_meters) {
4926             return 0;
4927         }
4928         first = last = meter_id;
4929     }
4930
4931     /* First delete the rules that use this meter.  If any of those rules are
4932      * currently being modified, postpone the whole operation until later. */
4933     rule_collection_init(&rules);
4934     ovs_mutex_lock(&ofproto_mutex);
4935     for (meter_id = first; meter_id <= last; ++meter_id) {
4936         struct meter *meter = ofproto->meters[meter_id];
4937         if (meter && !list_is_empty(&meter->rules)) {
4938             struct rule *rule;
4939
4940             LIST_FOR_EACH (rule, meter_list_node, &meter->rules) {
4941                 if (rule->pending) {
4942                     error = OFPROTO_POSTPONE;
4943                     goto exit;
4944                 }
4945                 rule_collection_add(&rules, rule);
4946             }
4947         }
4948     }
4949     if (rules.n > 0) {
4950         delete_flows__(ofproto, ofconn, oh, &rules, OFPRR_METER_DELETE);
4951     }
4952
4953     /* Delete the meters. */
4954     meter_delete(ofproto, first, last);
4955
4956 exit:
4957     ovs_mutex_unlock(&ofproto_mutex);
4958     rule_collection_destroy(&rules);
4959
4960     return error;
4961 }
4962
4963 static enum ofperr
4964 handle_meter_mod(struct ofconn *ofconn, const struct ofp_header *oh)
4965 {
4966     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
4967     struct ofputil_meter_mod mm;
4968     uint64_t bands_stub[256 / 8];
4969     struct ofpbuf bands;
4970     uint32_t meter_id;
4971     enum ofperr error;
4972
4973     error = reject_slave_controller(ofconn);
4974     if (error) {
4975         return error;
4976     }
4977
4978     ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
4979
4980     error = ofputil_decode_meter_mod(oh, &mm, &bands);
4981     if (error) {
4982         goto exit_free_bands;
4983     }
4984
4985     meter_id = mm.meter.meter_id;
4986
4987     if (mm.command != OFPMC13_DELETE) {
4988         /* Fails also when meters are not implemented by the provider. */
4989         if (meter_id == 0 || meter_id > OFPM13_MAX) {
4990             error = OFPERR_OFPMMFC_INVALID_METER;
4991             goto exit_free_bands;
4992         } else if (meter_id > ofproto->meter_features.max_meters) {
4993             error = OFPERR_OFPMMFC_OUT_OF_METERS;
4994             goto exit_free_bands;
4995         }
4996         if (mm.meter.n_bands > ofproto->meter_features.max_bands) {
4997             error = OFPERR_OFPMMFC_OUT_OF_BANDS;
4998             goto exit_free_bands;
4999         }
5000     }
5001
5002     switch (mm.command) {
5003     case OFPMC13_ADD:
5004         error = handle_add_meter(ofproto, &mm);
5005         break;
5006
5007     case OFPMC13_MODIFY:
5008         error = handle_modify_meter(ofproto, &mm);
5009         break;
5010
5011     case OFPMC13_DELETE:
5012         error = handle_delete_meter(ofconn, oh, &mm);
5013         break;
5014
5015     default:
5016         error = OFPERR_OFPMMFC_BAD_COMMAND;
5017         break;
5018     }
5019
5020 exit_free_bands:
5021     ofpbuf_uninit(&bands);
5022     return error;
5023 }
5024
5025 static enum ofperr
5026 handle_meter_features_request(struct ofconn *ofconn,
5027                               const struct ofp_header *request)
5028 {
5029     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5030     struct ofputil_meter_features features;
5031     struct ofpbuf *b;
5032
5033     if (ofproto->ofproto_class->meter_get_features) {
5034         ofproto->ofproto_class->meter_get_features(ofproto, &features);
5035     } else {
5036         memset(&features, 0, sizeof features);
5037     }
5038     b = ofputil_encode_meter_features_reply(&features, request);
5039
5040     ofconn_send_reply(ofconn, b);
5041     return 0;
5042 }
5043
5044 static enum ofperr
5045 handle_meter_request(struct ofconn *ofconn, const struct ofp_header *request,
5046                      enum ofptype type)
5047 {
5048     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
5049     struct list replies;
5050     uint64_t bands_stub[256 / 8];
5051     struct ofpbuf bands;
5052     uint32_t meter_id, first, last;
5053
5054     ofputil_decode_meter_request(request, &meter_id);
5055
5056     if (meter_id == OFPM13_ALL) {
5057         first = 1;
5058         last = ofproto->meter_features.max_meters;
5059     } else {
5060         if (!meter_id || meter_id > ofproto->meter_features.max_meters ||
5061             !ofproto->meters[meter_id]) {
5062             return OFPERR_OFPMMFC_UNKNOWN_METER;
5063         }
5064         first = last = meter_id;
5065     }
5066
5067     ofpbuf_use_stub(&bands, bands_stub, sizeof bands_stub);
5068     ofpmp_init(&replies, request);
5069
5070     for (meter_id = first; meter_id <= last; ++meter_id) {
5071         struct meter *meter = ofproto->meters[meter_id];
5072         if (!meter) {
5073             continue; /* Skip non-existing meters. */
5074         }
5075         if (type == OFPTYPE_METER_STATS_REQUEST) {
5076             struct ofputil_meter_stats stats;
5077
5078             stats.meter_id = meter_id;
5079
5080             /* Provider sets the packet and byte counts, we do the rest. */
5081             stats.flow_count = list_size(&meter->rules);
5082             calc_duration(meter->created, time_msec(),
5083                           &stats.duration_sec, &stats.duration_nsec);
5084             stats.n_bands = meter->n_bands;
5085             ofpbuf_clear(&bands);
5086             stats.bands
5087                 = ofpbuf_put_uninit(&bands,
5088                                     meter->n_bands * sizeof *stats.bands);
5089
5090             if (!ofproto->ofproto_class->meter_get(ofproto,
5091                                                    meter->provider_meter_id,
5092                                                    &stats)) {
5093                 ofputil_append_meter_stats(&replies, &stats);
5094             }
5095         } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5096             struct ofputil_meter_config config;
5097
5098             config.meter_id = meter_id;
5099             config.flags = meter->flags;
5100             config.n_bands = meter->n_bands;
5101             config.bands = meter->bands;
5102             ofputil_append_meter_config(&replies, &config);
5103         }
5104     }
5105
5106     ofconn_send_replies(ofconn, &replies);
5107     ofpbuf_uninit(&bands);
5108     return 0;
5109 }
5110
5111 static enum ofperr
5112 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
5113     OVS_EXCLUDED(ofproto_mutex)
5114 {
5115     const struct ofp_header *oh = msg->data;
5116     enum ofptype type;
5117     enum ofperr error;
5118
5119     error = ofptype_decode(&type, oh);
5120     if (error) {
5121         return error;
5122     }
5123
5124     switch (type) {
5125         /* OpenFlow requests. */
5126     case OFPTYPE_ECHO_REQUEST:
5127         return handle_echo_request(ofconn, oh);
5128
5129     case OFPTYPE_FEATURES_REQUEST:
5130         return handle_features_request(ofconn, oh);
5131
5132     case OFPTYPE_GET_CONFIG_REQUEST:
5133         return handle_get_config_request(ofconn, oh);
5134
5135     case OFPTYPE_SET_CONFIG:
5136         return handle_set_config(ofconn, oh);
5137
5138     case OFPTYPE_PACKET_OUT:
5139         return handle_packet_out(ofconn, oh);
5140
5141     case OFPTYPE_PORT_MOD:
5142         return handle_port_mod(ofconn, oh);
5143
5144     case OFPTYPE_FLOW_MOD:
5145         return handle_flow_mod(ofconn, oh);
5146
5147     case OFPTYPE_METER_MOD:
5148         return handle_meter_mod(ofconn, oh);
5149
5150     case OFPTYPE_BARRIER_REQUEST:
5151         return handle_barrier_request(ofconn, oh);
5152
5153     case OFPTYPE_ROLE_REQUEST:
5154         return handle_role_request(ofconn, oh);
5155
5156         /* OpenFlow replies. */
5157     case OFPTYPE_ECHO_REPLY:
5158         return 0;
5159
5160         /* Nicira extension requests. */
5161     case OFPTYPE_FLOW_MOD_TABLE_ID:
5162         return handle_nxt_flow_mod_table_id(ofconn, oh);
5163
5164     case OFPTYPE_SET_FLOW_FORMAT:
5165         return handle_nxt_set_flow_format(ofconn, oh);
5166
5167     case OFPTYPE_SET_PACKET_IN_FORMAT:
5168         return handle_nxt_set_packet_in_format(ofconn, oh);
5169
5170     case OFPTYPE_SET_CONTROLLER_ID:
5171         return handle_nxt_set_controller_id(ofconn, oh);
5172
5173     case OFPTYPE_FLOW_AGE:
5174         /* Nothing to do. */
5175         return 0;
5176
5177     case OFPTYPE_FLOW_MONITOR_CANCEL:
5178         return handle_flow_monitor_cancel(ofconn, oh);
5179
5180     case OFPTYPE_SET_ASYNC_CONFIG:
5181         return handle_nxt_set_async_config(ofconn, oh);
5182
5183         /* Statistics requests. */
5184     case OFPTYPE_DESC_STATS_REQUEST:
5185         return handle_desc_stats_request(ofconn, oh);
5186
5187     case OFPTYPE_FLOW_STATS_REQUEST:
5188         return handle_flow_stats_request(ofconn, oh);
5189
5190     case OFPTYPE_AGGREGATE_STATS_REQUEST:
5191         return handle_aggregate_stats_request(ofconn, oh);
5192
5193     case OFPTYPE_TABLE_STATS_REQUEST:
5194         return handle_table_stats_request(ofconn, oh);
5195
5196     case OFPTYPE_PORT_STATS_REQUEST:
5197         return handle_port_stats_request(ofconn, oh);
5198
5199     case OFPTYPE_QUEUE_STATS_REQUEST:
5200         return handle_queue_stats_request(ofconn, oh);
5201
5202     case OFPTYPE_PORT_DESC_STATS_REQUEST:
5203         return handle_port_desc_stats_request(ofconn, oh);
5204
5205     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
5206         return handle_flow_monitor_request(ofconn, oh);
5207
5208     case OFPTYPE_METER_STATS_REQUEST:
5209     case OFPTYPE_METER_CONFIG_STATS_REQUEST:
5210         return handle_meter_request(ofconn, oh, type);
5211
5212     case OFPTYPE_METER_FEATURES_STATS_REQUEST:
5213         return handle_meter_features_request(ofconn, oh);
5214
5215         /* FIXME: Change the following once they are implemented: */
5216     case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
5217     case OFPTYPE_GET_ASYNC_REQUEST:
5218     case OFPTYPE_GROUP_STATS_REQUEST:
5219     case OFPTYPE_GROUP_DESC_STATS_REQUEST:
5220     case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
5221     case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
5222         return OFPERR_OFPBRC_BAD_TYPE;
5223
5224     case OFPTYPE_HELLO:
5225     case OFPTYPE_ERROR:
5226     case OFPTYPE_FEATURES_REPLY:
5227     case OFPTYPE_GET_CONFIG_REPLY:
5228     case OFPTYPE_PACKET_IN:
5229     case OFPTYPE_FLOW_REMOVED:
5230     case OFPTYPE_PORT_STATUS:
5231     case OFPTYPE_BARRIER_REPLY:
5232     case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
5233     case OFPTYPE_DESC_STATS_REPLY:
5234     case OFPTYPE_FLOW_STATS_REPLY:
5235     case OFPTYPE_QUEUE_STATS_REPLY:
5236     case OFPTYPE_PORT_STATS_REPLY:
5237     case OFPTYPE_TABLE_STATS_REPLY:
5238     case OFPTYPE_AGGREGATE_STATS_REPLY:
5239     case OFPTYPE_PORT_DESC_STATS_REPLY:
5240     case OFPTYPE_ROLE_REPLY:
5241     case OFPTYPE_FLOW_MONITOR_PAUSED:
5242     case OFPTYPE_FLOW_MONITOR_RESUMED:
5243     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
5244     case OFPTYPE_GET_ASYNC_REPLY:
5245     case OFPTYPE_GROUP_STATS_REPLY:
5246     case OFPTYPE_GROUP_DESC_STATS_REPLY:
5247     case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
5248     case OFPTYPE_METER_STATS_REPLY:
5249     case OFPTYPE_METER_CONFIG_STATS_REPLY:
5250     case OFPTYPE_METER_FEATURES_STATS_REPLY:
5251     case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
5252     default:
5253         return OFPERR_OFPBRC_BAD_TYPE;
5254     }
5255 }
5256
5257 static bool
5258 handle_openflow(struct ofconn *ofconn, const struct ofpbuf *ofp_msg)
5259     OVS_EXCLUDED(ofproto_mutex)
5260 {
5261     int error = handle_openflow__(ofconn, ofp_msg);
5262     if (error && error != OFPROTO_POSTPONE) {
5263         ofconn_send_error(ofconn, ofp_msg->data, error);
5264     }
5265     COVERAGE_INC(ofproto_recv_openflow);
5266     return error != OFPROTO_POSTPONE;
5267 }
5268 \f
5269 /* Asynchronous operations. */
5270
5271 /* Creates and returns a new ofopgroup that is not associated with any
5272  * OpenFlow connection.
5273  *
5274  * The caller should add operations to the returned group with
5275  * ofoperation_create() and then submit it with ofopgroup_submit(). */
5276 static struct ofopgroup *
5277 ofopgroup_create_unattached(struct ofproto *ofproto)
5278     OVS_REQUIRES(ofproto_mutex)
5279 {
5280     struct ofopgroup *group = xzalloc(sizeof *group);
5281     group->ofproto = ofproto;
5282     list_init(&group->ofproto_node);
5283     list_init(&group->ops);
5284     list_init(&group->ofconn_node);
5285     return group;
5286 }
5287
5288 /* Creates and returns a new ofopgroup for 'ofproto'.
5289  *
5290  * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
5291  * connection.  The 'request' and 'buffer_id' arguments are ignored.
5292  *
5293  * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
5294  * If the ofopgroup eventually fails, then the error reply will include
5295  * 'request'.  If the ofopgroup eventually succeeds, then the packet with
5296  * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
5297  *
5298  * The caller should add operations to the returned group with
5299  * ofoperation_create() and then submit it with ofopgroup_submit(). */
5300 static struct ofopgroup *
5301 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
5302                  const struct ofp_header *request, uint32_t buffer_id)
5303     OVS_REQUIRES(ofproto_mutex)
5304 {
5305     struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
5306     if (ofconn) {
5307         size_t request_len = ntohs(request->length);
5308
5309         ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
5310
5311         ofconn_add_opgroup(ofconn, &group->ofconn_node);
5312         group->ofconn = ofconn;
5313         group->request = xmemdup(request, MIN(request_len, 64));
5314         group->buffer_id = buffer_id;
5315     }
5316     return group;
5317 }
5318
5319 /* Submits 'group' for processing.
5320  *
5321  * If 'group' contains no operations (e.g. none were ever added, or all of the
5322  * ones that were added completed synchronously), then it is destroyed
5323  * immediately.  Otherwise it is added to the ofproto's list of pending
5324  * groups. */
5325 static void
5326 ofopgroup_submit(struct ofopgroup *group)
5327     OVS_REQUIRES(ofproto_mutex)
5328 {
5329     if (!group->n_running) {
5330         ofopgroup_complete(group);
5331     } else {
5332         list_push_back(&group->ofproto->pending, &group->ofproto_node);
5333         group->ofproto->n_pending++;
5334     }
5335 }
5336
5337 static void
5338 ofopgroup_complete(struct ofopgroup *group)
5339     OVS_REQUIRES(ofproto_mutex)
5340 {
5341     struct ofproto *ofproto = group->ofproto;
5342
5343     struct ofconn *abbrev_ofconn;
5344     ovs_be32 abbrev_xid;
5345
5346     struct ofoperation *op, *next_op;
5347     int error;
5348
5349     ovs_assert(!group->n_running);
5350
5351     error = 0;
5352     LIST_FOR_EACH (op, group_node, &group->ops) {
5353         if (op->error) {
5354             error = op->error;
5355             break;
5356         }
5357     }
5358
5359     if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
5360         LIST_FOR_EACH (op, group_node, &group->ops) {
5361             if (op->type != OFOPERATION_DELETE) {
5362                 struct ofpbuf *packet;
5363                 ofp_port_t in_port;
5364
5365                 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
5366                                                &packet, &in_port);
5367                 if (packet) {
5368                     struct rule_execute *re;
5369
5370                     ovs_assert(!error);
5371
5372                     ofproto_rule_ref(op->rule);
5373
5374                     re = xmalloc(sizeof *re);
5375                     re->rule = op->rule;
5376                     re->in_port = in_port;
5377                     re->packet = packet;
5378
5379                     if (!guarded_list_push_back(&ofproto->rule_executes,
5380                                                 &re->list_node, 1024)) {
5381                         ofproto_rule_unref(op->rule);
5382                         ofpbuf_delete(re->packet);
5383                         free(re);
5384                     }
5385                 }
5386                 break;
5387             }
5388         }
5389     }
5390
5391     if (!error && !list_is_empty(&group->ofconn_node)) {
5392         abbrev_ofconn = group->ofconn;
5393         abbrev_xid = group->request->xid;
5394     } else {
5395         abbrev_ofconn = NULL;
5396         abbrev_xid = htonl(0);
5397     }
5398     LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
5399         struct rule *rule = op->rule;
5400
5401         /* We generally want to report the change to active OpenFlow flow
5402            monitors (e.g. NXST_FLOW_MONITOR).  There are three exceptions:
5403
5404               - The operation failed.
5405
5406               - The affected rule is not visible to controllers.
5407
5408               - The operation's only effect was to update rule->modified. */
5409         if (!(op->error
5410               || ofproto_rule_is_hidden(rule)
5411               || (op->type == OFOPERATION_MODIFY
5412                   && op->actions
5413                   && rule->flow_cookie == op->flow_cookie))) {
5414             /* Check that we can just cast from ofoperation_type to
5415              * nx_flow_update_event. */
5416             enum nx_flow_update_event event_type;
5417
5418             switch (op->type) {
5419             case OFOPERATION_ADD:
5420             case OFOPERATION_REPLACE:
5421                 event_type = NXFME_ADDED;
5422                 break;
5423
5424             case OFOPERATION_DELETE:
5425                 event_type = NXFME_DELETED;
5426                 break;
5427
5428             case OFOPERATION_MODIFY:
5429                 event_type = NXFME_MODIFIED;
5430                 break;
5431
5432             default:
5433                 NOT_REACHED();
5434             }
5435
5436             ofmonitor_report(ofproto->connmgr, rule, event_type,
5437                              op->reason, abbrev_ofconn, abbrev_xid);
5438         }
5439
5440         rule->pending = NULL;
5441
5442         switch (op->type) {
5443         case OFOPERATION_ADD:
5444             if (!op->error) {
5445                 uint16_t vid_mask;
5446
5447                 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
5448                 if (vid_mask == VLAN_VID_MASK) {
5449                     if (ofproto->vlan_bitmap) {
5450                         uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
5451                         if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
5452                             bitmap_set1(ofproto->vlan_bitmap, vid);
5453                             ofproto->vlans_changed = true;
5454                         }
5455                     } else {
5456                         ofproto->vlans_changed = true;
5457                     }
5458                 }
5459             } else {
5460                 oftable_remove_rule(rule);
5461                 ofproto_rule_unref(rule);
5462             }
5463             break;
5464
5465         case OFOPERATION_DELETE:
5466             ovs_assert(!op->error);
5467             ofproto_rule_unref(rule);
5468             op->rule = NULL;
5469             break;
5470
5471         case OFOPERATION_MODIFY:
5472         case OFOPERATION_REPLACE:
5473             if (!op->error) {
5474                 long long int now = time_msec();
5475
5476                 rule->modified = now;
5477                 if (op->type == OFOPERATION_REPLACE) {
5478                     rule->created = rule->used = now;
5479                 }
5480             } else {
5481                 ofproto_rule_change_cookie(ofproto, rule, op->flow_cookie);
5482                 ovs_mutex_lock(&rule->mutex);
5483                 rule->idle_timeout = op->idle_timeout;
5484                 rule->hard_timeout = op->hard_timeout;
5485                 ovs_mutex_unlock(&rule->mutex);
5486                 if (op->actions) {
5487                     struct rule_actions *old_actions;
5488
5489                     ovs_mutex_lock(&rule->mutex);
5490                     old_actions = rule->actions;
5491                     rule->actions = op->actions;
5492                     ovs_mutex_unlock(&rule->mutex);
5493
5494                     op->actions = NULL;
5495                     rule_actions_unref(old_actions);
5496                 }
5497                 rule->send_flow_removed = op->send_flow_removed;
5498             }
5499             break;
5500
5501         default:
5502             NOT_REACHED();
5503         }
5504
5505         ofoperation_destroy(op);
5506     }
5507
5508     ofmonitor_flush(ofproto->connmgr);
5509
5510     if (!list_is_empty(&group->ofproto_node)) {
5511         ovs_assert(ofproto->n_pending > 0);
5512         ofproto->n_pending--;
5513         list_remove(&group->ofproto_node);
5514     }
5515     if (!list_is_empty(&group->ofconn_node)) {
5516         list_remove(&group->ofconn_node);
5517         if (error) {
5518             ofconn_send_error(group->ofconn, group->request, error);
5519         }
5520         connmgr_retry(ofproto->connmgr);
5521     }
5522     free(group->request);
5523     free(group);
5524 }
5525
5526 /* Initiates a new operation on 'rule', of the specified 'type', within
5527  * 'group'.  Prior to calling, 'rule' must not have any pending operation.
5528  *
5529  * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
5530  * the flow is being deleted.  For other 'type's, 'reason' is ignored (use 0).
5531  *
5532  * Returns the newly created ofoperation (which is also available as
5533  * rule->pending). */
5534 static struct ofoperation *
5535 ofoperation_create(struct ofopgroup *group, struct rule *rule,
5536                    enum ofoperation_type type,
5537                    enum ofp_flow_removed_reason reason)
5538     OVS_REQUIRES(ofproto_mutex)
5539 {
5540     struct ofproto *ofproto = group->ofproto;
5541     struct ofoperation *op;
5542
5543     ovs_assert(!rule->pending);
5544
5545     op = rule->pending = xzalloc(sizeof *op);
5546     op->group = group;
5547     list_push_back(&group->ops, &op->group_node);
5548     op->rule = rule;
5549     op->type = type;
5550     op->reason = reason;
5551     op->flow_cookie = rule->flow_cookie;
5552     ovs_mutex_lock(&rule->mutex);
5553     op->idle_timeout = rule->idle_timeout;
5554     op->hard_timeout = rule->hard_timeout;
5555     ovs_mutex_unlock(&rule->mutex);
5556     op->send_flow_removed = rule->send_flow_removed;
5557
5558     group->n_running++;
5559
5560     if (type == OFOPERATION_DELETE) {
5561         hmap_insert(&ofproto->deletions, &op->hmap_node,
5562                     cls_rule_hash(&rule->cr, rule->table_id));
5563     }
5564
5565     return op;
5566 }
5567
5568 static void
5569 ofoperation_destroy(struct ofoperation *op)
5570     OVS_REQUIRES(ofproto_mutex)
5571 {
5572     struct ofopgroup *group = op->group;
5573
5574     if (op->rule) {
5575         op->rule->pending = NULL;
5576     }
5577     if (op->type == OFOPERATION_DELETE) {
5578         hmap_remove(&group->ofproto->deletions, &op->hmap_node);
5579     }
5580     list_remove(&op->group_node);
5581     rule_actions_unref(op->actions);
5582     free(op);
5583 }
5584
5585 /* Indicates that 'op' completed with status 'error', which is either 0 to
5586  * indicate success or an OpenFlow error code on failure.
5587  *
5588  * If 'error' is 0, indicating success, the operation will be committed
5589  * permanently to the flow table.
5590  *
5591  * If 'error' is nonzero, then generally the operation will be rolled back:
5592  *
5593  *   - If 'op' is an "add flow" operation, ofproto removes the new rule or
5594  *     restores the original rule.  The caller must have uninitialized any
5595  *     derived state in the new rule, as in step 5 of in the "Life Cycle" in
5596  *     ofproto/ofproto-provider.h.  ofoperation_complete() performs steps 6 and
5597  *     and 7 for the new rule, calling its ->rule_dealloc() function.
5598  *
5599  *   - If 'op' is a "modify flow" operation, ofproto restores the original
5600  *     actions.
5601  *
5602  *   - 'op' must not be a "delete flow" operation.  Removing a rule is not
5603  *     allowed to fail.  It must always succeed.
5604  *
5605  * Please see the large comment in ofproto/ofproto-provider.h titled
5606  * "Asynchronous Operation Support" for more information. */
5607 void
5608 ofoperation_complete(struct ofoperation *op, enum ofperr error)
5609 {
5610     struct ofopgroup *group = op->group;
5611
5612     ovs_assert(group->n_running > 0);
5613     ovs_assert(!error || op->type != OFOPERATION_DELETE);
5614
5615     op->error = error;
5616     if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
5617         /* This function can be called from ->rule_construct(), in which case
5618          * ofproto_mutex is held, or it can be called from ->run(), in which
5619          * case ofproto_mutex is not held.  But only in the latter case can we
5620          * arrive here, so we can safely take ofproto_mutex now. */
5621         ovs_mutex_lock(&ofproto_mutex);
5622         ovs_assert(op->rule->pending == op);
5623         ofopgroup_complete(group);
5624         ovs_mutex_unlock(&ofproto_mutex);
5625     }
5626 }
5627 \f
5628 static uint64_t
5629 pick_datapath_id(const struct ofproto *ofproto)
5630 {
5631     const struct ofport *port;
5632
5633     port = ofproto_get_port(ofproto, OFPP_LOCAL);
5634     if (port) {
5635         uint8_t ea[ETH_ADDR_LEN];
5636         int error;
5637
5638         error = netdev_get_etheraddr(port->netdev, ea);
5639         if (!error) {
5640             return eth_addr_to_uint64(ea);
5641         }
5642         VLOG_WARN("%s: could not get MAC address for %s (%s)",
5643                   ofproto->name, netdev_get_name(port->netdev),
5644                   ovs_strerror(error));
5645     }
5646     return ofproto->fallback_dpid;
5647 }
5648
5649 static uint64_t
5650 pick_fallback_dpid(void)
5651 {
5652     uint8_t ea[ETH_ADDR_LEN];
5653     eth_addr_nicira_random(ea);
5654     return eth_addr_to_uint64(ea);
5655 }
5656 \f
5657 /* Table overflow policy. */
5658
5659 /* Chooses and updates 'rulep' with a rule to evict from 'table'.  Sets 'rulep'
5660  * to NULL if the table is not configured to evict rules or if the table
5661  * contains no evictable rules.  (Rules with a readlock on their evict rwlock,
5662  * or with no timeouts are not evictable.) */
5663 static bool
5664 choose_rule_to_evict(struct oftable *table, struct rule **rulep)
5665     OVS_REQUIRES(ofproto_mutex)
5666 {
5667     struct eviction_group *evg;
5668
5669     *rulep = NULL;
5670     if (!table->eviction_fields) {
5671         return false;
5672     }
5673
5674     /* In the common case, the outer and inner loops here will each be entered
5675      * exactly once:
5676      *
5677      *   - The inner loop normally "return"s in its first iteration.  If the
5678      *     eviction group has any evictable rules, then it always returns in
5679      *     some iteration.
5680      *
5681      *   - The outer loop only iterates more than once if the largest eviction
5682      *     group has no evictable rules.
5683      *
5684      *   - The outer loop can exit only if table's 'max_flows' is all filled up
5685      *     by unevictable rules. */
5686     HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
5687         struct rule *rule;
5688
5689         HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
5690             *rulep = rule;
5691             return true;
5692         }
5693     }
5694
5695     return false;
5696 }
5697
5698 /* Searches 'ofproto' for tables that have more flows than their configured
5699  * maximum and that have flow eviction enabled, and evicts as many flows as
5700  * necessary and currently feasible from them.
5701  *
5702  * This triggers only when an OpenFlow table has N flows in it and then the
5703  * client configures a maximum number of flows less than N. */
5704 static void
5705 ofproto_evict(struct ofproto *ofproto)
5706 {
5707     struct oftable *table;
5708
5709     ovs_mutex_lock(&ofproto_mutex);
5710     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
5711         evict_rules_from_table(ofproto, table, 0);
5712     }
5713     ovs_mutex_unlock(&ofproto_mutex);
5714 }
5715 \f
5716 /* Eviction groups. */
5717
5718 /* Returns the priority to use for an eviction_group that contains 'n_rules'
5719  * rules.  The priority contains low-order random bits to ensure that eviction
5720  * groups with the same number of rules are prioritized randomly. */
5721 static uint32_t
5722 eviction_group_priority(size_t n_rules)
5723 {
5724     uint16_t size = MIN(UINT16_MAX, n_rules);
5725     return (size << 16) | random_uint16();
5726 }
5727
5728 /* Updates 'evg', an eviction_group within 'table', following a change that
5729  * adds or removes rules in 'evg'. */
5730 static void
5731 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
5732     OVS_REQUIRES(ofproto_mutex)
5733 {
5734     heap_change(&table->eviction_groups_by_size, &evg->size_node,
5735                 eviction_group_priority(heap_count(&evg->rules)));
5736 }
5737
5738 /* Destroys 'evg', an eviction_group within 'table':
5739  *
5740  *   - Removes all the rules, if any, from 'evg'.  (It doesn't destroy the
5741  *     rules themselves, just removes them from the eviction group.)
5742  *
5743  *   - Removes 'evg' from 'table'.
5744  *
5745  *   - Frees 'evg'. */
5746 static void
5747 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
5748     OVS_REQUIRES(ofproto_mutex)
5749 {
5750     while (!heap_is_empty(&evg->rules)) {
5751         struct rule *rule;
5752
5753         rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
5754         rule->eviction_group = NULL;
5755     }
5756     hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
5757     heap_remove(&table->eviction_groups_by_size, &evg->size_node);
5758     heap_destroy(&evg->rules);
5759     free(evg);
5760 }
5761
5762 /* Removes 'rule' from its eviction group, if any. */
5763 static void
5764 eviction_group_remove_rule(struct rule *rule)
5765     OVS_REQUIRES(ofproto_mutex)
5766 {
5767     if (rule->eviction_group) {
5768         struct oftable *table = &rule->ofproto->tables[rule->table_id];
5769         struct eviction_group *evg = rule->eviction_group;
5770
5771         rule->eviction_group = NULL;
5772         heap_remove(&evg->rules, &rule->evg_node);
5773         if (heap_is_empty(&evg->rules)) {
5774             eviction_group_destroy(table, evg);
5775         } else {
5776             eviction_group_resized(table, evg);
5777         }
5778     }
5779 }
5780
5781 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
5782  * returns the hash value. */
5783 static uint32_t
5784 eviction_group_hash_rule(struct rule *rule)
5785     OVS_REQUIRES(ofproto_mutex)
5786 {
5787     struct oftable *table = &rule->ofproto->tables[rule->table_id];
5788     const struct mf_subfield *sf;
5789     struct flow flow;
5790     uint32_t hash;
5791
5792     hash = table->eviction_group_id_basis;
5793     miniflow_expand(&rule->cr.match.flow, &flow);
5794     for (sf = table->eviction_fields;
5795          sf < &table->eviction_fields[table->n_eviction_fields];
5796          sf++)
5797     {
5798         if (mf_are_prereqs_ok(sf->field, &flow)) {
5799             union mf_value value;
5800
5801             mf_get_value(sf->field, &flow, &value);
5802             if (sf->ofs) {
5803                 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
5804             }
5805             if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
5806                 unsigned int start = sf->ofs + sf->n_bits;
5807                 bitwise_zero(&value, sf->field->n_bytes, start,
5808                              sf->field->n_bytes * 8 - start);
5809             }
5810             hash = hash_bytes(&value, sf->field->n_bytes, hash);
5811         } else {
5812             hash = hash_int(hash, 0);
5813         }
5814     }
5815
5816     return hash;
5817 }
5818
5819 /* Returns an eviction group within 'table' with the given 'id', creating one
5820  * if necessary. */
5821 static struct eviction_group *
5822 eviction_group_find(struct oftable *table, uint32_t id)
5823     OVS_REQUIRES(ofproto_mutex)
5824 {
5825     struct eviction_group *evg;
5826
5827     HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
5828         return evg;
5829     }
5830
5831     evg = xmalloc(sizeof *evg);
5832     hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
5833     heap_insert(&table->eviction_groups_by_size, &evg->size_node,
5834                 eviction_group_priority(0));
5835     heap_init(&evg->rules);
5836
5837     return evg;
5838 }
5839
5840 /* Returns an eviction priority for 'rule'.  The return value should be
5841  * interpreted so that higher priorities make a rule more attractive candidates
5842  * for eviction. */
5843 static uint32_t
5844 rule_eviction_priority(struct rule *rule)
5845     OVS_REQUIRES(ofproto_mutex)
5846 {
5847     long long int hard_expiration;
5848     long long int idle_expiration;
5849     long long int expiration;
5850     uint32_t expiration_offset;
5851
5852     /* Calculate time of expiration. */
5853     ovs_mutex_lock(&rule->mutex);
5854     hard_expiration = (rule->hard_timeout
5855                        ? rule->modified + rule->hard_timeout * 1000
5856                        : LLONG_MAX);
5857     idle_expiration = (rule->idle_timeout
5858                        ? rule->used + rule->idle_timeout * 1000
5859                        : LLONG_MAX);
5860     expiration = MIN(hard_expiration, idle_expiration);
5861     ovs_mutex_unlock(&rule->mutex);
5862     if (expiration == LLONG_MAX) {
5863         return 0;
5864     }
5865
5866     /* Calculate the time of expiration as a number of (approximate) seconds
5867      * after program startup.
5868      *
5869      * This should work OK for program runs that last UINT32_MAX seconds or
5870      * less.  Therefore, please restart OVS at least once every 136 years. */
5871     expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
5872
5873     /* Invert the expiration offset because we're using a max-heap. */
5874     return UINT32_MAX - expiration_offset;
5875 }
5876
5877 /* Adds 'rule' to an appropriate eviction group for its oftable's
5878  * configuration.  Does nothing if 'rule''s oftable doesn't have eviction
5879  * enabled, or if 'rule' is a permanent rule (one that will never expire on its
5880  * own).
5881  *
5882  * The caller must ensure that 'rule' is not already in an eviction group. */
5883 static void
5884 eviction_group_add_rule(struct rule *rule)
5885     OVS_REQUIRES(ofproto_mutex)
5886 {
5887     struct ofproto *ofproto = rule->ofproto;
5888     struct oftable *table = &ofproto->tables[rule->table_id];
5889     bool has_timeout;
5890
5891     ovs_mutex_lock(&rule->mutex);
5892     has_timeout = rule->hard_timeout || rule->idle_timeout;
5893     ovs_mutex_unlock(&rule->mutex);
5894
5895     if (table->eviction_fields && has_timeout) {
5896         struct eviction_group *evg;
5897
5898         evg = eviction_group_find(table, eviction_group_hash_rule(rule));
5899
5900         rule->eviction_group = evg;
5901         heap_insert(&evg->rules, &rule->evg_node,
5902                     rule_eviction_priority(rule));
5903         eviction_group_resized(table, evg);
5904     }
5905 }
5906 \f
5907 /* oftables. */
5908
5909 /* Initializes 'table'. */
5910 static void
5911 oftable_init(struct oftable *table)
5912 {
5913     memset(table, 0, sizeof *table);
5914     classifier_init(&table->cls);
5915     table->max_flows = UINT_MAX;
5916 }
5917
5918 /* Destroys 'table', including its classifier and eviction groups.
5919  *
5920  * The caller is responsible for freeing 'table' itself. */
5921 static void
5922 oftable_destroy(struct oftable *table)
5923 {
5924     ovs_rwlock_rdlock(&table->cls.rwlock);
5925     ovs_assert(classifier_is_empty(&table->cls));
5926     ovs_rwlock_unlock(&table->cls.rwlock);
5927     oftable_disable_eviction(table);
5928     classifier_destroy(&table->cls);
5929     free(table->name);
5930 }
5931
5932 /* Changes the name of 'table' to 'name'.  If 'name' is NULL or the empty
5933  * string, then 'table' will use its default name.
5934  *
5935  * This only affects the name exposed for a table exposed through the OpenFlow
5936  * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
5937 static void
5938 oftable_set_name(struct oftable *table, const char *name)
5939 {
5940     if (name && name[0]) {
5941         int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
5942         if (!table->name || strncmp(name, table->name, len)) {
5943             free(table->name);
5944             table->name = xmemdup0(name, len);
5945         }
5946     } else {
5947         free(table->name);
5948         table->name = NULL;
5949     }
5950 }
5951
5952 /* oftables support a choice of two policies when adding a rule would cause the
5953  * number of flows in the table to exceed the configured maximum number: either
5954  * they can refuse to add the new flow or they can evict some existing flow.
5955  * This function configures the former policy on 'table'. */
5956 static void
5957 oftable_disable_eviction(struct oftable *table)
5958     OVS_REQUIRES(ofproto_mutex)
5959 {
5960     if (table->eviction_fields) {
5961         struct eviction_group *evg, *next;
5962
5963         HMAP_FOR_EACH_SAFE (evg, next, id_node,
5964                             &table->eviction_groups_by_id) {
5965             eviction_group_destroy(table, evg);
5966         }
5967         hmap_destroy(&table->eviction_groups_by_id);
5968         heap_destroy(&table->eviction_groups_by_size);
5969
5970         free(table->eviction_fields);
5971         table->eviction_fields = NULL;
5972         table->n_eviction_fields = 0;
5973     }
5974 }
5975
5976 /* oftables support a choice of two policies when adding a rule would cause the
5977  * number of flows in the table to exceed the configured maximum number: either
5978  * they can refuse to add the new flow or they can evict some existing flow.
5979  * This function configures the latter policy on 'table', with fairness based
5980  * on the values of the 'n_fields' fields specified in 'fields'.  (Specifying
5981  * 'n_fields' as 0 disables fairness.) */
5982 static void
5983 oftable_enable_eviction(struct oftable *table,
5984                         const struct mf_subfield *fields, size_t n_fields)
5985     OVS_REQUIRES(ofproto_mutex)
5986 {
5987     struct cls_cursor cursor;
5988     struct rule *rule;
5989
5990     if (table->eviction_fields
5991         && n_fields == table->n_eviction_fields
5992         && (!n_fields
5993             || !memcmp(fields, table->eviction_fields,
5994                        n_fields * sizeof *fields))) {
5995         /* No change. */
5996         return;
5997     }
5998
5999     oftable_disable_eviction(table);
6000
6001     table->n_eviction_fields = n_fields;
6002     table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
6003
6004     table->eviction_group_id_basis = random_uint32();
6005     hmap_init(&table->eviction_groups_by_id);
6006     heap_init(&table->eviction_groups_by_size);
6007
6008     ovs_rwlock_rdlock(&table->cls.rwlock);
6009     cls_cursor_init(&cursor, &table->cls, NULL);
6010     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
6011         eviction_group_add_rule(rule);
6012     }
6013     ovs_rwlock_unlock(&table->cls.rwlock);
6014 }
6015
6016 /* Removes 'rule' from the oftable that contains it. */
6017 static void
6018 oftable_remove_rule__(struct ofproto *ofproto, struct rule *rule)
6019     OVS_REQUIRES(ofproto_mutex)
6020 {
6021     struct classifier *cls = &ofproto->tables[rule->table_id].cls;
6022
6023     ovs_rwlock_wrlock(&cls->rwlock);
6024     classifier_remove(cls, CONST_CAST(struct cls_rule *, &rule->cr));
6025     ovs_rwlock_unlock(&cls->rwlock);
6026
6027     cookies_remove(ofproto, rule);
6028
6029     eviction_group_remove_rule(rule);
6030     if (!list_is_empty(&rule->expirable)) {
6031         list_remove(&rule->expirable);
6032     }
6033     if (!list_is_empty(&rule->meter_list_node)) {
6034         list_remove(&rule->meter_list_node);
6035         list_init(&rule->meter_list_node);
6036     }
6037 }
6038
6039 static void
6040 oftable_remove_rule(struct rule *rule)
6041     OVS_REQUIRES(ofproto_mutex)
6042 {
6043     oftable_remove_rule__(rule->ofproto, rule);
6044 }
6045
6046 /* Inserts 'rule' into its oftable, which must not already contain any rule for
6047  * the same cls_rule. */
6048 static void
6049 oftable_insert_rule(struct rule *rule)
6050     OVS_REQUIRES(ofproto_mutex)
6051 {
6052     struct ofproto *ofproto = rule->ofproto;
6053     struct oftable *table = &ofproto->tables[rule->table_id];
6054     bool may_expire;
6055
6056     ovs_mutex_lock(&rule->mutex);
6057     may_expire = rule->hard_timeout || rule->idle_timeout;
6058     ovs_mutex_unlock(&rule->mutex);
6059
6060     if (may_expire) {
6061         list_insert(&ofproto->expirable, &rule->expirable);
6062     }
6063
6064     cookies_insert(ofproto, rule);
6065
6066     if (rule->actions->meter_id) {
6067         struct meter *meter = ofproto->meters[rule->actions->meter_id];
6068         list_insert(&meter->rules, &rule->meter_list_node);
6069     }
6070     ovs_rwlock_wrlock(&table->cls.rwlock);
6071     classifier_insert(&table->cls, CONST_CAST(struct cls_rule *, &rule->cr));
6072     ovs_rwlock_unlock(&table->cls.rwlock);
6073     eviction_group_add_rule(rule);
6074 }
6075 \f
6076 /* unixctl commands. */
6077
6078 struct ofproto *
6079 ofproto_lookup(const char *name)
6080 {
6081     struct ofproto *ofproto;
6082
6083     HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
6084                              &all_ofprotos) {
6085         if (!strcmp(ofproto->name, name)) {
6086             return ofproto;
6087         }
6088     }
6089     return NULL;
6090 }
6091
6092 static void
6093 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
6094                      const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
6095 {
6096     struct ofproto *ofproto;
6097     struct ds results;
6098
6099     ds_init(&results);
6100     HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
6101         ds_put_format(&results, "%s\n", ofproto->name);
6102     }
6103     unixctl_command_reply(conn, ds_cstr(&results));
6104     ds_destroy(&results);
6105 }
6106
6107 static void
6108 ofproto_unixctl_init(void)
6109 {
6110     static bool registered;
6111     if (registered) {
6112         return;
6113     }
6114     registered = true;
6115
6116     unixctl_command_register("ofproto/list", "", 0, 0,
6117                              ofproto_unixctl_list, NULL);
6118 }
6119 \f
6120 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6121  *
6122  * This is deprecated.  It is only for compatibility with broken device drivers
6123  * in old versions of Linux that do not properly support VLANs when VLAN
6124  * devices are not used.  When broken device drivers are no longer in
6125  * widespread use, we will delete these interfaces. */
6126
6127 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6128  * (exactly) by an OpenFlow rule in 'ofproto'. */
6129 void
6130 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
6131 {
6132     const struct oftable *oftable;
6133
6134     free(ofproto->vlan_bitmap);
6135     ofproto->vlan_bitmap = bitmap_allocate(4096);
6136     ofproto->vlans_changed = false;
6137
6138     OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
6139         const struct cls_table *table;
6140
6141         ovs_rwlock_rdlock(&oftable->cls.rwlock);
6142         HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
6143             if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
6144                 const struct cls_rule *rule;
6145
6146                 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
6147                     uint16_t vid = miniflow_get_vid(&rule->match.flow);
6148                     bitmap_set1(vlan_bitmap, vid);
6149                     bitmap_set1(ofproto->vlan_bitmap, vid);
6150                 }
6151             }
6152         }
6153         ovs_rwlock_unlock(&oftable->cls.rwlock);
6154     }
6155 }
6156
6157 /* Returns true if new VLANs have come into use by the flow table since the
6158  * last call to ofproto_get_vlan_usage().
6159  *
6160  * We don't track when old VLANs stop being used. */
6161 bool
6162 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
6163 {
6164     return ofproto->vlans_changed;
6165 }
6166
6167 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6168  * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'.  If
6169  * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6170  * device as a VLAN splinter for VLAN ID 'vid'.  If 'realdev_ofp_port' is zero,
6171  * then the VLAN device is un-enslaved. */
6172 int
6173 ofproto_port_set_realdev(struct ofproto *ofproto, ofp_port_t vlandev_ofp_port,
6174                          ofp_port_t realdev_ofp_port, int vid)
6175 {
6176     struct ofport *ofport;
6177     int error;
6178
6179     ovs_assert(vlandev_ofp_port != realdev_ofp_port);
6180
6181     ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
6182     if (!ofport) {
6183         VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
6184                   ofproto->name, vlandev_ofp_port);
6185         return EINVAL;
6186     }
6187
6188     if (!ofproto->ofproto_class->set_realdev) {
6189         if (!vlandev_ofp_port) {
6190             return 0;
6191         }
6192         VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
6193         return EOPNOTSUPP;
6194     }
6195
6196     error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
6197     if (error) {
6198         VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
6199                   ofproto->name, vlandev_ofp_port,
6200                   netdev_get_name(ofport->netdev), ovs_strerror(error));
6201     }
6202     return error;
6203 }