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