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(odp_overflow);
53 COVERAGE_DEFINE(ofproto_agg_request);
54 COVERAGE_DEFINE(ofproto_costly_flags);
55 COVERAGE_DEFINE(ofproto_ctlr_action);
56 COVERAGE_DEFINE(ofproto_error);
57 COVERAGE_DEFINE(ofproto_expiration);
58 COVERAGE_DEFINE(ofproto_expired);
59 COVERAGE_DEFINE(ofproto_flows_req);
60 COVERAGE_DEFINE(ofproto_flush);
61 COVERAGE_DEFINE(ofproto_invalidated);
62 COVERAGE_DEFINE(ofproto_no_packet_in);
63 COVERAGE_DEFINE(ofproto_ofp2odp);
64 COVERAGE_DEFINE(ofproto_packet_in);
65 COVERAGE_DEFINE(ofproto_packet_out);
66 COVERAGE_DEFINE(ofproto_queue_req);
67 COVERAGE_DEFINE(ofproto_recv_openflow);
68 COVERAGE_DEFINE(ofproto_reinit_ports);
69 COVERAGE_DEFINE(ofproto_unexpected_rule);
70 COVERAGE_DEFINE(ofproto_uninstallable);
71 COVERAGE_DEFINE(ofproto_update_port);
73 static void ofport_destroy__(struct ofport *);
74 static void ofport_destroy(struct ofport *);
76 static int rule_create(struct ofproto *, const struct cls_rule *,
77 const union ofp_action *, size_t n_actions,
78 uint16_t idle_timeout, uint16_t hard_timeout,
79 ovs_be64 flow_cookie, bool send_flow_removed,
82 static uint64_t pick_datapath_id(const struct ofproto *);
83 static uint64_t pick_fallback_dpid(void);
85 static void ofproto_destroy__(struct ofproto *);
86 static void ofproto_flush_flows__(struct ofproto *);
88 static void ofproto_rule_destroy__(struct rule *);
89 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
90 static void ofproto_rule_remove(struct rule *);
92 static void handle_openflow(struct ofconn *, struct ofpbuf *);
94 static void update_port(struct ofproto *, const char *devname);
95 static int init_ports(struct ofproto *);
96 static void reinit_ports(struct ofproto *);
98 static void ofproto_unixctl_init(void);
100 /* All registered ofproto classes, in probe order. */
101 static const struct ofproto_class **ofproto_classes;
102 static size_t n_ofproto_classes;
103 static size_t allocated_ofproto_classes;
105 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
106 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
108 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
111 ofproto_initialize(void)
117 ofproto_class_register(&ofproto_dpif_class);
121 /* 'type' should be a normalized datapath type, as returned by
122 * ofproto_normalize_type(). Returns the corresponding ofproto_class
123 * structure, or a null pointer if there is none registered for 'type'. */
124 static const struct ofproto_class *
125 ofproto_class_find__(const char *type)
129 ofproto_initialize();
130 for (i = 0; i < n_ofproto_classes; i++) {
131 const struct ofproto_class *class = ofproto_classes[i];
136 class->enumerate_types(&types);
137 found = sset_contains(&types, type);
138 sset_destroy(&types);
144 VLOG_WARN("unknown datapath type %s", type);
148 /* Registers a new ofproto class. After successful registration, new ofprotos
149 * of that type can be created using ofproto_create(). */
151 ofproto_class_register(const struct ofproto_class *new_class)
155 for (i = 0; i < n_ofproto_classes; i++) {
156 if (ofproto_classes[i] == new_class) {
161 if (n_ofproto_classes >= allocated_ofproto_classes) {
162 ofproto_classes = x2nrealloc(ofproto_classes,
163 &allocated_ofproto_classes,
164 sizeof *ofproto_classes);
166 ofproto_classes[n_ofproto_classes++] = new_class;
170 /* Unregisters a datapath provider. 'type' must have been previously
171 * registered and not currently be in use by any ofprotos. After
172 * unregistration new datapaths of that type cannot be opened using
173 * ofproto_create(). */
175 ofproto_class_unregister(const struct ofproto_class *class)
179 for (i = 0; i < n_ofproto_classes; i++) {
180 if (ofproto_classes[i] == class) {
181 for (i++; i < n_ofproto_classes; i++) {
182 ofproto_classes[i - 1] = ofproto_classes[i];
188 VLOG_WARN("attempted to unregister an ofproto class that is not "
193 /* Clears 'types' and enumerates all registered ofproto types into it. The
194 * caller must first initialize the sset. */
196 ofproto_enumerate_types(struct sset *types)
200 ofproto_initialize();
201 for (i = 0; i < n_ofproto_classes; i++) {
202 ofproto_classes[i]->enumerate_types(types);
206 /* Returns the fully spelled out name for the given ofproto 'type'.
208 * Normalized type string can be compared with strcmp(). Unnormalized type
209 * string might be the same even if they have different spellings. */
211 ofproto_normalize_type(const char *type)
213 return type && type[0] ? type : "system";
216 /* Clears 'names' and enumerates the names of all known created ofprotos with
217 * the given 'type'. The caller must first initialize the sset. Returns 0 if
218 * successful, otherwise a positive errno value.
220 * Some kinds of datapaths might not be practically enumerable. This is not
221 * considered an error. */
223 ofproto_enumerate_names(const char *type, struct sset *names)
225 const struct ofproto_class *class = ofproto_class_find__(type);
226 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
230 ofproto_create(const char *datapath_name, const char *datapath_type,
231 struct ofproto **ofprotop)
233 const struct ofproto_class *class;
234 struct ofproto *ofproto;
239 ofproto_initialize();
240 ofproto_unixctl_init();
242 datapath_type = ofproto_normalize_type(datapath_type);
243 class = ofproto_class_find__(datapath_type);
245 VLOG_WARN("could not create datapath %s of unknown type %s",
246 datapath_name, datapath_type);
250 ofproto = class->alloc();
252 VLOG_ERR("failed to allocate datapath %s of type %s",
253 datapath_name, datapath_type);
258 memset(ofproto, 0, sizeof *ofproto);
259 ofproto->ofproto_class = class;
260 ofproto->name = xstrdup(datapath_name);
261 ofproto->type = xstrdup(datapath_type);
262 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
263 hash_string(ofproto->name, 0));
264 ofproto->datapath_id = 0;
265 ofproto->fallback_dpid = pick_fallback_dpid();
266 ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
267 ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
268 ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
269 ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
270 ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
271 ofproto->netdev_monitor = netdev_monitor_create();
272 hmap_init(&ofproto->ports);
273 shash_init(&ofproto->port_by_name);
274 classifier_init(&ofproto->cls);
275 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
277 error = ofproto->ofproto_class->construct(ofproto);
279 VLOG_ERR("failed to open datapath %s: %s",
280 datapath_name, strerror(error));
281 ofproto_destroy__(ofproto);
285 ofproto->datapath_id = pick_datapath_id(ofproto);
286 VLOG_INFO("using datapath ID %016"PRIx64, ofproto->datapath_id);
294 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
296 uint64_t old_dpid = p->datapath_id;
297 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
298 if (p->datapath_id != old_dpid) {
299 VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
301 /* Force all active connections to reconnect, since there is no way to
302 * notify a controller that the datapath ID has changed. */
303 ofproto_reconnect_controllers(p);
308 ofproto_set_controllers(struct ofproto *p,
309 const struct ofproto_controller *controllers,
310 size_t n_controllers)
312 connmgr_set_controllers(p->connmgr, controllers, n_controllers);
316 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
318 connmgr_set_fail_mode(p->connmgr, fail_mode);
321 /* Drops the connections between 'ofproto' and all of its controllers, forcing
322 * them to reconnect. */
324 ofproto_reconnect_controllers(struct ofproto *ofproto)
326 connmgr_reconnect(ofproto->connmgr);
329 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
330 * in-band control should guarantee access, in the same way that in-band
331 * control guarantees access to OpenFlow controllers. */
333 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
334 const struct sockaddr_in *extras, size_t n)
336 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
339 /* Sets the OpenFlow queue used by flows set up by in-band control on
340 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
341 * flows will use the default queue. */
343 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
345 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
349 ofproto_set_desc(struct ofproto *p,
350 const char *mfr_desc, const char *hw_desc,
351 const char *sw_desc, const char *serial_desc,
354 struct ofp_desc_stats *ods;
357 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
358 VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
359 sizeof ods->mfr_desc);
362 p->mfr_desc = xstrdup(mfr_desc);
365 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
366 VLOG_WARN("truncating hw_desc, must be less than %zu characters",
367 sizeof ods->hw_desc);
370 p->hw_desc = xstrdup(hw_desc);
373 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
374 VLOG_WARN("truncating sw_desc, must be less than %zu characters",
375 sizeof ods->sw_desc);
378 p->sw_desc = xstrdup(sw_desc);
381 if (strlen(serial_desc) >= sizeof ods->serial_num) {
382 VLOG_WARN("truncating serial_desc, must be less than %zu "
384 sizeof ods->serial_num);
386 free(p->serial_desc);
387 p->serial_desc = xstrdup(serial_desc);
390 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
391 VLOG_WARN("truncating dp_desc, must be less than %zu characters",
392 sizeof ods->dp_desc);
395 p->dp_desc = xstrdup(dp_desc);
400 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
402 return connmgr_set_snoops(ofproto->connmgr, snoops);
406 ofproto_set_netflow(struct ofproto *ofproto,
407 const struct netflow_options *nf_options)
409 if (nf_options && sset_is_empty(&nf_options->collectors)) {
413 if (ofproto->ofproto_class->set_netflow) {
414 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
416 return nf_options ? EOPNOTSUPP : 0;
421 ofproto_set_sflow(struct ofproto *ofproto,
422 const struct ofproto_sflow_options *oso)
424 if (oso && sset_is_empty(&oso->targets)) {
428 if (ofproto->ofproto_class->set_sflow) {
429 return ofproto->ofproto_class->set_sflow(ofproto, oso);
431 return oso ? EOPNOTSUPP : 0;
435 /* Connectivity Fault Management configuration. */
437 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
439 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
441 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
442 if (ofport && ofproto->ofproto_class->set_cfm) {
443 ofproto->ofproto_class->set_cfm(ofport, NULL, NULL, 0);
447 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
448 * basic configuration from the configuration members in 'cfm', and the set of
449 * remote maintenance points from the 'n_remote_mps' elements in 'remote_mps'.
450 * Ignores the statistics members of 'cfm'.
452 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
454 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
455 const struct cfm *cfm,
456 const uint16_t *remote_mps, size_t n_remote_mps)
458 struct ofport *ofport;
461 ofport = ofproto_get_port(ofproto, ofp_port);
463 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
464 ofproto->name, ofp_port);
468 error = (ofproto->ofproto_class->set_cfm
469 ? ofproto->ofproto_class->set_cfm(ofport, cfm,
470 remote_mps, n_remote_mps)
473 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
474 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
479 /* Returns the connectivity fault management object associated with 'ofp_port'
480 * within 'ofproto', or a null pointer if 'ofproto' does not have a port
481 * 'ofp_port' or if that port does not have CFM configured. The caller must
482 * not modify or destroy the returned object. */
484 ofproto_port_get_cfm(struct ofproto *ofproto, uint16_t ofp_port)
486 struct ofport *ofport;
487 const struct cfm *cfm;
489 ofport = ofproto_get_port(ofproto, ofp_port);
491 && ofproto->ofproto_class->get_cfm
492 && !ofproto->ofproto_class->get_cfm(ofport, &cfm)) ? cfm : NULL;
495 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
496 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
497 * 0 if LACP partner information is not current (generally indicating a
498 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
500 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
502 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
503 return (ofport && ofproto->ofproto_class->port_is_lacp_current
504 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
510 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
511 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
512 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
513 * configuration plus, if there is more than one slave, a bonding
516 * If 'aux' is already registered then this function updates its configuration
517 * to 's'. Otherwise, this function registers a new bundle.
519 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
522 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
523 const struct ofproto_bundle_settings *s)
525 return (ofproto->ofproto_class->bundle_set
526 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
530 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
531 * If no such bundle has been registered, this has no effect. */
533 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
535 return ofproto_bundle_register(ofproto, aux, NULL);
539 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
540 * If 'aux' is already registered then this function updates its configuration
541 * to 's'. Otherwise, this function registers a new mirror.
543 * Mirrors affect only the treatment of packets output to the OFPP_NORMAL
546 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
547 const struct ofproto_mirror_settings *s)
549 return (ofproto->ofproto_class->mirror_set
550 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
554 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
555 * If no mirror has been registered, this has no effect. */
557 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
559 return ofproto_mirror_register(ofproto, aux, NULL);
562 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
563 * which all packets are flooded, instead of using MAC learning. If
564 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
566 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
569 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
571 return (ofproto->ofproto_class->set_flood_vlans
572 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
576 /* Returns true if 'aux' is a registered bundle that is currently in use as the
577 * output for a mirror. */
579 ofproto_is_mirror_output_bundle(struct ofproto *ofproto, void *aux)
581 return (ofproto->ofproto_class->is_mirror_output_bundle
582 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
587 ofproto_has_snoops(const struct ofproto *ofproto)
589 return connmgr_has_snoops(ofproto->connmgr);
593 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
595 connmgr_get_snoops(ofproto->connmgr, snoops);
599 ofproto_destroy__(struct ofproto *ofproto)
601 connmgr_destroy(ofproto->connmgr);
603 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
605 free(ofproto->mfr_desc);
606 free(ofproto->hw_desc);
607 free(ofproto->sw_desc);
608 free(ofproto->serial_desc);
609 free(ofproto->dp_desc);
610 netdev_monitor_destroy(ofproto->netdev_monitor);
611 hmap_destroy(&ofproto->ports);
612 shash_destroy(&ofproto->port_by_name);
613 classifier_destroy(&ofproto->cls);
615 ofproto->ofproto_class->dealloc(ofproto);
619 ofproto_destroy(struct ofproto *p)
621 struct ofport *ofport, *next_ofport;
627 ofproto_flush_flows__(p);
628 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
629 hmap_remove(&p->ports, &ofport->hmap_node);
630 ofport_destroy(ofport);
633 p->ofproto_class->destruct(p);
634 ofproto_destroy__(p);
637 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
638 * kernel datapath, for example, this destroys the datapath in the kernel, and
639 * with the netdev-based datapath, it tears down the data structures that
640 * represent the datapath.
642 * The datapath should not be currently open as an ofproto. */
644 ofproto_delete(const char *name, const char *type)
646 const struct ofproto_class *class = ofproto_class_find__(type);
647 return (!class ? EAFNOSUPPORT
648 : !class->del ? EACCES
649 : class->del(type, name));
653 process_port_change(struct ofproto *ofproto, int error, char *devname)
655 if (error == ENOBUFS) {
656 reinit_ports(ofproto);
658 update_port(ofproto, devname);
664 ofproto_run(struct ofproto *p)
669 error = p->ofproto_class->run(p);
670 if (error == ENODEV) {
671 /* Someone destroyed the datapath behind our back. The caller
672 * better destroy us and give up, because we're just going to
673 * spin from here on out. */
674 static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
675 VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
680 if (p->ofproto_class->port_poll) {
681 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
682 process_port_change(p, error, devname);
685 while ((error = netdev_monitor_poll(p->netdev_monitor,
686 &devname)) != EAGAIN) {
687 process_port_change(p, error, devname);
690 connmgr_run(p->connmgr, handle_openflow);
696 ofproto_wait(struct ofproto *p)
698 p->ofproto_class->wait(p);
699 if (p->ofproto_class->port_poll_wait) {
700 p->ofproto_class->port_poll_wait(p);
702 netdev_monitor_poll_wait(p->netdev_monitor);
703 connmgr_wait(p->connmgr);
707 ofproto_is_alive(const struct ofproto *p)
709 return connmgr_has_controllers(p->connmgr);
713 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
716 connmgr_get_controller_info(ofproto->connmgr, info);
720 ofproto_free_ofproto_controller_info(struct shash *info)
722 struct shash_node *node;
724 SHASH_FOR_EACH (node, info) {
725 struct ofproto_controller_info *cinfo = node->data;
726 while (cinfo->pairs.n) {
727 free((char *) cinfo->pairs.values[--cinfo->pairs.n]);
734 /* Makes a deep copy of 'old' into 'port'. */
736 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
738 port->name = xstrdup(old->name);
739 port->type = xstrdup(old->type);
740 port->ofp_port = old->ofp_port;
743 /* Frees memory allocated to members of 'ofproto_port'.
745 * Do not call this function on an ofproto_port obtained from
746 * ofproto_port_dump_next(): that function retains ownership of the data in the
749 ofproto_port_destroy(struct ofproto_port *ofproto_port)
751 free(ofproto_port->name);
752 free(ofproto_port->type);
755 /* Initializes 'dump' to begin dumping the ports in an ofproto.
757 * This function provides no status indication. An error status for the entire
758 * dump operation is provided when it is completed by calling
759 * ofproto_port_dump_done().
762 ofproto_port_dump_start(struct ofproto_port_dump *dump,
763 const struct ofproto *ofproto)
765 dump->ofproto = ofproto;
766 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
770 /* Attempts to retrieve another port from 'dump', which must have been created
771 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
772 * 'port' and returns true. On failure, returns false.
774 * Failure might indicate an actual error or merely that the last port has been
775 * dumped. An error status for the entire dump operation is provided when it
776 * is completed by calling ofproto_port_dump_done().
778 * The ofproto owns the data stored in 'port'. It will remain valid until at
779 * least the next time 'dump' is passed to ofproto_port_dump_next() or
780 * ofproto_port_dump_done(). */
782 ofproto_port_dump_next(struct ofproto_port_dump *dump,
783 struct ofproto_port *port)
785 const struct ofproto *ofproto = dump->ofproto;
791 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
794 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
800 /* Completes port table dump operation 'dump', which must have been created
801 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
802 * error-free, otherwise a positive errno value describing the problem. */
804 ofproto_port_dump_done(struct ofproto_port_dump *dump)
806 const struct ofproto *ofproto = dump->ofproto;
808 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
811 return dump->error == EOF ? 0 : dump->error;
814 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
815 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
816 * is non-null). On failure, returns a positive errno value and sets
817 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
819 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
825 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
827 update_port(ofproto, netdev_get_name(netdev));
830 *ofp_portp = error ? OFPP_NONE : ofp_port;
835 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
836 * initializes '*port' appropriately; on failure, returns a positive errno
839 * The caller owns the data in 'ofproto_port' and must free it with
840 * ofproto_port_destroy() when it is no longer needed. */
842 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
843 struct ofproto_port *port)
847 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
849 memset(port, 0, sizeof *port);
854 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
855 * Returns 0 if successful, otherwise a positive errno. */
857 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
859 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
860 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
863 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
864 if (!error && ofport) {
865 /* 'name' is the netdev's name and update_port() is going to close the
866 * netdev. Just in case update_port() refers to 'name' after it
867 * destroys 'ofport', make a copy of it around the update_port()
869 char *devname = xstrdup(name);
870 update_port(ofproto, devname);
876 /* Adds a flow to the OpenFlow flow table in 'p' that matches 'cls_rule' and
877 * performs the 'n_actions' actions in 'actions'. The new flow will not
880 * If cls_rule->priority is in the range of priorities supported by OpenFlow
881 * (0...65535, inclusive) then the flow will be visible to OpenFlow
882 * controllers; otherwise, it will be hidden.
884 * The caller retains ownership of 'cls_rule' and 'actions'. */
886 ofproto_add_flow(struct ofproto *p, const struct cls_rule *cls_rule,
887 const union ofp_action *actions, size_t n_actions)
890 rule_create(p, cls_rule, actions, n_actions, 0, 0, 0, false, &rule);
894 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
898 rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
901 ofproto_rule_remove(rule);
906 ofproto_flush_flows__(struct ofproto *ofproto)
908 struct rule *rule, *next_rule;
909 struct cls_cursor cursor;
911 COVERAGE_INC(ofproto_flush);
913 if (ofproto->ofproto_class->flush) {
914 ofproto->ofproto_class->flush(ofproto);
917 cls_cursor_init(&cursor, &ofproto->cls, NULL);
918 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
919 ofproto_rule_remove(rule);
924 ofproto_flush_flows(struct ofproto *ofproto)
926 ofproto_flush_flows__(ofproto);
927 connmgr_flushed(ofproto->connmgr);
931 reinit_ports(struct ofproto *p)
933 struct ofproto_port_dump dump;
934 struct sset devnames;
935 struct ofport *ofport;
936 struct ofproto_port ofproto_port;
939 COVERAGE_INC(ofproto_reinit_ports);
941 sset_init(&devnames);
942 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
943 sset_add(&devnames, netdev_get_name(ofport->netdev));
945 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
946 sset_add(&devnames, ofproto_port.name);
949 SSET_FOR_EACH (devname, &devnames) {
950 update_port(p, devname);
952 sset_destroy(&devnames);
955 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
956 * netdev cannot be opened. On success, also fills in 'opp'. */
957 static struct netdev *
958 ofport_open(const struct ofproto_port *ofproto_port, struct ofp_phy_port *opp)
960 uint32_t curr, advertised, supported, peer;
961 struct netdev_options netdev_options;
962 enum netdev_flags flags;
963 struct netdev *netdev;
966 memset(&netdev_options, 0, sizeof netdev_options);
967 netdev_options.name = ofproto_port->name;
968 netdev_options.type = ofproto_port->type;
969 netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
971 error = netdev_open(&netdev_options, &netdev);
973 VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
974 "cannot be opened (%s)",
975 ofproto_port->name, ofproto_port->ofp_port,
976 ofproto_port->name, strerror(error));
980 netdev_get_flags(netdev, &flags);
981 netdev_get_features(netdev, &curr, &advertised, &supported, &peer);
983 opp->port_no = htons(ofproto_port->ofp_port);
984 netdev_get_etheraddr(netdev, opp->hw_addr);
985 ovs_strzcpy(opp->name, ofproto_port->name, sizeof opp->name);
986 opp->config = flags & NETDEV_UP ? 0 : htonl(OFPPC_PORT_DOWN);
987 opp->state = netdev_get_carrier(netdev) ? 0 : htonl(OFPPS_LINK_DOWN);
988 opp->curr = htonl(curr);
989 opp->advertised = htonl(advertised);
990 opp->supported = htonl(supported);
991 opp->peer = htonl(peer);
996 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
997 * port number, and 'config' bits other than OFPPC_PORT_DOWN are
1000 ofport_equal(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
1002 BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1003 return (!memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1004 && a->state == b->state
1005 && !((a->config ^ b->config) & htonl(OFPPC_PORT_DOWN))
1006 && a->curr == b->curr
1007 && a->advertised == b->advertised
1008 && a->supported == b->supported
1009 && a->peer == b->peer);
1012 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1013 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1014 * one with the same name or port number). */
1016 ofport_install(struct ofproto *p,
1017 struct netdev *netdev, const struct ofp_phy_port *opp)
1019 const char *netdev_name = netdev_get_name(netdev);
1020 struct ofport *ofport;
1023 /* Create ofport. */
1024 ofport = p->ofproto_class->port_alloc();
1029 ofport->ofproto = p;
1030 ofport->netdev = netdev;
1032 ofport->ofp_port = ntohs(opp->port_no);
1034 /* Add port to 'p'. */
1035 netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1036 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1037 shash_add(&p->port_by_name, netdev_name, ofport);
1039 /* Let the ofproto_class initialize its private data. */
1040 error = p->ofproto_class->port_construct(ofport);
1044 connmgr_send_port_status(p->connmgr, opp, OFPPR_ADD);
1048 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1049 p->name, netdev_name, strerror(error));
1051 ofport_destroy__(ofport);
1053 netdev_close(netdev);
1057 /* Removes 'ofport' from 'p' and destroys it. */
1059 ofport_remove(struct ofport *ofport)
1061 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->opp,
1063 ofport_destroy(ofport);
1066 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1069 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1071 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1073 ofport_remove(port);
1077 /* Updates 'port' within 'ofproto' with the new 'netdev' and 'opp'.
1079 * Does not handle a name or port number change. The caller must implement
1080 * such a change as a delete followed by an add. */
1082 ofport_modified(struct ofport *port, struct ofp_phy_port *opp)
1084 memcpy(port->opp.hw_addr, opp->hw_addr, ETH_ADDR_LEN);
1085 port->opp.config = ((port->opp.config & ~htonl(OFPPC_PORT_DOWN))
1086 | (opp->config & htonl(OFPPC_PORT_DOWN)));
1087 port->opp.state = opp->state;
1088 port->opp.curr = opp->curr;
1089 port->opp.advertised = opp->advertised;
1090 port->opp.supported = opp->supported;
1091 port->opp.peer = opp->peer;
1093 connmgr_send_port_status(port->ofproto->connmgr, &port->opp, OFPPR_MODIFY);
1097 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1099 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1101 if (port->ofproto->ofproto_class->set_cfm) {
1102 port->ofproto->ofproto_class->set_cfm(port, NULL, NULL, 0);
1104 if (port->ofproto->ofproto_class->bundle_remove) {
1105 port->ofproto->ofproto_class->bundle_remove(port);
1111 ofport_destroy__(struct ofport *port)
1113 struct ofproto *ofproto = port->ofproto;
1114 const char *name = netdev_get_name(port->netdev);
1116 netdev_monitor_remove(ofproto->netdev_monitor, port->netdev);
1117 hmap_remove(&ofproto->ports, &port->hmap_node);
1118 shash_delete(&ofproto->port_by_name,
1119 shash_find(&ofproto->port_by_name, name));
1121 netdev_close(port->netdev);
1122 ofproto->ofproto_class->port_dealloc(port);
1126 ofport_destroy(struct ofport *port)
1129 port->ofproto->ofproto_class->port_destruct(port);
1130 ofport_destroy__(port);
1135 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1137 struct ofport *port;
1139 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1140 hash_int(ofp_port, 0), &ofproto->ports) {
1141 if (port->ofp_port == ofp_port) {
1149 update_port(struct ofproto *ofproto, const char *name)
1151 struct ofproto_port ofproto_port;
1152 struct ofp_phy_port opp;
1153 struct netdev *netdev;
1154 struct ofport *port;
1156 COVERAGE_INC(ofproto_update_port);
1158 /* Fetch 'name''s location and properties from the datapath. */
1159 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1160 ? ofport_open(&ofproto_port, &opp)
1163 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1164 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1165 /* 'name' hasn't changed location. Any properties changed? */
1166 if (!ofport_equal(&port->opp, &opp)) {
1167 ofport_modified(port, &opp);
1170 /* Install the newly opened netdev in case it has changed. */
1171 netdev_monitor_remove(ofproto->netdev_monitor, port->netdev);
1172 netdev_monitor_add(ofproto->netdev_monitor, netdev);
1174 netdev_close(port->netdev);
1175 port->netdev = netdev;
1177 if (port->ofproto->ofproto_class->port_modified) {
1178 port->ofproto->ofproto_class->port_modified(port);
1181 /* If 'port' is nonnull then its name differs from 'name' and thus
1182 * we should delete it. If we think there's a port named 'name'
1183 * then its port number must be wrong now so delete it too. */
1185 ofport_remove(port);
1187 ofport_remove_with_name(ofproto, name);
1188 ofport_install(ofproto, netdev, &opp);
1191 /* Any port named 'name' is gone now. */
1192 ofport_remove_with_name(ofproto, name);
1194 ofproto_port_destroy(&ofproto_port);
1198 init_ports(struct ofproto *p)
1200 struct ofproto_port_dump dump;
1201 struct ofproto_port ofproto_port;
1203 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1204 uint16_t ofp_port = ofproto_port.ofp_port;
1205 if (ofproto_get_port(p, ofp_port)) {
1206 VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1208 } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1209 VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1212 struct ofp_phy_port opp;
1213 struct netdev *netdev;
1215 netdev = ofport_open(&ofproto_port, &opp);
1217 ofport_install(p, netdev, &opp);
1225 /* Creates a new rule initialized as specified, inserts it into 'ofproto''s
1226 * flow table, and stores the new rule into '*rulep'. Returns 0 on success,
1227 * otherwise a positive errno value or OpenFlow error code. */
1229 rule_create(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1230 const union ofp_action *actions, size_t n_actions,
1231 uint16_t idle_timeout, uint16_t hard_timeout,
1232 ovs_be64 flow_cookie, bool send_flow_removed,
1233 struct rule **rulep)
1238 rule = ofproto->ofproto_class->rule_alloc();
1244 rule->ofproto = ofproto;
1245 rule->cr = *cls_rule;
1246 rule->flow_cookie = flow_cookie;
1247 rule->created = time_msec();
1248 rule->idle_timeout = idle_timeout;
1249 rule->hard_timeout = hard_timeout;
1250 rule->send_flow_removed = send_flow_removed;
1251 if (n_actions > 0) {
1252 rule->actions = xmemdup(actions, n_actions * sizeof *actions);
1254 rule->actions = NULL;
1256 rule->n_actions = n_actions;
1258 error = ofproto->ofproto_class->rule_construct(rule);
1260 ofproto_rule_destroy__(rule);
1268 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
1269 ofproto->name, strerror(error));
1275 ofproto_rule_destroy__(struct rule *rule)
1277 free(rule->actions);
1278 rule->ofproto->ofproto_class->rule_dealloc(rule);
1281 /* Destroys 'rule' and removes it from the datapath.
1283 * The caller must have already removed 'rule' from the classifier. */
1285 ofproto_rule_destroy(struct rule *rule)
1287 rule->ofproto->ofproto_class->rule_destruct(rule);
1288 ofproto_rule_destroy__(rule);
1291 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1292 * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1295 rule_has_out_port(const struct rule *rule, ovs_be16 out_port)
1297 const union ofp_action *oa;
1298 struct actions_iterator i;
1300 if (out_port == htons(OFPP_NONE)) {
1303 for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
1304 oa = actions_next(&i)) {
1305 if (action_outputs_to_port(oa, out_port)) {
1313 ofproto_rule_lookup(struct ofproto *ofproto, const struct flow *flow)
1315 return rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
1318 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1319 * statistics appropriately. 'packet' must have at least sizeof(struct
1320 * ofp_packet_in) bytes of headroom.
1322 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1323 * with statistics for 'packet' either way.
1325 * Takes ownership of 'packet'. */
1327 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1331 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1333 flow_extract(packet, 0, in_port, &flow);
1334 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1337 /* Removes 'rule' from 'ofproto' and frees up the associated memory. Removes
1338 * 'rule' from the classifier. */
1340 ofproto_rule_remove(struct rule *rule)
1342 rule->ofproto->ofproto_class->rule_remove(rule);
1343 ofproto_rule_destroy(rule);
1346 /* Returns true if 'rule' should be hidden from the controller.
1348 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1349 * (e.g. by in-band control) and are intentionally hidden from the
1352 rule_is_hidden(const struct rule *rule)
1354 return rule->cr.priority > UINT16_MAX;
1358 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
1361 struct ofpbuf *buf = ofputil_encode_error_msg(error, oh);
1363 COVERAGE_INC(ofproto_error);
1364 ofconn_send_reply(ofconn, buf);
1369 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1371 ofconn_send_reply(ofconn, make_echo_reply(oh));
1376 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1378 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1379 struct ofp_switch_features *osf;
1381 struct ofport *port;
1383 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1384 osf->datapath_id = htonll(ofproto->datapath_id);
1385 osf->n_buffers = htonl(pktbuf_capacity());
1387 osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1388 OFPC_PORT_STATS | OFPC_ARP_MATCH_IP);
1389 osf->actions = htonl((1u << OFPAT_OUTPUT) |
1390 (1u << OFPAT_SET_VLAN_VID) |
1391 (1u << OFPAT_SET_VLAN_PCP) |
1392 (1u << OFPAT_STRIP_VLAN) |
1393 (1u << OFPAT_SET_DL_SRC) |
1394 (1u << OFPAT_SET_DL_DST) |
1395 (1u << OFPAT_SET_NW_SRC) |
1396 (1u << OFPAT_SET_NW_DST) |
1397 (1u << OFPAT_SET_NW_TOS) |
1398 (1u << OFPAT_SET_TP_SRC) |
1399 (1u << OFPAT_SET_TP_DST) |
1400 (1u << OFPAT_ENQUEUE));
1402 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1403 ofpbuf_put(buf, &port->opp, sizeof port->opp);
1406 ofconn_send_reply(ofconn, buf);
1411 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1413 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1415 struct ofp_switch_config *osc;
1419 /* Figure out flags. */
1420 drop_frags = ofproto->ofproto_class->get_drop_frags(ofproto);
1421 flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
1424 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1425 osc->flags = htons(flags);
1426 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1427 ofconn_send_reply(ofconn, buf);
1433 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1435 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1436 uint16_t flags = ntohs(osc->flags);
1438 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1439 && ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1440 switch (flags & OFPC_FRAG_MASK) {
1441 case OFPC_FRAG_NORMAL:
1442 ofproto->ofproto_class->set_drop_frags(ofproto, false);
1444 case OFPC_FRAG_DROP:
1445 ofproto->ofproto_class->set_drop_frags(ofproto, true);
1448 VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
1454 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1459 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1460 * error message code (composed with ofp_mkerr()) for the caller to propagate
1461 * upward. Otherwise, returns 0.
1463 * The log message mentions 'msg_type'. */
1465 reject_slave_controller(struct ofconn *ofconn, const const char *msg_type)
1467 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1468 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1469 static struct vlog_rate_limit perm_rl = VLOG_RATE_LIMIT_INIT(1, 5);
1470 VLOG_WARN_RL(&perm_rl, "rejecting %s message from slave controller",
1473 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
1480 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1482 struct ofproto *p = ofconn_get_ofproto(ofconn);
1483 struct ofp_packet_out *opo;
1484 struct ofpbuf payload, *buffer;
1485 union ofp_action *ofp_actions;
1486 struct ofpbuf request;
1488 size_t n_ofp_actions;
1492 COVERAGE_INC(ofproto_packet_out);
1494 error = reject_slave_controller(ofconn, "OFPT_PACKET_OUT");
1499 /* Get ofp_packet_out. */
1500 ofpbuf_use_const(&request, oh, ntohs(oh->length));
1501 opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1504 error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1505 &ofp_actions, &n_ofp_actions);
1511 if (opo->buffer_id != htonl(UINT32_MAX)) {
1512 error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1514 if (error || !buffer) {
1523 /* Send out packet. */
1524 flow_extract(&payload, 0, ntohs(opo->in_port), &flow);
1525 error = p->ofproto_class->packet_out(p, &payload, &flow,
1526 ofp_actions, n_ofp_actions);
1527 ofpbuf_delete(buffer);
1533 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1535 ovs_be32 old_config = port->opp.config;
1537 mask &= config ^ port->opp.config;
1538 if (mask & htonl(OFPPC_PORT_DOWN)) {
1539 if (config & htonl(OFPPC_PORT_DOWN)) {
1540 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1542 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1546 port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1547 OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1548 OFPPC_NO_PACKET_IN));
1549 if (port->opp.config != old_config) {
1550 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1555 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1557 struct ofproto *p = ofconn_get_ofproto(ofconn);
1558 const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1559 struct ofport *port;
1562 error = reject_slave_controller(ofconn, "OFPT_PORT_MOD");
1567 port = ofproto_get_port(p, ntohs(opm->port_no));
1569 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
1570 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1571 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
1573 update_port_config(port, opm->config, opm->mask);
1574 if (opm->advertise) {
1575 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1581 static struct ofpbuf *
1582 make_ofp_stats_reply(ovs_be32 xid, ovs_be16 type, size_t body_len)
1584 struct ofp_stats_reply *osr;
1587 msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
1588 osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
1590 osr->flags = htons(0);
1594 static struct ofpbuf *
1595 start_ofp_stats_reply(const struct ofp_header *request, size_t body_len)
1597 const struct ofp_stats_request *osr
1598 = (const struct ofp_stats_request *) request;
1599 return make_ofp_stats_reply(osr->header.xid, osr->type, body_len);
1603 append_ofp_stats_reply(size_t nbytes, struct ofconn *ofconn,
1604 struct ofpbuf **msgp)
1606 struct ofpbuf *msg = *msgp;
1607 assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
1608 if (nbytes + msg->size > UINT16_MAX) {
1609 struct ofp_stats_reply *reply = msg->data;
1610 reply->flags = htons(OFPSF_REPLY_MORE);
1611 *msgp = make_ofp_stats_reply(reply->header.xid, reply->type, nbytes);
1612 ofconn_send_reply(ofconn, msg);
1614 return ofpbuf_put_uninit(*msgp, nbytes);
1617 static struct ofpbuf *
1618 make_nxstats_reply(ovs_be32 xid, ovs_be32 subtype, size_t body_len)
1620 struct nicira_stats_msg *nsm;
1623 msg = ofpbuf_new(MIN(sizeof *nsm + body_len, UINT16_MAX));
1624 nsm = put_openflow_xid(sizeof *nsm, OFPT_STATS_REPLY, xid, msg);
1625 nsm->type = htons(OFPST_VENDOR);
1626 nsm->flags = htons(0);
1627 nsm->vendor = htonl(NX_VENDOR_ID);
1628 nsm->subtype = subtype;
1632 static struct ofpbuf *
1633 start_nxstats_reply(const struct nicira_stats_msg *request, size_t body_len)
1635 return make_nxstats_reply(request->header.xid, request->subtype, body_len);
1639 append_nxstats_reply(size_t nbytes, struct ofconn *ofconn,
1640 struct ofpbuf **msgp)
1642 struct ofpbuf *msg = *msgp;
1643 assert(nbytes <= UINT16_MAX - sizeof(struct nicira_stats_msg));
1644 if (nbytes + msg->size > UINT16_MAX) {
1645 struct nicira_stats_msg *reply = msg->data;
1646 reply->flags = htons(OFPSF_REPLY_MORE);
1647 *msgp = make_nxstats_reply(reply->header.xid, reply->subtype, nbytes);
1648 ofconn_send_reply(ofconn, msg);
1650 ofpbuf_prealloc_tailroom(*msgp, nbytes);
1654 handle_desc_stats_request(struct ofconn *ofconn,
1655 const struct ofp_header *request)
1657 struct ofproto *p = ofconn_get_ofproto(ofconn);
1658 struct ofp_desc_stats *ods;
1661 msg = start_ofp_stats_reply(request, sizeof *ods);
1662 ods = append_ofp_stats_reply(sizeof *ods, ofconn, &msg);
1663 memset(ods, 0, sizeof *ods);
1664 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1665 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1666 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1667 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1668 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1669 ofconn_send_reply(ofconn, msg);
1675 handle_table_stats_request(struct ofconn *ofconn,
1676 const struct ofp_header *request)
1678 struct ofproto *p = ofconn_get_ofproto(ofconn);
1679 struct ofp_table_stats *ots;
1682 msg = start_ofp_stats_reply(request, sizeof *ots * 2);
1684 /* Classifier table. */
1685 ots = append_ofp_stats_reply(sizeof *ots, ofconn, &msg);
1686 memset(ots, 0, sizeof *ots);
1687 strcpy(ots->name, "classifier");
1688 ots->wildcards = (ofconn_get_flow_format(ofconn) == NXFF_OPENFLOW10
1689 ? htonl(OFPFW_ALL) : htonl(OVSFW_ALL));
1690 ots->max_entries = htonl(1024 * 1024); /* An arbitrary big number. */
1691 ots->active_count = htonl(classifier_count(&p->cls));
1692 put_32aligned_be64(&ots->lookup_count, htonll(0)); /* XXX */
1693 put_32aligned_be64(&ots->matched_count, htonll(0)); /* XXX */
1695 ofconn_send_reply(ofconn, msg);
1700 append_port_stat(struct ofport *port, struct ofconn *ofconn,
1701 struct ofpbuf **msgp)
1703 struct netdev_stats stats;
1704 struct ofp_port_stats *ops;
1706 /* Intentionally ignore return value, since errors will set
1707 * 'stats' to all-1s, which is correct for OpenFlow, and
1708 * netdev_get_stats() will log errors. */
1709 netdev_get_stats(port->netdev, &stats);
1711 ops = append_ofp_stats_reply(sizeof *ops, ofconn, msgp);
1712 ops->port_no = port->opp.port_no;
1713 memset(ops->pad, 0, sizeof ops->pad);
1714 put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
1715 put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
1716 put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
1717 put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
1718 put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
1719 put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
1720 put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
1721 put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
1722 put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
1723 put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
1724 put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
1725 put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
1729 handle_port_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
1731 struct ofproto *p = ofconn_get_ofproto(ofconn);
1732 const struct ofp_port_stats_request *psr = ofputil_stats_body(oh);
1733 struct ofp_port_stats *ops;
1735 struct ofport *port;
1737 msg = start_ofp_stats_reply(oh, sizeof *ops * 16);
1738 if (psr->port_no != htons(OFPP_NONE)) {
1739 port = ofproto_get_port(p, ntohs(psr->port_no));
1741 append_port_stat(port, ofconn, &msg);
1744 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
1745 append_port_stat(port, ofconn, &msg);
1749 ofconn_send_reply(ofconn, msg);
1754 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
1756 long long int msecs = time_msec() - start;
1757 *sec = msecs / 1000;
1758 *nsec = (msecs % 1000) * (1000 * 1000);
1762 calc_flow_duration(long long int start, ovs_be32 *sec_be, ovs_be32 *nsec_be)
1766 calc_flow_duration__(start, &sec, &nsec);
1767 *sec_be = htonl(sec);
1768 *nsec_be = htonl(nsec);
1772 put_ofp_flow_stats(struct ofconn *ofconn, struct rule *rule,
1773 ovs_be16 out_port, struct ofpbuf **replyp)
1775 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1776 struct ofp_flow_stats *ofs;
1777 uint64_t packet_count, byte_count;
1779 size_t act_len, len;
1781 if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
1785 act_len = sizeof *rule->actions * rule->n_actions;
1786 len = offsetof(struct ofp_flow_stats, actions) + act_len;
1788 ofproto->ofproto_class->rule_get_stats(rule, &packet_count, &byte_count);
1790 ofs = append_ofp_stats_reply(len, ofconn, replyp);
1791 ofs->length = htons(len);
1794 ofputil_cls_rule_to_match(&rule->cr, ofconn_get_flow_format(ofconn),
1795 &ofs->match, rule->flow_cookie, &cookie);
1796 put_32aligned_be64(&ofs->cookie, cookie);
1797 calc_flow_duration(rule->created, &ofs->duration_sec, &ofs->duration_nsec);
1798 ofs->priority = htons(rule->cr.priority);
1799 ofs->idle_timeout = htons(rule->idle_timeout);
1800 ofs->hard_timeout = htons(rule->hard_timeout);
1801 memset(ofs->pad2, 0, sizeof ofs->pad2);
1802 put_32aligned_be64(&ofs->packet_count, htonll(packet_count));
1803 put_32aligned_be64(&ofs->byte_count, htonll(byte_count));
1804 if (rule->n_actions > 0) {
1805 memcpy(ofs->actions, rule->actions, act_len);
1810 is_valid_table(uint8_t table_id)
1812 if (table_id == 0 || table_id == 0xff) {
1815 /* It would probably be better to reply with an error but there doesn't
1816 * seem to be any appropriate value, so that might just be
1818 VLOG_WARN_RL(&rl, "controller asked for invalid table %"PRIu8,
1825 handle_flow_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
1827 const struct ofp_flow_stats_request *fsr = ofputil_stats_body(oh);
1828 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1829 struct ofpbuf *reply;
1831 COVERAGE_INC(ofproto_flows_req);
1832 reply = start_ofp_stats_reply(oh, 1024);
1833 if (is_valid_table(fsr->table_id)) {
1834 struct cls_cursor cursor;
1835 struct cls_rule target;
1838 ofputil_cls_rule_from_match(&fsr->match, 0, NXFF_OPENFLOW10, 0,
1840 cls_cursor_init(&cursor, &ofproto->cls, &target);
1841 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1842 put_ofp_flow_stats(ofconn, rule, fsr->out_port, &reply);
1845 ofconn_send_reply(ofconn, reply);
1851 put_nx_flow_stats(struct ofconn *ofconn, struct rule *rule,
1852 ovs_be16 out_port, struct ofpbuf **replyp)
1854 struct nx_flow_stats *nfs;
1855 uint64_t packet_count, byte_count;
1856 size_t act_len, start_len;
1857 struct ofpbuf *reply;
1859 if (rule_is_hidden(rule) || !rule_has_out_port(rule, out_port)) {
1863 rule->ofproto->ofproto_class->rule_get_stats(rule,
1864 &packet_count, &byte_count);
1866 act_len = sizeof *rule->actions * rule->n_actions;
1868 append_nxstats_reply(sizeof *nfs + NXM_MAX_LEN + act_len, ofconn, replyp);
1869 start_len = (*replyp)->size;
1872 nfs = ofpbuf_put_uninit(reply, sizeof *nfs);
1875 calc_flow_duration(rule->created, &nfs->duration_sec, &nfs->duration_nsec);
1876 nfs->cookie = rule->flow_cookie;
1877 nfs->priority = htons(rule->cr.priority);
1878 nfs->idle_timeout = htons(rule->idle_timeout);
1879 nfs->hard_timeout = htons(rule->hard_timeout);
1880 nfs->match_len = htons(nx_put_match(reply, &rule->cr));
1881 memset(nfs->pad2, 0, sizeof nfs->pad2);
1882 nfs->packet_count = htonll(packet_count);
1883 nfs->byte_count = htonll(byte_count);
1884 if (rule->n_actions > 0) {
1885 ofpbuf_put(reply, rule->actions, act_len);
1887 nfs->length = htons(reply->size - start_len);
1891 handle_nxst_flow(struct ofconn *ofconn, const struct ofp_header *oh)
1893 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1894 struct nx_flow_stats_request *nfsr;
1895 struct cls_rule target;
1896 struct ofpbuf *reply;
1900 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1902 /* Dissect the message. */
1903 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1904 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &target);
1909 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1912 COVERAGE_INC(ofproto_flows_req);
1913 reply = start_nxstats_reply(&nfsr->nsm, 1024);
1914 if (is_valid_table(nfsr->table_id)) {
1915 struct cls_cursor cursor;
1918 cls_cursor_init(&cursor, &ofproto->cls, &target);
1919 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1920 put_nx_flow_stats(ofconn, rule, nfsr->out_port, &reply);
1923 ofconn_send_reply(ofconn, reply);
1929 flow_stats_ds(struct rule *rule, struct ds *results)
1931 uint64_t packet_count, byte_count;
1932 size_t act_len = sizeof *rule->actions * rule->n_actions;
1934 rule->ofproto->ofproto_class->rule_get_stats(rule,
1935 &packet_count, &byte_count);
1937 ds_put_format(results, "duration=%llds, ",
1938 (time_msec() - rule->created) / 1000);
1939 ds_put_format(results, "priority=%u, ", rule->cr.priority);
1940 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
1941 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
1942 cls_rule_format(&rule->cr, results);
1943 ds_put_char(results, ',');
1945 ofp_print_actions(results, &rule->actions->header, act_len);
1947 ds_put_cstr(results, "drop");
1949 ds_put_cstr(results, "\n");
1952 /* Adds a pretty-printed description of all flows to 'results', including
1953 * hidden flows (e.g., set up by in-band control). */
1955 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
1957 struct cls_cursor cursor;
1960 cls_cursor_init(&cursor, &p->cls, NULL);
1961 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1962 flow_stats_ds(rule, results);
1966 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
1967 * '*engine_type' and '*engine_id', respectively. */
1969 ofproto_get_netflow_ids(const struct ofproto *ofproto,
1970 uint8_t *engine_type, uint8_t *engine_id)
1972 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
1976 query_aggregate_stats(struct ofproto *ofproto, struct cls_rule *target,
1977 ovs_be16 out_port, uint8_t table_id,
1978 struct ofp_aggregate_stats_reply *oasr)
1980 uint64_t total_packets = 0;
1981 uint64_t total_bytes = 0;
1984 COVERAGE_INC(ofproto_agg_request);
1986 if (is_valid_table(table_id)) {
1987 struct cls_cursor cursor;
1990 cls_cursor_init(&cursor, &ofproto->cls, target);
1991 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
1992 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
1993 uint64_t packet_count;
1994 uint64_t byte_count;
1996 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
1999 total_packets += packet_count;
2000 total_bytes += byte_count;
2006 oasr->flow_count = htonl(n_flows);
2007 put_32aligned_be64(&oasr->packet_count, htonll(total_packets));
2008 put_32aligned_be64(&oasr->byte_count, htonll(total_bytes));
2009 memset(oasr->pad, 0, sizeof oasr->pad);
2013 handle_aggregate_stats_request(struct ofconn *ofconn,
2014 const struct ofp_header *oh)
2016 const struct ofp_aggregate_stats_request *request = ofputil_stats_body(oh);
2017 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2018 struct ofp_aggregate_stats_reply *reply;
2019 struct cls_rule target;
2022 ofputil_cls_rule_from_match(&request->match, 0, NXFF_OPENFLOW10, 0,
2025 msg = start_ofp_stats_reply(oh, sizeof *reply);
2026 reply = append_ofp_stats_reply(sizeof *reply, ofconn, &msg);
2027 query_aggregate_stats(ofproto, &target, request->out_port,
2028 request->table_id, reply);
2029 ofconn_send_reply(ofconn, msg);
2034 handle_nxst_aggregate(struct ofconn *ofconn, const struct ofp_header *oh)
2036 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2037 struct nx_aggregate_stats_request *request;
2038 struct ofp_aggregate_stats_reply *reply;
2039 struct cls_rule target;
2044 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2046 /* Dissect the message. */
2047 request = ofpbuf_pull(&b, sizeof *request);
2048 error = nx_pull_match(&b, ntohs(request->match_len), 0, &target);
2053 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2057 COVERAGE_INC(ofproto_flows_req);
2058 buf = start_nxstats_reply(&request->nsm, sizeof *reply);
2059 reply = ofpbuf_put_uninit(buf, sizeof *reply);
2060 query_aggregate_stats(ofproto, &target, request->out_port,
2061 request->table_id, reply);
2062 ofconn_send_reply(ofconn, buf);
2067 struct queue_stats_cbdata {
2068 struct ofconn *ofconn;
2069 struct ofport *ofport;
2074 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2075 const struct netdev_queue_stats *stats)
2077 struct ofp_queue_stats *reply;
2079 reply = append_ofp_stats_reply(sizeof *reply, cbdata->ofconn, &cbdata->msg);
2080 reply->port_no = cbdata->ofport->opp.port_no;
2081 memset(reply->pad, 0, sizeof reply->pad);
2082 reply->queue_id = htonl(queue_id);
2083 put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2084 put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2085 put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2089 handle_queue_stats_dump_cb(uint32_t queue_id,
2090 struct netdev_queue_stats *stats,
2093 struct queue_stats_cbdata *cbdata = cbdata_;
2095 put_queue_stats(cbdata, queue_id, stats);
2099 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2100 struct queue_stats_cbdata *cbdata)
2102 cbdata->ofport = port;
2103 if (queue_id == OFPQ_ALL) {
2104 netdev_dump_queue_stats(port->netdev,
2105 handle_queue_stats_dump_cb, cbdata);
2107 struct netdev_queue_stats stats;
2109 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2110 put_queue_stats(cbdata, queue_id, &stats);
2116 handle_queue_stats_request(struct ofconn *ofconn, const struct ofp_header *oh)
2118 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2119 const struct ofp_queue_stats_request *qsr;
2120 struct queue_stats_cbdata cbdata;
2121 struct ofport *port;
2122 unsigned int port_no;
2125 qsr = ofputil_stats_body(oh);
2127 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2130 COVERAGE_INC(ofproto_queue_req);
2132 cbdata.ofconn = ofconn;
2133 cbdata.msg = start_ofp_stats_reply(oh, 128);
2135 port_no = ntohs(qsr->port_no);
2136 queue_id = ntohl(qsr->queue_id);
2137 if (port_no == OFPP_ALL) {
2138 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2139 handle_queue_stats_for_port(port, queue_id, &cbdata);
2141 } else if (port_no < OFPP_MAX) {
2142 port = ofproto_get_port(ofproto, port_no);
2144 handle_queue_stats_for_port(port, queue_id, &cbdata);
2147 ofpbuf_delete(cbdata.msg);
2148 return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
2150 ofconn_send_reply(ofconn, cbdata.msg);
2155 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2156 * in which no matching flow already exists in the flow table.
2158 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2159 * ofp_actions, to the ofproto's flow table. Returns 0 on success or an
2160 * OpenFlow error code as encoded by ofp_mkerr() on failure.
2162 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2165 add_flow(struct ofconn *ofconn, struct flow_mod *fm)
2167 struct ofproto *p = ofconn_get_ofproto(ofconn);
2168 struct ofpbuf *packet;
2174 if (fm->flags & OFPFF_CHECK_OVERLAP
2175 && classifier_rule_overlaps(&p->cls, &fm->cr)) {
2176 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
2179 buf_err = ofconn_pktbuf_retrieve(ofconn, fm->buffer_id, &packet, &in_port);
2180 error = rule_create(p, &fm->cr, fm->actions, fm->n_actions,
2181 fm->idle_timeout, fm->hard_timeout, fm->cookie,
2182 fm->flags & OFPFF_SEND_FLOW_REM, &rule);
2184 ofpbuf_delete(packet);
2190 return rule_execute(rule, in_port, packet);
2195 static struct rule *
2196 find_flow_strict(struct ofproto *p, const struct flow_mod *fm)
2198 return rule_from_cls_rule(classifier_find_rule_exactly(&p->cls, &fm->cr));
2202 send_buffered_packet(struct ofconn *ofconn,
2203 struct rule *rule, uint32_t buffer_id)
2205 struct ofpbuf *packet;
2209 if (buffer_id == UINT32_MAX) {
2213 error = ofconn_pktbuf_retrieve(ofconn, buffer_id, &packet, &in_port);
2218 return rule_execute(rule, in_port, packet);
2221 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2223 struct modify_flows_cbdata {
2224 struct ofproto *ofproto;
2225 const struct flow_mod *fm;
2229 static int modify_flow(const struct flow_mod *, struct rule *);
2231 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code as
2232 * encoded by ofp_mkerr() on failure.
2234 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2237 modify_flows_loose(struct ofconn *ofconn, struct flow_mod *fm)
2239 struct ofproto *p = ofconn_get_ofproto(ofconn);
2240 struct rule *match = NULL;
2241 struct cls_cursor cursor;
2246 cls_cursor_init(&cursor, &p->cls, &fm->cr);
2247 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2248 if (!rule_is_hidden(rule)) {
2249 int retval = modify_flow(fm, rule);
2261 /* This credits the packet to whichever flow happened to match last.
2262 * That's weird. Maybe we should do a lookup for the flow that
2263 * actually matches the packet? Who knows. */
2264 send_buffered_packet(ofconn, match, fm->buffer_id);
2267 return add_flow(ofconn, fm);
2271 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2272 * code as encoded by ofp_mkerr() on failure.
2274 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2277 modify_flow_strict(struct ofconn *ofconn, struct flow_mod *fm)
2279 struct ofproto *p = ofconn_get_ofproto(ofconn);
2280 struct rule *rule = find_flow_strict(p, fm);
2281 if (rule && !rule_is_hidden(rule)) {
2282 int error = modify_flow(fm, rule);
2284 error = send_buffered_packet(ofconn, rule, fm->buffer_id);
2288 return add_flow(ofconn, fm);
2292 /* Implements core of OFPFC_MODIFY and OFPFC_MODIFY_STRICT where 'rule' has
2293 * been identified as a flow to be modified, by changing the rule's actions to
2294 * match those in 'ofm' (which is followed by 'n_actions' ofp_action[]
2297 modify_flow(const struct flow_mod *fm, struct rule *rule)
2299 size_t actions_len = fm->n_actions * sizeof *rule->actions;
2302 if (fm->n_actions == rule->n_actions
2304 || !memcmp(fm->actions, rule->actions, actions_len))) {
2307 error = rule->ofproto->ofproto_class->rule_modify_actions(
2308 rule, fm->actions, fm->n_actions);
2310 free(rule->actions);
2311 rule->actions = (fm->n_actions
2312 ? xmemdup(fm->actions, actions_len)
2314 rule->n_actions = fm->n_actions;
2319 rule->flow_cookie = fm->cookie;
2325 /* OFPFC_DELETE implementation. */
2327 static void delete_flow(struct rule *, ovs_be16 out_port);
2329 /* Implements OFPFC_DELETE. */
2331 delete_flows_loose(struct ofproto *p, const struct flow_mod *fm)
2333 struct rule *rule, *next_rule;
2334 struct cls_cursor cursor;
2336 cls_cursor_init(&cursor, &p->cls, &fm->cr);
2337 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
2338 delete_flow(rule, htons(fm->out_port));
2342 /* Implements OFPFC_DELETE_STRICT. */
2344 delete_flow_strict(struct ofproto *p, struct flow_mod *fm)
2346 struct rule *rule = find_flow_strict(p, fm);
2348 delete_flow(rule, htons(fm->out_port));
2352 /* Implements core of OFPFC_DELETE and OFPFC_DELETE_STRICT where 'rule' has
2353 * been identified as a flow to delete from 'p''s flow table, by deleting the
2354 * flow and sending out a OFPT_FLOW_REMOVED message to any interested
2357 * Will not delete 'rule' if it is hidden. Will delete 'rule' only if
2358 * 'out_port' is htons(OFPP_NONE) or if 'rule' actually outputs to the
2359 * specified 'out_port'. */
2361 delete_flow(struct rule *rule, ovs_be16 out_port)
2363 if (rule_is_hidden(rule)) {
2367 if (out_port != htons(OFPP_NONE) && !rule_has_out_port(rule, out_port)) {
2371 ofproto_rule_send_removed(rule, OFPRR_DELETE);
2372 ofproto_rule_remove(rule);
2376 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2378 struct ofputil_flow_removed fr;
2380 if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2385 fr.cookie = rule->flow_cookie;
2387 calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2388 fr.idle_timeout = rule->idle_timeout;
2389 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2392 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2395 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2396 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2399 * ofproto implementation ->run() functions should use this function to expire
2400 * OpenFlow flows. */
2402 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2404 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2405 ofproto_rule_send_removed(rule, reason);
2406 ofproto_rule_remove(rule);
2410 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2412 struct ofproto *p = ofconn_get_ofproto(ofconn);
2416 error = reject_slave_controller(ofconn, "flow_mod");
2421 error = ofputil_decode_flow_mod(&fm, oh, ofconn_get_flow_format(ofconn));
2426 /* We do not support the emergency flow cache. It will hopefully get
2427 * dropped from OpenFlow in the near future. */
2428 if (fm.flags & OFPFF_EMERG) {
2429 /* There isn't a good fit for an error code, so just state that the
2430 * flow table is full. */
2431 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
2434 switch (fm.command) {
2436 return add_flow(ofconn, &fm);
2439 return modify_flows_loose(ofconn, &fm);
2441 case OFPFC_MODIFY_STRICT:
2442 return modify_flow_strict(ofconn, &fm);
2445 delete_flows_loose(p, &fm);
2448 case OFPFC_DELETE_STRICT:
2449 delete_flow_strict(p, &fm);
2453 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2458 handle_tun_id_from_cookie(struct ofconn *ofconn, const struct ofp_header *oh)
2460 const struct nxt_tun_id_cookie *msg
2461 = (const struct nxt_tun_id_cookie *) oh;
2462 enum nx_flow_format flow_format;
2464 flow_format = msg->set ? NXFF_TUN_ID_FROM_COOKIE : NXFF_OPENFLOW10;
2465 ofconn_set_flow_format(ofconn, flow_format);
2471 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2473 struct nx_role_request *nrr = (struct nx_role_request *) oh;
2474 struct nx_role_request *reply;
2478 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2479 VLOG_WARN_RL(&rl, "ignoring role request on service connection");
2480 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2483 role = ntohl(nrr->role);
2484 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2485 && role != NX_ROLE_SLAVE) {
2486 VLOG_WARN_RL(&rl, "received request for unknown role %"PRIu32, role);
2488 /* There's no good error code for this. */
2489 return ofp_mkerr(OFPET_BAD_REQUEST, -1);
2492 ofconn_set_role(ofconn, role);
2494 reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2495 reply->role = htonl(role);
2496 ofconn_send_reply(ofconn, buf);
2502 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2504 const struct nxt_set_flow_format *msg
2505 = (const struct nxt_set_flow_format *) oh;
2508 format = ntohl(msg->format);
2509 if (format == NXFF_OPENFLOW10
2510 || format == NXFF_TUN_ID_FROM_COOKIE
2511 || format == NXFF_NXM) {
2512 ofconn_set_flow_format(ofconn, format);
2515 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2520 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2522 struct ofp_header *ob;
2525 /* Currently, everything executes synchronously, so we can just
2526 * immediately send the barrier reply. */
2527 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2528 ofconn_send_reply(ofconn, buf);
2533 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2535 const struct ofp_header *oh = msg->data;
2536 const struct ofputil_msg_type *type;
2539 error = ofputil_decode_msg_type(oh, &type);
2544 switch (ofputil_msg_type_code(type)) {
2545 /* OpenFlow requests. */
2546 case OFPUTIL_OFPT_ECHO_REQUEST:
2547 return handle_echo_request(ofconn, oh);
2549 case OFPUTIL_OFPT_FEATURES_REQUEST:
2550 return handle_features_request(ofconn, oh);
2552 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2553 return handle_get_config_request(ofconn, oh);
2555 case OFPUTIL_OFPT_SET_CONFIG:
2556 return handle_set_config(ofconn, msg->data);
2558 case OFPUTIL_OFPT_PACKET_OUT:
2559 return handle_packet_out(ofconn, oh);
2561 case OFPUTIL_OFPT_PORT_MOD:
2562 return handle_port_mod(ofconn, oh);
2564 case OFPUTIL_OFPT_FLOW_MOD:
2565 return handle_flow_mod(ofconn, oh);
2567 case OFPUTIL_OFPT_BARRIER_REQUEST:
2568 return handle_barrier_request(ofconn, oh);
2570 /* OpenFlow replies. */
2571 case OFPUTIL_OFPT_ECHO_REPLY:
2574 /* Nicira extension requests. */
2575 case OFPUTIL_NXT_TUN_ID_FROM_COOKIE:
2576 return handle_tun_id_from_cookie(ofconn, oh);
2578 case OFPUTIL_NXT_ROLE_REQUEST:
2579 return handle_role_request(ofconn, oh);
2581 case OFPUTIL_NXT_SET_FLOW_FORMAT:
2582 return handle_nxt_set_flow_format(ofconn, oh);
2584 case OFPUTIL_NXT_FLOW_MOD:
2585 return handle_flow_mod(ofconn, oh);
2587 /* OpenFlow statistics requests. */
2588 case OFPUTIL_OFPST_DESC_REQUEST:
2589 return handle_desc_stats_request(ofconn, oh);
2591 case OFPUTIL_OFPST_FLOW_REQUEST:
2592 return handle_flow_stats_request(ofconn, oh);
2594 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
2595 return handle_aggregate_stats_request(ofconn, oh);
2597 case OFPUTIL_OFPST_TABLE_REQUEST:
2598 return handle_table_stats_request(ofconn, oh);
2600 case OFPUTIL_OFPST_PORT_REQUEST:
2601 return handle_port_stats_request(ofconn, oh);
2603 case OFPUTIL_OFPST_QUEUE_REQUEST:
2604 return handle_queue_stats_request(ofconn, oh);
2606 /* Nicira extension statistics requests. */
2607 case OFPUTIL_NXST_FLOW_REQUEST:
2608 return handle_nxst_flow(ofconn, oh);
2610 case OFPUTIL_NXST_AGGREGATE_REQUEST:
2611 return handle_nxst_aggregate(ofconn, oh);
2613 case OFPUTIL_INVALID:
2614 case OFPUTIL_OFPT_HELLO:
2615 case OFPUTIL_OFPT_ERROR:
2616 case OFPUTIL_OFPT_FEATURES_REPLY:
2617 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
2618 case OFPUTIL_OFPT_PACKET_IN:
2619 case OFPUTIL_OFPT_FLOW_REMOVED:
2620 case OFPUTIL_OFPT_PORT_STATUS:
2621 case OFPUTIL_OFPT_BARRIER_REPLY:
2622 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
2623 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
2624 case OFPUTIL_OFPST_DESC_REPLY:
2625 case OFPUTIL_OFPST_FLOW_REPLY:
2626 case OFPUTIL_OFPST_QUEUE_REPLY:
2627 case OFPUTIL_OFPST_PORT_REPLY:
2628 case OFPUTIL_OFPST_TABLE_REPLY:
2629 case OFPUTIL_OFPST_AGGREGATE_REPLY:
2630 case OFPUTIL_NXT_ROLE_REPLY:
2631 case OFPUTIL_NXT_FLOW_REMOVED:
2632 case OFPUTIL_NXST_FLOW_REPLY:
2633 case OFPUTIL_NXST_AGGREGATE_REPLY:
2635 if (VLOG_IS_WARN_ENABLED()) {
2636 char *s = ofp_to_string(oh, ntohs(oh->length), 2);
2637 VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
2640 if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
2641 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2643 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
2649 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
2651 int error = handle_openflow__(ofconn, ofp_msg);
2653 send_error_oh(ofconn, ofp_msg->data, error);
2655 COVERAGE_INC(ofproto_recv_openflow);
2659 pick_datapath_id(const struct ofproto *ofproto)
2661 const struct ofport *port;
2663 port = ofproto_get_port(ofproto, OFPP_LOCAL);
2665 uint8_t ea[ETH_ADDR_LEN];
2668 error = netdev_get_etheraddr(port->netdev, ea);
2670 return eth_addr_to_uint64(ea);
2672 VLOG_WARN("could not get MAC address for %s (%s)",
2673 netdev_get_name(port->netdev), strerror(error));
2675 return ofproto->fallback_dpid;
2679 pick_fallback_dpid(void)
2681 uint8_t ea[ETH_ADDR_LEN];
2682 eth_addr_nicira_random(ea);
2683 return eth_addr_to_uint64(ea);
2686 /* unixctl commands. */
2689 ofproto_lookup(const char *name)
2691 struct ofproto *ofproto;
2693 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
2695 if (!strcmp(ofproto->name, name)) {
2703 ofproto_unixctl_list(struct unixctl_conn *conn, const char *arg OVS_UNUSED,
2704 void *aux OVS_UNUSED)
2706 struct ofproto *ofproto;
2710 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
2711 ds_put_format(&results, "%s\n", ofproto->name);
2713 unixctl_command_reply(conn, 200, ds_cstr(&results));
2714 ds_destroy(&results);
2718 ofproto_unixctl_init(void)
2720 static bool registered;
2726 unixctl_command_register("ofproto/list", ofproto_unixctl_list, NULL);