ddf51f8b3259a9c6f98a7a39e7d143dd89b8cf6b
[sliver-openvswitch.git] / ofproto / ofproto.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3  * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #include <config.h>
19 #include "ofproto.h"
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <stdbool.h>
23 #include <stdlib.h>
24 #include "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     ovs_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         ovs_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     ovs_assert(!ofproto->n_tables);
473     ovs_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     ovs_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     ovs_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     ovs_assert(list_is_empty(&ofproto->pending));
996     ovs_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     uint16_t end_port_no = ofproto->alloc_port_no;
1617
1618     ofp_port = simap_get(&ofproto->ofp_requests, netdev_name);
1619     ofp_port = ofp_port ? ofp_port : OFPP_NONE;
1620
1621     if (ofp_port >= ofproto->max_ports
1622             || bitmap_is_set(ofproto->ofp_port_ids, ofp_port)) {
1623         /* Search for a free OpenFlow port number.  We try not to
1624          * immediately reuse them to prevent problems due to old
1625          * flows. */
1626         for (;;) {
1627             if (++ofproto->alloc_port_no >= ofproto->max_ports) {
1628                 ofproto->alloc_port_no = 0;
1629             }
1630             if (!bitmap_is_set(ofproto->ofp_port_ids,
1631                                ofproto->alloc_port_no)) {
1632                 ofp_port = ofproto->alloc_port_no;
1633                 break;
1634             }
1635             if (ofproto->alloc_port_no == end_port_no) {
1636                 return OFPP_NONE;
1637             }
1638         }
1639     }
1640     bitmap_set1(ofproto->ofp_port_ids, ofp_port);
1641     return ofp_port;
1642 }
1643
1644 static void
1645 dealloc_ofp_port(const struct ofproto *ofproto, uint16_t ofp_port)
1646 {
1647     bitmap_set0(ofproto->ofp_port_ids, ofp_port);
1648 }
1649
1650 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1651  * pointer if the netdev cannot be opened.  On success, also fills in
1652  * 'opp'.  */
1653 static struct netdev *
1654 ofport_open(struct ofproto *ofproto,
1655             struct ofproto_port *ofproto_port,
1656             struct ofputil_phy_port *pp)
1657 {
1658     enum netdev_flags flags;
1659     struct netdev *netdev;
1660     int error;
1661
1662     error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1663     if (error) {
1664         VLOG_WARN_RL(&rl, "%s: ignoring port %s (%"PRIu16") because netdev %s "
1665                      "cannot be opened (%s)",
1666                      ofproto->name,
1667                      ofproto_port->name, ofproto_port->ofp_port,
1668                      ofproto_port->name, strerror(error));
1669         return NULL;
1670     }
1671
1672     if (ofproto_port->ofp_port == OFPP_NONE) {
1673         if (!strcmp(ofproto->name, ofproto_port->name)) {
1674             ofproto_port->ofp_port = OFPP_LOCAL;
1675         } else {
1676             ofproto_port->ofp_port = alloc_ofp_port(ofproto,
1677                                                     ofproto_port->name);
1678         }
1679     }
1680     pp->port_no = ofproto_port->ofp_port;
1681     netdev_get_etheraddr(netdev, pp->hw_addr);
1682     ovs_strlcpy(pp->name, ofproto_port->name, sizeof pp->name);
1683     netdev_get_flags(netdev, &flags);
1684     pp->config = flags & NETDEV_UP ? 0 : OFPUTIL_PC_PORT_DOWN;
1685     pp->state = netdev_get_carrier(netdev) ? 0 : OFPUTIL_PS_LINK_DOWN;
1686     netdev_get_features(netdev, &pp->curr, &pp->advertised,
1687                         &pp->supported, &pp->peer);
1688     pp->curr_speed = netdev_features_to_bps(pp->curr, 0);
1689     pp->max_speed = netdev_features_to_bps(pp->supported, 0);
1690
1691     return netdev;
1692 }
1693
1694 /* Returns true if most fields of 'a' and 'b' are equal.  Differences in name,
1695  * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1696  * disregarded. */
1697 static bool
1698 ofport_equal(const struct ofputil_phy_port *a,
1699              const struct ofputil_phy_port *b)
1700 {
1701     return (eth_addr_equals(a->hw_addr, b->hw_addr)
1702             && a->state == b->state
1703             && !((a->config ^ b->config) & OFPUTIL_PC_PORT_DOWN)
1704             && a->curr == b->curr
1705             && a->advertised == b->advertised
1706             && a->supported == b->supported
1707             && a->peer == b->peer
1708             && a->curr_speed == b->curr_speed
1709             && a->max_speed == b->max_speed);
1710 }
1711
1712 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1713  * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1714  * one with the same name or port number). */
1715 static void
1716 ofport_install(struct ofproto *p,
1717                struct netdev *netdev, const struct ofputil_phy_port *pp)
1718 {
1719     const char *netdev_name = netdev_get_name(netdev);
1720     struct ofport *ofport;
1721     int error;
1722
1723     /* Create ofport. */
1724     ofport = p->ofproto_class->port_alloc();
1725     if (!ofport) {
1726         error = ENOMEM;
1727         goto error;
1728     }
1729     ofport->ofproto = p;
1730     ofport->netdev = netdev;
1731     ofport->change_seq = netdev_change_seq(netdev);
1732     ofport->pp = *pp;
1733     ofport->ofp_port = pp->port_no;
1734
1735     /* Add port to 'p'. */
1736     hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1737     shash_add(&p->port_by_name, netdev_name, ofport);
1738
1739     update_mtu(p, ofport);
1740
1741     /* Let the ofproto_class initialize its private data. */
1742     error = p->ofproto_class->port_construct(ofport);
1743     if (error) {
1744         goto error;
1745     }
1746     connmgr_send_port_status(p->connmgr, pp, OFPPR_ADD);
1747     return;
1748
1749 error:
1750     VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1751                  p->name, netdev_name, strerror(error));
1752     if (ofport) {
1753         ofport_destroy__(ofport);
1754     } else {
1755         netdev_close(netdev);
1756     }
1757 }
1758
1759 /* Removes 'ofport' from 'p' and destroys it. */
1760 static void
1761 ofport_remove(struct ofport *ofport)
1762 {
1763     connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->pp,
1764                              OFPPR_DELETE);
1765     ofport_destroy(ofport);
1766 }
1767
1768 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1769  * destroys it. */
1770 static void
1771 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1772 {
1773     struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1774     if (port) {
1775         ofport_remove(port);
1776     }
1777 }
1778
1779 /* Updates 'port' with new 'pp' description.
1780  *
1781  * Does not handle a name or port number change.  The caller must implement
1782  * such a change as a delete followed by an add.  */
1783 static void
1784 ofport_modified(struct ofport *port, struct ofputil_phy_port *pp)
1785 {
1786     memcpy(port->pp.hw_addr, pp->hw_addr, ETH_ADDR_LEN);
1787     port->pp.config = ((port->pp.config & ~OFPUTIL_PC_PORT_DOWN)
1788                         | (pp->config & OFPUTIL_PC_PORT_DOWN));
1789     port->pp.state = pp->state;
1790     port->pp.curr = pp->curr;
1791     port->pp.advertised = pp->advertised;
1792     port->pp.supported = pp->supported;
1793     port->pp.peer = pp->peer;
1794     port->pp.curr_speed = pp->curr_speed;
1795     port->pp.max_speed = pp->max_speed;
1796
1797     connmgr_send_port_status(port->ofproto->connmgr, &port->pp, OFPPR_MODIFY);
1798 }
1799
1800 /* Update OpenFlow 'state' in 'port' and notify controller. */
1801 void
1802 ofproto_port_set_state(struct ofport *port, enum ofputil_port_state state)
1803 {
1804     if (port->pp.state != state) {
1805         port->pp.state = state;
1806         connmgr_send_port_status(port->ofproto->connmgr, &port->pp,
1807                                  OFPPR_MODIFY);
1808     }
1809 }
1810
1811 void
1812 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1813 {
1814     struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1815     if (port) {
1816         if (port->ofproto->ofproto_class->set_realdev) {
1817             port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1818         }
1819         if (port->ofproto->ofproto_class->set_stp_port) {
1820             port->ofproto->ofproto_class->set_stp_port(port, NULL);
1821         }
1822         if (port->ofproto->ofproto_class->set_cfm) {
1823             port->ofproto->ofproto_class->set_cfm(port, NULL);
1824         }
1825         if (port->ofproto->ofproto_class->bundle_remove) {
1826             port->ofproto->ofproto_class->bundle_remove(port);
1827         }
1828     }
1829 }
1830
1831 static void
1832 ofport_destroy__(struct ofport *port)
1833 {
1834     struct ofproto *ofproto = port->ofproto;
1835     const char *name = netdev_get_name(port->netdev);
1836
1837     hmap_remove(&ofproto->ports, &port->hmap_node);
1838     shash_delete(&ofproto->port_by_name,
1839                  shash_find(&ofproto->port_by_name, name));
1840
1841     netdev_close(port->netdev);
1842     ofproto->ofproto_class->port_dealloc(port);
1843 }
1844
1845 static void
1846 ofport_destroy(struct ofport *port)
1847 {
1848     if (port) {
1849         dealloc_ofp_port(port->ofproto, port->ofp_port);
1850         port->ofproto->ofproto_class->port_destruct(port);
1851         ofport_destroy__(port);
1852      }
1853 }
1854
1855 struct ofport *
1856 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1857 {
1858     struct ofport *port;
1859
1860     HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1861                              hash_int(ofp_port, 0), &ofproto->ports) {
1862         if (port->ofp_port == ofp_port) {
1863             return port;
1864         }
1865     }
1866     return NULL;
1867 }
1868
1869 int
1870 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1871 {
1872     struct ofproto *ofproto = port->ofproto;
1873     int error;
1874
1875     if (ofproto->ofproto_class->port_get_stats) {
1876         error = ofproto->ofproto_class->port_get_stats(port, stats);
1877     } else {
1878         error = EOPNOTSUPP;
1879     }
1880
1881     return error;
1882 }
1883
1884 static void
1885 update_port(struct ofproto *ofproto, const char *name)
1886 {
1887     struct ofproto_port ofproto_port;
1888     struct ofputil_phy_port pp;
1889     struct netdev *netdev;
1890     struct ofport *port;
1891
1892     COVERAGE_INC(ofproto_update_port);
1893
1894     /* Fetch 'name''s location and properties from the datapath. */
1895     netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1896               ? ofport_open(ofproto, &ofproto_port, &pp)
1897               : NULL);
1898     if (netdev) {
1899         port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1900         if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1901             struct netdev *old_netdev = port->netdev;
1902
1903             /* 'name' hasn't changed location.  Any properties changed? */
1904             if (!ofport_equal(&port->pp, &pp)) {
1905                 ofport_modified(port, &pp);
1906             }
1907
1908             update_mtu(ofproto, port);
1909
1910             /* Install the newly opened netdev in case it has changed.
1911              * Don't close the old netdev yet in case port_modified has to
1912              * remove a retained reference to it.*/
1913             port->netdev = netdev;
1914             port->change_seq = netdev_change_seq(netdev);
1915
1916             if (port->ofproto->ofproto_class->port_modified) {
1917                 port->ofproto->ofproto_class->port_modified(port);
1918             }
1919
1920             netdev_close(old_netdev);
1921         } else {
1922             /* If 'port' is nonnull then its name differs from 'name' and thus
1923              * we should delete it.  If we think there's a port named 'name'
1924              * then its port number must be wrong now so delete it too. */
1925             if (port) {
1926                 ofport_remove(port);
1927             }
1928             ofport_remove_with_name(ofproto, name);
1929             ofport_install(ofproto, netdev, &pp);
1930         }
1931     } else {
1932         /* Any port named 'name' is gone now. */
1933         ofport_remove_with_name(ofproto, name);
1934     }
1935     ofproto_port_destroy(&ofproto_port);
1936 }
1937
1938 static int
1939 init_ports(struct ofproto *p)
1940 {
1941     struct ofproto_port_dump dump;
1942     struct ofproto_port ofproto_port;
1943     struct shash_node *node, *next;
1944
1945     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1946         const char *name = ofproto_port.name;
1947
1948         if (shash_find(&p->port_by_name, name)) {
1949             VLOG_WARN_RL(&rl, "%s: ignoring duplicate device %s in datapath",
1950                          p->name, name);
1951         } else {
1952             struct ofputil_phy_port pp;
1953             struct netdev *netdev;
1954
1955             /* Check if an OpenFlow port number had been requested. */
1956             node = shash_find(&init_ofp_ports, name);
1957             if (node) {
1958                 const struct iface_hint *iface_hint = node->data;
1959                 simap_put(&p->ofp_requests, name, iface_hint->ofp_port);
1960             }
1961
1962             netdev = ofport_open(p, &ofproto_port, &pp);
1963             if (netdev) {
1964                 ofport_install(p, netdev, &pp);
1965             }
1966         }
1967     }
1968
1969     SHASH_FOR_EACH_SAFE(node, next, &init_ofp_ports) {
1970         struct iface_hint *iface_hint = node->data;
1971
1972         if (!strcmp(iface_hint->br_name, p->name)) {
1973             free(iface_hint->br_name);
1974             free(iface_hint->br_type);
1975             free(iface_hint);
1976             shash_delete(&init_ofp_ports, node);
1977         }
1978     }
1979
1980     return 0;
1981 }
1982
1983 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1984  * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1985 static int
1986 find_min_mtu(struct ofproto *p)
1987 {
1988     struct ofport *ofport;
1989     int mtu = 0;
1990
1991     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1992         struct netdev *netdev = ofport->netdev;
1993         int dev_mtu;
1994
1995         /* Skip any internal ports, since that's what we're trying to
1996          * set. */
1997         if (!strcmp(netdev_get_type(netdev), "internal")) {
1998             continue;
1999         }
2000
2001         if (netdev_get_mtu(netdev, &dev_mtu)) {
2002             continue;
2003         }
2004         if (!mtu || dev_mtu < mtu) {
2005             mtu = dev_mtu;
2006         }
2007     }
2008
2009     return mtu ? mtu: ETH_PAYLOAD_MAX;
2010 }
2011
2012 /* Update MTU of all datapath devices on 'p' to the minimum of the
2013  * non-datapath ports in event of 'port' added or changed. */
2014 static void
2015 update_mtu(struct ofproto *p, struct ofport *port)
2016 {
2017     struct ofport *ofport;
2018     struct netdev *netdev = port->netdev;
2019     int dev_mtu, old_min;
2020
2021     if (netdev_get_mtu(netdev, &dev_mtu)) {
2022         port->mtu = 0;
2023         return;
2024     }
2025     if (!strcmp(netdev_get_type(port->netdev), "internal")) {
2026         if (dev_mtu > p->min_mtu) {
2027            if (!netdev_set_mtu(port->netdev, p->min_mtu)) {
2028                dev_mtu = p->min_mtu;
2029            }
2030         }
2031         port->mtu = dev_mtu;
2032         return;
2033     }
2034
2035     /* For non-internal port find new min mtu. */
2036     old_min = p->min_mtu;
2037     port->mtu = dev_mtu;
2038     p->min_mtu = find_min_mtu(p);
2039     if (p->min_mtu == old_min) {
2040         return;
2041     }
2042
2043     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
2044         struct netdev *netdev = ofport->netdev;
2045
2046         if (!strcmp(netdev_get_type(netdev), "internal")) {
2047             if (!netdev_set_mtu(netdev, p->min_mtu)) {
2048                 ofport->mtu = p->min_mtu;
2049             }
2050         }
2051     }
2052 }
2053 \f
2054 static void
2055 ofproto_rule_destroy__(struct rule *rule)
2056 {
2057     if (rule) {
2058         cls_rule_destroy(&rule->cr);
2059         free(rule->ofpacts);
2060         rule->ofproto->ofproto_class->rule_dealloc(rule);
2061     }
2062 }
2063
2064 /* This function allows an ofproto implementation to destroy any rules that
2065  * remain when its ->destruct() function is called.  The caller must have
2066  * already uninitialized any derived members of 'rule' (step 5 described in the
2067  * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
2068  * This function implements steps 6 and 7.
2069  *
2070  * This function should only be called from an ofproto implementation's
2071  * ->destruct() function.  It is not suitable elsewhere. */
2072 void
2073 ofproto_rule_destroy(struct rule *rule)
2074 {
2075     ovs_assert(!rule->pending);
2076     oftable_remove_rule(rule);
2077     ofproto_rule_destroy__(rule);
2078 }
2079
2080 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2081  * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2082 bool
2083 ofproto_rule_has_out_port(const struct rule *rule, uint16_t port)
2084 {
2085     return (port == OFPP_ANY
2086             || ofpacts_output_to_port(rule->ofpacts, rule->ofpacts_len, port));
2087 }
2088
2089 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2090  * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2091 bool
2092 ofoperation_has_out_port(const struct ofoperation *op, uint16_t out_port)
2093 {
2094     if (ofproto_rule_has_out_port(op->rule, out_port)) {
2095         return true;
2096     }
2097
2098     switch (op->type) {
2099     case OFOPERATION_ADD:
2100         return op->victim && ofproto_rule_has_out_port(op->victim, out_port);
2101
2102     case OFOPERATION_DELETE:
2103         return false;
2104
2105     case OFOPERATION_MODIFY:
2106         return ofpacts_output_to_port(op->ofpacts, op->ofpacts_len, out_port);
2107     }
2108
2109     NOT_REACHED();
2110 }
2111
2112 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2113  * statistics appropriately.  'packet' must have at least sizeof(struct
2114  * ofp10_packet_in) bytes of headroom.
2115  *
2116  * 'packet' doesn't necessarily have to match 'rule'.  'rule' will be credited
2117  * with statistics for 'packet' either way.
2118  *
2119  * Takes ownership of 'packet'. */
2120 static int
2121 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
2122 {
2123     struct flow flow;
2124
2125     ovs_assert(ofpbuf_headroom(packet) >= sizeof(struct ofp10_packet_in));
2126
2127     flow_extract(packet, 0, 0, NULL, in_port, &flow);
2128     return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
2129 }
2130
2131 /* Returns true if 'rule' should be hidden from the controller.
2132  *
2133  * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2134  * (e.g. by in-band control) and are intentionally hidden from the
2135  * controller. */
2136 bool
2137 ofproto_rule_is_hidden(const struct rule *rule)
2138 {
2139     return rule->cr.priority > UINT16_MAX;
2140 }
2141
2142 static enum oftable_flags
2143 rule_get_flags(const struct rule *rule)
2144 {
2145     return rule->ofproto->tables[rule->table_id].flags;
2146 }
2147
2148 static bool
2149 rule_is_modifiable(const struct rule *rule)
2150 {
2151     return !(rule_get_flags(rule) & OFTABLE_READONLY);
2152 }
2153 \f
2154 static enum ofperr
2155 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
2156 {
2157     ofconn_send_reply(ofconn, make_echo_reply(oh));
2158     return 0;
2159 }
2160
2161 static enum ofperr
2162 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
2163 {
2164     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2165     struct ofputil_switch_features features;
2166     struct ofport *port;
2167     bool arp_match_ip;
2168     struct ofpbuf *b;
2169     int n_tables;
2170     int i;
2171
2172     ofproto->ofproto_class->get_features(ofproto, &arp_match_ip,
2173                                          &features.actions);
2174     ovs_assert(features.actions & OFPUTIL_A_OUTPUT); /* sanity check */
2175
2176     /* Count only non-hidden tables in the number of tables.  (Hidden tables,
2177      * if present, are always at the end.) */
2178     n_tables = ofproto->n_tables;
2179     for (i = 0; i < ofproto->n_tables; i++) {
2180         if (ofproto->tables[i].flags & OFTABLE_HIDDEN) {
2181             n_tables = i;
2182             break;
2183         }
2184     }
2185
2186     features.datapath_id = ofproto->datapath_id;
2187     features.n_buffers = pktbuf_capacity();
2188     features.n_tables = n_tables;
2189     features.capabilities = (OFPUTIL_C_FLOW_STATS | OFPUTIL_C_TABLE_STATS |
2190                              OFPUTIL_C_PORT_STATS | OFPUTIL_C_QUEUE_STATS);
2191     if (arp_match_ip) {
2192         features.capabilities |= OFPUTIL_C_ARP_MATCH_IP;
2193     }
2194     /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2195     features.auxiliary_id = 0;
2196     b = ofputil_encode_switch_features(&features, ofconn_get_protocol(ofconn),
2197                                        oh->xid);
2198     HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2199         ofputil_put_switch_features_port(&port->pp, b);
2200     }
2201
2202     ofconn_send_reply(ofconn, b);
2203     return 0;
2204 }
2205
2206 static enum ofperr
2207 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
2208 {
2209     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2210     struct ofp_switch_config *osc;
2211     enum ofp_config_flags flags;
2212     struct ofpbuf *buf;
2213
2214     /* Send reply. */
2215     buf = ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY, oh, 0);
2216     osc = ofpbuf_put_uninit(buf, sizeof *osc);
2217     flags = ofproto->frag_handling;
2218     /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2219     if (oh->version < OFP13_VERSION
2220         && ofconn_get_invalid_ttl_to_controller(ofconn)) {
2221         flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
2222     }
2223     osc->flags = htons(flags);
2224     osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
2225     ofconn_send_reply(ofconn, buf);
2226
2227     return 0;
2228 }
2229
2230 static enum ofperr
2231 handle_set_config(struct ofconn *ofconn, const struct ofp_header *oh)
2232 {
2233     const struct ofp_switch_config *osc = ofpmsg_body(oh);
2234     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2235     uint16_t flags = ntohs(osc->flags);
2236
2237     if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
2238         || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
2239         enum ofp_config_flags cur = ofproto->frag_handling;
2240         enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
2241
2242         ovs_assert((cur & OFPC_FRAG_MASK) == cur);
2243         if (cur != next) {
2244             if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
2245                 ofproto->frag_handling = next;
2246             } else {
2247                 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
2248                              ofproto->name,
2249                              ofputil_frag_handling_to_string(next));
2250             }
2251         }
2252     }
2253     /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
2254     ofconn_set_invalid_ttl_to_controller(ofconn,
2255              (oh->version < OFP13_VERSION
2256               && flags & OFPC_INVALID_TTL_TO_CONTROLLER));
2257
2258     ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
2259
2260     return 0;
2261 }
2262
2263 /* Checks whether 'ofconn' is a slave controller.  If so, returns an OpenFlow
2264  * error message code for the caller to propagate upward.  Otherwise, returns
2265  * 0.
2266  *
2267  * The log message mentions 'msg_type'. */
2268 static enum ofperr
2269 reject_slave_controller(struct ofconn *ofconn)
2270 {
2271     if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
2272         && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
2273         return OFPERR_OFPBRC_EPERM;
2274     } else {
2275         return 0;
2276     }
2277 }
2278
2279 static enum ofperr
2280 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
2281 {
2282     struct ofproto *p = ofconn_get_ofproto(ofconn);
2283     struct ofputil_packet_out po;
2284     struct ofpbuf *payload;
2285     uint64_t ofpacts_stub[1024 / 8];
2286     struct ofpbuf ofpacts;
2287     struct flow flow;
2288     enum ofperr error;
2289
2290     COVERAGE_INC(ofproto_packet_out);
2291
2292     error = reject_slave_controller(ofconn);
2293     if (error) {
2294         goto exit;
2295     }
2296
2297     /* Decode message. */
2298     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2299     error = ofputil_decode_packet_out(&po, oh, &ofpacts);
2300     if (error) {
2301         goto exit_free_ofpacts;
2302     }
2303     if (po.in_port >= p->max_ports && po.in_port < OFPP_MAX) {
2304         error = OFPERR_OFPBRC_BAD_PORT;
2305         goto exit_free_ofpacts;
2306     }
2307
2308
2309     /* Get payload. */
2310     if (po.buffer_id != UINT32_MAX) {
2311         error = ofconn_pktbuf_retrieve(ofconn, po.buffer_id, &payload, NULL);
2312         if (error || !payload) {
2313             goto exit_free_ofpacts;
2314         }
2315     } else {
2316         payload = xmalloc(sizeof *payload);
2317         ofpbuf_use_const(payload, po.packet, po.packet_len);
2318     }
2319
2320     /* Verify actions against packet, then send packet if successful. */
2321     flow_extract(payload, 0, 0, NULL, po.in_port, &flow);
2322     error = ofpacts_check(po.ofpacts, po.ofpacts_len, &flow, p->max_ports);
2323     if (!error) {
2324         error = p->ofproto_class->packet_out(p, payload, &flow,
2325                                              po.ofpacts, po.ofpacts_len);
2326     }
2327     ofpbuf_delete(payload);
2328
2329 exit_free_ofpacts:
2330     ofpbuf_uninit(&ofpacts);
2331 exit:
2332     return error;
2333 }
2334
2335 static void
2336 update_port_config(struct ofport *port,
2337                    enum ofputil_port_config config,
2338                    enum ofputil_port_config mask)
2339 {
2340     enum ofputil_port_config old_config = port->pp.config;
2341     enum ofputil_port_config toggle;
2342
2343     toggle = (config ^ port->pp.config) & mask;
2344     if (toggle & OFPUTIL_PC_PORT_DOWN) {
2345         if (config & OFPUTIL_PC_PORT_DOWN) {
2346             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2347         } else {
2348             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2349         }
2350         toggle &= ~OFPUTIL_PC_PORT_DOWN;
2351     }
2352
2353     port->pp.config ^= toggle;
2354     if (port->pp.config != old_config) {
2355         port->ofproto->ofproto_class->port_reconfigured(port, old_config);
2356     }
2357 }
2358
2359 static enum ofperr
2360 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2361 {
2362     struct ofproto *p = ofconn_get_ofproto(ofconn);
2363     struct ofputil_port_mod pm;
2364     struct ofport *port;
2365     enum ofperr error;
2366
2367     error = reject_slave_controller(ofconn);
2368     if (error) {
2369         return error;
2370     }
2371
2372     error = ofputil_decode_port_mod(oh, &pm);
2373     if (error) {
2374         return error;
2375     }
2376
2377     port = ofproto_get_port(p, pm.port_no);
2378     if (!port) {
2379         return OFPERR_OFPPMFC_BAD_PORT;
2380     } else if (!eth_addr_equals(port->pp.hw_addr, pm.hw_addr)) {
2381         return OFPERR_OFPPMFC_BAD_HW_ADDR;
2382     } else {
2383         update_port_config(port, pm.config, pm.mask);
2384         if (pm.advertise) {
2385             netdev_set_advertisements(port->netdev, pm.advertise);
2386         }
2387     }
2388     return 0;
2389 }
2390
2391 static enum ofperr
2392 handle_desc_stats_request(struct ofconn *ofconn,
2393                           const struct ofp_header *request)
2394 {
2395     static const char *default_mfr_desc = "Nicira, Inc.";
2396     static const char *default_hw_desc = "Open vSwitch";
2397     static const char *default_sw_desc = VERSION;
2398     static const char *default_serial_desc = "None";
2399     static const char *default_dp_desc = "None";
2400
2401     struct ofproto *p = ofconn_get_ofproto(ofconn);
2402     struct ofp_desc_stats *ods;
2403     struct ofpbuf *msg;
2404
2405     msg = ofpraw_alloc_stats_reply(request, 0);
2406     ods = ofpbuf_put_zeros(msg, sizeof *ods);
2407     ovs_strlcpy(ods->mfr_desc, p->mfr_desc ? p->mfr_desc : default_mfr_desc,
2408                 sizeof ods->mfr_desc);
2409     ovs_strlcpy(ods->hw_desc, p->hw_desc ? p->hw_desc : default_hw_desc,
2410                 sizeof ods->hw_desc);
2411     ovs_strlcpy(ods->sw_desc, p->sw_desc ? p->sw_desc : default_sw_desc,
2412                 sizeof ods->sw_desc);
2413     ovs_strlcpy(ods->serial_num,
2414                 p->serial_desc ? p->serial_desc : default_serial_desc,
2415                 sizeof ods->serial_num);
2416     ovs_strlcpy(ods->dp_desc, p->dp_desc ? p->dp_desc : default_dp_desc,
2417                 sizeof ods->dp_desc);
2418     ofconn_send_reply(ofconn, msg);
2419
2420     return 0;
2421 }
2422
2423 static enum ofperr
2424 handle_table_stats_request(struct ofconn *ofconn,
2425                            const struct ofp_header *request)
2426 {
2427     struct ofproto *p = ofconn_get_ofproto(ofconn);
2428     struct ofp12_table_stats *ots;
2429     struct ofpbuf *msg;
2430     int n_tables;
2431     size_t i;
2432
2433     /* Set up default values.
2434      *
2435      * ofp12_table_stats is used as a generic structure as
2436      * it is able to hold all the fields for ofp10_table_stats
2437      * and ofp11_table_stats (and of course itself).
2438      */
2439     ots = xcalloc(p->n_tables, sizeof *ots);
2440     for (i = 0; i < p->n_tables; i++) {
2441         ots[i].table_id = i;
2442         sprintf(ots[i].name, "table%zu", i);
2443         ots[i].match = htonll(OFPXMT12_MASK);
2444         ots[i].wildcards = htonll(OFPXMT12_MASK);
2445         ots[i].write_actions = htonl(OFPAT11_OUTPUT);
2446         ots[i].apply_actions = htonl(OFPAT11_OUTPUT);
2447         ots[i].write_setfields = htonll(OFPXMT12_MASK);
2448         ots[i].apply_setfields = htonll(OFPXMT12_MASK);
2449         ots[i].metadata_match = htonll(UINT64_MAX);
2450         ots[i].metadata_write = htonll(UINT64_MAX);
2451         ots[i].instructions = htonl(OFPIT11_ALL);
2452         ots[i].config = htonl(OFPTC11_TABLE_MISS_MASK);
2453         ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
2454         ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
2455     }
2456
2457     p->ofproto_class->get_tables(p, ots);
2458
2459     /* Post-process the tables, dropping hidden tables. */
2460     n_tables = p->n_tables;
2461     for (i = 0; i < p->n_tables; i++) {
2462         const struct oftable *table = &p->tables[i];
2463
2464         if (table->flags & OFTABLE_HIDDEN) {
2465             n_tables = i;
2466             break;
2467         }
2468
2469         if (table->name) {
2470             ovs_strzcpy(ots[i].name, table->name, sizeof ots[i].name);
2471         }
2472
2473         if (table->max_flows < ntohl(ots[i].max_entries)) {
2474             ots[i].max_entries = htonl(table->max_flows);
2475         }
2476     }
2477
2478     msg = ofputil_encode_table_stats_reply(ots, n_tables, request);
2479     ofconn_send_reply(ofconn, msg);
2480
2481     free(ots);
2482
2483     return 0;
2484 }
2485
2486 static void
2487 append_port_stat(struct ofport *port, struct list *replies)
2488 {
2489     struct ofputil_port_stats ops = { .port_no = port->pp.port_no };
2490
2491     /* Intentionally ignore return value, since errors will set
2492      * 'stats' to all-1s, which is correct for OpenFlow, and
2493      * netdev_get_stats() will log errors. */
2494     ofproto_port_get_stats(port, &ops.stats);
2495
2496     ofputil_append_port_stat(replies, &ops);
2497 }
2498
2499 static enum ofperr
2500 handle_port_stats_request(struct ofconn *ofconn,
2501                           const struct ofp_header *request)
2502 {
2503     struct ofproto *p = ofconn_get_ofproto(ofconn);
2504     struct ofport *port;
2505     struct list replies;
2506     uint16_t port_no;
2507     enum ofperr error;
2508
2509     error = ofputil_decode_port_stats_request(request, &port_no);
2510     if (error) {
2511         return error;
2512     }
2513
2514     ofpmp_init(&replies, request);
2515     if (port_no != OFPP_ANY) {
2516         port = ofproto_get_port(p, port_no);
2517         if (port) {
2518             append_port_stat(port, &replies);
2519         }
2520     } else {
2521         HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2522             append_port_stat(port, &replies);
2523         }
2524     }
2525
2526     ofconn_send_replies(ofconn, &replies);
2527     return 0;
2528 }
2529
2530 static enum ofperr
2531 handle_port_desc_stats_request(struct ofconn *ofconn,
2532                                const struct ofp_header *request)
2533 {
2534     struct ofproto *p = ofconn_get_ofproto(ofconn);
2535     enum ofp_version version;
2536     struct ofport *port;
2537     struct list replies;
2538
2539     ofpmp_init(&replies, request);
2540
2541     version = ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn));
2542     HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2543         ofputil_append_port_desc_stats_reply(version, &port->pp, &replies);
2544     }
2545
2546     ofconn_send_replies(ofconn, &replies);
2547     return 0;
2548 }
2549
2550 static void
2551 calc_flow_duration__(long long int start, long long int now,
2552                      uint32_t *sec, uint32_t *nsec)
2553 {
2554     long long int msecs = now - start;
2555     *sec = msecs / 1000;
2556     *nsec = (msecs % 1000) * (1000 * 1000);
2557 }
2558
2559 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'.  Returns
2560  * 0 if 'table_id' is OK, otherwise an OpenFlow error code.  */
2561 static enum ofperr
2562 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2563 {
2564     return (table_id == 0xff || table_id < ofproto->n_tables
2565             ? 0
2566             : OFPERR_OFPBRC_BAD_TABLE_ID);
2567
2568 }
2569
2570 static struct oftable *
2571 next_visible_table(const struct ofproto *ofproto, uint8_t table_id)
2572 {
2573     struct oftable *table;
2574
2575     for (table = &ofproto->tables[table_id];
2576          table < &ofproto->tables[ofproto->n_tables];
2577          table++) {
2578         if (!(table->flags & OFTABLE_HIDDEN)) {
2579             return table;
2580         }
2581     }
2582
2583     return NULL;
2584 }
2585
2586 static struct oftable *
2587 first_matching_table(const struct ofproto *ofproto, uint8_t table_id)
2588 {
2589     if (table_id == 0xff) {
2590         return next_visible_table(ofproto, 0);
2591     } else if (table_id < ofproto->n_tables) {
2592         return &ofproto->tables[table_id];
2593     } else {
2594         return NULL;
2595     }
2596 }
2597
2598 static struct oftable *
2599 next_matching_table(const struct ofproto *ofproto,
2600                     const struct oftable *table, uint8_t table_id)
2601 {
2602     return (table_id == 0xff
2603             ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2604             : NULL);
2605 }
2606
2607 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2608  *
2609  *   - If TABLE_ID is 0xff, this iterates over every classifier table in
2610  *     OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2611  *
2612  *   - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2613  *     only once, for that table.  (This can be used to access tables marked
2614  *     OFTABLE_HIDDEN.)
2615  *
2616  *   - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2617  *     entered at all.  (Perhaps you should have validated TABLE_ID with
2618  *     check_table_id().)
2619  *
2620  * All parameters are evaluated multiple times.
2621  */
2622 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO)         \
2623     for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID);       \
2624          (TABLE) != NULL;                                         \
2625          (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2626
2627 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2628  * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2629  * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2630  * 'rules'.
2631  *
2632  * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2633  * to 'out_port' are included.
2634  *
2635  * Hidden rules are always omitted.
2636  *
2637  * Returns 0 on success, otherwise an OpenFlow error code. */
2638 static enum ofperr
2639 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2640                     const struct match *match,
2641                     ovs_be64 cookie, ovs_be64 cookie_mask,
2642                     uint16_t out_port, struct list *rules)
2643 {
2644     struct oftable *table;
2645     struct cls_rule cr;
2646     enum ofperr error;
2647
2648     error = check_table_id(ofproto, table_id);
2649     if (error) {
2650         return error;
2651     }
2652
2653     list_init(rules);
2654     cls_rule_init(&cr, match, 0);
2655     FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2656         struct cls_cursor cursor;
2657         struct rule *rule;
2658
2659         cls_cursor_init(&cursor, &table->cls, &cr);
2660         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2661             if (rule->pending) {
2662                 error = OFPROTO_POSTPONE;
2663                 goto exit;
2664             }
2665             if (!ofproto_rule_is_hidden(rule)
2666                 && ofproto_rule_has_out_port(rule, out_port)
2667                     && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2668                 list_push_back(rules, &rule->ofproto_node);
2669             }
2670         }
2671     }
2672
2673 exit:
2674     cls_rule_destroy(&cr);
2675     return error;
2676 }
2677
2678 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2679  * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2680  * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2681  * on list 'rules'.
2682  *
2683  * If 'out_port' is anything other than OFPP_ANY, then only rules that output
2684  * to 'out_port' are included.
2685  *
2686  * Hidden rules are always omitted.
2687  *
2688  * Returns 0 on success, otherwise an OpenFlow error code. */
2689 static enum ofperr
2690 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2691                      const struct match *match, unsigned int priority,
2692                      ovs_be64 cookie, ovs_be64 cookie_mask,
2693                      uint16_t out_port, struct list *rules)
2694 {
2695     struct oftable *table;
2696     struct cls_rule cr;
2697     int error;
2698
2699     error = check_table_id(ofproto, table_id);
2700     if (error) {
2701         return error;
2702     }
2703
2704     list_init(rules);
2705     cls_rule_init(&cr, match, priority);
2706     FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2707         struct rule *rule;
2708
2709         rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2710                                                                &cr));
2711         if (rule) {
2712             if (rule->pending) {
2713                 error = OFPROTO_POSTPONE;
2714                 goto exit;
2715             }
2716             if (!ofproto_rule_is_hidden(rule)
2717                 && ofproto_rule_has_out_port(rule, out_port)
2718                     && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2719                 list_push_back(rules, &rule->ofproto_node);
2720             }
2721         }
2722     }
2723
2724 exit:
2725     cls_rule_destroy(&cr);
2726     return 0;
2727 }
2728
2729 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2730  * forced into the range of a uint16_t. */
2731 static int
2732 age_secs(long long int age_ms)
2733 {
2734     return (age_ms < 0 ? 0
2735             : age_ms >= UINT16_MAX * 1000 ? UINT16_MAX
2736             : (unsigned int) age_ms / 1000);
2737 }
2738
2739 static enum ofperr
2740 handle_flow_stats_request(struct ofconn *ofconn,
2741                           const struct ofp_header *request)
2742 {
2743     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2744     struct ofputil_flow_stats_request fsr;
2745     struct list replies;
2746     struct list rules;
2747     struct rule *rule;
2748     enum ofperr error;
2749
2750     error = ofputil_decode_flow_stats_request(&fsr, request);
2751     if (error) {
2752         return error;
2753     }
2754
2755     error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2756                                 fsr.cookie, fsr.cookie_mask,
2757                                 fsr.out_port, &rules);
2758     if (error) {
2759         return error;
2760     }
2761
2762     ofpmp_init(&replies, request);
2763     LIST_FOR_EACH (rule, ofproto_node, &rules) {
2764         long long int now = time_msec();
2765         struct ofputil_flow_stats fs;
2766
2767         minimatch_expand(&rule->cr.match, &fs.match);
2768         fs.priority = rule->cr.priority;
2769         fs.cookie = rule->flow_cookie;
2770         fs.table_id = rule->table_id;
2771         calc_flow_duration__(rule->created, now, &fs.duration_sec,
2772                              &fs.duration_nsec);
2773         fs.idle_timeout = rule->idle_timeout;
2774         fs.hard_timeout = rule->hard_timeout;
2775         fs.idle_age = age_secs(now - rule->used);
2776         fs.hard_age = age_secs(now - rule->modified);
2777         ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2778                                                &fs.byte_count);
2779         fs.ofpacts = rule->ofpacts;
2780         fs.ofpacts_len = rule->ofpacts_len;
2781         fs.flags = 0;
2782         if (rule->send_flow_removed) {
2783             fs.flags |= OFPFF_SEND_FLOW_REM;
2784             /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
2785                and OFPFF13_NO_BYT_COUNTS */
2786         }
2787         ofputil_append_flow_stats_reply(&fs, &replies);
2788     }
2789     ofconn_send_replies(ofconn, &replies);
2790
2791     return 0;
2792 }
2793
2794 static void
2795 flow_stats_ds(struct rule *rule, struct ds *results)
2796 {
2797     uint64_t packet_count, byte_count;
2798
2799     rule->ofproto->ofproto_class->rule_get_stats(rule,
2800                                                  &packet_count, &byte_count);
2801
2802     if (rule->table_id != 0) {
2803         ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2804     }
2805     ds_put_format(results, "duration=%llds, ",
2806                   (time_msec() - rule->created) / 1000);
2807     ds_put_format(results, "priority=%u, ", rule->cr.priority);
2808     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2809     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2810     cls_rule_format(&rule->cr, results);
2811     ds_put_char(results, ',');
2812     if (rule->ofpacts_len > 0) {
2813         ofpacts_format(rule->ofpacts, rule->ofpacts_len, results);
2814     } else {
2815         ds_put_cstr(results, "drop");
2816     }
2817     ds_put_cstr(results, "\n");
2818 }
2819
2820 /* Adds a pretty-printed description of all flows to 'results', including
2821  * hidden flows (e.g., set up by in-band control). */
2822 void
2823 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2824 {
2825     struct oftable *table;
2826
2827     OFPROTO_FOR_EACH_TABLE (table, p) {
2828         struct cls_cursor cursor;
2829         struct rule *rule;
2830
2831         cls_cursor_init(&cursor, &table->cls, NULL);
2832         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2833             flow_stats_ds(rule, results);
2834         }
2835     }
2836 }
2837
2838 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2839  * '*engine_type' and '*engine_id', respectively. */
2840 void
2841 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2842                         uint8_t *engine_type, uint8_t *engine_id)
2843 {
2844     ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2845 }
2846
2847 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'.  Returns a
2848  * bitmask of 'cfm_fault_reason's to indicate a CFM fault (generally
2849  * indicating a connectivity problem).  Returns zero if CFM is not faulted,
2850  * and -1 if CFM is not enabled on 'ofp_port'. */
2851 int
2852 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2853 {
2854     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2855     return (ofport && ofproto->ofproto_class->get_cfm_fault
2856             ? ofproto->ofproto_class->get_cfm_fault(ofport)
2857             : -1);
2858 }
2859
2860 /* Checks the operational status reported by the remote CFM endpoint of
2861  * 'ofp_port'  Returns 1 if operationally up, 0 if operationally down, and -1
2862  * if CFM is not enabled on 'ofp_port' or does not support operational status.
2863  */
2864 int
2865 ofproto_port_get_cfm_opup(const struct ofproto *ofproto, uint16_t ofp_port)
2866 {
2867     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2868     return (ofport && ofproto->ofproto_class->get_cfm_opup
2869             ? ofproto->ofproto_class->get_cfm_opup(ofport)
2870             : -1);
2871 }
2872
2873 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2874  * within 'ofproto'.  Populates 'rmps' with an array of MPIDs owned by
2875  * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'.  Returns a
2876  * number less than 0 if CFM is not enabled on 'ofp_port'. */
2877 int
2878 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2879                                   uint16_t ofp_port, const uint64_t **rmps,
2880                                   size_t *n_rmps)
2881 {
2882     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2883
2884     *rmps = NULL;
2885     *n_rmps = 0;
2886     return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2887             ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2888                                                            n_rmps)
2889             : -1);
2890 }
2891
2892 /* Checks the health of the CFM for 'ofp_port' within 'ofproto'.  Returns an
2893  * integer value between 0 and 100 to indicate the health of the port as a
2894  * percentage which is the average of cfm health of all the remote_mpids or
2895  * returns -1 if CFM is not enabled on 'ofport'. */
2896 int
2897 ofproto_port_get_cfm_health(const struct ofproto *ofproto, uint16_t ofp_port)
2898 {
2899     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2900     return (ofport && ofproto->ofproto_class->get_cfm_health
2901             ? ofproto->ofproto_class->get_cfm_health(ofport)
2902             : -1);
2903 }
2904
2905 static enum ofperr
2906 handle_aggregate_stats_request(struct ofconn *ofconn,
2907                                const struct ofp_header *oh)
2908 {
2909     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2910     struct ofputil_flow_stats_request request;
2911     struct ofputil_aggregate_stats stats;
2912     bool unknown_packets, unknown_bytes;
2913     struct ofpbuf *reply;
2914     struct list rules;
2915     struct rule *rule;
2916     enum ofperr error;
2917
2918     error = ofputil_decode_flow_stats_request(&request, oh);
2919     if (error) {
2920         return error;
2921     }
2922
2923     error = collect_rules_loose(ofproto, request.table_id, &request.match,
2924                                 request.cookie, request.cookie_mask,
2925                                 request.out_port, &rules);
2926     if (error) {
2927         return error;
2928     }
2929
2930     memset(&stats, 0, sizeof stats);
2931     unknown_packets = unknown_bytes = false;
2932     LIST_FOR_EACH (rule, ofproto_node, &rules) {
2933         uint64_t packet_count;
2934         uint64_t byte_count;
2935
2936         ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2937                                                &byte_count);
2938
2939         if (packet_count == UINT64_MAX) {
2940             unknown_packets = true;
2941         } else {
2942             stats.packet_count += packet_count;
2943         }
2944
2945         if (byte_count == UINT64_MAX) {
2946             unknown_bytes = true;
2947         } else {
2948             stats.byte_count += byte_count;
2949         }
2950
2951         stats.flow_count++;
2952     }
2953     if (unknown_packets) {
2954         stats.packet_count = UINT64_MAX;
2955     }
2956     if (unknown_bytes) {
2957         stats.byte_count = UINT64_MAX;
2958     }
2959
2960     reply = ofputil_encode_aggregate_stats_reply(&stats, oh);
2961     ofconn_send_reply(ofconn, reply);
2962
2963     return 0;
2964 }
2965
2966 struct queue_stats_cbdata {
2967     struct ofport *ofport;
2968     struct list replies;
2969 };
2970
2971 static void
2972 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2973                 const struct netdev_queue_stats *stats)
2974 {
2975
2976     struct ofputil_queue_stats oqs = {
2977         .port_no = cbdata->ofport->pp.port_no,
2978         .queue_id = queue_id,
2979         .stats = *stats,
2980     };
2981     ofputil_append_queue_stat(&cbdata->replies, &oqs);
2982 }
2983
2984 static void
2985 handle_queue_stats_dump_cb(uint32_t queue_id,
2986                            struct netdev_queue_stats *stats,
2987                            void *cbdata_)
2988 {
2989     struct queue_stats_cbdata *cbdata = cbdata_;
2990
2991     put_queue_stats(cbdata, queue_id, stats);
2992 }
2993
2994 static enum ofperr
2995 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2996                             struct queue_stats_cbdata *cbdata)
2997 {
2998     cbdata->ofport = port;
2999     if (queue_id == OFPQ_ALL) {
3000         netdev_dump_queue_stats(port->netdev,
3001                                 handle_queue_stats_dump_cb, cbdata);
3002     } else {
3003         struct netdev_queue_stats stats;
3004
3005         if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
3006             put_queue_stats(cbdata, queue_id, &stats);
3007         } else {
3008             return OFPERR_OFPQOFC_BAD_QUEUE;
3009         }
3010     }
3011     return 0;
3012 }
3013
3014 static enum ofperr
3015 handle_queue_stats_request(struct ofconn *ofconn,
3016                            const struct ofp_header *rq)
3017 {
3018     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3019     struct queue_stats_cbdata cbdata;
3020     struct ofport *port;
3021     enum ofperr error;
3022     struct ofputil_queue_stats_request oqsr;
3023
3024     COVERAGE_INC(ofproto_queue_req);
3025
3026     ofpmp_init(&cbdata.replies, rq);
3027
3028     error = ofputil_decode_queue_stats_request(rq, &oqsr);
3029     if (error) {
3030         return error;
3031     }
3032
3033     if (oqsr.port_no == OFPP_ANY) {
3034         error = OFPERR_OFPQOFC_BAD_QUEUE;
3035         HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
3036             if (!handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)) {
3037                 error = 0;
3038             }
3039         }
3040     } else {
3041         port = ofproto_get_port(ofproto, oqsr.port_no);
3042         error = (port
3043                  ? handle_queue_stats_for_port(port, oqsr.queue_id, &cbdata)
3044                  : OFPERR_OFPQOFC_BAD_PORT);
3045     }
3046     if (!error) {
3047         ofconn_send_replies(ofconn, &cbdata.replies);
3048     } else {
3049         ofpbuf_list_delete(&cbdata.replies);
3050     }
3051
3052     return error;
3053 }
3054
3055 static bool
3056 is_flow_deletion_pending(const struct ofproto *ofproto,
3057                          const struct cls_rule *cls_rule,
3058                          uint8_t table_id)
3059 {
3060     if (!hmap_is_empty(&ofproto->deletions)) {
3061         struct ofoperation *op;
3062
3063         HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
3064                                  cls_rule_hash(cls_rule, table_id),
3065                                  &ofproto->deletions) {
3066             if (cls_rule_equal(cls_rule, &op->rule->cr)) {
3067                 return true;
3068             }
3069         }
3070     }
3071
3072     return false;
3073 }
3074
3075 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3076  * in which no matching flow already exists in the flow table.
3077  *
3078  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3079  * ofp_actions, to the ofproto's flow table.  Returns 0 on success, an OpenFlow
3080  * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3081  * initiated now but may be retried later.
3082  *
3083  * Upon successful return, takes ownership of 'fm->ofpacts'.  On failure,
3084  * ownership remains with the caller.
3085  *
3086  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3087  * if any. */
3088 static enum ofperr
3089 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
3090          const struct ofputil_flow_mod *fm, const struct ofp_header *request)
3091 {
3092     struct oftable *table;
3093     struct ofopgroup *group;
3094     struct rule *victim;
3095     struct cls_rule cr;
3096     struct rule *rule;
3097     int error;
3098
3099     error = check_table_id(ofproto, fm->table_id);
3100     if (error) {
3101         return error;
3102     }
3103
3104     /* Pick table. */
3105     if (fm->table_id == 0xff) {
3106         uint8_t table_id;
3107         if (ofproto->ofproto_class->rule_choose_table) {
3108             error = ofproto->ofproto_class->rule_choose_table(ofproto,
3109                                                               &fm->match,
3110                                                               &table_id);
3111             if (error) {
3112                 return error;
3113             }
3114             ovs_assert(table_id < ofproto->n_tables);
3115             table = &ofproto->tables[table_id];
3116         } else {
3117             table = &ofproto->tables[0];
3118         }
3119     } else if (fm->table_id < ofproto->n_tables) {
3120         table = &ofproto->tables[fm->table_id];
3121     } else {
3122         return OFPERR_OFPBRC_BAD_TABLE_ID;
3123     }
3124
3125     if (table->flags & OFTABLE_READONLY) {
3126         return OFPERR_OFPBRC_EPERM;
3127     }
3128
3129     /* Allocate new rule and initialize classifier rule. */
3130     rule = ofproto->ofproto_class->rule_alloc();
3131     if (!rule) {
3132         VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
3133                      ofproto->name, strerror(error));
3134         return ENOMEM;
3135     }
3136     cls_rule_init(&rule->cr, &fm->match, fm->priority);
3137
3138     /* Serialize against pending deletion. */
3139     if (is_flow_deletion_pending(ofproto, &cr, table - ofproto->tables)) {
3140         cls_rule_destroy(&rule->cr);
3141         ofproto->ofproto_class->rule_dealloc(rule);
3142         return OFPROTO_POSTPONE;
3143     }
3144
3145     /* Check for overlap, if requested. */
3146     if (fm->flags & OFPFF_CHECK_OVERLAP
3147         && classifier_rule_overlaps(&table->cls, &rule->cr)) {
3148         cls_rule_destroy(&rule->cr);
3149         ofproto->ofproto_class->rule_dealloc(rule);
3150         return OFPERR_OFPFMFC_OVERLAP;
3151     }
3152
3153     /* FIXME: Implement OFPFF12_RESET_COUNTS */
3154
3155     rule->ofproto = ofproto;
3156     rule->pending = NULL;
3157     rule->flow_cookie = fm->new_cookie;
3158     rule->created = rule->modified = rule->used = time_msec();
3159     rule->idle_timeout = fm->idle_timeout;
3160     rule->hard_timeout = fm->hard_timeout;
3161     rule->table_id = table - ofproto->tables;
3162     rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
3163     /* FIXME: Implement OF 1.3 flags OFPFF13_NO_PKT_COUNTS
3164        and OFPFF13_NO_BYT_COUNTS */
3165     rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3166     rule->ofpacts_len = fm->ofpacts_len;
3167     rule->evictable = true;
3168     rule->eviction_group = NULL;
3169     rule->monitor_flags = 0;
3170     rule->add_seqno = 0;
3171     rule->modify_seqno = 0;
3172
3173     /* Insert new rule. */
3174     victim = oftable_replace_rule(rule);
3175     if (victim && !rule_is_modifiable(victim)) {
3176         error = OFPERR_OFPBRC_EPERM;
3177     } else if (victim && victim->pending) {
3178         error = OFPROTO_POSTPONE;
3179     } else {
3180         struct ofoperation *op;
3181         struct rule *evict;
3182
3183         if (classifier_count(&table->cls) > table->max_flows) {
3184             bool was_evictable;
3185
3186             was_evictable = rule->evictable;
3187             rule->evictable = false;
3188             evict = choose_rule_to_evict(table);
3189             rule->evictable = was_evictable;
3190
3191             if (!evict) {
3192                 error = OFPERR_OFPFMFC_TABLE_FULL;
3193                 goto exit;
3194             } else if (evict->pending) {
3195                 error = OFPROTO_POSTPONE;
3196                 goto exit;
3197             }
3198         } else {
3199             evict = NULL;
3200         }
3201
3202         group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3203         op = ofoperation_create(group, rule, OFOPERATION_ADD, 0);
3204         op->victim = victim;
3205
3206         error = ofproto->ofproto_class->rule_construct(rule);
3207         if (error) {
3208             op->group->n_running--;
3209             ofoperation_destroy(rule->pending);
3210         } else if (evict) {
3211             delete_flow__(evict, group);
3212         }
3213         ofopgroup_submit(group);
3214     }
3215
3216 exit:
3217     /* Back out if an error occurred. */
3218     if (error) {
3219         oftable_substitute_rule(rule, victim);
3220         ofproto_rule_destroy__(rule);
3221     }
3222     return error;
3223 }
3224 \f
3225 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3226
3227 /* Modifies the rules listed in 'rules', changing their actions to match those
3228  * in 'fm'.
3229  *
3230  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3231  * if any.
3232  *
3233  * Returns 0 on success, otherwise an OpenFlow error code. */
3234 static enum ofperr
3235 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3236                const struct ofputil_flow_mod *fm,
3237                const struct ofp_header *request, struct list *rules)
3238 {
3239     struct ofopgroup *group;
3240     struct rule *rule;
3241     enum ofperr error;
3242
3243     group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
3244     error = OFPERR_OFPBRC_EPERM;
3245     LIST_FOR_EACH (rule, ofproto_node, rules) {
3246         struct ofoperation *op;
3247         bool actions_changed;
3248         ovs_be64 new_cookie;
3249
3250         /* FIXME: Implement OFPFF12_RESET_COUNTS */
3251
3252         if (rule_is_modifiable(rule)) {
3253             /* At least one rule is modifiable, don't report EPERM error. */
3254             error = 0;
3255         } else {
3256             continue;
3257         }
3258
3259         actions_changed = !ofpacts_equal(fm->ofpacts, fm->ofpacts_len,
3260                                          rule->ofpacts, rule->ofpacts_len);
3261         new_cookie = (fm->new_cookie != htonll(UINT64_MAX)
3262                       ? fm->new_cookie
3263                       : rule->flow_cookie);
3264         if (!actions_changed && new_cookie == rule->flow_cookie) {
3265             /* No change at all. */
3266             continue;
3267         }
3268
3269         op = ofoperation_create(group, rule, OFOPERATION_MODIFY, 0);
3270         rule->flow_cookie = new_cookie;
3271         if (actions_changed) {
3272             op->ofpacts = rule->ofpacts;
3273             op->ofpacts_len = rule->ofpacts_len;
3274             rule->ofpacts = xmemdup(fm->ofpacts, fm->ofpacts_len);
3275             rule->ofpacts_len = fm->ofpacts_len;
3276             rule->ofproto->ofproto_class->rule_modify_actions(rule);
3277         } else {
3278             ofoperation_complete(op, 0);
3279         }
3280     }
3281     ofopgroup_submit(group);
3282
3283     return error;
3284 }
3285
3286 static enum ofperr
3287 modify_flows_add(struct ofproto *ofproto, struct ofconn *ofconn,
3288                  const struct ofputil_flow_mod *fm,
3289                  const struct ofp_header *request)
3290 {
3291     if (fm->cookie_mask != htonll(0) || fm->new_cookie == htonll(UINT64_MAX)) {
3292         return 0;
3293     }
3294     return add_flow(ofproto, ofconn, fm, request);
3295 }
3296
3297 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code on
3298  * failure.
3299  *
3300  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3301  * if any. */
3302 static enum ofperr
3303 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3304                    const struct ofputil_flow_mod *fm,
3305                    const struct ofp_header *request)
3306 {
3307     struct list rules;
3308     int error;
3309
3310     error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3311                                 fm->cookie, fm->cookie_mask,
3312                                 OFPP_ANY, &rules);
3313     if (error) {
3314         return error;
3315     } else if (list_is_empty(&rules)) {
3316         return modify_flows_add(ofproto, ofconn, fm, request);
3317     } else {
3318         return modify_flows__(ofproto, ofconn, fm, request, &rules);
3319     }
3320 }
3321
3322 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
3323  * code on failure.
3324  *
3325  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3326  * if any. */
3327 static enum ofperr
3328 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3329                    const struct ofputil_flow_mod *fm,
3330                    const struct ofp_header *request)
3331 {
3332     struct list rules;
3333     int error;
3334
3335     error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3336                                  fm->priority, fm->cookie, fm->cookie_mask,
3337                                  OFPP_ANY, &rules);
3338
3339     if (error) {
3340         return error;
3341     } else if (list_is_empty(&rules)) {
3342         return modify_flows_add(ofproto, ofconn, fm, request);
3343     } else {
3344         return list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
3345                                                           fm, request, &rules)
3346                                          : 0;
3347     }
3348 }
3349 \f
3350 /* OFPFC_DELETE implementation. */
3351
3352 static void
3353 delete_flow__(struct rule *rule, struct ofopgroup *group)
3354 {
3355     struct ofproto *ofproto = rule->ofproto;
3356
3357     ofproto_rule_send_removed(rule, OFPRR_DELETE);
3358
3359     ofoperation_create(group, rule, OFOPERATION_DELETE, OFPRR_DELETE);
3360     oftable_remove_rule(rule);
3361     ofproto->ofproto_class->rule_destruct(rule);
3362 }
3363
3364 /* Deletes the rules listed in 'rules'.
3365  *
3366  * Returns 0 on success, otherwise an OpenFlow error code. */
3367 static enum ofperr
3368 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
3369                const struct ofp_header *request, struct list *rules)
3370 {
3371     struct rule *rule, *next;
3372     struct ofopgroup *group;
3373
3374     group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
3375     LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
3376         delete_flow__(rule, group);
3377     }
3378     ofopgroup_submit(group);
3379
3380     return 0;
3381 }
3382
3383 /* Implements OFPFC_DELETE. */
3384 static enum ofperr
3385 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
3386                    const struct ofputil_flow_mod *fm,
3387                    const struct ofp_header *request)
3388 {
3389     struct list rules;
3390     enum ofperr error;
3391
3392     error = collect_rules_loose(ofproto, fm->table_id, &fm->match,
3393                                 fm->cookie, fm->cookie_mask,
3394                                 fm->out_port, &rules);
3395     return (error ? error
3396             : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
3397                                                       &rules)
3398             : 0);
3399 }
3400
3401 /* Implements OFPFC_DELETE_STRICT. */
3402 static enum ofperr
3403 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
3404                    const struct ofputil_flow_mod *fm,
3405                    const struct ofp_header *request)
3406 {
3407     struct list rules;
3408     enum ofperr error;
3409
3410     error = collect_rules_strict(ofproto, fm->table_id, &fm->match,
3411                                  fm->priority, fm->cookie, fm->cookie_mask,
3412                                  fm->out_port, &rules);
3413     return (error ? error
3414             : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
3415                                                          request, &rules)
3416             : 0);
3417 }
3418
3419 static void
3420 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
3421 {
3422     struct ofputil_flow_removed fr;
3423
3424     if (ofproto_rule_is_hidden(rule) || !rule->send_flow_removed) {
3425         return;
3426     }
3427
3428     minimatch_expand(&rule->cr.match, &fr.match);
3429     fr.priority = rule->cr.priority;
3430     fr.cookie = rule->flow_cookie;
3431     fr.reason = reason;
3432     fr.table_id = rule->table_id;
3433     calc_flow_duration__(rule->created, time_msec(),
3434                          &fr.duration_sec, &fr.duration_nsec);
3435     fr.idle_timeout = rule->idle_timeout;
3436     fr.hard_timeout = rule->hard_timeout;
3437     rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
3438                                                  &fr.byte_count);
3439
3440     connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
3441 }
3442
3443 void
3444 ofproto_rule_update_used(struct rule *rule, long long int used)
3445 {
3446     if (used > rule->used) {
3447         struct eviction_group *evg = rule->eviction_group;
3448
3449         rule->used = used;
3450         if (evg) {
3451             heap_change(&evg->rules, &rule->evg_node,
3452                         rule_eviction_priority(rule));
3453         }
3454     }
3455 }
3456
3457 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3458  * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3459  * ofproto.
3460  *
3461  * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3462  * NULL).
3463  *
3464  * ofproto implementation ->run() functions should use this function to expire
3465  * OpenFlow flows. */
3466 void
3467 ofproto_rule_expire(struct rule *rule, uint8_t reason)
3468 {
3469     struct ofproto *ofproto = rule->ofproto;
3470     struct ofopgroup *group;
3471
3472     ovs_assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
3473
3474     ofproto_rule_send_removed(rule, reason);
3475
3476     group = ofopgroup_create_unattached(ofproto);
3477     ofoperation_create(group, rule, OFOPERATION_DELETE, reason);
3478     oftable_remove_rule(rule);
3479     ofproto->ofproto_class->rule_destruct(rule);
3480     ofopgroup_submit(group);
3481 }
3482 \f
3483 static enum ofperr
3484 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
3485 {
3486     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3487     struct ofputil_flow_mod fm;
3488     uint64_t ofpacts_stub[1024 / 8];
3489     struct ofpbuf ofpacts;
3490     enum ofperr error;
3491     long long int now;
3492
3493     error = reject_slave_controller(ofconn);
3494     if (error) {
3495         goto exit;
3496     }
3497
3498     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
3499     error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_protocol(ofconn),
3500                                     &ofpacts);
3501     if (!error) {
3502         error = ofpacts_check(fm.ofpacts, fm.ofpacts_len,
3503                               &fm.match.flow, ofproto->max_ports);
3504     }
3505     if (!error) {
3506         error = handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
3507     }
3508     if (error) {
3509         goto exit_free_ofpacts;
3510     }
3511
3512     /* Record the operation for logging a summary report. */
3513     switch (fm.command) {
3514     case OFPFC_ADD:
3515         ofproto->n_add++;
3516         break;
3517
3518     case OFPFC_MODIFY:
3519     case OFPFC_MODIFY_STRICT:
3520         ofproto->n_modify++;
3521         break;
3522
3523     case OFPFC_DELETE:
3524     case OFPFC_DELETE_STRICT:
3525         ofproto->n_delete++;
3526         break;
3527     }
3528
3529     now = time_msec();
3530     if (ofproto->next_op_report == LLONG_MAX) {
3531         ofproto->first_op = now;
3532         ofproto->next_op_report = MAX(now + 10 * 1000,
3533                                       ofproto->op_backoff);
3534         ofproto->op_backoff = ofproto->next_op_report + 60 * 1000;
3535     }
3536     ofproto->last_op = now;
3537
3538 exit_free_ofpacts:
3539     ofpbuf_uninit(&ofpacts);
3540 exit:
3541     return error;
3542 }
3543
3544 static enum ofperr
3545 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
3546                   const struct ofputil_flow_mod *fm,
3547                   const struct ofp_header *oh)
3548 {
3549     if (ofproto->n_pending >= 50) {
3550         ovs_assert(!list_is_empty(&ofproto->pending));
3551         return OFPROTO_POSTPONE;
3552     }
3553
3554     switch (fm->command) {
3555     case OFPFC_ADD:
3556         return add_flow(ofproto, ofconn, fm, oh);
3557
3558     case OFPFC_MODIFY:
3559         return modify_flows_loose(ofproto, ofconn, fm, oh);
3560
3561     case OFPFC_MODIFY_STRICT:
3562         return modify_flow_strict(ofproto, ofconn, fm, oh);
3563
3564     case OFPFC_DELETE:
3565         return delete_flows_loose(ofproto, ofconn, fm, oh);
3566
3567     case OFPFC_DELETE_STRICT:
3568         return delete_flow_strict(ofproto, ofconn, fm, oh);
3569
3570     default:
3571         if (fm->command > 0xff) {
3572             VLOG_WARN_RL(&rl, "%s: flow_mod has explicit table_id but "
3573                          "flow_mod_table_id extension is not enabled",
3574                          ofproto->name);
3575         }
3576         return OFPERR_OFPFMFC_BAD_COMMAND;
3577     }
3578 }
3579
3580 static enum ofperr
3581 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
3582 {
3583     struct ofputil_role_request rr;
3584     struct ofpbuf *buf;
3585     uint32_t role;
3586     enum ofperr error;
3587
3588     error = ofputil_decode_role_message(oh, &rr);
3589     if (error) {
3590         return error;
3591     }
3592
3593     if (rr.request_current_role_only) {
3594         role = ofconn_get_role(ofconn); /* NX_ROLE_* */
3595         goto reply;
3596     }
3597
3598     role = rr.role;
3599
3600     if (ofconn_get_role(ofconn) != role
3601         && ofconn_has_pending_opgroups(ofconn)) {
3602         return OFPROTO_POSTPONE;
3603     }
3604
3605     if (rr.have_generation_id) {
3606         if (!ofconn_set_master_election_id(ofconn, rr.generation_id)) {
3607             return OFPERR_OFPRRFC_STALE;
3608         }
3609     }
3610
3611     ofconn_set_role(ofconn, role);
3612
3613 reply:
3614     buf = ofputil_encode_role_reply(oh, role);
3615     ofconn_send_reply(ofconn, buf);
3616
3617     return 0;
3618 }
3619
3620 static enum ofperr
3621 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
3622                              const struct ofp_header *oh)
3623 {
3624     const struct nx_flow_mod_table_id *msg = ofpmsg_body(oh);
3625     enum ofputil_protocol cur, next;
3626
3627     cur = ofconn_get_protocol(ofconn);
3628     next = ofputil_protocol_set_tid(cur, msg->set != 0);
3629     ofconn_set_protocol(ofconn, next);
3630
3631     return 0;
3632 }
3633
3634 static enum ofperr
3635 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
3636 {
3637     const struct nx_set_flow_format *msg = ofpmsg_body(oh);
3638     enum ofputil_protocol cur, next;
3639     enum ofputil_protocol next_base;
3640
3641     next_base = ofputil_nx_flow_format_to_protocol(ntohl(msg->format));
3642     if (!next_base) {
3643         return OFPERR_OFPBRC_EPERM;
3644     }
3645
3646     cur = ofconn_get_protocol(ofconn);
3647     next = ofputil_protocol_set_base(cur, next_base);
3648     if (cur != next && ofconn_has_pending_opgroups(ofconn)) {
3649         /* Avoid sending async messages in surprising protocol. */
3650         return OFPROTO_POSTPONE;
3651     }
3652
3653     ofconn_set_protocol(ofconn, next);
3654     return 0;
3655 }
3656
3657 static enum ofperr
3658 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
3659                                 const struct ofp_header *oh)
3660 {
3661     const struct nx_set_packet_in_format *msg = ofpmsg_body(oh);
3662     uint32_t format;
3663
3664     format = ntohl(msg->format);
3665     if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
3666         return OFPERR_OFPBRC_EPERM;
3667     }
3668
3669     if (format != ofconn_get_packet_in_format(ofconn)
3670         && ofconn_has_pending_opgroups(ofconn)) {
3671         /* Avoid sending async message in surprsing packet in format. */
3672         return OFPROTO_POSTPONE;
3673     }
3674
3675     ofconn_set_packet_in_format(ofconn, format);
3676     return 0;
3677 }
3678
3679 static enum ofperr
3680 handle_nxt_set_async_config(struct ofconn *ofconn, const struct ofp_header *oh)
3681 {
3682     const struct nx_async_config *msg = ofpmsg_body(oh);
3683     uint32_t master[OAM_N_TYPES];
3684     uint32_t slave[OAM_N_TYPES];
3685
3686     master[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[0]);
3687     master[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[0]);
3688     master[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[0]);
3689
3690     slave[OAM_PACKET_IN] = ntohl(msg->packet_in_mask[1]);
3691     slave[OAM_PORT_STATUS] = ntohl(msg->port_status_mask[1]);
3692     slave[OAM_FLOW_REMOVED] = ntohl(msg->flow_removed_mask[1]);
3693
3694     ofconn_set_async_config(ofconn, master, slave);
3695     if (ofconn_get_type(ofconn) == OFCONN_SERVICE &&
3696         !ofconn_get_miss_send_len(ofconn)) {
3697         ofconn_set_miss_send_len(ofconn, OFP_DEFAULT_MISS_SEND_LEN);
3698     }
3699
3700     return 0;
3701 }
3702
3703 static enum ofperr
3704 handle_nxt_set_controller_id(struct ofconn *ofconn,
3705                              const struct ofp_header *oh)
3706 {
3707     const struct nx_controller_id *nci = ofpmsg_body(oh);
3708
3709     if (!is_all_zeros(nci->zero, sizeof nci->zero)) {
3710         return OFPERR_NXBRC_MUST_BE_ZERO;
3711     }
3712
3713     ofconn_set_controller_id(ofconn, ntohs(nci->controller_id));
3714     return 0;
3715 }
3716
3717 static enum ofperr
3718 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
3719 {
3720     struct ofpbuf *buf;
3721
3722     if (ofconn_has_pending_opgroups(ofconn)) {
3723         return OFPROTO_POSTPONE;
3724     }
3725
3726     buf = ofpraw_alloc_reply((oh->version == OFP10_VERSION
3727                               ? OFPRAW_OFPT10_BARRIER_REPLY
3728                               : OFPRAW_OFPT11_BARRIER_REPLY), oh, 0);
3729     ofconn_send_reply(ofconn, buf);
3730     return 0;
3731 }
3732
3733 static void
3734 ofproto_compose_flow_refresh_update(const struct rule *rule,
3735                                     enum nx_flow_monitor_flags flags,
3736                                     struct list *msgs)
3737 {
3738     struct ofoperation *op = rule->pending;
3739     struct ofputil_flow_update fu;
3740     struct match match;
3741
3742     if (op && op->type == OFOPERATION_ADD && !op->victim) {
3743         /* We'll report the final flow when the operation completes.  Reporting
3744          * it now would cause a duplicate report later. */
3745         return;
3746     }
3747
3748     fu.event = (flags & (NXFMF_INITIAL | NXFMF_ADD)
3749                 ? NXFME_ADDED : NXFME_MODIFIED);
3750     fu.reason = 0;
3751     fu.idle_timeout = rule->idle_timeout;
3752     fu.hard_timeout = rule->hard_timeout;
3753     fu.table_id = rule->table_id;
3754     fu.cookie = rule->flow_cookie;
3755     minimatch_expand(&rule->cr.match, &match);
3756     fu.match = &match;
3757     fu.priority = rule->cr.priority;
3758     if (!(flags & NXFMF_ACTIONS)) {
3759         fu.ofpacts = NULL;
3760         fu.ofpacts_len = 0;
3761     } else if (!op) {
3762         fu.ofpacts = rule->ofpacts;
3763         fu.ofpacts_len = rule->ofpacts_len;
3764     } else {
3765         /* An operation is in progress.  Use the previous version of the flow's
3766          * actions, so that when the operation commits we report the change. */
3767         switch (op->type) {
3768         case OFOPERATION_ADD:
3769             /* We already verified that there was a victim. */
3770             fu.ofpacts = op->victim->ofpacts;
3771             fu.ofpacts_len = op->victim->ofpacts_len;
3772             break;
3773
3774         case OFOPERATION_MODIFY:
3775             if (op->ofpacts) {
3776                 fu.ofpacts = op->ofpacts;
3777                 fu.ofpacts_len = op->ofpacts_len;
3778             } else {
3779                 fu.ofpacts = rule->ofpacts;
3780                 fu.ofpacts_len = rule->ofpacts_len;
3781             }
3782             break;
3783
3784         case OFOPERATION_DELETE:
3785             fu.ofpacts = rule->ofpacts;
3786             fu.ofpacts_len = rule->ofpacts_len;
3787             break;
3788
3789         default:
3790             NOT_REACHED();
3791         }
3792     }
3793
3794     if (list_is_empty(msgs)) {
3795         ofputil_start_flow_update(msgs);
3796     }
3797     ofputil_append_flow_update(&fu, msgs);
3798 }
3799
3800 void
3801 ofmonitor_compose_refresh_updates(struct list *rules, struct list *msgs)
3802 {
3803     struct rule *rule;
3804
3805     LIST_FOR_EACH (rule, ofproto_node, rules) {
3806         enum nx_flow_monitor_flags flags = rule->monitor_flags;
3807         rule->monitor_flags = 0;
3808
3809         ofproto_compose_flow_refresh_update(rule, flags, msgs);
3810     }
3811 }
3812
3813 static void
3814 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor *m,
3815                                        struct rule *rule, uint64_t seqno,
3816                                        struct list *rules)
3817 {
3818     enum nx_flow_monitor_flags update;
3819
3820     if (ofproto_rule_is_hidden(rule)) {
3821         return;
3822     }
3823
3824     if (!(rule->pending
3825           ? ofoperation_has_out_port(rule->pending, m->out_port)
3826           : ofproto_rule_has_out_port(rule, m->out_port))) {
3827         return;
3828     }
3829
3830     if (seqno) {
3831         if (rule->add_seqno > seqno) {
3832             update = NXFMF_ADD | NXFMF_MODIFY;
3833         } else if (rule->modify_seqno > seqno) {
3834             update = NXFMF_MODIFY;
3835         } else {
3836             return;
3837         }
3838
3839         if (!(m->flags & update)) {
3840             return;
3841         }
3842     } else {
3843         update = NXFMF_INITIAL;
3844     }
3845
3846     if (!rule->monitor_flags) {
3847         list_push_back(rules, &rule->ofproto_node);
3848     }
3849     rule->monitor_flags |= update | (m->flags & NXFMF_ACTIONS);
3850 }
3851
3852 static void
3853 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor *m,
3854                                         uint64_t seqno,
3855                                         struct list *rules)
3856 {
3857     const struct ofproto *ofproto = ofconn_get_ofproto(m->ofconn);
3858     const struct ofoperation *op;
3859     const struct oftable *table;
3860     struct cls_rule target;
3861
3862     cls_rule_init_from_minimatch(&target, &m->match, 0);
3863     FOR_EACH_MATCHING_TABLE (table, m->table_id, ofproto) {
3864         struct cls_cursor cursor;
3865         struct rule *rule;
3866
3867         cls_cursor_init(&cursor, &table->cls, &target);
3868         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
3869             ovs_assert(!rule->pending); /* XXX */
3870             ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3871         }
3872     }
3873
3874     HMAP_FOR_EACH (op, hmap_node, &ofproto->deletions) {
3875         struct rule *rule = op->rule;
3876
3877         if (((m->table_id == 0xff
3878               ? !(ofproto->tables[rule->table_id].flags & OFTABLE_HIDDEN)
3879               : m->table_id == rule->table_id))
3880             && cls_rule_is_loose_match(&rule->cr, &target.match)) {
3881             ofproto_collect_ofmonitor_refresh_rule(m, rule, seqno, rules);
3882         }
3883     }
3884     cls_rule_destroy(&target);
3885 }
3886
3887 static void
3888 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor *m,
3889                                         struct list *rules)
3890 {
3891     if (m->flags & NXFMF_INITIAL) {
3892         ofproto_collect_ofmonitor_refresh_rules(m, 0, rules);
3893     }
3894 }
3895
3896 void
3897 ofmonitor_collect_resume_rules(struct ofmonitor *m,
3898                                uint64_t seqno, struct list *rules)
3899 {
3900     ofproto_collect_ofmonitor_refresh_rules(m, seqno, rules);
3901 }
3902
3903 static enum ofperr
3904 handle_flow_monitor_request(struct ofconn *ofconn, const struct ofp_header *oh)
3905 {
3906     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
3907     struct ofmonitor **monitors;
3908     size_t n_monitors, allocated_monitors;
3909     struct list replies;
3910     enum ofperr error;
3911     struct list rules;
3912     struct ofpbuf b;
3913     size_t i;
3914
3915     error = 0;
3916     ofpbuf_use_const(&b, oh, ntohs(oh->length));
3917     monitors = NULL;
3918     n_monitors = allocated_monitors = 0;
3919     for (;;) {
3920         struct ofputil_flow_monitor_request request;
3921         struct ofmonitor *m;
3922         int retval;
3923
3924         retval = ofputil_decode_flow_monitor_request(&request, &b);
3925         if (retval == EOF) {
3926             break;
3927         } else if (retval) {
3928             error = retval;
3929             goto error;
3930         }
3931
3932         if (request.table_id != 0xff
3933             && request.table_id >= ofproto->n_tables) {
3934             error = OFPERR_OFPBRC_BAD_TABLE_ID;
3935             goto error;
3936         }
3937
3938         error = ofmonitor_create(&request, ofconn, &m);
3939         if (error) {
3940             goto error;
3941         }
3942
3943         if (n_monitors >= allocated_monitors) {
3944             monitors = x2nrealloc(monitors, &allocated_monitors,
3945                                   sizeof *monitors);
3946         }
3947         monitors[n_monitors++] = m;
3948     }
3949
3950     list_init(&rules);
3951     for (i = 0; i < n_monitors; i++) {
3952         ofproto_collect_ofmonitor_initial_rules(monitors[i], &rules);
3953     }
3954
3955     ofpmp_init(&replies, oh);
3956     ofmonitor_compose_refresh_updates(&rules, &replies);
3957     ofconn_send_replies(ofconn, &replies);
3958
3959     free(monitors);
3960
3961     return 0;
3962
3963 error:
3964     for (i = 0; i < n_monitors; i++) {
3965         ofmonitor_destroy(monitors[i]);
3966     }
3967     free(monitors);
3968     return error;
3969 }
3970
3971 static enum ofperr
3972 handle_flow_monitor_cancel(struct ofconn *ofconn, const struct ofp_header *oh)
3973 {
3974     struct ofmonitor *m;
3975     uint32_t id;
3976
3977     id = ofputil_decode_flow_monitor_cancel(oh);
3978     m = ofmonitor_lookup(ofconn, id);
3979     if (!m) {
3980         return OFPERR_NXBRC_FM_BAD_ID;
3981     }
3982
3983     ofmonitor_destroy(m);
3984     return 0;
3985 }
3986
3987 static enum ofperr
3988 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
3989 {
3990     const struct ofp_header *oh = msg->data;
3991     enum ofptype type;
3992     enum ofperr error;
3993
3994     error = ofptype_decode(&type, oh);
3995     if (error) {
3996         return error;
3997     }
3998
3999     switch (type) {
4000         /* OpenFlow requests. */
4001     case OFPTYPE_ECHO_REQUEST:
4002         return handle_echo_request(ofconn, oh);
4003
4004     case OFPTYPE_FEATURES_REQUEST:
4005         return handle_features_request(ofconn, oh);
4006
4007     case OFPTYPE_GET_CONFIG_REQUEST:
4008         return handle_get_config_request(ofconn, oh);
4009
4010     case OFPTYPE_SET_CONFIG:
4011         return handle_set_config(ofconn, oh);
4012
4013     case OFPTYPE_PACKET_OUT:
4014         return handle_packet_out(ofconn, oh);
4015
4016     case OFPTYPE_PORT_MOD:
4017         return handle_port_mod(ofconn, oh);
4018
4019     case OFPTYPE_FLOW_MOD:
4020         return handle_flow_mod(ofconn, oh);
4021
4022     case OFPTYPE_BARRIER_REQUEST:
4023         return handle_barrier_request(ofconn, oh);
4024
4025     case OFPTYPE_ROLE_REQUEST:
4026         return handle_role_request(ofconn, oh);
4027
4028         /* OpenFlow replies. */
4029     case OFPTYPE_ECHO_REPLY:
4030         return 0;
4031
4032         /* Nicira extension requests. */
4033     case OFPTYPE_FLOW_MOD_TABLE_ID:
4034         return handle_nxt_flow_mod_table_id(ofconn, oh);
4035
4036     case OFPTYPE_SET_FLOW_FORMAT:
4037         return handle_nxt_set_flow_format(ofconn, oh);
4038
4039     case OFPTYPE_SET_PACKET_IN_FORMAT:
4040         return handle_nxt_set_packet_in_format(ofconn, oh);
4041
4042     case OFPTYPE_SET_CONTROLLER_ID:
4043         return handle_nxt_set_controller_id(ofconn, oh);
4044
4045     case OFPTYPE_FLOW_AGE:
4046         /* Nothing to do. */
4047         return 0;
4048
4049     case OFPTYPE_FLOW_MONITOR_CANCEL:
4050         return handle_flow_monitor_cancel(ofconn, oh);
4051
4052     case OFPTYPE_SET_ASYNC_CONFIG:
4053         return handle_nxt_set_async_config(ofconn, oh);
4054
4055         /* Statistics requests. */
4056     case OFPTYPE_DESC_STATS_REQUEST:
4057         return handle_desc_stats_request(ofconn, oh);
4058
4059     case OFPTYPE_FLOW_STATS_REQUEST:
4060         return handle_flow_stats_request(ofconn, oh);
4061
4062     case OFPTYPE_AGGREGATE_STATS_REQUEST:
4063         return handle_aggregate_stats_request(ofconn, oh);
4064
4065     case OFPTYPE_TABLE_STATS_REQUEST:
4066         return handle_table_stats_request(ofconn, oh);
4067
4068     case OFPTYPE_PORT_STATS_REQUEST:
4069         return handle_port_stats_request(ofconn, oh);
4070
4071     case OFPTYPE_QUEUE_STATS_REQUEST:
4072         return handle_queue_stats_request(ofconn, oh);
4073
4074     case OFPTYPE_PORT_DESC_STATS_REQUEST:
4075         return handle_port_desc_stats_request(ofconn, oh);
4076
4077     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
4078         return handle_flow_monitor_request(ofconn, oh);
4079
4080         /* FIXME: Change the following once they are implemented: */
4081     case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
4082     case OFPTYPE_GET_ASYNC_REQUEST:
4083     case OFPTYPE_METER_MOD:
4084     case OFPTYPE_GROUP_REQUEST:
4085     case OFPTYPE_GROUP_DESC_REQUEST:
4086     case OFPTYPE_GROUP_FEATURES_REQUEST:
4087     case OFPTYPE_METER_REQUEST:
4088     case OFPTYPE_METER_CONFIG_REQUEST:
4089     case OFPTYPE_METER_FEATURES_REQUEST:
4090     case OFPTYPE_TABLE_FEATURES_REQUEST:
4091         return OFPERR_OFPBRC_BAD_TYPE;
4092
4093     case OFPTYPE_HELLO:
4094     case OFPTYPE_ERROR:
4095     case OFPTYPE_FEATURES_REPLY:
4096     case OFPTYPE_GET_CONFIG_REPLY:
4097     case OFPTYPE_PACKET_IN:
4098     case OFPTYPE_FLOW_REMOVED:
4099     case OFPTYPE_PORT_STATUS:
4100     case OFPTYPE_BARRIER_REPLY:
4101     case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
4102     case OFPTYPE_DESC_STATS_REPLY:
4103     case OFPTYPE_FLOW_STATS_REPLY:
4104     case OFPTYPE_QUEUE_STATS_REPLY:
4105     case OFPTYPE_PORT_STATS_REPLY:
4106     case OFPTYPE_TABLE_STATS_REPLY:
4107     case OFPTYPE_AGGREGATE_STATS_REPLY:
4108     case OFPTYPE_PORT_DESC_STATS_REPLY:
4109     case OFPTYPE_ROLE_REPLY:
4110     case OFPTYPE_FLOW_MONITOR_PAUSED:
4111     case OFPTYPE_FLOW_MONITOR_RESUMED:
4112     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
4113     case OFPTYPE_GET_ASYNC_REPLY:
4114     case OFPTYPE_GROUP_REPLY:
4115     case OFPTYPE_GROUP_DESC_REPLY:
4116     case OFPTYPE_GROUP_FEATURES_REPLY:
4117     case OFPTYPE_METER_REPLY:
4118     case OFPTYPE_METER_CONFIG_REPLY:
4119     case OFPTYPE_METER_FEATURES_REPLY:
4120     case OFPTYPE_TABLE_FEATURES_REPLY:
4121     default:
4122         return OFPERR_OFPBRC_BAD_TYPE;
4123     }
4124 }
4125
4126 static bool
4127 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
4128 {
4129     int error = handle_openflow__(ofconn, ofp_msg);
4130     if (error && error != OFPROTO_POSTPONE) {
4131         ofconn_send_error(ofconn, ofp_msg->data, error);
4132     }
4133     COVERAGE_INC(ofproto_recv_openflow);
4134     return error != OFPROTO_POSTPONE;
4135 }
4136 \f
4137 /* Asynchronous operations. */
4138
4139 /* Creates and returns a new ofopgroup that is not associated with any
4140  * OpenFlow connection.
4141  *
4142  * The caller should add operations to the returned group with
4143  * ofoperation_create() and then submit it with ofopgroup_submit(). */
4144 static struct ofopgroup *
4145 ofopgroup_create_unattached(struct ofproto *ofproto)
4146 {
4147     struct ofopgroup *group = xzalloc(sizeof *group);
4148     group->ofproto = ofproto;
4149     list_init(&group->ofproto_node);
4150     list_init(&group->ops);
4151     list_init(&group->ofconn_node);
4152     return group;
4153 }
4154
4155 /* Creates and returns a new ofopgroup for 'ofproto'.
4156  *
4157  * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
4158  * connection.  The 'request' and 'buffer_id' arguments are ignored.
4159  *
4160  * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
4161  * If the ofopgroup eventually fails, then the error reply will include
4162  * 'request'.  If the ofopgroup eventually succeeds, then the packet with
4163  * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
4164  *
4165  * The caller should add operations to the returned group with
4166  * ofoperation_create() and then submit it with ofopgroup_submit(). */
4167 static struct ofopgroup *
4168 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
4169                  const struct ofp_header *request, uint32_t buffer_id)
4170 {
4171     struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
4172     if (ofconn) {
4173         size_t request_len = ntohs(request->length);
4174
4175         ovs_assert(ofconn_get_ofproto(ofconn) == ofproto);
4176
4177         ofconn_add_opgroup(ofconn, &group->ofconn_node);
4178         group->ofconn = ofconn;
4179         group->request = xmemdup(request, MIN(request_len, 64));
4180         group->buffer_id = buffer_id;
4181     }
4182     return group;
4183 }
4184
4185 /* Submits 'group' for processing.
4186  *
4187  * If 'group' contains no operations (e.g. none were ever added, or all of the
4188  * ones that were added completed synchronously), then it is destroyed
4189  * immediately.  Otherwise it is added to the ofproto's list of pending
4190  * groups. */
4191 static void
4192 ofopgroup_submit(struct ofopgroup *group)
4193 {
4194     if (!group->n_running) {
4195         ofopgroup_complete(group);
4196     } else {
4197         list_push_back(&group->ofproto->pending, &group->ofproto_node);
4198         group->ofproto->n_pending++;
4199     }
4200 }
4201
4202 static void
4203 ofopgroup_complete(struct ofopgroup *group)
4204 {
4205     struct ofproto *ofproto = group->ofproto;
4206
4207     struct ofconn *abbrev_ofconn;
4208     ovs_be32 abbrev_xid;
4209
4210     struct ofoperation *op, *next_op;
4211     int error;
4212
4213     ovs_assert(!group->n_running);
4214
4215     error = 0;
4216     LIST_FOR_EACH (op, group_node, &group->ops) {
4217         if (op->error) {
4218             error = op->error;
4219             break;
4220         }
4221     }
4222
4223     if (!error && group->ofconn && group->buffer_id != UINT32_MAX) {
4224         LIST_FOR_EACH (op, group_node, &group->ops) {
4225             if (op->type != OFOPERATION_DELETE) {
4226                 struct ofpbuf *packet;
4227                 uint16_t in_port;
4228
4229                 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
4230                                                &packet, &in_port);
4231                 if (packet) {
4232                     ovs_assert(!error);
4233                     error = rule_execute(op->rule, in_port, packet);
4234                 }
4235                 break;
4236             }
4237         }
4238     }
4239
4240     if (!error && !list_is_empty(&group->ofconn_node)) {
4241         abbrev_ofconn = group->ofconn;
4242         abbrev_xid = group->request->xid;
4243     } else {
4244         abbrev_ofconn = NULL;
4245         abbrev_xid = htonl(0);
4246     }
4247     LIST_FOR_EACH_SAFE (op, next_op, group_node, &group->ops) {
4248         struct rule *rule = op->rule;
4249
4250         if (!op->error && !ofproto_rule_is_hidden(rule)) {
4251             /* Check that we can just cast from ofoperation_type to
4252              * nx_flow_update_event. */
4253             BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_ADD
4254                               == NXFME_ADDED);
4255             BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_DELETE
4256                               == NXFME_DELETED);
4257             BUILD_ASSERT_DECL((enum nx_flow_update_event) OFOPERATION_MODIFY
4258                               == NXFME_MODIFIED);
4259
4260             ofmonitor_report(ofproto->connmgr, rule,
4261                              (enum nx_flow_update_event) op->type,
4262                              op->reason, abbrev_ofconn, abbrev_xid);
4263         }
4264
4265         rule->pending = NULL;
4266
4267         switch (op->type) {
4268         case OFOPERATION_ADD:
4269             if (!op->error) {
4270                 uint16_t vid_mask;
4271
4272                 ofproto_rule_destroy__(op->victim);
4273                 vid_mask = minimask_get_vid_mask(&rule->cr.match.mask);
4274                 if (vid_mask == VLAN_VID_MASK) {
4275                     if (ofproto->vlan_bitmap) {
4276                         uint16_t vid = miniflow_get_vid(&rule->cr.match.flow);
4277                         if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
4278                             bitmap_set1(ofproto->vlan_bitmap, vid);
4279                             ofproto->vlans_changed = true;
4280                         }
4281                     } else {
4282                         ofproto->vlans_changed = true;
4283                     }
4284                 }
4285             } else {
4286                 oftable_substitute_rule(rule, op->victim);
4287                 ofproto_rule_destroy__(rule);
4288             }
4289             break;
4290
4291         case OFOPERATION_DELETE:
4292             ovs_assert(!op->error);
4293             ofproto_rule_destroy__(rule);
4294             op->rule = NULL;
4295             break;
4296
4297         case OFOPERATION_MODIFY:
4298             if (!op->error) {
4299                 rule->modified = time_msec();
4300             } else {
4301                 rule->flow_cookie = op->flow_cookie;
4302                 if (op->ofpacts) {
4303                     free(rule->ofpacts);
4304                     rule->ofpacts = op->ofpacts;
4305                     rule->ofpacts_len = op->ofpacts_len;
4306                     op->ofpacts = NULL;
4307                     op->ofpacts_len = 0;
4308                 }
4309             }
4310             break;
4311
4312         default:
4313             NOT_REACHED();
4314         }
4315
4316         ofoperation_destroy(op);
4317     }
4318
4319     ofmonitor_flush(ofproto->connmgr);
4320
4321     if (!list_is_empty(&group->ofproto_node)) {
4322         ovs_assert(ofproto->n_pending > 0);
4323         ofproto->n_pending--;
4324         list_remove(&group->ofproto_node);
4325     }
4326     if (!list_is_empty(&group->ofconn_node)) {
4327         list_remove(&group->ofconn_node);
4328         if (error) {
4329             ofconn_send_error(group->ofconn, group->request, error);
4330         }
4331         connmgr_retry(ofproto->connmgr);
4332     }
4333     free(group->request);
4334     free(group);
4335 }
4336
4337 /* Initiates a new operation on 'rule', of the specified 'type', within
4338  * 'group'.  Prior to calling, 'rule' must not have any pending operation.
4339  *
4340  * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4341  * the flow is being deleted.  For other 'type's, 'reason' is ignored (use 0).
4342  *
4343  * Returns the newly created ofoperation (which is also available as
4344  * rule->pending). */
4345 static struct ofoperation *
4346 ofoperation_create(struct ofopgroup *group, struct rule *rule,
4347                    enum ofoperation_type type,
4348                    enum ofp_flow_removed_reason reason)
4349 {
4350     struct ofproto *ofproto = group->ofproto;
4351     struct ofoperation *op;
4352
4353     ovs_assert(!rule->pending);
4354
4355     op = rule->pending = xzalloc(sizeof *op);
4356     op->group = group;
4357     list_push_back(&group->ops, &op->group_node);
4358     op->rule = rule;
4359     op->type = type;
4360     op->reason = reason;
4361     op->flow_cookie = rule->flow_cookie;
4362
4363     group->n_running++;
4364
4365     if (type == OFOPERATION_DELETE) {
4366         hmap_insert(&ofproto->deletions, &op->hmap_node,
4367                     cls_rule_hash(&rule->cr, rule->table_id));
4368     }
4369
4370     return op;
4371 }
4372
4373 static void
4374 ofoperation_destroy(struct ofoperation *op)
4375 {
4376     struct ofopgroup *group = op->group;
4377
4378     if (op->rule) {
4379         op->rule->pending = NULL;
4380     }
4381     if (op->type == OFOPERATION_DELETE) {
4382         hmap_remove(&group->ofproto->deletions, &op->hmap_node);
4383     }
4384     list_remove(&op->group_node);
4385     free(op->ofpacts);
4386     free(op);
4387 }
4388
4389 /* Indicates that 'op' completed with status 'error', which is either 0 to
4390  * indicate success or an OpenFlow error code on failure.
4391  *
4392  * If 'error' is 0, indicating success, the operation will be committed
4393  * permanently to the flow table.  There is one interesting subcase:
4394  *
4395  *   - If 'op' is an "add flow" operation that is replacing an existing rule in
4396  *     the flow table (the "victim" rule) by a new one, then the caller must
4397  *     have uninitialized any derived state in the victim rule, as in step 5 in
4398  *     the "Life Cycle" in ofproto/ofproto-provider.h.  ofoperation_complete()
4399  *     performs steps 6 and 7 for the victim rule, most notably by calling its
4400  *     ->rule_dealloc() function.
4401  *
4402  * If 'error' is nonzero, then generally the operation will be rolled back:
4403  *
4404  *   - If 'op' is an "add flow" operation, ofproto removes the new rule or
4405  *     restores the original rule.  The caller must have uninitialized any
4406  *     derived state in the new rule, as in step 5 of in the "Life Cycle" in
4407  *     ofproto/ofproto-provider.h.  ofoperation_complete() performs steps 6 and
4408  *     and 7 for the new rule, calling its ->rule_dealloc() function.
4409  *
4410  *   - If 'op' is a "modify flow" operation, ofproto restores the original
4411  *     actions.
4412  *
4413  *   - 'op' must not be a "delete flow" operation.  Removing a rule is not
4414  *     allowed to fail.  It must always succeed.
4415  *
4416  * Please see the large comment in ofproto/ofproto-provider.h titled
4417  * "Asynchronous Operation Support" for more information. */
4418 void
4419 ofoperation_complete(struct ofoperation *op, enum ofperr error)
4420 {
4421     struct ofopgroup *group = op->group;
4422
4423     ovs_assert(op->rule->pending == op);
4424     ovs_assert(group->n_running > 0);
4425     ovs_assert(!error || op->type != OFOPERATION_DELETE);
4426
4427     op->error = error;
4428     if (!--group->n_running && !list_is_empty(&group->ofproto_node)) {
4429         ofopgroup_complete(group);
4430     }
4431 }
4432
4433 struct rule *
4434 ofoperation_get_victim(struct ofoperation *op)
4435 {
4436     ovs_assert(op->type == OFOPERATION_ADD);
4437     return op->victim;
4438 }
4439 \f
4440 static uint64_t
4441 pick_datapath_id(const struct ofproto *ofproto)
4442 {
4443     const struct ofport *port;
4444
4445     port = ofproto_get_port(ofproto, OFPP_LOCAL);
4446     if (port) {
4447         uint8_t ea[ETH_ADDR_LEN];
4448         int error;
4449
4450         error = netdev_get_etheraddr(port->netdev, ea);
4451         if (!error) {
4452             return eth_addr_to_uint64(ea);
4453         }
4454         VLOG_WARN("%s: could not get MAC address for %s (%s)",
4455                   ofproto->name, netdev_get_name(port->netdev),
4456                   strerror(error));
4457     }
4458     return ofproto->fallback_dpid;
4459 }
4460
4461 static uint64_t
4462 pick_fallback_dpid(void)
4463 {
4464     uint8_t ea[ETH_ADDR_LEN];
4465     eth_addr_nicira_random(ea);
4466     return eth_addr_to_uint64(ea);
4467 }
4468 \f
4469 /* Table overflow policy. */
4470
4471 /* Chooses and returns a rule to evict from 'table'.  Returns NULL if the table
4472  * is not configured to evict rules or if the table contains no evictable
4473  * rules.  (Rules with 'evictable' set to false or with no timeouts are not
4474  * evictable.) */
4475 static struct rule *
4476 choose_rule_to_evict(struct oftable *table)
4477 {
4478     struct eviction_group *evg;
4479
4480     if (!table->eviction_fields) {
4481         return NULL;
4482     }
4483
4484     /* In the common case, the outer and inner loops here will each be entered
4485      * exactly once:
4486      *
4487      *   - The inner loop normally "return"s in its first iteration.  If the
4488      *     eviction group has any evictable rules, then it always returns in
4489      *     some iteration.
4490      *
4491      *   - The outer loop only iterates more than once if the largest eviction
4492      *     group has no evictable rules.
4493      *
4494      *   - The outer loop can exit only if table's 'max_flows' is all filled up
4495      *     by unevictable rules'. */
4496     HEAP_FOR_EACH (evg, size_node, &table->eviction_groups_by_size) {
4497         struct rule *rule;
4498
4499         HEAP_FOR_EACH (rule, evg_node, &evg->rules) {
4500             if (rule->evictable) {
4501                 return rule;
4502             }
4503         }
4504     }
4505
4506     return NULL;
4507 }
4508
4509 /* Searches 'ofproto' for tables that have more flows than their configured
4510  * maximum and that have flow eviction enabled, and evicts as many flows as
4511  * necessary and currently feasible from them.
4512  *
4513  * This triggers only when an OpenFlow table has N flows in it and then the
4514  * client configures a maximum number of flows less than N. */
4515 static void
4516 ofproto_evict(struct ofproto *ofproto)
4517 {
4518     struct ofopgroup *group;
4519     struct oftable *table;
4520
4521     group = ofopgroup_create_unattached(ofproto);
4522     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
4523         while (classifier_count(&table->cls) > table->max_flows
4524                && table->eviction_fields) {
4525             struct rule *rule;
4526
4527             rule = choose_rule_to_evict(table);
4528             if (!rule || rule->pending) {
4529                 break;
4530             }
4531
4532             ofoperation_create(group, rule,
4533                                OFOPERATION_DELETE, OFPRR_EVICTION);
4534             oftable_remove_rule(rule);
4535             ofproto->ofproto_class->rule_destruct(rule);
4536         }
4537     }
4538     ofopgroup_submit(group);
4539 }
4540 \f
4541 /* Eviction groups. */
4542
4543 /* Returns the priority to use for an eviction_group that contains 'n_rules'
4544  * rules.  The priority contains low-order random bits to ensure that eviction
4545  * groups with the same number of rules are prioritized randomly. */
4546 static uint32_t
4547 eviction_group_priority(size_t n_rules)
4548 {
4549     uint16_t size = MIN(UINT16_MAX, n_rules);
4550     return (size << 16) | random_uint16();
4551 }
4552
4553 /* Updates 'evg', an eviction_group within 'table', following a change that
4554  * adds or removes rules in 'evg'. */
4555 static void
4556 eviction_group_resized(struct oftable *table, struct eviction_group *evg)
4557 {
4558     heap_change(&table->eviction_groups_by_size, &evg->size_node,
4559                 eviction_group_priority(heap_count(&evg->rules)));
4560 }
4561
4562 /* Destroys 'evg', an eviction_group within 'table':
4563  *
4564  *   - Removes all the rules, if any, from 'evg'.  (It doesn't destroy the
4565  *     rules themselves, just removes them from the eviction group.)
4566  *
4567  *   - Removes 'evg' from 'table'.
4568  *
4569  *   - Frees 'evg'. */
4570 static void
4571 eviction_group_destroy(struct oftable *table, struct eviction_group *evg)
4572 {
4573     while (!heap_is_empty(&evg->rules)) {
4574         struct rule *rule;
4575
4576         rule = CONTAINER_OF(heap_pop(&evg->rules), struct rule, evg_node);
4577         rule->eviction_group = NULL;
4578     }
4579     hmap_remove(&table->eviction_groups_by_id, &evg->id_node);
4580     heap_remove(&table->eviction_groups_by_size, &evg->size_node);
4581     heap_destroy(&evg->rules);
4582     free(evg);
4583 }
4584
4585 /* Removes 'rule' from its eviction group, if any. */
4586 static void
4587 eviction_group_remove_rule(struct rule *rule)
4588 {
4589     if (rule->eviction_group) {
4590         struct oftable *table = &rule->ofproto->tables[rule->table_id];
4591         struct eviction_group *evg = rule->eviction_group;
4592
4593         rule->eviction_group = NULL;
4594         heap_remove(&evg->rules, &rule->evg_node);
4595         if (heap_is_empty(&evg->rules)) {
4596             eviction_group_destroy(table, evg);
4597         } else {
4598             eviction_group_resized(table, evg);
4599         }
4600     }
4601 }
4602
4603 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
4604  * returns the hash value. */
4605 static uint32_t
4606 eviction_group_hash_rule(struct rule *rule)
4607 {
4608     struct oftable *table = &rule->ofproto->tables[rule->table_id];
4609     const struct mf_subfield *sf;
4610     struct flow flow;
4611     uint32_t hash;
4612
4613     hash = table->eviction_group_id_basis;
4614     miniflow_expand(&rule->cr.match.flow, &flow);
4615     for (sf = table->eviction_fields;
4616          sf < &table->eviction_fields[table->n_eviction_fields];
4617          sf++)
4618     {
4619         if (mf_are_prereqs_ok(sf->field, &flow)) {
4620             union mf_value value;
4621
4622             mf_get_value(sf->field, &flow, &value);
4623             if (sf->ofs) {
4624                 bitwise_zero(&value, sf->field->n_bytes, 0, sf->ofs);
4625             }
4626             if (sf->ofs + sf->n_bits < sf->field->n_bytes * 8) {
4627                 unsigned int start = sf->ofs + sf->n_bits;
4628                 bitwise_zero(&value, sf->field->n_bytes, start,
4629                              sf->field->n_bytes * 8 - start);
4630             }
4631             hash = hash_bytes(&value, sf->field->n_bytes, hash);
4632         } else {
4633             hash = hash_int(hash, 0);
4634         }
4635     }
4636
4637     return hash;
4638 }
4639
4640 /* Returns an eviction group within 'table' with the given 'id', creating one
4641  * if necessary. */
4642 static struct eviction_group *
4643 eviction_group_find(struct oftable *table, uint32_t id)
4644 {
4645     struct eviction_group *evg;
4646
4647     HMAP_FOR_EACH_WITH_HASH (evg, id_node, id, &table->eviction_groups_by_id) {
4648         return evg;
4649     }
4650
4651     evg = xmalloc(sizeof *evg);
4652     hmap_insert(&table->eviction_groups_by_id, &evg->id_node, id);
4653     heap_insert(&table->eviction_groups_by_size, &evg->size_node,
4654                 eviction_group_priority(0));
4655     heap_init(&evg->rules);
4656
4657     return evg;
4658 }
4659
4660 /* Returns an eviction priority for 'rule'.  The return value should be
4661  * interpreted so that higher priorities make a rule more attractive candidates
4662  * for eviction. */
4663 static uint32_t
4664 rule_eviction_priority(struct rule *rule)
4665 {
4666     long long int hard_expiration;
4667     long long int idle_expiration;
4668     long long int expiration;
4669     uint32_t expiration_offset;
4670
4671     /* Calculate time of expiration. */
4672     hard_expiration = (rule->hard_timeout
4673                        ? rule->modified + rule->hard_timeout * 1000
4674                        : LLONG_MAX);
4675     idle_expiration = (rule->idle_timeout
4676                        ? rule->used + rule->idle_timeout * 1000
4677                        : LLONG_MAX);
4678     expiration = MIN(hard_expiration, idle_expiration);
4679     if (expiration == LLONG_MAX) {
4680         return 0;
4681     }
4682
4683     /* Calculate the time of expiration as a number of (approximate) seconds
4684      * after program startup.
4685      *
4686      * This should work OK for program runs that last UINT32_MAX seconds or
4687      * less.  Therefore, please restart OVS at least once every 136 years. */
4688     expiration_offset = (expiration >> 10) - (time_boot_msec() >> 10);
4689
4690     /* Invert the expiration offset because we're using a max-heap. */
4691     return UINT32_MAX - expiration_offset;
4692 }
4693
4694 /* Adds 'rule' to an appropriate eviction group for its oftable's
4695  * configuration.  Does nothing if 'rule''s oftable doesn't have eviction
4696  * enabled, or if 'rule' is a permanent rule (one that will never expire on its
4697  * own).
4698  *
4699  * The caller must ensure that 'rule' is not already in an eviction group. */
4700 static void
4701 eviction_group_add_rule(struct rule *rule)
4702 {
4703     struct ofproto *ofproto = rule->ofproto;
4704     struct oftable *table = &ofproto->tables[rule->table_id];
4705
4706     if (table->eviction_fields
4707         && (rule->hard_timeout || rule->idle_timeout)) {
4708         struct eviction_group *evg;
4709
4710         evg = eviction_group_find(table, eviction_group_hash_rule(rule));
4711
4712         rule->eviction_group = evg;
4713         heap_insert(&evg->rules, &rule->evg_node,
4714                     rule_eviction_priority(rule));
4715         eviction_group_resized(table, evg);
4716     }
4717 }
4718 \f
4719 /* oftables. */
4720
4721 /* Initializes 'table'. */
4722 static void
4723 oftable_init(struct oftable *table)
4724 {
4725     memset(table, 0, sizeof *table);
4726     classifier_init(&table->cls);
4727     table->max_flows = UINT_MAX;
4728 }
4729
4730 /* Destroys 'table', including its classifier and eviction groups.
4731  *
4732  * The caller is responsible for freeing 'table' itself. */
4733 static void
4734 oftable_destroy(struct oftable *table)
4735 {
4736     ovs_assert(classifier_is_empty(&table->cls));
4737     oftable_disable_eviction(table);
4738     classifier_destroy(&table->cls);
4739     free(table->name);
4740 }
4741
4742 /* Changes the name of 'table' to 'name'.  If 'name' is NULL or the empty
4743  * string, then 'table' will use its default name.
4744  *
4745  * This only affects the name exposed for a table exposed through the OpenFlow
4746  * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
4747 static void
4748 oftable_set_name(struct oftable *table, const char *name)
4749 {
4750     if (name && name[0]) {
4751         int len = strnlen(name, OFP_MAX_TABLE_NAME_LEN);
4752         if (!table->name || strncmp(name, table->name, len)) {
4753             free(table->name);
4754             table->name = xmemdup0(name, len);
4755         }
4756     } else {
4757         free(table->name);
4758         table->name = NULL;
4759     }
4760 }
4761
4762 /* oftables support a choice of two policies when adding a rule would cause the
4763  * number of flows in the table to exceed the configured maximum number: either
4764  * they can refuse to add the new flow or they can evict some existing flow.
4765  * This function configures the former policy on 'table'. */
4766 static void
4767 oftable_disable_eviction(struct oftable *table)
4768 {
4769     if (table->eviction_fields) {
4770         struct eviction_group *evg, *next;
4771
4772         HMAP_FOR_EACH_SAFE (evg, next, id_node,
4773                             &table->eviction_groups_by_id) {
4774             eviction_group_destroy(table, evg);
4775         }
4776         hmap_destroy(&table->eviction_groups_by_id);
4777         heap_destroy(&table->eviction_groups_by_size);
4778
4779         free(table->eviction_fields);
4780         table->eviction_fields = NULL;
4781         table->n_eviction_fields = 0;
4782     }
4783 }
4784
4785 /* oftables support a choice of two policies when adding a rule would cause the
4786  * number of flows in the table to exceed the configured maximum number: either
4787  * they can refuse to add the new flow or they can evict some existing flow.
4788  * This function configures the latter policy on 'table', with fairness based
4789  * on the values of the 'n_fields' fields specified in 'fields'.  (Specifying
4790  * 'n_fields' as 0 disables fairness.) */
4791 static void
4792 oftable_enable_eviction(struct oftable *table,
4793                         const struct mf_subfield *fields, size_t n_fields)
4794 {
4795     struct cls_cursor cursor;
4796     struct rule *rule;
4797
4798     if (table->eviction_fields
4799         && n_fields == table->n_eviction_fields
4800         && (!n_fields
4801             || !memcmp(fields, table->eviction_fields,
4802                        n_fields * sizeof *fields))) {
4803         /* No change. */
4804         return;
4805     }
4806
4807     oftable_disable_eviction(table);
4808
4809     table->n_eviction_fields = n_fields;
4810     table->eviction_fields = xmemdup(fields, n_fields * sizeof *fields);
4811
4812     table->eviction_group_id_basis = random_uint32();
4813     hmap_init(&table->eviction_groups_by_id);
4814     heap_init(&table->eviction_groups_by_size);
4815
4816     cls_cursor_init(&cursor, &table->cls, NULL);
4817     CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
4818         eviction_group_add_rule(rule);
4819     }
4820 }
4821
4822 /* Removes 'rule' from the oftable that contains it. */
4823 static void
4824 oftable_remove_rule(struct rule *rule)
4825 {
4826     struct ofproto *ofproto = rule->ofproto;
4827     struct oftable *table = &ofproto->tables[rule->table_id];
4828
4829     classifier_remove(&table->cls, &rule->cr);
4830     eviction_group_remove_rule(rule);
4831 }
4832
4833 /* Inserts 'rule' into its oftable.  Removes any existing rule from 'rule''s
4834  * oftable that has an identical cls_rule.  Returns the rule that was removed,
4835  * if any, and otherwise NULL. */
4836 static struct rule *
4837 oftable_replace_rule(struct rule *rule)
4838 {
4839     struct ofproto *ofproto = rule->ofproto;
4840     struct oftable *table = &ofproto->tables[rule->table_id];
4841     struct rule *victim;
4842
4843     victim = rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
4844     if (victim) {
4845         eviction_group_remove_rule(victim);
4846     }
4847     eviction_group_add_rule(rule);
4848     return victim;
4849 }
4850
4851 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
4852 static void
4853 oftable_substitute_rule(struct rule *old, struct rule *new)
4854 {
4855     if (new) {
4856         oftable_replace_rule(new);
4857     } else {
4858         oftable_remove_rule(old);
4859     }
4860 }
4861 \f
4862 /* unixctl commands. */
4863
4864 struct ofproto *
4865 ofproto_lookup(const char *name)
4866 {
4867     struct ofproto *ofproto;
4868
4869     HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
4870                              &all_ofprotos) {
4871         if (!strcmp(ofproto->name, name)) {
4872             return ofproto;
4873         }
4874     }
4875     return NULL;
4876 }
4877
4878 static void
4879 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
4880                      const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
4881 {
4882     struct ofproto *ofproto;
4883     struct ds results;
4884
4885     ds_init(&results);
4886     HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
4887         ds_put_format(&results, "%s\n", ofproto->name);
4888     }
4889     unixctl_command_reply(conn, ds_cstr(&results));
4890     ds_destroy(&results);
4891 }
4892
4893 static void
4894 ofproto_unixctl_init(void)
4895 {
4896     static bool registered;
4897     if (registered) {
4898         return;
4899     }
4900     registered = true;
4901
4902     unixctl_command_register("ofproto/list", "", 0, 0,
4903                              ofproto_unixctl_list, NULL);
4904 }
4905 \f
4906 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
4907  *
4908  * This is deprecated.  It is only for compatibility with broken device drivers
4909  * in old versions of Linux that do not properly support VLANs when VLAN
4910  * devices are not used.  When broken device drivers are no longer in
4911  * widespread use, we will delete these interfaces. */
4912
4913 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
4914  * (exactly) by an OpenFlow rule in 'ofproto'. */
4915 void
4916 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
4917 {
4918     const struct oftable *oftable;
4919
4920     free(ofproto->vlan_bitmap);
4921     ofproto->vlan_bitmap = bitmap_allocate(4096);
4922     ofproto->vlans_changed = false;
4923
4924     OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
4925         const struct cls_table *table;
4926
4927         HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
4928             if (minimask_get_vid_mask(&table->mask) == VLAN_VID_MASK) {
4929                 const struct cls_rule *rule;
4930
4931                 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
4932                     uint16_t vid = miniflow_get_vid(&rule->match.flow);
4933                     bitmap_set1(vlan_bitmap, vid);
4934                     bitmap_set1(ofproto->vlan_bitmap, vid);
4935                 }
4936             }
4937         }
4938     }
4939 }
4940
4941 /* Returns true if new VLANs have come into use by the flow table since the
4942  * last call to ofproto_get_vlan_usage().
4943  *
4944  * We don't track when old VLANs stop being used. */
4945 bool
4946 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
4947 {
4948     return ofproto->vlans_changed;
4949 }
4950
4951 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
4952  * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'.  If
4953  * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
4954  * device as a VLAN splinter for VLAN ID 'vid'.  If 'realdev_ofp_port' is zero,
4955  * then the VLAN device is un-enslaved. */
4956 int
4957 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
4958                          uint16_t realdev_ofp_port, int vid)
4959 {
4960     struct ofport *ofport;
4961     int error;
4962
4963     ovs_assert(vlandev_ofp_port != realdev_ofp_port);
4964
4965     ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
4966     if (!ofport) {
4967         VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
4968                   ofproto->name, vlandev_ofp_port);
4969         return EINVAL;
4970     }
4971
4972     if (!ofproto->ofproto_class->set_realdev) {
4973         if (!vlandev_ofp_port) {
4974             return 0;
4975         }
4976         VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
4977         return EOPNOTSUPP;
4978     }
4979
4980     error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
4981     if (error) {
4982         VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
4983                   ofproto->name, vlandev_ofp_port,
4984                   netdev_get_name(ofport->netdev), strerror(error));
4985     }
4986     return error;
4987 }