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