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