2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
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 * Mirrors affect only the treatment of packets output to the OFPP_NORMAL
732 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
733 const struct ofproto_mirror_settings *s)
735 return (ofproto->ofproto_class->mirror_set
736 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
740 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
741 * If no mirror has been registered, this has no effect. */
743 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
745 return ofproto_mirror_register(ofproto, aux, NULL);
748 /* Retrieves statistics from mirror associated with client data pointer
749 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
750 * 'bytes', respectively. If a particular counters is not supported,
751 * the appropriate argument is set to UINT64_MAX. */
753 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
754 uint64_t *packets, uint64_t *bytes)
756 if (!ofproto->ofproto_class->mirror_get_stats) {
757 *packets = *bytes = UINT64_MAX;
761 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
765 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
766 * which all packets are flooded, instead of using MAC learning. If
767 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
769 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
772 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
774 return (ofproto->ofproto_class->set_flood_vlans
775 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
779 /* Returns true if 'aux' is a registered bundle that is currently in use as the
780 * output for a mirror. */
782 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
784 return (ofproto->ofproto_class->is_mirror_output_bundle
785 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
790 ofproto_has_snoops(const struct ofproto *ofproto)
792 return connmgr_has_snoops(ofproto->connmgr);
796 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
798 connmgr_get_snoops(ofproto->connmgr, snoops);
802 ofproto_flush__(struct ofproto *ofproto)
804 struct classifier *table;
805 struct ofopgroup *group;
807 if (ofproto->ofproto_class->flush) {
808 ofproto->ofproto_class->flush(ofproto);
811 group = ofopgroup_create_unattached(ofproto);
812 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
813 struct rule *rule, *next_rule;
814 struct cls_cursor cursor;
816 cls_cursor_init(&cursor, table, NULL);
817 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
818 if (!rule->pending) {
819 ofoperation_create(group, rule, OFOPERATION_DELETE);
820 classifier_remove(table, &rule->cr);
821 ofproto->ofproto_class->rule_destruct(rule);
825 ofopgroup_submit(group);
829 ofproto_destroy__(struct ofproto *ofproto)
831 struct classifier *table;
833 assert(list_is_empty(&ofproto->pending));
834 assert(!ofproto->n_pending);
836 connmgr_destroy(ofproto->connmgr);
838 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
841 free(ofproto->mfr_desc);
842 free(ofproto->hw_desc);
843 free(ofproto->sw_desc);
844 free(ofproto->serial_desc);
845 free(ofproto->dp_desc);
846 hmap_destroy(&ofproto->ports);
847 shash_destroy(&ofproto->port_by_name);
849 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
850 assert(classifier_is_empty(table));
851 classifier_destroy(table);
853 free(ofproto->tables);
855 hmap_destroy(&ofproto->deletions);
857 free(ofproto->vlan_bitmap);
859 ofproto->ofproto_class->dealloc(ofproto);
863 ofproto_destroy(struct ofproto *p)
865 struct ofport *ofport, *next_ofport;
872 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
873 ofport_destroy(ofport);
876 p->ofproto_class->destruct(p);
877 ofproto_destroy__(p);
880 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
881 * kernel datapath, for example, this destroys the datapath in the kernel, and
882 * with the netdev-based datapath, it tears down the data structures that
883 * represent the datapath.
885 * The datapath should not be currently open as an ofproto. */
887 ofproto_delete(const char *name, const char *type)
889 const struct ofproto_class *class = ofproto_class_find__(type);
890 return (!class ? EAFNOSUPPORT
891 : !class->del ? EACCES
892 : class->del(type, name));
896 process_port_change(struct ofproto *ofproto, int error, char *devname)
898 if (error == ENOBUFS) {
899 reinit_ports(ofproto);
901 update_port(ofproto, devname);
907 ofproto_run(struct ofproto *p)
909 struct ofport *ofport;
913 error = p->ofproto_class->run(p);
914 if (error == ENODEV) {
915 /* Someone destroyed the datapath behind our back. The caller
916 * better destroy us and give up, because we're just going to
917 * spin from here on out. */
918 static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
919 VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
924 if (p->ofproto_class->port_poll) {
925 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
926 process_port_change(p, error, devname);
930 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
931 unsigned int change_seq = netdev_change_seq(ofport->netdev);
932 if (ofport->change_seq != change_seq) {
933 ofport->change_seq = change_seq;
934 update_port(p, netdev_get_name(ofport->netdev));
941 connmgr_run(p->connmgr, handle_openflow);
945 connmgr_run(p->connmgr, NULL);
947 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
948 connmgr_flushed(p->connmgr);
949 p->state = S_OPENFLOW;
961 ofproto_wait(struct ofproto *p)
963 struct ofport *ofport;
965 p->ofproto_class->wait(p);
966 if (p->ofproto_class->port_poll_wait) {
967 p->ofproto_class->port_poll_wait(p);
970 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
971 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
972 poll_immediate_wake();
978 connmgr_wait(p->connmgr, true);
982 connmgr_wait(p->connmgr, false);
983 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
984 poll_immediate_wake();
991 ofproto_is_alive(const struct ofproto *p)
993 return connmgr_has_controllers(p->connmgr);
997 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1000 connmgr_get_controller_info(ofproto->connmgr, info);
1004 ofproto_free_ofproto_controller_info(struct shash *info)
1006 connmgr_free_controller_info(info);
1009 /* Makes a deep copy of 'old' into 'port'. */
1011 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1013 port->name = xstrdup(old->name);
1014 port->type = xstrdup(old->type);
1015 port->ofp_port = old->ofp_port;
1018 /* Frees memory allocated to members of 'ofproto_port'.
1020 * Do not call this function on an ofproto_port obtained from
1021 * ofproto_port_dump_next(): that function retains ownership of the data in the
1024 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1026 free(ofproto_port->name);
1027 free(ofproto_port->type);
1030 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1032 * This function provides no status indication. An error status for the entire
1033 * dump operation is provided when it is completed by calling
1034 * ofproto_port_dump_done().
1037 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1038 const struct ofproto *ofproto)
1040 dump->ofproto = ofproto;
1041 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1045 /* Attempts to retrieve another port from 'dump', which must have been created
1046 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1047 * 'port' and returns true. On failure, returns false.
1049 * Failure might indicate an actual error or merely that the last port has been
1050 * dumped. An error status for the entire dump operation is provided when it
1051 * is completed by calling ofproto_port_dump_done().
1053 * The ofproto owns the data stored in 'port'. It will remain valid until at
1054 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1055 * ofproto_port_dump_done(). */
1057 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1058 struct ofproto_port *port)
1060 const struct ofproto *ofproto = dump->ofproto;
1066 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1069 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1075 /* Completes port table dump operation 'dump', which must have been created
1076 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1077 * error-free, otherwise a positive errno value describing the problem. */
1079 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1081 const struct ofproto *ofproto = dump->ofproto;
1083 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1086 return dump->error == EOF ? 0 : dump->error;
1089 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
1090 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
1091 * is non-null). On failure, returns a positive errno value and sets
1092 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
1094 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1095 uint16_t *ofp_portp)
1100 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
1102 update_port(ofproto, netdev_get_name(netdev));
1105 *ofp_portp = error ? OFPP_NONE : ofp_port;
1110 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1111 * initializes '*port' appropriately; on failure, returns a positive errno
1114 * The caller owns the data in 'ofproto_port' and must free it with
1115 * ofproto_port_destroy() when it is no longer needed. */
1117 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1118 struct ofproto_port *port)
1122 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1124 memset(port, 0, sizeof *port);
1129 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1130 * Returns 0 if successful, otherwise a positive errno. */
1132 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1134 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1135 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1138 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1139 if (!error && ofport) {
1140 /* 'name' is the netdev's name and update_port() is going to close the
1141 * netdev. Just in case update_port() refers to 'name' after it
1142 * destroys 'ofport', make a copy of it around the update_port()
1144 char *devname = xstrdup(name);
1145 update_port(ofproto, devname);
1151 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1152 * performs the 'n_actions' actions in 'actions'. The new flow will not
1155 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1156 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1157 * controllers; otherwise, it will be hidden.
1159 * The caller retains ownership of 'cls_rule' and 'actions'.
1161 * This is a helper function for in-band control and fail-open. */
1163 ofproto_add_flow(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1164 const union ofp_action *actions, size_t n_actions)
1166 const struct rule *rule;
1168 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1169 &ofproto->tables[0], cls_rule));
1170 if (!rule || !ofputil_actions_equal(rule->actions, rule->n_actions,
1171 actions, n_actions)) {
1172 struct ofputil_flow_mod fm;
1174 memset(&fm, 0, sizeof fm);
1176 fm.buffer_id = UINT32_MAX;
1177 fm.actions = (union ofp_action *) actions;
1178 fm.n_actions = n_actions;
1179 add_flow(ofproto, NULL, &fm, NULL);
1183 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1184 * OpenFlow error code as encoded by ofp_mkerr() on failure, or
1185 * OFPROTO_POSTPONE if the operation cannot be initiated now but may be retried
1188 * This is a helper function for in-band control and fail-open. */
1190 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1192 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1195 /* Searches for a rule with matching criteria exactly equal to 'target' in
1196 * ofproto's table 0 and, if it finds one, deletes it.
1198 * This is a helper function for in-band control and fail-open. */
1200 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1204 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1205 &ofproto->tables[0], target));
1207 /* No such rule -> success. */
1209 } else if (rule->pending) {
1210 /* An operation on the rule is already pending -> failure.
1211 * Caller must retry later if it's important. */
1214 /* Initiate deletion -> success. */
1215 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1216 ofoperation_create(group, rule, OFOPERATION_DELETE);
1217 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
1218 rule->ofproto->ofproto_class->rule_destruct(rule);
1219 ofopgroup_submit(group);
1225 /* Starts the process of deleting all of the flows from all of ofproto's flow
1226 * tables and then reintroducing the flows required by in-band control and
1227 * fail-open. The process will complete in a later call to ofproto_run(). */
1229 ofproto_flush_flows(struct ofproto *ofproto)
1231 COVERAGE_INC(ofproto_flush);
1232 ofproto->state = S_FLUSH;
1236 reinit_ports(struct ofproto *p)
1238 struct ofproto_port_dump dump;
1239 struct sset devnames;
1240 struct ofport *ofport;
1241 struct ofproto_port ofproto_port;
1242 const char *devname;
1244 COVERAGE_INC(ofproto_reinit_ports);
1246 sset_init(&devnames);
1247 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1248 sset_add(&devnames, netdev_get_name(ofport->netdev));
1250 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1251 sset_add(&devnames, ofproto_port.name);
1254 SSET_FOR_EACH (devname, &devnames) {
1255 update_port(p, devname);
1257 sset_destroy(&devnames);
1260 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
1261 * netdev cannot be opened. On success, also fills in 'opp'. */
1262 static struct netdev *
1263 ofport_open(const struct ofproto_port *ofproto_port, struct ofp_phy_port *opp)
1265 uint32_t curr, advertised, supported, peer;
1266 enum netdev_flags flags;
1267 struct netdev *netdev;
1270 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1272 VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1273 "cannot be opened (%s)",
1274 ofproto_port->name, ofproto_port->ofp_port,
1275 ofproto_port->name, strerror(error));
1279 netdev_get_flags(netdev, &flags);
1280 netdev_get_features(netdev, &curr, &advertised, &supported, &peer);
1282 opp->port_no = htons(ofproto_port->ofp_port);
1283 netdev_get_etheraddr(netdev, opp->hw_addr);
1284 ovs_strzcpy(opp->name, ofproto_port->name, sizeof opp->name);
1285 opp->config = flags & NETDEV_UP ? 0 : htonl(OFPPC_PORT_DOWN);
1286 opp->state = netdev_get_carrier(netdev) ? 0 : htonl(OFPPS_LINK_DOWN);
1287 opp->curr = htonl(curr);
1288 opp->advertised = htonl(advertised);
1289 opp->supported = htonl(supported);
1290 opp->peer = htonl(peer);
1295 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1296 * port number, and 'config' bits other than OFPPC_PORT_DOWN are
1299 ofport_equal(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
1301 BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1302 return (!memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1303 && a->state == b->state
1304 && !((a->config ^ b->config) & htonl(OFPPC_PORT_DOWN))
1305 && a->curr == b->curr
1306 && a->advertised == b->advertised
1307 && a->supported == b->supported
1308 && a->peer == b->peer);
1311 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1312 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1313 * one with the same name or port number). */
1315 ofport_install(struct ofproto *p,
1316 struct netdev *netdev, const struct ofp_phy_port *opp)
1318 const char *netdev_name = netdev_get_name(netdev);
1319 struct ofport *ofport;
1323 /* Create ofport. */
1324 ofport = p->ofproto_class->port_alloc();
1329 ofport->ofproto = p;
1330 ofport->netdev = netdev;
1331 ofport->change_seq = netdev_change_seq(netdev);
1333 ofport->ofp_port = ntohs(opp->port_no);
1335 /* Add port to 'p'. */
1336 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1337 shash_add(&p->port_by_name, netdev_name, ofport);
1339 if (!netdev_get_mtu(netdev, &dev_mtu)) {
1340 set_internal_devs_mtu(p);
1341 ofport->mtu = dev_mtu;
1346 /* Let the ofproto_class initialize its private data. */
1347 error = p->ofproto_class->port_construct(ofport);
1351 connmgr_send_port_status(p->connmgr, opp, OFPPR_ADD);
1355 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1356 p->name, netdev_name, strerror(error));
1358 ofport_destroy__(ofport);
1360 netdev_close(netdev);
1364 /* Removes 'ofport' from 'p' and destroys it. */
1366 ofport_remove(struct ofport *ofport)
1368 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->opp,
1370 ofport_destroy(ofport);
1373 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1376 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1378 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1380 ofport_remove(port);
1384 /* Updates 'port' with new 'opp' description.
1386 * Does not handle a name or port number change. The caller must implement
1387 * such a change as a delete followed by an add. */
1389 ofport_modified(struct ofport *port, struct ofp_phy_port *opp)
1391 memcpy(port->opp.hw_addr, opp->hw_addr, ETH_ADDR_LEN);
1392 port->opp.config = ((port->opp.config & ~htonl(OFPPC_PORT_DOWN))
1393 | (opp->config & htonl(OFPPC_PORT_DOWN)));
1394 port->opp.state = opp->state;
1395 port->opp.curr = opp->curr;
1396 port->opp.advertised = opp->advertised;
1397 port->opp.supported = opp->supported;
1398 port->opp.peer = opp->peer;
1400 connmgr_send_port_status(port->ofproto->connmgr, &port->opp, OFPPR_MODIFY);
1403 /* Update OpenFlow 'state' in 'port' and notify controller. */
1405 ofproto_port_set_state(struct ofport *port, ovs_be32 state)
1407 if (port->opp.state != state) {
1408 port->opp.state = state;
1409 connmgr_send_port_status(port->ofproto->connmgr, &port->opp,
1415 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1417 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1419 if (port->ofproto->ofproto_class->set_realdev) {
1420 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1422 if (port->ofproto->ofproto_class->set_stp_port) {
1423 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1425 if (port->ofproto->ofproto_class->set_cfm) {
1426 port->ofproto->ofproto_class->set_cfm(port, NULL);
1428 if (port->ofproto->ofproto_class->bundle_remove) {
1429 port->ofproto->ofproto_class->bundle_remove(port);
1435 ofport_destroy__(struct ofport *port)
1437 struct ofproto *ofproto = port->ofproto;
1438 const char *name = netdev_get_name(port->netdev);
1440 hmap_remove(&ofproto->ports, &port->hmap_node);
1441 shash_delete(&ofproto->port_by_name,
1442 shash_find(&ofproto->port_by_name, name));
1444 netdev_close(port->netdev);
1445 ofproto->ofproto_class->port_dealloc(port);
1449 ofport_destroy(struct ofport *port)
1452 port->ofproto->ofproto_class->port_destruct(port);
1453 ofport_destroy__(port);
1458 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1460 struct ofport *port;
1462 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1463 hash_int(ofp_port, 0), &ofproto->ports) {
1464 if (port->ofp_port == ofp_port) {
1472 update_port(struct ofproto *ofproto, const char *name)
1474 struct ofproto_port ofproto_port;
1475 struct ofp_phy_port opp;
1476 struct netdev *netdev;
1477 struct ofport *port;
1479 COVERAGE_INC(ofproto_update_port);
1481 /* Fetch 'name''s location and properties from the datapath. */
1482 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1483 ? ofport_open(&ofproto_port, &opp)
1486 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1487 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1488 struct netdev *old_netdev = port->netdev;
1491 /* 'name' hasn't changed location. Any properties changed? */
1492 if (!ofport_equal(&port->opp, &opp)) {
1493 ofport_modified(port, &opp);
1496 /* If this is a non-internal port and the MTU changed, check
1497 * if the datapath's MTU needs to be updated. */
1498 if (strcmp(netdev_get_type(netdev), "internal")
1499 && !netdev_get_mtu(netdev, &dev_mtu)
1500 && port->mtu != dev_mtu) {
1501 set_internal_devs_mtu(ofproto);
1502 port->mtu = dev_mtu;
1505 /* Install the newly opened netdev in case it has changed.
1506 * Don't close the old netdev yet in case port_modified has to
1507 * remove a retained reference to it.*/
1508 port->netdev = netdev;
1509 port->change_seq = netdev_change_seq(netdev);
1511 if (port->ofproto->ofproto_class->port_modified) {
1512 port->ofproto->ofproto_class->port_modified(port);
1515 netdev_close(old_netdev);
1517 /* If 'port' is nonnull then its name differs from 'name' and thus
1518 * we should delete it. If we think there's a port named 'name'
1519 * then its port number must be wrong now so delete it too. */
1521 ofport_remove(port);
1523 ofport_remove_with_name(ofproto, name);
1524 ofport_install(ofproto, netdev, &opp);
1527 /* Any port named 'name' is gone now. */
1528 ofport_remove_with_name(ofproto, name);
1530 ofproto_port_destroy(&ofproto_port);
1534 init_ports(struct ofproto *p)
1536 struct ofproto_port_dump dump;
1537 struct ofproto_port ofproto_port;
1539 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1540 uint16_t ofp_port = ofproto_port.ofp_port;
1541 if (ofproto_get_port(p, ofp_port)) {
1542 VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1544 } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1545 VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1548 struct ofp_phy_port opp;
1549 struct netdev *netdev;
1551 netdev = ofport_open(&ofproto_port, &opp);
1553 ofport_install(p, netdev, &opp);
1561 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1562 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1564 find_min_mtu(struct ofproto *p)
1566 struct ofport *ofport;
1569 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1570 struct netdev *netdev = ofport->netdev;
1573 /* Skip any internal ports, since that's what we're trying to
1575 if (!strcmp(netdev_get_type(netdev), "internal")) {
1579 if (netdev_get_mtu(netdev, &dev_mtu)) {
1582 if (!mtu || dev_mtu < mtu) {
1587 return mtu ? mtu: ETH_PAYLOAD_MAX;
1590 /* Set the MTU of all datapath devices on 'p' to the minimum of the
1591 * non-datapath ports. */
1593 set_internal_devs_mtu(struct ofproto *p)
1595 struct ofport *ofport;
1596 int mtu = find_min_mtu(p);
1598 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1599 struct netdev *netdev = ofport->netdev;
1601 if (!strcmp(netdev_get_type(netdev), "internal")) {
1602 netdev_set_mtu(netdev, mtu);
1608 ofproto_rule_destroy__(struct rule *rule)
1610 free(rule->actions);
1611 rule->ofproto->ofproto_class->rule_dealloc(rule);
1614 /* This function allows an ofproto implementation to destroy any rules that
1615 * remain when its ->destruct() function is called. The caller must have
1616 * already uninitialized any derived members of 'rule' (step 5 described in the
1617 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1618 * This function implements steps 6 and 7.
1620 * This function should only be called from an ofproto implementation's
1621 * ->destruct() function. It is not suitable elsewhere. */
1623 ofproto_rule_destroy(struct rule *rule)
1625 assert(!rule->pending);
1626 classifier_remove(&rule->ofproto->tables[rule->table_id], &rule->cr);
1627 ofproto_rule_destroy__(rule);
1630 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1631 * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1634 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1636 const union ofp_action *oa;
1639 if (out_port == OFPP_NONE) {
1642 OFPUTIL_ACTION_FOR_EACH_UNSAFE (oa, left, rule->actions, rule->n_actions) {
1643 if (action_outputs_to_port(oa, htons(out_port))) {
1650 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1651 * statistics appropriately. 'packet' must have at least sizeof(struct
1652 * ofp_packet_in) bytes of headroom.
1654 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1655 * with statistics for 'packet' either way.
1657 * Takes ownership of 'packet'. */
1659 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1663 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1665 flow_extract(packet, 0, 0, in_port, &flow);
1666 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1669 /* Returns true if 'rule' should be hidden from the controller.
1671 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1672 * (e.g. by in-band control) and are intentionally hidden from the
1675 rule_is_hidden(const struct rule *rule)
1677 return rule->cr.priority > UINT16_MAX;
1681 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1683 ofconn_send_reply(ofconn, make_echo_reply(oh));
1688 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1690 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1691 struct ofp_switch_features *osf;
1693 struct ofport *port;
1697 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip, &actions);
1698 assert(actions & (1 << OFPAT_OUTPUT)); /* sanity check */
1700 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1701 osf->datapath_id = htonll(ofproto->datapath_id);
1702 osf->n_buffers = htonl(pktbuf_capacity());
1703 osf->n_tables = ofproto->n_tables;
1704 osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1705 OFPC_PORT_STATS | OFPC_QUEUE_STATS);
1707 osf->capabilities |= htonl(OFPC_ARP_MATCH_IP);
1709 osf->actions = htonl(actions);
1711 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1712 ofpbuf_put(buf, &port->opp, sizeof port->opp);
1715 ofconn_send_reply(ofconn, buf);
1720 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1722 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1723 struct ofp_switch_config *osc;
1727 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1728 osc->flags = htons(ofproto->frag_handling);
1729 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1730 ofconn_send_reply(ofconn, buf);
1736 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1738 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1739 uint16_t flags = ntohs(osc->flags);
1741 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
1742 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1743 enum ofp_config_flags cur = ofproto->frag_handling;
1744 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
1746 assert((cur & OFPC_FRAG_MASK) == cur);
1748 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
1749 ofproto->frag_handling = next;
1751 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
1753 ofputil_frag_handling_to_string(next));
1758 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1763 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1764 * error message code (composed with ofp_mkerr()) for the caller to propagate
1765 * upward. Otherwise, returns 0. */
1767 reject_slave_controller(const struct ofconn *ofconn)
1769 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1770 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1771 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
1778 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1780 struct ofproto *p = ofconn_get_ofproto(ofconn);
1781 struct ofp_packet_out *opo;
1782 struct ofpbuf payload, *buffer;
1783 union ofp_action *ofp_actions;
1784 struct ofpbuf request;
1786 size_t n_ofp_actions;
1790 COVERAGE_INC(ofproto_packet_out);
1792 error = reject_slave_controller(ofconn);
1797 /* Get ofp_packet_out. */
1798 ofpbuf_use_const(&request, oh, ntohs(oh->length));
1799 opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1802 error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1803 &ofp_actions, &n_ofp_actions);
1809 if (opo->buffer_id != htonl(UINT32_MAX)) {
1810 error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1812 if (error || !buffer) {
1821 /* Get in_port and partially validate it.
1823 * We don't know what range of ports the ofproto actually implements, but
1824 * we do know that only certain reserved ports (numbered OFPP_MAX and
1825 * above) are valid. */
1826 in_port = ntohs(opo->in_port);
1827 if (in_port >= OFPP_MAX && in_port != OFPP_LOCAL && in_port != OFPP_NONE) {
1828 return ofp_mkerr_nicira(OFPET_BAD_REQUEST, NXBRC_BAD_IN_PORT);
1831 /* Send out packet. */
1832 flow_extract(&payload, 0, 0, in_port, &flow);
1833 error = p->ofproto_class->packet_out(p, &payload, &flow,
1834 ofp_actions, n_ofp_actions);
1835 ofpbuf_delete(buffer);
1841 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1843 ovs_be32 old_config = port->opp.config;
1845 mask &= config ^ port->opp.config;
1846 if (mask & htonl(OFPPC_PORT_DOWN)) {
1847 if (config & htonl(OFPPC_PORT_DOWN)) {
1848 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1850 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1854 port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1855 OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1856 OFPPC_NO_PACKET_IN));
1857 if (port->opp.config != old_config) {
1858 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1863 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1865 struct ofproto *p = ofconn_get_ofproto(ofconn);
1866 const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1867 struct ofport *port;
1870 error = reject_slave_controller(ofconn);
1875 port = ofproto_get_port(p, ntohs(opm->port_no));
1877 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
1878 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1879 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
1881 update_port_config(port, opm->config, opm->mask);
1882 if (opm->advertise) {
1883 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1890 handle_desc_stats_request(struct ofconn *ofconn,
1891 const struct ofp_stats_msg *request)
1893 struct ofproto *p = ofconn_get_ofproto(ofconn);
1894 struct ofp_desc_stats *ods;
1897 ods = ofputil_make_stats_reply(sizeof *ods, request, &msg);
1898 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1899 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1900 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1901 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1902 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1903 ofconn_send_reply(ofconn, msg);
1909 handle_table_stats_request(struct ofconn *ofconn,
1910 const struct ofp_stats_msg *request)
1912 struct ofproto *p = ofconn_get_ofproto(ofconn);
1913 struct ofp_table_stats *ots;
1917 ofputil_make_stats_reply(sizeof(struct ofp_stats_msg), request, &msg);
1919 ots = ofpbuf_put_zeros(msg, sizeof *ots * p->n_tables);
1920 for (i = 0; i < p->n_tables; i++) {
1921 ots[i].table_id = i;
1922 sprintf(ots[i].name, "table%zu", i);
1923 ots[i].wildcards = htonl(OFPFW_ALL);
1924 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
1925 ots[i].active_count = htonl(classifier_count(&p->tables[i]));
1928 p->ofproto_class->get_tables(p, ots);
1930 ofconn_send_reply(ofconn, msg);
1935 append_port_stat(struct ofport *port, struct list *replies)
1937 struct netdev_stats stats;
1938 struct ofp_port_stats *ops;
1940 /* Intentionally ignore return value, since errors will set
1941 * 'stats' to all-1s, which is correct for OpenFlow, and
1942 * netdev_get_stats() will log errors. */
1943 netdev_get_stats(port->netdev, &stats);
1945 ops = ofputil_append_stats_reply(sizeof *ops, replies);
1946 ops->port_no = port->opp.port_no;
1947 memset(ops->pad, 0, sizeof ops->pad);
1948 put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
1949 put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
1950 put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
1951 put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
1952 put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
1953 put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
1954 put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
1955 put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
1956 put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
1957 put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
1958 put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
1959 put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
1963 handle_port_stats_request(struct ofconn *ofconn,
1964 const struct ofp_port_stats_request *psr)
1966 struct ofproto *p = ofconn_get_ofproto(ofconn);
1967 struct ofport *port;
1968 struct list replies;
1970 ofputil_start_stats_reply(&psr->osm, &replies);
1971 if (psr->port_no != htons(OFPP_NONE)) {
1972 port = ofproto_get_port(p, ntohs(psr->port_no));
1974 append_port_stat(port, &replies);
1977 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
1978 append_port_stat(port, &replies);
1982 ofconn_send_replies(ofconn, &replies);
1987 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
1989 long long int msecs = time_msec() - start;
1990 *sec = msecs / 1000;
1991 *nsec = (msecs % 1000) * (1000 * 1000);
1994 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
1995 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
1997 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
1999 return (table_id == 0xff || table_id < ofproto->n_tables
2001 : ofp_mkerr_nicira(OFPET_BAD_REQUEST, NXBRC_BAD_TABLE_ID));
2005 static struct classifier *
2006 first_matching_table(struct ofproto *ofproto, uint8_t table_id)
2008 if (table_id == 0xff) {
2009 return &ofproto->tables[0];
2010 } else if (table_id < ofproto->n_tables) {
2011 return &ofproto->tables[table_id];
2017 static struct classifier *
2018 next_matching_table(struct ofproto *ofproto,
2019 struct classifier *cls, uint8_t table_id)
2021 return (table_id == 0xff && cls != &ofproto->tables[ofproto->n_tables - 1]
2026 /* Assigns CLS to each classifier table, in turn, that matches TABLE_ID in
2029 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2032 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2033 * only once, for that table.
2035 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2036 * entered at all. (Perhaps you should have validated TABLE_ID with
2037 * check_table_id().)
2039 * All parameters are evaluated multiple times.
2041 #define FOR_EACH_MATCHING_TABLE(CLS, TABLE_ID, OFPROTO) \
2042 for ((CLS) = first_matching_table(OFPROTO, TABLE_ID); \
2044 (CLS) = next_matching_table(OFPROTO, CLS, TABLE_ID))
2046 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2047 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2048 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2051 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2052 * to 'out_port' are included.
2054 * Hidden rules are always omitted.
2056 * Returns 0 on success, otherwise an OpenFlow error code. */
2058 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2059 const struct cls_rule *match, uint16_t out_port,
2062 struct classifier *cls;
2065 error = check_table_id(ofproto, table_id);
2071 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
2072 struct cls_cursor cursor;
2075 cls_cursor_init(&cursor, cls, match);
2076 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2077 if (rule->pending) {
2078 return OFPROTO_POSTPONE;
2080 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
2081 list_push_back(rules, &rule->ofproto_node);
2088 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2089 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2090 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2093 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2094 * to 'out_port' are included.
2096 * Hidden rules are always omitted.
2098 * Returns 0 on success, otherwise an OpenFlow error code. */
2100 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2101 const struct cls_rule *match, uint16_t out_port,
2104 struct classifier *cls;
2107 error = check_table_id(ofproto, table_id);
2113 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
2116 rule = rule_from_cls_rule(classifier_find_rule_exactly(cls, match));
2118 if (rule->pending) {
2119 return OFPROTO_POSTPONE;
2121 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
2122 list_push_back(rules, &rule->ofproto_node);
2130 handle_flow_stats_request(struct ofconn *ofconn,
2131 const struct ofp_stats_msg *osm)
2133 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2134 struct ofputil_flow_stats_request fsr;
2135 struct list replies;
2140 error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
2145 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2146 fsr.out_port, &rules);
2151 ofputil_start_stats_reply(osm, &replies);
2152 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2153 struct ofputil_flow_stats fs;
2156 fs.cookie = rule->flow_cookie;
2157 fs.table_id = rule->table_id;
2158 calc_flow_duration__(rule->created, &fs.duration_sec,
2160 fs.idle_timeout = rule->idle_timeout;
2161 fs.hard_timeout = rule->hard_timeout;
2162 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2164 fs.actions = rule->actions;
2165 fs.n_actions = rule->n_actions;
2166 ofputil_append_flow_stats_reply(&fs, &replies);
2168 ofconn_send_replies(ofconn, &replies);
2174 flow_stats_ds(struct rule *rule, struct ds *results)
2176 uint64_t packet_count, byte_count;
2178 rule->ofproto->ofproto_class->rule_get_stats(rule,
2179 &packet_count, &byte_count);
2181 if (rule->table_id != 0) {
2182 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2184 ds_put_format(results, "duration=%llds, ",
2185 (time_msec() - rule->created) / 1000);
2186 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2187 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2188 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2189 cls_rule_format(&rule->cr, results);
2190 ds_put_char(results, ',');
2191 if (rule->n_actions > 0) {
2192 ofp_print_actions(results, rule->actions, rule->n_actions);
2194 ds_put_cstr(results, "drop");
2196 ds_put_cstr(results, "\n");
2199 /* Adds a pretty-printed description of all flows to 'results', including
2200 * hidden flows (e.g., set up by in-band control). */
2202 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2204 struct classifier *cls;
2206 OFPROTO_FOR_EACH_TABLE (cls, p) {
2207 struct cls_cursor cursor;
2210 cls_cursor_init(&cursor, cls, NULL);
2211 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2212 flow_stats_ds(rule, results);
2217 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2218 * '*engine_type' and '*engine_id', respectively. */
2220 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2221 uint8_t *engine_type, uint8_t *engine_id)
2223 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2226 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns 1
2227 * if CFM is faulted (generally indiciating a connectivity problem), 0 if CFM
2228 * is not faulted, and -1 if CFM is not enabled on 'ofp_port'. */
2230 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2232 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2233 return (ofport && ofproto->ofproto_class->get_cfm_fault
2234 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2238 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2239 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2240 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2241 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2243 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2244 uint16_t ofp_port, const uint64_t **rmps,
2247 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2251 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2252 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2258 handle_aggregate_stats_request(struct ofconn *ofconn,
2259 const struct ofp_stats_msg *osm)
2261 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2262 struct ofputil_flow_stats_request request;
2263 struct ofputil_aggregate_stats stats;
2264 bool unknown_packets, unknown_bytes;
2265 struct ofpbuf *reply;
2270 error = ofputil_decode_flow_stats_request(&request, &osm->header);
2275 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2276 request.out_port, &rules);
2281 memset(&stats, 0, sizeof stats);
2282 unknown_packets = unknown_bytes = false;
2283 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2284 uint64_t packet_count;
2285 uint64_t byte_count;
2287 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2290 if (packet_count == UINT64_MAX) {
2291 unknown_packets = true;
2293 stats.packet_count += packet_count;
2296 if (byte_count == UINT64_MAX) {
2297 unknown_bytes = true;
2299 stats.byte_count += byte_count;
2304 if (unknown_packets) {
2305 stats.packet_count = UINT64_MAX;
2307 if (unknown_bytes) {
2308 stats.byte_count = UINT64_MAX;
2311 reply = ofputil_encode_aggregate_stats_reply(&stats, osm);
2312 ofconn_send_reply(ofconn, reply);
2317 struct queue_stats_cbdata {
2318 struct ofport *ofport;
2319 struct list replies;
2323 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2324 const struct netdev_queue_stats *stats)
2326 struct ofp_queue_stats *reply;
2328 reply = ofputil_append_stats_reply(sizeof *reply, &cbdata->replies);
2329 reply->port_no = cbdata->ofport->opp.port_no;
2330 memset(reply->pad, 0, sizeof reply->pad);
2331 reply->queue_id = htonl(queue_id);
2332 put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2333 put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2334 put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2338 handle_queue_stats_dump_cb(uint32_t queue_id,
2339 struct netdev_queue_stats *stats,
2342 struct queue_stats_cbdata *cbdata = cbdata_;
2344 put_queue_stats(cbdata, queue_id, stats);
2348 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2349 struct queue_stats_cbdata *cbdata)
2351 cbdata->ofport = port;
2352 if (queue_id == OFPQ_ALL) {
2353 netdev_dump_queue_stats(port->netdev,
2354 handle_queue_stats_dump_cb, cbdata);
2356 struct netdev_queue_stats stats;
2358 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2359 put_queue_stats(cbdata, queue_id, &stats);
2365 handle_queue_stats_request(struct ofconn *ofconn,
2366 const struct ofp_queue_stats_request *qsr)
2368 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2369 struct queue_stats_cbdata cbdata;
2370 struct ofport *port;
2371 unsigned int port_no;
2374 COVERAGE_INC(ofproto_queue_req);
2376 ofputil_start_stats_reply(&qsr->osm, &cbdata.replies);
2378 port_no = ntohs(qsr->port_no);
2379 queue_id = ntohl(qsr->queue_id);
2380 if (port_no == OFPP_ALL) {
2381 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2382 handle_queue_stats_for_port(port, queue_id, &cbdata);
2384 } else if (port_no < OFPP_MAX) {
2385 port = ofproto_get_port(ofproto, port_no);
2387 handle_queue_stats_for_port(port, queue_id, &cbdata);
2390 ofpbuf_list_delete(&cbdata.replies);
2391 return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
2393 ofconn_send_replies(ofconn, &cbdata.replies);
2399 is_flow_deletion_pending(const struct ofproto *ofproto,
2400 const struct cls_rule *cls_rule,
2403 if (!hmap_is_empty(&ofproto->deletions)) {
2404 struct ofoperation *op;
2406 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2407 cls_rule_hash(cls_rule, table_id),
2408 &ofproto->deletions) {
2409 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2418 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2419 * in which no matching flow already exists in the flow table.
2421 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2422 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
2423 * error code as encoded by ofp_mkerr() on failure, or OFPROTO_POSTPONE if the
2424 * operation cannot be initiated now but may be retried later.
2426 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2429 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
2430 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
2432 struct classifier *table;
2433 struct ofopgroup *group;
2434 struct rule *victim;
2438 error = check_table_id(ofproto, fm->table_id);
2444 if (fm->table_id == 0xff) {
2446 if (ofproto->ofproto_class->rule_choose_table) {
2447 error = ofproto->ofproto_class->rule_choose_table(ofproto, &fm->cr,
2452 assert(table_id < ofproto->n_tables);
2453 table = &ofproto->tables[table_id];
2455 table = &ofproto->tables[0];
2457 } else if (fm->table_id < ofproto->n_tables) {
2458 table = &ofproto->tables[fm->table_id];
2460 return ofp_mkerr_nicira(OFPET_FLOW_MOD_FAILED, NXFMFC_BAD_TABLE_ID);
2463 /* Check for overlap, if requested. */
2464 if (fm->flags & OFPFF_CHECK_OVERLAP
2465 && classifier_rule_overlaps(table, &fm->cr)) {
2466 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
2469 /* Serialize against pending deletion. */
2470 if (is_flow_deletion_pending(ofproto, &fm->cr, table - ofproto->tables)) {
2471 return OFPROTO_POSTPONE;
2474 /* Allocate new rule. */
2475 rule = ofproto->ofproto_class->rule_alloc();
2477 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2478 ofproto->name, strerror(error));
2481 rule->ofproto = ofproto;
2483 rule->pending = NULL;
2484 rule->flow_cookie = fm->cookie;
2485 rule->created = rule->modified = time_msec();
2486 rule->idle_timeout = fm->idle_timeout;
2487 rule->hard_timeout = fm->hard_timeout;
2488 rule->table_id = table - ofproto->tables;
2489 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2490 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2491 rule->n_actions = fm->n_actions;
2493 /* Insert new rule. */
2494 victim = rule_from_cls_rule(classifier_replace(table, &rule->cr));
2495 if (victim && victim->pending) {
2496 error = OFPROTO_POSTPONE;
2498 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2499 ofoperation_create(group, rule, OFOPERATION_ADD);
2500 rule->pending->victim = victim;
2502 error = ofproto->ofproto_class->rule_construct(rule);
2504 ofoperation_destroy(rule->pending);
2506 ofopgroup_submit(group);
2509 /* Back out if an error occurred. */
2512 classifier_replace(table, &victim->cr);
2514 classifier_remove(table, &rule->cr);
2516 ofproto_rule_destroy__(rule);
2521 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2523 /* Modifies the rules listed in 'rules', changing their actions to match those
2526 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2529 * Returns 0 on success, otherwise an OpenFlow error code. */
2531 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2532 const struct ofputil_flow_mod *fm,
2533 const struct ofp_header *request, struct list *rules)
2535 struct ofopgroup *group;
2538 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2539 LIST_FOR_EACH (rule, ofproto_node, rules) {
2540 if (!ofputil_actions_equal(fm->actions, fm->n_actions,
2541 rule->actions, rule->n_actions)) {
2542 ofoperation_create(group, rule, OFOPERATION_MODIFY);
2543 rule->pending->actions = rule->actions;
2544 rule->pending->n_actions = rule->n_actions;
2545 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2546 rule->n_actions = fm->n_actions;
2547 rule->ofproto->ofproto_class->rule_modify_actions(rule);
2549 rule->modified = time_msec();
2551 rule->flow_cookie = fm->cookie;
2553 ofopgroup_submit(group);
2558 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code as
2559 * encoded by ofp_mkerr() on failure.
2561 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2564 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2565 const struct ofputil_flow_mod *fm,
2566 const struct ofp_header *request)
2571 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr, OFPP_NONE,
2573 return (error ? error
2574 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2575 : modify_flows__(ofproto, ofconn, fm, request, &rules));
2578 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2579 * code as encoded by ofp_mkerr() on failure.
2581 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2584 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2585 const struct ofputil_flow_mod *fm,
2586 const struct ofp_header *request)
2591 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr, OFPP_NONE,
2593 return (error ? error
2594 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2595 : list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
2596 fm, request, &rules)
2600 /* OFPFC_DELETE implementation. */
2602 /* Deletes the rules listed in 'rules'.
2604 * Returns 0 on success, otherwise an OpenFlow error code. */
2606 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2607 const struct ofp_header *request, struct list *rules)
2609 struct rule *rule, *next;
2610 struct ofopgroup *group;
2612 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
2613 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
2614 ofproto_rule_send_removed(rule, OFPRR_DELETE);
2616 ofoperation_create(group, rule, OFOPERATION_DELETE);
2617 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2618 rule->ofproto->ofproto_class->rule_destruct(rule);
2620 ofopgroup_submit(group);
2625 /* Implements OFPFC_DELETE. */
2627 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2628 const struct ofputil_flow_mod *fm,
2629 const struct ofp_header *request)
2634 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr, fm->out_port,
2636 return (error ? error
2637 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
2642 /* Implements OFPFC_DELETE_STRICT. */
2644 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2645 const struct ofputil_flow_mod *fm,
2646 const struct ofp_header *request)
2651 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr, fm->out_port,
2653 return (error ? error
2654 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
2660 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2662 struct ofputil_flow_removed fr;
2664 if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2669 fr.cookie = rule->flow_cookie;
2671 calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2672 fr.idle_timeout = rule->idle_timeout;
2673 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2676 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2679 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2680 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2683 * ofproto implementation ->run() functions should use this function to expire
2684 * OpenFlow flows. */
2686 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2688 struct ofproto *ofproto = rule->ofproto;
2689 struct ofopgroup *group;
2691 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2693 ofproto_rule_send_removed(rule, reason);
2695 group = ofopgroup_create_unattached(ofproto);
2696 ofoperation_create(group, rule, OFOPERATION_DELETE);
2697 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2698 rule->ofproto->ofproto_class->rule_destruct(rule);
2699 ofopgroup_submit(group);
2703 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2705 struct ofputil_flow_mod fm;
2708 error = reject_slave_controller(ofconn);
2713 error = ofputil_decode_flow_mod(&fm, oh,
2714 ofconn_get_flow_mod_table_id(ofconn));
2719 /* We do not support the emergency flow cache. It will hopefully get
2720 * dropped from OpenFlow in the near future. */
2721 if (fm.flags & OFPFF_EMERG) {
2722 /* There isn't a good fit for an error code, so just state that the
2723 * flow table is full. */
2724 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
2727 return handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
2731 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
2732 const struct ofputil_flow_mod *fm,
2733 const struct ofp_header *oh)
2735 if (ofproto->n_pending >= 50) {
2736 assert(!list_is_empty(&ofproto->pending));
2737 return OFPROTO_POSTPONE;
2740 switch (fm->command) {
2742 return add_flow(ofproto, ofconn, fm, oh);
2745 return modify_flows_loose(ofproto, ofconn, fm, oh);
2747 case OFPFC_MODIFY_STRICT:
2748 return modify_flow_strict(ofproto, ofconn, fm, oh);
2751 return delete_flows_loose(ofproto, ofconn, fm, oh);
2753 case OFPFC_DELETE_STRICT:
2754 return delete_flow_strict(ofproto, ofconn, fm, oh);
2757 if (fm->command > 0xff) {
2758 VLOG_WARN_RL(&rl, "flow_mod has explicit table_id but "
2759 "flow_mod_table_id extension is not enabled");
2761 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2766 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2768 struct nx_role_request *nrr = (struct nx_role_request *) oh;
2769 struct nx_role_request *reply;
2773 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2774 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2777 role = ntohl(nrr->role);
2778 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2779 && role != NX_ROLE_SLAVE) {
2780 return ofp_mkerr_nicira(OFPET_BAD_REQUEST, NXBRC_BAD_ROLE);
2783 if (ofconn_get_role(ofconn) != role
2784 && ofconn_has_pending_opgroups(ofconn)) {
2785 return OFPROTO_POSTPONE;
2788 ofconn_set_role(ofconn, role);
2790 reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2791 reply->role = htonl(role);
2792 ofconn_send_reply(ofconn, buf);
2798 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
2799 const struct ofp_header *oh)
2801 const struct nxt_flow_mod_table_id *msg
2802 = (const struct nxt_flow_mod_table_id *) oh;
2804 ofconn_set_flow_mod_table_id(ofconn, msg->set != 0);
2809 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2811 const struct nxt_set_flow_format *msg
2812 = (const struct nxt_set_flow_format *) oh;
2815 format = ntohl(msg->format);
2816 if (format != NXFF_OPENFLOW10 && format != NXFF_NXM) {
2817 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2820 if (format != ofconn_get_flow_format(ofconn)
2821 && ofconn_has_pending_opgroups(ofconn)) {
2822 /* Avoid sending async messages in surprising flow format. */
2823 return OFPROTO_POSTPONE;
2826 ofconn_set_flow_format(ofconn, format);
2831 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2833 struct ofp_header *ob;
2836 if (ofconn_has_pending_opgroups(ofconn)) {
2837 return OFPROTO_POSTPONE;
2840 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2841 ofconn_send_reply(ofconn, buf);
2846 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2848 const struct ofp_header *oh = msg->data;
2849 const struct ofputil_msg_type *type;
2852 error = ofputil_decode_msg_type(oh, &type);
2857 switch (ofputil_msg_type_code(type)) {
2858 /* OpenFlow requests. */
2859 case OFPUTIL_OFPT_ECHO_REQUEST:
2860 return handle_echo_request(ofconn, oh);
2862 case OFPUTIL_OFPT_FEATURES_REQUEST:
2863 return handle_features_request(ofconn, oh);
2865 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2866 return handle_get_config_request(ofconn, oh);
2868 case OFPUTIL_OFPT_SET_CONFIG:
2869 return handle_set_config(ofconn, msg->data);
2871 case OFPUTIL_OFPT_PACKET_OUT:
2872 return handle_packet_out(ofconn, oh);
2874 case OFPUTIL_OFPT_PORT_MOD:
2875 return handle_port_mod(ofconn, oh);
2877 case OFPUTIL_OFPT_FLOW_MOD:
2878 return handle_flow_mod(ofconn, oh);
2880 case OFPUTIL_OFPT_BARRIER_REQUEST:
2881 return handle_barrier_request(ofconn, oh);
2883 /* OpenFlow replies. */
2884 case OFPUTIL_OFPT_ECHO_REPLY:
2887 /* Nicira extension requests. */
2888 case OFPUTIL_NXT_ROLE_REQUEST:
2889 return handle_role_request(ofconn, oh);
2891 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
2892 return handle_nxt_flow_mod_table_id(ofconn, oh);
2894 case OFPUTIL_NXT_SET_FLOW_FORMAT:
2895 return handle_nxt_set_flow_format(ofconn, oh);
2897 case OFPUTIL_NXT_FLOW_MOD:
2898 return handle_flow_mod(ofconn, oh);
2900 /* Statistics requests. */
2901 case OFPUTIL_OFPST_DESC_REQUEST:
2902 return handle_desc_stats_request(ofconn, msg->data);
2904 case OFPUTIL_OFPST_FLOW_REQUEST:
2905 case OFPUTIL_NXST_FLOW_REQUEST:
2906 return handle_flow_stats_request(ofconn, msg->data);
2908 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
2909 case OFPUTIL_NXST_AGGREGATE_REQUEST:
2910 return handle_aggregate_stats_request(ofconn, msg->data);
2912 case OFPUTIL_OFPST_TABLE_REQUEST:
2913 return handle_table_stats_request(ofconn, msg->data);
2915 case OFPUTIL_OFPST_PORT_REQUEST:
2916 return handle_port_stats_request(ofconn, msg->data);
2918 case OFPUTIL_OFPST_QUEUE_REQUEST:
2919 return handle_queue_stats_request(ofconn, msg->data);
2921 case OFPUTIL_MSG_INVALID:
2922 case OFPUTIL_OFPT_HELLO:
2923 case OFPUTIL_OFPT_ERROR:
2924 case OFPUTIL_OFPT_FEATURES_REPLY:
2925 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
2926 case OFPUTIL_OFPT_PACKET_IN:
2927 case OFPUTIL_OFPT_FLOW_REMOVED:
2928 case OFPUTIL_OFPT_PORT_STATUS:
2929 case OFPUTIL_OFPT_BARRIER_REPLY:
2930 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
2931 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
2932 case OFPUTIL_OFPST_DESC_REPLY:
2933 case OFPUTIL_OFPST_FLOW_REPLY:
2934 case OFPUTIL_OFPST_QUEUE_REPLY:
2935 case OFPUTIL_OFPST_PORT_REPLY:
2936 case OFPUTIL_OFPST_TABLE_REPLY:
2937 case OFPUTIL_OFPST_AGGREGATE_REPLY:
2938 case OFPUTIL_NXT_ROLE_REPLY:
2939 case OFPUTIL_NXT_FLOW_REMOVED:
2940 case OFPUTIL_NXST_FLOW_REPLY:
2941 case OFPUTIL_NXST_AGGREGATE_REPLY:
2943 if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
2944 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2946 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
2952 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
2954 int error = handle_openflow__(ofconn, ofp_msg);
2955 if (error && error != OFPROTO_POSTPONE) {
2956 ofconn_send_error(ofconn, ofp_msg->data, error);
2958 COVERAGE_INC(ofproto_recv_openflow);
2959 return error != OFPROTO_POSTPONE;
2962 /* Asynchronous operations. */
2964 /* Creates and returns a new ofopgroup that is not associated with any
2965 * OpenFlow connection.
2967 * The caller should add operations to the returned group with
2968 * ofoperation_create() and then submit it with ofopgroup_submit(). */
2969 static struct ofopgroup *
2970 ofopgroup_create_unattached(struct ofproto *ofproto)
2972 struct ofopgroup *group = xzalloc(sizeof *group);
2973 group->ofproto = ofproto;
2974 list_init(&group->ofproto_node);
2975 list_init(&group->ops);
2976 list_init(&group->ofconn_node);
2980 /* Creates and returns a new ofopgroup for 'ofproto'.
2982 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
2983 * connection. The 'request' and 'buffer_id' arguments are ignored.
2985 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
2986 * If the ofopgroup eventually fails, then the error reply will include
2987 * 'request'. If the ofopgroup eventually succeeds, then the packet with
2988 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
2990 * The caller should add operations to the returned group with
2991 * ofoperation_create() and then submit it with ofopgroup_submit(). */
2992 static struct ofopgroup *
2993 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
2994 const struct ofp_header *request, uint32_t buffer_id)
2996 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
2998 size_t request_len = ntohs(request->length);
3000 assert(ofconn_get_ofproto(ofconn) == ofproto);
3002 ofconn_add_opgroup(ofconn, &group->ofconn_node);
3003 group->ofconn = ofconn;
3004 group->request = xmemdup(request, MIN(request_len, 64));
3005 group->buffer_id = buffer_id;
3010 /* Submits 'group' for processing.
3012 * If 'group' contains no operations (e.g. none were ever added, or all of the
3013 * ones that were added completed synchronously), then it is destroyed
3014 * immediately. Otherwise it is added to the ofproto's list of pending
3017 ofopgroup_submit(struct ofopgroup *group)
3019 if (list_is_empty(&group->ops)) {
3020 ofopgroup_destroy(group);
3022 list_push_back(&group->ofproto->pending, &group->ofproto_node);
3023 group->ofproto->n_pending++;
3028 ofopgroup_destroy(struct ofopgroup *group)
3030 assert(list_is_empty(&group->ops));
3031 if (!list_is_empty(&group->ofproto_node)) {
3032 assert(group->ofproto->n_pending > 0);
3033 group->ofproto->n_pending--;
3034 list_remove(&group->ofproto_node);
3036 if (!list_is_empty(&group->ofconn_node)) {
3037 list_remove(&group->ofconn_node);
3039 ofconn_send_error(group->ofconn, group->request, group->error);
3041 connmgr_retry(group->ofproto->connmgr);
3043 free(group->request);
3047 /* Initiates a new operation on 'rule', of the specified 'type', within
3048 * 'group'. Prior to calling, 'rule' must not have any pending operation. */
3050 ofoperation_create(struct ofopgroup *group, struct rule *rule,
3051 enum ofoperation_type type)
3053 struct ofoperation *op;
3055 assert(!rule->pending);
3057 op = rule->pending = xzalloc(sizeof *op);
3059 list_push_back(&group->ops, &op->group_node);
3063 op->flow_cookie = rule->flow_cookie;
3065 if (type == OFOPERATION_DELETE) {
3066 hmap_insert(&op->group->ofproto->deletions, &op->hmap_node,
3067 cls_rule_hash(&rule->cr, rule->table_id));
3072 ofoperation_destroy(struct ofoperation *op)
3074 struct ofopgroup *group = op->group;
3077 op->rule->pending = NULL;
3079 if (op->type == OFOPERATION_DELETE) {
3080 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
3082 list_remove(&op->group_node);
3086 if (list_is_empty(&group->ops) && !list_is_empty(&group->ofproto_node)) {
3087 ofopgroup_destroy(group);
3091 /* Indicates that 'op' completed with status 'error', which is either 0 to
3092 * indicate success or an OpenFlow error code (constructed with
3093 * e.g. ofp_mkerr()).
3095 * If 'error' is 0, indicating success, the operation will be committed
3096 * permanently to the flow table. There is one interesting subcase:
3098 * - If 'op' is an "add flow" operation that is replacing an existing rule in
3099 * the flow table (the "victim" rule) by a new one, then the caller must
3100 * have uninitialized any derived state in the victim rule, as in step 5 in
3101 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
3102 * performs steps 6 and 7 for the victim rule, most notably by calling its
3103 * ->rule_dealloc() function.
3105 * If 'error' is nonzero, then generally the operation will be rolled back:
3107 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
3108 * restores the original rule. The caller must have uninitialized any
3109 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
3110 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
3111 * and 7 for the new rule, calling its ->rule_dealloc() function.
3113 * - If 'op' is a "modify flow" operation, ofproto restores the original
3116 * - 'op' must not be a "delete flow" operation. Removing a rule is not
3117 * allowed to fail. It must always succeed.
3119 * Please see the large comment in ofproto/ofproto-provider.h titled
3120 * "Asynchronous Operation Support" for more information. */
3122 ofoperation_complete(struct ofoperation *op, int error)
3124 struct ofopgroup *group = op->group;
3125 struct rule *rule = op->rule;
3126 struct ofproto *ofproto = rule->ofproto;
3127 struct classifier *table = &ofproto->tables[rule->table_id];
3129 assert(rule->pending == op);
3130 assert(op->status < 0);
3135 && op->type != OFOPERATION_DELETE
3137 && group->buffer_id != UINT32_MAX
3138 && list_is_singleton(&op->group_node)) {
3139 struct ofpbuf *packet;
3142 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
3146 error = rule_execute(rule, in_port, packet);
3149 if (!group->error) {
3150 group->error = error;
3154 case OFOPERATION_ADD:
3157 ofproto_rule_destroy__(op->victim);
3159 if (!(rule->cr.wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3160 && ofproto->vlan_bitmap) {
3161 uint16_t vid = vlan_tci_to_vid(rule->cr.flow.vlan_tci);
3163 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
3164 bitmap_set1(ofproto->vlan_bitmap, vid);
3165 ofproto->vlans_changed = true;
3170 classifier_replace(table, &op->victim->cr);
3173 classifier_remove(table, &rule->cr);
3175 ofproto_rule_destroy__(rule);
3180 case OFOPERATION_DELETE:
3182 ofproto_rule_destroy__(rule);
3186 case OFOPERATION_MODIFY:
3188 rule->modified = time_msec();
3190 free(rule->actions);
3191 rule->actions = op->actions;
3192 rule->n_actions = op->n_actions;
3200 ofoperation_destroy(op);
3204 ofoperation_get_victim(struct ofoperation *op)
3206 assert(op->type == OFOPERATION_ADD);
3211 pick_datapath_id(const struct ofproto *ofproto)
3213 const struct ofport *port;
3215 port = ofproto_get_port(ofproto, OFPP_LOCAL);
3217 uint8_t ea[ETH_ADDR_LEN];
3220 error = netdev_get_etheraddr(port->netdev, ea);
3222 return eth_addr_to_uint64(ea);
3224 VLOG_WARN("could not get MAC address for %s (%s)",
3225 netdev_get_name(port->netdev), strerror(error));
3227 return ofproto->fallback_dpid;
3231 pick_fallback_dpid(void)
3233 uint8_t ea[ETH_ADDR_LEN];
3234 eth_addr_nicira_random(ea);
3235 return eth_addr_to_uint64(ea);
3238 /* unixctl commands. */
3241 ofproto_lookup(const char *name)
3243 struct ofproto *ofproto;
3245 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
3247 if (!strcmp(ofproto->name, name)) {
3255 ofproto_unixctl_list(struct unixctl_conn *conn, const char *arg OVS_UNUSED,
3256 void *aux OVS_UNUSED)
3258 struct ofproto *ofproto;
3262 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
3263 ds_put_format(&results, "%s\n", ofproto->name);
3265 unixctl_command_reply(conn, 200, ds_cstr(&results));
3266 ds_destroy(&results);
3270 ofproto_unixctl_init(void)
3272 static bool registered;
3278 unixctl_command_register("ofproto/list", "", ofproto_unixctl_list, NULL);
3281 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
3283 * This is deprecated. It is only for compatibility with broken device drivers
3284 * in old versions of Linux that do not properly support VLANs when VLAN
3285 * devices are not used. When broken device drivers are no longer in
3286 * widespread use, we will delete these interfaces. */
3288 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
3289 * (exactly) by an OpenFlow rule in 'ofproto'. */
3291 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
3293 const struct classifier *cls;
3295 free(ofproto->vlan_bitmap);
3296 ofproto->vlan_bitmap = bitmap_allocate(4096);
3297 ofproto->vlans_changed = false;
3299 OFPROTO_FOR_EACH_TABLE (cls, ofproto) {
3300 const struct cls_table *table;
3302 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
3303 if (!(table->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
3304 const struct cls_rule *rule;
3306 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
3307 uint16_t vid = vlan_tci_to_vid(rule->flow.vlan_tci);
3308 bitmap_set1(vlan_bitmap, vid);
3309 bitmap_set1(ofproto->vlan_bitmap, vid);
3316 /* Returns true if new VLANs have come into use by the flow table since the
3317 * last call to ofproto_get_vlan_usage().
3319 * We don't track when old VLANs stop being used. */
3321 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
3323 return ofproto->vlans_changed;
3326 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
3327 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
3328 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
3329 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
3330 * then the VLAN device is un-enslaved. */
3332 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
3333 uint16_t realdev_ofp_port, int vid)
3335 struct ofport *ofport;
3338 assert(vlandev_ofp_port != realdev_ofp_port);
3340 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
3342 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
3343 ofproto->name, vlandev_ofp_port);
3347 if (!ofproto->ofproto_class->set_realdev) {
3348 if (!vlandev_ofp_port) {
3351 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
3355 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
3357 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
3358 ofproto->name, vlandev_ofp_port,
3359 netdev_get_name(ofport->netdev), strerror(error));