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