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