New action NXAST_RESUBMIT_TABLE.
[openvswitch] / ofproto / ofproto.c
1 /*
2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
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 "byte-order.h"
25 #include "classifier.h"
26 #include "connmgr.h"
27 #include "coverage.h"
28 #include "dynamic-string.h"
29 #include "hash.h"
30 #include "hmap.h"
31 #include "netdev.h"
32 #include "nx-match.h"
33 #include "ofp-print.h"
34 #include "ofp-util.h"
35 #include "ofpbuf.h"
36 #include "ofproto-provider.h"
37 #include "openflow/nicira-ext.h"
38 #include "openflow/openflow.h"
39 #include "packets.h"
40 #include "pinsched.h"
41 #include "pktbuf.h"
42 #include "poll-loop.h"
43 #include "shash.h"
44 #include "sset.h"
45 #include "timeval.h"
46 #include "unaligned.h"
47 #include "unixctl.h"
48 #include "vlog.h"
49
50 VLOG_DEFINE_THIS_MODULE(ofproto);
51
52 COVERAGE_DEFINE(ofproto_error);
53 COVERAGE_DEFINE(ofproto_flush);
54 COVERAGE_DEFINE(ofproto_no_packet_in);
55 COVERAGE_DEFINE(ofproto_packet_out);
56 COVERAGE_DEFINE(ofproto_queue_req);
57 COVERAGE_DEFINE(ofproto_recv_openflow);
58 COVERAGE_DEFINE(ofproto_reinit_ports);
59 COVERAGE_DEFINE(ofproto_uninstallable);
60 COVERAGE_DEFINE(ofproto_update_port);
61
62 enum ofproto_state {
63     S_OPENFLOW,                 /* Processing OpenFlow commands. */
64     S_FLUSH,                    /* Deleting all flow table rules. */
65 };
66
67 enum ofoperation_type {
68     OFOPERATION_ADD,
69     OFOPERATION_DELETE,
70     OFOPERATION_MODIFY
71 };
72
73 /* A single OpenFlow request can execute any number of operations.  The
74  * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
75  * ofconn to which an error reply should be sent if necessary.
76  *
77  * ofproto initiates some operations internally.  These operations are still
78  * assigned to groups but will not have an associated ofconn. */
79 struct ofopgroup {
80     struct ofproto *ofproto;    /* Owning ofproto. */
81     struct list ofproto_node;   /* In ofproto's "pending" list. */
82     struct list ops;            /* List of "struct ofoperation"s. */
83
84     /* Data needed to send OpenFlow reply on failure or to send a buffered
85      * packet on success.
86      *
87      * If list_is_empty(ofconn_node) then this ofopgroup never had an
88      * associated ofconn or its ofconn's connection dropped after it initiated
89      * the operation.  In the latter case 'ofconn' is a wild pointer that
90      * refers to freed memory, so the 'ofconn' member must be used only if
91      * !list_is_empty(ofconn_node).
92      */
93     struct list ofconn_node;    /* In ofconn's list of pending opgroups. */
94     struct ofconn *ofconn;      /* ofconn for reply (but see note above). */
95     struct ofp_header *request; /* Original request (truncated at 64 bytes). */
96     uint32_t buffer_id;         /* Buffer id from original request. */
97     int error;                  /* 0 if no error yet, otherwise error code. */
98 };
99
100 static struct ofopgroup *ofopgroup_create(struct ofproto *);
101 static struct ofopgroup *ofopgroup_create_for_ofconn(struct ofconn *,
102                                                      const struct ofp_header *,
103                                                      uint32_t buffer_id);
104 static void ofopgroup_submit(struct ofopgroup *);
105 static void ofopgroup_destroy(struct ofopgroup *);
106
107 /* A single flow table operation. */
108 struct ofoperation {
109     struct ofopgroup *group;    /* Owning group. */
110     struct list group_node;     /* In ofopgroup's "ops" list. */
111     struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
112     struct rule *rule;          /* Rule being operated upon. */
113     enum ofoperation_type type; /* Type of operation. */
114     int status;                 /* -1 if pending, otherwise 0 or error code. */
115     struct rule *victim;        /* OFOPERATION_ADDING: Replaced rule. */
116     union ofp_action *actions;  /* OFOPERATION_MODIFYING: Replaced actions. */
117     int n_actions;              /* OFOPERATION_MODIFYING: # of old actions. */
118     ovs_be64 flow_cookie;       /* Rule's old flow cookie. */
119 };
120
121 static void ofoperation_create(struct ofopgroup *, struct rule *,
122                                enum ofoperation_type);
123 static void ofoperation_destroy(struct ofoperation *);
124
125 static void ofport_destroy__(struct ofport *);
126 static void ofport_destroy(struct ofport *);
127
128 static uint64_t pick_datapath_id(const struct ofproto *);
129 static uint64_t pick_fallback_dpid(void);
130
131 static void ofproto_destroy__(struct ofproto *);
132
133 static void ofproto_rule_destroy__(struct rule *);
134 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
135
136 static void ofopgroup_destroy(struct ofopgroup *);
137
138 static int add_flow(struct ofproto *, struct ofconn *, struct flow_mod *,
139                     const struct ofp_header *);
140
141 /* This return value tells handle_openflow() that processing of the current
142  * OpenFlow message must be postponed until some ongoing operations have
143  * completed.
144  *
145  * This particular value is a good choice because it is negative (so it won't
146  * collide with any errno value or any value returned by ofp_mkerr()) and large
147  * (so it won't accidentally collide with EOF or a negative errno value). */
148 enum { OFPROTO_POSTPONE = -100000 };
149
150 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
151
152 static void update_port(struct ofproto *, const char *devname);
153 static int init_ports(struct ofproto *);
154 static void reinit_ports(struct ofproto *);
155
156 static void ofproto_unixctl_init(void);
157
158 /* All registered ofproto classes, in probe order. */
159 static const struct ofproto_class **ofproto_classes;
160 static size_t n_ofproto_classes;
161 static size_t allocated_ofproto_classes;
162
163 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
164 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
165
166 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
167
168 static void
169 ofproto_initialize(void)
170 {
171     static bool inited;
172
173     if (!inited) {
174         inited = true;
175         ofproto_class_register(&ofproto_dpif_class);
176     }
177 }
178
179 /* 'type' should be a normalized datapath type, as returned by
180  * ofproto_normalize_type().  Returns the corresponding ofproto_class
181  * structure, or a null pointer if there is none registered for 'type'. */
182 static const struct ofproto_class *
183 ofproto_class_find__(const char *type)
184 {
185     size_t i;
186
187     ofproto_initialize();
188     for (i = 0; i < n_ofproto_classes; i++) {
189         const struct ofproto_class *class = ofproto_classes[i];
190         struct sset types;
191         bool found;
192
193         sset_init(&types);
194         class->enumerate_types(&types);
195         found = sset_contains(&types, type);
196         sset_destroy(&types);
197
198         if (found) {
199             return class;
200         }
201     }
202     VLOG_WARN("unknown datapath type %s", type);
203     return NULL;
204 }
205
206 /* Registers a new ofproto class.  After successful registration, new ofprotos
207  * of that type can be created using ofproto_create(). */
208 int
209 ofproto_class_register(const struct ofproto_class *new_class)
210 {
211     size_t i;
212
213     for (i = 0; i < n_ofproto_classes; i++) {
214         if (ofproto_classes[i] == new_class) {
215             return EEXIST;
216         }
217     }
218
219     if (n_ofproto_classes >= allocated_ofproto_classes) {
220         ofproto_classes = x2nrealloc(ofproto_classes,
221                                      &allocated_ofproto_classes,
222                                      sizeof *ofproto_classes);
223     }
224     ofproto_classes[n_ofproto_classes++] = new_class;
225     return 0;
226 }
227
228 /* Unregisters a datapath provider.  'type' must have been previously
229  * registered and not currently be in use by any ofprotos.  After
230  * unregistration new datapaths of that type cannot be opened using
231  * ofproto_create(). */
232 int
233 ofproto_class_unregister(const struct ofproto_class *class)
234 {
235     size_t i;
236
237     for (i = 0; i < n_ofproto_classes; i++) {
238         if (ofproto_classes[i] == class) {
239             for (i++; i < n_ofproto_classes; i++) {
240                 ofproto_classes[i - 1] = ofproto_classes[i];
241             }
242             n_ofproto_classes--;
243             return 0;
244         }
245     }
246     VLOG_WARN("attempted to unregister an ofproto class that is not "
247               "registered");
248     return EAFNOSUPPORT;
249 }
250
251 /* Clears 'types' and enumerates all registered ofproto types into it.  The
252  * caller must first initialize the sset. */
253 void
254 ofproto_enumerate_types(struct sset *types)
255 {
256     size_t i;
257
258     ofproto_initialize();
259     for (i = 0; i < n_ofproto_classes; i++) {
260         ofproto_classes[i]->enumerate_types(types);
261     }
262 }
263
264 /* Returns the fully spelled out name for the given ofproto 'type'.
265  *
266  * Normalized type string can be compared with strcmp().  Unnormalized type
267  * string might be the same even if they have different spellings. */
268 const char *
269 ofproto_normalize_type(const char *type)
270 {
271     return type && type[0] ? type : "system";
272 }
273
274 /* Clears 'names' and enumerates the names of all known created ofprotos with
275  * the given 'type'.  The caller must first initialize the sset.  Returns 0 if
276  * successful, otherwise a positive errno value.
277  *
278  * Some kinds of datapaths might not be practically enumerable.  This is not
279  * considered an error. */
280 int
281 ofproto_enumerate_names(const char *type, struct sset *names)
282 {
283     const struct ofproto_class *class = ofproto_class_find__(type);
284     return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
285  }
286
287 int
288 ofproto_create(const char *datapath_name, const char *datapath_type,
289                struct ofproto **ofprotop)
290 {
291     const struct ofproto_class *class;
292     struct classifier *table;
293     struct ofproto *ofproto;
294     int n_tables;
295     int error;
296
297     *ofprotop = NULL;
298
299     ofproto_initialize();
300     ofproto_unixctl_init();
301
302     datapath_type = ofproto_normalize_type(datapath_type);
303     class = ofproto_class_find__(datapath_type);
304     if (!class) {
305         VLOG_WARN("could not create datapath %s of unknown type %s",
306                   datapath_name, datapath_type);
307         return EAFNOSUPPORT;
308     }
309
310     ofproto = class->alloc();
311     if (!ofproto) {
312         VLOG_ERR("failed to allocate datapath %s of type %s",
313                  datapath_name, datapath_type);
314         return ENOMEM;
315     }
316
317     /* Initialize. */
318     memset(ofproto, 0, sizeof *ofproto);
319     ofproto->ofproto_class = class;
320     ofproto->name = xstrdup(datapath_name);
321     ofproto->type = xstrdup(datapath_type);
322     hmap_insert(&all_ofprotos, &ofproto->hmap_node,
323                 hash_string(ofproto->name, 0));
324     ofproto->datapath_id = 0;
325     ofproto_set_flow_eviction_threshold(ofproto,
326                                         OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT);
327     ofproto->fallback_dpid = pick_fallback_dpid();
328     ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
329     ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
330     ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
331     ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
332     ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
333     hmap_init(&ofproto->ports);
334     shash_init(&ofproto->port_by_name);
335     ofproto->tables = NULL;
336     ofproto->n_tables = 0;
337     ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
338     ofproto->state = S_OPENFLOW;
339     list_init(&ofproto->pending);
340     hmap_init(&ofproto->deletions);
341
342     error = ofproto->ofproto_class->construct(ofproto, &n_tables);
343     if (error) {
344         VLOG_ERR("failed to open datapath %s: %s",
345                  datapath_name, strerror(error));
346         ofproto_destroy__(ofproto);
347         return error;
348     }
349
350     assert(n_tables >= 1 && n_tables <= 255);
351     ofproto->n_tables = n_tables;
352     ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
353     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
354         classifier_init(table);
355     }
356
357     ofproto->datapath_id = pick_datapath_id(ofproto);
358     VLOG_INFO("using datapath ID %016"PRIx64, ofproto->datapath_id);
359     init_ports(ofproto);
360
361     *ofprotop = ofproto;
362     return 0;
363 }
364
365 void
366 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
367 {
368     uint64_t old_dpid = p->datapath_id;
369     p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
370     if (p->datapath_id != old_dpid) {
371         VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
372
373         /* Force all active connections to reconnect, since there is no way to
374          * notify a controller that the datapath ID has changed. */
375         ofproto_reconnect_controllers(p);
376     }
377 }
378
379 void
380 ofproto_set_controllers(struct ofproto *p,
381                         const struct ofproto_controller *controllers,
382                         size_t n_controllers)
383 {
384     connmgr_set_controllers(p->connmgr, controllers, n_controllers);
385 }
386
387 void
388 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
389 {
390     connmgr_set_fail_mode(p->connmgr, fail_mode);
391 }
392
393 /* Drops the connections between 'ofproto' and all of its controllers, forcing
394  * them to reconnect. */
395 void
396 ofproto_reconnect_controllers(struct ofproto *ofproto)
397 {
398     connmgr_reconnect(ofproto->connmgr);
399 }
400
401 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
402  * in-band control should guarantee access, in the same way that in-band
403  * control guarantees access to OpenFlow controllers. */
404 void
405 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
406                                   const struct sockaddr_in *extras, size_t n)
407 {
408     connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
409 }
410
411 /* Sets the OpenFlow queue used by flows set up by in-band control on
412  * 'ofproto' to 'queue_id'.  If 'queue_id' is negative, then in-band control
413  * flows will use the default queue. */
414 void
415 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
416 {
417     connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
418 }
419
420 /* Sets the number of flows at which eviction from the kernel flow table
421  * will occur. */
422 void
423 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
424 {
425     if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
426         ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
427     } else {
428         ofproto->flow_eviction_threshold = threshold;
429     }
430 }
431
432 void
433 ofproto_set_desc(struct ofproto *p,
434                  const char *mfr_desc, const char *hw_desc,
435                  const char *sw_desc, const char *serial_desc,
436                  const char *dp_desc)
437 {
438     struct ofp_desc_stats *ods;
439
440     if (mfr_desc) {
441         if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
442             VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
443                     sizeof ods->mfr_desc);
444         }
445         free(p->mfr_desc);
446         p->mfr_desc = xstrdup(mfr_desc);
447     }
448     if (hw_desc) {
449         if (strlen(hw_desc) >= sizeof ods->hw_desc) {
450             VLOG_WARN("truncating hw_desc, must be less than %zu characters",
451                     sizeof ods->hw_desc);
452         }
453         free(p->hw_desc);
454         p->hw_desc = xstrdup(hw_desc);
455     }
456     if (sw_desc) {
457         if (strlen(sw_desc) >= sizeof ods->sw_desc) {
458             VLOG_WARN("truncating sw_desc, must be less than %zu characters",
459                     sizeof ods->sw_desc);
460         }
461         free(p->sw_desc);
462         p->sw_desc = xstrdup(sw_desc);
463     }
464     if (serial_desc) {
465         if (strlen(serial_desc) >= sizeof ods->serial_num) {
466             VLOG_WARN("truncating serial_desc, must be less than %zu "
467                     "characters",
468                     sizeof ods->serial_num);
469         }
470         free(p->serial_desc);
471         p->serial_desc = xstrdup(serial_desc);
472     }
473     if (dp_desc) {
474         if (strlen(dp_desc) >= sizeof ods->dp_desc) {
475             VLOG_WARN("truncating dp_desc, must be less than %zu characters",
476                     sizeof ods->dp_desc);
477         }
478         free(p->dp_desc);
479         p->dp_desc = xstrdup(dp_desc);
480     }
481 }
482
483 int
484 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
485 {
486     return connmgr_set_snoops(ofproto->connmgr, snoops);
487 }
488
489 int
490 ofproto_set_netflow(struct ofproto *ofproto,
491                     const struct netflow_options *nf_options)
492 {
493     if (nf_options && sset_is_empty(&nf_options->collectors)) {
494         nf_options = NULL;
495     }
496
497     if (ofproto->ofproto_class->set_netflow) {
498         return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
499     } else {
500         return nf_options ? EOPNOTSUPP : 0;
501     }
502 }
503
504 int
505 ofproto_set_sflow(struct ofproto *ofproto,
506                   const struct ofproto_sflow_options *oso)
507 {
508     if (oso && sset_is_empty(&oso->targets)) {
509         oso = NULL;
510     }
511
512     if (ofproto->ofproto_class->set_sflow) {
513         return ofproto->ofproto_class->set_sflow(ofproto, oso);
514     } else {
515         return oso ? EOPNOTSUPP : 0;
516     }
517 }
518 \f
519 /* Connectivity Fault Management configuration. */
520
521 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
522 void
523 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
524 {
525     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
526     if (ofport && ofproto->ofproto_class->set_cfm) {
527         ofproto->ofproto_class->set_cfm(ofport, NULL);
528     }
529 }
530
531 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'.  Takes
532  * basic configuration from the configuration members in 'cfm', and the remote
533  * maintenance point ID from  remote_mpid.  Ignores the statistics members of
534  * 'cfm'.
535  *
536  * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
537 void
538 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
539                      const struct cfm_settings *s)
540 {
541     struct ofport *ofport;
542     int error;
543
544     ofport = ofproto_get_port(ofproto, ofp_port);
545     if (!ofport) {
546         VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
547                   ofproto->name, ofp_port);
548         return;
549     }
550
551     /* XXX: For configuration simplicity, we only support one remote_mpid
552      * outside of the CFM module.  It's not clear if this is the correct long
553      * term solution or not. */
554     error = (ofproto->ofproto_class->set_cfm
555              ? ofproto->ofproto_class->set_cfm(ofport, s)
556              : EOPNOTSUPP);
557     if (error) {
558         VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
559                   ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
560                   strerror(error));
561     }
562 }
563
564 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
565  * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
566  * 0 if LACP partner information is not current (generally indicating a
567  * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
568 int
569 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
570 {
571     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
572     return (ofport && ofproto->ofproto_class->port_is_lacp_current
573             ? ofproto->ofproto_class->port_is_lacp_current(ofport)
574             : -1);
575 }
576 \f
577 /* Bundles. */
578
579 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
580  * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
581  * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
582  * configuration plus, if there is more than one slave, a bonding
583  * configuration.
584  *
585  * If 'aux' is already registered then this function updates its configuration
586  * to 's'.  Otherwise, this function registers a new bundle.
587  *
588  * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
589  * port. */
590 int
591 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
592                         const struct ofproto_bundle_settings *s)
593 {
594     return (ofproto->ofproto_class->bundle_set
595             ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
596             : EOPNOTSUPP);
597 }
598
599 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
600  * If no such bundle has been registered, this has no effect. */
601 int
602 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
603 {
604     return ofproto_bundle_register(ofproto, aux, NULL);
605 }
606
607 \f
608 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
609  * If 'aux' is already registered then this function updates its configuration
610  * to 's'.  Otherwise, this function registers a new mirror.
611  *
612  * Mirrors affect only the treatment of packets output to the OFPP_NORMAL
613  * port.  */
614 int
615 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
616                         const struct ofproto_mirror_settings *s)
617 {
618     return (ofproto->ofproto_class->mirror_set
619             ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
620             : EOPNOTSUPP);
621 }
622
623 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
624  * If no mirror has been registered, this has no effect. */
625 int
626 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
627 {
628     return ofproto_mirror_register(ofproto, aux, NULL);
629 }
630
631 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
632  * which all packets are flooded, instead of using MAC learning.  If
633  * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
634  *
635  * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
636  * port. */
637 int
638 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
639 {
640     return (ofproto->ofproto_class->set_flood_vlans
641             ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
642             : EOPNOTSUPP);
643 }
644
645 /* Returns true if 'aux' is a registered bundle that is currently in use as the
646  * output for a mirror. */
647 bool
648 ofproto_is_mirror_output_bundle(struct ofproto *ofproto, void *aux)
649 {
650     return (ofproto->ofproto_class->is_mirror_output_bundle
651             ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
652             : false);
653 }
654 \f
655 bool
656 ofproto_has_snoops(const struct ofproto *ofproto)
657 {
658     return connmgr_has_snoops(ofproto->connmgr);
659 }
660
661 void
662 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
663 {
664     connmgr_get_snoops(ofproto->connmgr, snoops);
665 }
666
667 static void
668 ofproto_flush__(struct ofproto *ofproto)
669 {
670     struct classifier *table;
671     struct ofopgroup *group;
672
673     if (ofproto->ofproto_class->flush) {
674         ofproto->ofproto_class->flush(ofproto);
675     }
676
677     group = ofopgroup_create(ofproto);
678     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
679         struct rule *rule, *next_rule;
680         struct cls_cursor cursor;
681
682         cls_cursor_init(&cursor, table, NULL);
683         CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
684             if (!rule->pending) {
685                 ofoperation_create(group, rule, OFOPERATION_DELETE);
686                 classifier_remove(table, &rule->cr);
687                 ofproto->ofproto_class->rule_destruct(rule);
688             }
689         }
690     }
691     ofopgroup_submit(group);
692 }
693
694 static void
695 ofproto_destroy__(struct ofproto *ofproto)
696 {
697     struct classifier *table;
698
699     assert(list_is_empty(&ofproto->pending));
700
701     connmgr_destroy(ofproto->connmgr);
702
703     hmap_remove(&all_ofprotos, &ofproto->hmap_node);
704     free(ofproto->name);
705     free(ofproto->type);
706     free(ofproto->mfr_desc);
707     free(ofproto->hw_desc);
708     free(ofproto->sw_desc);
709     free(ofproto->serial_desc);
710     free(ofproto->dp_desc);
711     hmap_destroy(&ofproto->ports);
712     shash_destroy(&ofproto->port_by_name);
713
714     OFPROTO_FOR_EACH_TABLE (table, ofproto) {
715         assert(classifier_is_empty(table));
716         classifier_destroy(table);
717     }
718     free(ofproto->tables);
719
720     hmap_destroy(&ofproto->deletions);
721
722     ofproto->ofproto_class->dealloc(ofproto);
723 }
724
725 void
726 ofproto_destroy(struct ofproto *p)
727 {
728     struct ofport *ofport, *next_ofport;
729
730     if (!p) {
731         return;
732     }
733
734     ofproto_flush__(p);
735     HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
736         ofport_destroy(ofport);
737     }
738
739     p->ofproto_class->destruct(p);
740     ofproto_destroy__(p);
741 }
742
743 /* Destroys the datapath with the respective 'name' and 'type'.  With the Linux
744  * kernel datapath, for example, this destroys the datapath in the kernel, and
745  * with the netdev-based datapath, it tears down the data structures that
746  * represent the datapath.
747  *
748  * The datapath should not be currently open as an ofproto. */
749 int
750 ofproto_delete(const char *name, const char *type)
751 {
752     const struct ofproto_class *class = ofproto_class_find__(type);
753     return (!class ? EAFNOSUPPORT
754             : !class->del ? EACCES
755             : class->del(type, name));
756 }
757
758 static void
759 process_port_change(struct ofproto *ofproto, int error, char *devname)
760 {
761     if (error == ENOBUFS) {
762         reinit_ports(ofproto);
763     } else if (!error) {
764         update_port(ofproto, devname);
765         free(devname);
766     }
767 }
768
769 int
770 ofproto_run(struct ofproto *p)
771 {
772     struct ofport *ofport;
773     char *devname;
774     int error;
775
776     error = p->ofproto_class->run(p);
777     if (error == ENODEV) {
778         /* Someone destroyed the datapath behind our back.  The caller
779          * better destroy us and give up, because we're just going to
780          * spin from here on out. */
781         static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
782         VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
783                     p->name);
784         return ENODEV;
785     }
786
787     if (p->ofproto_class->port_poll) {
788         while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
789             process_port_change(p, error, devname);
790         }
791     }
792
793     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
794         unsigned int change_seq = netdev_change_seq(ofport->netdev);
795         if (ofport->change_seq != change_seq) {
796             ofport->change_seq = change_seq;
797             update_port(p, netdev_get_name(ofport->netdev));
798         }
799     }
800
801
802     switch (p->state) {
803     case S_OPENFLOW:
804         connmgr_run(p->connmgr, handle_openflow);
805         break;
806
807     case S_FLUSH:
808         connmgr_run(p->connmgr, NULL);
809         ofproto_flush__(p);
810         if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
811             connmgr_flushed(p->connmgr);
812             p->state = S_OPENFLOW;
813         }
814         break;
815
816     default:
817         NOT_REACHED();
818     }
819
820     return 0;
821 }
822
823 void
824 ofproto_wait(struct ofproto *p)
825 {
826     struct ofport *ofport;
827
828     p->ofproto_class->wait(p);
829     if (p->ofproto_class->port_poll_wait) {
830         p->ofproto_class->port_poll_wait(p);
831     }
832
833     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
834         if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
835             poll_immediate_wake();
836         }
837     }
838
839     switch (p->state) {
840     case S_OPENFLOW:
841         connmgr_wait(p->connmgr, true);
842         break;
843
844     case S_FLUSH:
845         connmgr_wait(p->connmgr, false);
846         if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
847             poll_immediate_wake();
848         }
849         break;
850     }
851 }
852
853 bool
854 ofproto_is_alive(const struct ofproto *p)
855 {
856     return connmgr_has_controllers(p->connmgr);
857 }
858
859 void
860 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
861                                     struct shash *info)
862 {
863     connmgr_get_controller_info(ofproto->connmgr, info);
864 }
865
866 void
867 ofproto_free_ofproto_controller_info(struct shash *info)
868 {
869     connmgr_free_controller_info(info);
870 }
871
872 /* Makes a deep copy of 'old' into 'port'. */
873 void
874 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
875 {
876     port->name = xstrdup(old->name);
877     port->type = xstrdup(old->type);
878     port->ofp_port = old->ofp_port;
879 }
880
881 /* Frees memory allocated to members of 'ofproto_port'.
882  *
883  * Do not call this function on an ofproto_port obtained from
884  * ofproto_port_dump_next(): that function retains ownership of the data in the
885  * ofproto_port. */
886 void
887 ofproto_port_destroy(struct ofproto_port *ofproto_port)
888 {
889     free(ofproto_port->name);
890     free(ofproto_port->type);
891 }
892
893 /* Initializes 'dump' to begin dumping the ports in an ofproto.
894  *
895  * This function provides no status indication.  An error status for the entire
896  * dump operation is provided when it is completed by calling
897  * ofproto_port_dump_done().
898  */
899 void
900 ofproto_port_dump_start(struct ofproto_port_dump *dump,
901                         const struct ofproto *ofproto)
902 {
903     dump->ofproto = ofproto;
904     dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
905                                                           &dump->state);
906 }
907
908 /* Attempts to retrieve another port from 'dump', which must have been created
909  * with ofproto_port_dump_start().  On success, stores a new ofproto_port into
910  * 'port' and returns true.  On failure, returns false.
911  *
912  * Failure might indicate an actual error or merely that the last port has been
913  * dumped.  An error status for the entire dump operation is provided when it
914  * is completed by calling ofproto_port_dump_done().
915  *
916  * The ofproto owns the data stored in 'port'.  It will remain valid until at
917  * least the next time 'dump' is passed to ofproto_port_dump_next() or
918  * ofproto_port_dump_done(). */
919 bool
920 ofproto_port_dump_next(struct ofproto_port_dump *dump,
921                        struct ofproto_port *port)
922 {
923     const struct ofproto *ofproto = dump->ofproto;
924
925     if (dump->error) {
926         return false;
927     }
928
929     dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
930                                                          port);
931     if (dump->error) {
932         ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
933         return false;
934     }
935     return true;
936 }
937
938 /* Completes port table dump operation 'dump', which must have been created
939  * with ofproto_port_dump_start().  Returns 0 if the dump operation was
940  * error-free, otherwise a positive errno value describing the problem. */
941 int
942 ofproto_port_dump_done(struct ofproto_port_dump *dump)
943 {
944     const struct ofproto *ofproto = dump->ofproto;
945     if (!dump->error) {
946         dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
947                                                              dump->state);
948     }
949     return dump->error == EOF ? 0 : dump->error;
950 }
951
952 /* Attempts to add 'netdev' as a port on 'ofproto'.  If successful, returns 0
953  * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
954  * is non-null).  On failure, returns a positive errno value and sets
955  * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
956 int
957 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
958                  uint16_t *ofp_portp)
959 {
960     uint16_t ofp_port;
961     int error;
962
963     error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
964     if (!error) {
965         update_port(ofproto, netdev_get_name(netdev));
966     }
967     if (ofp_portp) {
968         *ofp_portp = error ? OFPP_NONE : ofp_port;
969     }
970     return error;
971 }
972
973 /* Looks up a port named 'devname' in 'ofproto'.  On success, returns 0 and
974  * initializes '*port' appropriately; on failure, returns a positive errno
975  * value.
976  *
977  * The caller owns the data in 'ofproto_port' and must free it with
978  * ofproto_port_destroy() when it is no longer needed. */
979 int
980 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
981                            struct ofproto_port *port)
982 {
983     int error;
984
985     error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
986     if (error) {
987         memset(port, 0, sizeof *port);
988     }
989     return error;
990 }
991
992 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
993  * Returns 0 if successful, otherwise a positive errno. */
994 int
995 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
996 {
997     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
998     const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
999     int error;
1000
1001     error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1002     if (!error && ofport) {
1003         /* 'name' is the netdev's name and update_port() is going to close the
1004          * netdev.  Just in case update_port() refers to 'name' after it
1005          * destroys 'ofport', make a copy of it around the update_port()
1006          * call. */
1007         char *devname = xstrdup(name);
1008         update_port(ofproto, devname);
1009         free(devname);
1010     }
1011     return error;
1012 }
1013
1014 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1015  * performs the 'n_actions' actions in 'actions'.  The new flow will not
1016  * timeout.
1017  *
1018  * If cls_rule->priority is in the range of priorities supported by OpenFlow
1019  * (0...65535, inclusive) then the flow will be visible to OpenFlow
1020  * controllers; otherwise, it will be hidden.
1021  *
1022  * The caller retains ownership of 'cls_rule' and 'actions'.
1023  *
1024  * This is a helper function for in-band control and fail-open. */
1025 void
1026 ofproto_add_flow(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1027                  const union ofp_action *actions, size_t n_actions)
1028 {
1029     const struct rule *rule;
1030
1031     rule = rule_from_cls_rule(classifier_find_rule_exactly(
1032                                     &ofproto->tables[0], cls_rule));
1033     if (!rule || !ofputil_actions_equal(rule->actions, rule->n_actions,
1034                                         actions, n_actions)) {
1035         struct flow_mod fm;
1036
1037         memset(&fm, 0, sizeof fm);
1038         fm.cr = *cls_rule;
1039         fm.buffer_id = UINT32_MAX;
1040         fm.actions = (union ofp_action *) actions;
1041         fm.n_actions = n_actions;
1042         add_flow(ofproto, NULL, &fm, NULL);
1043     }
1044 }
1045
1046 /* Searches for a rule with matching criteria exactly equal to 'target' in
1047  * ofproto's table 0 and, if it finds one, deletes it.
1048  *
1049  * This is a helper function for in-band control and fail-open. */
1050 bool
1051 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1052 {
1053     struct rule *rule;
1054
1055     rule = rule_from_cls_rule(classifier_find_rule_exactly(
1056                                   &ofproto->tables[0], target));
1057     if (!rule) {
1058         /* No such rule -> success. */
1059         return true;
1060     } else if (rule->pending) {
1061         /* An operation on the rule is already pending -> failure.
1062          * Caller must retry later if it's important. */
1063         return false;
1064     } else {
1065         /* Initiate deletion -> success. */
1066         struct ofopgroup *group = ofopgroup_create(ofproto);
1067         ofoperation_create(group, rule, OFOPERATION_DELETE);
1068         classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
1069         rule->ofproto->ofproto_class->rule_destruct(rule);
1070         ofopgroup_submit(group);
1071         return true;
1072     }
1073
1074 }
1075
1076 /* Starts the process of deleting all of the flows from all of ofproto's flow
1077  * tables and then reintroducing the flows required by in-band control and
1078  * fail-open.  The process will complete in a later call to ofproto_run(). */
1079 void
1080 ofproto_flush_flows(struct ofproto *ofproto)
1081 {
1082     COVERAGE_INC(ofproto_flush);
1083     ofproto->state = S_FLUSH;
1084 }
1085 \f
1086 static void
1087 reinit_ports(struct ofproto *p)
1088 {
1089     struct ofproto_port_dump dump;
1090     struct sset devnames;
1091     struct ofport *ofport;
1092     struct ofproto_port ofproto_port;
1093     const char *devname;
1094
1095     COVERAGE_INC(ofproto_reinit_ports);
1096
1097     sset_init(&devnames);
1098     HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1099         sset_add(&devnames, netdev_get_name(ofport->netdev));
1100     }
1101     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1102         sset_add(&devnames, ofproto_port.name);
1103     }
1104
1105     SSET_FOR_EACH (devname, &devnames) {
1106         update_port(p, devname);
1107     }
1108     sset_destroy(&devnames);
1109 }
1110
1111 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
1112  * netdev cannot be opened.  On success, also fills in 'opp'.  */
1113 static struct netdev *
1114 ofport_open(const struct ofproto_port *ofproto_port, struct ofp_phy_port *opp)
1115 {
1116     uint32_t curr, advertised, supported, peer;
1117     enum netdev_flags flags;
1118     struct netdev *netdev;
1119     int error;
1120
1121     error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1122     if (error) {
1123         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1124                      "cannot be opened (%s)",
1125                      ofproto_port->name, ofproto_port->ofp_port,
1126                      ofproto_port->name, strerror(error));
1127         return NULL;
1128     }
1129
1130     netdev_get_flags(netdev, &flags);
1131     netdev_get_features(netdev, &curr, &advertised, &supported, &peer);
1132
1133     opp->port_no = htons(ofproto_port->ofp_port);
1134     netdev_get_etheraddr(netdev, opp->hw_addr);
1135     ovs_strzcpy(opp->name, ofproto_port->name, sizeof opp->name);
1136     opp->config = flags & NETDEV_UP ? 0 : htonl(OFPPC_PORT_DOWN);
1137     opp->state = netdev_get_carrier(netdev) ? 0 : htonl(OFPPS_LINK_DOWN);
1138     opp->curr = htonl(curr);
1139     opp->advertised = htonl(advertised);
1140     opp->supported = htonl(supported);
1141     opp->peer = htonl(peer);
1142
1143     return netdev;
1144 }
1145
1146 /* Returns true if most fields of 'a' and 'b' are equal.  Differences in name,
1147  * port number, and 'config' bits other than OFPPC_PORT_DOWN are
1148  * disregarded. */
1149 static bool
1150 ofport_equal(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
1151 {
1152     BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1153     return (!memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1154             && a->state == b->state
1155             && !((a->config ^ b->config) & htonl(OFPPC_PORT_DOWN))
1156             && a->curr == b->curr
1157             && a->advertised == b->advertised
1158             && a->supported == b->supported
1159             && a->peer == b->peer);
1160 }
1161
1162 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1163  * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1164  * one with the same name or port number). */
1165 static void
1166 ofport_install(struct ofproto *p,
1167                struct netdev *netdev, const struct ofp_phy_port *opp)
1168 {
1169     const char *netdev_name = netdev_get_name(netdev);
1170     struct ofport *ofport;
1171     int error;
1172
1173     /* Create ofport. */
1174     ofport = p->ofproto_class->port_alloc();
1175     if (!ofport) {
1176         error = ENOMEM;
1177         goto error;
1178     }
1179     ofport->ofproto = p;
1180     ofport->netdev = netdev;
1181     ofport->change_seq = netdev_change_seq(netdev);
1182     ofport->opp = *opp;
1183     ofport->ofp_port = ntohs(opp->port_no);
1184
1185     /* Add port to 'p'. */
1186     hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1187     shash_add(&p->port_by_name, netdev_name, ofport);
1188
1189     /* Let the ofproto_class initialize its private data. */
1190     error = p->ofproto_class->port_construct(ofport);
1191     if (error) {
1192         goto error;
1193     }
1194     connmgr_send_port_status(p->connmgr, opp, OFPPR_ADD);
1195     return;
1196
1197 error:
1198     VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1199                  p->name, netdev_name, strerror(error));
1200     if (ofport) {
1201         ofport_destroy__(ofport);
1202     } else {
1203         netdev_close(netdev);
1204     }
1205 }
1206
1207 /* Removes 'ofport' from 'p' and destroys it. */
1208 static void
1209 ofport_remove(struct ofport *ofport)
1210 {
1211     connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->opp,
1212                              OFPPR_DELETE);
1213     ofport_destroy(ofport);
1214 }
1215
1216 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1217  * destroys it. */
1218 static void
1219 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1220 {
1221     struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1222     if (port) {
1223         ofport_remove(port);
1224     }
1225 }
1226
1227 /* Updates 'port' within 'ofproto' with the new 'netdev' and 'opp'.
1228  *
1229  * Does not handle a name or port number change.  The caller must implement
1230  * such a change as a delete followed by an add.  */
1231 static void
1232 ofport_modified(struct ofport *port, struct ofp_phy_port *opp)
1233 {
1234     memcpy(port->opp.hw_addr, opp->hw_addr, ETH_ADDR_LEN);
1235     port->opp.config = ((port->opp.config & ~htonl(OFPPC_PORT_DOWN))
1236                         | (opp->config & htonl(OFPPC_PORT_DOWN)));
1237     port->opp.state = opp->state;
1238     port->opp.curr = opp->curr;
1239     port->opp.advertised = opp->advertised;
1240     port->opp.supported = opp->supported;
1241     port->opp.peer = opp->peer;
1242
1243     connmgr_send_port_status(port->ofproto->connmgr, &port->opp, OFPPR_MODIFY);
1244 }
1245
1246 void
1247 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1248 {
1249     struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1250     if (port) {
1251         if (port->ofproto->ofproto_class->set_cfm) {
1252             port->ofproto->ofproto_class->set_cfm(port, NULL);
1253         }
1254         if (port->ofproto->ofproto_class->bundle_remove) {
1255             port->ofproto->ofproto_class->bundle_remove(port);
1256         }
1257     }
1258 }
1259
1260 static void
1261 ofport_destroy__(struct ofport *port)
1262 {
1263     struct ofproto *ofproto = port->ofproto;
1264     const char *name = netdev_get_name(port->netdev);
1265
1266     hmap_remove(&ofproto->ports, &port->hmap_node);
1267     shash_delete(&ofproto->port_by_name,
1268                  shash_find(&ofproto->port_by_name, name));
1269
1270     netdev_close(port->netdev);
1271     ofproto->ofproto_class->port_dealloc(port);
1272 }
1273
1274 static void
1275 ofport_destroy(struct ofport *port)
1276 {
1277     if (port) {
1278         port->ofproto->ofproto_class->port_destruct(port);
1279         ofport_destroy__(port);
1280      }
1281 }
1282
1283 struct ofport *
1284 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1285 {
1286     struct ofport *port;
1287
1288     HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1289                              hash_int(ofp_port, 0), &ofproto->ports) {
1290         if (port->ofp_port == ofp_port) {
1291             return port;
1292         }
1293     }
1294     return NULL;
1295 }
1296
1297 static void
1298 update_port(struct ofproto *ofproto, const char *name)
1299 {
1300     struct ofproto_port ofproto_port;
1301     struct ofp_phy_port opp;
1302     struct netdev *netdev;
1303     struct ofport *port;
1304
1305     COVERAGE_INC(ofproto_update_port);
1306
1307     /* Fetch 'name''s location and properties from the datapath. */
1308     netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1309               ? ofport_open(&ofproto_port, &opp)
1310               : NULL);
1311     if (netdev) {
1312         port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1313         if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1314             struct netdev *old_netdev = port->netdev;
1315
1316             /* 'name' hasn't changed location.  Any properties changed? */
1317             if (!ofport_equal(&port->opp, &opp)) {
1318                 ofport_modified(port, &opp);
1319             }
1320
1321             /* Install the newly opened netdev in case it has changed.
1322              * Don't close the old netdev yet in case port_modified has to
1323              * remove a retained reference to it.*/
1324             port->netdev = netdev;
1325             port->change_seq = netdev_change_seq(netdev);
1326
1327             if (port->ofproto->ofproto_class->port_modified) {
1328                 port->ofproto->ofproto_class->port_modified(port);
1329             }
1330
1331             netdev_close(old_netdev);
1332         } else {
1333             /* If 'port' is nonnull then its name differs from 'name' and thus
1334              * we should delete it.  If we think there's a port named 'name'
1335              * then its port number must be wrong now so delete it too. */
1336             if (port) {
1337                 ofport_remove(port);
1338             }
1339             ofport_remove_with_name(ofproto, name);
1340             ofport_install(ofproto, netdev, &opp);
1341         }
1342     } else {
1343         /* Any port named 'name' is gone now. */
1344         ofport_remove_with_name(ofproto, name);
1345     }
1346     ofproto_port_destroy(&ofproto_port);
1347 }
1348
1349 static int
1350 init_ports(struct ofproto *p)
1351 {
1352     struct ofproto_port_dump dump;
1353     struct ofproto_port ofproto_port;
1354
1355     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1356         uint16_t ofp_port = ofproto_port.ofp_port;
1357         if (ofproto_get_port(p, ofp_port)) {
1358             VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1359                          ofp_port);
1360         } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1361             VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1362                          ofproto_port.name);
1363         } else {
1364             struct ofp_phy_port opp;
1365             struct netdev *netdev;
1366
1367             netdev = ofport_open(&ofproto_port, &opp);
1368             if (netdev) {
1369                 ofport_install(p, netdev, &opp);
1370             }
1371         }
1372     }
1373
1374     return 0;
1375 }
1376 \f
1377 static void
1378 ofproto_rule_destroy__(struct rule *rule)
1379 {
1380     free(rule->actions);
1381     rule->ofproto->ofproto_class->rule_dealloc(rule);
1382 }
1383
1384 /* This function allows an ofproto implementation to destroy any rules that
1385  * remain when its ->destruct() function is called.  The caller must have
1386  * already uninitialized any derived members of 'rule' (step 5 described in the
1387  * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1388  * This function implements steps 6 and 7.
1389  *
1390  * This function should only be called from an ofproto implementation's
1391  * ->destruct() function.  It is not suitable elsewhere. */
1392 void
1393 ofproto_rule_destroy(struct rule *rule)
1394 {
1395     assert(!rule->pending);
1396     classifier_remove(&rule->ofproto->tables[rule->table_id], &rule->cr);
1397     ofproto_rule_destroy__(rule);
1398 }
1399
1400 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1401  * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1402  * count). */
1403 static bool
1404 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1405 {
1406     const union ofp_action *oa;
1407     size_t left;
1408
1409     if (out_port == OFPP_NONE) {
1410         return true;
1411     }
1412     OFPUTIL_ACTION_FOR_EACH_UNSAFE (oa, left, rule->actions, rule->n_actions) {
1413         if (action_outputs_to_port(oa, htons(out_port))) {
1414             return true;
1415         }
1416     }
1417     return false;
1418 }
1419
1420 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1421  * statistics appropriately.  'packet' must have at least sizeof(struct
1422  * ofp_packet_in) bytes of headroom.
1423  *
1424  * 'packet' doesn't necessarily have to match 'rule'.  'rule' will be credited
1425  * with statistics for 'packet' either way.
1426  *
1427  * Takes ownership of 'packet'. */
1428 static int
1429 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1430 {
1431     struct flow flow;
1432
1433     assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1434
1435     flow_extract(packet, 0, in_port, &flow);
1436     return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1437 }
1438
1439 /* Returns true if 'rule' should be hidden from the controller.
1440  *
1441  * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1442  * (e.g. by in-band control) and are intentionally hidden from the
1443  * controller. */
1444 static bool
1445 rule_is_hidden(const struct rule *rule)
1446 {
1447     return rule->cr.priority > UINT16_MAX;
1448 }
1449 \f
1450 static int
1451 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1452 {
1453     ofconn_send_reply(ofconn, make_echo_reply(oh));
1454     return 0;
1455 }
1456
1457 static int
1458 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1459 {
1460     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1461     struct ofp_switch_features *osf;
1462     struct ofpbuf *buf;
1463     struct ofport *port;
1464     bool arp_match_ip;
1465     uint32_t actions;
1466
1467     ofproto->ofproto_class->get_features(ofproto, &arp_match_ip, &actions);
1468     assert(actions & (1 << OFPAT_OUTPUT)); /* sanity check */
1469
1470     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1471     osf->datapath_id = htonll(ofproto->datapath_id);
1472     osf->n_buffers = htonl(pktbuf_capacity());
1473     osf->n_tables = ofproto->n_tables;
1474     osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1475                               OFPC_PORT_STATS);
1476     if (arp_match_ip) {
1477         osf->capabilities |= htonl(OFPC_ARP_MATCH_IP);
1478     }
1479     osf->actions = htonl(actions);
1480
1481     HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1482         ofpbuf_put(buf, &port->opp, sizeof port->opp);
1483     }
1484
1485     ofconn_send_reply(ofconn, buf);
1486     return 0;
1487 }
1488
1489 static int
1490 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1491 {
1492     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1493     struct ofpbuf *buf;
1494     struct ofp_switch_config *osc;
1495     uint16_t flags;
1496     bool drop_frags;
1497
1498     /* Figure out flags. */
1499     drop_frags = ofproto->ofproto_class->get_drop_frags(ofproto);
1500     flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
1501
1502     /* Send reply. */
1503     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1504     osc->flags = htons(flags);
1505     osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1506     ofconn_send_reply(ofconn, buf);
1507
1508     return 0;
1509 }
1510
1511 static int
1512 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1513 {
1514     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1515     uint16_t flags = ntohs(osc->flags);
1516
1517     if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1518         && ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1519         switch (flags & OFPC_FRAG_MASK) {
1520         case OFPC_FRAG_NORMAL:
1521             ofproto->ofproto_class->set_drop_frags(ofproto, false);
1522             break;
1523         case OFPC_FRAG_DROP:
1524             ofproto->ofproto_class->set_drop_frags(ofproto, true);
1525             break;
1526         default:
1527             VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
1528                          osc->flags);
1529             break;
1530         }
1531     }
1532
1533     ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1534
1535     return 0;
1536 }
1537
1538 /* Checks whether 'ofconn' is a slave controller.  If so, returns an OpenFlow
1539  * error message code (composed with ofp_mkerr()) for the caller to propagate
1540  * upward.  Otherwise, returns 0.
1541  *
1542  * The log message mentions 'msg_type'. */
1543 static int
1544 reject_slave_controller(struct ofconn *ofconn, const char *msg_type)
1545 {
1546     if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1547         && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1548         static struct vlog_rate_limit perm_rl = VLOG_RATE_LIMIT_INIT(1, 5);
1549         VLOG_WARN_RL(&perm_rl, "rejecting %s message from slave controller",
1550                      msg_type);
1551
1552         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
1553     } else {
1554         return 0;
1555     }
1556 }
1557
1558 static int
1559 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1560 {
1561     struct ofproto *p = ofconn_get_ofproto(ofconn);
1562     struct ofp_packet_out *opo;
1563     struct ofpbuf payload, *buffer;
1564     union ofp_action *ofp_actions;
1565     struct ofpbuf request;
1566     struct flow flow;
1567     size_t n_ofp_actions;
1568     uint16_t in_port;
1569     int error;
1570
1571     COVERAGE_INC(ofproto_packet_out);
1572
1573     error = reject_slave_controller(ofconn, "OFPT_PACKET_OUT");
1574     if (error) {
1575         return error;
1576     }
1577
1578     /* Get ofp_packet_out. */
1579     ofpbuf_use_const(&request, oh, ntohs(oh->length));
1580     opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1581
1582     /* Get actions. */
1583     error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1584                                  &ofp_actions, &n_ofp_actions);
1585     if (error) {
1586         return error;
1587     }
1588
1589     /* Get payload. */
1590     if (opo->buffer_id != htonl(UINT32_MAX)) {
1591         error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1592                                        &buffer, &in_port);
1593         if (error || !buffer) {
1594             return error;
1595         }
1596         payload = *buffer;
1597     } else {
1598         payload = request;
1599         buffer = NULL;
1600     }
1601
1602     /* Send out packet. */
1603     flow_extract(&payload, 0, ntohs(opo->in_port), &flow);
1604     error = p->ofproto_class->packet_out(p, &payload, &flow,
1605                                          ofp_actions, n_ofp_actions);
1606     ofpbuf_delete(buffer);
1607
1608     return error;
1609 }
1610
1611 static void
1612 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1613 {
1614     ovs_be32 old_config = port->opp.config;
1615
1616     mask &= config ^ port->opp.config;
1617     if (mask & htonl(OFPPC_PORT_DOWN)) {
1618         if (config & htonl(OFPPC_PORT_DOWN)) {
1619             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1620         } else {
1621             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1622         }
1623     }
1624
1625     port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1626                                       OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1627                                       OFPPC_NO_PACKET_IN));
1628     if (port->opp.config != old_config) {
1629         port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1630     }
1631 }
1632
1633 static int
1634 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1635 {
1636     struct ofproto *p = ofconn_get_ofproto(ofconn);
1637     const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1638     struct ofport *port;
1639     int error;
1640
1641     error = reject_slave_controller(ofconn, "OFPT_PORT_MOD");
1642     if (error) {
1643         return error;
1644     }
1645
1646     port = ofproto_get_port(p, ntohs(opm->port_no));
1647     if (!port) {
1648         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
1649     } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1650         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
1651     } else {
1652         update_port_config(port, opm->config, opm->mask);
1653         if (opm->advertise) {
1654             netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1655         }
1656     }
1657     return 0;
1658 }
1659
1660 static int
1661 handle_desc_stats_request(struct ofconn *ofconn,
1662                           const struct ofp_stats_msg *request)
1663 {
1664     struct ofproto *p = ofconn_get_ofproto(ofconn);
1665     struct ofp_desc_stats *ods;
1666     struct ofpbuf *msg;
1667
1668     ods = ofputil_make_stats_reply(sizeof *ods, request, &msg);
1669     ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1670     ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1671     ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1672     ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1673     ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1674     ofconn_send_reply(ofconn, msg);
1675
1676     return 0;
1677 }
1678
1679 static int
1680 handle_table_stats_request(struct ofconn *ofconn,
1681                            const struct ofp_stats_msg *request)
1682 {
1683     struct ofproto *p = ofconn_get_ofproto(ofconn);
1684     struct ofp_table_stats *ots;
1685     struct ofpbuf *msg;
1686     size_t i;
1687
1688     ofputil_make_stats_reply(sizeof(struct ofp_stats_msg), request, &msg);
1689
1690     ots = ofpbuf_put_zeros(msg, sizeof *ots * p->n_tables);
1691     for (i = 0; i < p->n_tables; i++) {
1692         ots[i].table_id = i;
1693         sprintf(ots[i].name, "table%zu", i);
1694         ots[i].wildcards = htonl(OFPFW_ALL);
1695         ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
1696         ots[i].active_count = htonl(classifier_count(&p->tables[i]));
1697     }
1698
1699     p->ofproto_class->get_tables(p, ots);
1700
1701     ofconn_send_reply(ofconn, msg);
1702     return 0;
1703 }
1704
1705 static void
1706 append_port_stat(struct ofport *port, struct list *replies)
1707 {
1708     struct netdev_stats stats;
1709     struct ofp_port_stats *ops;
1710
1711     /* Intentionally ignore return value, since errors will set
1712      * 'stats' to all-1s, which is correct for OpenFlow, and
1713      * netdev_get_stats() will log errors. */
1714     netdev_get_stats(port->netdev, &stats);
1715
1716     ops = ofputil_append_stats_reply(sizeof *ops, replies);
1717     ops->port_no = port->opp.port_no;
1718     memset(ops->pad, 0, sizeof ops->pad);
1719     put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
1720     put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
1721     put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
1722     put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
1723     put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
1724     put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
1725     put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
1726     put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
1727     put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
1728     put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
1729     put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
1730     put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
1731 }
1732
1733 static int
1734 handle_port_stats_request(struct ofconn *ofconn,
1735                           const struct ofp_port_stats_request *psr)
1736 {
1737     struct ofproto *p = ofconn_get_ofproto(ofconn);
1738     struct ofport *port;
1739     struct list replies;
1740
1741     ofputil_start_stats_reply(&psr->osm, &replies);
1742     if (psr->port_no != htons(OFPP_NONE)) {
1743         port = ofproto_get_port(p, ntohs(psr->port_no));
1744         if (port) {
1745             append_port_stat(port, &replies);
1746         }
1747     } else {
1748         HMAP_FOR_EACH (port, hmap_node, &p->ports) {
1749             append_port_stat(port, &replies);
1750         }
1751     }
1752
1753     ofconn_send_replies(ofconn, &replies);
1754     return 0;
1755 }
1756
1757 static void
1758 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
1759 {
1760     long long int msecs = time_msec() - start;
1761     *sec = msecs / 1000;
1762     *nsec = (msecs % 1000) * (1000 * 1000);
1763 }
1764
1765 static struct classifier *
1766 first_matching_table(struct ofproto *ofproto, uint8_t table_id)
1767 {
1768     if (table_id == 0xff) {
1769         return &ofproto->tables[0];
1770     } else if (table_id < ofproto->n_tables) {
1771         return &ofproto->tables[table_id];
1772     } else {
1773         /* It would probably be better to reply with an error but there doesn't
1774          * seem to be any appropriate value, so that might just be
1775          * confusing. */
1776         VLOG_WARN_RL(&rl, "controller asked for invalid table %"PRIu8,
1777                      table_id);
1778         return NULL;
1779     }
1780 }
1781
1782 static struct classifier *
1783 next_matching_table(struct ofproto *ofproto,
1784                     struct classifier *cls, uint8_t table_id)
1785 {
1786     return (table_id == 0xff && cls != &ofproto->tables[ofproto->n_tables - 1]
1787             ? cls + 1
1788             : NULL);
1789 }
1790
1791 /* Assigns CLS to each classifier table, in turn, that matches TABLE_ID in
1792  * OFPROTO:
1793  *
1794  *   - If TABLE_ID is 0xff, this iterates over every classifier table in
1795  *     OFPROTO.
1796  *
1797  *   - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
1798  *     only once, for that table.
1799  *
1800  *   - Otherwise, TABLE_ID isn't valid for OFPROTO, so ofproto logs a warning
1801  *     and does not enter the loop at all.
1802  *
1803  * All parameters are evaluated multiple times.
1804  */
1805 #define FOR_EACH_MATCHING_TABLE(CLS, TABLE_ID, OFPROTO)         \
1806     for ((CLS) = first_matching_table(OFPROTO, TABLE_ID);       \
1807          (CLS) != NULL;                                         \
1808          (CLS) = next_matching_table(OFPROTO, CLS, TABLE_ID))
1809
1810 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
1811  * 'table_id' is 0xff) that match 'match' in the "loose" way required for
1812  * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
1813  * 'rules'.
1814  *
1815  * If 'out_port' is anything other than OFPP_NONE, then only rules that output
1816  * to 'out_port' are included.
1817  *
1818  * Hidden rules are always omitted.
1819  *
1820  * Returns 0 on success, otherwise an OpenFlow error code. */
1821 static int
1822 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
1823                     const struct cls_rule *match, uint16_t out_port,
1824                     struct list *rules)
1825 {
1826     struct classifier *cls;
1827
1828     list_init(rules);
1829     FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
1830         struct cls_cursor cursor;
1831         struct rule *rule;
1832
1833         cls_cursor_init(&cursor, cls, match);
1834         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1835             if (rule->pending) {
1836                 return OFPROTO_POSTPONE;
1837             }
1838             if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
1839                 list_push_back(rules, &rule->ofproto_node);
1840             }
1841         }
1842     }
1843     return 0;
1844 }
1845
1846 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
1847  * 'table_id' is 0xff) that match 'match' in the "strict" way required for
1848  * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
1849  * on list 'rules'.
1850  *
1851  * If 'out_port' is anything other than OFPP_NONE, then only rules that output
1852  * to 'out_port' are included.
1853  *
1854  * Hidden rules are always omitted.
1855  *
1856  * Returns 0 on success, otherwise an OpenFlow error code. */
1857 static int
1858 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
1859                      const struct cls_rule *match, uint16_t out_port,
1860                      struct list *rules)
1861 {
1862     struct classifier *cls;
1863
1864     list_init(rules);
1865     FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
1866         struct rule *rule;
1867
1868         rule = rule_from_cls_rule(classifier_find_rule_exactly(cls, match));
1869         if (rule) {
1870             if (rule->pending) {
1871                 return OFPROTO_POSTPONE;
1872             }
1873             if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
1874                 list_push_back(rules, &rule->ofproto_node);
1875             }
1876         }
1877     }
1878     return 0;
1879 }
1880
1881 static int
1882 handle_flow_stats_request(struct ofconn *ofconn,
1883                           const struct ofp_stats_msg *osm)
1884 {
1885     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1886     struct flow_stats_request fsr;
1887     struct list replies;
1888     struct list rules;
1889     struct rule *rule;
1890     int error;
1891
1892     error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
1893     if (error) {
1894         return error;
1895     }
1896
1897     error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
1898                                 fsr.out_port, &rules);
1899     if (error) {
1900         return error;
1901     }
1902
1903     ofputil_start_stats_reply(osm, &replies);
1904     LIST_FOR_EACH (rule, ofproto_node, &rules) {
1905         struct ofputil_flow_stats fs;
1906
1907         fs.rule = rule->cr;
1908         fs.cookie = rule->flow_cookie;
1909         fs.table_id = rule->table_id;
1910         calc_flow_duration__(rule->created, &fs.duration_sec,
1911                              &fs.duration_nsec);
1912         fs.idle_timeout = rule->idle_timeout;
1913         fs.hard_timeout = rule->hard_timeout;
1914         ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
1915                                                &fs.byte_count);
1916         fs.actions = rule->actions;
1917         fs.n_actions = rule->n_actions;
1918         ofputil_append_flow_stats_reply(&fs, &replies);
1919     }
1920     ofconn_send_replies(ofconn, &replies);
1921
1922     return 0;
1923 }
1924
1925 static void
1926 flow_stats_ds(struct rule *rule, struct ds *results)
1927 {
1928     uint64_t packet_count, byte_count;
1929
1930     rule->ofproto->ofproto_class->rule_get_stats(rule,
1931                                                  &packet_count, &byte_count);
1932
1933     if (rule->table_id != 0) {
1934         ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
1935     }
1936     ds_put_format(results, "duration=%llds, ",
1937                   (time_msec() - rule->created) / 1000);
1938     ds_put_format(results, "priority=%u, ", rule->cr.priority);
1939     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
1940     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
1941     cls_rule_format(&rule->cr, results);
1942     ds_put_char(results, ',');
1943     if (rule->n_actions > 0) {
1944         ofp_print_actions(results, rule->actions, rule->n_actions);
1945     } else {
1946         ds_put_cstr(results, "drop");
1947     }
1948     ds_put_cstr(results, "\n");
1949 }
1950
1951 /* Adds a pretty-printed description of all flows to 'results', including
1952  * hidden flows (e.g., set up by in-band control). */
1953 void
1954 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
1955 {
1956     struct classifier *cls;
1957
1958     OFPROTO_FOR_EACH_TABLE (cls, p) {
1959         struct cls_cursor cursor;
1960         struct rule *rule;
1961
1962         cls_cursor_init(&cursor, cls, NULL);
1963         CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1964             flow_stats_ds(rule, results);
1965         }
1966     }
1967 }
1968
1969 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
1970  * '*engine_type' and '*engine_id', respectively. */
1971 void
1972 ofproto_get_netflow_ids(const struct ofproto *ofproto,
1973                         uint8_t *engine_type, uint8_t *engine_id)
1974 {
1975     ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
1976 }
1977
1978 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'.  Returns 1
1979  * if CFM is faulted (generally indiciating a connectivity problem), 0 if CFM
1980  * is not faulted, and -1 if CFM is not enabled on 'ofp_port'. */
1981 int
1982 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
1983 {
1984     struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1985     return (ofport && ofproto->ofproto_class->get_cfm_fault
1986             ? ofproto->ofproto_class->get_cfm_fault(ofport)
1987             : -1);
1988 }
1989
1990 static int
1991 handle_aggregate_stats_request(struct ofconn *ofconn,
1992                                const struct ofp_stats_msg *osm)
1993 {
1994     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1995     struct flow_stats_request request;
1996     struct ofputil_aggregate_stats stats;
1997     bool unknown_packets, unknown_bytes;
1998     struct ofpbuf *reply;
1999     struct list rules;
2000     struct rule *rule;
2001     int error;
2002
2003     error = ofputil_decode_flow_stats_request(&request, &osm->header);
2004     if (error) {
2005         return error;
2006     }
2007
2008     error = collect_rules_loose(ofproto, request.table_id, &request.match,
2009                                 request.out_port, &rules);
2010     if (error) {
2011         return error;
2012     }
2013
2014     memset(&stats, 0, sizeof stats);
2015     unknown_packets = unknown_bytes = false;
2016     LIST_FOR_EACH (rule, ofproto_node, &rules) {
2017         uint64_t packet_count;
2018         uint64_t byte_count;
2019
2020         ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2021                                                &byte_count);
2022
2023         if (packet_count == UINT64_MAX) {
2024             unknown_packets = true;
2025         } else {
2026             stats.packet_count += packet_count;
2027         }
2028
2029         if (byte_count == UINT64_MAX) {
2030             unknown_bytes = true;
2031         } else {
2032             stats.byte_count += byte_count;
2033         }
2034
2035         stats.flow_count++;
2036     }
2037     if (unknown_packets) {
2038         stats.packet_count = UINT64_MAX;
2039     }
2040     if (unknown_bytes) {
2041         stats.byte_count = UINT64_MAX;
2042     }
2043
2044     reply = ofputil_encode_aggregate_stats_reply(&stats, osm);
2045     ofconn_send_reply(ofconn, reply);
2046
2047     return 0;
2048 }
2049
2050 struct queue_stats_cbdata {
2051     struct ofport *ofport;
2052     struct list replies;
2053 };
2054
2055 static void
2056 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2057                 const struct netdev_queue_stats *stats)
2058 {
2059     struct ofp_queue_stats *reply;
2060
2061     reply = ofputil_append_stats_reply(sizeof *reply, &cbdata->replies);
2062     reply->port_no = cbdata->ofport->opp.port_no;
2063     memset(reply->pad, 0, sizeof reply->pad);
2064     reply->queue_id = htonl(queue_id);
2065     put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2066     put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2067     put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2068 }
2069
2070 static void
2071 handle_queue_stats_dump_cb(uint32_t queue_id,
2072                            struct netdev_queue_stats *stats,
2073                            void *cbdata_)
2074 {
2075     struct queue_stats_cbdata *cbdata = cbdata_;
2076
2077     put_queue_stats(cbdata, queue_id, stats);
2078 }
2079
2080 static void
2081 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2082                             struct queue_stats_cbdata *cbdata)
2083 {
2084     cbdata->ofport = port;
2085     if (queue_id == OFPQ_ALL) {
2086         netdev_dump_queue_stats(port->netdev,
2087                                 handle_queue_stats_dump_cb, cbdata);
2088     } else {
2089         struct netdev_queue_stats stats;
2090
2091         if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2092             put_queue_stats(cbdata, queue_id, &stats);
2093         }
2094     }
2095 }
2096
2097 static int
2098 handle_queue_stats_request(struct ofconn *ofconn,
2099                            const struct ofp_queue_stats_request *qsr)
2100 {
2101     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2102     struct queue_stats_cbdata cbdata;
2103     struct ofport *port;
2104     unsigned int port_no;
2105     uint32_t queue_id;
2106
2107     COVERAGE_INC(ofproto_queue_req);
2108
2109     ofputil_start_stats_reply(&qsr->osm, &cbdata.replies);
2110
2111     port_no = ntohs(qsr->port_no);
2112     queue_id = ntohl(qsr->queue_id);
2113     if (port_no == OFPP_ALL) {
2114         HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2115             handle_queue_stats_for_port(port, queue_id, &cbdata);
2116         }
2117     } else if (port_no < OFPP_MAX) {
2118         port = ofproto_get_port(ofproto, port_no);
2119         if (port) {
2120             handle_queue_stats_for_port(port, queue_id, &cbdata);
2121         }
2122     } else {
2123         ofpbuf_list_delete(&cbdata.replies);
2124         return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
2125     }
2126     ofconn_send_replies(ofconn, &cbdata.replies);
2127
2128     return 0;
2129 }
2130
2131 static bool
2132 is_flow_deletion_pending(const struct ofproto *ofproto,
2133                          const struct cls_rule *cls_rule,
2134                          uint8_t table_id)
2135 {
2136     if (!hmap_is_empty(&ofproto->deletions)) {
2137         struct ofoperation *op;
2138
2139         HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2140                                  cls_rule_hash(cls_rule, table_id),
2141                                  &ofproto->deletions) {
2142             if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2143                 return true;
2144             }
2145         }
2146     }
2147
2148     return false;
2149 }
2150
2151 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2152  * in which no matching flow already exists in the flow table.
2153  *
2154  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2155  * ofp_actions, to the ofproto's flow table.  Returns 0 on success or an
2156  * OpenFlow error code as encoded by ofp_mkerr() on failure.
2157  *
2158  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2159  * if any. */
2160 static int
2161 add_flow(struct ofproto *ofproto, struct ofconn *ofconn, struct flow_mod *fm,
2162          const struct ofp_header *request)
2163 {
2164     struct classifier *table;
2165     struct ofopgroup *group;
2166     struct rule *victim;
2167     struct rule *rule;
2168     int error;
2169
2170     /* Check for overlap, if requested. */
2171     if (fm->flags & OFPFF_CHECK_OVERLAP) {
2172         struct classifier *cls;
2173
2174         FOR_EACH_MATCHING_TABLE (cls, fm->table_id, ofproto) {
2175             if (classifier_rule_overlaps(cls, &fm->cr)) {
2176                 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
2177             }
2178         }
2179     }
2180
2181     /* Pick table. */
2182     if (fm->table_id == 0xff) {
2183         uint8_t table_id;
2184         if (ofproto->ofproto_class->rule_choose_table) {
2185             error = ofproto->ofproto_class->rule_choose_table(ofproto, &fm->cr,
2186                                                               &table_id);
2187             if (error) {
2188                 return error;
2189             }
2190             assert(table_id < ofproto->n_tables);
2191             table = &ofproto->tables[table_id];
2192         } else {
2193             table = &ofproto->tables[0];
2194         }
2195     } else if (fm->table_id < ofproto->n_tables) {
2196         table = &ofproto->tables[fm->table_id];
2197     } else {
2198         return ofp_mkerr_nicira(OFPET_FLOW_MOD_FAILED, NXFMFC_BAD_TABLE_ID);
2199     }
2200
2201     /* Serialize against pending deletion. */
2202     if (is_flow_deletion_pending(ofproto, &fm->cr, table - ofproto->tables)) {
2203         return OFPROTO_POSTPONE;
2204     }
2205
2206     /* Allocate new rule. */
2207     rule = ofproto->ofproto_class->rule_alloc();
2208     if (!rule) {
2209         VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2210                      ofproto->name, strerror(error));
2211         return ENOMEM;
2212     }
2213     rule->ofproto = ofproto;
2214     rule->cr = fm->cr;
2215     rule->pending = NULL;
2216     rule->flow_cookie = fm->cookie;
2217     rule->created = time_msec();
2218     rule->idle_timeout = fm->idle_timeout;
2219     rule->hard_timeout = fm->hard_timeout;
2220     rule->table_id = table - ofproto->tables;
2221     rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2222     rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2223     rule->n_actions = fm->n_actions;
2224
2225     /* Insert new rule. */
2226     victim = rule_from_cls_rule(classifier_replace(table, &rule->cr));
2227     if (victim && victim->pending) {
2228         error = OFPROTO_POSTPONE;
2229     } else {
2230         group = (ofconn
2231                  ? ofopgroup_create_for_ofconn(ofconn, request, fm->buffer_id)
2232                  : ofopgroup_create(ofproto));
2233         ofoperation_create(group, rule, OFOPERATION_ADD);
2234         rule->pending->victim = victim;
2235
2236         error = ofproto->ofproto_class->rule_construct(rule);
2237         if (error) {
2238             ofoperation_destroy(rule->pending);
2239         }
2240         ofopgroup_submit(group);
2241     }
2242
2243     /* Back out if an error occurred. */
2244     if (error) {
2245         if (victim) {
2246             classifier_replace(table, &victim->cr);
2247         } else {
2248             classifier_remove(table, &rule->cr);
2249         }
2250         ofproto_rule_destroy__(rule);
2251     }
2252     return error;
2253 }
2254 \f
2255 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2256
2257 /* Modifies the rules listed in 'rules', changing their actions to match those
2258  * in 'fm'.
2259  *
2260  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2261  * if any.
2262  *
2263  * Returns 0 on success, otherwise an OpenFlow error code. */
2264 static int
2265 modify_flows__(struct ofconn *ofconn, const struct flow_mod *fm,
2266                const struct ofp_header *request, struct list *rules)
2267 {
2268     struct ofopgroup *group;
2269     struct rule *rule;
2270
2271     group = ofopgroup_create_for_ofconn(ofconn, request, fm->buffer_id);
2272     LIST_FOR_EACH (rule, ofproto_node, rules) {
2273         if (!ofputil_actions_equal(fm->actions, fm->n_actions,
2274                                    rule->actions, rule->n_actions)) {
2275             ofoperation_create(group, rule, OFOPERATION_MODIFY);
2276             rule->pending->actions = rule->actions;
2277             rule->pending->n_actions = rule->n_actions;
2278             rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2279             rule->n_actions = fm->n_actions;
2280             rule->ofproto->ofproto_class->rule_modify_actions(rule);
2281         }
2282         rule->flow_cookie = fm->cookie;
2283     }
2284     ofopgroup_submit(group);
2285
2286     return 0;
2287 }
2288
2289 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code as
2290  * encoded by ofp_mkerr() on failure.
2291  *
2292  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2293  * if any. */
2294 static int
2295 modify_flows_loose(struct ofconn *ofconn, struct flow_mod *fm,
2296                    const struct ofp_header *request)
2297 {
2298     struct ofproto *p = ofconn_get_ofproto(ofconn);
2299     struct list rules;
2300     int error;
2301
2302     error = collect_rules_loose(p, fm->table_id, &fm->cr, OFPP_NONE, &rules);
2303     return (error ? error
2304             : list_is_empty(&rules) ? add_flow(p, ofconn, fm, request)
2305             : modify_flows__(ofconn, fm, request, &rules));
2306 }
2307
2308 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
2309  * code as encoded by ofp_mkerr() on failure.
2310  *
2311  * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2312  * if any. */
2313 static int
2314 modify_flow_strict(struct ofconn *ofconn, struct flow_mod *fm,
2315                    const struct ofp_header *request)
2316 {
2317     struct ofproto *p = ofconn_get_ofproto(ofconn);
2318     struct list rules;
2319     int error;
2320
2321     error = collect_rules_strict(p, fm->table_id, &fm->cr, OFPP_NONE, &rules);
2322     return (error ? error
2323             : list_is_empty(&rules) ? add_flow(p, ofconn, fm, request)
2324             : list_is_singleton(&rules) ? modify_flows__(ofconn, fm, request,
2325                                                          &rules)
2326             : 0);
2327 }
2328 \f
2329 /* OFPFC_DELETE implementation. */
2330
2331 /* Deletes the rules listed in 'rules'.
2332  *
2333  * Returns 0 on success, otherwise an OpenFlow error code. */
2334 static int
2335 delete_flows__(struct ofconn *ofconn, const struct ofp_header *request,
2336                struct list *rules)
2337 {
2338     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2339     struct rule *rule, *next;
2340     struct ofopgroup *group;
2341
2342     group = ofopgroup_create_for_ofconn(ofconn, request, UINT32_MAX);
2343     LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
2344         ofproto_rule_send_removed(rule, OFPRR_DELETE);
2345
2346         ofoperation_create(group, rule, OFOPERATION_DELETE);
2347         classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2348         rule->ofproto->ofproto_class->rule_destruct(rule);
2349     }
2350     ofopgroup_submit(group);
2351
2352     return 0;
2353 }
2354
2355 /* Implements OFPFC_DELETE. */
2356 static int
2357 delete_flows_loose(struct ofconn *ofconn, const struct flow_mod *fm,
2358                    const struct ofp_header *request)
2359 {
2360     struct ofproto *p = ofconn_get_ofproto(ofconn);
2361     struct list rules;
2362     int error;
2363
2364     error = collect_rules_loose(p, fm->table_id, &fm->cr, fm->out_port,
2365                                 &rules);
2366     return (error ? error
2367             : !list_is_empty(&rules) ? delete_flows__(ofconn, request, &rules)
2368             : 0);
2369 }
2370
2371 /* Implements OFPFC_DELETE_STRICT. */
2372 static int
2373 delete_flow_strict(struct ofconn *ofconn, struct flow_mod *fm,
2374                    const struct ofp_header *request)
2375 {
2376     struct ofproto *p = ofconn_get_ofproto(ofconn);
2377     struct list rules;
2378     int error;
2379
2380     error = collect_rules_strict(p, fm->table_id, &fm->cr, fm->out_port,
2381                                  &rules);
2382     return (error ? error
2383             : list_is_singleton(&rules) ? delete_flows__(ofconn, request,
2384                                                          &rules)
2385             : 0);
2386 }
2387
2388 static void
2389 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2390 {
2391     struct ofputil_flow_removed fr;
2392
2393     if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2394         return;
2395     }
2396
2397     fr.rule = rule->cr;
2398     fr.cookie = rule->flow_cookie;
2399     fr.reason = reason;
2400     calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2401     fr.idle_timeout = rule->idle_timeout;
2402     rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2403                                                  &fr.byte_count);
2404
2405     connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2406 }
2407
2408 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2409  * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2410  * ofproto.
2411  *
2412  * ofproto implementation ->run() functions should use this function to expire
2413  * OpenFlow flows. */
2414 void
2415 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2416 {
2417     struct ofproto *ofproto = rule->ofproto;
2418     struct ofopgroup *group;
2419
2420     assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2421
2422     ofproto_rule_send_removed(rule, reason);
2423
2424     group = ofopgroup_create(ofproto);
2425     ofoperation_create(group, rule, OFOPERATION_DELETE);
2426     classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2427     rule->ofproto->ofproto_class->rule_destruct(rule);
2428     ofopgroup_submit(group);
2429 }
2430 \f
2431 static int
2432 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2433 {
2434     struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2435     struct flow_mod fm;
2436     int error;
2437
2438     error = reject_slave_controller(ofconn, "flow_mod");
2439     if (error) {
2440         return error;
2441     }
2442
2443     if (list_size(&ofproto->pending) >= 50) {
2444         return OFPROTO_POSTPONE;
2445     }
2446
2447     error = ofputil_decode_flow_mod(&fm, oh,
2448                                     ofconn_get_flow_mod_table_id(ofconn));
2449     if (error) {
2450         return error;
2451     }
2452
2453     /* We do not support the emergency flow cache.  It will hopefully get
2454      * dropped from OpenFlow in the near future. */
2455     if (fm.flags & OFPFF_EMERG) {
2456         /* There isn't a good fit for an error code, so just state that the
2457          * flow table is full. */
2458         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
2459     }
2460
2461     switch (fm.command) {
2462     case OFPFC_ADD:
2463         return add_flow(ofproto, ofconn, &fm, oh);
2464
2465     case OFPFC_MODIFY:
2466         return modify_flows_loose(ofconn, &fm, oh);
2467
2468     case OFPFC_MODIFY_STRICT:
2469         return modify_flow_strict(ofconn, &fm, oh);
2470
2471     case OFPFC_DELETE:
2472         return delete_flows_loose(ofconn, &fm, oh);
2473
2474     case OFPFC_DELETE_STRICT:
2475         return delete_flow_strict(ofconn, &fm, oh);
2476
2477     default:
2478         if (fm.command > 0xff) {
2479             VLOG_WARN_RL(&rl, "flow_mod has explicit table_id but "
2480                          "flow_mod_table_id extension is not enabled");
2481         }
2482         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2483     }
2484 }
2485
2486 static int
2487 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2488 {
2489     struct nx_role_request *nrr = (struct nx_role_request *) oh;
2490     struct nx_role_request *reply;
2491     struct ofpbuf *buf;
2492     uint32_t role;
2493
2494     if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2495         VLOG_WARN_RL(&rl, "ignoring role request on service connection");
2496         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2497     }
2498
2499     role = ntohl(nrr->role);
2500     if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2501         && role != NX_ROLE_SLAVE) {
2502         VLOG_WARN_RL(&rl, "received request for unknown role %"PRIu32, role);
2503
2504         /* There's no good error code for this. */
2505         return ofp_mkerr(OFPET_BAD_REQUEST, -1);
2506     }
2507
2508     if (ofconn_get_role(ofconn) != role
2509         && ofconn_has_pending_opgroups(ofconn)) {
2510         return OFPROTO_POSTPONE;
2511     }
2512
2513     ofconn_set_role(ofconn, role);
2514
2515     reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2516     reply->role = htonl(role);
2517     ofconn_send_reply(ofconn, buf);
2518
2519     return 0;
2520 }
2521
2522 static int
2523 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
2524                              const struct ofp_header *oh)
2525 {
2526     const struct nxt_flow_mod_table_id *msg
2527         = (const struct nxt_flow_mod_table_id *) oh;
2528
2529     ofconn_set_flow_mod_table_id(ofconn, msg->set != 0);
2530     return 0;
2531 }
2532
2533 static int
2534 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2535 {
2536     const struct nxt_set_flow_format *msg
2537         = (const struct nxt_set_flow_format *) oh;
2538     uint32_t format;
2539
2540     format = ntohl(msg->format);
2541     if (format != NXFF_OPENFLOW10 && format != NXFF_NXM) {
2542         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2543     }
2544
2545     if (format != ofconn_get_flow_format(ofconn)
2546         && ofconn_has_pending_opgroups(ofconn)) {
2547         /* Avoid sending async messages in surprising flow format. */
2548         return OFPROTO_POSTPONE;
2549     }
2550
2551     ofconn_set_flow_format(ofconn, format);
2552     return 0;
2553 }
2554
2555 static int
2556 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2557 {
2558     struct ofp_header *ob;
2559     struct ofpbuf *buf;
2560
2561     if (ofconn_has_pending_opgroups(ofconn)) {
2562         return OFPROTO_POSTPONE;
2563     }
2564
2565     ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2566     ofconn_send_reply(ofconn, buf);
2567     return 0;
2568 }
2569
2570 static int
2571 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2572 {
2573     const struct ofp_header *oh = msg->data;
2574     const struct ofputil_msg_type *type;
2575     int error;
2576
2577     error = ofputil_decode_msg_type(oh, &type);
2578     if (error) {
2579         return error;
2580     }
2581
2582     switch (ofputil_msg_type_code(type)) {
2583         /* OpenFlow requests. */
2584     case OFPUTIL_OFPT_ECHO_REQUEST:
2585         return handle_echo_request(ofconn, oh);
2586
2587     case OFPUTIL_OFPT_FEATURES_REQUEST:
2588         return handle_features_request(ofconn, oh);
2589
2590     case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2591         return handle_get_config_request(ofconn, oh);
2592
2593     case OFPUTIL_OFPT_SET_CONFIG:
2594         return handle_set_config(ofconn, msg->data);
2595
2596     case OFPUTIL_OFPT_PACKET_OUT:
2597         return handle_packet_out(ofconn, oh);
2598
2599     case OFPUTIL_OFPT_PORT_MOD:
2600         return handle_port_mod(ofconn, oh);
2601
2602     case OFPUTIL_OFPT_FLOW_MOD:
2603         return handle_flow_mod(ofconn, oh);
2604
2605     case OFPUTIL_OFPT_BARRIER_REQUEST:
2606         return handle_barrier_request(ofconn, oh);
2607
2608         /* OpenFlow replies. */
2609     case OFPUTIL_OFPT_ECHO_REPLY:
2610         return 0;
2611
2612         /* Nicira extension requests. */
2613     case OFPUTIL_NXT_ROLE_REQUEST:
2614         return handle_role_request(ofconn, oh);
2615
2616     case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
2617         return handle_nxt_flow_mod_table_id(ofconn, oh);
2618
2619     case OFPUTIL_NXT_SET_FLOW_FORMAT:
2620         return handle_nxt_set_flow_format(ofconn, oh);
2621
2622     case OFPUTIL_NXT_FLOW_MOD:
2623         return handle_flow_mod(ofconn, oh);
2624
2625         /* Statistics requests. */
2626     case OFPUTIL_OFPST_DESC_REQUEST:
2627         return handle_desc_stats_request(ofconn, msg->data);
2628
2629     case OFPUTIL_OFPST_FLOW_REQUEST:
2630     case OFPUTIL_NXST_FLOW_REQUEST:
2631         return handle_flow_stats_request(ofconn, msg->data);
2632
2633     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
2634     case OFPUTIL_NXST_AGGREGATE_REQUEST:
2635         return handle_aggregate_stats_request(ofconn, msg->data);
2636
2637     case OFPUTIL_OFPST_TABLE_REQUEST:
2638         return handle_table_stats_request(ofconn, msg->data);
2639
2640     case OFPUTIL_OFPST_PORT_REQUEST:
2641         return handle_port_stats_request(ofconn, msg->data);
2642
2643     case OFPUTIL_OFPST_QUEUE_REQUEST:
2644         return handle_queue_stats_request(ofconn, msg->data);
2645
2646     case OFPUTIL_MSG_INVALID:
2647     case OFPUTIL_OFPT_HELLO:
2648     case OFPUTIL_OFPT_ERROR:
2649     case OFPUTIL_OFPT_FEATURES_REPLY:
2650     case OFPUTIL_OFPT_GET_CONFIG_REPLY:
2651     case OFPUTIL_OFPT_PACKET_IN:
2652     case OFPUTIL_OFPT_FLOW_REMOVED:
2653     case OFPUTIL_OFPT_PORT_STATUS:
2654     case OFPUTIL_OFPT_BARRIER_REPLY:
2655     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
2656     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
2657     case OFPUTIL_OFPST_DESC_REPLY:
2658     case OFPUTIL_OFPST_FLOW_REPLY:
2659     case OFPUTIL_OFPST_QUEUE_REPLY:
2660     case OFPUTIL_OFPST_PORT_REPLY:
2661     case OFPUTIL_OFPST_TABLE_REPLY:
2662     case OFPUTIL_OFPST_AGGREGATE_REPLY:
2663     case OFPUTIL_NXT_ROLE_REPLY:
2664     case OFPUTIL_NXT_FLOW_REMOVED:
2665     case OFPUTIL_NXST_FLOW_REPLY:
2666     case OFPUTIL_NXST_AGGREGATE_REPLY:
2667     default:
2668         if (VLOG_IS_WARN_ENABLED()) {
2669             char *s = ofp_to_string(oh, ntohs(oh->length), 2);
2670             VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
2671             free(s);
2672         }
2673         if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
2674             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2675         } else {
2676             return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
2677         }
2678     }
2679 }
2680
2681 static bool
2682 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
2683 {
2684     int error = handle_openflow__(ofconn, ofp_msg);
2685     if (error && error != OFPROTO_POSTPONE) {
2686         ofconn_send_error(ofconn, ofp_msg->data, error);
2687     }
2688     COVERAGE_INC(ofproto_recv_openflow);
2689     return error != OFPROTO_POSTPONE;
2690 }
2691 \f
2692 /* Asynchronous operations. */
2693
2694 /* Creates and returns a new ofopgroup that is not associated with any
2695  * OpenFlow connection.
2696  *
2697  * The caller should add operations to the returned group with
2698  * ofoperation_create() and then submit it with ofopgroup_submit(). */
2699 static struct ofopgroup *
2700 ofopgroup_create(struct ofproto *ofproto)
2701 {
2702     struct ofopgroup *group = xzalloc(sizeof *group);
2703     group->ofproto = ofproto;
2704     list_init(&group->ofproto_node);
2705     list_init(&group->ops);
2706     list_init(&group->ofconn_node);
2707     return group;
2708 }
2709
2710 /* Creates and returns a new ofopgroup that is associated with 'ofconn'.  If
2711  * the ofopgroup eventually fails, then the error reply will include 'request'.
2712  * If the ofopgroup eventually succeeds, then the packet with buffer id
2713  * 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
2714  *
2715  * The caller should add operations to the returned group with
2716  * ofoperation_create() and then submit it with ofopgroup_submit(). */
2717 static struct ofopgroup *
2718 ofopgroup_create_for_ofconn(struct ofconn *ofconn,
2719                             const struct ofp_header *request,
2720                             uint32_t buffer_id)
2721 {
2722     struct ofopgroup *group = ofopgroup_create(ofconn_get_ofproto(ofconn));
2723     size_t request_len = ntohs(request->length);
2724
2725     ofconn_add_opgroup(ofconn, &group->ofconn_node);
2726     group->ofconn = ofconn;
2727     group->request = xmemdup(request, MIN(request_len, 64));
2728     group->buffer_id = buffer_id;
2729
2730     return group;
2731 }
2732
2733 /* Submits 'group' for processing.
2734  *
2735  * If 'group' contains no operations (e.g. none were ever added, or all of the
2736  * ones that were added completed synchronously), then it is destroyed
2737  * immediately.  Otherwise it is added to the ofproto's list of pending
2738  * groups. */
2739 static void
2740 ofopgroup_submit(struct ofopgroup *group)
2741 {
2742     if (list_is_empty(&group->ops)) {
2743         ofopgroup_destroy(group);
2744     } else {
2745         list_push_back(&group->ofproto->pending, &group->ofproto_node);
2746     }
2747 }
2748
2749 static void
2750 ofopgroup_destroy(struct ofopgroup *group)
2751 {
2752     assert(list_is_empty(&group->ops));
2753     if (!list_is_empty(&group->ofproto_node)) {
2754         list_remove(&group->ofproto_node);
2755     }
2756     if (!list_is_empty(&group->ofconn_node)) {
2757         list_remove(&group->ofconn_node);
2758         if (group->error) {
2759             ofconn_send_error(group->ofconn, group->request, group->error);
2760         }
2761         connmgr_retry(group->ofproto->connmgr);
2762     }
2763     free(group->request);
2764     free(group);
2765 }
2766
2767 /* Initiates a new operation on 'rule', of the specified 'type', within
2768  * 'group'.  Prior to calling, 'rule' must not have any pending operation. */
2769 static void
2770 ofoperation_create(struct ofopgroup *group, struct rule *rule,
2771                    enum ofoperation_type type)
2772 {
2773     struct ofoperation *op;
2774
2775     assert(!rule->pending);
2776
2777     op = rule->pending = xzalloc(sizeof *op);
2778     op->group = group;
2779     list_push_back(&group->ops, &op->group_node);
2780     op->rule = rule;
2781     op->type = type;
2782     op->status = -1;
2783     op->flow_cookie = rule->flow_cookie;
2784
2785     if (type == OFOPERATION_DELETE) {
2786         hmap_insert(&op->group->ofproto->deletions, &op->hmap_node,
2787                     cls_rule_hash(&rule->cr, rule->table_id));
2788     }
2789 }
2790
2791 static void
2792 ofoperation_destroy(struct ofoperation *op)
2793 {
2794     struct ofopgroup *group = op->group;
2795
2796     if (op->rule) {
2797         op->rule->pending = NULL;
2798     }
2799     if (op->type == OFOPERATION_DELETE) {
2800         hmap_remove(&group->ofproto->deletions, &op->hmap_node);
2801     }
2802     list_remove(&op->group_node);
2803     free(op->actions);
2804     free(op);
2805
2806     if (list_is_empty(&group->ops) && !list_is_empty(&group->ofproto_node)) {
2807         ofopgroup_destroy(group);
2808     }
2809 }
2810
2811 /* Indicates that 'op' completed with status 'error', which is either 0 to
2812  * indicate success or an OpenFlow error code (constructed with
2813  * e.g. ofp_mkerr()).
2814  *
2815  * If 'op' is a "delete flow" operation, 'error' must be 0.  That is, flow
2816  * deletions are not allowed to fail.
2817  *
2818  * Please see the large comment in ofproto/ofproto-provider.h titled
2819  * "Asynchronous Operation Support" for more information. */
2820 void
2821 ofoperation_complete(struct ofoperation *op, int error)
2822 {
2823     struct ofopgroup *group = op->group;
2824     struct rule *rule = op->rule;
2825     struct classifier *table = &rule->ofproto->tables[rule->table_id];
2826
2827     assert(rule->pending == op);
2828     assert(op->status < 0);
2829     assert(error >= 0);
2830
2831     if (!error
2832         && !group->error
2833         && op->type != OFOPERATION_DELETE
2834         && group->ofconn
2835         && group->buffer_id != UINT32_MAX
2836         && list_is_singleton(&op->group_node)) {
2837         struct ofpbuf *packet;
2838         uint16_t in_port;
2839
2840         error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
2841                                        &packet, &in_port);
2842         if (packet) {
2843             assert(!error);
2844             error = rule_execute(rule, in_port, packet);
2845         }
2846     }
2847     if (!group->error) {
2848         group->error = error;
2849     }
2850
2851     switch (op->type) {
2852     case OFOPERATION_ADD:
2853         if (!error) {
2854             if (op->victim) {
2855                 ofproto_rule_destroy__(op->victim);
2856             }
2857         } else {
2858             if (op->victim) {
2859                 classifier_replace(table, &op->victim->cr);
2860                 op->victim = NULL;
2861             } else {
2862                 classifier_remove(table, &rule->cr);
2863             }
2864             ofproto_rule_destroy__(rule);
2865         }
2866         op->victim = NULL;
2867         break;
2868
2869     case OFOPERATION_DELETE:
2870         assert(!error);
2871         ofproto_rule_destroy__(rule);
2872         op->rule = NULL;
2873         break;
2874
2875     case OFOPERATION_MODIFY:
2876         if (error) {
2877             free(rule->actions);
2878             rule->actions = op->actions;
2879             rule->n_actions = op->n_actions;
2880             op->actions = NULL;
2881         }
2882         break;
2883
2884     default:
2885         NOT_REACHED();
2886     }
2887     ofoperation_destroy(op);
2888 }
2889
2890 struct rule *
2891 ofoperation_get_victim(struct ofoperation *op)
2892 {
2893     assert(op->type == OFOPERATION_ADD);
2894     return op->victim;
2895 }
2896 \f
2897 static uint64_t
2898 pick_datapath_id(const struct ofproto *ofproto)
2899 {
2900     const struct ofport *port;
2901
2902     port = ofproto_get_port(ofproto, OFPP_LOCAL);
2903     if (port) {
2904         uint8_t ea[ETH_ADDR_LEN];
2905         int error;
2906
2907         error = netdev_get_etheraddr(port->netdev, ea);
2908         if (!error) {
2909             return eth_addr_to_uint64(ea);
2910         }
2911         VLOG_WARN("could not get MAC address for %s (%s)",
2912                   netdev_get_name(port->netdev), strerror(error));
2913     }
2914     return ofproto->fallback_dpid;
2915 }
2916
2917 static uint64_t
2918 pick_fallback_dpid(void)
2919 {
2920     uint8_t ea[ETH_ADDR_LEN];
2921     eth_addr_nicira_random(ea);
2922     return eth_addr_to_uint64(ea);
2923 }
2924 \f
2925 /* unixctl commands. */
2926
2927 struct ofproto *
2928 ofproto_lookup(const char *name)
2929 {
2930     struct ofproto *ofproto;
2931
2932     HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
2933                              &all_ofprotos) {
2934         if (!strcmp(ofproto->name, name)) {
2935             return ofproto;
2936         }
2937     }
2938     return NULL;
2939 }
2940
2941 static void
2942 ofproto_unixctl_list(struct unixctl_conn *conn, const char *arg OVS_UNUSED,
2943                      void *aux OVS_UNUSED)
2944 {
2945     struct ofproto *ofproto;
2946     struct ds results;
2947
2948     ds_init(&results);
2949     HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
2950         ds_put_format(&results, "%s\n", ofproto->name);
2951     }
2952     unixctl_command_reply(conn, 200, ds_cstr(&results));
2953     ds_destroy(&results);
2954 }
2955
2956 static void
2957 ofproto_unixctl_init(void)
2958 {
2959     static bool registered;
2960     if (registered) {
2961         return;
2962     }
2963     registered = true;
2964
2965     unixctl_command_register("ofproto/list", ofproto_unixctl_list, NULL);
2966 }