2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
24 #include "byte-order.h"
25 #include "classifier.h"
28 #include "dynamic-string.h"
33 #include "ofp-print.h"
36 #include "openflow/nicira-ext.h"
37 #include "openflow/openflow.h"
41 #include "poll-loop.h"
46 #include "unaligned.h"
50 VLOG_DEFINE_THIS_MODULE(ofproto);
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);
64 static void ofport_destroy__(struct ofport *);
65 static void ofport_destroy(struct ofport *);
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,
73 static uint64_t pick_datapath_id(const struct ofproto *);
74 static uint64_t pick_fallback_dpid(void);
76 static void ofproto_destroy__(struct ofproto *);
77 static void ofproto_flush_flows__(struct ofproto *);
79 static void ofproto_rule_destroy__(struct rule *);
80 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
81 static void ofproto_rule_remove(struct rule *);
83 static void handle_openflow(struct ofconn *, struct ofpbuf *);
85 static void update_port(struct ofproto *, const char *devname);
86 static int init_ports(struct ofproto *);
87 static void reinit_ports(struct ofproto *);
89 static void ofproto_unixctl_init(void);
91 /* All registered ofproto classes, in probe order. */
92 static const struct ofproto_class **ofproto_classes;
93 static size_t n_ofproto_classes;
94 static size_t allocated_ofproto_classes;
96 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
97 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
99 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
102 ofproto_initialize(void)
108 ofproto_class_register(&ofproto_dpif_class);
112 /* 'type' should be a normalized datapath type, as returned by
113 * ofproto_normalize_type(). Returns the corresponding ofproto_class
114 * structure, or a null pointer if there is none registered for 'type'. */
115 static const struct ofproto_class *
116 ofproto_class_find__(const char *type)
120 ofproto_initialize();
121 for (i = 0; i < n_ofproto_classes; i++) {
122 const struct ofproto_class *class = ofproto_classes[i];
127 class->enumerate_types(&types);
128 found = sset_contains(&types, type);
129 sset_destroy(&types);
135 VLOG_WARN("unknown datapath type %s", type);
139 /* Registers a new ofproto class. After successful registration, new ofprotos
140 * of that type can be created using ofproto_create(). */
142 ofproto_class_register(const struct ofproto_class *new_class)
146 for (i = 0; i < n_ofproto_classes; i++) {
147 if (ofproto_classes[i] == new_class) {
152 if (n_ofproto_classes >= allocated_ofproto_classes) {
153 ofproto_classes = x2nrealloc(ofproto_classes,
154 &allocated_ofproto_classes,
155 sizeof *ofproto_classes);
157 ofproto_classes[n_ofproto_classes++] = new_class;
161 /* Unregisters a datapath provider. 'type' must have been previously
162 * registered and not currently be in use by any ofprotos. After
163 * unregistration new datapaths of that type cannot be opened using
164 * ofproto_create(). */
166 ofproto_class_unregister(const struct ofproto_class *class)
170 for (i = 0; i < n_ofproto_classes; i++) {
171 if (ofproto_classes[i] == class) {
172 for (i++; i < n_ofproto_classes; i++) {
173 ofproto_classes[i - 1] = ofproto_classes[i];
179 VLOG_WARN("attempted to unregister an ofproto class that is not "
184 /* Clears 'types' and enumerates all registered ofproto types into it. The
185 * caller must first initialize the sset. */
187 ofproto_enumerate_types(struct sset *types)
191 ofproto_initialize();
192 for (i = 0; i < n_ofproto_classes; i++) {
193 ofproto_classes[i]->enumerate_types(types);
197 /* Returns the fully spelled out name for the given ofproto 'type'.
199 * Normalized type string can be compared with strcmp(). Unnormalized type
200 * string might be the same even if they have different spellings. */
202 ofproto_normalize_type(const char *type)
204 return type && type[0] ? type : "system";
207 /* Clears 'names' and enumerates the names of all known created ofprotos with
208 * the given 'type'. The caller must first initialize the sset. Returns 0 if
209 * successful, otherwise a positive errno value.
211 * Some kinds of datapaths might not be practically enumerable. This is not
212 * considered an error. */
214 ofproto_enumerate_names(const char *type, struct sset *names)
216 const struct ofproto_class *class = ofproto_class_find__(type);
217 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
221 ofproto_create(const char *datapath_name, const char *datapath_type,
222 struct ofproto **ofprotop)
224 const struct ofproto_class *class;
225 struct ofproto *ofproto;
230 ofproto_initialize();
231 ofproto_unixctl_init();
233 datapath_type = ofproto_normalize_type(datapath_type);
234 class = ofproto_class_find__(datapath_type);
236 VLOG_WARN("could not create datapath %s of unknown type %s",
237 datapath_name, datapath_type);
241 ofproto = class->alloc();
243 VLOG_ERR("failed to allocate datapath %s of type %s",
244 datapath_name, datapath_type);
249 memset(ofproto, 0, sizeof *ofproto);
250 ofproto->ofproto_class = class;
251 ofproto->name = xstrdup(datapath_name);
252 ofproto->type = xstrdup(datapath_type);
253 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
254 hash_string(ofproto->name, 0));
255 ofproto->datapath_id = 0;
256 ofproto->fallback_dpid = pick_fallback_dpid();
257 ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
258 ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
259 ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
260 ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
261 ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
262 ofproto->netdev_monitor = netdev_monitor_create();
263 hmap_init(&ofproto->ports);
264 shash_init(&ofproto->port_by_name);
265 classifier_init(&ofproto->cls);
266 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
268 error = ofproto->ofproto_class->construct(ofproto);
270 VLOG_ERR("failed to open datapath %s: %s",
271 datapath_name, strerror(error));
272 ofproto_destroy__(ofproto);
276 ofproto->datapath_id = pick_datapath_id(ofproto);
277 VLOG_INFO("using datapath ID %016"PRIx64, ofproto->datapath_id);
285 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
287 uint64_t old_dpid = p->datapath_id;
288 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
289 if (p->datapath_id != old_dpid) {
290 VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
292 /* Force all active connections to reconnect, since there is no way to
293 * notify a controller that the datapath ID has changed. */
294 ofproto_reconnect_controllers(p);
299 ofproto_set_controllers(struct ofproto *p,
300 const struct ofproto_controller *controllers,
301 size_t n_controllers)
303 connmgr_set_controllers(p->connmgr, controllers, n_controllers);
307 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
309 connmgr_set_fail_mode(p->connmgr, fail_mode);
312 /* Drops the connections between 'ofproto' and all of its controllers, forcing
313 * them to reconnect. */
315 ofproto_reconnect_controllers(struct ofproto *ofproto)
317 connmgr_reconnect(ofproto->connmgr);
320 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
321 * in-band control should guarantee access, in the same way that in-band
322 * control guarantees access to OpenFlow controllers. */
324 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
325 const struct sockaddr_in *extras, size_t n)
327 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
330 /* Sets the OpenFlow queue used by flows set up by in-band control on
331 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
332 * flows will use the default queue. */
334 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
336 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
340 ofproto_set_desc(struct ofproto *p,
341 const char *mfr_desc, const char *hw_desc,
342 const char *sw_desc, const char *serial_desc,
345 struct ofp_desc_stats *ods;
348 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
349 VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
350 sizeof ods->mfr_desc);
353 p->mfr_desc = xstrdup(mfr_desc);
356 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
357 VLOG_WARN("truncating hw_desc, must be less than %zu characters",
358 sizeof ods->hw_desc);
361 p->hw_desc = xstrdup(hw_desc);
364 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
365 VLOG_WARN("truncating sw_desc, must be less than %zu characters",
366 sizeof ods->sw_desc);
369 p->sw_desc = xstrdup(sw_desc);
372 if (strlen(serial_desc) >= sizeof ods->serial_num) {
373 VLOG_WARN("truncating serial_desc, must be less than %zu "
375 sizeof ods->serial_num);
377 free(p->serial_desc);
378 p->serial_desc = xstrdup(serial_desc);
381 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
382 VLOG_WARN("truncating dp_desc, must be less than %zu characters",
383 sizeof ods->dp_desc);
386 p->dp_desc = xstrdup(dp_desc);
391 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
393 return connmgr_set_snoops(ofproto->connmgr, snoops);
397 ofproto_set_netflow(struct ofproto *ofproto,
398 const struct netflow_options *nf_options)
400 if (nf_options && sset_is_empty(&nf_options->collectors)) {
404 if (ofproto->ofproto_class->set_netflow) {
405 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
407 return nf_options ? EOPNOTSUPP : 0;
412 ofproto_set_sflow(struct ofproto *ofproto,
413 const struct ofproto_sflow_options *oso)
415 if (oso && sset_is_empty(&oso->targets)) {
419 if (ofproto->ofproto_class->set_sflow) {
420 return ofproto->ofproto_class->set_sflow(ofproto, oso);
422 return oso ? EOPNOTSUPP : 0;
426 /* Connectivity Fault Management configuration. */
428 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
430 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
432 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
433 if (ofport && ofproto->ofproto_class->set_cfm) {
434 ofproto->ofproto_class->set_cfm(ofport, NULL, NULL, 0);
438 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
439 * basic configuration from the configuration members in 'cfm', and the set of
440 * remote maintenance points from the 'n_remote_mps' elements in 'remote_mps'.
441 * Ignores the statistics members of 'cfm'.
443 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
445 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
446 const struct cfm *cfm,
447 const uint16_t *remote_mps, size_t n_remote_mps)
449 struct ofport *ofport;
452 ofport = ofproto_get_port(ofproto, ofp_port);
454 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
455 ofproto->name, ofp_port);
459 error = (ofproto->ofproto_class->set_cfm
460 ? ofproto->ofproto_class->set_cfm(ofport, cfm,
461 remote_mps, n_remote_mps)
464 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
465 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
470 /* Returns the connectivity fault management object associated with 'ofp_port'
471 * within 'ofproto', or a null pointer if 'ofproto' does not have a port
472 * 'ofp_port' or if that port does not have CFM configured. The caller must
473 * not modify or destroy the returned object. */
475 ofproto_port_get_cfm(struct ofproto *ofproto, uint16_t ofp_port)
477 struct ofport *ofport;
478 const struct cfm *cfm;
480 ofport = ofproto_get_port(ofproto, ofp_port);
482 && ofproto->ofproto_class->get_cfm
483 && !ofproto->ofproto_class->get_cfm(ofport, &cfm)) ? cfm : NULL;
486 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
487 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
488 * 0 if LACP partner information is not current (generally indicating a
489 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
491 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
493 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
494 return (ofport && ofproto->ofproto_class->port_is_lacp_current
495 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
501 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
502 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
503 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
504 * configuration plus, if there is more than one slave, a bonding
507 * If 'aux' is already registered then this function updates its configuration
508 * to 's'. Otherwise, this function registers a new bundle.
510 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
513 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
514 const struct ofproto_bundle_settings *s)
516 return (ofproto->ofproto_class->bundle_set
517 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
521 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
522 * If no such bundle has been registered, this has no effect. */
524 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
526 return ofproto_bundle_register(ofproto, aux, NULL);
530 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
531 * If 'aux' is already registered then this function updates its configuration
532 * to 's'. Otherwise, this function registers a new mirror.
534 * Mirrors affect only the treatment of packets output to the OFPP_NORMAL
537 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
538 const struct ofproto_mirror_settings *s)
540 return (ofproto->ofproto_class->mirror_set
541 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
545 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
546 * If no mirror has been registered, this has no effect. */
548 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
550 return ofproto_mirror_register(ofproto, aux, NULL);
553 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
554 * which all packets are flooded, instead of using MAC learning. If
555 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
557 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
560 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
562 return (ofproto->ofproto_class->set_flood_vlans
563 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
567 /* Returns true if 'aux' is a registered bundle that is currently in use as the
568 * output for a mirror. */
570 ofproto_is_mirror_output_bundle(struct ofproto *ofproto, void *aux)
572 return (ofproto->ofproto_class->is_mirror_output_bundle
573 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
578 ofproto_has_snoops(const struct ofproto *ofproto)
580 return connmgr_has_snoops(ofproto->connmgr);
584 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
586 connmgr_get_snoops(ofproto->connmgr, snoops);
590 ofproto_destroy__(struct ofproto *ofproto)
592 connmgr_destroy(ofproto->connmgr);
594 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
596 free(ofproto->mfr_desc);
597 free(ofproto->hw_desc);
598 free(ofproto->sw_desc);
599 free(ofproto->serial_desc);
600 free(ofproto->dp_desc);
601 netdev_monitor_destroy(ofproto->netdev_monitor);
602 hmap_destroy(&ofproto->ports);
603 shash_destroy(&ofproto->port_by_name);
604 classifier_destroy(&ofproto->cls);
606 ofproto->ofproto_class->dealloc(ofproto);
610 ofproto_destroy(struct ofproto *p)
612 struct ofport *ofport, *next_ofport;
618 ofproto_flush_flows__(p);
619 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
620 hmap_remove(&p->ports, &ofport->hmap_node);
621 ofport_destroy(ofport);
624 p->ofproto_class->destruct(p);
625 ofproto_destroy__(p);
628 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
629 * kernel datapath, for example, this destroys the datapath in the kernel, and
630 * with the netdev-based datapath, it tears down the data structures that
631 * represent the datapath.
633 * The datapath should not be currently open as an ofproto. */
635 ofproto_delete(const char *name, const char *type)
637 const struct ofproto_class *class = ofproto_class_find__(type);
638 return (!class ? EAFNOSUPPORT
639 : !class->del ? EACCES
640 : class->del(type, name));
644 process_port_change(struct ofproto *ofproto, int error, char *devname)
646 if (error == ENOBUFS) {
647 reinit_ports(ofproto);
649 update_port(ofproto, devname);
655 ofproto_run(struct ofproto *p)
660 error = p->ofproto_class->run(p);
661 if (error == ENODEV) {
662 /* Someone destroyed the datapath behind our back. The caller
663 * better destroy us and give up, because we're just going to
664 * spin from here on out. */
665 static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
666 VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
671 if (p->ofproto_class->port_poll) {
672 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
673 process_port_change(p, error, devname);
676 while ((error = netdev_monitor_poll(p->netdev_monitor,
677 &devname)) != EAGAIN) {
678 process_port_change(p, error, devname);
681 connmgr_run(p->connmgr, handle_openflow);
687 ofproto_wait(struct ofproto *p)
689 p->ofproto_class->wait(p);
690 if (p->ofproto_class->port_poll_wait) {
691 p->ofproto_class->port_poll_wait(p);
693 netdev_monitor_poll_wait(p->netdev_monitor);
694 connmgr_wait(p->connmgr);
698 ofproto_is_alive(const struct ofproto *p)
700 return connmgr_has_controllers(p->connmgr);
704 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
707 connmgr_get_controller_info(ofproto->connmgr, info);
711 ofproto_free_ofproto_controller_info(struct shash *info)
713 struct shash_node *node;
715 SHASH_FOR_EACH (node, info) {
716 struct ofproto_controller_info *cinfo = node->data;
717 while (cinfo->pairs.n) {
718 free((char *) cinfo->pairs.values[--cinfo->pairs.n]);
725 /* Makes a deep copy of 'old' into 'port'. */
727 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
729 port->name = xstrdup(old->name);
730 port->type = xstrdup(old->type);
731 port->ofp_port = old->ofp_port;
734 /* Frees memory allocated to members of 'ofproto_port'.
736 * Do not call this function on an ofproto_port obtained from
737 * ofproto_port_dump_next(): that function retains ownership of the data in the
740 ofproto_port_destroy(struct ofproto_port *ofproto_port)
742 free(ofproto_port->name);
743 free(ofproto_port->type);
746 /* Initializes 'dump' to begin dumping the ports in an ofproto.
748 * This function provides no status indication. An error status for the entire
749 * dump operation is provided when it is completed by calling
750 * ofproto_port_dump_done().
753 ofproto_port_dump_start(struct ofproto_port_dump *dump,
754 const struct ofproto *ofproto)
756 dump->ofproto = ofproto;
757 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
761 /* Attempts to retrieve another port from 'dump', which must have been created
762 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
763 * 'port' and returns true. On failure, returns false.
765 * Failure might indicate an actual error or merely that the last port has been
766 * dumped. An error status for the entire dump operation is provided when it
767 * is completed by calling ofproto_port_dump_done().
769 * The ofproto owns the data stored in 'port'. It will remain valid until at
770 * least the next time 'dump' is passed to ofproto_port_dump_next() or
771 * ofproto_port_dump_done(). */
773 ofproto_port_dump_next(struct ofproto_port_dump *dump,
774 struct ofproto_port *port)
776 const struct ofproto *ofproto = dump->ofproto;
782 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
785 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
791 /* Completes port table dump operation 'dump', which must have been created
792 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
793 * error-free, otherwise a positive errno value describing the problem. */
795 ofproto_port_dump_done(struct ofproto_port_dump *dump)
797 const struct ofproto *ofproto = dump->ofproto;
799 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
802 return dump->error == EOF ? 0 : dump->error;
805 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
806 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
807 * is non-null). On failure, returns a positive errno value and sets
808 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
810 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
816 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
818 update_port(ofproto, netdev_get_name(netdev));
821 *ofp_portp = error ? OFPP_NONE : ofp_port;
826 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
827 * initializes '*port' appropriately; on failure, returns a positive errno
830 * The caller owns the data in 'ofproto_port' and must free it with
831 * ofproto_port_destroy() when it is no longer needed. */
833 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
834 struct ofproto_port *port)
838 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
840 memset(port, 0, sizeof *port);
845 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
846 * Returns 0 if successful, otherwise a positive errno. */
848 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
850 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
851 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
854 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
855 if (!error && ofport) {
856 /* 'name' is the netdev's name and update_port() is going to close the
857 * netdev. Just in case update_port() refers to 'name' after it
858 * destroys 'ofport', make a copy of it around the update_port()
860 char *devname = xstrdup(name);
861 update_port(ofproto, devname);
867 /* Adds a flow to the OpenFlow flow table in 'p' that matches 'cls_rule' and
868 * performs the 'n_actions' actions in 'actions'. The new flow will not
871 * If cls_rule->priority is in the range of priorities supported by OpenFlow
872 * (0...65535, inclusive) then the flow will be visible to OpenFlow
873 * controllers; otherwise, it will be hidden.
875 * The caller retains ownership of 'cls_rule' and 'actions'. */
877 ofproto_add_flow(struct ofproto *p, const struct cls_rule *cls_rule,
878 const union ofp_action *actions, size_t n_actions)
881 rule_create(p, cls_rule, actions, n_actions, 0, 0, 0, false, &rule);
885 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
889 rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
892 ofproto_rule_remove(rule);
897 ofproto_flush_flows__(struct ofproto *ofproto)
899 struct rule *rule, *next_rule;
900 struct cls_cursor cursor;
902 COVERAGE_INC(ofproto_flush);
904 if (ofproto->ofproto_class->flush) {
905 ofproto->ofproto_class->flush(ofproto);
908 cls_cursor_init(&cursor, &ofproto->cls, NULL);
909 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
910 ofproto_rule_remove(rule);
915 ofproto_flush_flows(struct ofproto *ofproto)
917 ofproto_flush_flows__(ofproto);
918 connmgr_flushed(ofproto->connmgr);
922 reinit_ports(struct ofproto *p)
924 struct ofproto_port_dump dump;
925 struct sset devnames;
926 struct ofport *ofport;
927 struct ofproto_port ofproto_port;
930 COVERAGE_INC(ofproto_reinit_ports);
932 sset_init(&devnames);
933 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
934 sset_add(&devnames, netdev_get_name(ofport->netdev));
936 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
937 sset_add(&devnames, ofproto_port.name);
940 SSET_FOR_EACH (devname, &devnames) {
941 update_port(p, devname);
943 sset_destroy(&devnames);
946 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
947 * netdev cannot be opened. On success, also fills in 'opp'. */
948 static struct netdev *
949 ofport_open(const struct ofproto_port *ofproto_port, struct ofp_phy_port *opp)
951 uint32_t curr, advertised, supported, peer;
952 struct netdev_options netdev_options;
953 enum netdev_flags flags;
954 struct netdev *netdev;
957 memset(&netdev_options, 0, sizeof netdev_options);
958 netdev_options.name = ofproto_port->name;
959 netdev_options.type = ofproto_port->type;
960 netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
962 error = netdev_open(&netdev_options, &netdev);
964 VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
965 "cannot be opened (%s)",
966 ofproto_port->name, ofproto_port->ofp_port,
967 ofproto_port->name, strerror(error));
971 netdev_get_flags(netdev, &flags);
972 netdev_get_features(netdev, &curr, &advertised, &supported, &peer);
974 opp->port_no = htons(ofproto_port->ofp_port);
975 netdev_get_etheraddr(netdev, opp->hw_addr);
976 ovs_strzcpy(opp->name, ofproto_port->name, sizeof opp->name);
977 opp->config = flags & NETDEV_UP ? 0 : htonl(OFPPC_PORT_DOWN);
978 opp->state = netdev_get_carrier(netdev) ? 0 : htonl(OFPPS_LINK_DOWN);
979 opp->curr = htonl(curr);
980 opp->advertised = htonl(advertised);
981 opp->supported = htonl(supported);
982 opp->peer = htonl(peer);
987 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
988 * port number, and 'config' bits other than OFPPC_PORT_DOWN are
991 ofport_equal(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
993 BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
994 return (!memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
995 && a->state == b->state
996 && !((a->config ^ b->config) & htonl(OFPPC_PORT_DOWN))
997 && a->curr == b->curr
998 && a->advertised == b->advertised
999 && a->supported == b->supported
1000 && a->peer == b->peer);
1003 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1004 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1005 * one with the same name or port number). */
1007 ofport_install(struct ofproto *p,
1008 struct netdev *netdev, const struct ofp_phy_port *opp)
1010 const char *netdev_name = netdev_get_name(netdev);
1011 struct ofport *ofport;
1014 /* Create ofport. */
1015 ofport = p->ofproto_class->port_alloc();
1020 ofport->ofproto = p;
1021 ofport->netdev = netdev;
1023 ofport->ofp_port = ntohs(opp->port_no);
1025 /* Add port to 'p'. */
1026 netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1027 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1028 shash_add(&p->port_by_name, netdev_name, ofport);
1030 /* Let the ofproto_class initialize its private data. */
1031 error = p->ofproto_class->port_construct(ofport);
1035 connmgr_send_port_status(p->connmgr, opp, OFPPR_ADD);
1039 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1040 p->name, netdev_name, strerror(error));
1042 ofport_destroy__(ofport);
1044 netdev_close(netdev);
1048 /* Removes 'ofport' from 'p' and destroys it. */
1050 ofport_remove(struct ofport *ofport)
1052 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->opp,
1054 ofport_destroy(ofport);
1057 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1060 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1062 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1064 ofport_remove(port);
1068 /* Updates 'port' within 'ofproto' with the new 'netdev' and 'opp'.
1070 * Does not handle a name or port number change. The caller must implement
1071 * such a change as a delete followed by an add. */
1073 ofport_modified(struct ofport *port, struct ofp_phy_port *opp)
1075 memcpy(port->opp.hw_addr, opp->hw_addr, ETH_ADDR_LEN);
1076 port->opp.config = ((port->opp.config & ~htonl(OFPPC_PORT_DOWN))
1077 | (opp->config & htonl(OFPPC_PORT_DOWN)));
1078 port->opp.state = opp->state;
1079 port->opp.curr = opp->curr;
1080 port->opp.advertised = opp->advertised;
1081 port->opp.supported = opp->supported;
1082 port->opp.peer = opp->peer;
1084 connmgr_send_port_status(port->ofproto->connmgr, &port->opp, OFPPR_MODIFY);
1088 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1090 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1092 if (port->ofproto->ofproto_class->set_cfm) {
1093 port->ofproto->ofproto_class->set_cfm(port, NULL, NULL, 0);
1095 if (port->ofproto->ofproto_class->bundle_remove) {
1096 port->ofproto->ofproto_class->bundle_remove(port);
1102 ofport_destroy__(struct ofport *port)
1104 struct ofproto *ofproto = port->ofproto;
1105 const char *name = netdev_get_name(port->netdev);
1107 netdev_monitor_remove(ofproto->netdev_monitor, port->netdev);
1108 hmap_remove(&ofproto->ports, &port->hmap_node);
1109 shash_delete(&ofproto->port_by_name,
1110 shash_find(&ofproto->port_by_name, name));
1112 netdev_close(port->netdev);
1113 ofproto->ofproto_class->port_dealloc(port);
1117 ofport_destroy(struct ofport *port)
1120 port->ofproto->ofproto_class->port_destruct(port);
1121 ofport_destroy__(port);
1126 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1128 struct ofport *port;
1130 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1131 hash_int(ofp_port, 0), &ofproto->ports) {
1132 if (port->ofp_port == ofp_port) {
1140 update_port(struct ofproto *ofproto, const char *name)
1142 struct ofproto_port ofproto_port;
1143 struct ofp_phy_port opp;
1144 struct netdev *netdev;
1145 struct ofport *port;
1147 COVERAGE_INC(ofproto_update_port);
1149 /* Fetch 'name''s location and properties from the datapath. */
1150 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1151 ? ofport_open(&ofproto_port, &opp)
1154 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1155 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1156 /* 'name' hasn't changed location. Any properties changed? */
1157 if (!ofport_equal(&port->opp, &opp)) {
1158 ofport_modified(port, &opp);
1161 /* Install the newly opened netdev in case it has changed. */
1162 netdev_monitor_remove(ofproto->netdev_monitor, port->netdev);
1163 netdev_monitor_add(ofproto->netdev_monitor, netdev);
1165 netdev_close(port->netdev);
1166 port->netdev = netdev;
1168 if (port->ofproto->ofproto_class->port_modified) {
1169 port->ofproto->ofproto_class->port_modified(port);
1172 /* If 'port' is nonnull then its name differs from 'name' and thus
1173 * we should delete it. If we think there's a port named 'name'
1174 * then its port number must be wrong now so delete it too. */
1176 ofport_remove(port);
1178 ofport_remove_with_name(ofproto, name);
1179 ofport_install(ofproto, netdev, &opp);
1182 /* Any port named 'name' is gone now. */
1183 ofport_remove_with_name(ofproto, name);
1185 ofproto_port_destroy(&ofproto_port);
1189 init_ports(struct ofproto *p)
1191 struct ofproto_port_dump dump;
1192 struct ofproto_port ofproto_port;
1194 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1195 uint16_t ofp_port = ofproto_port.ofp_port;
1196 if (ofproto_get_port(p, ofp_port)) {
1197 VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1199 } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1200 VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1203 struct ofp_phy_port opp;
1204 struct netdev *netdev;
1206 netdev = ofport_open(&ofproto_port, &opp);
1208 ofport_install(p, netdev, &opp);
1216 /* Creates a new rule initialized as specified, inserts it into 'ofproto''s
1217 * flow table, and stores the new rule into '*rulep'. Returns 0 on success,
1218 * otherwise a positive errno value or OpenFlow error code. */
1220 rule_create(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1221 const union ofp_action *actions, size_t n_actions,
1222 uint16_t idle_timeout, uint16_t hard_timeout,
1223 ovs_be64 flow_cookie, bool send_flow_removed,
1224 struct rule **rulep)
1229 rule = ofproto->ofproto_class->rule_alloc();
1235 rule->ofproto = ofproto;
1236 rule->cr = *cls_rule;
1237 rule->flow_cookie = flow_cookie;
1238 rule->created = time_msec();
1239 rule->idle_timeout = idle_timeout;
1240 rule->hard_timeout = hard_timeout;
1241 rule->send_flow_removed = send_flow_removed;
1242 if (n_actions > 0) {
1243 rule->actions = xmemdup(actions, n_actions * sizeof *actions);
1245 rule->actions = NULL;
1247 rule->n_actions = n_actions;
1249 error = ofproto->ofproto_class->rule_construct(rule);
1251 ofproto_rule_destroy__(rule);
1259 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
1260 ofproto->name, strerror(error));
1266 ofproto_rule_destroy__(struct rule *rule)
1268 free(rule->actions);
1269 rule->ofproto->ofproto_class->rule_dealloc(rule);
1272 /* Destroys 'rule' and removes it from the datapath.
1274 * The caller must have already removed 'rule' from the classifier. */
1276 ofproto_rule_destroy(struct rule *rule)
1278 rule->ofproto->ofproto_class->rule_destruct(rule);
1279 ofproto_rule_destroy__(rule);
1282 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1283 * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1286 rule_has_out_port(const struct rule *rule, ovs_be16 out_port)
1288 const union ofp_action *oa;
1289 struct actions_iterator i;
1291 if (out_port == htons(OFPP_NONE)) {
1294 for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
1295 oa = actions_next(&i)) {
1296 if (action_outputs_to_port(oa, out_port)) {
1304 ofproto_rule_lookup(struct ofproto *ofproto, const struct flow *flow)
1306 return rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
1309 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1310 * statistics appropriately. 'packet' must have at least sizeof(struct
1311 * ofp_packet_in) bytes of headroom.
1313 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1314 * with statistics for 'packet' either way.
1316 * Takes ownership of 'packet'. */
1318 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1322 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1324 flow_extract(packet, 0, in_port, &flow);
1325 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1328 /* Removes 'rule' from 'ofproto' and frees up the associated memory. Removes
1329 * 'rule' from the classifier. */
1331 ofproto_rule_remove(struct rule *rule)
1333 rule->ofproto->ofproto_class->rule_remove(rule);
1334 ofproto_rule_destroy(rule);
1337 /* Returns true if 'rule' should be hidden from the controller.
1339 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1340 * (e.g. by in-band control) and are intentionally hidden from the
1343 rule_is_hidden(const struct rule *rule)
1345 return rule->cr.priority > UINT16_MAX;
1349 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
1352 struct ofpbuf *buf = ofputil_encode_error_msg(error, oh);
1354 COVERAGE_INC(ofproto_error);
1355 ofconn_send_reply(ofconn, buf);
1360 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1362 ofconn_send_reply(ofconn, make_echo_reply(oh));
1367 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1369 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1370 struct ofp_switch_features *osf;
1372 struct ofport *port;
1374 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1375 osf->datapath_id = htonll(ofproto->datapath_id);
1376 osf->n_buffers = htonl(pktbuf_capacity());
1378 osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1379 OFPC_PORT_STATS | OFPC_ARP_MATCH_IP);
1380 osf->actions = htonl((1u << OFPAT_OUTPUT) |
1381 (1u << OFPAT_SET_VLAN_VID) |
1382 (1u << OFPAT_SET_VLAN_PCP) |
1383 (1u << OFPAT_STRIP_VLAN) |
1384 (1u << OFPAT_SET_DL_SRC) |
1385 (1u << OFPAT_SET_DL_DST) |
1386 (1u << OFPAT_SET_NW_SRC) |
1387 (1u << OFPAT_SET_NW_DST) |
1388 (1u << OFPAT_SET_NW_TOS) |
1389 (1u << OFPAT_SET_TP_SRC) |
1390 (1u << OFPAT_SET_TP_DST) |
1391 (1u << OFPAT_ENQUEUE));
1393 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1394 ofpbuf_put(buf, &port->opp, sizeof port->opp);
1397 ofconn_send_reply(ofconn, buf);
1402 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1404 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1406 struct ofp_switch_config *osc;
1410 /* Figure out flags. */
1411 drop_frags = ofproto->ofproto_class->get_drop_frags(ofproto);
1412 flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
1415 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1416 osc->flags = htons(flags);
1417 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1418 ofconn_send_reply(ofconn, buf);
1424 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1426 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1427 uint16_t flags = ntohs(osc->flags);
1429 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1430 && ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1431 switch (flags & OFPC_FRAG_MASK) {
1432 case OFPC_FRAG_NORMAL:
1433 ofproto->ofproto_class->set_drop_frags(ofproto, false);
1435 case OFPC_FRAG_DROP:
1436 ofproto->ofproto_class->set_drop_frags(ofproto, true);
1439 VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
1445 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1450 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1451 * error message code (composed with ofp_mkerr()) for the caller to propagate
1452 * upward. Otherwise, returns 0.
1454 * The log message mentions 'msg_type'. */
1456 reject_slave_controller(struct ofconn *ofconn, const const char *msg_type)
1458 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1459 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1460 static struct vlog_rate_limit perm_rl = VLOG_RATE_LIMIT_INIT(1, 5);
1461 VLOG_WARN_RL(&perm_rl, "rejecting %s message from slave controller",
1464 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
1471 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1473 struct ofproto *p = ofconn_get_ofproto(ofconn);
1474 struct ofp_packet_out *opo;
1475 struct ofpbuf payload, *buffer;
1476 union ofp_action *ofp_actions;
1477 struct ofpbuf request;
1479 size_t n_ofp_actions;
1483 COVERAGE_INC(ofproto_packet_out);
1485 error = reject_slave_controller(ofconn, "OFPT_PACKET_OUT");
1490 /* Get ofp_packet_out. */
1491 ofpbuf_use_const(&request, oh, ntohs(oh->length));
1492 opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1495 error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1496 &ofp_actions, &n_ofp_actions);
1502 if (opo->buffer_id != htonl(UINT32_MAX)) {
1503 error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1505 if (error || !buffer) {
1514 /* Send out packet. */
1515 flow_extract(&payload, 0, ntohs(opo->in_port), &flow);
1516 error = p->ofproto_class->packet_out(p, &payload, &flow,
1517 ofp_actions, n_ofp_actions);
1518 ofpbuf_delete(buffer);
1524 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1526 ovs_be32 old_config = port->opp.config;
1528 mask &= config ^ port->opp.config;
1529 if (mask & htonl(OFPPC_PORT_DOWN)) {
1530 if (config & htonl(OFPPC_PORT_DOWN)) {
1531 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1533 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1537 port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1538 OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1539 OFPPC_NO_PACKET_IN));
1540 if (port->opp.config != old_config) {
1541 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1546 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1548 struct ofproto *p = ofconn_get_ofproto(ofconn);
1549 const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1550 struct ofport *port;
1553 error = reject_slave_controller(ofconn, "OFPT_PORT_MOD");
1558 port = ofproto_get_port(p, ntohs(opm->port_no));
1560 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
1561 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1562 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
1564 update_port_config(port, opm->config, opm->mask);
1565 if (opm->advertise) {
1566 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1572 static struct ofpbuf *
1573 make_ofp_stats_reply(ovs_be32 xid, ovs_be16 type, size_t body_len)
1575 struct ofp_stats_reply *osr;
1578 msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
1579 osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
1581 osr->flags = htons(0);
1585 static struct ofpbuf *
1586 start_ofp_stats_reply(const struct ofp_header *request, size_t body_len)
1588 const struct ofp_stats_request *osr
1589 = (const struct ofp_stats_request *) request;
1590 return make_ofp_stats_reply(osr->header.xid, osr->type, body_len);
1594 append_ofp_stats_reply(size_t nbytes, struct ofconn *ofconn,
1595 struct ofpbuf **msgp)
1597 struct ofpbuf *msg = *msgp;
1598 assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
1599 if (nbytes + msg->size > UINT16_MAX) {
1600 struct ofp_stats_reply *reply = msg->data;
1601 reply->flags = htons(OFPSF_REPLY_MORE);
1602 *msgp = make_ofp_stats_reply(reply->header.xid, reply->type, nbytes);
1603 ofconn_send_reply(ofconn, msg);
1605 return ofpbuf_put_uninit(*msgp, nbytes);
1608 static struct ofpbuf *
1609 make_nxstats_reply(ovs_be32 xid, ovs_be32 subtype, size_t body_len)
1611 struct nicira_stats_msg *nsm;
1614 msg = ofpbuf_new(MIN(sizeof *nsm + body_len, UINT16_MAX));
1615 nsm = put_openflow_xid(sizeof *nsm, OFPT_STATS_REPLY, xid, msg);
1616 nsm->type = htons(OFPST_VENDOR);
1617 nsm->flags = htons(0);
1618 nsm->vendor = htonl(NX_VENDOR_ID);
1619 nsm->subtype = subtype;
1623 static struct ofpbuf *
1624 start_nxstats_reply(const struct nicira_stats_msg *request, size_t body_len)
1626 return make_nxstats_reply(request->header.xid, request->subtype, body_len);
1630 append_nxstats_reply(size_t nbytes, struct ofconn *ofconn,
1631 struct ofpbuf **msgp)
1633 struct ofpbuf *msg = *msgp;
1634 assert(nbytes <= UINT16_MAX - sizeof(struct nicira_stats_msg));
1635 if (nbytes + msg->size > UINT16_MAX) {
1636 struct nicira_stats_msg *reply = msg->data;
1637 reply->flags = htons(OFPSF_REPLY_MORE);
1638 *msgp = make_nxstats_reply(reply->header.xid, reply->subtype, nbytes);
1639 ofconn_send_reply(ofconn, msg);
1641 ofpbuf_prealloc_tailroom(*msgp, nbytes);
1645 handle_desc_stats_request(struct ofconn *ofconn,
1646 const struct ofp_header *request)
1648 struct ofproto *p = ofconn_get_ofproto(ofconn);
1649 struct ofp_desc_stats *ods;
1652 msg = start_ofp_stats_reply(request, sizeof *ods);
1653 ods = append_ofp_stats_reply(sizeof *ods, ofconn, &msg);
1654 memset(ods, 0, sizeof *ods);
1655 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1656 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1657 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1658 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1659 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1660 ofconn_send_reply(ofconn, msg);
1666 handle_table_stats_request(struct ofconn *ofconn,
1667 const struct ofp_header *request)
1669 struct ofproto *p = ofconn_get_ofproto(ofconn);
1670 struct ofp_table_stats *ots;
1673 msg = start_ofp_stats_reply(request, sizeof *ots * 2);
1675 /* Classifier table. */
1676 ots = append_ofp_stats_reply(sizeof *ots, ofconn, &msg);
1677 memset(ots, 0, sizeof *ots);
1678 strcpy(ots->name, "classifier");
1679 ots->wildcards = (ofconn_get_flow_format(ofconn) == NXFF_OPENFLOW10
1680 ? htonl(OFPFW_ALL) : htonl(OVSFW_ALL));
1681 ots->max_entries = htonl(1024 * 1024); /* An arbitrary big number. */
1682 ots->active_count = htonl(classifier_count(&p->cls));
1683 put_32aligned_be64(&ots->lookup_count, htonll(0)); /* XXX */
1684 put_32aligned_be64(&ots->matched_count, htonll(0)); /* XXX */
1686 ofconn_send_reply(ofconn, msg);
1691 append_port_stat(struct ofport *port, struct ofconn *ofconn,
1692 struct ofpbuf **msgp)
1694 struct netdev_stats stats;
1695 struct ofp_port_stats *ops;
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);
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));
1720 handle_port_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
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;
1726 struct ofport *port;
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));
1732 append_port_stat(port, ofconn, &msg);
1735 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
1736 append_port_stat(port, ofconn, &msg);
1740 ofconn_send_reply(ofconn, msg);
1745 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
1747 long long int msecs = time_msec() - start;
1748 *sec = msecs / 1000;
1749 *nsec = (msecs % 1000) * (1000 * 1000);
1753 calc_flow_duration(long long int start, ovs_be32 *sec_be, ovs_be32 *nsec_be)
1757 calc_flow_duration__(start, &sec, &nsec);
1758 *sec_be = htonl(sec);
1759 *nsec_be = htonl(nsec);
1763 put_ofp_flow_stats(struct ofconn *ofconn, struct rule *rule,
1764 ovs_be16 out_port, struct ofpbuf **replyp)
1766 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1767 struct ofp_flow_stats *ofs;
1768 uint64_t packet_count, byte_count;
1770 size_t act_len, len;
1772 if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
1776 act_len = sizeof *rule->actions * rule->n_actions;
1777 len = offsetof(struct ofp_flow_stats, actions) + act_len;
1779 ofproto->ofproto_class->rule_get_stats(rule, &packet_count, &byte_count);
1781 ofs = append_ofp_stats_reply(len, ofconn, replyp);
1782 ofs->length = htons(len);
1785 ofputil_cls_rule_to_match(&rule->cr, ofconn_get_flow_format(ofconn),
1786 &ofs->match, rule->flow_cookie, &cookie);
1787 put_32aligned_be64(&ofs->cookie, cookie);
1788 calc_flow_duration(rule->created, &ofs->duration_sec, &ofs->duration_nsec);
1789 ofs->priority = htons(rule->cr.priority);
1790 ofs->idle_timeout = htons(rule->idle_timeout);
1791 ofs->hard_timeout = htons(rule->hard_timeout);
1792 memset(ofs->pad2, 0, sizeof ofs->pad2);
1793 put_32aligned_be64(&ofs->packet_count, htonll(packet_count));
1794 put_32aligned_be64(&ofs->byte_count, htonll(byte_count));
1795 if (rule->n_actions > 0) {
1796 memcpy(ofs->actions, rule->actions, act_len);
1801 is_valid_table(uint8_t table_id)
1803 if (table_id == 0 || table_id == 0xff) {
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
1809 VLOG_WARN_RL(&rl, "controller asked for invalid table %"PRIu8,
1816 handle_flow_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
1818 const struct ofp_flow_stats_request *fsr = ofputil_stats_body(oh);
1819 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1820 struct ofpbuf *reply;
1822 COVERAGE_INC(ofproto_flows_req);
1823 reply = start_ofp_stats_reply(oh, 1024);
1824 if (is_valid_table(fsr->table_id)) {
1825 struct cls_cursor cursor;
1826 struct cls_rule target;
1829 ofputil_cls_rule_from_match(&fsr->match, 0, NXFF_OPENFLOW10, 0,
1831 cls_cursor_init(&cursor, &ofproto->cls, &target);
1832 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1833 put_ofp_flow_stats(ofconn, rule, fsr->out_port, &reply);
1836 ofconn_send_reply(ofconn, reply);
1842 put_nx_flow_stats(struct ofconn *ofconn, struct rule *rule,
1843 ovs_be16 out_port, struct ofpbuf **replyp)
1845 struct nx_flow_stats *nfs;
1846 uint64_t packet_count, byte_count;
1847 size_t act_len, start_len;
1848 struct ofpbuf *reply;
1850 if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
1854 rule->ofproto->ofproto_class->rule_get_stats(rule,
1855 &packet_count, &byte_count);
1857 act_len = sizeof *rule->actions * rule->n_actions;
1859 append_nxstats_reply(sizeof *nfs + NXM_MAX_LEN + act_len, ofconn, replyp);
1860 start_len = (*replyp)->size;
1863 nfs = ofpbuf_put_uninit(reply, sizeof *nfs);
1866 calc_flow_duration(rule->created, &nfs->duration_sec, &nfs->duration_nsec);
1867 nfs->cookie = rule->flow_cookie;
1868 nfs->priority = htons(rule->cr.priority);
1869 nfs->idle_timeout = htons(rule->idle_timeout);
1870 nfs->hard_timeout = htons(rule->hard_timeout);
1871 nfs->match_len = htons(nx_put_match(reply, &rule->cr));
1872 memset(nfs->pad2, 0, sizeof nfs->pad2);
1873 nfs->packet_count = htonll(packet_count);
1874 nfs->byte_count = htonll(byte_count);
1875 if (rule->n_actions > 0) {
1876 ofpbuf_put(reply, rule->actions, act_len);
1878 nfs->length = htons(reply->size - start_len);
1882 handle_nxst_flow(struct ofconn *ofconn, const struct ofp_header *oh)
1884 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1885 struct nx_flow_stats_request *nfsr;
1886 struct cls_rule target;
1887 struct ofpbuf *reply;
1891 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1893 /* Dissect the message. */
1894 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1895 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &target);
1900 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1903 COVERAGE_INC(ofproto_flows_req);
1904 reply = start_nxstats_reply(&nfsr->nsm, 1024);
1905 if (is_valid_table(nfsr->table_id)) {
1906 struct cls_cursor cursor;
1909 cls_cursor_init(&cursor, &ofproto->cls, &target);
1910 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1911 put_nx_flow_stats(ofconn, rule, nfsr->out_port, &reply);
1914 ofconn_send_reply(ofconn, reply);
1920 flow_stats_ds(struct rule *rule, struct ds *results)
1922 uint64_t packet_count, byte_count;
1923 size_t act_len = sizeof *rule->actions * rule->n_actions;
1925 rule->ofproto->ofproto_class->rule_get_stats(rule,
1926 &packet_count, &byte_count);
1928 ds_put_format(results, "duration=%llds, ",
1929 (time_msec() - rule->created) / 1000);
1930 ds_put_format(results, "priority=%u, ", rule->cr.priority);
1931 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
1932 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
1933 cls_rule_format(&rule->cr, results);
1934 ds_put_char(results, ',');
1936 ofp_print_actions(results, &rule->actions->header, act_len);
1938 ds_put_cstr(results, "drop");
1940 ds_put_cstr(results, "\n");
1943 /* Adds a pretty-printed description of all flows to 'results', including
1944 * hidden flows (e.g., set up by in-band control). */
1946 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
1948 struct cls_cursor cursor;
1951 cls_cursor_init(&cursor, &p->cls, NULL);
1952 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1953 flow_stats_ds(rule, results);
1957 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
1958 * '*engine_type' and '*engine_id', respectively. */
1960 ofproto_get_netflow_ids(const struct ofproto *ofproto,
1961 uint8_t *engine_type, uint8_t *engine_id)
1963 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
1967 query_aggregate_stats(struct ofproto *ofproto, struct cls_rule *target,
1968 ovs_be16 out_port, uint8_t table_id,
1969 struct ofp_aggregate_stats_reply *oasr)
1971 uint64_t total_packets = 0;
1972 uint64_t total_bytes = 0;
1975 COVERAGE_INC(ofproto_agg_request);
1977 if (is_valid_table(table_id)) {
1978 struct cls_cursor cursor;
1981 cls_cursor_init(&cursor, &ofproto->cls, target);
1982 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1983 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
1984 uint64_t packet_count;
1985 uint64_t byte_count;
1987 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
1990 total_packets += packet_count;
1991 total_bytes += byte_count;
1997 oasr->flow_count = htonl(n_flows);
1998 put_32aligned_be64(&oasr->packet_count, htonll(total_packets));
1999 put_32aligned_be64(&oasr->byte_count, htonll(total_bytes));
2000 memset(oasr->pad, 0, sizeof oasr->pad);
2004 handle_aggregate_stats_request(struct ofconn *ofconn,
2005 const struct ofp_header *oh)
2007 const struct ofp_aggregate_stats_request *request = ofputil_stats_body(oh);
2008 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2009 struct ofp_aggregate_stats_reply *reply;
2010 struct cls_rule target;
2013 ofputil_cls_rule_from_match(&request->match, 0, NXFF_OPENFLOW10, 0,
2016 msg = start_ofp_stats_reply(oh, sizeof *reply);
2017 reply = append_ofp_stats_reply(sizeof *reply, ofconn, &msg);
2018 query_aggregate_stats(ofproto, &target, request->out_port,
2019 request->table_id, reply);
2020 ofconn_send_reply(ofconn, msg);
2025 handle_nxst_aggregate(struct ofconn *ofconn, const struct ofp_header *oh)
2027 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2028 struct nx_aggregate_stats_request *request;
2029 struct ofp_aggregate_stats_reply *reply;
2030 struct cls_rule target;
2035 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2037 /* Dissect the message. */
2038 request = ofpbuf_pull(&b, sizeof *request);
2039 error = nx_pull_match(&b, ntohs(request->match_len), 0, &target);
2044 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2048 COVERAGE_INC(ofproto_flows_req);
2049 buf = start_nxstats_reply(&request->nsm, sizeof *reply);
2050 reply = ofpbuf_put_uninit(buf, sizeof *reply);
2051 query_aggregate_stats(ofproto, &target, request->out_port,
2052 request->table_id, reply);
2053 ofconn_send_reply(ofconn, buf);
2058 struct queue_stats_cbdata {
2059 struct ofconn *ofconn;
2060 struct ofport *ofport;
2065 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2066 const struct netdev_queue_stats *stats)
2068 struct ofp_queue_stats *reply;
2070 reply = append_ofp_stats_reply(sizeof *reply, cbdata->ofconn, &cbdata->msg);
2071 reply->port_no = cbdata->ofport->opp.port_no;
2072 memset(reply->pad, 0, sizeof reply->pad);
2073 reply->queue_id = htonl(queue_id);
2074 put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2075 put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2076 put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2080 handle_queue_stats_dump_cb(uint32_t queue_id,
2081 struct netdev_queue_stats *stats,
2084 struct queue_stats_cbdata *cbdata = cbdata_;
2086 put_queue_stats(cbdata, queue_id, stats);
2090 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2091 struct queue_stats_cbdata *cbdata)
2093 cbdata->ofport = port;
2094 if (queue_id == OFPQ_ALL) {
2095 netdev_dump_queue_stats(port->netdev,
2096 handle_queue_stats_dump_cb, cbdata);
2098 struct netdev_queue_stats stats;
2100 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2101 put_queue_stats(cbdata, queue_id, &stats);
2107 handle_queue_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
2109 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2110 const struct ofp_queue_stats_request *qsr;
2111 struct queue_stats_cbdata cbdata;
2112 struct ofport *port;
2113 unsigned int port_no;
2116 qsr = ofputil_stats_body(oh);
2118 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2121 COVERAGE_INC(ofproto_queue_req);
2123 cbdata.ofconn = ofconn;
2124 cbdata.msg = start_ofp_stats_reply(oh, 128);
2126 port_no = ntohs(qsr->port_no);
2127 queue_id = ntohl(qsr->queue_id);
2128 if (port_no == OFPP_ALL) {
2129 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2130 handle_queue_stats_for_port(port, queue_id, &cbdata);
2132 } else if (port_no < OFPP_MAX) {
2133 port = ofproto_get_port(ofproto, port_no);
2135 handle_queue_stats_for_port(port, queue_id, &cbdata);
2138 ofpbuf_delete(cbdata.msg);
2139 return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
2141 ofconn_send_reply(ofconn, cbdata.msg);
2146 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2147 * in which no matching flow already exists in the flow table.
2149 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2150 * ofp_actions, to the ofproto's flow table. Returns 0 on success or an
2151 * OpenFlow error code as encoded by ofp_mkerr() on failure.
2153 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2156 add_flow(struct ofconn *ofconn, struct flow_mod *fm)
2158 struct ofproto *p = ofconn_get_ofproto(ofconn);
2159 struct ofpbuf *packet;
2165 if (fm->flags & OFPFF_CHECK_OVERLAP
2166 && classifier_rule_overlaps(&p->cls, &fm->cr)) {
2167 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
2170 buf_err = ofconn_pktbuf_retrieve(ofconn, fm->buffer_id, &packet, &in_port);
2171 error = rule_create(p, &fm->cr, fm->actions, fm->n_actions,
2172 fm->idle_timeout, fm->hard_timeout, fm->cookie,
2173 fm->flags & OFPFF_SEND_FLOW_REM, &rule);
2175 ofpbuf_delete(packet);
2181 return rule_execute(rule, in_port, packet);
2186 static struct rule *
2187 find_flow_strict(struct ofproto *p, const struct flow_mod *fm)
2189 return rule_from_cls_rule(classifier_find_rule_exactly(&p->cls, &fm->cr));
2193 send_buffered_packet(struct ofconn *ofconn,
2194 struct rule *rule, uint32_t buffer_id)
2196 struct ofpbuf *packet;
2200 if (buffer_id == UINT32_MAX) {
2204 error = ofconn_pktbuf_retrieve(ofconn, buffer_id, &packet, &in_port);
2209 return rule_execute(rule, in_port, packet);
2212 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2214 struct modify_flows_cbdata {
2215 struct ofproto *ofproto;
2216 const struct flow_mod *fm;
2220 static int modify_flow(const struct flow_mod *, struct rule *);
2222 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code as
2223 * encoded by ofp_mkerr() on failure.
2225 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2228 modify_flows_loose(struct ofconn *ofconn, struct flow_mod *fm)
2230 struct ofproto *p = ofconn_get_ofproto(ofconn);
2231 struct rule *match = NULL;
2232 struct cls_cursor cursor;
2237 cls_cursor_init(&cursor, &p->cls, &fm->cr);
2238 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2239 if (!rule_is_hidden(rule)) {
2240 int retval = modify_flow(fm, rule);
2252 /* This credits the packet to whichever flow happened to match last.
2253 * That's weird. Maybe we should do a lookup for the flow that
2254 * actually matches the packet? Who knows. */
2255 send_buffered_packet(ofconn, match, fm->buffer_id);
2258 return add_flow(ofconn, fm);
2262 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2263 * code as encoded by ofp_mkerr() on failure.
2265 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2268 modify_flow_strict(struct ofconn *ofconn, struct flow_mod *fm)
2270 struct ofproto *p = ofconn_get_ofproto(ofconn);
2271 struct rule *rule = find_flow_strict(p, fm);
2272 if (rule && !rule_is_hidden(rule)) {
2273 int error = modify_flow(fm, rule);
2275 error = send_buffered_packet(ofconn, rule, fm->buffer_id);
2279 return add_flow(ofconn, fm);
2283 /* Implements core of OFPFC_MODIFY and OFPFC_MODIFY_STRICT where 'rule' has
2284 * been identified as a flow to be modified, by changing the rule's actions to
2285 * match those in 'ofm' (which is followed by 'n_actions' ofp_action[]
2288 modify_flow(const struct flow_mod *fm, struct rule *rule)
2290 size_t actions_len = fm->n_actions * sizeof *rule->actions;
2293 if (fm->n_actions == rule->n_actions
2295 || !memcmp(fm->actions, rule->actions, actions_len))) {
2298 error = rule->ofproto->ofproto_class->rule_modify_actions(
2299 rule, fm->actions, fm->n_actions);
2301 free(rule->actions);
2302 rule->actions = (fm->n_actions
2303 ? xmemdup(fm->actions, actions_len)
2305 rule->n_actions = fm->n_actions;
2310 rule->flow_cookie = fm->cookie;
2316 /* OFPFC_DELETE implementation. */
2318 static void delete_flow(struct rule *, ovs_be16 out_port);
2320 /* Implements OFPFC_DELETE. */
2322 delete_flows_loose(struct ofproto *p, const struct flow_mod *fm)
2324 struct rule *rule, *next_rule;
2325 struct cls_cursor cursor;
2327 cls_cursor_init(&cursor, &p->cls, &fm->cr);
2328 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
2329 delete_flow(rule, htons(fm->out_port));
2333 /* Implements OFPFC_DELETE_STRICT. */
2335 delete_flow_strict(struct ofproto *p, struct flow_mod *fm)
2337 struct rule *rule = find_flow_strict(p, fm);
2339 delete_flow(rule, htons(fm->out_port));
2343 /* Implements core of OFPFC_DELETE and OFPFC_DELETE_STRICT where 'rule' has
2344 * been identified as a flow to delete from 'p''s flow table, by deleting the
2345 * flow and sending out a OFPT_FLOW_REMOVED message to any interested
2348 * Will not delete 'rule' if it is hidden. Will delete 'rule' only if
2349 * 'out_port' is htons(OFPP_NONE) or if 'rule' actually outputs to the
2350 * specified 'out_port'. */
2352 delete_flow(struct rule *rule, ovs_be16 out_port)
2354 if (rule_is_hidden(rule)) {
2358 if (out_port != htons(OFPP_NONE) && !rule_has_out_port(rule, out_port)) {
2362 ofproto_rule_send_removed(rule, OFPRR_DELETE);
2363 ofproto_rule_remove(rule);
2367 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2369 struct ofputil_flow_removed fr;
2371 if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2376 fr.cookie = rule->flow_cookie;
2378 calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2379 fr.idle_timeout = rule->idle_timeout;
2380 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2383 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2386 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2387 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2390 * ofproto implementation ->run() functions should use this function to expire
2391 * OpenFlow flows. */
2393 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2395 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2396 ofproto_rule_send_removed(rule, reason);
2397 ofproto_rule_remove(rule);
2401 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2403 struct ofproto *p = ofconn_get_ofproto(ofconn);
2407 error = reject_slave_controller(ofconn, "flow_mod");
2412 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_flow_format(ofconn));
2417 /* We do not support the emergency flow cache. It will hopefully get
2418 * dropped from OpenFlow in the near future. */
2419 if (fm.flags & OFPFF_EMERG) {
2420 /* There isn't a good fit for an error code, so just state that the
2421 * flow table is full. */
2422 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
2425 switch (fm.command) {
2427 return add_flow(ofconn, &fm);
2430 return modify_flows_loose(ofconn, &fm);
2432 case OFPFC_MODIFY_STRICT:
2433 return modify_flow_strict(ofconn, &fm);
2436 delete_flows_loose(p, &fm);
2439 case OFPFC_DELETE_STRICT:
2440 delete_flow_strict(p, &fm);
2444 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2449 handle_tun_id_from_cookie(struct ofconn *ofconn, const struct ofp_header *oh)
2451 const struct nxt_tun_id_cookie *msg
2452 = (const struct nxt_tun_id_cookie *) oh;
2453 enum nx_flow_format flow_format;
2455 flow_format = msg->set ? NXFF_TUN_ID_FROM_COOKIE : NXFF_OPENFLOW10;
2456 ofconn_set_flow_format(ofconn, flow_format);
2462 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2464 struct nx_role_request *nrr = (struct nx_role_request *) oh;
2465 struct nx_role_request *reply;
2469 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2470 VLOG_WARN_RL(&rl, "ignoring role request on service connection");
2471 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2474 role = ntohl(nrr->role);
2475 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2476 && role != NX_ROLE_SLAVE) {
2477 VLOG_WARN_RL(&rl, "received request for unknown role %"PRIu32, role);
2479 /* There's no good error code for this. */
2480 return ofp_mkerr(OFPET_BAD_REQUEST, -1);
2483 ofconn_set_role(ofconn, role);
2485 reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2486 reply->role = htonl(role);
2487 ofconn_send_reply(ofconn, buf);
2493 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2495 const struct nxt_set_flow_format *msg
2496 = (const struct nxt_set_flow_format *) oh;
2499 format = ntohl(msg->format);
2500 if (format == NXFF_OPENFLOW10
2501 || format == NXFF_TUN_ID_FROM_COOKIE
2502 || format == NXFF_NXM) {
2503 ofconn_set_flow_format(ofconn, format);
2506 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2511 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2513 struct ofp_header *ob;
2516 /* Currently, everything executes synchronously, so we can just
2517 * immediately send the barrier reply. */
2518 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2519 ofconn_send_reply(ofconn, buf);
2524 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2526 const struct ofp_header *oh = msg->data;
2527 const struct ofputil_msg_type *type;
2530 error = ofputil_decode_msg_type(oh, &type);
2535 switch (ofputil_msg_type_code(type)) {
2536 /* OpenFlow requests. */
2537 case OFPUTIL_OFPT_ECHO_REQUEST:
2538 return handle_echo_request(ofconn, oh);
2540 case OFPUTIL_OFPT_FEATURES_REQUEST:
2541 return handle_features_request(ofconn, oh);
2543 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2544 return handle_get_config_request(ofconn, oh);
2546 case OFPUTIL_OFPT_SET_CONFIG:
2547 return handle_set_config(ofconn, msg->data);
2549 case OFPUTIL_OFPT_PACKET_OUT:
2550 return handle_packet_out(ofconn, oh);
2552 case OFPUTIL_OFPT_PORT_MOD:
2553 return handle_port_mod(ofconn, oh);
2555 case OFPUTIL_OFPT_FLOW_MOD:
2556 return handle_flow_mod(ofconn, oh);
2558 case OFPUTIL_OFPT_BARRIER_REQUEST:
2559 return handle_barrier_request(ofconn, oh);
2561 /* OpenFlow replies. */
2562 case OFPUTIL_OFPT_ECHO_REPLY:
2565 /* Nicira extension requests. */
2566 case OFPUTIL_NXT_TUN_ID_FROM_COOKIE:
2567 return handle_tun_id_from_cookie(ofconn, oh);
2569 case OFPUTIL_NXT_ROLE_REQUEST:
2570 return handle_role_request(ofconn, oh);
2572 case OFPUTIL_NXT_SET_FLOW_FORMAT:
2573 return handle_nxt_set_flow_format(ofconn, oh);
2575 case OFPUTIL_NXT_FLOW_MOD:
2576 return handle_flow_mod(ofconn, oh);
2578 /* OpenFlow statistics requests. */
2579 case OFPUTIL_OFPST_DESC_REQUEST:
2580 return handle_desc_stats_request(ofconn, oh);
2582 case OFPUTIL_OFPST_FLOW_REQUEST:
2583 return handle_flow_stats_request(ofconn, oh);
2585 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
2586 return handle_aggregate_stats_request(ofconn, oh);
2588 case OFPUTIL_OFPST_TABLE_REQUEST:
2589 return handle_table_stats_request(ofconn, oh);
2591 case OFPUTIL_OFPST_PORT_REQUEST:
2592 return handle_port_stats_request(ofconn, oh);
2594 case OFPUTIL_OFPST_QUEUE_REQUEST:
2595 return handle_queue_stats_request(ofconn, oh);
2597 /* Nicira extension statistics requests. */
2598 case OFPUTIL_NXST_FLOW_REQUEST:
2599 return handle_nxst_flow(ofconn, oh);
2601 case OFPUTIL_NXST_AGGREGATE_REQUEST:
2602 return handle_nxst_aggregate(ofconn, oh);
2604 case OFPUTIL_INVALID:
2605 case OFPUTIL_OFPT_HELLO:
2606 case OFPUTIL_OFPT_ERROR:
2607 case OFPUTIL_OFPT_FEATURES_REPLY:
2608 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
2609 case OFPUTIL_OFPT_PACKET_IN:
2610 case OFPUTIL_OFPT_FLOW_REMOVED:
2611 case OFPUTIL_OFPT_PORT_STATUS:
2612 case OFPUTIL_OFPT_BARRIER_REPLY:
2613 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
2614 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
2615 case OFPUTIL_OFPST_DESC_REPLY:
2616 case OFPUTIL_OFPST_FLOW_REPLY:
2617 case OFPUTIL_OFPST_QUEUE_REPLY:
2618 case OFPUTIL_OFPST_PORT_REPLY:
2619 case OFPUTIL_OFPST_TABLE_REPLY:
2620 case OFPUTIL_OFPST_AGGREGATE_REPLY:
2621 case OFPUTIL_NXT_ROLE_REPLY:
2622 case OFPUTIL_NXT_FLOW_REMOVED:
2623 case OFPUTIL_NXST_FLOW_REPLY:
2624 case OFPUTIL_NXST_AGGREGATE_REPLY:
2626 if (VLOG_IS_WARN_ENABLED()) {
2627 char *s = ofp_to_string(oh, ntohs(oh->length), 2);
2628 VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
2631 if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
2632 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2634 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
2640 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
2642 int error = handle_openflow__(ofconn, ofp_msg);
2644 send_error_oh(ofconn, ofp_msg->data, error);
2646 COVERAGE_INC(ofproto_recv_openflow);
2650 pick_datapath_id(const struct ofproto *ofproto)
2652 const struct ofport *port;
2654 port = ofproto_get_port(ofproto, OFPP_LOCAL);
2656 uint8_t ea[ETH_ADDR_LEN];
2659 error = netdev_get_etheraddr(port->netdev, ea);
2661 return eth_addr_to_uint64(ea);
2663 VLOG_WARN("could not get MAC address for %s (%s)",
2664 netdev_get_name(port->netdev), strerror(error));
2666 return ofproto->fallback_dpid;
2670 pick_fallback_dpid(void)
2672 uint8_t ea[ETH_ADDR_LEN];
2673 eth_addr_nicira_random(ea);
2674 return eth_addr_to_uint64(ea);
2677 /* unixctl commands. */
2680 ofproto_lookup(const char *name)
2682 struct ofproto *ofproto;
2684 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
2686 if (!strcmp(ofproto->name, name)) {
2694 ofproto_unixctl_list(struct unixctl_conn *conn, const char *arg OVS_UNUSED,
2695 void *aux OVS_UNUSED)
2697 struct ofproto *ofproto;
2701 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
2702 ds_put_format(&results, "%s\n", ofproto->name);
2704 unixctl_command_reply(conn, 200, ds_cstr(&results));
2705 ds_destroy(&results);
2709 ofproto_unixctl_init(void)
2711 static bool registered;
2717 unixctl_command_register("ofproto/list", ofproto_unixctl_list, NULL);