1f34bbaeda98aaf6c92bb0e32abec33b10998f1a
[openvswitch] / ofproto / ofproto.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012 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 "bitmap.h"
25 #include "byte-order.h"
26 #include "classifier.h"
27 #include "connmgr.h"
28 #include "coverage.h"
29 #include "dynamic-string.h"
30 #include "hash.h"
31 #include "hmap.h"
32 #include "meta-flow.h"
33 #include "netdev.h"
34 #include "nx-match.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
37 #include "ofp-msgs.h"
38 #include "ofp-print.h"
39 #include "ofp-util.h"
40 #include "ofpbuf.h"
41 #include "ofproto-provider.h"
42 #include "openflow/nicira-ext.h"
43 #include "openflow/openflow.h"
44 #include "packets.h"
45 #include "pinsched.h"
46 #include "pktbuf.h"
47 #include "poll-loop.h"
48 #include "random.h"
49 #include "shash.h"
50 #include "simap.h"
51 #include "sset.h"
52 #include "timeval.h"
53 #include "unaligned.h"
54 #include "unixctl.h"
55 #include "vlog.h"
56
57 VLOG_DEFINE_THIS_MODULE(ofproto);
58
59 COVERAGE_DEFINE(ofproto_error);
60 COVERAGE_DEFINE(ofproto_flush);
61 COVERAGE_DEFINE(ofproto_no_packet_in);
62 COVERAGE_DEFINE(ofproto_packet_out);
63 COVERAGE_DEFINE(ofproto_queue_req);
64 COVERAGE_DEFINE(ofproto_recv_openflow);
65 COVERAGE_DEFINE(ofproto_reinit_ports);
66 COVERAGE_DEFINE(ofproto_uninstallable);
67 COVERAGE_DEFINE(ofproto_update_port);
68
69 enum ofproto_state {
70     S_OPENFLOW,                 /* Processing OpenFlow commands. */
71     S_EVICT,                    /* Evicting flows from over-limit tables. */
72     S_FLUSH,                    /* Deleting all flow table rules. */
73 };
74
75 enum ofoperation_type {
76     OFOPERATION_ADD,
77     OFOPERATION_DELETE,
78     OFOPERATION_MODIFY
79 };
80
81 /* A single OpenFlow request can execute any number of operations.  The
82  * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
83  * ofconn to which an error reply should be sent if necessary.
84  *
85  * ofproto initiates some operations internally.  These operations are still
86  * assigned to groups but will not have an associated ofconn. */
87 struct ofopgroup {
88     struct ofproto *ofproto;    /* Owning ofproto. */
89     struct list ofproto_node;   /* In ofproto's "pending" list. */
90     struct list ops;            /* List of "struct ofoperation"s. */
91     int n_running;              /* Number of ops still pending. */
92
93     /* Data needed to send OpenFlow reply on failure or to send a buffered
94      * packet on success.
95      *
96      * If list_is_empty(ofconn_node) then this ofopgroup never had an
97      * associated ofconn or its ofconn's connection dropped after it initiated
98      * the operation.  In the latter case 'ofconn' is a wild pointer that
99      * refers to freed memory, so the 'ofconn' member must be used only if
100      * !list_is_empty(ofconn_node).
101      */
102     struct list ofconn_node;    /* In ofconn's list of pending opgroups. */
103     struct ofconn *ofconn;      /* ofconn for reply (but see note above). */
104     struct ofp_header *request; /* Original request (truncated at 64 bytes). */
105     uint32_t buffer_id;         /* Buffer id from original request. */
106 };
107
108 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
109 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
110                                           const struct ofp_header *,
111                                           uint32_t buffer_id);
112 static void ofopgroup_submit(struct ofopgroup *);
113 static void ofopgroup_complete(struct ofopgroup *);
114
115 /* A single flow table operation. */
116 struct ofoperation {
117     struct ofopgroup *group;    /* Owning group. */
118     struct list group_node;     /* In ofopgroup's "ops" list. */
119     struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
120     struct rule *rule;          /* Rule being operated upon. */
121     enum ofoperation_type type; /* Type of operation. */
122
123     /* OFOPERATION_ADD. */
124     struct rule *victim;        /* Rule being replaced, if any.. */
125
126     /* OFOPERATION_MODIFY: The old actions, if the actions are changing. */
127     struct ofpact *ofpacts;
128     size_t ofpacts_len;
129
130     /* OFOPERATION_DELETE. */
131     enum ofp_flow_removed_reason reason; /* Reason flow was removed. */
132
133     ovs_be64 flow_cookie;       /* Rule's old flow cookie. */
134     enum ofperr error;          /* 0 if no error. */
135 };
136
137 static struct ofoperation *ofoperation_create(struct ofopgroup *,
138                                               struct rule *,
139                                               enum ofoperation_type,
140                                               enum ofp_flow_removed_reason);
141 static void ofoperation_destroy(struct ofoperation *);
142
143 /* oftable. */
144 static void oftable_init(struct oftable *);
145 static void oftable_destroy(struct oftable *);
146
147 static void oftable_set_name(struct oftable *, const char *name);
148
149 static void oftable_disable_eviction(struct oftable *);
150 static void oftable_enable_eviction(struct oftable *,
151                                     const struct mf_subfield *fields,
152                                     size_t n_fields);
153
154 static void oftable_remove_rule(struct rule *);
155 static struct rule *oftable_replace_rule(struct rule *);
156 static void oftable_substitute_rule(struct rule *old, struct rule *new);
157
158 /* A set of rules within a single OpenFlow table (oftable) that have the same
159  * values for the oftable's eviction_fields.  A rule to be evicted, when one is
160  * needed, is taken from the eviction group that contains the greatest number
161  * of rules.
162  *
163  * An oftable owns any number of eviction groups, each of which contains any
164  * number of rules.
165  *
166  * Membership in an eviction group is imprecise, based on the hash of the
167  * oftable's eviction_fields (in the eviction_group's id_node.hash member).
168  * That is, if two rules have different eviction_fields, but those
169  * eviction_fields hash to the same value, then they will belong to the same
170  * eviction_group anyway.
171  *
172  * (When eviction is not enabled on an oftable, we don't track any eviction
173  * groups, to save time and space.) */
174 struct eviction_group {
175     struct hmap_node id_node;   /* In oftable's "eviction_groups_by_id". */
176     struct heap_node size_node; /* In oftable's "eviction_groups_by_size". */
177     struct heap rules;          /* Contains "struct rule"s. */
178 };
179
180 static struct rule *choose_rule_to_evict(struct oftable *);
181 static void ofproto_evict(struct ofproto *);
182 static uint32_t rule_eviction_priority(struct rule *);
183
184 /* ofport. */
185 static void ofport_destroy__(struct ofport *);
186 static void ofport_destroy(struct ofport *);
187
188 static void update_port(struct ofproto *, const char *devname);
189 static int init_ports(struct ofproto *);
190 static void reinit_ports(struct ofproto *);
191
192 /* rule. */
193 static void ofproto_rule_destroy__(struct rule *);
194 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
195 static bool rule_is_modifiable(const struct rule *);
196
197 /* OpenFlow. */
198 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
199                             const struct ofputil_flow_mod *,
200                             const struct ofp_header *);
201 static void delete_flow__(struct rule *, struct ofopgroup *);
202 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
203 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
204                                      const struct ofputil_flow_mod *,
205                                      const struct ofp_header *);
206
207 /* ofproto. */
208 static uint64_t pick_datapath_id(const struct ofproto *);
209 static uint64_t pick_fallback_dpid(void);
210 static void ofproto_destroy__(struct ofproto *);
211 static void update_mtu(struct ofproto *, struct ofport *);
212
213 /* unixctl. */
214 static void ofproto_unixctl_init(void);
215
216 /* All registered ofproto classes, in probe order. */
217 static const struct ofproto_class **ofproto_classes;
218 static size_t n_ofproto_classes;
219 static size_t allocated_ofproto_classes;
220
221 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
222 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
223
224 /* Initial mappings of port to OpenFlow number mappings. */
225 static struct shash init_ofp_ports = SHASH_INITIALIZER(&init_ofp_ports);
226
227 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
228
229 /* Must be called to initialize the ofproto library.
230  *
231  * The caller may pass in 'iface_hints', which contains an shash of
232  * "iface_hint" elements indexed by the interface's name.  The provider
233  * may use these hints to describe the startup configuration in order to
234  * reinitialize its state.  The caller owns the provided data, so a
235  * provider will make copies of anything required.  An ofproto provider
236  * will remove any existing state that is not described by the hint, and
237  * may choose to remove it all. */
238 void
239 ofproto_init(const struct shash *iface_hints)
240 {
241     struct shash_node *node;
242     size_t i;
243
244     ofproto_class_register(&ofproto_dpif_class);
245
246     /* Make a local copy, since we don't own 'iface_hints' elements. */
247     SHASH_FOR_EACH(node, iface_hints) {
248         const struct iface_hint *orig_hint = node->data;
249         struct iface_hint *new_hint = xmalloc(sizeof *new_hint);
250         const char *br_type = ofproto_normalize_type(orig_hint->br_type);
251
252         new_hint->br_name = xstrdup(orig_hint->br_name);
253         new_hint->br_type = xstrdup(br_type);
254         new_hint->ofp_port = orig_hint->ofp_port;
255
256         shash_add(&init_ofp_ports, node->name, new_hint);
257     }
258
259     for (i = 0; i < n_ofproto_classes; i++) {
260         ofproto_classes[i]->init(&init_ofp_ports);
261     }
262 }
263
264 /* 'type' should be a normalized datapath type, as returned by
265  * ofproto_normalize_type().  Returns the corresponding ofproto_class
266  * structure, or a null pointer if there is none registered for 'type'. */
267 static const struct ofproto_class *
268 ofproto_class_find__(const char *type)
269 {
270     size_t i;
271
272     for (i = 0; i < n_ofproto_classes; i++) {
273         const struct ofproto_class *class = ofproto_classes[i];
274         struct sset types;
275         bool found;
276
277         sset_init(&types);
278         class->enumerate_types(&types);
279         found = sset_contains(&types, type);
280         sset_destroy(&types);
281
282         if (found) {
283             return class;
284         }
285     }
286     VLOG_WARN("unknown datapath type %s", type);
287     return NULL;
288 }
289
290 /* Registers a new ofproto class.  After successful registration, new ofprotos
291  * of that type can be created using ofproto_create(). */
292 int
293 ofproto_class_register(const struct ofproto_class *new_class)
294 {
295     size_t i;
296
297     for (i = 0; i < n_ofproto_classes; i++) {
298         if (ofproto_classes[i] == new_class) {
299             return EEXIST;
300         }
301     }
302
303     if (n_ofproto_classes >= allocated_ofproto_classes) {
304         ofproto_classes = x2nrealloc(ofproto_classes,
305                                      &allocated_ofproto_classes,
306                                      sizeof *ofproto_classes);
307     }
308     ofproto_classes[n_ofproto_classes++] = new_class;
309     return 0;
310 }
311
312 /* Unregisters a datapath provider.  'type' must have been previously
313  * registered and not currently be in use by any ofprotos.  After
314  * unregistration new datapaths of that type cannot be opened using
315  * ofproto_create(). */
316 int
317 ofproto_class_unregister(const struct ofproto_class *class)
318 {
319     size_t i;
320
321     for (i = 0; i < n_ofproto_classes; i++) {
322         if (ofproto_classes[i] == class) {
323             for (i++; i < n_ofproto_classes; i++) {
324                 ofproto_classes[i - 1] = ofproto_classes[i];
325             }
326             n_ofproto_classes--;
327             return 0;
328         }
329     }
330     VLOG_WARN("attempted to unregister an ofproto class that is not "
331               "registered");
332     return EAFNOSUPPORT;
333 }
334
335 /* Clears 'types' and enumerates all registered ofproto types into it.  The
336  * caller must first initialize the sset. */
337 void
338 ofproto_enumerate_types(struct sset *types)
339 {
340     size_t i;
341
342     for (i = 0; i < n_ofproto_classes; i++) {
343         ofproto_classes[i]->enumerate_types(types);
344     }
345 }
346
347 /* Returns the fully spelled out name for the given ofproto 'type'.
348  *
349  * Normalized type string can be compared with strcmp().  Unnormalized type
350  * string might be the same even if they have different spellings. */
351 const char *
352 ofproto_normalize_type(const char *type)
353 {
354     return type && type[0] ? type : "system";
355 }
356
357 /* Clears 'names' and enumerates the names of all known created ofprotos with
358  * the given 'type'.  The caller must first initialize the sset.  Returns 0 if
359  * successful, otherwise a positive errno value.
360  *
361  * Some kinds of datapaths might not be practically enumerable.  This is not
362  * considered an error. */
363 int
364 ofproto_enumerate_names(const char *type, struct sset *names)
365 {
366     const struct ofproto_class *class = ofproto_class_find__(type);
367     return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
368  }
369
370 int
371 ofproto_create(const char *datapath_name, const char *datapath_type,
372                struct ofproto **ofprotop)
373 {
374     const struct ofproto_class *class;
375     struct ofproto *ofproto;
376     int error;
377     int i;
378
379     *ofprotop = NULL;
380
381     ofproto_unixctl_init();
382
383     datapath_type = ofproto_normalize_type(datapath_type);
384     class = ofproto_class_find__(datapath_type);
385     if (!class) {
386         VLOG_WARN("could not create datapath %s of unknown type %s",
387                   datapath_name, datapath_type);
388         return EAFNOSUPPORT;
389     }
390
391     ofproto = class->alloc();
392     if (!ofproto) {
393         VLOG_ERR("failed to allocate datapath %s of type %s",
394                  datapath_name, datapath_type);
395         return ENOMEM;
396     }
397
398     /* Initialize. */
399     memset(ofproto, 0, sizeof *ofproto);
400     ofproto->ofproto_class = class;
401     ofproto->name = xstrdup(datapath_name);
402     ofproto->type = xstrdup(datapath_type);
403     hmap_insert(&all_ofprotos, &ofproto->hmap_node,
404                 hash_string(ofproto->name, 0));
405     ofproto->datapath_id = 0;
406     ofproto_set_flow_eviction_threshold(ofproto,
407                                         OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT);
408     ofproto->forward_bpdu = false;
409     ofproto->fallback_dpid = pick_fallback_dpid();
410     ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
411     ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
412     ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
413     ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
414     ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
415     ofproto->frag_handling = OFPC_FRAG_NORMAL;
416     hmap_init(&ofproto->ports);
417     shash_init(&ofproto->port_by_name);
418     simap_init(&ofproto->ofp_requests);
419     ofproto->max_ports = OFPP_MAX;
420     ofproto->tables = NULL;
421     ofproto->n_tables = 0;
422     ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
423     ofproto->state = S_OPENFLOW;
424     list_init(&ofproto->pending);
425     ofproto->n_pending = 0;
426     hmap_init(&ofproto->deletions);
427     ofproto->n_add = ofproto->n_delete = ofproto->n_modify = 0;
428     ofproto->first_op = ofproto->last_op = LLONG_MIN;
429     ofproto->next_op_report = LLONG_MAX;
430     ofproto->op_backoff = LLONG_MIN;
431     ofproto->vlan_bitmap = NULL;
432     ofproto->vlans_changed = false;
433     ofproto->min_mtu = INT_MAX;
434
435     error = ofproto->ofproto_class->construct(ofproto);
436     if (error) {
437         VLOG_ERR("failed to open datapath %s: %s",
438                  datapath_name, strerror(error));
439         ofproto_destroy__(ofproto);
440         return error;
441     }
442
443     /* The "max_ports" member should have been set by ->construct(ofproto).
444      * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
445     ofproto->ofp_port_ids = bitmap_allocate(ofproto->max_ports);
446     bitmap_set1(ofproto->ofp_port_ids, 0);
447
448     /* Check that hidden tables, if any, are at the end. */
449     assert(ofproto->n_tables);
450     for (i = 0; i + 1 < ofproto->n_tables; i++) {
451         enum oftable_flags flags = ofproto->tables[i].flags;
452         enum oftable_flags next_flags = ofproto->tables[i + 1].flags;
453
454         assert(!(flags & OFTABLE_HIDDEN) || next_flags & OFTABLE_HIDDEN);
455     }
456
457     ofproto->datapath_id = pick_datapath_id(ofproto);
458     init_ports(ofproto);
459
460     *ofprotop = ofproto;
461     return 0;
462 }
463
464 /* Must be called (only) by an ofproto implementation in its constructor
465  * function.  See the large comment on 'construct' in struct ofproto_class for
466  * details. */
467 void
468 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
469 {
470     struct oftable *table;
471
472     assert(!ofproto->n_tables);
473     assert(n_tables >= 1 && n_tables <= 255);
474
475     ofproto->n_tables = n_tables;
476     ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
477     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
478         oftable_init(table);
479     }
480 }
481
482 /* To be optionally called (only) by an ofproto implementation in its
483  * constructor function.  See the large comment on 'construct' in struct
484  * ofproto_class for details.
485  *
486  * Sets the maximum number of ports to 'max_ports'.  The ofproto generic layer
487  * will then ensure that actions passed into the ofproto implementation will
488  * not refer to OpenFlow ports numbered 'max_ports' or higher.  If this
489  * function is not called, there will be no such restriction.
490  *
491  * Reserved ports numbered OFPP_MAX and higher are special and not subject to
492  * the 'max_ports' restriction. */
493 void
494 ofproto_init_max_ports(struct ofproto *ofproto, uint16_t max_ports)
495 {
496     assert(max_ports <= OFPP_MAX);
497     ofproto->max_ports = max_ports;
498 }
499
500 uint64_t
501 ofproto_get_datapath_id(const struct ofproto *ofproto)
502 {
503     return ofproto->datapath_id;
504 }
505
506 void
507 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
508 {
509     uint64_t old_dpid = p->datapath_id;
510     p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
511     if (p->datapath_id != old_dpid) {
512         /* Force all active connections to reconnect, since there is no way to
513          * notify a controller that the datapath ID has changed. */
514         ofproto_reconnect_controllers(p);
515     }
516 }
517
518 void
519 ofproto_set_controllers(struct ofproto *p,
520                         const struct ofproto_controller *controllers,
521                         size_t n_controllers)
522 {
523     connmgr_set_controllers(p->connmgr, controllers, n_controllers);
524 }
525
526 void
527 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
528 {
529     connmgr_set_fail_mode(p->connmgr, fail_mode);
530 }
531
532 /* Drops the connections between 'ofproto' and all of its controllers, forcing
533  * them to reconnect. */
534 void
535 ofproto_reconnect_controllers(struct ofproto *ofproto)
536 {
537     connmgr_reconnect(ofproto->connmgr);
538 }
539
540 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
541  * in-band control should guarantee access, in the same way that in-band
542  * control guarantees access to OpenFlow controllers. */
543 void
544 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
545                                   const struct sockaddr_in *extras, size_t n)
546 {
547     connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
548 }
549
550 /* Sets the OpenFlow queue used by flows set up by in-band control on
551  * 'ofproto' to 'queue_id'.  If 'queue_id' is negative, then in-band control
552  * flows will use the default queue. */
553 void
554 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
555 {
556     connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
557 }
558
559 /* Sets the number of flows at which eviction from the kernel flow table
560  * will occur. */
561 void
562 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
563 {
564     if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
565         ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
566     } else {
567         ofproto->flow_eviction_threshold = threshold;
568     }
569 }
570
571 /* If forward_bpdu is true, the NORMAL action will forward frames with
572  * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
573  * the NORMAL action will drop these frames. */
574 void
575 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
576 {
577     bool old_val = ofproto->forward_bpdu;
578     ofproto->forward_bpdu = forward_bpdu;
579     if (old_val != ofproto->forward_bpdu) {
580         if (ofproto->ofproto_class->forward_bpdu_changed) {
581             ofproto->ofproto_class->forward_bpdu_changed(ofproto);
582         }
583     }
584 }
585
586 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
587  * 'idle_time', in seconds. */
588 void
589 ofproto_set_mac_idle_time(struct ofproto *ofproto, unsigned idle_time)
590 {
591     if (ofproto->ofproto_class->set_mac_idle_time) {
592         ofproto->ofproto_class->set_mac_idle_time(ofproto, idle_time);
593     }
594 }
595
596 void
597 ofproto_set_desc(struct ofproto *p,
598                  const char *mfr_desc, const char *hw_desc,
599                  const char *sw_desc, const char *serial_desc,
600                  const char *dp_desc)
601 {
602     struct ofp_desc_stats *ods;
603
604     if (mfr_desc) {
605         if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
606             VLOG_WARN("%s: truncating mfr_desc, must be less than %zu bytes",
607                       p->name, sizeof ods->mfr_desc);
608         }
609         free(p->mfr_desc);
610         p->mfr_desc = xstrdup(mfr_desc);
611     }
612     if (hw_desc) {
613         if (strlen(hw_desc) >= sizeof ods->hw_desc) {
614             VLOG_WARN("%s: truncating hw_desc, must be less than %zu bytes",
615                       p->name, sizeof ods->hw_desc);
616         }
617         free(p->hw_desc);
618         p->hw_desc = xstrdup(hw_desc);
619     }
620     if (sw_desc) {
621         if (strlen(sw_desc) >= sizeof ods->sw_desc) {
622             VLOG_WARN("%s: truncating sw_desc, must be less than %zu bytes",
623                       p->name, sizeof ods->sw_desc);
624         }
625         free(p->sw_desc);
626         p->sw_desc = xstrdup(sw_desc);
627     }
628     if (serial_desc) {
629         if (strlen(serial_desc) >= sizeof ods->serial_num) {
630             VLOG_WARN("%s: truncating serial_desc, must be less than %zu "
631                       "bytes", p->name, sizeof ods->serial_num);
632         }
633         free(p->serial_desc);
634         p->serial_desc = xstrdup(serial_desc);
635     }
636     if (dp_desc) {
637         if (strlen(dp_desc) >= sizeof ods->dp_desc) {
638             VLOG_WARN("%s: truncating dp_desc, must be less than %zu bytes",
639                       p->name, sizeof ods->dp_desc);
640         }
641         free(p->dp_desc);
642         p->dp_desc = xstrdup(dp_desc);
643     }
644 }
645
646 int
647 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
648 {
649     return connmgr_set_snoops(ofproto->connmgr, snoops);
650 }
651
652 int
653 ofproto_set_netflow(struct ofproto *ofproto,
654                     const struct netflow_options *nf_options)
655 {
656     if (nf_options && sset_is_empty(&nf_options->collectors)) {
657         nf_options = NULL;
658     }
659
660     if (ofproto->ofproto_class->set_netflow) {
661         return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
662     } else {
663         return nf_options ? EOPNOTSUPP : 0;
664     }
665 }
666
667 int
668 ofproto_set_sflow(struct ofproto *ofproto,
669                   const struct ofproto_sflow_options *oso)
670 {
671     if (oso && sset_is_empty(&oso->targets)) {
672         oso = NULL;
673     }
674
675     if (ofproto->ofproto_class->set_sflow) {
676         return ofproto->ofproto_class->set_sflow(ofproto, oso);
677     } else {
678         return oso ? EOPNOTSUPP : 0;
679     }
680 }
681 \f
682 /* Spanning Tree Protocol (STP) configuration. */
683
684 /* Configures STP on 'ofproto' using the settings defined in 's'.  If
685  * 's' is NULL, disables STP.
686  *
687  * Returns 0 if successful, otherwise a positive errno value. */
688 int
689 ofproto_set_stp(struct ofproto *ofproto,
690                 const struct ofproto_stp_settings *s)
691 {
692     return (ofproto->ofproto_class->set_stp
693             ? ofproto->ofproto_class->set_stp(ofproto, s)
694             : EOPNOTSUPP);
695 }
696
697 /* Retrieves STP status of 'ofproto' and stores it in 's'.  If the
698  * 'enabled' member of 's' is false, then the other members are not
699  * meaningful.
700  *
701  * Returns 0 if successful, otherwise a positive errno value. */
702 int
703 ofproto_get_stp_status(struct ofproto *ofproto,
704                        struct ofproto_stp_status *s)
705 {
706     return (ofproto->ofproto_class->get_stp_status
707             ? ofproto->ofproto_class->get_stp_status(ofproto, s)
708             : EOPNOTSUPP);
709 }
710
711 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
712  * in 's'.  The caller is responsible for assigning STP port numbers
713  * (using the 'port_num' member in the range of 1 through 255, inclusive)
714  * and ensuring there are no duplicates.  If the 's' is NULL, then STP
715  * is disabled on the port.
716  *
717  * Returns 0 if successful, otherwise a positive errno value.*/
718 int
719 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
720                      const struct ofproto_port_stp_settings *s)
721 {
722     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
723     if (!ofport) {
724         VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
725                   ofproto->name, ofp_port);
726         return ENODEV;
727     }
728
729     return (ofproto->ofproto_class->set_stp_port
730             ? ofproto->ofproto_class->set_stp_port(ofport, s)
731             : EOPNOTSUPP);
732 }
733
734 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
735  * 's'.  If the 'enabled' member in 's' is false, then the other members
736  * are not meaningful.
737  *
738  * Returns 0 if successful, otherwise a positive errno value.*/
739 int
740 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
741                             struct ofproto_port_stp_status *s)
742 {
743     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
744     if (!ofport) {
745         VLOG_WARN_RL(&rl, "%s: cannot get STP status on nonexistent "
746                      "port %"PRIu16, ofproto->name, ofp_port);
747         return ENODEV;
748     }
749
750     return (ofproto->ofproto_class->get_stp_port_status
751             ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
752             : EOPNOTSUPP);
753 }
754 \f
755 /* Queue DSCP configuration. */
756
757 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
758  * 'queues' attached to 'ofport'.  This data is not intended to be sufficient
759  * to implement QoS.  Instead, it is used to implement features which require
760  * knowledge of what queues exist on a port, and some basic information about
761  * them.
762  *
763  * Returns 0 if successful, otherwise a positive errno value. */
764 int
765 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
766                         const struct ofproto_port_queue *queues,
767                         size_t n_queues)
768 {
769     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
770
771     if (!ofport) {
772         VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
773                   ofproto->name, ofp_port);
774         return ENODEV;
775     }
776
777     return (ofproto->ofproto_class->set_queues
778             ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
779             : EOPNOTSUPP);
780 }
781 \f
782 /* Connectivity Fault Management configuration. */
783
784 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
785 void
786 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
787 {
788     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
789     if (ofport && ofproto->ofproto_class->set_cfm) {
790         ofproto->ofproto_class->set_cfm(ofport, NULL);
791     }
792 }
793
794 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'.  Takes
795  * basic configuration from the configuration members in 'cfm', and the remote
796  * maintenance point ID from  remote_mpid.  Ignores the statistics members of
797  * 'cfm'.
798  *
799  * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
800 void
801 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
802                      const struct cfm_settings *s)
803 {
804     struct ofport *ofport;
805     int error;
806
807     ofport = ofproto_get_port(ofproto, ofp_port);
808     if (!ofport) {
809         VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
810                   ofproto->name, ofp_port);
811         return;
812     }
813
814     /* XXX: For configuration simplicity, we only support one remote_mpid
815      * outside of the CFM module.  It's not clear if this is the correct long
816      * term solution or not. */
817     error = (ofproto->ofproto_class->set_cfm
818              ? ofproto->ofproto_class->set_cfm(ofport, s)
819              : EOPNOTSUPP);
820     if (error) {
821         VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
822                   ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
823                   strerror(error));
824     }
825 }
826
827 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
828  * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
829  * 0 if LACP partner information is not current (generally indicating a
830  * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
831 int
832 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
833 {
834     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
835     return (ofport && ofproto->ofproto_class->port_is_lacp_current
836             ? ofproto->ofproto_class->port_is_lacp_current(ofport)
837             : -1);
838 }
839 \f
840 /* Bundles. */
841
842 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
843  * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
844  * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
845  * configuration plus, if there is more than one slave, a bonding
846  * configuration.
847  *
848  * If 'aux' is already registered then this function updates its configuration
849  * to 's'.  Otherwise, this function registers a new bundle.
850  *
851  * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
852  * port. */
853 int
854 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
855                         const struct ofproto_bundle_settings *s)
856 {
857     return (ofproto->ofproto_class->bundle_set
858             ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
859             : EOPNOTSUPP);
860 }
861
862 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
863  * If no such bundle has been registered, this has no effect. */
864 int
865 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
866 {
867     return ofproto_bundle_register(ofproto, aux, NULL);
868 }
869
870 \f
871 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
872  * If 'aux' is already registered then this function updates its configuration
873  * to 's'.  Otherwise, this function registers a new mirror. */
874 int
875 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
876                         const struct ofproto_mirror_settings *s)
877 {
878     return (ofproto->ofproto_class->mirror_set
879             ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
880             : EOPNOTSUPP);
881 }
882
883 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
884  * If no mirror has been registered, this has no effect. */
885 int
886 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
887 {
888     return ofproto_mirror_register(ofproto, aux, NULL);
889 }
890
891 /* Retrieves statistics from mirror associated with client data pointer
892  * 'aux' in 'ofproto'.  Stores packet and byte counts in 'packets' and
893  * 'bytes', respectively.  If a particular counters is not supported,
894  * the appropriate argument is set to UINT64_MAX. */
895 int
896 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
897                          uint64_t *packets, uint64_t *bytes)
898 {
899     if (!ofproto->ofproto_class->mirror_get_stats) {
900         *packets = *bytes = UINT64_MAX;
901         return EOPNOTSUPP;
902     }
903
904     return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
905                                                     packets, bytes);
906 }
907
908 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
909  * which all packets are flooded, instead of using MAC learning.  If
910  * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
911  *
912  * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
913  * port. */
914 int
915 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
916 {
917     return (ofproto->ofproto_class->set_flood_vlans
918             ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
919             : EOPNOTSUPP);
920 }
921
922 /* Returns true if 'aux' is a registered bundle that is currently in use as the
923  * output for a mirror. */
924 bool
925 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
926 {
927     return (ofproto->ofproto_class->is_mirror_output_bundle
928             ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
929             : false);
930 }
931 \f
932 /* Configuration of OpenFlow tables. */
933
934 /* Returns the number of OpenFlow tables in 'ofproto'. */
935 int
936 ofproto_get_n_tables(const struct ofproto *ofproto)
937 {
938     return ofproto->n_tables;
939 }
940
941 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
942  * settings from 's'.  'table_id' must be in the range 0 through the number of
943  * OpenFlow tables in 'ofproto' minus 1, inclusive.
944  *
945  * For read-only tables, only the name may be configured. */
946 void
947 ofproto_configure_table(struct ofproto *ofproto, int table_id,
948                         const struct ofproto_table_settings *s)
949 {
950     struct oftable *table;
951
952     assert(table_id >= 0 && table_id < ofproto->n_tables);
953     table = &ofproto->tables[table_id];
954
955     oftable_set_name(table, s->name);
956
957     if (table->flags & OFTABLE_READONLY) {
958         return;
959     }
960
961     if (s->groups) {
962         oftable_enable_eviction(table, s->groups, s->n_groups);
963     } else {
964         oftable_disable_eviction(table);
965     }
966
967     table->max_flows = s->max_flows;
968     if (classifier_count(&table->cls) > table->max_flows
969         && table->eviction_fields) {
970         /* 'table' contains more flows than allowed.  We might not be able to
971          * evict them right away because of the asynchronous nature of flow
972          * table changes.  Schedule eviction for later. */
973         switch (ofproto->state) {
974         case S_OPENFLOW:
975             ofproto->state = S_EVICT;
976             break;
977         case S_EVICT:
978         case S_FLUSH:
979             /* We're already deleting flows, nothing more to do. */
980             break;
981         }
982     }
983 }
984 \f
985 bool
986 ofproto_has_snoops(const struct ofproto *ofproto)
987 {
988     return connmgr_has_snoops(ofproto->connmgr);
989 }
990
991 void
992 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
993 {
994     connmgr_get_snoops(ofproto->connmgr, snoops);
995 }
996
997 static void
998 ofproto_flush__(struct ofproto *ofproto)
999 {
1000     struct ofopgroup *group;
1001     struct oftable *table;
1002
1003     if (ofproto->ofproto_class->flush) {
1004         ofproto->ofproto_class->flush(ofproto);
1005     }
1006
1007     group = ofopgroup_create_unattached(ofproto);
1008     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1009         struct rule *rule, *next_rule;
1010         struct cls_cursor cursor;
1011
1012         if (table->flags & OFTABLE_HIDDEN) {
1013             continue;
1014         }
1015
1016         cls_cursor_init(&cursor, &table->cls, NULL);
1017         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
1018             if (!rule->pending) {
1019                 ofoperation_create(group, rule, OFOPERATION_DELETE,
1020                                    OFPRR_DELETE);
1021                 oftable_remove_rule(rule);
1022                 ofproto->ofproto_class->rule_destruct(rule);
1023             }
1024         }
1025     }
1026     ofopgroup_submit(group);
1027 }
1028
1029 static void
1030 ofproto_destroy__(struct ofproto *ofproto)
1031 {
1032     struct oftable *table;
1033
1034     assert(list_is_empty(&ofproto->pending));
1035     assert(!ofproto->n_pending);
1036
1037     connmgr_destroy(ofproto->connmgr);
1038
1039     hmap_remove(&all_ofprotos, &ofproto->hmap_node);
1040     free(ofproto->name);
1041     free(ofproto->type);
1042     free(ofproto->mfr_desc);
1043     free(ofproto->hw_desc);
1044     free(ofproto->sw_desc);
1045     free(ofproto->serial_desc);
1046     free(ofproto->dp_desc);
1047     hmap_destroy(&ofproto->ports);
1048     shash_destroy(&ofproto->port_by_name);
1049     bitmap_free(ofproto->ofp_port_ids);
1050     simap_destroy(&ofproto->ofp_requests);
1051
1052     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1053         oftable_destroy(table);
1054     }
1055     free(ofproto->tables);
1056
1057     hmap_destroy(&ofproto->deletions);
1058
1059     free(ofproto->vlan_bitmap);
1060
1061     ofproto->ofproto_class->dealloc(ofproto);
1062 }
1063
1064 void
1065 ofproto_destroy(struct ofproto *p)
1066 {
1067     struct ofport *ofport, *next_ofport;
1068
1069     if (!p) {
1070         return;
1071     }
1072
1073     ofproto_flush__(p);
1074     HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
1075         ofport_destroy(ofport);
1076     }
1077
1078     p->ofproto_class->destruct(p);
1079     ofproto_destroy__(p);
1080 }
1081
1082 /* Destroys the datapath with the respective 'name' and 'type'.  With the Linux
1083  * kernel datapath, for example, this destroys the datapath in the kernel, and
1084  * with the netdev-based datapath, it tears down the data structures that
1085  * represent the datapath.
1086  *
1087  * The datapath should not be currently open as an ofproto. */
1088 int
1089 ofproto_delete(const char *name, const char *type)
1090 {
1091     const struct ofproto_class *class = ofproto_class_find__(type);
1092     return (!class ? EAFNOSUPPORT
1093             : !class->del ? EACCES
1094             : class->del(type, name));
1095 }
1096
1097 static void
1098 process_port_change(struct ofproto *ofproto, int error, char *devname)
1099 {
1100     if (error == ENOBUFS) {
1101         reinit_ports(ofproto);
1102     } else if (!error) {
1103         update_port(ofproto, devname);
1104         free(devname);
1105     }
1106 }
1107
1108 int
1109 ofproto_type_run(const char *datapath_type)
1110 {
1111     const struct ofproto_class *class;
1112     int error;
1113
1114     datapath_type = ofproto_normalize_type(datapath_type);
1115     class = ofproto_class_find__(datapath_type);
1116
1117     error = class->type_run ? class->type_run(datapath_type) : 0;
1118     if (error && error != EAGAIN) {
1119         VLOG_ERR_RL(&rl, "%s: type_run failed (%s)",
1120                     datapath_type, strerror(error));
1121     }
1122     return error;
1123 }
1124
1125 int
1126 ofproto_type_run_fast(const char *datapath_type)
1127 {
1128     const struct ofproto_class *class;
1129     int error;
1130
1131     datapath_type = ofproto_normalize_type(datapath_type);
1132     class = ofproto_class_find__(datapath_type);
1133
1134     error = class->type_run_fast ? class->type_run_fast(datapath_type) : 0;
1135     if (error && error != EAGAIN) {
1136         VLOG_ERR_RL(&rl, "%s: type_run_fast failed (%s)",
1137                     datapath_type, strerror(error));
1138     }
1139     return error;
1140 }
1141
1142 void
1143 ofproto_type_wait(const char *datapath_type)
1144 {
1145     const struct ofproto_class *class;
1146
1147     datapath_type = ofproto_normalize_type(datapath_type);
1148     class = ofproto_class_find__(datapath_type);
1149
1150     if (class->type_wait) {
1151         class->type_wait(datapath_type);
1152     }
1153 }
1154
1155 int
1156 ofproto_run(struct ofproto *p)
1157 {
1158     struct sset changed_netdevs;
1159     const char *changed_netdev;
1160     struct ofport *ofport;
1161     int error;
1162
1163     error = p->ofproto_class->run(p);
1164     if (error && error != EAGAIN) {
1165         VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, strerror(error));
1166     }
1167
1168     if (p->ofproto_class->port_poll) {
1169         char *devname;
1170
1171         while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
1172             process_port_change(p, error, devname);
1173         }
1174     }
1175
1176     /* Update OpenFlow port status for any port whose netdev has changed.
1177      *
1178      * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1179      * destroyed, so it's not safe to update ports directly from the
1180      * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE.  Instead, we
1181      * need this two-phase approach. */
1182     sset_init(&changed_netdevs);
1183     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1184         unsigned int change_seq = netdev_change_seq(ofport->netdev);
1185         if (ofport->change_seq != change_seq) {
1186             ofport->change_seq = change_seq;
1187             sset_add(&changed_netdevs, netdev_get_name(ofport->netdev));
1188         }
1189     }
1190     SSET_FOR_EACH (changed_netdev, &changed_netdevs) {
1191         update_port(p, changed_netdev);
1192     }
1193     sset_destroy(&changed_netdevs);
1194
1195     switch (p->state) {
1196     case S_OPENFLOW:
1197         connmgr_run(p->connmgr, handle_openflow);
1198         break;
1199
1200     case S_EVICT:
1201         connmgr_run(p->connmgr, NULL);
1202         ofproto_evict(p);
1203         if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1204             p->state = S_OPENFLOW;
1205         }
1206         break;
1207
1208     case S_FLUSH:
1209         connmgr_run(p->connmgr, NULL);
1210         ofproto_flush__(p);
1211         if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1212             connmgr_flushed(p->connmgr);
1213             p->state = S_OPENFLOW;
1214         }
1215         break;
1216
1217     default:
1218         NOT_REACHED();
1219     }
1220
1221     if (time_msec() >= p->next_op_report) {
1222         long long int ago = (time_msec() - p->first_op) / 1000;
1223         long long int interval = (p->last_op - p->first_op) / 1000;
1224         struct ds s;
1225
1226         ds_init(&s);
1227         ds_put_format(&s, "%d flow_mods ",
1228                       p->n_add + p->n_delete + p->n_modify);
1229         if (interval == ago) {
1230             ds_put_format(&s, "in the last %lld s", ago);
1231         } else if (interval) {
1232             ds_put_format(&s, "in the %lld s starting %lld s ago",
1233                           interval, ago);
1234         } else {
1235             ds_put_format(&s, "%lld s ago", ago);
1236         }
1237
1238         ds_put_cstr(&s, " (");
1239         if (p->n_add) {
1240             ds_put_format(&s, "%d adds, ", p->n_add);
1241         }
1242         if (p->n_delete) {
1243             ds_put_format(&s, "%d deletes, ", p->n_delete);
1244         }
1245         if (p->n_modify) {
1246             ds_put_format(&s, "%d modifications, ", p->n_modify);
1247         }
1248         s.length -= 2;
1249         ds_put_char(&s, ')');
1250
1251         VLOG_INFO("%s: %s", p->name, ds_cstr(&s));
1252         ds_destroy(&s);
1253
1254         p->n_add = p->n_delete = p->n_modify = 0;
1255         p->next_op_report = LLONG_MAX;
1256     }
1257
1258     return error;
1259 }
1260
1261 /* Performs periodic activity required by 'ofproto' that needs to be done
1262  * with the least possible latency.
1263  *
1264  * It makes sense to call this function a couple of times per poll loop, to
1265  * provide a significant performance boost on some benchmarks with the
1266  * ofproto-dpif implementation. */
1267 int
1268 ofproto_run_fast(struct ofproto *p)
1269 {
1270     int error;
1271
1272     error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
1273     if (error && error != EAGAIN) {
1274         VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
1275                     p->name, strerror(error));
1276     }
1277     return error;
1278 }
1279
1280 void
1281 ofproto_wait(struct ofproto *p)
1282 {
1283     struct ofport *ofport;
1284
1285     p->ofproto_class->wait(p);
1286     if (p->ofproto_class->port_poll_wait) {
1287         p->ofproto_class->port_poll_wait(p);
1288     }
1289
1290     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1291         if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1292             poll_immediate_wake();
1293         }
1294     }
1295
1296     switch (p->state) {
1297     case S_OPENFLOW:
1298         connmgr_wait(p->connmgr, true);
1299         break;
1300
1301     case S_EVICT:
1302     case S_FLUSH:
1303         connmgr_wait(p->connmgr, false);
1304         if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1305             poll_immediate_wake();
1306         }
1307         break;
1308     }
1309 }
1310
1311 bool
1312 ofproto_is_alive(const struct ofproto *p)
1313 {
1314     return connmgr_has_controllers(p->connmgr);
1315 }
1316
1317 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1318  * memory_report(). */
1319 void
1320 ofproto_get_memory_usage(const struct ofproto *ofproto, struct simap *usage)
1321 {
1322     const struct oftable *table;
1323     unsigned int n_rules;
1324
1325     simap_increase(usage, "ports", hmap_count(&ofproto->ports));
1326     simap_increase(usage, "ops",
1327                    ofproto->n_pending + hmap_count(&ofproto->deletions));
1328
1329     n_rules = 0;
1330     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
1331         n_rules += classifier_count(&table->cls);
1332     }
1333     simap_increase(usage, "rules", n_rules);
1334
1335     if (ofproto->ofproto_class->get_memory_usage) {
1336         ofproto->ofproto_class->get_memory_usage(ofproto, usage);
1337     }
1338
1339     connmgr_get_memory_usage(ofproto->connmgr, usage);
1340 }
1341
1342 void
1343 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1344                                     struct shash *info)
1345 {
1346     connmgr_get_controller_info(ofproto->connmgr, info);
1347 }
1348
1349 void
1350 ofproto_free_ofproto_controller_info(struct shash *info)
1351 {
1352     connmgr_free_controller_info(info);
1353 }
1354
1355 /* Makes a deep copy of 'old' into 'port'. */
1356 void
1357 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1358 {
1359     port->name = xstrdup(old->name);
1360     port->type = xstrdup(old->type);
1361     port->ofp_port = old->ofp_port;
1362 }
1363
1364 /* Frees memory allocated to members of 'ofproto_port'.
1365  *
1366  * Do not call this function on an ofproto_port obtained from
1367  * ofproto_port_dump_next(): that function retains ownership of the data in the
1368  * ofproto_port. */
1369 void
1370 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1371 {
1372     free(ofproto_port->name);
1373     free(ofproto_port->type);
1374 }
1375
1376 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1377  *
1378  * This function provides no status indication.  An error status for the entire
1379  * dump operation is provided when it is completed by calling
1380  * ofproto_port_dump_done().
1381  */
1382 void
1383 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1384                         const struct ofproto *ofproto)
1385 {
1386     dump->ofproto = ofproto;
1387     dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1388                                                           &dump->state);
1389 }
1390
1391 /* Attempts to retrieve another port from 'dump', which must have been created
1392  * with ofproto_port_dump_start().  On success, stores a new ofproto_port into
1393  * 'port' and returns true.  On failure, returns false.
1394  *
1395  * Failure might indicate an actual error or merely that the last port has been
1396  * dumped.  An error status for the entire dump operation is provided when it
1397  * is completed by calling ofproto_port_dump_done().
1398  *
1399  * The ofproto owns the data stored in 'port'.  It will remain valid until at
1400  * least the next time 'dump' is passed to ofproto_port_dump_next() or
1401  * ofproto_port_dump_done(). */
1402 bool
1403 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1404                        struct ofproto_port *port)
1405 {
1406     const struct ofproto *ofproto = dump->ofproto;
1407
1408     if (dump->error) {
1409         return false;
1410     }
1411
1412     dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1413                                                          port);
1414     if (dump->error) {
1415         ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1416         return false;
1417     }
1418     return true;
1419 }
1420
1421 /* Completes port table dump operation 'dump', which must have been created
1422  * with ofproto_port_dump_start().  Returns 0 if the dump operation was
1423  * error-free, otherwise a positive errno value describing the problem. */
1424 int
1425 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1426 {
1427     const struct ofproto *ofproto = dump->ofproto;
1428     if (!dump->error) {
1429         dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1430                                                              dump->state);
1431     }
1432     return dump->error == EOF ? 0 : dump->error;
1433 }
1434
1435 /* Attempts to add 'netdev' as a port on 'ofproto'.  If 'ofp_portp' is
1436  * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1437  * the port's OpenFlow port number.
1438  *
1439  * If successful, returns 0 and sets '*ofp_portp' to the new port's
1440  * OpenFlow port number (if 'ofp_portp' is non-null).  On failure,
1441  * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1442  * 'ofp_portp' is non-null). */
1443 int
1444 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1445                  uint16_t *ofp_portp)
1446 {
1447     uint16_t ofp_port = ofp_portp ? *ofp_portp : OFPP_NONE;
1448     int error;
1449
1450     error = ofproto->ofproto_class->port_add(ofproto, netdev);
1451     if (!error) {
1452         const char *netdev_name = netdev_get_name(netdev);
1453
1454         simap_put(&ofproto->ofp_requests, netdev_name, ofp_port);
1455         update_port(ofproto, netdev_name);
1456     }
1457     if (ofp_portp) {
1458         struct ofproto_port ofproto_port;
1459
1460         ofproto_port_query_by_name(ofproto, netdev_get_name(netdev),
1461                                    &ofproto_port);
1462         *ofp_portp = error ? OFPP_NONE : ofproto_port.ofp_port;
1463         ofproto_port_destroy(&ofproto_port);
1464     }
1465     return error;
1466 }
1467
1468 /* Looks up a port named 'devname' in 'ofproto'.  On success, returns 0 and
1469  * initializes '*port' appropriately; on failure, returns a positive errno
1470  * value.
1471  *
1472  * The caller owns the data in 'ofproto_port' and must free it with
1473  * ofproto_port_destroy() when it is no longer needed. */
1474 int
1475 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1476                            struct ofproto_port *port)
1477 {
1478     int error;
1479
1480     error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1481     if (error) {
1482         memset(port, 0, sizeof *port);
1483     }
1484     return error;
1485 }
1486
1487 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1488  * Returns 0 if successful, otherwise a positive errno. */
1489 int
1490 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1491 {
1492     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1493     const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1494     struct simap_node *ofp_request_node;
1495     int error;
1496
1497     ofp_request_node = simap_find(&ofproto->ofp_requests, name);
1498     if (ofp_request_node) {
1499         simap_delete(&ofproto->ofp_requests, ofp_request_node);
1500     }
1501
1502     error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1503     if (!error && ofport) {
1504         /* 'name' is the netdev's name and update_port() is going to close the
1505          * netdev.  Just in case update_port() refers to 'name' after it
1506          * destroys 'ofport', make a copy of it around the update_port()
1507          * call. */
1508         char *devname = xstrdup(name);
1509         update_port(ofproto, devname);
1510         free(devname);
1511     }
1512     return error;
1513 }
1514
1515 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1516  * performs the 'n_actions' actions in 'actions'.  The new flow will not
1517  * timeout.
1518  *
1519  * If cls_rule->priority is in the range of priorities supported by OpenFlow
1520  * (0...65535, inclusive) then the flow will be visible to OpenFlow
1521  * controllers; otherwise, it will be hidden.
1522  *
1523  * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1524  *
1525  * This is a helper function for in-band control and fail-open. */
1526 void
1527 ofproto_add_flow(struct ofproto *ofproto, const struct match *match,
1528                  unsigned int priority,
1529                  const struct ofpact *ofpacts, size_t ofpacts_len)
1530 {
1531     const struct rule *rule;
1532
1533     rule = rule_from_cls_rule(classifier_find_match_exactly(
1534                                   &ofproto->tables[0].cls, match, priority));
1535     if (!rule || !ofpacts_equal(rule->ofpacts, rule->ofpacts_len,
1536                                 ofpacts, ofpacts_len)) {
1537         struct ofputil_flow_mod fm;
1538
1539         memset(&fm, 0, sizeof fm);
1540         fm.match = *match;
1541         fm.priority = priority;
1542         fm.buffer_id = UINT32_MAX;
1543         fm.ofpacts = xmemdup(ofpacts, ofpacts_len);
1544         fm.ofpacts_len = ofpacts_len;
1545         add_flow(ofproto, NULL, &fm, NULL);
1546         free(fm.ofpacts);
1547     }
1548 }
1549
1550 /* Executes the flow modification specified in 'fm'.  Returns 0 on success, an
1551  * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1552  * operation cannot be initiated now but may be retried later.
1553  *
1554  * This is a helper function for in-band control and fail-open. */
1555 int
1556 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1557 {
1558     return handle_flow_mod__(ofproto, NULL, fm, NULL);
1559 }
1560
1561 /* Searches for a rule with matching criteria exactly equal to 'target' in
1562  * ofproto's table 0 and, if it finds one, deletes it.
1563  *
1564  * This is a helper function for in-band control and fail-open. */
1565 bool
1566 ofproto_delete_flow(struct ofproto *ofproto,
1567                     const struct match *target, unsigned int priority)
1568 {
1569     struct rule *rule;
1570
1571     rule = rule_from_cls_rule(classifier_find_match_exactly(
1572                                   &ofproto->tables[0].cls, target, priority));
1573     if (!rule) {
1574         /* No such rule -> success. */
1575         return true;
1576     } else if (rule->pending) {
1577         /* An operation on the rule is already pending -> failure.
1578          * Caller must retry later if it's important. */
1579         return false;
1580     } else {
1581         /* Initiate deletion -> success. */
1582         struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1583         ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
1584         oftable_remove_rule(rule);
1585         ofproto->ofproto_class->rule_destruct(rule);
1586         ofopgroup_submit(group);
1587         return true;
1588     }
1589
1590 }
1591
1592 /* Starts the process of deleting all of the flows from all of ofproto's flow
1593  * tables and then reintroducing the flows required by in-band control and
1594  * fail-open.  The process will complete in a later call to ofproto_run(). */
1595 void
1596 ofproto_flush_flows(struct ofproto *ofproto)
1597 {
1598     COVERAGE_INC(ofproto_flush);
1599     ofproto->state = S_FLUSH;
1600 }
1601 \f
1602 static void
1603 reinit_ports(struct ofproto *p)
1604 {
1605     struct ofproto_port_dump dump;
1606     struct sset devnames;
1607     struct ofport *ofport;
1608     struct ofproto_port ofproto_port;
1609     const char *devname;
1610
1611     COVERAGE_INC(ofproto_reinit_ports);
1612
1613     sset_init(&devnames);
1614     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1615         sset_add(&devnames, netdev_get_name(ofport->netdev));
1616     }
1617     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1618         sset_add(&devnames, ofproto_port.name);
1619     }
1620
1621     SSET_FOR_EACH (devname, &devnames) {
1622         update_port(p, devname);
1623     }
1624     sset_destroy(&devnames);
1625 }
1626
1627 static uint16_t
1628 alloc_ofp_port(struct ofproto *ofproto, const char *netdev_name)
1629 {
1630     uint16_t ofp_port;
1631
1632     ofp_port = simap_get(&ofproto->ofp_requests, netdev_name);
1633     ofp_port = ofp_port ? ofp_port : OFPP_NONE;
1634
1635     if (ofp_port >= ofproto->max_ports
1636             || bitmap_is_set(ofproto->ofp_port_ids, ofp_port)) {
1637         bool retry = ofproto->alloc_port_no ? true : false;
1638
1639         /* Search for a free OpenFlow port number.  We try not to
1640          * immediately reuse them to prevent problems due to old
1641          * flows. */
1642         while (ofp_port >= ofproto->max_ports) {
1643             for (ofproto->alloc_port_no++;
1644                  ofproto->alloc_port_no < ofproto->max_ports; ) {
1645                 if (!bitmap_is_set(ofproto->ofp_port_ids,
1646                                    ofproto->alloc_port_no)) {
1647                     ofp_port = ofproto->alloc_port_no;
1648                     break;
1649                 }
1650             }
1651             if (ofproto->alloc_port_no >= ofproto->max_ports) {
1652                 if (retry) {
1653                     ofproto->alloc_port_no = 0;
1654                     retry = false;
1655                 } else {
1656                     return OFPP_NONE;
1657                 }
1658             }
1659         }
1660     }
1661
1662     bitmap_set1(ofproto->ofp_port_ids, ofp_port);
1663     return ofp_port;
1664 }
1665
1666 static void
1667 dealloc_ofp_port(const struct ofproto *ofproto, uint16_t ofp_port)
1668 {
1669     bitmap_set0(ofproto->ofp_port_ids, ofp_port);
1670 }
1671
1672 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1673  * pointer if the netdev cannot be opened.  On success, also fills in
1674  * 'opp'.  */
1675 static struct netdev *
1676 ofport_open(struct ofproto *ofproto,
1677             struct ofproto_port *ofproto_port,
1678             struct ofputil_phy_port *pp)
1679 {
1680     enum netdev_flags flags;
1681     struct netdev *netdev;
1682     int error;
1683
1684     error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1685     if (error) {
1686         VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1687                      "cannot be opened (%s)",
1688                      ofproto->name,
1689                      ofproto_port->name, ofproto_port->ofp_port,
1690                      ofproto_port->name, strerror(error));
1691         return NULL;
1692     }
1693
1694     if (ofproto_port->ofp_port == OFPP_NONE) {
1695         if (!strcmp(ofproto->name, ofproto_port->name)) {
1696             ofproto_port->ofp_port = OFPP_LOCAL;
1697         } else {
1698             ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1699                                                     ofproto_port->name);
1700         }
1701     }
1702     pp->port_no = ofproto_port->ofp_port;
1703     netdev_get_etheraddr(netdev, pp->hw_addr);
1704     ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1705     netdev_get_flags(netdev, &flags);
1706     pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1707     pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1708     netdev_get_features(netdev, &pp->curr, &pp->advertised,
1709                         &pp->supported, &pp->peer);
1710     pp->curr_speed = netdev_features_to_bps(pp->curr, 0);
1711     pp->max_speed = netdev_features_to_bps(pp->supported, 0);
1712
1713     return netdev;
1714 }
1715
1716 /* Returns true if most fields of 'a' and 'b' are equal.  Differences in name,
1717  * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1718  * disregarded. */
1719 static bool
1720 ofport_equal(const struct ofputil_phy_port *a,
1721              const struct ofputil_phy_port *b)
1722 {
1723     return (eth_addr_equals(a->hw_addr, b->hw_addr)
1724             && a->state == b->state
1725             && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1726             && a->curr == b->curr
1727             && a->advertised == b->advertised
1728             && a->supported == b->supported
1729             && a->peer == b->peer
1730             && a->curr_speed == b->curr_speed
1731             && a->max_speed == b->max_speed);
1732 }
1733
1734 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1735  * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1736  * one with the same name or port number). */
1737 static void
1738 ofport_install(struct ofproto *p,
1739                struct netdev *netdev, const struct ofputil_phy_port *pp)
1740 {
1741     const char *netdev_name = netdev_get_name(netdev);
1742     struct ofport *ofport;
1743     int error;
1744
1745     /* Create ofport. */
1746     ofport = p->ofproto_class->port_alloc();
1747     if (!ofport) {
1748         error = ENOMEM;
1749         goto error;
1750     }
1751     ofport->ofproto = p;
1752     ofport->netdev = netdev;
1753     ofport->change_seq = netdev_change_seq(netdev);
1754     ofport->pp = *pp;
1755     ofport->ofp_port = pp->port_no;
1756
1757     /* Add port to 'p'. */
1758     hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1759     shash_add(&p->port_by_name, netdev_name, ofport);
1760
1761     update_mtu(p, ofport);
1762
1763     /* Let the ofproto_class initialize its private data. */
1764     error = p->ofproto_class->port_construct(ofport);
1765     if (error) {
1766         goto error;
1767     }
1768     connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1769     return;
1770
1771 error:
1772     VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1773                  p->name, netdev_name, strerror(error));
1774     if (ofport) {
1775         ofport_destroy__(ofport);
1776     } else {
1777         netdev_close(netdev);
1778     }
1779 }
1780
1781 /* Removes 'ofport' from 'p' and destroys it. */
1782 static void
1783 ofport_remove(struct ofport *ofport)
1784 {
1785     connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1786                              OFPPR_DELETE);
1787     ofport_destroy(ofport);
1788 }
1789
1790 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1791  * destroys it. */
1792 static void
1793 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1794 {
1795     struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1796     if (port) {
1797         ofport_remove(port);
1798     }
1799 }
1800
1801 /* Updates 'port' with new 'pp' description.
1802  *
1803  * Does not handle a name or port number change.  The caller must implement
1804  * such a change as a delete followed by an add.  */
1805 static void
1806 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1807 {
1808     memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1809     port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1810                         | (pp->config & OFPUTIL_PC_PORT_DOWN));
1811     port->pp.state = pp->state;
1812     port->pp.curr = pp->curr;
1813     port->pp.advertised = pp->advertised;
1814     port->pp.supported = pp->supported;
1815     port->pp.peer = pp->peer;
1816     port->pp.curr_speed = pp->curr_speed;
1817     port->pp.max_speed = pp->max_speed;
1818
1819     connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1820 }
1821
1822 /* Update OpenFlow 'state' in 'port' and notify controller. */
1823 void
1824 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
1825 {
1826     if (port->pp.state != state) {
1827         port->pp.state = state;
1828         connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
1829                                  OFPPR_MODIFY);
1830     }
1831 }
1832
1833 void
1834 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1835 {
1836     struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1837     if (port) {
1838         if (port->ofproto->ofproto_class->set_realdev) {
1839             port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1840         }
1841         if (port->ofproto->ofproto_class->set_stp_port) {
1842             port->ofproto->ofproto_class->set_stp_port(port, NULL);
1843         }
1844         if (port->ofproto->ofproto_class->set_cfm) {
1845             port->ofproto->ofproto_class->set_cfm(port, NULL);
1846         }
1847         if (port->ofproto->ofproto_class->bundle_remove) {
1848             port->ofproto->ofproto_class->bundle_remove(port);
1849         }
1850     }
1851 }
1852
1853 static void
1854 ofport_destroy__(struct ofport *port)
1855 {
1856     struct ofproto *ofproto = port->ofproto;
1857     const char *name = netdev_get_name(port->netdev);
1858
1859     hmap_remove(&ofproto->ports, &port->hmap_node);
1860     shash_delete(&ofproto->port_by_name,
1861                  shash_find(&ofproto->port_by_name, name));
1862
1863     netdev_close(port->netdev);
1864     ofproto->ofproto_class->port_dealloc(port);
1865 }
1866
1867 static void
1868 ofport_destroy(struct ofport *port)
1869 {
1870     if (port) {
1871         dealloc_ofp_port(port->ofproto, port->ofp_port);
1872         port->ofproto->ofproto_class->port_destruct(port);
1873         ofport_destroy__(port);
1874      }
1875 }
1876
1877 struct ofport *
1878 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1879 {
1880     struct ofport *port;
1881
1882     HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1883                              hash_int(ofp_port, 0), &ofproto->ports) {
1884         if (port->ofp_port == ofp_port) {
1885             return port;
1886         }
1887     }
1888     return NULL;
1889 }
1890
1891 int
1892 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1893 {
1894     struct ofproto *ofproto = port->ofproto;
1895     int error;
1896
1897     if (ofproto->ofproto_class->port_get_stats) {
1898         error = ofproto->ofproto_class->port_get_stats(port, stats);
1899     } else {
1900         error = EOPNOTSUPP;
1901     }
1902
1903     return error;
1904 }
1905
1906 static void
1907 update_port(struct ofproto *ofproto, const char *name)
1908 {
1909     struct ofproto_port ofproto_port;
1910     struct ofputil_phy_port pp;
1911     struct netdev *netdev;
1912     struct ofport *port;
1913
1914     COVERAGE_INC(ofproto_update_port);
1915
1916     /* Fetch 'name''s location and properties from the datapath. */
1917     netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1918               ? ofport_open(ofproto, &ofproto_port, &pp)
1919               : NULL);
1920     if (netdev) {
1921         port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1922         if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1923             struct netdev *old_netdev = port->netdev;
1924
1925             /* 'name' hasn't changed location.  Any properties changed? */
1926             if (!ofport_equal(&port->pp, &pp)) {
1927                 ofport_modified(port, &pp);
1928             }
1929
1930             update_mtu(ofproto, port);
1931
1932             /* Install the newly opened netdev in case it has changed.
1933              * Don't close the old netdev yet in case port_modified has to
1934              * remove a retained reference to it.*/
1935             port->netdev = netdev;
1936             port->change_seq = netdev_change_seq(netdev);
1937
1938             if (port->ofproto->ofproto_class->port_modified) {
1939                 port->ofproto->ofproto_class->port_modified(port);
1940             }
1941
1942             netdev_close(old_netdev);
1943         } else {
1944             /* If 'port' is nonnull then its name differs from 'name' and thus
1945              * we should delete it.  If we think there's a port named 'name'
1946              * then its port number must be wrong now so delete it too. */
1947             if (port) {
1948                 ofport_remove(port);
1949             }
1950             ofport_remove_with_name(ofproto, name);
1951             ofport_install(ofproto, netdev, &pp);
1952         }
1953     } else {
1954         /* Any port named 'name' is gone now. */
1955         ofport_remove_with_name(ofproto, name);
1956     }
1957     ofproto_port_destroy(&ofproto_port);
1958 }
1959
1960 static int
1961 init_ports(struct ofproto *p)
1962 {
1963     struct ofproto_port_dump dump;
1964     struct ofproto_port ofproto_port;
1965     struct shash_node *node, *next;
1966
1967     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1968         const char *name = ofproto_port.name;
1969
1970         if (shash_find(&p->port_by_name, name)) {
1971             VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
1972                          p->name, name);
1973         } else {
1974             struct ofputil_phy_port pp;
1975             struct netdev *netdev;
1976
1977             /* Check if an OpenFlow port number had been requested. */
1978             node = shash_find(&init_ofp_ports, name);
1979             if (node) {
1980                 const struct iface_hint *iface_hint = node->data;
1981                 simap_put(&p->ofp_requests, name, iface_hint->ofp_port);
1982             }
1983
1984             netdev = ofport_open(p, &ofproto_port, &pp);
1985             if (netdev) {
1986                 ofport_install(p, netdev, &pp);
1987             }
1988         }
1989     }
1990
1991     SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
1992         const struct iface_hint *iface_hint = node->data;
1993
1994         if (!strcmp(iface_hint->br_name, p->name)) {
1995             free(iface_hint->br_name);
1996             free(iface_hint->br_type);
1997             shash_delete(&init_ofp_ports, node);
1998         }
1999     }
2000
2001     return 0;
2002 }
2003
2004 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2005  * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2006 static int
2007 find_min_mtu(struct ofproto *p)
2008 {
2009     struct ofport *ofport;
2010     int mtu = 0;
2011
2012     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2013         struct netdev *netdev = ofport->netdev;
2014         int dev_mtu;
2015
2016         /* Skip any internal ports, since that's what we're trying to
2017          * set. */
2018         if (!strcmp(netdev_get_type(netdev), "internal")) {
2019             continue;
2020         }
2021
2022         if (netdev_get_mtu(netdev, &dev_mtu)) {
2023             continue;
2024         }
2025         if (!mtu || dev_mtu < mtu) {
2026             mtu = dev_mtu;
2027         }
2028     }
2029
2030     return mtu ? mtu: ETH_PAYLOAD_MAX;
2031 }
2032
2033 /* Update MTU of all datapath devices on 'p' to the minimum of the
2034  * non-datapath ports in event of 'port' added or changed. */
2035 static void
2036 update_mtu(struct ofproto *p, struct ofport *port)
2037 {
2038     struct ofport *ofport;
2039     struct netdev *netdev = port->netdev;
2040     int dev_mtu, old_min;
2041
2042     if (netdev_get_mtu(netdev, &dev_mtu)) {
2043         port->mtu = 0;
2044         return;
2045     }
2046     if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2047         if (dev_mtu > p->min_mtu) {
2048            if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2049                dev_mtu = p->min_mtu;
2050            }
2051         }
2052         port->mtu = dev_mtu;
2053         return;
2054     }
2055
2056     /* For non-internal port find new min mtu. */
2057     old_min = p->min_mtu;
2058     port->mtu = dev_mtu;
2059     p->min_mtu = find_min_mtu(p);
2060     if (p->min_mtu == old_min) {
2061         return;
2062     }
2063
2064     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2065         struct netdev *netdev = ofport->netdev;
2066
2067         if (!strcmp(netdev_get_type(netdev), "internal")) {
2068             if (!netdev_set_mtu(netdev, p->min_mtu)) {
2069                 ofport->mtu = p->min_mtu;
2070             }
2071         }
2072     }
2073 }
2074 \f
2075 static void
2076 ofproto_rule_destroy__(struct rule *rule)
2077 {
2078     if (rule) {
2079         cls_rule_destroy(&rule->cr);
2080         free(rule->ofpacts);
2081         rule->ofproto->ofproto_class->rule_dealloc(rule);
2082     }
2083 }
2084
2085 /* This function allows an ofproto implementation to destroy any rules that
2086  * remain when its ->destruct() function is called.  The caller must have
2087  * already uninitialized any derived members of 'rule' (step 5 described in the
2088  * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
2089  * This function implements steps 6 and 7.
2090  *
2091  * This function should only be called from an ofproto implementation's
2092  * ->destruct() function.  It is not suitable elsewhere. */
2093 void
2094 ofproto_rule_destroy(struct rule *rule)
2095 {
2096     assert(!rule->pending);
2097     oftable_remove_rule(rule);
2098     ofproto_rule_destroy__(rule);
2099 }
2100
2101 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2102  * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2103 bool
2104 ofproto_rule_has_out_port(const struct rule *rule, uint16_t port)
2105 {
2106     return (port == OFPP_NONE
2107             || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
2108 }
2109
2110 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2111  * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2112 bool
2113 ofoperation_has_out_port(const struct ofoperation *op, uint16_t out_port)
2114 {
2115     if (ofproto_rule_has_out_port(op->rule, out_port)) {
2116         return true;
2117     }
2118
2119     switch (op->type) {
2120     case OFOPERATION_ADD:
2121         return op->victim && ofproto_rule_has_out_port(op->victim, out_port);
2122
2123     case OFOPERATION_DELETE:
2124         return false;
2125
2126     case OFOPERATION_MODIFY:
2127         return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
2128     }
2129
2130     NOT_REACHED();
2131 }
2132
2133 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2134  * statistics appropriately.  'packet' must have at least sizeof(struct
2135  * ofp_packet_in) bytes of headroom.
2136  *
2137  * 'packet' doesn't necessarily have to match 'rule'.  'rule' will be credited
2138  * with statistics for 'packet' either way.
2139  *
2140  * Takes ownership of 'packet'. */
2141 static int
2142 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
2143 {
2144     struct flow flow;
2145
2146     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
2147
2148     flow_extract(packet, 0, NULL, in_port, &flow);
2149     return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
2150 }
2151
2152 /* Returns true if 'rule' should be hidden from the controller.
2153  *
2154  * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2155  * (e.g. by in-band control) and are intentionally hidden from the
2156  * controller. */
2157 bool
2158 ofproto_rule_is_hidden(const struct rule *rule)
2159 {
2160     return rule->cr.priority > UINT16_MAX;
2161 }
2162
2163 static enum oftable_flags
2164 rule_get_flags(const struct rule *rule)
2165 {
2166     return rule->ofproto->tables[rule->table_id].flags;
2167 }
2168
2169 static bool
2170 rule_is_modifiable(const struct rule *rule)
2171 {
2172     return !(rule_get_flags(rule) & OFTABLE_READONLY);
2173 }
2174 \f
2175 static enum ofperr
2176 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2177 {
2178     ofconn_send_reply(ofconn, make_echo_reply(oh));
2179     return 0;
2180 }
2181
2182 static enum ofperr
2183 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2184 {
2185     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2186     struct ofputil_switch_features features;
2187     struct ofport *port;
2188     bool arp_match_ip;
2189     struct ofpbuf *b;
2190     int n_tables;
2191     int i;
2192
2193     ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2194                                          &features.actions);
2195     assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2196
2197     /* Count only non-hidden tables in the number of tables.  (Hidden tables,
2198      * if present, are always at the end.) */
2199     n_tables = ofproto->n_tables;
2200     for (i = 0; i < ofproto->n_tables; i++) {
2201         if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2202             n_tables = i;
2203             break;
2204         }
2205     }
2206
2207     features.datapath_id = ofproto->datapath_id;
2208     features.n_buffers = pktbuf_capacity();
2209     features.n_tables = n_tables;
2210     features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2211                              OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2212     if (arp_match_ip) {
2213         features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2214     }
2215
2216     b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2217                                        oh->xid);
2218     HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2219         ofputil_put_switch_features_port(&port->pp, b);
2220     }
2221
2222     ofconn_send_reply(ofconn, b);
2223     return 0;
2224 }
2225
2226 static enum ofperr
2227 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2228 {
2229     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2230     struct ofp_switch_config *osc;
2231     enum ofp_config_flags flags;
2232     struct ofpbuf *buf;
2233
2234     /* Send reply. */
2235     buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2236     osc = ofpbuf_put_uninit(buf, sizeof *osc);
2237     flags = ofproto->frag_handling;
2238     if (ofconn_get_invalid_ttl_to_controller(ofconn)) {
2239         flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2240     }
2241     osc->flags = htons(flags);
2242     osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2243     ofconn_send_reply(ofconn, buf);
2244
2245     return 0;
2246 }
2247
2248 static enum ofperr
2249 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2250 {
2251     const struct ofp_switch_config *osc = ofpmsg_body(oh);
2252     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2253     uint16_t flags = ntohs(osc->flags);
2254
2255     if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2256         || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
2257         enum ofp_config_flags cur = ofproto->frag_handling;
2258         enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2259
2260         assert((cur & OFPC_FRAG_MASK) == cur);
2261         if (cur != next) {
2262             if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2263                 ofproto->frag_handling = next;
2264             } else {
2265                 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2266                              ofproto->name,
2267                              ofputil_frag_handling_to_string(next));
2268             }
2269         }
2270     }
2271     ofconn_set_invalid_ttl_to_controller(ofconn,
2272              (flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2273
2274     ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2275
2276     return 0;
2277 }
2278
2279 /* Checks whether 'ofconn' is a slave controller.  If so, returns an OpenFlow
2280  * error message code for the caller to propagate upward.  Otherwise, returns
2281  * 0.
2282  *
2283  * The log message mentions 'msg_type'. */
2284 static enum ofperr
2285 reject_slave_controller(struct ofconn *ofconn)
2286 {
2287     if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2288         && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
2289         return OFPERR_OFPBRC_EPERM;
2290     } else {
2291         return 0;
2292     }
2293 }
2294
2295 static enum ofperr
2296 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2297 {
2298     struct ofproto *p = ofconn_get_ofproto(ofconn);
2299     struct ofputil_packet_out po;
2300     struct ofpbuf *payload;
2301     uint64_t ofpacts_stub[1024 / 8];
2302     struct ofpbuf ofpacts;
2303     struct flow flow;
2304     enum ofperr error;
2305
2306     COVERAGE_INC(ofproto_packet_out);
2307
2308     error = reject_slave_controller(ofconn);
2309     if (error) {
2310         goto exit;
2311     }
2312
2313     /* Decode message. */
2314     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2315     error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2316     if (error) {
2317         goto exit_free_ofpacts;
2318     }
2319     if (po.in_port >= p->max_ports && po.in_port < OFPP_MAX) {
2320         error = OFPERR_OFPBRC_BAD_PORT;
2321         goto exit_free_ofpacts;
2322     }
2323
2324
2325     /* Get payload. */
2326     if (po.buffer_id != UINT32_MAX) {
2327         error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2328         if (error || !payload) {
2329             goto exit_free_ofpacts;
2330         }
2331     } else {
2332         payload = xmalloc(sizeof *payload);
2333         ofpbuf_use_const(payload, po.packet, po.packet_len);
2334     }
2335
2336     /* Verify actions against packet, then send packet if successful. */
2337     flow_extract(payload, 0, NULL, po.in_port, &flow);
2338     error = ofpacts_check(po.ofpacts, po.ofpacts_len, &flow, p->max_ports);
2339     if (!error) {
2340         error = p->ofproto_class->packet_out(p, payload, &flow,
2341                                              po.ofpacts, po.ofpacts_len);
2342     }
2343     ofpbuf_delete(payload);
2344
2345 exit_free_ofpacts:
2346     ofpbuf_uninit(&ofpacts);
2347 exit:
2348     return error;
2349 }
2350
2351 static void
2352 update_port_config(struct ofport *port,
2353                    enum ofputil_port_config config,
2354                    enum ofputil_port_config mask)
2355 {
2356     enum ofputil_port_config old_config = port->pp.config;
2357     enum ofputil_port_config toggle;
2358
2359     toggle = (config ^ port->pp.config) & mask;
2360     if (toggle & OFPUTIL_PC_PORT_DOWN) {
2361         if (config & OFPUTIL_PC_PORT_DOWN) {
2362             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2363         } else {
2364             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2365         }
2366         toggle &= ~OFPUTIL_PC_PORT_DOWN;
2367     }
2368
2369     port->pp.config ^= toggle;
2370     if (port->pp.config != old_config) {
2371         port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2372     }
2373 }
2374
2375 static enum ofperr
2376 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2377 {
2378     struct ofproto *p = ofconn_get_ofproto(ofconn);
2379     struct ofputil_port_mod pm;
2380     struct ofport *port;
2381     enum ofperr error;
2382
2383     error = reject_slave_controller(ofconn);
2384     if (error) {
2385         return error;
2386     }
2387
2388     error = ofputil_decode_port_mod(oh, &pm);
2389     if (error) {
2390         return error;
2391     }
2392
2393     port = ofproto_get_port(p, pm.port_no);
2394     if (!port) {
2395         return OFPERR_OFPPMFC_BAD_PORT;
2396     } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2397         return OFPERR_OFPPMFC_BAD_HW_ADDR;
2398     } else {
2399         update_port_config(port, pm.config, pm.mask);
2400         if (pm.advertise) {
2401             netdev_set_advertisements(port->netdev, pm.advertise);
2402         }
2403     }
2404     return 0;
2405 }
2406
2407 static enum ofperr
2408 handle_desc_stats_request(struct ofconn *ofconn,
2409                           const struct ofp_header *request)
2410 {
2411     struct ofproto *p = ofconn_get_ofproto(ofconn);
2412     struct ofp_desc_stats *ods;
2413     struct ofpbuf *msg;
2414
2415     msg = ofpraw_alloc_stats_reply(request, 0);
2416     ods = ofpbuf_put_zeros(msg, sizeof *ods);
2417     ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
2418     ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
2419     ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
2420     ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
2421     ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
2422     ofconn_send_reply(ofconn, msg);
2423
2424     return 0;
2425 }
2426
2427 static enum ofperr
2428 handle_table_stats_request(struct ofconn *ofconn,
2429                            const struct ofp_header *request)
2430 {
2431     struct ofproto *p = ofconn_get_ofproto(ofconn);
2432     struct ofp12_table_stats *ots;
2433     struct ofpbuf *msg;
2434     int n_tables;
2435     size_t i;
2436
2437     /* Set up default values.
2438      *
2439      * ofp12_table_stats is used as a generic structure as
2440      * it is able to hold all the fields for ofp10_table_stats
2441      * and ofp11_table_stats (and of course itself).
2442      */
2443     ots = xcalloc(p->n_tables, sizeof *ots);
2444     for (i = 0; i < p->n_tables; i++) {
2445         ots[i].table_id = i;
2446         sprintf(ots[i].name, "table%zu", i);
2447         ots[i].match = htonll(OFPXMT12_MASK);
2448         ots[i].wildcards = htonll(OFPXMT12_MASK);
2449         ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2450         ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2451         ots[i].write_setfields = htonll(OFPXMT12_MASK);
2452         ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2453         ots[i].metadata_match = htonll(UINT64_MAX);
2454         ots[i].metadata_write = htonll(UINT64_MAX);
2455         ots[i].instructions = htonl(OFPIT11_ALL);
2456         ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2457         ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2458         ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2459     }
2460
2461     p->ofproto_class->get_tables(p, ots);
2462
2463     /* Post-process the tables, dropping hidden tables. */
2464     n_tables = p->n_tables;
2465     for (i = 0; i < p->n_tables; i++) {
2466         const struct oftable *table = &p->tables[i];
2467
2468         if (table->flags & OFTABLE_HIDDEN) {
2469             n_tables = i;
2470             break;
2471         }
2472
2473         if (table->name) {
2474             ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2475         }
2476
2477         if (table->max_flows < ntohl(ots[i].max_entries)) {
2478             ots[i].max_entries = htonl(table->max_flows);
2479         }
2480     }
2481
2482     msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2483     ofconn_send_reply(ofconn, msg);
2484
2485     free(ots);
2486
2487     return 0;
2488 }
2489
2490 static void
2491 append_port_stat(struct ofport *port, struct list *replies)
2492 {
2493     struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2494
2495     /* Intentionally ignore return value, since errors will set
2496      * 'stats' to all-1s, which is correct for OpenFlow, and
2497      * netdev_get_stats() will log errors. */
2498     ofproto_port_get_stats(port, &ops.stats);
2499
2500     ofputil_append_port_stat(replies, &ops);
2501 }
2502
2503 static enum ofperr
2504 handle_port_stats_request(struct ofconn *ofconn,
2505                           const struct ofp_header *request)
2506 {
2507     struct ofproto *p = ofconn_get_ofproto(ofconn);
2508     struct ofport *port;
2509     struct list replies;
2510     uint16_t port_no;
2511     enum ofperr error;
2512
2513     error = ofputil_decode_port_stats_request(request, &port_no);
2514     if (error) {
2515         return error;
2516     }
2517
2518     ofpmp_init(&replies, request);
2519     if (port_no != OFPP_NONE) {
2520         port = ofproto_get_port(p, port_no);
2521         if (port) {
2522             append_port_stat(port, &replies);
2523         }
2524     } else {
2525         HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2526             append_port_stat(port, &replies);
2527         }
2528     }
2529
2530     ofconn_send_replies(ofconn, &replies);
2531     return 0;
2532 }
2533
2534 static enum ofperr
2535 handle_port_desc_stats_request(struct ofconn *ofconn,
2536                                const struct ofp_header *request)
2537 {
2538     struct ofproto *p = ofconn_get_ofproto(ofconn);
2539     enum ofp_version version;
2540     struct ofport *port;
2541     struct list replies;
2542
2543     ofpmp_init(&replies, request);
2544
2545     version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2546     HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2547         ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2548     }
2549
2550     ofconn_send_replies(ofconn, &replies);
2551     return 0;
2552 }
2553
2554 static void
2555 calc_flow_duration__(long long int start, long long int now,
2556                      uint32_t *sec, uint32_t *nsec)
2557 {
2558     long long int msecs = now - start;
2559     *sec = msecs / 1000;
2560     *nsec = (msecs % 1000) * (1000 * 1000);
2561 }
2562
2563 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'.  Returns
2564  * 0 if 'table_id' is OK, otherwise an OpenFlow error code.  */
2565 static enum ofperr
2566 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2567 {
2568     return (table_id == 0xff || table_id < ofproto->n_tables
2569             ? 0
2570             : OFPERR_OFPBRC_BAD_TABLE_ID);
2571
2572 }
2573
2574 static struct oftable *
2575 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2576 {
2577     struct oftable *table;
2578
2579     for (table = &ofproto->tables[table_id];
2580          table < &ofproto->tables[ofproto->n_tables];
2581          table++) {
2582         if (!(table->flags & OFTABLE_HIDDEN)) {
2583             return table;
2584         }
2585     }
2586
2587     return NULL;
2588 }
2589
2590 static struct oftable *
2591 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2592 {
2593     if (table_id == 0xff) {
2594         return next_visible_table(ofproto, 0);
2595     } else if (table_id < ofproto->n_tables) {
2596         return &ofproto->tables[table_id];
2597     } else {
2598         return NULL;
2599     }
2600 }
2601
2602 static struct oftable *
2603 next_matching_table(const struct ofproto *ofproto,
2604                     const struct oftable *table, uint8_t table_id)
2605 {
2606     return (table_id == 0xff
2607             ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2608             : NULL);
2609 }
2610
2611 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2612  *
2613  *   - If TABLE_ID is 0xff, this iterates over every classifier table in
2614  *     OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2615  *
2616  *   - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2617  *     only once, for that table.  (This can be used to access tables marked
2618  *     OFTABLE_HIDDEN.)
2619  *
2620  *   - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2621  *     entered at all.  (Perhaps you should have validated TABLE_ID with
2622  *     check_table_id().)
2623  *
2624  * All parameters are evaluated multiple times.
2625  */
2626 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO)         \
2627     for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID);       \
2628          (TABLE) != NULL;                                         \
2629          (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2630
2631 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2632  * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2633  * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2634  * 'rules'.
2635  *
2636  * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2637  * to 'out_port' are included.
2638  *
2639  * Hidden rules are always omitted.
2640  *
2641  * Returns 0 on success, otherwise an OpenFlow error code. */
2642 static enum ofperr
2643 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2644                     const struct match *match,
2645                     ovs_be64 cookie, ovs_be64 cookie_mask,
2646                     uint16_t out_port, struct list *rules)
2647 {
2648     struct oftable *table;
2649     struct cls_rule cr;
2650     enum ofperr error;
2651
2652     error = check_table_id(ofproto, table_id);
2653     if (error) {
2654         return error;
2655     }
2656
2657     list_init(rules);
2658     cls_rule_init(&cr, match, 0);
2659     FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2660         struct cls_cursor cursor;
2661         struct rule *rule;
2662
2663         cls_cursor_init(&cursor, &table->cls, &cr);
2664         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2665             if (rule->pending) {
2666                 error = OFPROTO_POSTPONE;
2667                 goto exit;
2668             }
2669             if (!ofproto_rule_is_hidden(rule)
2670                 && ofproto_rule_has_out_port(rule, out_port)
2671                     && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2672                 list_push_back(rules, &rule->ofproto_node);
2673             }
2674         }
2675     }
2676
2677 exit:
2678     cls_rule_destroy(&cr);
2679     return error;
2680 }
2681
2682 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2683  * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2684  * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2685  * on list 'rules'.
2686  *
2687  * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2688  * to 'out_port' are included.
2689  *
2690  * Hidden rules are always omitted.
2691  *
2692  * Returns 0 on success, otherwise an OpenFlow error code. */
2693 static enum ofperr
2694 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2695                      const struct match *match, unsigned int priority,
2696                      ovs_be64 cookie, ovs_be64 cookie_mask,
2697                      uint16_t out_port, struct list *rules)
2698 {
2699     struct oftable *table;
2700     struct cls_rule cr;
2701     int error;
2702
2703     error = check_table_id(ofproto, table_id);
2704     if (error) {
2705         return error;
2706     }
2707
2708     list_init(rules);
2709     cls_rule_init(&cr, match, priority);
2710     FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2711         struct rule *rule;
2712
2713         rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2714                                                                &cr));
2715         if (rule) {
2716             if (rule->pending) {
2717                 error = OFPROTO_POSTPONE;
2718                 goto exit;
2719             }
2720             if (!ofproto_rule_is_hidden(rule)
2721                 && ofproto_rule_has_out_port(rule, out_port)
2722                     && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2723                 list_push_back(rules, &rule->ofproto_node);
2724             }
2725         }
2726     }
2727
2728 exit:
2729     cls_rule_destroy(&cr);
2730     return 0;
2731 }
2732
2733 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2734  * forced into the range of a uint16_t. */
2735 static int
2736 age_secs(long long int age_ms)
2737 {
2738     return (age_ms < 0 ? 0
2739             : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
2740             : (unsigned int) age_ms / 1000);
2741 }
2742
2743 static enum ofperr
2744 handle_flow_stats_request(struct ofconn *ofconn,
2745                           const struct ofp_header *request)
2746 {
2747     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2748     struct ofputil_flow_stats_request fsr;
2749     struct list replies;
2750     struct list rules;
2751     struct rule *rule;
2752     enum ofperr error;
2753
2754     error = ofputil_decode_flow_stats_request(&fsr, request);
2755     if (error) {
2756         return error;
2757     }
2758
2759     error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2760                                 fsr.cookie, fsr.cookie_mask,
2761                                 fsr.out_port, &rules);
2762     if (error) {
2763         return error;
2764     }
2765
2766     ofpmp_init(&replies, request);
2767     LIST_FOR_EACH (rule, ofproto_node, &rules) {
2768         long long int now = time_msec();
2769         struct ofputil_flow_stats fs;
2770
2771         minimatch_expand(&rule->cr.match, &fs.match);
2772         fs.priority = rule->cr.priority;
2773         fs.cookie = rule->flow_cookie;
2774         fs.table_id = rule->table_id;
2775         calc_flow_duration__(rule->created, now, &fs.duration_sec,
2776                              &fs.duration_nsec);
2777         fs.idle_timeout = rule->idle_timeout;
2778         fs.hard_timeout = rule->hard_timeout;
2779         fs.idle_age = age_secs(now - rule->used);
2780         fs.hard_age = age_secs(now - rule->modified);
2781         ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2782                                                &fs.byte_count);
2783         fs.ofpacts = rule->ofpacts;
2784         fs.ofpacts_len = rule->ofpacts_len;
2785         ofputil_append_flow_stats_reply(&fs, &replies);
2786     }
2787     ofconn_send_replies(ofconn, &replies);
2788
2789     return 0;
2790 }
2791
2792 static void
2793 flow_stats_ds(struct rule *rule, struct ds *results)
2794 {
2795     uint64_t packet_count, byte_count;
2796
2797     rule->ofproto->ofproto_class->rule_get_stats(rule,
2798                                                  &packet_count, &byte_count);
2799
2800     if (rule->table_id != 0) {
2801         ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2802     }
2803     ds_put_format(results, "duration=%llds, ",
2804                   (time_msec() - rule->created) / 1000);
2805     ds_put_format(results, "priority=%u, ", rule->cr.priority);
2806     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2807     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2808     cls_rule_format(&rule->cr, results);
2809     ds_put_char(results, ',');
2810     if (rule->ofpacts_len > 0) {
2811         ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
2812     } else {
2813         ds_put_cstr(results, "drop");
2814     }
2815     ds_put_cstr(results, "\n");
2816 }
2817
2818 /* Adds a pretty-printed description of all flows to 'results', including
2819  * hidden flows (e.g., set up by in-band control). */
2820 void
2821 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2822 {
2823     struct oftable *table;
2824
2825     OFPROTO_FOR_EACH_TABLE (table, p) {
2826         struct cls_cursor cursor;
2827         struct rule *rule;
2828
2829         cls_cursor_init(&cursor, &table->cls, NULL);
2830         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2831             flow_stats_ds(rule, results);
2832         }
2833     }
2834 }
2835
2836 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2837  * '*engine_type' and '*engine_id', respectively. */
2838 void
2839 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2840                         uint8_t *engine_type, uint8_t *engine_id)
2841 {
2842     ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2843 }
2844
2845 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'.  Returns a
2846  * bitmask of 'cfm_fault_reason's to indicate a CFM fault (generally
2847  * indicating a connectivity problem).  Returns zero if CFM is not faulted,
2848  * and -1 if CFM is not enabled on 'ofp_port'. */
2849 int
2850 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2851 {
2852     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2853     return (ofport && ofproto->ofproto_class->get_cfm_fault
2854             ? ofproto->ofproto_class->get_cfm_fault(ofport)
2855             : -1);
2856 }
2857
2858 /* Checks the operational status reported by the remote CFM endpoint of
2859  * 'ofp_port'  Returns 1 if operationally up, 0 if operationally down, and -1
2860  * if CFM is not enabled on 'ofp_port' or does not support operational status.
2861  */
2862 int
2863 ofproto_port_get_cfm_opup(const struct ofproto *ofproto, uint16_t ofp_port)
2864 {
2865     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2866     return (ofport && ofproto->ofproto_class->get_cfm_opup
2867             ? ofproto->ofproto_class->get_cfm_opup(ofport)
2868             : -1);
2869 }
2870
2871 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2872  * within 'ofproto'.  Populates 'rmps' with an array of MPIDs owned by
2873  * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'.  Returns a
2874  * number less than 0 if CFM is not enabled on 'ofp_port'. */
2875 int
2876 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2877                                   uint16_t ofp_port, const uint64_t **rmps,
2878                                   size_t *n_rmps)
2879 {
2880     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2881
2882     *rmps = NULL;
2883     *n_rmps = 0;
2884     return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2885             ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2886                                                            n_rmps)
2887             : -1);
2888 }
2889
2890 /* Checks the health of the CFM for 'ofp_port' within 'ofproto'.  Returns an
2891  * integer value between 0 and 100 to indicate the health of the port as a
2892  * percentage which is the average of cfm health of all the remote_mpids or
2893  * returns -1 if CFM is not enabled on 'ofport'. */
2894 int
2895 ofproto_port_get_cfm_health(const struct ofproto *ofproto, uint16_t ofp_port)
2896 {
2897     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2898     return (ofport && ofproto->ofproto_class->get_cfm_health
2899             ? ofproto->ofproto_class->get_cfm_health(ofport)
2900             : -1);
2901 }
2902
2903 static enum ofperr
2904 handle_aggregate_stats_request(struct ofconn *ofconn,
2905                                const struct ofp_header *oh)
2906 {
2907     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2908     struct ofputil_flow_stats_request request;
2909     struct ofputil_aggregate_stats stats;
2910     bool unknown_packets, unknown_bytes;
2911     struct ofpbuf *reply;
2912     struct list rules;
2913     struct rule *rule;
2914     enum ofperr error;
2915
2916     error = ofputil_decode_flow_stats_request(&request, oh);
2917     if (error) {
2918         return error;
2919     }
2920
2921     error = collect_rules_loose(ofproto, request.table_id, &request.match,
2922                                 request.cookie, request.cookie_mask,
2923                                 request.out_port, &rules);
2924     if (error) {
2925         return error;
2926     }
2927
2928     memset(&stats, 0, sizeof stats);
2929     unknown_packets = unknown_bytes = false;
2930     LIST_FOR_EACH (rule, ofproto_node, &rules) {
2931         uint64_t packet_count;
2932         uint64_t byte_count;
2933
2934         ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2935                                                &byte_count);
2936
2937         if (packet_count == UINT64_MAX) {
2938             unknown_packets = true;
2939         } else {
2940             stats.packet_count += packet_count;
2941         }
2942
2943         if (byte_count == UINT64_MAX) {
2944             unknown_bytes = true;
2945         } else {
2946             stats.byte_count += byte_count;
2947         }
2948
2949         stats.flow_count++;
2950     }
2951     if (unknown_packets) {
2952         stats.packet_count = UINT64_MAX;
2953     }
2954     if (unknown_bytes) {
2955         stats.byte_count = UINT64_MAX;
2956     }
2957
2958     reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
2959     ofconn_send_reply(ofconn, reply);
2960
2961     return 0;
2962 }
2963
2964 struct queue_stats_cbdata {
2965     struct ofport *ofport;
2966     struct list replies;
2967 };
2968
2969 static void
2970 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2971                 const struct netdev_queue_stats *stats)
2972 {
2973
2974     struct ofputil_queue_stats oqs = {
2975         .port_no = cbdata->ofport->pp.port_no,
2976         .queue_id = queue_id,
2977         .stats = *stats,
2978     };
2979     ofputil_append_queue_stat(&cbdata->replies, &oqs);
2980 }
2981
2982 static void
2983 handle_queue_stats_dump_cb(uint32_t queue_id,
2984                            struct netdev_queue_stats *stats,
2985                            void *cbdata_)
2986 {
2987     struct queue_stats_cbdata *cbdata = cbdata_;
2988
2989     put_queue_stats(cbdata, queue_id, stats);
2990 }
2991
2992 static enum ofperr
2993 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2994                             struct queue_stats_cbdata *cbdata)
2995 {
2996     cbdata->ofport = port;
2997     if (queue_id == OFPQ_ALL) {
2998         netdev_dump_queue_stats(port->netdev,
2999                                 handle_queue_stats_dump_cb, cbdata);
3000     } else {
3001         struct netdev_queue_stats stats;
3002
3003         if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3004             put_queue_stats(cbdata, queue_id, &stats);
3005         } else {
3006             return OFPERR_OFPQOFC_BAD_QUEUE;
3007         }
3008     }
3009     return 0;
3010 }
3011
3012 static enum ofperr
3013 handle_queue_stats_request(struct ofconn *ofconn,
3014                            const struct ofp_header *rq)
3015 {
3016     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3017     struct queue_stats_cbdata cbdata;
3018     struct ofport *port;
3019     enum ofperr error;
3020     struct ofputil_queue_stats_request oqsr;
3021
3022     COVERAGE_INC(ofproto_queue_req);
3023
3024     ofpmp_init(&cbdata.replies, rq);
3025
3026     error = ofputil_decode_queue_stats_request(rq, &oqsr);
3027     if (error) {
3028         return error;
3029     }
3030
3031     if (oqsr.port_no == OFPP_ALL) {
3032         error = OFPERR_OFPQOFC_BAD_QUEUE;
3033         HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3034             if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3035                 error = 0;
3036             }
3037         }
3038     } else {
3039         port = ofproto_get_port(ofproto, oqsr.port_no);
3040         error = (port
3041                  ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3042                  : OFPERR_OFPQOFC_BAD_PORT);
3043     }
3044     if (!error) {
3045         ofconn_send_replies(ofconn, &cbdata.replies);
3046     } else {
3047         ofpbuf_list_delete(&cbdata.replies);
3048     }
3049
3050     return error;
3051 }
3052
3053 static bool
3054 is_flow_deletion_pending(const struct ofproto *ofproto,
3055                          const struct cls_rule *cls_rule,
3056                          uint8_t table_id)
3057 {
3058     if (!hmap_is_empty(&ofproto->deletions)) {
3059         struct ofoperation *op;
3060
3061         HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3062                                  cls_rule_hash(cls_rule, table_id),
3063                                  &ofproto->deletions) {
3064             if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3065                 return true;
3066             }
3067         }
3068     }
3069
3070     return false;
3071 }
3072
3073 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3074  * in which no matching flow already exists in the flow table.
3075  *
3076  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3077  * ofp_actions, to the ofproto's flow table.  Returns 0 on success, an OpenFlow
3078  * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3079  * initiated now but may be retried later.
3080  *
3081  * Upon successful return, takes ownership of 'fm->ofpacts'.  On failure,
3082  * ownership remains with the caller.
3083  *
3084  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3085  * if any. */
3086 static enum ofperr
3087 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3088          const struct ofputil_flow_mod *fm, const struct ofp_header *request)
3089 {
3090     struct oftable *table;
3091     struct ofopgroup *group;
3092     struct rule *victim;
3093     struct cls_rule cr;
3094     struct rule *rule;
3095     int error;
3096
3097     error = check_table_id(ofproto, fm->table_id);
3098     if (error) {
3099         return error;
3100     }
3101
3102     /* Pick table. */
3103     if (fm->table_id == 0xff) {
3104         uint8_t table_id;
3105         if (ofproto->ofproto_class->rule_choose_table) {
3106             error = ofproto->ofproto_class->rule_choose_table(ofproto,
3107                                                               &fm->match,
3108                                                               &table_id);
3109             if (error) {
3110                 return error;
3111             }
3112             assert(table_id < ofproto->n_tables);
3113             table = &ofproto->tables[table_id];
3114         } else {
3115             table = &ofproto->tables[0];
3116         }
3117     } else if (fm->table_id < ofproto->n_tables) {
3118         table = &ofproto->tables[fm->table_id];
3119     } else {
3120         return OFPERR_OFPBRC_BAD_TABLE_ID;
3121     }
3122
3123     if (table->flags & OFTABLE_READONLY) {
3124         return OFPERR_OFPBRC_EPERM;
3125     }
3126
3127     /* Allocate new rule and initialize classifier rule. */
3128     rule = ofproto->ofproto_class->rule_alloc();
3129     if (!rule) {
3130         VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3131                      ofproto->name, strerror(error));
3132         return ENOMEM;
3133     }
3134     cls_rule_init(&rule->cr, &fm->match, fm->priority);
3135
3136     /* Serialize against pending deletion. */
3137     if (is_flow_deletion_pending(ofproto, &cr, table - ofproto->tables)) {
3138         cls_rule_destroy(&rule->cr);
3139         ofproto->ofproto_class->rule_dealloc(rule);
3140         return OFPROTO_POSTPONE;
3141     }
3142
3143     /* Check for overlap, if requested. */
3144     if (fm->flags & OFPFF_CHECK_OVERLAP
3145         && classifier_rule_overlaps(&table->cls, &rule->cr)) {
3146         cls_rule_destroy(&rule->cr);
3147         ofproto->ofproto_class->rule_dealloc(rule);
3148         return OFPERR_OFPFMFC_OVERLAP;
3149     }
3150
3151     rule->ofproto = ofproto;
3152     rule->pending = NULL;
3153     rule->flow_cookie = fm->new_cookie;
3154     rule->created = rule->modified = rule->used = time_msec();
3155     rule->idle_timeout = fm->idle_timeout;
3156     rule->hard_timeout = fm->hard_timeout;
3157     rule->table_id = table - ofproto->tables;
3158     rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
3159     rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3160     rule->ofpacts_len = fm->ofpacts_len;
3161     rule->evictable = true;
3162     rule->eviction_group = NULL;
3163     rule->monitor_flags = 0;
3164     rule->add_seqno = 0;
3165     rule->modify_seqno = 0;
3166
3167     /* Insert new rule. */
3168     victim = oftable_replace_rule(rule);
3169     if (victim && !rule_is_modifiable(victim)) {
3170         error = OFPERR_OFPBRC_EPERM;
3171     } else if (victim && victim->pending) {
3172         error = OFPROTO_POSTPONE;
3173     } else {
3174         struct ofoperation *op;
3175         struct rule *evict;
3176
3177         if (classifier_count(&table->cls) > table->max_flows) {
3178             bool was_evictable;
3179
3180             was_evictable = rule->evictable;
3181             rule->evictable = false;
3182             evict = choose_rule_to_evict(table);
3183             rule->evictable = was_evictable;
3184
3185             if (!evict) {
3186                 error = OFPERR_OFPFMFC_TABLE_FULL;
3187                 goto exit;
3188             } else if (evict->pending) {
3189                 error = OFPROTO_POSTPONE;
3190                 goto exit;
3191             }
3192         } else {
3193             evict = NULL;
3194         }
3195
3196         group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3197         op = ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3198         op->victim = victim;
3199
3200         error = ofproto->ofproto_class->rule_construct(rule);
3201         if (error) {
3202             op->group->n_running--;
3203             ofoperation_destroy(rule->pending);
3204         } else if (evict) {
3205             delete_flow__(evict, group);
3206         }
3207         ofopgroup_submit(group);
3208     }
3209
3210 exit:
3211     /* Back out if an error occurred. */
3212     if (error) {
3213         oftable_substitute_rule(rule, victim);
3214         ofproto_rule_destroy__(rule);
3215     }
3216     return error;
3217 }
3218 \f
3219 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3220
3221 /* Modifies the rules listed in 'rules', changing their actions to match those
3222  * in 'fm'.
3223  *
3224  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3225  * if any.
3226  *
3227  * Returns 0 on success, otherwise an OpenFlow error code. */
3228 static enum ofperr
3229 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3230                const struct ofputil_flow_mod *fm,
3231                const struct ofp_header *request, struct list *rules)
3232 {
3233     struct ofopgroup *group;
3234     struct rule *rule;
3235     enum ofperr error;
3236
3237     group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3238     error = OFPERR_OFPBRC_EPERM;
3239     LIST_FOR_EACH (rule, ofproto_node, rules) {
3240         struct ofoperation *op;
3241         bool actions_changed;
3242         ovs_be64 new_cookie;
3243
3244         if (rule_is_modifiable(rule)) {
3245             /* At least one rule is modifiable, don't report EPERM error. */
3246             error = 0;
3247         } else {
3248             continue;
3249         }
3250
3251         actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3252                                          rule->ofpacts, rule->ofpacts_len);
3253         new_cookie = (fm->new_cookie != htonll(UINT64_MAX)
3254                       ? fm->new_cookie
3255                       : rule->flow_cookie);
3256         if (!actions_changed && new_cookie == rule->flow_cookie) {
3257             /* No change at all. */
3258             continue;
3259         }
3260
3261         op = ofoperation_create(group, rule, OFOPERATION_MODIFY, 0);
3262         rule->flow_cookie = new_cookie;
3263         if (actions_changed) {
3264             op->ofpacts = rule->ofpacts;
3265             op->ofpacts_len = rule->ofpacts_len;
3266             rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3267             rule->ofpacts_len = fm->ofpacts_len;
3268             rule->ofproto->ofproto_class->rule_modify_actions(rule);
3269         } else {
3270             ofoperation_complete(op, 0);
3271         }
3272     }
3273     ofopgroup_submit(group);
3274
3275     return error;
3276 }
3277
3278 static enum ofperr
3279 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3280                  const struct ofputil_flow_mod *fm,
3281                  const struct ofp_header *request)
3282 {
3283     if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3284         return 0;
3285     }
3286     return add_flow(ofproto, ofconn, fm, request);
3287 }
3288
3289 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code on
3290  * failure.
3291  *
3292  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3293  * if any. */
3294 static enum ofperr
3295 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3296                    const struct ofputil_flow_mod *fm,
3297                    const struct ofp_header *request)
3298 {
3299     struct list rules;
3300     int error;
3301
3302     error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3303                                 fm->cookie, fm->cookie_mask,
3304                                 OFPP_NONE, &rules);
3305     if (error) {
3306         return error;
3307     } else if (list_is_empty(&rules)) {
3308         return modify_flows_add(ofproto, ofconn, fm, request);
3309     } else {
3310         return modify_flows__(ofproto, ofconn, fm, request, &rules);
3311     }
3312 }
3313
3314 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
3315  * code on failure.
3316  *
3317  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3318  * if any. */
3319 static enum ofperr
3320 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3321                    const struct ofputil_flow_mod *fm,
3322                    const struct ofp_header *request)
3323 {
3324     struct list rules;
3325     int error;
3326
3327     error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3328                                  fm->priority, fm->cookie, fm->cookie_mask,
3329                                  OFPP_NONE, &rules);
3330
3331     if (error) {
3332         return error;
3333     } else if (list_is_empty(&rules)) {
3334         return modify_flows_add(ofproto, ofconn, fm, request);
3335     } else {
3336         return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3337                                                           fm, request, &rules)
3338                                          : 0;
3339     }
3340 }
3341 \f
3342 /* OFPFC_DELETE implementation. */
3343
3344 static void
3345 delete_flow__(struct rule *rule, struct ofopgroup *group)
3346 {
3347     struct ofproto *ofproto = rule->ofproto;
3348
3349     ofproto_rule_send_removed(rule, OFPRR_DELETE);
3350
3351     ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
3352     oftable_remove_rule(rule);
3353     ofproto->ofproto_class->rule_destruct(rule);
3354 }
3355
3356 /* Deletes the rules listed in 'rules'.
3357  *
3358  * Returns 0 on success, otherwise an OpenFlow error code. */
3359 static enum ofperr
3360 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3361                const struct ofp_header *request, struct list *rules)
3362 {
3363     struct rule *rule, *next;
3364     struct ofopgroup *group;
3365
3366     group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3367     LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3368         delete_flow__(rule, group);
3369     }
3370     ofopgroup_submit(group);
3371
3372     return 0;
3373 }
3374
3375 /* Implements OFPFC_DELETE. */
3376 static enum ofperr
3377 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3378                    const struct ofputil_flow_mod *fm,
3379                    const struct ofp_header *request)
3380 {
3381     struct list rules;
3382     enum ofperr error;
3383
3384     error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3385                                 fm->cookie, fm->cookie_mask,
3386                                 fm->out_port, &rules);
3387     return (error ? error
3388             : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3389                                                       &rules)
3390             : 0);
3391 }
3392
3393 /* Implements OFPFC_DELETE_STRICT. */
3394 static enum ofperr
3395 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3396                    const struct ofputil_flow_mod *fm,
3397                    const struct ofp_header *request)
3398 {
3399     struct list rules;
3400     enum ofperr error;
3401
3402     error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3403                                  fm->priority, fm->cookie, fm->cookie_mask,
3404                                  fm->out_port, &rules);
3405     return (error ? error
3406             : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3407                                                          request, &rules)
3408             : 0);
3409 }
3410
3411 static void
3412 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3413 {
3414     struct ofputil_flow_removed fr;
3415
3416     if (ofproto_rule_is_hidden(rule) || !rule->send_flow_removed) {
3417         return;
3418     }
3419
3420     minimatch_expand(&rule->cr.match, &fr.match);
3421     fr.priority = rule->cr.priority;
3422     fr.cookie = rule->flow_cookie;
3423     fr.reason = reason;
3424     fr.table_id = rule->table_id;
3425     calc_flow_duration__(rule->created, time_msec(),
3426                          &fr.duration_sec, &fr.duration_nsec);
3427     fr.idle_timeout = rule->idle_timeout;
3428     fr.hard_timeout = rule->hard_timeout;
3429     rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3430                                                  &fr.byte_count);
3431
3432     connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3433 }
3434
3435 void
3436 ofproto_rule_update_used(struct rule *rule, long long int used)
3437 {
3438     if (used > rule->used) {
3439         struct eviction_group *evg = rule->eviction_group;
3440
3441         rule->used = used;
3442         if (evg) {
3443             heap_change(&evg->rules, &rule->evg_node,
3444                         rule_eviction_priority(rule));
3445         }
3446     }
3447 }
3448
3449 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3450  * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3451  * ofproto.
3452  *
3453  * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3454  * NULL).
3455  *
3456  * ofproto implementation ->run() functions should use this function to expire
3457  * OpenFlow flows. */
3458 void
3459 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3460 {
3461     struct ofproto *ofproto = rule->ofproto;
3462     struct ofopgroup *group;
3463
3464     assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
3465
3466     ofproto_rule_send_removed(rule, reason);
3467
3468     group = ofopgroup_create_unattached(ofproto);
3469     ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3470     oftable_remove_rule(rule);
3471     ofproto->ofproto_class->rule_destruct(rule);
3472     ofopgroup_submit(group);
3473 }
3474 \f
3475 static enum ofperr
3476 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3477 {
3478     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3479     struct ofputil_flow_mod fm;
3480     uint64_t ofpacts_stub[1024 / 8];
3481     struct ofpbuf ofpacts;
3482     enum ofperr error;
3483     long long int now;
3484
3485     error = reject_slave_controller(ofconn);
3486     if (error) {
3487         goto exit;
3488     }
3489
3490     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3491     error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3492                                     &ofpacts);
3493     if (error) {
3494         goto exit_free_ofpacts;
3495     }
3496
3497     if (fm.flags & OFPFF10_EMERG) {
3498         /* We do not support the OpenFlow 1.0 emergency flow cache, which
3499          * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
3500          * There is no good error code, so just state that the flow table
3501          * is full. */
3502         error = OFPERR_OFPFMFC_TABLE_FULL;
3503     }
3504     if (!error) {
3505         error = ofpacts_check(fm.ofpacts, fm.ofpacts_len,
3506                               &fm.match.flow, ofproto->max_ports);
3507     }
3508     if (!error) {
3509         error = handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
3510     }
3511     if (error) {
3512         goto exit_free_ofpacts;
3513     }
3514
3515     /* Record the operation for logging a summary report. */
3516     switch (fm.command) {
3517     case OFPFC_ADD:
3518         ofproto->n_add++;
3519         break;
3520
3521     case OFPFC_MODIFY:
3522     case OFPFC_MODIFY_STRICT:
3523         ofproto->n_modify++;
3524         break;
3525
3526     case OFPFC_DELETE:
3527     case OFPFC_DELETE_STRICT:
3528         ofproto->n_delete++;
3529         break;
3530     }
3531
3532     now = time_msec();
3533     if (ofproto->next_op_report == LLONG_MAX) {
3534         ofproto->first_op = now;
3535         ofproto->next_op_report = MAX(now + 10 * 1000,
3536                                       ofproto->op_backoff);
3537         ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
3538     }
3539     ofproto->last_op = now;
3540
3541 exit_free_ofpacts:
3542     ofpbuf_uninit(&ofpacts);
3543 exit:
3544     return error;
3545 }
3546
3547 static enum ofperr
3548 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3549                   const struct ofputil_flow_mod *fm,
3550                   const struct ofp_header *oh)
3551 {
3552     if (ofproto->n_pending >= 50) {
3553         assert(!list_is_empty(&ofproto->pending));
3554         return OFPROTO_POSTPONE;
3555     }
3556
3557     switch (fm->command) {
3558     case OFPFC_ADD:
3559         return add_flow(ofproto, ofconn, fm, oh);
3560
3561     case OFPFC_MODIFY:
3562         return modify_flows_loose(ofproto, ofconn, fm, oh);
3563
3564     case OFPFC_MODIFY_STRICT:
3565         return modify_flow_strict(ofproto, ofconn, fm, oh);
3566
3567     case OFPFC_DELETE:
3568         return delete_flows_loose(ofproto, ofconn, fm, oh);
3569
3570     case OFPFC_DELETE_STRICT:
3571         return delete_flow_strict(ofproto, ofconn, fm, oh);
3572
3573     default:
3574         if (fm->command > 0xff) {
3575             VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
3576                          "flow_mod_table_id extension is not enabled",
3577                          ofproto->name);
3578         }
3579         return OFPERR_OFPFMFC_BAD_COMMAND;
3580     }
3581 }
3582
3583 static enum ofperr
3584 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
3585 {
3586     const struct nx_role_request *nrr = ofpmsg_body(oh);
3587     struct nx_role_request *reply;
3588     struct ofpbuf *buf;
3589     uint32_t role;
3590
3591     role = ntohl(nrr->role);
3592     if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
3593         && role != NX_ROLE_SLAVE) {
3594         return OFPERR_OFPRRFC_BAD_ROLE;
3595     }
3596
3597     if (ofconn_get_role(ofconn) != role
3598         && ofconn_has_pending_opgroups(ofconn)) {
3599         return OFPROTO_POSTPONE;
3600     }
3601
3602     ofconn_set_role(ofconn, role);
3603
3604     buf = ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY, oh, 0);
3605     reply = ofpbuf_put_zeros(buf, sizeof *reply);
3606     reply->role = htonl(role);
3607     ofconn_send_reply(ofconn, buf);
3608
3609     return 0;
3610 }
3611
3612 static enum ofperr
3613 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
3614                              const struct ofp_header *oh)
3615 {
3616     const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
3617     enum ofputil_protocol cur, next;
3618
3619     cur = ofconn_get_protocol(ofconn);
3620     next = ofputil_protocol_set_tid(cur, msg->set != 0);
3621     ofconn_set_protocol(ofconn, next);
3622
3623     return 0;
3624 }
3625
3626 static enum ofperr
3627 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
3628 {
3629     const struct nx_set_flow_format *msg = ofpmsg_body(oh);
3630     enum ofputil_protocol cur, next;
3631     enum ofputil_protocol next_base;
3632
3633     next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
3634     if (!next_base) {
3635         return OFPERR_OFPBRC_EPERM;
3636     }
3637
3638     cur = ofconn_get_protocol(ofconn);
3639     next = ofputil_protocol_set_base(cur, next_base);
3640     if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
3641         /* Avoid sending async messages in surprising protocol. */
3642         return OFPROTO_POSTPONE;
3643     }
3644
3645     ofconn_set_protocol(ofconn, next);
3646     return 0;
3647 }
3648
3649 static enum ofperr
3650 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
3651                                 const struct ofp_header *oh)
3652 {
3653     const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
3654     uint32_t format;
3655
3656     format = ntohl(msg->format);
3657     if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
3658         return OFPERR_OFPBRC_EPERM;
3659     }
3660
3661     if (format != ofconn_get_packet_in_format(ofconn)
3662         && ofconn_has_pending_opgroups(ofconn)) {
3663         /* Avoid sending async message in surprsing packet in format. */
3664         return OFPROTO_POSTPONE;
3665     }
3666
3667     ofconn_set_packet_in_format(ofconn, format);
3668     return 0;
3669 }
3670
3671 static enum ofperr
3672 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
3673 {
3674     const struct nx_async_config *msg = ofpmsg_body(oh);
3675     uint32_t master[OAM_N_TYPES];
3676     uint32_t slave[OAM_N_TYPES];
3677
3678     master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
3679     master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
3680     master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
3681
3682     slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
3683     slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
3684     slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
3685
3686     ofconn_set_async_config(ofconn, master, slave);
3687     if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
3688         !ofconn_get_miss_send_len(ofconn)) {
3689         ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
3690     }
3691
3692     return 0;
3693 }
3694
3695 static enum ofperr
3696 handle_nxt_set_controller_id(struct ofconn *ofconn,
3697                              const struct ofp_header *oh)
3698 {
3699     const struct nx_controller_id *nci = ofpmsg_body(oh);
3700
3701     if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
3702         return OFPERR_NXBRC_MUST_BE_ZERO;
3703     }
3704
3705     ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
3706     return 0;
3707 }
3708
3709 static enum ofperr
3710 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
3711 {
3712     struct ofpbuf *buf;
3713
3714     if (ofconn_has_pending_opgroups(ofconn)) {
3715         return OFPROTO_POSTPONE;
3716     }
3717
3718     buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
3719                               ? OFPRAW_OFPT10_BARRIER_REPLY
3720                               : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
3721     ofconn_send_reply(ofconn, buf);
3722     return 0;
3723 }
3724
3725 static void
3726 ofproto_compose_flow_refresh_update(const struct rule *rule,
3727                                     enum nx_flow_monitor_flags flags,
3728                                     struct list *msgs)
3729 {
3730     struct ofoperation *op = rule->pending;
3731     struct ofputil_flow_update fu;
3732     struct match match;
3733
3734     if (op && op->type == OFOPERATION_ADD && !op->victim) {
3735         /* We'll report the final flow when the operation completes.  Reporting
3736          * it now would cause a duplicate report later. */
3737         return;
3738     }
3739
3740     fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
3741                 ? NXFME_ADDED : NXFME_MODIFIED);
3742     fu.reason = 0;
3743     fu.idle_timeout = rule->idle_timeout;
3744     fu.hard_timeout = rule->hard_timeout;
3745     fu.table_id = rule->table_id;
3746     fu.cookie = rule->flow_cookie;
3747     minimatch_expand(&rule->cr.match, &match);
3748     fu.match = &match;
3749     fu.priority = rule->cr.priority;
3750     if (!(flags & NXFMF_ACTIONS)) {
3751         fu.ofpacts = NULL;
3752         fu.ofpacts_len = 0;
3753     } else if (!op) {
3754         fu.ofpacts = rule->ofpacts;
3755         fu.ofpacts_len = rule->ofpacts_len;
3756     } else {
3757         /* An operation is in progress.  Use the previous version of the flow's
3758          * actions, so that when the operation commits we report the change. */
3759         switch (op->type) {
3760         case OFOPERATION_ADD:
3761             /* We already verified that there was a victim. */
3762             fu.ofpacts = op->victim->ofpacts;
3763             fu.ofpacts_len = op->victim->ofpacts_len;
3764             break;
3765
3766         case OFOPERATION_MODIFY:
3767             if (op->ofpacts) {
3768                 fu.ofpacts = op->ofpacts;
3769                 fu.ofpacts_len = op->ofpacts_len;
3770             } else {
3771                 fu.ofpacts = rule->ofpacts;
3772                 fu.ofpacts_len = rule->ofpacts_len;
3773             }
3774             break;
3775
3776         case OFOPERATION_DELETE:
3777             fu.ofpacts = rule->ofpacts;
3778             fu.ofpacts_len = rule->ofpacts_len;
3779             break;
3780
3781         default:
3782             NOT_REACHED();
3783         }
3784     }
3785
3786     if (list_is_empty(msgs)) {
3787         ofputil_start_flow_update(msgs);
3788     }
3789     ofputil_append_flow_update(&fu, msgs);
3790 }
3791
3792 void
3793 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
3794 {
3795     struct rule *rule;
3796
3797     LIST_FOR_EACH (rule, ofproto_node, rules) {
3798         enum nx_flow_monitor_flags flags = rule->monitor_flags;
3799         rule->monitor_flags = 0;
3800
3801         ofproto_compose_flow_refresh_update(rule, flags, msgs);
3802     }
3803 }
3804
3805 static void
3806 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
3807                                        struct rule *rule, uint64_t seqno,
3808                                        struct list *rules)
3809 {
3810     enum nx_flow_monitor_flags update;
3811
3812     if (ofproto_rule_is_hidden(rule)) {
3813         return;
3814     }
3815
3816     if (!(rule->pending
3817           ? ofoperation_has_out_port(rule->pending, m->out_port)
3818           : ofproto_rule_has_out_port(rule, m->out_port))) {
3819         return;
3820     }
3821
3822     if (seqno) {
3823         if (rule->add_seqno > seqno) {
3824             update = NXFMF_ADD | NXFMF_MODIFY;
3825         } else if (rule->modify_seqno > seqno) {
3826             update = NXFMF_MODIFY;
3827         } else {
3828             return;
3829         }
3830
3831         if (!(m->flags & update)) {
3832             return;
3833         }
3834     } else {
3835         update = NXFMF_INITIAL;
3836     }
3837
3838     if (!rule->monitor_flags) {
3839         list_push_back(rules, &rule->ofproto_node);
3840     }
3841     rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
3842 }
3843
3844 static void
3845 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
3846                                         uint64_t seqno,
3847                                         struct list *rules)
3848 {
3849     const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
3850     const struct ofoperation *op;
3851     const struct oftable *table;
3852     struct cls_rule target;
3853
3854     cls_rule_init_from_minimatch(&target, &m->match, 0);
3855     FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
3856         struct cls_cursor cursor;
3857         struct rule *rule;
3858
3859         cls_cursor_init(&cursor, &table->cls, &target);
3860         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3861             assert(!rule->pending); /* XXX */
3862             ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3863         }
3864     }
3865
3866     HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
3867         struct rule *rule = op->rule;
3868
3869         if (((m->table_id == 0xff
3870               ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
3871               : m->table_id == rule->table_id))
3872             && cls_rule_is_loose_match(&rule->cr, &target.match)) {
3873             ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3874         }
3875     }
3876     cls_rule_destroy(&target);
3877 }
3878
3879 static void
3880 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
3881                                         struct list *rules)
3882 {
3883     if (m->flags & NXFMF_INITIAL) {
3884         ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
3885     }
3886 }
3887
3888 void
3889 ofmonitor_collect_resume_rules(struct ofmonitor *m,
3890                                uint64_t seqno, struct list *rules)
3891 {
3892     ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
3893 }
3894
3895 static enum ofperr
3896 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
3897 {
3898     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3899     struct ofmonitor **monitors;
3900     size_t n_monitors, allocated_monitors;
3901     struct list replies;
3902     enum ofperr error;
3903     struct list rules;
3904     struct ofpbuf b;
3905     size_t i;
3906
3907     error = 0;
3908     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3909     monitors = NULL;
3910     n_monitors = allocated_monitors = 0;
3911     for (;;) {
3912         struct ofputil_flow_monitor_request request;
3913         struct ofmonitor *m;
3914         int retval;
3915
3916         retval = ofputil_decode_flow_monitor_request(&request, &b);
3917         if (retval == EOF) {
3918             break;
3919         } else if (retval) {
3920             error = retval;
3921             goto error;
3922         }
3923
3924         if (request.table_id != 0xff
3925             && request.table_id >= ofproto->n_tables) {
3926             error = OFPERR_OFPBRC_BAD_TABLE_ID;
3927             goto error;
3928         }
3929
3930         error = ofmonitor_create(&request, ofconn, &m);
3931         if (error) {
3932             goto error;
3933         }
3934
3935         if (n_monitors >= allocated_monitors) {
3936             monitors = x2nrealloc(monitors, &allocated_monitors,
3937                                   sizeof *monitors);
3938         }
3939         monitors[n_monitors++] = m;
3940     }
3941
3942     list_init(&rules);
3943     for (i = 0; i < n_monitors; i++) {
3944         ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
3945     }
3946
3947     ofpmp_init(&replies, oh);
3948     ofmonitor_compose_refresh_updates(&rules, &replies);
3949     ofconn_send_replies(ofconn, &replies);
3950
3951     free(monitors);
3952
3953     return 0;
3954
3955 error:
3956     for (i = 0; i < n_monitors; i++) {
3957         ofmonitor_destroy(monitors[i]);
3958     }
3959     free(monitors);
3960     return error;
3961 }
3962
3963 static enum ofperr
3964 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
3965 {
3966     struct ofmonitor *m;
3967     uint32_t id;
3968
3969     id = ofputil_decode_flow_monitor_cancel(oh);
3970     m = ofmonitor_lookup(ofconn, id);
3971     if (!m) {
3972         return OFPERR_NXBRC_FM_BAD_ID;
3973     }
3974
3975     ofmonitor_destroy(m);
3976     return 0;
3977 }
3978
3979 static enum ofperr
3980 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
3981 {
3982     const struct ofp_header *oh = msg->data;
3983     enum ofptype type;
3984     enum ofperr error;
3985
3986     error = ofptype_decode(&type, oh);
3987     if (error) {
3988         return error;
3989     }
3990
3991     switch (type) {
3992         /* OpenFlow requests. */
3993     case OFPTYPE_ECHO_REQUEST:
3994         return handle_echo_request(ofconn, oh);
3995
3996     case OFPTYPE_FEATURES_REQUEST:
3997         return handle_features_request(ofconn, oh);
3998
3999     case OFPTYPE_GET_CONFIG_REQUEST:
4000         return handle_get_config_request(ofconn, oh);
4001
4002     case OFPTYPE_SET_CONFIG:
4003         return handle_set_config(ofconn, oh);
4004
4005     case OFPTYPE_PACKET_OUT:
4006         return handle_packet_out(ofconn, oh);
4007
4008     case OFPTYPE_PORT_MOD:
4009         return handle_port_mod(ofconn, oh);
4010
4011     case OFPTYPE_FLOW_MOD:
4012         return handle_flow_mod(ofconn, oh);
4013
4014     case OFPTYPE_BARRIER_REQUEST:
4015         return handle_barrier_request(ofconn, oh);
4016
4017         /* OpenFlow replies. */
4018     case OFPTYPE_ECHO_REPLY:
4019         return 0;
4020
4021         /* Nicira extension requests. */
4022     case OFPTYPE_ROLE_REQUEST:
4023         return handle_role_request(ofconn, oh);
4024
4025     case OFPTYPE_FLOW_MOD_TABLE_ID:
4026         return handle_nxt_flow_mod_table_id(ofconn, oh);
4027
4028     case OFPTYPE_SET_FLOW_FORMAT:
4029         return handle_nxt_set_flow_format(ofconn, oh);
4030
4031     case OFPTYPE_SET_PACKET_IN_FORMAT:
4032         return handle_nxt_set_packet_in_format(ofconn, oh);
4033
4034     case OFPTYPE_SET_CONTROLLER_ID:
4035         return handle_nxt_set_controller_id(ofconn, oh);
4036
4037     case OFPTYPE_FLOW_AGE:
4038         /* Nothing to do. */
4039         return 0;
4040
4041     case OFPTYPE_FLOW_MONITOR_CANCEL:
4042         return handle_flow_monitor_cancel(ofconn, oh);
4043
4044     case OFPTYPE_SET_ASYNC_CONFIG:
4045         return handle_nxt_set_async_config(ofconn, oh);
4046
4047         /* Statistics requests. */
4048     case OFPTYPE_DESC_STATS_REQUEST:
4049         return handle_desc_stats_request(ofconn, oh);
4050
4051     case OFPTYPE_FLOW_STATS_REQUEST:
4052         return handle_flow_stats_request(ofconn, oh);
4053
4054     case OFPTYPE_AGGREGATE_STATS_REQUEST:
4055         return handle_aggregate_stats_request(ofconn, oh);
4056
4057     case OFPTYPE_TABLE_STATS_REQUEST:
4058         return handle_table_stats_request(ofconn, oh);
4059
4060     case OFPTYPE_PORT_STATS_REQUEST:
4061         return handle_port_stats_request(ofconn, oh);
4062
4063     case OFPTYPE_QUEUE_STATS_REQUEST:
4064         return handle_queue_stats_request(ofconn, oh);
4065
4066     case OFPTYPE_PORT_DESC_STATS_REQUEST:
4067         return handle_port_desc_stats_request(ofconn, oh);
4068
4069     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
4070         return handle_flow_monitor_request(ofconn, oh);
4071
4072     case OFPTYPE_HELLO:
4073     case OFPTYPE_ERROR:
4074     case OFPTYPE_FEATURES_REPLY:
4075     case OFPTYPE_GET_CONFIG_REPLY:
4076     case OFPTYPE_PACKET_IN:
4077     case OFPTYPE_FLOW_REMOVED:
4078     case OFPTYPE_PORT_STATUS:
4079     case OFPTYPE_BARRIER_REPLY:
4080     case OFPTYPE_DESC_STATS_REPLY:
4081     case OFPTYPE_FLOW_STATS_REPLY:
4082     case OFPTYPE_QUEUE_STATS_REPLY:
4083     case OFPTYPE_PORT_STATS_REPLY:
4084     case OFPTYPE_TABLE_STATS_REPLY:
4085     case OFPTYPE_AGGREGATE_STATS_REPLY:
4086     case OFPTYPE_PORT_DESC_STATS_REPLY:
4087     case OFPTYPE_ROLE_REPLY:
4088     case OFPTYPE_FLOW_MONITOR_PAUSED:
4089     case OFPTYPE_FLOW_MONITOR_RESUMED:
4090     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
4091     default:
4092         return OFPERR_OFPBRC_BAD_TYPE;
4093     }
4094 }
4095
4096 static bool
4097 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
4098 {
4099     int error = handle_openflow__(ofconn, ofp_msg);
4100     if (error && error != OFPROTO_POSTPONE) {
4101         ofconn_send_error(ofconn, ofp_msg->data, error);
4102     }
4103     COVERAGE_INC(ofproto_recv_openflow);
4104     return error != OFPROTO_POSTPONE;
4105 }
4106 \f
4107 /* Asynchronous operations. */
4108
4109 /* Creates and returns a new ofopgroup that is not associated with any
4110  * OpenFlow connection.
4111  *
4112  * The caller should add operations to the returned group with
4113  * ofoperation_create() and then submit it with ofopgroup_submit(). */
4114 static struct ofopgroup *
4115 ofopgroup_create_unattached(struct ofproto *ofproto)
4116 {
4117     struct ofopgroup *group = xzalloc(sizeof *group);
4118     group->ofproto = ofproto;
4119     list_init(&group->ofproto_node);
4120     list_init(&group->ops);
4121     list_init(&group->ofconn_node);
4122     return group;
4123 }
4124
4125 /* Creates and returns a new ofopgroup for 'ofproto'.
4126  *
4127  * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
4128  * connection.  The 'request' and 'buffer_id' arguments are ignored.
4129  *
4130  * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
4131  * If the ofopgroup eventually fails, then the error reply will include
4132  * 'request'.  If the ofopgroup eventually succeeds, then the packet with
4133  * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
4134  *
4135  * The caller should add operations to the returned group with
4136  * ofoperation_create() and then submit it with ofopgroup_submit(). */
4137 static struct ofopgroup *
4138 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
4139                  const struct ofp_header *request, uint32_t buffer_id)
4140 {
4141     struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
4142     if (ofconn) {
4143         size_t request_len = ntohs(request->length);
4144
4145         assert(ofconn_get_ofproto(ofconn) == ofproto);
4146
4147         ofconn_add_opgroup(ofconn, &group->ofconn_node);
4148         group->ofconn = ofconn;
4149         group->request = xmemdup(request, MIN(request_len, 64));
4150         group->buffer_id = buffer_id;
4151     }
4152     return group;
4153 }
4154
4155 /* Submits 'group' for processing.
4156  *
4157  * If 'group' contains no operations (e.g. none were ever added, or all of the
4158  * ones that were added completed synchronously), then it is destroyed
4159  * immediately.  Otherwise it is added to the ofproto's list of pending
4160  * groups. */
4161 static void
4162 ofopgroup_submit(struct ofopgroup *group)
4163 {
4164     if (!group->n_running) {
4165         ofopgroup_complete(group);
4166     } else {
4167         list_push_back(&group->ofproto->pending, &group->ofproto_node);
4168         group->ofproto->n_pending++;
4169     }
4170 }
4171
4172 static void
4173 ofopgroup_complete(struct ofopgroup *group)
4174 {
4175     struct ofproto *ofproto = group->ofproto;
4176
4177     struct ofconn *abbrev_ofconn;
4178     ovs_be32 abbrev_xid;
4179
4180     struct ofoperation *op, *next_op;
4181     int error;
4182
4183     assert(!group->n_running);
4184
4185     error = 0;
4186     LIST_FOR_EACH (op, group_node, &group->ops) {
4187         if (op->error) {
4188             error = op->error;
4189             break;
4190         }
4191     }
4192
4193     if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
4194         LIST_FOR_EACH (op, group_node, &group->ops) {
4195             if (op->type != OFOPERATION_DELETE) {
4196                 struct ofpbuf *packet;
4197                 uint16_t in_port;
4198
4199                 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
4200                                                &packet, &in_port);
4201                 if (packet) {
4202                     assert(!error);
4203                     error = rule_execute(op->rule, in_port, packet);
4204                 }
4205                 break;
4206             }
4207         }
4208     }
4209
4210     if (!error && !list_is_empty(&group->ofconn_node)) {
4211         abbrev_ofconn = group->ofconn;
4212         abbrev_xid = group->request->xid;
4213     } else {
4214         abbrev_ofconn = NULL;
4215         abbrev_xid = htonl(0);
4216     }
4217     LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
4218         struct rule *rule = op->rule;
4219
4220         if (!op->error && !ofproto_rule_is_hidden(rule)) {
4221             /* Check that we can just cast from ofoperation_type to
4222              * nx_flow_update_event. */
4223             BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_ADD
4224                               == NXFME_ADDED);
4225             BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_DELETE
4226                               == NXFME_DELETED);
4227             BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_MODIFY
4228                               == NXFME_MODIFIED);
4229
4230             ofmonitor_report(ofproto->connmgr, rule,
4231                              (enum nx_flow_update_event) op->type,
4232                              op->reason, abbrev_ofconn, abbrev_xid);
4233         }
4234
4235         rule->pending = NULL;
4236
4237         switch (op->type) {
4238         case OFOPERATION_ADD:
4239             if (!op->error) {
4240                 uint16_t vid_mask;
4241
4242                 ofproto_rule_destroy__(op->victim);
4243                 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
4244                 if (vid_mask == VLAN_VID_MASK) {
4245                     if (ofproto->vlan_bitmap) {
4246                         uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4247                         if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4248                             bitmap_set1(ofproto->vlan_bitmap, vid);
4249                             ofproto->vlans_changed = true;
4250                         }
4251                     } else {
4252                         ofproto->vlans_changed = true;
4253                     }
4254                 }
4255             } else {
4256                 oftable_substitute_rule(rule, op->victim);
4257                 ofproto_rule_destroy__(rule);
4258             }
4259             break;
4260
4261         case OFOPERATION_DELETE:
4262             assert(!op->error);
4263             ofproto_rule_destroy__(rule);
4264             op->rule = NULL;
4265             break;
4266
4267         case OFOPERATION_MODIFY:
4268             if (!op->error) {
4269                 rule->modified = time_msec();
4270             } else {
4271                 rule->flow_cookie = op->flow_cookie;
4272                 if (op->ofpacts) {
4273                     free(rule->ofpacts);
4274                     rule->ofpacts = op->ofpacts;
4275                     rule->ofpacts_len = op->ofpacts_len;
4276                     op->ofpacts = NULL;
4277                     op->ofpacts_len = 0;
4278                 }
4279             }
4280             break;
4281
4282         default:
4283             NOT_REACHED();
4284         }
4285
4286         ofoperation_destroy(op);
4287     }
4288
4289     ofmonitor_flush(ofproto->connmgr);
4290
4291     if (!list_is_empty(&group->ofproto_node)) {
4292         assert(ofproto->n_pending > 0);
4293         ofproto->n_pending--;
4294         list_remove(&group->ofproto_node);
4295     }
4296     if (!list_is_empty(&group->ofconn_node)) {
4297         list_remove(&group->ofconn_node);
4298         if (error) {
4299             ofconn_send_error(group->ofconn, group->request, error);
4300         }
4301         connmgr_retry(ofproto->connmgr);
4302     }
4303     free(group->request);
4304     free(group);
4305 }
4306
4307 /* Initiates a new operation on 'rule', of the specified 'type', within
4308  * 'group'.  Prior to calling, 'rule' must not have any pending operation.
4309  *
4310  * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4311  * the flow is being deleted.  For other 'type's, 'reason' is ignored (use 0).
4312  *
4313  * Returns the newly created ofoperation (which is also available as
4314  * rule->pending). */
4315 static struct ofoperation *
4316 ofoperation_create(struct ofopgroup *group, struct rule *rule,
4317                    enum ofoperation_type type,
4318                    enum ofp_flow_removed_reason reason)
4319 {
4320     struct ofproto *ofproto = group->ofproto;
4321     struct ofoperation *op;
4322
4323     assert(!rule->pending);
4324
4325     op = rule->pending = xzalloc(sizeof *op);
4326     op->group = group;
4327     list_push_back(&group->ops, &op->group_node);
4328     op->rule = rule;
4329     op->type = type;
4330     op->reason = reason;
4331     op->flow_cookie = rule->flow_cookie;
4332
4333     group->n_running++;
4334
4335     if (type == OFOPERATION_DELETE) {
4336         hmap_insert(&ofproto->deletions, &op->hmap_node,
4337                     cls_rule_hash(&rule->cr, rule->table_id));
4338     }
4339
4340     return op;
4341 }
4342
4343 static void
4344 ofoperation_destroy(struct ofoperation *op)
4345 {
4346     struct ofopgroup *group = op->group;
4347
4348     if (op->rule) {
4349         op->rule->pending = NULL;
4350     }
4351     if (op->type == OFOPERATION_DELETE) {
4352         hmap_remove(&group->ofproto->deletions, &op->hmap_node);
4353     }
4354     list_remove(&op->group_node);
4355     free(op->ofpacts);
4356     free(op);
4357 }
4358
4359 /* Indicates that 'op' completed with status 'error', which is either 0 to
4360  * indicate success or an OpenFlow error code on failure.
4361  *
4362  * If 'error' is 0, indicating success, the operation will be committed
4363  * permanently to the flow table.  There is one interesting subcase:
4364  *
4365  *   - If 'op' is an "add flow" operation that is replacing an existing rule in
4366  *     the flow table (the "victim" rule) by a new one, then the caller must
4367  *     have uninitialized any derived state in the victim rule, as in step 5 in
4368  *     the "Life Cycle" in ofproto/ofproto-provider.h.  ofoperation_complete()
4369  *     performs steps 6 and 7 for the victim rule, most notably by calling its
4370  *     ->rule_dealloc() function.
4371  *
4372  * If 'error' is nonzero, then generally the operation will be rolled back:
4373  *
4374  *   - If 'op' is an "add flow" operation, ofproto removes the new rule or
4375  *     restores the original rule.  The caller must have uninitialized any
4376  *     derived state in the new rule, as in step 5 of in the "Life Cycle" in
4377  *     ofproto/ofproto-provider.h.  ofoperation_complete() performs steps 6 and
4378  *     and 7 for the new rule, calling its ->rule_dealloc() function.
4379  *
4380  *   - If 'op' is a "modify flow" operation, ofproto restores the original
4381  *     actions.
4382  *
4383  *   - 'op' must not be a "delete flow" operation.  Removing a rule is not
4384  *     allowed to fail.  It must always succeed.
4385  *
4386  * Please see the large comment in ofproto/ofproto-provider.h titled
4387  * "Asynchronous Operation Support" for more information. */
4388 void
4389 ofoperation_complete(struct ofoperation *op, enum ofperr error)
4390 {
4391     struct ofopgroup *group = op->group;
4392
4393     assert(op->rule->pending == op);
4394     assert(group->n_running > 0);
4395     assert(!error || op->type != OFOPERATION_DELETE);
4396
4397     op->error = error;
4398     if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
4399         ofopgroup_complete(group);
4400     }
4401 }
4402
4403 struct rule *
4404 ofoperation_get_victim(struct ofoperation *op)
4405 {
4406     assert(op->type == OFOPERATION_ADD);
4407     return op->victim;
4408 }
4409 \f
4410 static uint64_t
4411 pick_datapath_id(const struct ofproto *ofproto)
4412 {
4413     const struct ofport *port;
4414
4415     port = ofproto_get_port(ofproto, OFPP_LOCAL);
4416     if (port) {
4417         uint8_t ea[ETH_ADDR_LEN];
4418         int error;
4419
4420         error = netdev_get_etheraddr(port->netdev, ea);
4421         if (!error) {
4422             return eth_addr_to_uint64(ea);
4423         }
4424         VLOG_WARN("%s: could not get MAC address for %s (%s)",
4425                   ofproto->name, netdev_get_name(port->netdev),
4426                   strerror(error));
4427     }
4428     return ofproto->fallback_dpid;
4429 }
4430
4431 static uint64_t
4432 pick_fallback_dpid(void)
4433 {
4434     uint8_t ea[ETH_ADDR_LEN];
4435     eth_addr_nicira_random(ea);
4436     return eth_addr_to_uint64(ea);
4437 }
4438 \f
4439 /* Table overflow policy. */
4440
4441 /* Chooses and returns a rule to evict from 'table'.  Returns NULL if the table
4442  * is not configured to evict rules or if the table contains no evictable
4443  * rules.  (Rules with 'evictable' set to false or with no timeouts are not
4444  * evictable.) */
4445 static struct rule *
4446 choose_rule_to_evict(struct oftable *table)
4447 {
4448     struct eviction_group *evg;
4449
4450     if (!table->eviction_fields) {
4451         return NULL;
4452     }
4453
4454     /* In the common case, the outer and inner loops here will each be entered
4455      * exactly once:
4456      *
4457      *   - The inner loop normally "return"s in its first iteration.  If the
4458      *     eviction group has any evictable rules, then it always returns in
4459      *     some iteration.
4460      *
4461      *   - The outer loop only iterates more than once if the largest eviction
4462      *     group has no evictable rules.
4463      *
4464      *   - The outer loop can exit only if table's 'max_flows' is all filled up
4465      *     by unevictable rules'. */
4466     HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
4467         struct rule *rule;
4468
4469         HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
4470             if (rule->evictable) {
4471                 return rule;
4472             }
4473         }
4474     }
4475
4476     return NULL;
4477 }
4478
4479 /* Searches 'ofproto' for tables that have more flows than their configured
4480  * maximum and that have flow eviction enabled, and evicts as many flows as
4481  * necessary and currently feasible from them.
4482  *
4483  * This triggers only when an OpenFlow table has N flows in it and then the
4484  * client configures a maximum number of flows less than N. */
4485 static void
4486 ofproto_evict(struct ofproto *ofproto)
4487 {
4488     struct ofopgroup *group;
4489     struct oftable *table;
4490
4491     group = ofopgroup_create_unattached(ofproto);
4492     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
4493         while (classifier_count(&table->cls) > table->max_flows
4494                && table->eviction_fields) {
4495             struct rule *rule;
4496
4497             rule = choose_rule_to_evict(table);
4498             if (!rule || rule->pending) {
4499                 break;
4500             }
4501
4502             ofoperation_create(group, rule,
4503                                OFOPERATION_DELETE, OFPRR_EVICTION);
4504             oftable_remove_rule(rule);
4505             ofproto->ofproto_class->rule_destruct(rule);
4506         }
4507     }
4508     ofopgroup_submit(group);
4509 }
4510 \f
4511 /* Eviction groups. */
4512
4513 /* Returns the priority to use for an eviction_group that contains 'n_rules'
4514  * rules.  The priority contains low-order random bits to ensure that eviction
4515  * groups with the same number of rules are prioritized randomly. */
4516 static uint32_t
4517 eviction_group_priority(size_t n_rules)
4518 {
4519     uint16_t size = MIN(UINT16_MAX, n_rules);
4520     return (size << 16) | random_uint16();
4521 }
4522
4523 /* Updates 'evg', an eviction_group within 'table', following a change that
4524  * adds or removes rules in 'evg'. */
4525 static void
4526 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
4527 {
4528     heap_change(&table->eviction_groups_by_size, &evg->size_node,
4529                 eviction_group_priority(heap_count(&evg->rules)));
4530 }
4531
4532 /* Destroys 'evg', an eviction_group within 'table':
4533  *
4534  *   - Removes all the rules, if any, from 'evg'.  (It doesn't destroy the
4535  *     rules themselves, just removes them from the eviction group.)
4536  *
4537  *   - Removes 'evg' from 'table'.
4538  *
4539  *   - Frees 'evg'. */
4540 static void
4541 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
4542 {
4543     while (!heap_is_empty(&evg->rules)) {
4544         struct rule *rule;
4545
4546         rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
4547         rule->eviction_group = NULL;
4548     }
4549     hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
4550     heap_remove(&table->eviction_groups_by_size, &evg->size_node);
4551     heap_destroy(&evg->rules);
4552     free(evg);
4553 }
4554
4555 /* Removes 'rule' from its eviction group, if any. */
4556 static void
4557 eviction_group_remove_rule(struct rule *rule)
4558 {
4559     if (rule->eviction_group) {
4560         struct oftable *table = &rule->ofproto->tables[rule->table_id];
4561         struct eviction_group *evg = rule->eviction_group;
4562
4563         rule->eviction_group = NULL;
4564         heap_remove(&evg->rules, &rule->evg_node);
4565         if (heap_is_empty(&evg->rules)) {
4566             eviction_group_destroy(table, evg);
4567         } else {
4568             eviction_group_resized(table, evg);
4569         }
4570     }
4571 }
4572
4573 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
4574  * returns the hash value. */
4575 static uint32_t
4576 eviction_group_hash_rule(struct rule *rule)
4577 {
4578     struct oftable *table = &rule->ofproto->tables[rule->table_id];
4579     const struct mf_subfield *sf;
4580     struct flow flow;
4581     uint32_t hash;
4582
4583     hash = table->eviction_group_id_basis;
4584     miniflow_expand(&rule->cr.match.flow, &flow);
4585     for (sf = table->eviction_fields;
4586          sf < &table->eviction_fields[table->n_eviction_fields];
4587          sf++)
4588     {
4589         if (mf_are_prereqs_ok(sf->field, &flow)) {
4590             union mf_value value;
4591
4592             mf_get_value(sf->field, &flow, &value);
4593             if (sf->ofs) {
4594                 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
4595             }
4596             if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
4597                 unsigned int start = sf->ofs + sf->n_bits;
4598                 bitwise_zero(&value, sf->field->n_bytes, start,
4599                              sf->field->n_bytes * 8 - start);
4600             }
4601             hash = hash_bytes(&value, sf->field->n_bytes, hash);
4602         } else {
4603             hash = hash_int(hash, 0);
4604         }
4605     }
4606
4607     return hash;
4608 }
4609
4610 /* Returns an eviction group within 'table' with the given 'id', creating one
4611  * if necessary. */
4612 static struct eviction_group *
4613 eviction_group_find(struct oftable *table, uint32_t id)
4614 {
4615     struct eviction_group *evg;
4616
4617     HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
4618         return evg;
4619     }
4620
4621     evg = xmalloc(sizeof *evg);
4622     hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
4623     heap_insert(&table->eviction_groups_by_size, &evg->size_node,
4624                 eviction_group_priority(0));
4625     heap_init(&evg->rules);
4626
4627     return evg;
4628 }
4629
4630 /* Returns an eviction priority for 'rule'.  The return value should be
4631  * interpreted so that higher priorities make a rule more attractive candidates
4632  * for eviction. */
4633 static uint32_t
4634 rule_eviction_priority(struct rule *rule)
4635 {
4636     long long int hard_expiration;
4637     long long int idle_expiration;
4638     long long int expiration;
4639     uint32_t expiration_offset;
4640
4641     /* Calculate time of expiration. */
4642     hard_expiration = (rule->hard_timeout
4643                        ? rule->modified + rule->hard_timeout * 1000
4644                        : LLONG_MAX);
4645     idle_expiration = (rule->idle_timeout
4646                        ? rule->used + rule->idle_timeout * 1000
4647                        : LLONG_MAX);
4648     expiration = MIN(hard_expiration, idle_expiration);
4649     if (expiration == LLONG_MAX) {
4650         return 0;
4651     }
4652
4653     /* Calculate the time of expiration as a number of (approximate) seconds
4654      * after program startup.
4655      *
4656      * This should work OK for program runs that last UINT32_MAX seconds or
4657      * less.  Therefore, please restart OVS at least once every 136 years. */
4658     expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
4659
4660     /* Invert the expiration offset because we're using a max-heap. */
4661     return UINT32_MAX - expiration_offset;
4662 }
4663
4664 /* Adds 'rule' to an appropriate eviction group for its oftable's
4665  * configuration.  Does nothing if 'rule''s oftable doesn't have eviction
4666  * enabled, or if 'rule' is a permanent rule (one that will never expire on its
4667  * own).
4668  *
4669  * The caller must ensure that 'rule' is not already in an eviction group. */
4670 static void
4671 eviction_group_add_rule(struct rule *rule)
4672 {
4673     struct ofproto *ofproto = rule->ofproto;
4674     struct oftable *table = &ofproto->tables[rule->table_id];
4675
4676     if (table->eviction_fields
4677         && (rule->hard_timeout || rule->idle_timeout)) {
4678         struct eviction_group *evg;
4679
4680         evg = eviction_group_find(table, eviction_group_hash_rule(rule));
4681
4682         rule->eviction_group = evg;
4683         heap_insert(&evg->rules, &rule->evg_node,
4684                     rule_eviction_priority(rule));
4685         eviction_group_resized(table, evg);
4686     }
4687 }
4688 \f
4689 /* oftables. */
4690
4691 /* Initializes 'table'. */
4692 static void
4693 oftable_init(struct oftable *table)
4694 {
4695     memset(table, 0, sizeof *table);
4696     classifier_init(&table->cls);
4697     table->max_flows = UINT_MAX;
4698 }
4699
4700 /* Destroys 'table', including its classifier and eviction groups.
4701  *
4702  * The caller is responsible for freeing 'table' itself. */
4703 static void
4704 oftable_destroy(struct oftable *table)
4705 {
4706     assert(classifier_is_empty(&table->cls));
4707     oftable_disable_eviction(table);
4708     classifier_destroy(&table->cls);
4709     free(table->name);
4710 }
4711
4712 /* Changes the name of 'table' to 'name'.  If 'name' is NULL or the empty
4713  * string, then 'table' will use its default name.
4714  *
4715  * This only affects the name exposed for a table exposed through the OpenFlow
4716  * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
4717 static void
4718 oftable_set_name(struct oftable *table, const char *name)
4719 {
4720     if (name && name[0]) {
4721         int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
4722         if (!table->name || strncmp(name, table->name, len)) {
4723             free(table->name);
4724             table->name = xmemdup0(name, len);
4725         }
4726     } else {
4727         free(table->name);
4728         table->name = NULL;
4729     }
4730 }
4731
4732 /* oftables support a choice of two policies when adding a rule would cause the
4733  * number of flows in the table to exceed the configured maximum number: either
4734  * they can refuse to add the new flow or they can evict some existing flow.
4735  * This function configures the former policy on 'table'. */
4736 static void
4737 oftable_disable_eviction(struct oftable *table)
4738 {
4739     if (table->eviction_fields) {
4740         struct eviction_group *evg, *next;
4741
4742         HMAP_FOR_EACH_SAFE (evg, next, id_node,
4743                             &table->eviction_groups_by_id) {
4744             eviction_group_destroy(table, evg);
4745         }
4746         hmap_destroy(&table->eviction_groups_by_id);
4747         heap_destroy(&table->eviction_groups_by_size);
4748
4749         free(table->eviction_fields);
4750         table->eviction_fields = NULL;
4751         table->n_eviction_fields = 0;
4752     }
4753 }
4754
4755 /* oftables support a choice of two policies when adding a rule would cause the
4756  * number of flows in the table to exceed the configured maximum number: either
4757  * they can refuse to add the new flow or they can evict some existing flow.
4758  * This function configures the latter policy on 'table', with fairness based
4759  * on the values of the 'n_fields' fields specified in 'fields'.  (Specifying
4760  * 'n_fields' as 0 disables fairness.) */
4761 static void
4762 oftable_enable_eviction(struct oftable *table,
4763                         const struct mf_subfield *fields, size_t n_fields)
4764 {
4765     struct cls_cursor cursor;
4766     struct rule *rule;
4767
4768     if (table->eviction_fields
4769         && n_fields == table->n_eviction_fields
4770         && (!n_fields
4771             || !memcmp(fields, table->eviction_fields,
4772                        n_fields * sizeof *fields))) {
4773         /* No change. */
4774         return;
4775     }
4776
4777     oftable_disable_eviction(table);
4778
4779     table->n_eviction_fields = n_fields;
4780     table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
4781
4782     table->eviction_group_id_basis = random_uint32();
4783     hmap_init(&table->eviction_groups_by_id);
4784     heap_init(&table->eviction_groups_by_size);
4785
4786     cls_cursor_init(&cursor, &table->cls, NULL);
4787     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4788         eviction_group_add_rule(rule);
4789     }
4790 }
4791
4792 /* Removes 'rule' from the oftable that contains it. */
4793 static void
4794 oftable_remove_rule(struct rule *rule)
4795 {
4796     struct ofproto *ofproto = rule->ofproto;
4797     struct oftable *table = &ofproto->tables[rule->table_id];
4798
4799     classifier_remove(&table->cls, &rule->cr);
4800     eviction_group_remove_rule(rule);
4801 }
4802
4803 /* Inserts 'rule' into its oftable.  Removes any existing rule from 'rule''s
4804  * oftable that has an identical cls_rule.  Returns the rule that was removed,
4805  * if any, and otherwise NULL. */
4806 static struct rule *
4807 oftable_replace_rule(struct rule *rule)
4808 {
4809     struct ofproto *ofproto = rule->ofproto;
4810     struct oftable *table = &ofproto->tables[rule->table_id];
4811     struct rule *victim;
4812
4813     victim = rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
4814     if (victim) {
4815         eviction_group_remove_rule(victim);
4816     }
4817     eviction_group_add_rule(rule);
4818     return victim;
4819 }
4820
4821 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
4822 static void
4823 oftable_substitute_rule(struct rule *old, struct rule *new)
4824 {
4825     if (new) {
4826         oftable_replace_rule(new);
4827     } else {
4828         oftable_remove_rule(old);
4829     }
4830 }
4831 \f
4832 /* unixctl commands. */
4833
4834 struct ofproto *
4835 ofproto_lookup(const char *name)
4836 {
4837     struct ofproto *ofproto;
4838
4839     HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
4840                              &all_ofprotos) {
4841         if (!strcmp(ofproto->name, name)) {
4842             return ofproto;
4843         }
4844     }
4845     return NULL;
4846 }
4847
4848 static void
4849 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
4850                      const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
4851 {
4852     struct ofproto *ofproto;
4853     struct ds results;
4854
4855     ds_init(&results);
4856     HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
4857         ds_put_format(&results, "%s\n", ofproto->name);
4858     }
4859     unixctl_command_reply(conn, ds_cstr(&results));
4860     ds_destroy(&results);
4861 }
4862
4863 static void
4864 ofproto_unixctl_init(void)
4865 {
4866     static bool registered;
4867     if (registered) {
4868         return;
4869     }
4870     registered = true;
4871
4872     unixctl_command_register("ofproto/list", "", 0, 0,
4873                              ofproto_unixctl_list, NULL);
4874 }
4875 \f
4876 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
4877  *
4878  * This is deprecated.  It is only for compatibility with broken device drivers
4879  * in old versions of Linux that do not properly support VLANs when VLAN
4880  * devices are not used.  When broken device drivers are no longer in
4881  * widespread use, we will delete these interfaces. */
4882
4883 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
4884  * (exactly) by an OpenFlow rule in 'ofproto'. */
4885 void
4886 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
4887 {
4888     const struct oftable *oftable;
4889
4890     free(ofproto->vlan_bitmap);
4891     ofproto->vlan_bitmap = bitmap_allocate(4096);
4892     ofproto->vlans_changed = false;
4893
4894     OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
4895         const struct cls_table *table;
4896
4897         HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
4898             if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
4899                 const struct cls_rule *rule;
4900
4901                 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
4902                     uint16_t vid = miniflow_get_vid(&rule->match.flow);
4903                     bitmap_set1(vlan_bitmap, vid);
4904                     bitmap_set1(ofproto->vlan_bitmap, vid);
4905                 }
4906             }
4907         }
4908     }
4909 }
4910
4911 /* Returns true if new VLANs have come into use by the flow table since the
4912  * last call to ofproto_get_vlan_usage().
4913  *
4914  * We don't track when old VLANs stop being used. */
4915 bool
4916 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
4917 {
4918     return ofproto->vlans_changed;
4919 }
4920
4921 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
4922  * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'.  If
4923  * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
4924  * device as a VLAN splinter for VLAN ID 'vid'.  If 'realdev_ofp_port' is zero,
4925  * then the VLAN device is un-enslaved. */
4926 int
4927 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
4928                          uint16_t realdev_ofp_port, int vid)
4929 {
4930     struct ofport *ofport;
4931     int error;
4932
4933     assert(vlandev_ofp_port != realdev_ofp_port);
4934
4935     ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
4936     if (!ofport) {
4937         VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
4938                   ofproto->name, vlandev_ofp_port);
4939         return EINVAL;
4940     }
4941
4942     if (!ofproto->ofproto_class->set_realdev) {
4943         if (!vlandev_ofp_port) {
4944             return 0;
4945         }
4946         VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
4947         return EOPNOTSUPP;
4948     }
4949
4950     error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
4951     if (error) {
4952         VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
4953                   ofproto->name, vlandev_ofp_port,
4954                   netdev_get_name(ofport->netdev), strerror(error));
4955     }
4956     return error;
4957 }