2 * Copyright (c) 2009, 2010, 2011, 2012 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.
25 #include "byte-order.h"
26 #include "classifier.h"
29 #include "dynamic-string.h"
34 #include "ofp-print.h"
37 #include "ofproto-provider.h"
38 #include "openflow/nicira-ext.h"
39 #include "openflow/openflow.h"
43 #include "poll-loop.h"
47 #include "unaligned.h"
51 VLOG_DEFINE_THIS_MODULE(ofproto);
53 COVERAGE_DEFINE(ofproto_error);
54 COVERAGE_DEFINE(ofproto_flush);
55 COVERAGE_DEFINE(ofproto_no_packet_in);
56 COVERAGE_DEFINE(ofproto_packet_out);
57 COVERAGE_DEFINE(ofproto_queue_req);
58 COVERAGE_DEFINE(ofproto_recv_openflow);
59 COVERAGE_DEFINE(ofproto_reinit_ports);
60 COVERAGE_DEFINE(ofproto_uninstallable);
61 COVERAGE_DEFINE(ofproto_update_port);
64 S_OPENFLOW, /* Processing OpenFlow commands. */
65 S_FLUSH, /* Deleting all flow table rules. */
68 enum ofoperation_type {
74 /* A single OpenFlow request can execute any number of operations. The
75 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
76 * ofconn to which an error reply should be sent if necessary.
78 * ofproto initiates some operations internally. These operations are still
79 * assigned to groups but will not have an associated ofconn. */
81 struct ofproto *ofproto; /* Owning ofproto. */
82 struct list ofproto_node; /* In ofproto's "pending" list. */
83 struct list ops; /* List of "struct ofoperation"s. */
85 /* Data needed to send OpenFlow reply on failure or to send a buffered
88 * If list_is_empty(ofconn_node) then this ofopgroup never had an
89 * associated ofconn or its ofconn's connection dropped after it initiated
90 * the operation. In the latter case 'ofconn' is a wild pointer that
91 * refers to freed memory, so the 'ofconn' member must be used only if
92 * !list_is_empty(ofconn_node).
94 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
95 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
96 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
97 uint32_t buffer_id; /* Buffer id from original request. */
98 int error; /* 0 if no error yet, otherwise error code. */
101 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
102 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
103 const struct ofp_header *,
105 static void ofopgroup_submit(struct ofopgroup *);
106 static void ofopgroup_destroy(struct ofopgroup *);
108 /* A single flow table operation. */
110 struct ofopgroup *group; /* Owning group. */
111 struct list group_node; /* In ofopgroup's "ops" list. */
112 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
113 struct rule *rule; /* Rule being operated upon. */
114 enum ofoperation_type type; /* Type of operation. */
115 int status; /* -1 if pending, otherwise 0 or error code. */
116 struct rule *victim; /* OFOPERATION_ADDING: Replaced rule. */
117 union ofp_action *actions; /* OFOPERATION_MODIFYING: Replaced actions. */
118 int n_actions; /* OFOPERATION_MODIFYING: # of old actions. */
119 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
122 static void ofoperation_create(struct ofopgroup *, struct rule *,
123 enum ofoperation_type);
124 static void ofoperation_destroy(struct ofoperation *);
126 static void ofport_destroy__(struct ofport *);
127 static void ofport_destroy(struct ofport *);
129 static uint64_t pick_datapath_id(const struct ofproto *);
130 static uint64_t pick_fallback_dpid(void);
132 static void ofproto_destroy__(struct ofproto *);
134 static void ofproto_rule_destroy__(struct rule *);
135 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
137 static void ofopgroup_destroy(struct ofopgroup *);
139 static int add_flow(struct ofproto *, struct ofconn *,
140 const struct ofputil_flow_mod *,
141 const struct ofp_header *);
143 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
144 static int handle_flow_mod__(struct ofproto *, struct ofconn *,
145 const struct ofputil_flow_mod *,
146 const struct ofp_header *);
148 static void update_port(struct ofproto *, const char *devname);
149 static int init_ports(struct ofproto *);
150 static void reinit_ports(struct ofproto *);
151 static void set_internal_devs_mtu(struct ofproto *);
153 static void ofproto_unixctl_init(void);
155 /* All registered ofproto classes, in probe order. */
156 static const struct ofproto_class **ofproto_classes;
157 static size_t n_ofproto_classes;
158 static size_t allocated_ofproto_classes;
160 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
161 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
163 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
166 ofproto_initialize(void)
172 ofproto_class_register(&ofproto_dpif_class);
176 /* 'type' should be a normalized datapath type, as returned by
177 * ofproto_normalize_type(). Returns the corresponding ofproto_class
178 * structure, or a null pointer if there is none registered for 'type'. */
179 static const struct ofproto_class *
180 ofproto_class_find__(const char *type)
184 ofproto_initialize();
185 for (i = 0; i < n_ofproto_classes; i++) {
186 const struct ofproto_class *class = ofproto_classes[i];
191 class->enumerate_types(&types);
192 found = sset_contains(&types, type);
193 sset_destroy(&types);
199 VLOG_WARN("unknown datapath type %s", type);
203 /* Registers a new ofproto class. After successful registration, new ofprotos
204 * of that type can be created using ofproto_create(). */
206 ofproto_class_register(const struct ofproto_class *new_class)
210 for (i = 0; i < n_ofproto_classes; i++) {
211 if (ofproto_classes[i] == new_class) {
216 if (n_ofproto_classes >= allocated_ofproto_classes) {
217 ofproto_classes = x2nrealloc(ofproto_classes,
218 &allocated_ofproto_classes,
219 sizeof *ofproto_classes);
221 ofproto_classes[n_ofproto_classes++] = new_class;
225 /* Unregisters a datapath provider. 'type' must have been previously
226 * registered and not currently be in use by any ofprotos. After
227 * unregistration new datapaths of that type cannot be opened using
228 * ofproto_create(). */
230 ofproto_class_unregister(const struct ofproto_class *class)
234 for (i = 0; i < n_ofproto_classes; i++) {
235 if (ofproto_classes[i] == class) {
236 for (i++; i < n_ofproto_classes; i++) {
237 ofproto_classes[i - 1] = ofproto_classes[i];
243 VLOG_WARN("attempted to unregister an ofproto class that is not "
248 /* Clears 'types' and enumerates all registered ofproto types into it. The
249 * caller must first initialize the sset. */
251 ofproto_enumerate_types(struct sset *types)
255 ofproto_initialize();
256 for (i = 0; i < n_ofproto_classes; i++) {
257 ofproto_classes[i]->enumerate_types(types);
261 /* Returns the fully spelled out name for the given ofproto 'type'.
263 * Normalized type string can be compared with strcmp(). Unnormalized type
264 * string might be the same even if they have different spellings. */
266 ofproto_normalize_type(const char *type)
268 return type && type[0] ? type : "system";
271 /* Clears 'names' and enumerates the names of all known created ofprotos with
272 * the given 'type'. The caller must first initialize the sset. Returns 0 if
273 * successful, otherwise a positive errno value.
275 * Some kinds of datapaths might not be practically enumerable. This is not
276 * considered an error. */
278 ofproto_enumerate_names(const char *type, struct sset *names)
280 const struct ofproto_class *class = ofproto_class_find__(type);
281 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
285 ofproto_create(const char *datapath_name, const char *datapath_type,
286 struct ofproto **ofprotop)
288 const struct ofproto_class *class;
289 struct classifier *table;
290 struct ofproto *ofproto;
296 ofproto_initialize();
297 ofproto_unixctl_init();
299 datapath_type = ofproto_normalize_type(datapath_type);
300 class = ofproto_class_find__(datapath_type);
302 VLOG_WARN("could not create datapath %s of unknown type %s",
303 datapath_name, datapath_type);
307 ofproto = class->alloc();
309 VLOG_ERR("failed to allocate datapath %s of type %s",
310 datapath_name, datapath_type);
315 memset(ofproto, 0, sizeof *ofproto);
316 ofproto->ofproto_class = class;
317 ofproto->name = xstrdup(datapath_name);
318 ofproto->type = xstrdup(datapath_type);
319 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
320 hash_string(ofproto->name, 0));
321 ofproto->datapath_id = 0;
322 ofproto_set_flow_eviction_threshold(ofproto,
323 OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT);
324 ofproto->forward_bpdu = false;
325 ofproto->fallback_dpid = pick_fallback_dpid();
326 ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
327 ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
328 ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
329 ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
330 ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
331 ofproto->frag_handling = OFPC_FRAG_NORMAL;
332 hmap_init(&ofproto->ports);
333 shash_init(&ofproto->port_by_name);
334 ofproto->tables = NULL;
335 ofproto->n_tables = 0;
336 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
337 ofproto->state = S_OPENFLOW;
338 list_init(&ofproto->pending);
339 ofproto->n_pending = 0;
340 hmap_init(&ofproto->deletions);
341 ofproto->vlan_bitmap = NULL;
342 ofproto->vlans_changed = false;
344 error = ofproto->ofproto_class->construct(ofproto, &n_tables);
346 VLOG_ERR("failed to open datapath %s: %s",
347 datapath_name, strerror(error));
348 ofproto_destroy__(ofproto);
352 assert(n_tables >= 1 && n_tables <= 255);
353 ofproto->n_tables = n_tables;
354 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
355 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
356 classifier_init(table);
359 ofproto->datapath_id = pick_datapath_id(ofproto);
360 VLOG_INFO("using datapath ID %016"PRIx64, ofproto->datapath_id);
368 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
370 uint64_t old_dpid = p->datapath_id;
371 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
372 if (p->datapath_id != old_dpid) {
373 VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
375 /* Force all active connections to reconnect, since there is no way to
376 * notify a controller that the datapath ID has changed. */
377 ofproto_reconnect_controllers(p);
382 ofproto_set_controllers(struct ofproto *p,
383 const struct ofproto_controller *controllers,
384 size_t n_controllers)
386 connmgr_set_controllers(p->connmgr, controllers, n_controllers);
390 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
392 connmgr_set_fail_mode(p->connmgr, fail_mode);
395 /* Drops the connections between 'ofproto' and all of its controllers, forcing
396 * them to reconnect. */
398 ofproto_reconnect_controllers(struct ofproto *ofproto)
400 connmgr_reconnect(ofproto->connmgr);
403 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
404 * in-band control should guarantee access, in the same way that in-band
405 * control guarantees access to OpenFlow controllers. */
407 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
408 const struct sockaddr_in *extras, size_t n)
410 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
413 /* Sets the OpenFlow queue used by flows set up by in-band control on
414 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
415 * flows will use the default queue. */
417 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
419 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
422 /* Sets the number of flows at which eviction from the kernel flow table
425 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
427 if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
428 ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
430 ofproto->flow_eviction_threshold = threshold;
434 /* If forward_bpdu is true, the NORMAL action will forward frames with
435 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
436 * the NORMAL action will drop these frames. */
438 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
440 bool old_val = ofproto->forward_bpdu;
441 ofproto->forward_bpdu = forward_bpdu;
442 if (old_val != ofproto->forward_bpdu) {
443 if (ofproto->ofproto_class->forward_bpdu_changed) {
444 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
450 ofproto_set_desc(struct ofproto *p,
451 const char *mfr_desc, const char *hw_desc,
452 const char *sw_desc, const char *serial_desc,
455 struct ofp_desc_stats *ods;
458 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
459 VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
460 sizeof ods->mfr_desc);
463 p->mfr_desc = xstrdup(mfr_desc);
466 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
467 VLOG_WARN("truncating hw_desc, must be less than %zu characters",
468 sizeof ods->hw_desc);
471 p->hw_desc = xstrdup(hw_desc);
474 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
475 VLOG_WARN("truncating sw_desc, must be less than %zu characters",
476 sizeof ods->sw_desc);
479 p->sw_desc = xstrdup(sw_desc);
482 if (strlen(serial_desc) >= sizeof ods->serial_num) {
483 VLOG_WARN("truncating serial_desc, must be less than %zu "
485 sizeof ods->serial_num);
487 free(p->serial_desc);
488 p->serial_desc = xstrdup(serial_desc);
491 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
492 VLOG_WARN("truncating dp_desc, must be less than %zu characters",
493 sizeof ods->dp_desc);
496 p->dp_desc = xstrdup(dp_desc);
501 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
503 return connmgr_set_snoops(ofproto->connmgr, snoops);
507 ofproto_set_netflow(struct ofproto *ofproto,
508 const struct netflow_options *nf_options)
510 if (nf_options && sset_is_empty(&nf_options->collectors)) {
514 if (ofproto->ofproto_class->set_netflow) {
515 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
517 return nf_options ? EOPNOTSUPP : 0;
522 ofproto_set_sflow(struct ofproto *ofproto,
523 const struct ofproto_sflow_options *oso)
525 if (oso && sset_is_empty(&oso->targets)) {
529 if (ofproto->ofproto_class->set_sflow) {
530 return ofproto->ofproto_class->set_sflow(ofproto, oso);
532 return oso ? EOPNOTSUPP : 0;
536 /* Spanning Tree Protocol (STP) configuration. */
538 /* Configures STP on 'ofproto' using the settings defined in 's'. If
539 * 's' is NULL, disables STP.
541 * Returns 0 if successful, otherwise a positive errno value. */
543 ofproto_set_stp(struct ofproto *ofproto,
544 const struct ofproto_stp_settings *s)
546 return (ofproto->ofproto_class->set_stp
547 ? ofproto->ofproto_class->set_stp(ofproto, s)
551 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
552 * 'enabled' member of 's' is false, then the other members are not
555 * Returns 0 if successful, otherwise a positive errno value. */
557 ofproto_get_stp_status(struct ofproto *ofproto,
558 struct ofproto_stp_status *s)
560 return (ofproto->ofproto_class->get_stp_status
561 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
565 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
566 * in 's'. The caller is responsible for assigning STP port numbers
567 * (using the 'port_num' member in the range of 1 through 255, inclusive)
568 * and ensuring there are no duplicates. If the 's' is NULL, then STP
569 * is disabled on the port.
571 * Returns 0 if successful, otherwise a positive errno value.*/
573 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
574 const struct ofproto_port_stp_settings *s)
576 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
578 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
579 ofproto->name, ofp_port);
583 return (ofproto->ofproto_class->set_stp_port
584 ? ofproto->ofproto_class->set_stp_port(ofport, s)
588 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
589 * 's'. If the 'enabled' member in 's' is false, then the other members
590 * are not meaningful.
592 * Returns 0 if successful, otherwise a positive errno value.*/
594 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
595 struct ofproto_port_stp_status *s)
597 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
599 VLOG_WARN("%s: cannot get STP status on nonexistent port %"PRIu16,
600 ofproto->name, ofp_port);
604 return (ofproto->ofproto_class->get_stp_port_status
605 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
609 /* Queue DSCP configuration. */
611 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
612 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
613 * to implement QoS. Instead, it is used to implement features which require
614 * knowledge of what queues exist on a port, and some basic information about
617 * Returns 0 if successful, otherwise a positive errno value. */
619 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
620 const struct ofproto_port_queue *queues,
623 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
626 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
627 ofproto->name, ofp_port);
631 return (ofproto->ofproto_class->set_queues
632 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
636 /* Connectivity Fault Management configuration. */
638 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
640 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
642 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
643 if (ofport && ofproto->ofproto_class->set_cfm) {
644 ofproto->ofproto_class->set_cfm(ofport, NULL);
648 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
649 * basic configuration from the configuration members in 'cfm', and the remote
650 * maintenance point ID from remote_mpid. Ignores the statistics members of
653 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
655 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
656 const struct cfm_settings *s)
658 struct ofport *ofport;
661 ofport = ofproto_get_port(ofproto, ofp_port);
663 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
664 ofproto->name, ofp_port);
668 /* XXX: For configuration simplicity, we only support one remote_mpid
669 * outside of the CFM module. It's not clear if this is the correct long
670 * term solution or not. */
671 error = (ofproto->ofproto_class->set_cfm
672 ? ofproto->ofproto_class->set_cfm(ofport, s)
675 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
676 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
681 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
682 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
683 * 0 if LACP partner information is not current (generally indicating a
684 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
686 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
688 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
689 return (ofport && ofproto->ofproto_class->port_is_lacp_current
690 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
696 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
697 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
698 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
699 * configuration plus, if there is more than one slave, a bonding
702 * If 'aux' is already registered then this function updates its configuration
703 * to 's'. Otherwise, this function registers a new bundle.
705 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
708 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
709 const struct ofproto_bundle_settings *s)
711 return (ofproto->ofproto_class->bundle_set
712 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
716 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
717 * If no such bundle has been registered, this has no effect. */
719 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
721 return ofproto_bundle_register(ofproto, aux, NULL);
725 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
726 * If 'aux' is already registered then this function updates its configuration
727 * to 's'. Otherwise, this function registers a new mirror. */
729 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
730 const struct ofproto_mirror_settings *s)
732 return (ofproto->ofproto_class->mirror_set
733 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
737 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
738 * If no mirror has been registered, this has no effect. */
740 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
742 return ofproto_mirror_register(ofproto, aux, NULL);
745 /* Retrieves statistics from mirror associated with client data pointer
746 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
747 * 'bytes', respectively. If a particular counters is not supported,
748 * the appropriate argument is set to UINT64_MAX. */
750 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
751 uint64_t *packets, uint64_t *bytes)
753 if (!ofproto->ofproto_class->mirror_get_stats) {
754 *packets = *bytes = UINT64_MAX;
758 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
762 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
763 * which all packets are flooded, instead of using MAC learning. If
764 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
766 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
769 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
771 return (ofproto->ofproto_class->set_flood_vlans
772 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
776 /* Returns true if 'aux' is a registered bundle that is currently in use as the
777 * output for a mirror. */
779 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
781 return (ofproto->ofproto_class->is_mirror_output_bundle
782 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
787 ofproto_has_snoops(const struct ofproto *ofproto)
789 return connmgr_has_snoops(ofproto->connmgr);
793 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
795 connmgr_get_snoops(ofproto->connmgr, snoops);
799 ofproto_flush__(struct ofproto *ofproto)
801 struct classifier *table;
802 struct ofopgroup *group;
804 if (ofproto->ofproto_class->flush) {
805 ofproto->ofproto_class->flush(ofproto);
808 group = ofopgroup_create_unattached(ofproto);
809 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
810 struct rule *rule, *next_rule;
811 struct cls_cursor cursor;
813 cls_cursor_init(&cursor, table, NULL);
814 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
815 if (!rule->pending) {
816 ofoperation_create(group, rule, OFOPERATION_DELETE);
817 classifier_remove(table, &rule->cr);
818 ofproto->ofproto_class->rule_destruct(rule);
822 ofopgroup_submit(group);
826 ofproto_destroy__(struct ofproto *ofproto)
828 struct classifier *table;
830 assert(list_is_empty(&ofproto->pending));
831 assert(!ofproto->n_pending);
833 connmgr_destroy(ofproto->connmgr);
835 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
838 free(ofproto->mfr_desc);
839 free(ofproto->hw_desc);
840 free(ofproto->sw_desc);
841 free(ofproto->serial_desc);
842 free(ofproto->dp_desc);
843 hmap_destroy(&ofproto->ports);
844 shash_destroy(&ofproto->port_by_name);
846 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
847 assert(classifier_is_empty(table));
848 classifier_destroy(table);
850 free(ofproto->tables);
852 hmap_destroy(&ofproto->deletions);
854 free(ofproto->vlan_bitmap);
856 ofproto->ofproto_class->dealloc(ofproto);
860 ofproto_destroy(struct ofproto *p)
862 struct ofport *ofport, *next_ofport;
869 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
870 ofport_destroy(ofport);
873 p->ofproto_class->destruct(p);
874 ofproto_destroy__(p);
877 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
878 * kernel datapath, for example, this destroys the datapath in the kernel, and
879 * with the netdev-based datapath, it tears down the data structures that
880 * represent the datapath.
882 * The datapath should not be currently open as an ofproto. */
884 ofproto_delete(const char *name, const char *type)
886 const struct ofproto_class *class = ofproto_class_find__(type);
887 return (!class ? EAFNOSUPPORT
888 : !class->del ? EACCES
889 : class->del(type, name));
893 process_port_change(struct ofproto *ofproto, int error, char *devname)
895 if (error == ENOBUFS) {
896 reinit_ports(ofproto);
898 update_port(ofproto, devname);
904 ofproto_run(struct ofproto *p)
906 struct ofport *ofport;
910 error = p->ofproto_class->run(p);
911 if (error && error != EAGAIN) {
912 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, strerror(error));
915 if (p->ofproto_class->port_poll) {
916 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
917 process_port_change(p, error, devname);
921 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
922 unsigned int change_seq = netdev_change_seq(ofport->netdev);
923 if (ofport->change_seq != change_seq) {
924 ofport->change_seq = change_seq;
925 update_port(p, netdev_get_name(ofport->netdev));
932 connmgr_run(p->connmgr, handle_openflow);
936 connmgr_run(p->connmgr, NULL);
938 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
939 connmgr_flushed(p->connmgr);
940 p->state = S_OPENFLOW;
951 /* Performs periodic activity required by 'ofproto' that needs to be done
952 * with the least possible latency.
954 * It makes sense to call this function a couple of times per poll loop, to
955 * provide a significant performance boost on some benchmarks with the
956 * ofproto-dpif implementation. */
958 ofproto_run_fast(struct ofproto *p)
962 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
963 if (error && error != EAGAIN) {
964 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
965 p->name, strerror(error));
971 ofproto_wait(struct ofproto *p)
973 struct ofport *ofport;
975 p->ofproto_class->wait(p);
976 if (p->ofproto_class->port_poll_wait) {
977 p->ofproto_class->port_poll_wait(p);
980 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
981 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
982 poll_immediate_wake();
988 connmgr_wait(p->connmgr, true);
992 connmgr_wait(p->connmgr, false);
993 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
994 poll_immediate_wake();
1001 ofproto_is_alive(const struct ofproto *p)
1003 return connmgr_has_controllers(p->connmgr);
1007 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1010 connmgr_get_controller_info(ofproto->connmgr, info);
1014 ofproto_free_ofproto_controller_info(struct shash *info)
1016 connmgr_free_controller_info(info);
1019 /* Makes a deep copy of 'old' into 'port'. */
1021 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1023 port->name = xstrdup(old->name);
1024 port->type = xstrdup(old->type);
1025 port->ofp_port = old->ofp_port;
1028 /* Frees memory allocated to members of 'ofproto_port'.
1030 * Do not call this function on an ofproto_port obtained from
1031 * ofproto_port_dump_next(): that function retains ownership of the data in the
1034 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1036 free(ofproto_port->name);
1037 free(ofproto_port->type);
1040 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1042 * This function provides no status indication. An error status for the entire
1043 * dump operation is provided when it is completed by calling
1044 * ofproto_port_dump_done().
1047 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1048 const struct ofproto *ofproto)
1050 dump->ofproto = ofproto;
1051 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1055 /* Attempts to retrieve another port from 'dump', which must have been created
1056 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1057 * 'port' and returns true. On failure, returns false.
1059 * Failure might indicate an actual error or merely that the last port has been
1060 * dumped. An error status for the entire dump operation is provided when it
1061 * is completed by calling ofproto_port_dump_done().
1063 * The ofproto owns the data stored in 'port'. It will remain valid until at
1064 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1065 * ofproto_port_dump_done(). */
1067 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1068 struct ofproto_port *port)
1070 const struct ofproto *ofproto = dump->ofproto;
1076 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1079 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1085 /* Completes port table dump operation 'dump', which must have been created
1086 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1087 * error-free, otherwise a positive errno value describing the problem. */
1089 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1091 const struct ofproto *ofproto = dump->ofproto;
1093 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1096 return dump->error == EOF ? 0 : dump->error;
1099 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
1100 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
1101 * is non-null). On failure, returns a positive errno value and sets
1102 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
1104 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1105 uint16_t *ofp_portp)
1110 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
1112 update_port(ofproto, netdev_get_name(netdev));
1115 *ofp_portp = error ? OFPP_NONE : ofp_port;
1120 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1121 * initializes '*port' appropriately; on failure, returns a positive errno
1124 * The caller owns the data in 'ofproto_port' and must free it with
1125 * ofproto_port_destroy() when it is no longer needed. */
1127 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1128 struct ofproto_port *port)
1132 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1134 memset(port, 0, sizeof *port);
1139 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1140 * Returns 0 if successful, otherwise a positive errno. */
1142 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1144 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1145 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1148 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1149 if (!error && ofport) {
1150 /* 'name' is the netdev's name and update_port() is going to close the
1151 * netdev. Just in case update_port() refers to 'name' after it
1152 * destroys 'ofport', make a copy of it around the update_port()
1154 char *devname = xstrdup(name);
1155 update_port(ofproto, devname);
1161 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1162 * performs the 'n_actions' actions in 'actions'. The new flow will not
1165 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1166 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1167 * controllers; otherwise, it will be hidden.
1169 * The caller retains ownership of 'cls_rule' and 'actions'.
1171 * This is a helper function for in-band control and fail-open. */
1173 ofproto_add_flow(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1174 const union ofp_action *actions, size_t n_actions)
1176 const struct rule *rule;
1178 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1179 &ofproto->tables[0], cls_rule));
1180 if (!rule || !ofputil_actions_equal(rule->actions, rule->n_actions,
1181 actions, n_actions)) {
1182 struct ofputil_flow_mod fm;
1184 memset(&fm, 0, sizeof fm);
1186 fm.buffer_id = UINT32_MAX;
1187 fm.actions = (union ofp_action *) actions;
1188 fm.n_actions = n_actions;
1189 add_flow(ofproto, NULL, &fm, NULL);
1193 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1194 * OpenFlow error code as encoded by ofp_mkerr() on failure, or
1195 * OFPROTO_POSTPONE if the operation cannot be initiated now but may be retried
1198 * This is a helper function for in-band control and fail-open. */
1200 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1202 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1205 /* Searches for a rule with matching criteria exactly equal to 'target' in
1206 * ofproto's table 0 and, if it finds one, deletes it.
1208 * This is a helper function for in-band control and fail-open. */
1210 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1214 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1215 &ofproto->tables[0], target));
1217 /* No such rule -> success. */
1219 } else if (rule->pending) {
1220 /* An operation on the rule is already pending -> failure.
1221 * Caller must retry later if it's important. */
1224 /* Initiate deletion -> success. */
1225 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1226 ofoperation_create(group, rule, OFOPERATION_DELETE);
1227 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
1228 rule->ofproto->ofproto_class->rule_destruct(rule);
1229 ofopgroup_submit(group);
1235 /* Starts the process of deleting all of the flows from all of ofproto's flow
1236 * tables and then reintroducing the flows required by in-band control and
1237 * fail-open. The process will complete in a later call to ofproto_run(). */
1239 ofproto_flush_flows(struct ofproto *ofproto)
1241 COVERAGE_INC(ofproto_flush);
1242 ofproto->state = S_FLUSH;
1246 reinit_ports(struct ofproto *p)
1248 struct ofproto_port_dump dump;
1249 struct sset devnames;
1250 struct ofport *ofport;
1251 struct ofproto_port ofproto_port;
1252 const char *devname;
1254 COVERAGE_INC(ofproto_reinit_ports);
1256 sset_init(&devnames);
1257 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1258 sset_add(&devnames, netdev_get_name(ofport->netdev));
1260 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1261 sset_add(&devnames, ofproto_port.name);
1264 SSET_FOR_EACH (devname, &devnames) {
1265 update_port(p, devname);
1267 sset_destroy(&devnames);
1270 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
1271 * netdev cannot be opened. On success, also fills in 'opp'. */
1272 static struct netdev *
1273 ofport_open(const struct ofproto_port *ofproto_port, struct ofp_phy_port *opp)
1275 uint32_t curr, advertised, supported, peer;
1276 enum netdev_flags flags;
1277 struct netdev *netdev;
1280 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1282 VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1283 "cannot be opened (%s)",
1284 ofproto_port->name, ofproto_port->ofp_port,
1285 ofproto_port->name, strerror(error));
1289 netdev_get_flags(netdev, &flags);
1290 netdev_get_features(netdev, &curr, &advertised, &supported, &peer);
1292 opp->port_no = htons(ofproto_port->ofp_port);
1293 netdev_get_etheraddr(netdev, opp->hw_addr);
1294 ovs_strzcpy(opp->name, ofproto_port->name, sizeof opp->name);
1295 opp->config = flags & NETDEV_UP ? 0 : htonl(OFPPC_PORT_DOWN);
1296 opp->state = netdev_get_carrier(netdev) ? 0 : htonl(OFPPS_LINK_DOWN);
1297 opp->curr = htonl(curr);
1298 opp->advertised = htonl(advertised);
1299 opp->supported = htonl(supported);
1300 opp->peer = htonl(peer);
1305 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1306 * port number, and 'config' bits other than OFPPC_PORT_DOWN are
1309 ofport_equal(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
1311 BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1312 return (!memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1313 && a->state == b->state
1314 && !((a->config ^ b->config) & htonl(OFPPC_PORT_DOWN))
1315 && a->curr == b->curr
1316 && a->advertised == b->advertised
1317 && a->supported == b->supported
1318 && a->peer == b->peer);
1321 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1322 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1323 * one with the same name or port number). */
1325 ofport_install(struct ofproto *p,
1326 struct netdev *netdev, const struct ofp_phy_port *opp)
1328 const char *netdev_name = netdev_get_name(netdev);
1329 struct ofport *ofport;
1333 /* Create ofport. */
1334 ofport = p->ofproto_class->port_alloc();
1339 ofport->ofproto = p;
1340 ofport->netdev = netdev;
1341 ofport->change_seq = netdev_change_seq(netdev);
1343 ofport->ofp_port = ntohs(opp->port_no);
1345 /* Add port to 'p'. */
1346 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1347 shash_add(&p->port_by_name, netdev_name, ofport);
1349 if (!netdev_get_mtu(netdev, &dev_mtu)) {
1350 set_internal_devs_mtu(p);
1351 ofport->mtu = dev_mtu;
1356 /* Let the ofproto_class initialize its private data. */
1357 error = p->ofproto_class->port_construct(ofport);
1361 connmgr_send_port_status(p->connmgr, opp, OFPPR_ADD);
1365 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1366 p->name, netdev_name, strerror(error));
1368 ofport_destroy__(ofport);
1370 netdev_close(netdev);
1374 /* Removes 'ofport' from 'p' and destroys it. */
1376 ofport_remove(struct ofport *ofport)
1378 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->opp,
1380 ofport_destroy(ofport);
1383 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1386 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1388 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1390 ofport_remove(port);
1394 /* Updates 'port' with new 'opp' description.
1396 * Does not handle a name or port number change. The caller must implement
1397 * such a change as a delete followed by an add. */
1399 ofport_modified(struct ofport *port, struct ofp_phy_port *opp)
1401 memcpy(port->opp.hw_addr, opp->hw_addr, ETH_ADDR_LEN);
1402 port->opp.config = ((port->opp.config & ~htonl(OFPPC_PORT_DOWN))
1403 | (opp->config & htonl(OFPPC_PORT_DOWN)));
1404 port->opp.state = opp->state;
1405 port->opp.curr = opp->curr;
1406 port->opp.advertised = opp->advertised;
1407 port->opp.supported = opp->supported;
1408 port->opp.peer = opp->peer;
1410 connmgr_send_port_status(port->ofproto->connmgr, &port->opp, OFPPR_MODIFY);
1413 /* Update OpenFlow 'state' in 'port' and notify controller. */
1415 ofproto_port_set_state(struct ofport *port, ovs_be32 state)
1417 if (port->opp.state != state) {
1418 port->opp.state = state;
1419 connmgr_send_port_status(port->ofproto->connmgr, &port->opp,
1425 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1427 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1429 if (port->ofproto->ofproto_class->set_realdev) {
1430 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1432 if (port->ofproto->ofproto_class->set_stp_port) {
1433 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1435 if (port->ofproto->ofproto_class->set_cfm) {
1436 port->ofproto->ofproto_class->set_cfm(port, NULL);
1438 if (port->ofproto->ofproto_class->bundle_remove) {
1439 port->ofproto->ofproto_class->bundle_remove(port);
1445 ofport_destroy__(struct ofport *port)
1447 struct ofproto *ofproto = port->ofproto;
1448 const char *name = netdev_get_name(port->netdev);
1450 hmap_remove(&ofproto->ports, &port->hmap_node);
1451 shash_delete(&ofproto->port_by_name,
1452 shash_find(&ofproto->port_by_name, name));
1454 netdev_close(port->netdev);
1455 ofproto->ofproto_class->port_dealloc(port);
1459 ofport_destroy(struct ofport *port)
1462 port->ofproto->ofproto_class->port_destruct(port);
1463 ofport_destroy__(port);
1468 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1470 struct ofport *port;
1472 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1473 hash_int(ofp_port, 0), &ofproto->ports) {
1474 if (port->ofp_port == ofp_port) {
1482 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1484 struct ofproto *ofproto = port->ofproto;
1487 if (ofproto->ofproto_class->port_get_stats) {
1488 error = ofproto->ofproto_class->port_get_stats(port, stats);
1497 update_port(struct ofproto *ofproto, const char *name)
1499 struct ofproto_port ofproto_port;
1500 struct ofp_phy_port opp;
1501 struct netdev *netdev;
1502 struct ofport *port;
1504 COVERAGE_INC(ofproto_update_port);
1506 /* Fetch 'name''s location and properties from the datapath. */
1507 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1508 ? ofport_open(&ofproto_port, &opp)
1511 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1512 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1513 struct netdev *old_netdev = port->netdev;
1516 /* 'name' hasn't changed location. Any properties changed? */
1517 if (!ofport_equal(&port->opp, &opp)) {
1518 ofport_modified(port, &opp);
1521 /* If this is a non-internal port and the MTU changed, check
1522 * if the datapath's MTU needs to be updated. */
1523 if (strcmp(netdev_get_type(netdev), "internal")
1524 && !netdev_get_mtu(netdev, &dev_mtu)
1525 && port->mtu != dev_mtu) {
1526 set_internal_devs_mtu(ofproto);
1527 port->mtu = dev_mtu;
1530 /* Install the newly opened netdev in case it has changed.
1531 * Don't close the old netdev yet in case port_modified has to
1532 * remove a retained reference to it.*/
1533 port->netdev = netdev;
1534 port->change_seq = netdev_change_seq(netdev);
1536 if (port->ofproto->ofproto_class->port_modified) {
1537 port->ofproto->ofproto_class->port_modified(port);
1540 netdev_close(old_netdev);
1542 /* If 'port' is nonnull then its name differs from 'name' and thus
1543 * we should delete it. If we think there's a port named 'name'
1544 * then its port number must be wrong now so delete it too. */
1546 ofport_remove(port);
1548 ofport_remove_with_name(ofproto, name);
1549 ofport_install(ofproto, netdev, &opp);
1552 /* Any port named 'name' is gone now. */
1553 ofport_remove_with_name(ofproto, name);
1555 ofproto_port_destroy(&ofproto_port);
1559 init_ports(struct ofproto *p)
1561 struct ofproto_port_dump dump;
1562 struct ofproto_port ofproto_port;
1564 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1565 uint16_t ofp_port = ofproto_port.ofp_port;
1566 if (ofproto_get_port(p, ofp_port)) {
1567 VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1569 } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1570 VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1573 struct ofp_phy_port opp;
1574 struct netdev *netdev;
1576 netdev = ofport_open(&ofproto_port, &opp);
1578 ofport_install(p, netdev, &opp);
1586 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1587 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1589 find_min_mtu(struct ofproto *p)
1591 struct ofport *ofport;
1594 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1595 struct netdev *netdev = ofport->netdev;
1598 /* Skip any internal ports, since that's what we're trying to
1600 if (!strcmp(netdev_get_type(netdev), "internal")) {
1604 if (netdev_get_mtu(netdev, &dev_mtu)) {
1607 if (!mtu || dev_mtu < mtu) {
1612 return mtu ? mtu: ETH_PAYLOAD_MAX;
1615 /* Set the MTU of all datapath devices on 'p' to the minimum of the
1616 * non-datapath ports. */
1618 set_internal_devs_mtu(struct ofproto *p)
1620 struct ofport *ofport;
1621 int mtu = find_min_mtu(p);
1623 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1624 struct netdev *netdev = ofport->netdev;
1626 if (!strcmp(netdev_get_type(netdev), "internal")) {
1627 netdev_set_mtu(netdev, mtu);
1633 ofproto_rule_destroy__(struct rule *rule)
1635 free(rule->actions);
1636 rule->ofproto->ofproto_class->rule_dealloc(rule);
1639 /* This function allows an ofproto implementation to destroy any rules that
1640 * remain when its ->destruct() function is called. The caller must have
1641 * already uninitialized any derived members of 'rule' (step 5 described in the
1642 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1643 * This function implements steps 6 and 7.
1645 * This function should only be called from an ofproto implementation's
1646 * ->destruct() function. It is not suitable elsewhere. */
1648 ofproto_rule_destroy(struct rule *rule)
1650 assert(!rule->pending);
1651 classifier_remove(&rule->ofproto->tables[rule->table_id], &rule->cr);
1652 ofproto_rule_destroy__(rule);
1655 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1656 * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1659 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1661 const union ofp_action *oa;
1664 if (out_port == OFPP_NONE) {
1667 OFPUTIL_ACTION_FOR_EACH_UNSAFE (oa, left, rule->actions, rule->n_actions) {
1668 if (action_outputs_to_port(oa, htons(out_port))) {
1675 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1676 * statistics appropriately. 'packet' must have at least sizeof(struct
1677 * ofp_packet_in) bytes of headroom.
1679 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1680 * with statistics for 'packet' either way.
1682 * Takes ownership of 'packet'. */
1684 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1688 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1690 flow_extract(packet, 0, 0, in_port, &flow);
1691 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1694 /* Returns true if 'rule' should be hidden from the controller.
1696 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1697 * (e.g. by in-band control) and are intentionally hidden from the
1700 rule_is_hidden(const struct rule *rule)
1702 return rule->cr.priority > UINT16_MAX;
1706 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1708 ofconn_send_reply(ofconn, make_echo_reply(oh));
1713 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1715 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1716 struct ofp_switch_features *osf;
1718 struct ofport *port;
1722 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip, &actions);
1723 assert(actions & (1 << OFPAT_OUTPUT)); /* sanity check */
1725 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1726 osf->datapath_id = htonll(ofproto->datapath_id);
1727 osf->n_buffers = htonl(pktbuf_capacity());
1728 osf->n_tables = ofproto->n_tables;
1729 osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1730 OFPC_PORT_STATS | OFPC_QUEUE_STATS);
1732 osf->capabilities |= htonl(OFPC_ARP_MATCH_IP);
1734 osf->actions = htonl(actions);
1736 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1737 ofpbuf_put(buf, &port->opp, sizeof port->opp);
1740 ofconn_send_reply(ofconn, buf);
1745 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1747 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1748 struct ofp_switch_config *osc;
1752 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1753 osc->flags = htons(ofproto->frag_handling);
1754 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1755 ofconn_send_reply(ofconn, buf);
1761 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1763 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1764 uint16_t flags = ntohs(osc->flags);
1766 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
1767 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1768 enum ofp_config_flags cur = ofproto->frag_handling;
1769 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
1771 assert((cur & OFPC_FRAG_MASK) == cur);
1773 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
1774 ofproto->frag_handling = next;
1776 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
1778 ofputil_frag_handling_to_string(next));
1783 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1788 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1789 * error message code (composed with ofp_mkerr()) for the caller to propagate
1790 * upward. Otherwise, returns 0. */
1792 reject_slave_controller(const struct ofconn *ofconn)
1794 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1795 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1796 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
1803 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1805 struct ofproto *p = ofconn_get_ofproto(ofconn);
1806 struct ofp_packet_out *opo;
1807 struct ofpbuf payload, *buffer;
1808 union ofp_action *ofp_actions;
1809 struct ofpbuf request;
1811 size_t n_ofp_actions;
1815 COVERAGE_INC(ofproto_packet_out);
1817 error = reject_slave_controller(ofconn);
1822 /* Get ofp_packet_out. */
1823 ofpbuf_use_const(&request, oh, ntohs(oh->length));
1824 opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1827 error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1828 &ofp_actions, &n_ofp_actions);
1834 if (opo->buffer_id != htonl(UINT32_MAX)) {
1835 error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1837 if (error || !buffer) {
1846 /* Get in_port and partially validate it.
1848 * We don't know what range of ports the ofproto actually implements, but
1849 * we do know that only certain reserved ports (numbered OFPP_MAX and
1850 * above) are valid. */
1851 in_port = ntohs(opo->in_port);
1852 if (in_port >= OFPP_MAX && in_port != OFPP_LOCAL && in_port != OFPP_NONE) {
1853 return ofp_mkerr_nicira(OFPET_BAD_REQUEST, NXBRC_BAD_IN_PORT);
1856 /* Send out packet. */
1857 flow_extract(&payload, 0, 0, in_port, &flow);
1858 error = p->ofproto_class->packet_out(p, &payload, &flow,
1859 ofp_actions, n_ofp_actions);
1860 ofpbuf_delete(buffer);
1866 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1868 ovs_be32 old_config = port->opp.config;
1870 mask &= config ^ port->opp.config;
1871 if (mask & htonl(OFPPC_PORT_DOWN)) {
1872 if (config & htonl(OFPPC_PORT_DOWN)) {
1873 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1875 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1879 port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1880 OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1881 OFPPC_NO_PACKET_IN));
1882 if (port->opp.config != old_config) {
1883 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1888 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1890 struct ofproto *p = ofconn_get_ofproto(ofconn);
1891 const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1892 struct ofport *port;
1895 error = reject_slave_controller(ofconn);
1900 port = ofproto_get_port(p, ntohs(opm->port_no));
1902 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
1903 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1904 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
1906 update_port_config(port, opm->config, opm->mask);
1907 if (opm->advertise) {
1908 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1915 handle_desc_stats_request(struct ofconn *ofconn,
1916 const struct ofp_stats_msg *request)
1918 struct ofproto *p = ofconn_get_ofproto(ofconn);
1919 struct ofp_desc_stats *ods;
1922 ods = ofputil_make_stats_reply(sizeof *ods, request, &msg);
1923 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1924 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1925 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1926 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1927 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1928 ofconn_send_reply(ofconn, msg);
1934 handle_table_stats_request(struct ofconn *ofconn,
1935 const struct ofp_stats_msg *request)
1937 struct ofproto *p = ofconn_get_ofproto(ofconn);
1938 struct ofp_table_stats *ots;
1942 ofputil_make_stats_reply(sizeof(struct ofp_stats_msg), request, &msg);
1944 ots = ofpbuf_put_zeros(msg, sizeof *ots * p->n_tables);
1945 for (i = 0; i < p->n_tables; i++) {
1946 ots[i].table_id = i;
1947 sprintf(ots[i].name, "table%zu", i);
1948 ots[i].wildcards = htonl(OFPFW_ALL);
1949 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
1950 ots[i].active_count = htonl(classifier_count(&p->tables[i]));
1953 p->ofproto_class->get_tables(p, ots);
1955 ofconn_send_reply(ofconn, msg);
1960 append_port_stat(struct ofport *port, struct list *replies)
1962 struct netdev_stats stats;
1963 struct ofp_port_stats *ops;
1965 /* Intentionally ignore return value, since errors will set
1966 * 'stats' to all-1s, which is correct for OpenFlow, and
1967 * netdev_get_stats() will log errors. */
1968 ofproto_port_get_stats(port, &stats);
1970 ops = ofputil_append_stats_reply(sizeof *ops, replies);
1971 ops->port_no = port->opp.port_no;
1972 memset(ops->pad, 0, sizeof ops->pad);
1973 put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
1974 put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
1975 put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
1976 put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
1977 put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
1978 put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
1979 put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
1980 put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
1981 put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
1982 put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
1983 put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
1984 put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
1988 handle_port_stats_request(struct ofconn *ofconn,
1989 const struct ofp_port_stats_request *psr)
1991 struct ofproto *p = ofconn_get_ofproto(ofconn);
1992 struct ofport *port;
1993 struct list replies;
1995 ofputil_start_stats_reply(&psr->osm, &replies);
1996 if (psr->port_no != htons(OFPP_NONE)) {
1997 port = ofproto_get_port(p, ntohs(psr->port_no));
1999 append_port_stat(port, &replies);
2002 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2003 append_port_stat(port, &replies);
2007 ofconn_send_replies(ofconn, &replies);
2012 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
2014 long long int msecs = time_msec() - start;
2015 *sec = msecs / 1000;
2016 *nsec = (msecs % 1000) * (1000 * 1000);
2019 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2020 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2022 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2024 return (table_id == 0xff || table_id < ofproto->n_tables
2026 : ofp_mkerr_nicira(OFPET_BAD_REQUEST, NXBRC_BAD_TABLE_ID));
2030 static struct classifier *
2031 first_matching_table(struct ofproto *ofproto, uint8_t table_id)
2033 if (table_id == 0xff) {
2034 return &ofproto->tables[0];
2035 } else if (table_id < ofproto->n_tables) {
2036 return &ofproto->tables[table_id];
2042 static struct classifier *
2043 next_matching_table(struct ofproto *ofproto,
2044 struct classifier *cls, uint8_t table_id)
2046 return (table_id == 0xff && cls != &ofproto->tables[ofproto->n_tables - 1]
2051 /* Assigns CLS to each classifier table, in turn, that matches TABLE_ID in
2054 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2057 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2058 * only once, for that table.
2060 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2061 * entered at all. (Perhaps you should have validated TABLE_ID with
2062 * check_table_id().)
2064 * All parameters are evaluated multiple times.
2066 #define FOR_EACH_MATCHING_TABLE(CLS, TABLE_ID, OFPROTO) \
2067 for ((CLS) = first_matching_table(OFPROTO, TABLE_ID); \
2069 (CLS) = next_matching_table(OFPROTO, CLS, TABLE_ID))
2071 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2072 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2073 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2076 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2077 * to 'out_port' are included.
2079 * Hidden rules are always omitted.
2081 * Returns 0 on success, otherwise an OpenFlow error code. */
2083 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2084 const struct cls_rule *match,
2085 ovs_be64 cookie, ovs_be64 cookie_mask,
2086 uint16_t out_port, struct list *rules)
2088 struct classifier *cls;
2091 error = check_table_id(ofproto, table_id);
2097 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
2098 struct cls_cursor cursor;
2101 cls_cursor_init(&cursor, cls, match);
2102 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2103 if (rule->pending) {
2104 return OFPROTO_POSTPONE;
2106 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2107 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2108 list_push_back(rules, &rule->ofproto_node);
2115 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2116 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2117 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2120 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2121 * to 'out_port' are included.
2123 * Hidden rules are always omitted.
2125 * Returns 0 on success, otherwise an OpenFlow error code. */
2127 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2128 const struct cls_rule *match,
2129 ovs_be64 cookie, ovs_be64 cookie_mask,
2130 uint16_t out_port, struct list *rules)
2132 struct classifier *cls;
2135 error = check_table_id(ofproto, table_id);
2141 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
2144 rule = rule_from_cls_rule(classifier_find_rule_exactly(cls, match));
2146 if (rule->pending) {
2147 return OFPROTO_POSTPONE;
2149 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2150 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2151 list_push_back(rules, &rule->ofproto_node);
2159 handle_flow_stats_request(struct ofconn *ofconn,
2160 const struct ofp_stats_msg *osm)
2162 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2163 struct ofputil_flow_stats_request fsr;
2164 struct list replies;
2169 error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
2174 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2175 fsr.cookie, fsr.cookie_mask,
2176 fsr.out_port, &rules);
2181 ofputil_start_stats_reply(osm, &replies);
2182 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2183 struct ofputil_flow_stats fs;
2186 fs.cookie = rule->flow_cookie;
2187 fs.table_id = rule->table_id;
2188 calc_flow_duration__(rule->created, &fs.duration_sec,
2190 fs.idle_timeout = rule->idle_timeout;
2191 fs.hard_timeout = rule->hard_timeout;
2192 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2194 fs.actions = rule->actions;
2195 fs.n_actions = rule->n_actions;
2196 ofputil_append_flow_stats_reply(&fs, &replies);
2198 ofconn_send_replies(ofconn, &replies);
2204 flow_stats_ds(struct rule *rule, struct ds *results)
2206 uint64_t packet_count, byte_count;
2208 rule->ofproto->ofproto_class->rule_get_stats(rule,
2209 &packet_count, &byte_count);
2211 if (rule->table_id != 0) {
2212 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2214 ds_put_format(results, "duration=%llds, ",
2215 (time_msec() - rule->created) / 1000);
2216 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2217 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2218 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2219 cls_rule_format(&rule->cr, results);
2220 ds_put_char(results, ',');
2221 if (rule->n_actions > 0) {
2222 ofp_print_actions(results, rule->actions, rule->n_actions);
2224 ds_put_cstr(results, "drop");
2226 ds_put_cstr(results, "\n");
2229 /* Adds a pretty-printed description of all flows to 'results', including
2230 * hidden flows (e.g., set up by in-band control). */
2232 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2234 struct classifier *cls;
2236 OFPROTO_FOR_EACH_TABLE (cls, p) {
2237 struct cls_cursor cursor;
2240 cls_cursor_init(&cursor, cls, NULL);
2241 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2242 flow_stats_ds(rule, results);
2247 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2248 * '*engine_type' and '*engine_id', respectively. */
2250 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2251 uint8_t *engine_type, uint8_t *engine_id)
2253 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2256 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns 1
2257 * if CFM is faulted (generally indiciating a connectivity problem), 0 if CFM
2258 * is not faulted, and -1 if CFM is not enabled on 'ofp_port'. */
2260 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2262 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2263 return (ofport && ofproto->ofproto_class->get_cfm_fault
2264 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2268 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2269 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2270 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2271 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2273 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2274 uint16_t ofp_port, const uint64_t **rmps,
2277 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2281 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2282 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2288 handle_aggregate_stats_request(struct ofconn *ofconn,
2289 const struct ofp_stats_msg *osm)
2291 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2292 struct ofputil_flow_stats_request request;
2293 struct ofputil_aggregate_stats stats;
2294 bool unknown_packets, unknown_bytes;
2295 struct ofpbuf *reply;
2300 error = ofputil_decode_flow_stats_request(&request, &osm->header);
2305 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2306 request.cookie, request.cookie_mask,
2307 request.out_port, &rules);
2312 memset(&stats, 0, sizeof stats);
2313 unknown_packets = unknown_bytes = false;
2314 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2315 uint64_t packet_count;
2316 uint64_t byte_count;
2318 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2321 if (packet_count == UINT64_MAX) {
2322 unknown_packets = true;
2324 stats.packet_count += packet_count;
2327 if (byte_count == UINT64_MAX) {
2328 unknown_bytes = true;
2330 stats.byte_count += byte_count;
2335 if (unknown_packets) {
2336 stats.packet_count = UINT64_MAX;
2338 if (unknown_bytes) {
2339 stats.byte_count = UINT64_MAX;
2342 reply = ofputil_encode_aggregate_stats_reply(&stats, osm);
2343 ofconn_send_reply(ofconn, reply);
2348 struct queue_stats_cbdata {
2349 struct ofport *ofport;
2350 struct list replies;
2354 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2355 const struct netdev_queue_stats *stats)
2357 struct ofp_queue_stats *reply;
2359 reply = ofputil_append_stats_reply(sizeof *reply, &cbdata->replies);
2360 reply->port_no = cbdata->ofport->opp.port_no;
2361 memset(reply->pad, 0, sizeof reply->pad);
2362 reply->queue_id = htonl(queue_id);
2363 put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2364 put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2365 put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2369 handle_queue_stats_dump_cb(uint32_t queue_id,
2370 struct netdev_queue_stats *stats,
2373 struct queue_stats_cbdata *cbdata = cbdata_;
2375 put_queue_stats(cbdata, queue_id, stats);
2379 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2380 struct queue_stats_cbdata *cbdata)
2382 cbdata->ofport = port;
2383 if (queue_id == OFPQ_ALL) {
2384 netdev_dump_queue_stats(port->netdev,
2385 handle_queue_stats_dump_cb, cbdata);
2387 struct netdev_queue_stats stats;
2389 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2390 put_queue_stats(cbdata, queue_id, &stats);
2396 handle_queue_stats_request(struct ofconn *ofconn,
2397 const struct ofp_queue_stats_request *qsr)
2399 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2400 struct queue_stats_cbdata cbdata;
2401 struct ofport *port;
2402 unsigned int port_no;
2405 COVERAGE_INC(ofproto_queue_req);
2407 ofputil_start_stats_reply(&qsr->osm, &cbdata.replies);
2409 port_no = ntohs(qsr->port_no);
2410 queue_id = ntohl(qsr->queue_id);
2411 if (port_no == OFPP_ALL) {
2412 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2413 handle_queue_stats_for_port(port, queue_id, &cbdata);
2415 } else if (port_no < OFPP_MAX) {
2416 port = ofproto_get_port(ofproto, port_no);
2418 handle_queue_stats_for_port(port, queue_id, &cbdata);
2421 ofpbuf_list_delete(&cbdata.replies);
2422 return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
2424 ofconn_send_replies(ofconn, &cbdata.replies);
2430 is_flow_deletion_pending(const struct ofproto *ofproto,
2431 const struct cls_rule *cls_rule,
2434 if (!hmap_is_empty(&ofproto->deletions)) {
2435 struct ofoperation *op;
2437 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2438 cls_rule_hash(cls_rule, table_id),
2439 &ofproto->deletions) {
2440 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2449 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2450 * in which no matching flow already exists in the flow table.
2452 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2453 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
2454 * error code as encoded by ofp_mkerr() on failure, or OFPROTO_POSTPONE if the
2455 * operation cannot be initiated now but may be retried later.
2457 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2460 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
2461 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
2463 struct classifier *table;
2464 struct ofopgroup *group;
2465 struct rule *victim;
2469 error = check_table_id(ofproto, fm->table_id);
2475 if (fm->table_id == 0xff) {
2477 if (ofproto->ofproto_class->rule_choose_table) {
2478 error = ofproto->ofproto_class->rule_choose_table(ofproto, &fm->cr,
2483 assert(table_id < ofproto->n_tables);
2484 table = &ofproto->tables[table_id];
2486 table = &ofproto->tables[0];
2488 } else if (fm->table_id < ofproto->n_tables) {
2489 table = &ofproto->tables[fm->table_id];
2491 return ofp_mkerr_nicira(OFPET_FLOW_MOD_FAILED, NXFMFC_BAD_TABLE_ID);
2494 /* Check for overlap, if requested. */
2495 if (fm->flags & OFPFF_CHECK_OVERLAP
2496 && classifier_rule_overlaps(table, &fm->cr)) {
2497 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
2500 /* Serialize against pending deletion. */
2501 if (is_flow_deletion_pending(ofproto, &fm->cr, table - ofproto->tables)) {
2502 return OFPROTO_POSTPONE;
2505 /* Allocate new rule. */
2506 rule = ofproto->ofproto_class->rule_alloc();
2508 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2509 ofproto->name, strerror(error));
2512 rule->ofproto = ofproto;
2514 rule->pending = NULL;
2515 rule->flow_cookie = fm->cookie;
2516 rule->created = rule->modified = time_msec();
2517 rule->idle_timeout = fm->idle_timeout;
2518 rule->hard_timeout = fm->hard_timeout;
2519 rule->table_id = table - ofproto->tables;
2520 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2521 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2522 rule->n_actions = fm->n_actions;
2524 /* Insert new rule. */
2525 victim = rule_from_cls_rule(classifier_replace(table, &rule->cr));
2526 if (victim && victim->pending) {
2527 error = OFPROTO_POSTPONE;
2529 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2530 ofoperation_create(group, rule, OFOPERATION_ADD);
2531 rule->pending->victim = victim;
2533 error = ofproto->ofproto_class->rule_construct(rule);
2535 ofoperation_destroy(rule->pending);
2537 ofopgroup_submit(group);
2540 /* Back out if an error occurred. */
2543 classifier_replace(table, &victim->cr);
2545 classifier_remove(table, &rule->cr);
2547 ofproto_rule_destroy__(rule);
2552 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2554 /* Modifies the rules listed in 'rules', changing their actions to match those
2557 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2560 * Returns 0 on success, otherwise an OpenFlow error code. */
2562 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2563 const struct ofputil_flow_mod *fm,
2564 const struct ofp_header *request, struct list *rules)
2566 struct ofopgroup *group;
2569 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2570 LIST_FOR_EACH (rule, ofproto_node, rules) {
2571 if (!ofputil_actions_equal(fm->actions, fm->n_actions,
2572 rule->actions, rule->n_actions)) {
2573 ofoperation_create(group, rule, OFOPERATION_MODIFY);
2574 rule->pending->actions = rule->actions;
2575 rule->pending->n_actions = rule->n_actions;
2576 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2577 rule->n_actions = fm->n_actions;
2578 rule->ofproto->ofproto_class->rule_modify_actions(rule);
2580 rule->modified = time_msec();
2582 rule->flow_cookie = fm->cookie;
2584 ofopgroup_submit(group);
2589 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code as
2590 * encoded by ofp_mkerr() on failure.
2592 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2595 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2596 const struct ofputil_flow_mod *fm,
2597 const struct ofp_header *request)
2602 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2603 fm->cookie, fm->cookie_mask,
2605 return (error ? error
2606 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2607 : modify_flows__(ofproto, ofconn, fm, request, &rules));
2610 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2611 * code as encoded by ofp_mkerr() on failure.
2613 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2616 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2617 const struct ofputil_flow_mod *fm,
2618 const struct ofp_header *request)
2623 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2624 fm->cookie, fm->cookie_mask,
2626 return (error ? error
2627 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2628 : list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
2629 fm, request, &rules)
2633 /* OFPFC_DELETE implementation. */
2635 /* Deletes the rules listed in 'rules'.
2637 * Returns 0 on success, otherwise an OpenFlow error code. */
2639 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2640 const struct ofp_header *request, struct list *rules)
2642 struct rule *rule, *next;
2643 struct ofopgroup *group;
2645 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
2646 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
2647 ofproto_rule_send_removed(rule, OFPRR_DELETE);
2649 ofoperation_create(group, rule, OFOPERATION_DELETE);
2650 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2651 rule->ofproto->ofproto_class->rule_destruct(rule);
2653 ofopgroup_submit(group);
2658 /* Implements OFPFC_DELETE. */
2660 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2661 const struct ofputil_flow_mod *fm,
2662 const struct ofp_header *request)
2667 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2668 fm->cookie, fm->cookie_mask,
2669 fm->out_port, &rules);
2670 return (error ? error
2671 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
2676 /* Implements OFPFC_DELETE_STRICT. */
2678 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2679 const struct ofputil_flow_mod *fm,
2680 const struct ofp_header *request)
2685 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2686 fm->cookie, fm->cookie_mask,
2687 fm->out_port, &rules);
2688 return (error ? error
2689 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
2695 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2697 struct ofputil_flow_removed fr;
2699 if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2704 fr.cookie = rule->flow_cookie;
2706 calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2707 fr.idle_timeout = rule->idle_timeout;
2708 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2711 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2714 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2715 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2718 * ofproto implementation ->run() functions should use this function to expire
2719 * OpenFlow flows. */
2721 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2723 struct ofproto *ofproto = rule->ofproto;
2724 struct ofopgroup *group;
2726 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2728 ofproto_rule_send_removed(rule, reason);
2730 group = ofopgroup_create_unattached(ofproto);
2731 ofoperation_create(group, rule, OFOPERATION_DELETE);
2732 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2733 rule->ofproto->ofproto_class->rule_destruct(rule);
2734 ofopgroup_submit(group);
2738 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2740 struct ofputil_flow_mod fm;
2743 error = reject_slave_controller(ofconn);
2748 error = ofputil_decode_flow_mod(&fm, oh,
2749 ofconn_get_flow_mod_table_id(ofconn));
2754 /* We do not support the emergency flow cache. It will hopefully get
2755 * dropped from OpenFlow in the near future. */
2756 if (fm.flags & OFPFF_EMERG) {
2757 /* There isn't a good fit for an error code, so just state that the
2758 * flow table is full. */
2759 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
2762 return handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
2766 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
2767 const struct ofputil_flow_mod *fm,
2768 const struct ofp_header *oh)
2770 if (ofproto->n_pending >= 50) {
2771 assert(!list_is_empty(&ofproto->pending));
2772 return OFPROTO_POSTPONE;
2775 switch (fm->command) {
2777 return add_flow(ofproto, ofconn, fm, oh);
2780 return modify_flows_loose(ofproto, ofconn, fm, oh);
2782 case OFPFC_MODIFY_STRICT:
2783 return modify_flow_strict(ofproto, ofconn, fm, oh);
2786 return delete_flows_loose(ofproto, ofconn, fm, oh);
2788 case OFPFC_DELETE_STRICT:
2789 return delete_flow_strict(ofproto, ofconn, fm, oh);
2792 if (fm->command > 0xff) {
2793 VLOG_WARN_RL(&rl, "flow_mod has explicit table_id but "
2794 "flow_mod_table_id extension is not enabled");
2796 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2801 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2803 struct nx_role_request *nrr = (struct nx_role_request *) oh;
2804 struct nx_role_request *reply;
2808 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2809 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2812 role = ntohl(nrr->role);
2813 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2814 && role != NX_ROLE_SLAVE) {
2815 return ofp_mkerr_nicira(OFPET_BAD_REQUEST, NXBRC_BAD_ROLE);
2818 if (ofconn_get_role(ofconn) != role
2819 && ofconn_has_pending_opgroups(ofconn)) {
2820 return OFPROTO_POSTPONE;
2823 ofconn_set_role(ofconn, role);
2825 reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2826 reply->role = htonl(role);
2827 ofconn_send_reply(ofconn, buf);
2833 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
2834 const struct ofp_header *oh)
2836 const struct nxt_flow_mod_table_id *msg
2837 = (const struct nxt_flow_mod_table_id *) oh;
2839 ofconn_set_flow_mod_table_id(ofconn, msg->set != 0);
2844 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2846 const struct nxt_set_flow_format *msg
2847 = (const struct nxt_set_flow_format *) oh;
2850 format = ntohl(msg->format);
2851 if (format != NXFF_OPENFLOW10 && format != NXFF_NXM) {
2852 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2855 if (format != ofconn_get_flow_format(ofconn)
2856 && ofconn_has_pending_opgroups(ofconn)) {
2857 /* Avoid sending async messages in surprising flow format. */
2858 return OFPROTO_POSTPONE;
2861 ofconn_set_flow_format(ofconn, format);
2866 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
2867 const struct ofp_header *oh)
2869 const struct nxt_set_packet_in_format *msg;
2872 msg = (const struct nxt_set_packet_in_format *) oh;
2873 format = ntohl(msg->format);
2874 if (format != NXFF_OPENFLOW10 && format != NXPIF_NXM) {
2875 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2878 if (format != ofconn_get_packet_in_format(ofconn)
2879 && ofconn_has_pending_opgroups(ofconn)) {
2880 /* Avoid sending async message in surprsing packet in format. */
2881 return OFPROTO_POSTPONE;
2884 ofconn_set_packet_in_format(ofconn, format);
2889 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2891 struct ofp_header *ob;
2894 if (ofconn_has_pending_opgroups(ofconn)) {
2895 return OFPROTO_POSTPONE;
2898 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2899 ofconn_send_reply(ofconn, buf);
2904 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2906 const struct ofp_header *oh = msg->data;
2907 const struct ofputil_msg_type *type;
2910 error = ofputil_decode_msg_type(oh, &type);
2915 switch (ofputil_msg_type_code(type)) {
2916 /* OpenFlow requests. */
2917 case OFPUTIL_OFPT_ECHO_REQUEST:
2918 return handle_echo_request(ofconn, oh);
2920 case OFPUTIL_OFPT_FEATURES_REQUEST:
2921 return handle_features_request(ofconn, oh);
2923 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2924 return handle_get_config_request(ofconn, oh);
2926 case OFPUTIL_OFPT_SET_CONFIG:
2927 return handle_set_config(ofconn, msg->data);
2929 case OFPUTIL_OFPT_PACKET_OUT:
2930 return handle_packet_out(ofconn, oh);
2932 case OFPUTIL_OFPT_PORT_MOD:
2933 return handle_port_mod(ofconn, oh);
2935 case OFPUTIL_OFPT_FLOW_MOD:
2936 return handle_flow_mod(ofconn, oh);
2938 case OFPUTIL_OFPT_BARRIER_REQUEST:
2939 return handle_barrier_request(ofconn, oh);
2941 /* OpenFlow replies. */
2942 case OFPUTIL_OFPT_ECHO_REPLY:
2945 /* Nicira extension requests. */
2946 case OFPUTIL_NXT_ROLE_REQUEST:
2947 return handle_role_request(ofconn, oh);
2949 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
2950 return handle_nxt_flow_mod_table_id(ofconn, oh);
2952 case OFPUTIL_NXT_SET_FLOW_FORMAT:
2953 return handle_nxt_set_flow_format(ofconn, oh);
2955 case OFPUTIL_NXT_SET_PACKET_IN_FORMAT:
2956 return handle_nxt_set_packet_in_format(ofconn, oh);
2958 case OFPUTIL_NXT_FLOW_MOD:
2959 return handle_flow_mod(ofconn, oh);
2961 /* Statistics requests. */
2962 case OFPUTIL_OFPST_DESC_REQUEST:
2963 return handle_desc_stats_request(ofconn, msg->data);
2965 case OFPUTIL_OFPST_FLOW_REQUEST:
2966 case OFPUTIL_NXST_FLOW_REQUEST:
2967 return handle_flow_stats_request(ofconn, msg->data);
2969 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
2970 case OFPUTIL_NXST_AGGREGATE_REQUEST:
2971 return handle_aggregate_stats_request(ofconn, msg->data);
2973 case OFPUTIL_OFPST_TABLE_REQUEST:
2974 return handle_table_stats_request(ofconn, msg->data);
2976 case OFPUTIL_OFPST_PORT_REQUEST:
2977 return handle_port_stats_request(ofconn, msg->data);
2979 case OFPUTIL_OFPST_QUEUE_REQUEST:
2980 return handle_queue_stats_request(ofconn, msg->data);
2982 case OFPUTIL_MSG_INVALID:
2983 case OFPUTIL_OFPT_HELLO:
2984 case OFPUTIL_OFPT_ERROR:
2985 case OFPUTIL_OFPT_FEATURES_REPLY:
2986 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
2987 case OFPUTIL_OFPT_PACKET_IN:
2988 case OFPUTIL_OFPT_FLOW_REMOVED:
2989 case OFPUTIL_OFPT_PORT_STATUS:
2990 case OFPUTIL_OFPT_BARRIER_REPLY:
2991 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
2992 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
2993 case OFPUTIL_OFPST_DESC_REPLY:
2994 case OFPUTIL_OFPST_FLOW_REPLY:
2995 case OFPUTIL_OFPST_QUEUE_REPLY:
2996 case OFPUTIL_OFPST_PORT_REPLY:
2997 case OFPUTIL_OFPST_TABLE_REPLY:
2998 case OFPUTIL_OFPST_AGGREGATE_REPLY:
2999 case OFPUTIL_NXT_ROLE_REPLY:
3000 case OFPUTIL_NXT_FLOW_REMOVED:
3001 case OFPUTIL_NXT_PACKET_IN:
3002 case OFPUTIL_NXST_FLOW_REPLY:
3003 case OFPUTIL_NXST_AGGREGATE_REPLY:
3005 if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
3006 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
3008 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
3014 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
3016 int error = handle_openflow__(ofconn, ofp_msg);
3017 if (error && error != OFPROTO_POSTPONE) {
3018 ofconn_send_error(ofconn, ofp_msg->data, error);
3020 COVERAGE_INC(ofproto_recv_openflow);
3021 return error != OFPROTO_POSTPONE;
3024 /* Asynchronous operations. */
3026 /* Creates and returns a new ofopgroup that is not associated with any
3027 * OpenFlow connection.
3029 * The caller should add operations to the returned group with
3030 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3031 static struct ofopgroup *
3032 ofopgroup_create_unattached(struct ofproto *ofproto)
3034 struct ofopgroup *group = xzalloc(sizeof *group);
3035 group->ofproto = ofproto;
3036 list_init(&group->ofproto_node);
3037 list_init(&group->ops);
3038 list_init(&group->ofconn_node);
3042 /* Creates and returns a new ofopgroup for 'ofproto'.
3044 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
3045 * connection. The 'request' and 'buffer_id' arguments are ignored.
3047 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
3048 * If the ofopgroup eventually fails, then the error reply will include
3049 * 'request'. If the ofopgroup eventually succeeds, then the packet with
3050 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
3052 * The caller should add operations to the returned group with
3053 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3054 static struct ofopgroup *
3055 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
3056 const struct ofp_header *request, uint32_t buffer_id)
3058 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3060 size_t request_len = ntohs(request->length);
3062 assert(ofconn_get_ofproto(ofconn) == ofproto);
3064 ofconn_add_opgroup(ofconn, &group->ofconn_node);
3065 group->ofconn = ofconn;
3066 group->request = xmemdup(request, MIN(request_len, 64));
3067 group->buffer_id = buffer_id;
3072 /* Submits 'group' for processing.
3074 * If 'group' contains no operations (e.g. none were ever added, or all of the
3075 * ones that were added completed synchronously), then it is destroyed
3076 * immediately. Otherwise it is added to the ofproto's list of pending
3079 ofopgroup_submit(struct ofopgroup *group)
3081 if (list_is_empty(&group->ops)) {
3082 ofopgroup_destroy(group);
3084 list_push_back(&group->ofproto->pending, &group->ofproto_node);
3085 group->ofproto->n_pending++;
3090 ofopgroup_destroy(struct ofopgroup *group)
3092 assert(list_is_empty(&group->ops));
3093 if (!list_is_empty(&group->ofproto_node)) {
3094 assert(group->ofproto->n_pending > 0);
3095 group->ofproto->n_pending--;
3096 list_remove(&group->ofproto_node);
3098 if (!list_is_empty(&group->ofconn_node)) {
3099 list_remove(&group->ofconn_node);
3101 ofconn_send_error(group->ofconn, group->request, group->error);
3103 connmgr_retry(group->ofproto->connmgr);
3105 free(group->request);
3109 /* Initiates a new operation on 'rule', of the specified 'type', within
3110 * 'group'. Prior to calling, 'rule' must not have any pending operation. */
3112 ofoperation_create(struct ofopgroup *group, struct rule *rule,
3113 enum ofoperation_type type)
3115 struct ofoperation *op;
3117 assert(!rule->pending);
3119 op = rule->pending = xzalloc(sizeof *op);
3121 list_push_back(&group->ops, &op->group_node);
3125 op->flow_cookie = rule->flow_cookie;
3127 if (type == OFOPERATION_DELETE) {
3128 hmap_insert(&op->group->ofproto->deletions, &op->hmap_node,
3129 cls_rule_hash(&rule->cr, rule->table_id));
3134 ofoperation_destroy(struct ofoperation *op)
3136 struct ofopgroup *group = op->group;
3139 op->rule->pending = NULL;
3141 if (op->type == OFOPERATION_DELETE) {
3142 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
3144 list_remove(&op->group_node);
3148 if (list_is_empty(&group->ops) && !list_is_empty(&group->ofproto_node)) {
3149 ofopgroup_destroy(group);
3153 /* Indicates that 'op' completed with status 'error', which is either 0 to
3154 * indicate success or an OpenFlow error code (constructed with
3155 * e.g. ofp_mkerr()).
3157 * If 'error' is 0, indicating success, the operation will be committed
3158 * permanently to the flow table. There is one interesting subcase:
3160 * - If 'op' is an "add flow" operation that is replacing an existing rule in
3161 * the flow table (the "victim" rule) by a new one, then the caller must
3162 * have uninitialized any derived state in the victim rule, as in step 5 in
3163 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
3164 * performs steps 6 and 7 for the victim rule, most notably by calling its
3165 * ->rule_dealloc() function.
3167 * If 'error' is nonzero, then generally the operation will be rolled back:
3169 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
3170 * restores the original rule. The caller must have uninitialized any
3171 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
3172 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
3173 * and 7 for the new rule, calling its ->rule_dealloc() function.
3175 * - If 'op' is a "modify flow" operation, ofproto restores the original
3178 * - 'op' must not be a "delete flow" operation. Removing a rule is not
3179 * allowed to fail. It must always succeed.
3181 * Please see the large comment in ofproto/ofproto-provider.h titled
3182 * "Asynchronous Operation Support" for more information. */
3184 ofoperation_complete(struct ofoperation *op, int error)
3186 struct ofopgroup *group = op->group;
3187 struct rule *rule = op->rule;
3188 struct ofproto *ofproto = rule->ofproto;
3189 struct classifier *table = &ofproto->tables[rule->table_id];
3191 assert(rule->pending == op);
3192 assert(op->status < 0);
3197 && op->type != OFOPERATION_DELETE
3199 && group->buffer_id != UINT32_MAX
3200 && list_is_singleton(&op->group_node)) {
3201 struct ofpbuf *packet;
3204 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
3208 error = rule_execute(rule, in_port, packet);
3211 if (!group->error) {
3212 group->error = error;
3216 case OFOPERATION_ADD:
3219 ofproto_rule_destroy__(op->victim);
3221 if ((rule->cr.wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3222 == htons(VLAN_VID_MASK)) {
3223 if (ofproto->vlan_bitmap) {
3224 uint16_t vid = vlan_tci_to_vid(rule->cr.flow.vlan_tci);
3226 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
3227 bitmap_set1(ofproto->vlan_bitmap, vid);
3228 ofproto->vlans_changed = true;
3231 ofproto->vlans_changed = true;
3236 classifier_replace(table, &op->victim->cr);
3239 classifier_remove(table, &rule->cr);
3241 ofproto_rule_destroy__(rule);
3246 case OFOPERATION_DELETE:
3248 ofproto_rule_destroy__(rule);
3252 case OFOPERATION_MODIFY:
3254 rule->modified = time_msec();
3256 free(rule->actions);
3257 rule->actions = op->actions;
3258 rule->n_actions = op->n_actions;
3266 ofoperation_destroy(op);
3270 ofoperation_get_victim(struct ofoperation *op)
3272 assert(op->type == OFOPERATION_ADD);
3277 pick_datapath_id(const struct ofproto *ofproto)
3279 const struct ofport *port;
3281 port = ofproto_get_port(ofproto, OFPP_LOCAL);
3283 uint8_t ea[ETH_ADDR_LEN];
3286 error = netdev_get_etheraddr(port->netdev, ea);
3288 return eth_addr_to_uint64(ea);
3290 VLOG_WARN("could not get MAC address for %s (%s)",
3291 netdev_get_name(port->netdev), strerror(error));
3293 return ofproto->fallback_dpid;
3297 pick_fallback_dpid(void)
3299 uint8_t ea[ETH_ADDR_LEN];
3300 eth_addr_nicira_random(ea);
3301 return eth_addr_to_uint64(ea);
3304 /* unixctl commands. */
3307 ofproto_lookup(const char *name)
3309 struct ofproto *ofproto;
3311 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
3313 if (!strcmp(ofproto->name, name)) {
3321 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
3322 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
3324 struct ofproto *ofproto;
3328 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
3329 ds_put_format(&results, "%s\n", ofproto->name);
3331 unixctl_command_reply(conn, 200, ds_cstr(&results));
3332 ds_destroy(&results);
3336 ofproto_unixctl_init(void)
3338 static bool registered;
3344 unixctl_command_register("ofproto/list", "", 0, 0,
3345 ofproto_unixctl_list, NULL);
3348 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
3350 * This is deprecated. It is only for compatibility with broken device drivers
3351 * in old versions of Linux that do not properly support VLANs when VLAN
3352 * devices are not used. When broken device drivers are no longer in
3353 * widespread use, we will delete these interfaces. */
3355 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
3356 * (exactly) by an OpenFlow rule in 'ofproto'. */
3358 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
3360 const struct classifier *cls;
3362 free(ofproto->vlan_bitmap);
3363 ofproto->vlan_bitmap = bitmap_allocate(4096);
3364 ofproto->vlans_changed = false;
3366 OFPROTO_FOR_EACH_TABLE (cls, ofproto) {
3367 const struct cls_table *table;
3369 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
3370 if ((table->wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3371 == htons(VLAN_VID_MASK)) {
3372 const struct cls_rule *rule;
3374 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
3375 uint16_t vid = vlan_tci_to_vid(rule->flow.vlan_tci);
3376 bitmap_set1(vlan_bitmap, vid);
3377 bitmap_set1(ofproto->vlan_bitmap, vid);
3384 /* Returns true if new VLANs have come into use by the flow table since the
3385 * last call to ofproto_get_vlan_usage().
3387 * We don't track when old VLANs stop being used. */
3389 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
3391 return ofproto->vlans_changed;
3394 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
3395 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
3396 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
3397 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
3398 * then the VLAN device is un-enslaved. */
3400 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
3401 uint16_t realdev_ofp_port, int vid)
3403 struct ofport *ofport;
3406 assert(vlandev_ofp_port != realdev_ofp_port);
3408 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
3410 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
3411 ofproto->name, vlandev_ofp_port);
3415 if (!ofproto->ofproto_class->set_realdev) {
3416 if (!vlandev_ofp_port) {
3419 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
3423 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
3425 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
3426 ofproto->name, vlandev_ofp_port,
3427 netdev_get_name(ofport->netdev), strerror(error));