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-errors.h"
35 #include "ofp-print.h"
38 #include "ofproto-provider.h"
39 #include "openflow/nicira-ext.h"
40 #include "openflow/openflow.h"
44 #include "poll-loop.h"
48 #include "unaligned.h"
52 VLOG_DEFINE_THIS_MODULE(ofproto);
54 COVERAGE_DEFINE(ofproto_error);
55 COVERAGE_DEFINE(ofproto_flush);
56 COVERAGE_DEFINE(ofproto_no_packet_in);
57 COVERAGE_DEFINE(ofproto_packet_out);
58 COVERAGE_DEFINE(ofproto_queue_req);
59 COVERAGE_DEFINE(ofproto_recv_openflow);
60 COVERAGE_DEFINE(ofproto_reinit_ports);
61 COVERAGE_DEFINE(ofproto_uninstallable);
62 COVERAGE_DEFINE(ofproto_update_port);
65 S_OPENFLOW, /* Processing OpenFlow commands. */
66 S_FLUSH, /* Deleting all flow table rules. */
69 enum ofoperation_type {
75 /* A single OpenFlow request can execute any number of operations. The
76 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
77 * ofconn to which an error reply should be sent if necessary.
79 * ofproto initiates some operations internally. These operations are still
80 * assigned to groups but will not have an associated ofconn. */
82 struct ofproto *ofproto; /* Owning ofproto. */
83 struct list ofproto_node; /* In ofproto's "pending" list. */
84 struct list ops; /* List of "struct ofoperation"s. */
86 /* Data needed to send OpenFlow reply on failure or to send a buffered
89 * If list_is_empty(ofconn_node) then this ofopgroup never had an
90 * associated ofconn or its ofconn's connection dropped after it initiated
91 * the operation. In the latter case 'ofconn' is a wild pointer that
92 * refers to freed memory, so the 'ofconn' member must be used only if
93 * !list_is_empty(ofconn_node).
95 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
96 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
97 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
98 uint32_t buffer_id; /* Buffer id from original request. */
99 int error; /* 0 if no error yet, otherwise error code. */
102 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
103 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
104 const struct ofp_header *,
106 static void ofopgroup_submit(struct ofopgroup *);
107 static void ofopgroup_destroy(struct ofopgroup *);
109 /* A single flow table operation. */
111 struct ofopgroup *group; /* Owning group. */
112 struct list group_node; /* In ofopgroup's "ops" list. */
113 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
114 struct rule *rule; /* Rule being operated upon. */
115 enum ofoperation_type type; /* Type of operation. */
116 int status; /* -1 if pending, otherwise 0 or error code. */
117 struct rule *victim; /* OFOPERATION_ADDING: Replaced rule. */
118 union ofp_action *actions; /* OFOPERATION_MODIFYING: Replaced actions. */
119 int n_actions; /* OFOPERATION_MODIFYING: # of old actions. */
120 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
123 static void ofoperation_create(struct ofopgroup *, struct rule *,
124 enum ofoperation_type);
125 static void ofoperation_destroy(struct ofoperation *);
127 static void ofport_destroy__(struct ofport *);
128 static void ofport_destroy(struct ofport *);
130 static uint64_t pick_datapath_id(const struct ofproto *);
131 static uint64_t pick_fallback_dpid(void);
133 static void ofproto_destroy__(struct ofproto *);
135 static void ofproto_rule_destroy__(struct rule *);
136 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
138 static void ofopgroup_destroy(struct ofopgroup *);
140 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
141 const struct ofputil_flow_mod *,
142 const struct ofp_header *);
144 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
145 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
146 const struct ofputil_flow_mod *,
147 const struct ofp_header *);
149 static void update_port(struct ofproto *, const char *devname);
150 static int init_ports(struct ofproto *);
151 static void reinit_ports(struct ofproto *);
152 static void set_internal_devs_mtu(struct ofproto *);
154 static void ofproto_unixctl_init(void);
156 /* All registered ofproto classes, in probe order. */
157 static const struct ofproto_class **ofproto_classes;
158 static size_t n_ofproto_classes;
159 static size_t allocated_ofproto_classes;
161 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
162 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
164 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
167 ofproto_initialize(void)
173 ofproto_class_register(&ofproto_dpif_class);
177 /* 'type' should be a normalized datapath type, as returned by
178 * ofproto_normalize_type(). Returns the corresponding ofproto_class
179 * structure, or a null pointer if there is none registered for 'type'. */
180 static const struct ofproto_class *
181 ofproto_class_find__(const char *type)
185 ofproto_initialize();
186 for (i = 0; i < n_ofproto_classes; i++) {
187 const struct ofproto_class *class = ofproto_classes[i];
192 class->enumerate_types(&types);
193 found = sset_contains(&types, type);
194 sset_destroy(&types);
200 VLOG_WARN("unknown datapath type %s", type);
204 /* Registers a new ofproto class. After successful registration, new ofprotos
205 * of that type can be created using ofproto_create(). */
207 ofproto_class_register(const struct ofproto_class *new_class)
211 for (i = 0; i < n_ofproto_classes; i++) {
212 if (ofproto_classes[i] == new_class) {
217 if (n_ofproto_classes >= allocated_ofproto_classes) {
218 ofproto_classes = x2nrealloc(ofproto_classes,
219 &allocated_ofproto_classes,
220 sizeof *ofproto_classes);
222 ofproto_classes[n_ofproto_classes++] = new_class;
226 /* Unregisters a datapath provider. 'type' must have been previously
227 * registered and not currently be in use by any ofprotos. After
228 * unregistration new datapaths of that type cannot be opened using
229 * ofproto_create(). */
231 ofproto_class_unregister(const struct ofproto_class *class)
235 for (i = 0; i < n_ofproto_classes; i++) {
236 if (ofproto_classes[i] == class) {
237 for (i++; i < n_ofproto_classes; i++) {
238 ofproto_classes[i - 1] = ofproto_classes[i];
244 VLOG_WARN("attempted to unregister an ofproto class that is not "
249 /* Clears 'types' and enumerates all registered ofproto types into it. The
250 * caller must first initialize the sset. */
252 ofproto_enumerate_types(struct sset *types)
256 ofproto_initialize();
257 for (i = 0; i < n_ofproto_classes; i++) {
258 ofproto_classes[i]->enumerate_types(types);
262 /* Returns the fully spelled out name for the given ofproto 'type'.
264 * Normalized type string can be compared with strcmp(). Unnormalized type
265 * string might be the same even if they have different spellings. */
267 ofproto_normalize_type(const char *type)
269 return type && type[0] ? type : "system";
272 /* Clears 'names' and enumerates the names of all known created ofprotos with
273 * the given 'type'. The caller must first initialize the sset. Returns 0 if
274 * successful, otherwise a positive errno value.
276 * Some kinds of datapaths might not be practically enumerable. This is not
277 * considered an error. */
279 ofproto_enumerate_names(const char *type, struct sset *names)
281 const struct ofproto_class *class = ofproto_class_find__(type);
282 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
286 ofproto_create(const char *datapath_name, const char *datapath_type,
287 struct ofproto **ofprotop)
289 const struct ofproto_class *class;
290 struct classifier *table;
291 struct ofproto *ofproto;
297 ofproto_initialize();
298 ofproto_unixctl_init();
300 datapath_type = ofproto_normalize_type(datapath_type);
301 class = ofproto_class_find__(datapath_type);
303 VLOG_WARN("could not create datapath %s of unknown type %s",
304 datapath_name, datapath_type);
308 ofproto = class->alloc();
310 VLOG_ERR("failed to allocate datapath %s of type %s",
311 datapath_name, datapath_type);
316 memset(ofproto, 0, sizeof *ofproto);
317 ofproto->ofproto_class = class;
318 ofproto->name = xstrdup(datapath_name);
319 ofproto->type = xstrdup(datapath_type);
320 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
321 hash_string(ofproto->name, 0));
322 ofproto->datapath_id = 0;
323 ofproto_set_flow_eviction_threshold(ofproto,
324 OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT);
325 ofproto->forward_bpdu = false;
326 ofproto->fallback_dpid = pick_fallback_dpid();
327 ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
328 ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
329 ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
330 ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
331 ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
332 ofproto->frag_handling = OFPC_FRAG_NORMAL;
333 hmap_init(&ofproto->ports);
334 shash_init(&ofproto->port_by_name);
335 ofproto->tables = NULL;
336 ofproto->n_tables = 0;
337 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
338 ofproto->state = S_OPENFLOW;
339 list_init(&ofproto->pending);
340 ofproto->n_pending = 0;
341 hmap_init(&ofproto->deletions);
342 ofproto->vlan_bitmap = NULL;
343 ofproto->vlans_changed = false;
345 error = ofproto->ofproto_class->construct(ofproto, &n_tables);
347 VLOG_ERR("failed to open datapath %s: %s",
348 datapath_name, strerror(error));
349 ofproto_destroy__(ofproto);
353 assert(n_tables >= 1 && n_tables <= 255);
354 ofproto->n_tables = n_tables;
355 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
356 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
357 classifier_init(table);
360 ofproto->datapath_id = pick_datapath_id(ofproto);
361 VLOG_INFO("using datapath ID %016"PRIx64, ofproto->datapath_id);
369 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
371 uint64_t old_dpid = p->datapath_id;
372 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
373 if (p->datapath_id != old_dpid) {
374 VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
376 /* Force all active connections to reconnect, since there is no way to
377 * notify a controller that the datapath ID has changed. */
378 ofproto_reconnect_controllers(p);
383 ofproto_set_controllers(struct ofproto *p,
384 const struct ofproto_controller *controllers,
385 size_t n_controllers)
387 connmgr_set_controllers(p->connmgr, controllers, n_controllers);
391 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
393 connmgr_set_fail_mode(p->connmgr, fail_mode);
396 /* Drops the connections between 'ofproto' and all of its controllers, forcing
397 * them to reconnect. */
399 ofproto_reconnect_controllers(struct ofproto *ofproto)
401 connmgr_reconnect(ofproto->connmgr);
404 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
405 * in-band control should guarantee access, in the same way that in-band
406 * control guarantees access to OpenFlow controllers. */
408 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
409 const struct sockaddr_in *extras, size_t n)
411 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
414 /* Sets the OpenFlow queue used by flows set up by in-band control on
415 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
416 * flows will use the default queue. */
418 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
420 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
423 /* Sets the number of flows at which eviction from the kernel flow table
426 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
428 if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
429 ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
431 ofproto->flow_eviction_threshold = threshold;
435 /* If forward_bpdu is true, the NORMAL action will forward frames with
436 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
437 * the NORMAL action will drop these frames. */
439 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
441 bool old_val = ofproto->forward_bpdu;
442 ofproto->forward_bpdu = forward_bpdu;
443 if (old_val != ofproto->forward_bpdu) {
444 if (ofproto->ofproto_class->forward_bpdu_changed) {
445 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
451 ofproto_set_desc(struct ofproto *p,
452 const char *mfr_desc, const char *hw_desc,
453 const char *sw_desc, const char *serial_desc,
456 struct ofp_desc_stats *ods;
459 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
460 VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
461 sizeof ods->mfr_desc);
464 p->mfr_desc = xstrdup(mfr_desc);
467 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
468 VLOG_WARN("truncating hw_desc, must be less than %zu characters",
469 sizeof ods->hw_desc);
472 p->hw_desc = xstrdup(hw_desc);
475 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
476 VLOG_WARN("truncating sw_desc, must be less than %zu characters",
477 sizeof ods->sw_desc);
480 p->sw_desc = xstrdup(sw_desc);
483 if (strlen(serial_desc) >= sizeof ods->serial_num) {
484 VLOG_WARN("truncating serial_desc, must be less than %zu "
486 sizeof ods->serial_num);
488 free(p->serial_desc);
489 p->serial_desc = xstrdup(serial_desc);
492 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
493 VLOG_WARN("truncating dp_desc, must be less than %zu characters",
494 sizeof ods->dp_desc);
497 p->dp_desc = xstrdup(dp_desc);
502 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
504 return connmgr_set_snoops(ofproto->connmgr, snoops);
508 ofproto_set_netflow(struct ofproto *ofproto,
509 const struct netflow_options *nf_options)
511 if (nf_options && sset_is_empty(&nf_options->collectors)) {
515 if (ofproto->ofproto_class->set_netflow) {
516 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
518 return nf_options ? EOPNOTSUPP : 0;
523 ofproto_set_sflow(struct ofproto *ofproto,
524 const struct ofproto_sflow_options *oso)
526 if (oso && sset_is_empty(&oso->targets)) {
530 if (ofproto->ofproto_class->set_sflow) {
531 return ofproto->ofproto_class->set_sflow(ofproto, oso);
533 return oso ? EOPNOTSUPP : 0;
537 /* Spanning Tree Protocol (STP) configuration. */
539 /* Configures STP on 'ofproto' using the settings defined in 's'. If
540 * 's' is NULL, disables STP.
542 * Returns 0 if successful, otherwise a positive errno value. */
544 ofproto_set_stp(struct ofproto *ofproto,
545 const struct ofproto_stp_settings *s)
547 return (ofproto->ofproto_class->set_stp
548 ? ofproto->ofproto_class->set_stp(ofproto, s)
552 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
553 * 'enabled' member of 's' is false, then the other members are not
556 * Returns 0 if successful, otherwise a positive errno value. */
558 ofproto_get_stp_status(struct ofproto *ofproto,
559 struct ofproto_stp_status *s)
561 return (ofproto->ofproto_class->get_stp_status
562 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
566 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
567 * in 's'. The caller is responsible for assigning STP port numbers
568 * (using the 'port_num' member in the range of 1 through 255, inclusive)
569 * and ensuring there are no duplicates. If the 's' is NULL, then STP
570 * is disabled on the port.
572 * Returns 0 if successful, otherwise a positive errno value.*/
574 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
575 const struct ofproto_port_stp_settings *s)
577 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
579 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
580 ofproto->name, ofp_port);
584 return (ofproto->ofproto_class->set_stp_port
585 ? ofproto->ofproto_class->set_stp_port(ofport, s)
589 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
590 * 's'. If the 'enabled' member in 's' is false, then the other members
591 * are not meaningful.
593 * Returns 0 if successful, otherwise a positive errno value.*/
595 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
596 struct ofproto_port_stp_status *s)
598 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
600 VLOG_WARN("%s: cannot get STP status on nonexistent port %"PRIu16,
601 ofproto->name, ofp_port);
605 return (ofproto->ofproto_class->get_stp_port_status
606 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
610 /* Queue DSCP configuration. */
612 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
613 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
614 * to implement QoS. Instead, it is used to implement features which require
615 * knowledge of what queues exist on a port, and some basic information about
618 * Returns 0 if successful, otherwise a positive errno value. */
620 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
621 const struct ofproto_port_queue *queues,
624 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
627 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
628 ofproto->name, ofp_port);
632 return (ofproto->ofproto_class->set_queues
633 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
637 /* Connectivity Fault Management configuration. */
639 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
641 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
643 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
644 if (ofport && ofproto->ofproto_class->set_cfm) {
645 ofproto->ofproto_class->set_cfm(ofport, NULL);
649 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
650 * basic configuration from the configuration members in 'cfm', and the remote
651 * maintenance point ID from remote_mpid. Ignores the statistics members of
654 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
656 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
657 const struct cfm_settings *s)
659 struct ofport *ofport;
662 ofport = ofproto_get_port(ofproto, ofp_port);
664 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
665 ofproto->name, ofp_port);
669 /* XXX: For configuration simplicity, we only support one remote_mpid
670 * outside of the CFM module. It's not clear if this is the correct long
671 * term solution or not. */
672 error = (ofproto->ofproto_class->set_cfm
673 ? ofproto->ofproto_class->set_cfm(ofport, s)
676 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
677 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
682 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
683 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
684 * 0 if LACP partner information is not current (generally indicating a
685 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
687 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
689 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
690 return (ofport && ofproto->ofproto_class->port_is_lacp_current
691 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
697 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
698 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
699 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
700 * configuration plus, if there is more than one slave, a bonding
703 * If 'aux' is already registered then this function updates its configuration
704 * to 's'. Otherwise, this function registers a new bundle.
706 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
709 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
710 const struct ofproto_bundle_settings *s)
712 return (ofproto->ofproto_class->bundle_set
713 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
717 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
718 * If no such bundle has been registered, this has no effect. */
720 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
722 return ofproto_bundle_register(ofproto, aux, NULL);
726 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
727 * If 'aux' is already registered then this function updates its configuration
728 * to 's'. Otherwise, this function registers a new mirror. */
730 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
731 const struct ofproto_mirror_settings *s)
733 return (ofproto->ofproto_class->mirror_set
734 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
738 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
739 * If no mirror has been registered, this has no effect. */
741 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
743 return ofproto_mirror_register(ofproto, aux, NULL);
746 /* Retrieves statistics from mirror associated with client data pointer
747 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
748 * 'bytes', respectively. If a particular counters is not supported,
749 * the appropriate argument is set to UINT64_MAX. */
751 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
752 uint64_t *packets, uint64_t *bytes)
754 if (!ofproto->ofproto_class->mirror_get_stats) {
755 *packets = *bytes = UINT64_MAX;
759 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
763 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
764 * which all packets are flooded, instead of using MAC learning. If
765 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
767 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
770 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
772 return (ofproto->ofproto_class->set_flood_vlans
773 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
777 /* Returns true if 'aux' is a registered bundle that is currently in use as the
778 * output for a mirror. */
780 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
782 return (ofproto->ofproto_class->is_mirror_output_bundle
783 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
788 ofproto_has_snoops(const struct ofproto *ofproto)
790 return connmgr_has_snoops(ofproto->connmgr);
794 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
796 connmgr_get_snoops(ofproto->connmgr, snoops);
800 ofproto_flush__(struct ofproto *ofproto)
802 struct classifier *table;
803 struct ofopgroup *group;
805 if (ofproto->ofproto_class->flush) {
806 ofproto->ofproto_class->flush(ofproto);
809 group = ofopgroup_create_unattached(ofproto);
810 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
811 struct rule *rule, *next_rule;
812 struct cls_cursor cursor;
814 cls_cursor_init(&cursor, table, NULL);
815 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
816 if (!rule->pending) {
817 ofoperation_create(group, rule, OFOPERATION_DELETE);
818 classifier_remove(table, &rule->cr);
819 ofproto->ofproto_class->rule_destruct(rule);
823 ofopgroup_submit(group);
827 ofproto_destroy__(struct ofproto *ofproto)
829 struct classifier *table;
831 assert(list_is_empty(&ofproto->pending));
832 assert(!ofproto->n_pending);
834 connmgr_destroy(ofproto->connmgr);
836 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
839 free(ofproto->mfr_desc);
840 free(ofproto->hw_desc);
841 free(ofproto->sw_desc);
842 free(ofproto->serial_desc);
843 free(ofproto->dp_desc);
844 hmap_destroy(&ofproto->ports);
845 shash_destroy(&ofproto->port_by_name);
847 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
848 assert(classifier_is_empty(table));
849 classifier_destroy(table);
851 free(ofproto->tables);
853 hmap_destroy(&ofproto->deletions);
855 free(ofproto->vlan_bitmap);
857 ofproto->ofproto_class->dealloc(ofproto);
861 ofproto_destroy(struct ofproto *p)
863 struct ofport *ofport, *next_ofport;
870 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
871 ofport_destroy(ofport);
874 p->ofproto_class->destruct(p);
875 ofproto_destroy__(p);
878 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
879 * kernel datapath, for example, this destroys the datapath in the kernel, and
880 * with the netdev-based datapath, it tears down the data structures that
881 * represent the datapath.
883 * The datapath should not be currently open as an ofproto. */
885 ofproto_delete(const char *name, const char *type)
887 const struct ofproto_class *class = ofproto_class_find__(type);
888 return (!class ? EAFNOSUPPORT
889 : !class->del ? EACCES
890 : class->del(type, name));
894 process_port_change(struct ofproto *ofproto, int error, char *devname)
896 if (error == ENOBUFS) {
897 reinit_ports(ofproto);
899 update_port(ofproto, devname);
905 ofproto_run(struct ofproto *p)
907 struct ofport *ofport;
911 error = p->ofproto_class->run(p);
912 if (error && error != EAGAIN) {
913 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, strerror(error));
916 if (p->ofproto_class->port_poll) {
917 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
918 process_port_change(p, error, devname);
922 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
923 unsigned int change_seq = netdev_change_seq(ofport->netdev);
924 if (ofport->change_seq != change_seq) {
925 ofport->change_seq = change_seq;
926 update_port(p, netdev_get_name(ofport->netdev));
933 connmgr_run(p->connmgr, handle_openflow);
937 connmgr_run(p->connmgr, NULL);
939 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
940 connmgr_flushed(p->connmgr);
941 p->state = S_OPENFLOW;
952 /* Performs periodic activity required by 'ofproto' that needs to be done
953 * with the least possible latency.
955 * It makes sense to call this function a couple of times per poll loop, to
956 * provide a significant performance boost on some benchmarks with the
957 * ofproto-dpif implementation. */
959 ofproto_run_fast(struct ofproto *p)
963 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
964 if (error && error != EAGAIN) {
965 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
966 p->name, strerror(error));
972 ofproto_wait(struct ofproto *p)
974 struct ofport *ofport;
976 p->ofproto_class->wait(p);
977 if (p->ofproto_class->port_poll_wait) {
978 p->ofproto_class->port_poll_wait(p);
981 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
982 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
983 poll_immediate_wake();
989 connmgr_wait(p->connmgr, true);
993 connmgr_wait(p->connmgr, false);
994 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
995 poll_immediate_wake();
1002 ofproto_is_alive(const struct ofproto *p)
1004 return connmgr_has_controllers(p->connmgr);
1008 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1011 connmgr_get_controller_info(ofproto->connmgr, info);
1015 ofproto_free_ofproto_controller_info(struct shash *info)
1017 connmgr_free_controller_info(info);
1020 /* Makes a deep copy of 'old' into 'port'. */
1022 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1024 port->name = xstrdup(old->name);
1025 port->type = xstrdup(old->type);
1026 port->ofp_port = old->ofp_port;
1029 /* Frees memory allocated to members of 'ofproto_port'.
1031 * Do not call this function on an ofproto_port obtained from
1032 * ofproto_port_dump_next(): that function retains ownership of the data in the
1035 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1037 free(ofproto_port->name);
1038 free(ofproto_port->type);
1041 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1043 * This function provides no status indication. An error status for the entire
1044 * dump operation is provided when it is completed by calling
1045 * ofproto_port_dump_done().
1048 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1049 const struct ofproto *ofproto)
1051 dump->ofproto = ofproto;
1052 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1056 /* Attempts to retrieve another port from 'dump', which must have been created
1057 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1058 * 'port' and returns true. On failure, returns false.
1060 * Failure might indicate an actual error or merely that the last port has been
1061 * dumped. An error status for the entire dump operation is provided when it
1062 * is completed by calling ofproto_port_dump_done().
1064 * The ofproto owns the data stored in 'port'. It will remain valid until at
1065 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1066 * ofproto_port_dump_done(). */
1068 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1069 struct ofproto_port *port)
1071 const struct ofproto *ofproto = dump->ofproto;
1077 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1080 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1086 /* Completes port table dump operation 'dump', which must have been created
1087 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1088 * error-free, otherwise a positive errno value describing the problem. */
1090 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1092 const struct ofproto *ofproto = dump->ofproto;
1094 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1097 return dump->error == EOF ? 0 : dump->error;
1100 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
1101 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
1102 * is non-null). On failure, returns a positive errno value and sets
1103 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
1105 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1106 uint16_t *ofp_portp)
1111 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
1113 update_port(ofproto, netdev_get_name(netdev));
1116 *ofp_portp = error ? OFPP_NONE : ofp_port;
1121 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1122 * initializes '*port' appropriately; on failure, returns a positive errno
1125 * The caller owns the data in 'ofproto_port' and must free it with
1126 * ofproto_port_destroy() when it is no longer needed. */
1128 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1129 struct ofproto_port *port)
1133 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1135 memset(port, 0, sizeof *port);
1140 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1141 * Returns 0 if successful, otherwise a positive errno. */
1143 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1145 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1146 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1149 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1150 if (!error && ofport) {
1151 /* 'name' is the netdev's name and update_port() is going to close the
1152 * netdev. Just in case update_port() refers to 'name' after it
1153 * destroys 'ofport', make a copy of it around the update_port()
1155 char *devname = xstrdup(name);
1156 update_port(ofproto, devname);
1162 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1163 * performs the 'n_actions' actions in 'actions'. The new flow will not
1166 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1167 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1168 * controllers; otherwise, it will be hidden.
1170 * The caller retains ownership of 'cls_rule' and 'actions'.
1172 * This is a helper function for in-band control and fail-open. */
1174 ofproto_add_flow(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1175 const union ofp_action *actions, size_t n_actions)
1177 const struct rule *rule;
1179 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1180 &ofproto->tables[0], cls_rule));
1181 if (!rule || !ofputil_actions_equal(rule->actions, rule->n_actions,
1182 actions, n_actions)) {
1183 struct ofputil_flow_mod fm;
1185 memset(&fm, 0, sizeof fm);
1187 fm.buffer_id = UINT32_MAX;
1188 fm.actions = (union ofp_action *) actions;
1189 fm.n_actions = n_actions;
1190 add_flow(ofproto, NULL, &fm, NULL);
1194 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1195 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1196 * operation cannot be initiated now but may be retried later.
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;
1749 enum ofp_config_flags flags;
1753 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1754 flags = ofproto->frag_handling;
1755 if (ofconn_get_invalid_ttl_to_controller(ofconn)) {
1756 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1758 osc->flags = htons(flags);
1759 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1760 ofconn_send_reply(ofconn, buf);
1766 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1768 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1769 uint16_t flags = ntohs(osc->flags);
1771 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
1772 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1773 enum ofp_config_flags cur = ofproto->frag_handling;
1774 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
1776 assert((cur & OFPC_FRAG_MASK) == cur);
1778 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
1779 ofproto->frag_handling = next;
1781 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
1783 ofputil_frag_handling_to_string(next));
1787 ofconn_set_invalid_ttl_to_controller(ofconn,
1788 (flags & OFPC_INVALID_TTL_TO_CONTROLLER));
1790 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1795 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1796 * error message code for the caller to propagate upward. Otherwise, returns
1799 * The log message mentions 'msg_type'. */
1801 reject_slave_controller(struct ofconn *ofconn)
1803 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1804 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1805 return OFPERR_OFPBRC_EPERM;
1812 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1814 struct ofproto *p = ofconn_get_ofproto(ofconn);
1815 struct ofp_packet_out *opo;
1816 struct ofpbuf payload, *buffer;
1817 union ofp_action *ofp_actions;
1818 struct ofpbuf request;
1820 size_t n_ofp_actions;
1824 COVERAGE_INC(ofproto_packet_out);
1826 error = reject_slave_controller(ofconn);
1831 /* Get ofp_packet_out. */
1832 ofpbuf_use_const(&request, oh, ntohs(oh->length));
1833 opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1836 error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1837 &ofp_actions, &n_ofp_actions);
1843 if (opo->buffer_id != htonl(UINT32_MAX)) {
1844 error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1846 if (error || !buffer) {
1855 /* Get in_port and partially validate it.
1857 * We don't know what range of ports the ofproto actually implements, but
1858 * we do know that only certain reserved ports (numbered OFPP_MAX and
1859 * above) are valid. */
1860 in_port = ntohs(opo->in_port);
1861 if (in_port >= OFPP_MAX && in_port != OFPP_LOCAL && in_port != OFPP_NONE) {
1862 return OFPERR_NXBRC_BAD_IN_PORT;
1865 /* Send out packet. */
1866 flow_extract(&payload, 0, 0, in_port, &flow);
1867 error = p->ofproto_class->packet_out(p, &payload, &flow,
1868 ofp_actions, n_ofp_actions);
1869 ofpbuf_delete(buffer);
1875 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1877 ovs_be32 old_config = port->opp.config;
1879 mask &= config ^ port->opp.config;
1880 if (mask & htonl(OFPPC_PORT_DOWN)) {
1881 if (config & htonl(OFPPC_PORT_DOWN)) {
1882 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1884 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1888 port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1889 OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1890 OFPPC_NO_PACKET_IN));
1891 if (port->opp.config != old_config) {
1892 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1897 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1899 struct ofproto *p = ofconn_get_ofproto(ofconn);
1900 const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1901 struct ofport *port;
1904 error = reject_slave_controller(ofconn);
1909 port = ofproto_get_port(p, ntohs(opm->port_no));
1911 return OFPERR_OFPPMFC_BAD_PORT;
1912 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1913 return OFPERR_OFPPMFC_BAD_HW_ADDR;
1915 update_port_config(port, opm->config, opm->mask);
1916 if (opm->advertise) {
1917 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1924 handle_desc_stats_request(struct ofconn *ofconn,
1925 const struct ofp_stats_msg *request)
1927 struct ofproto *p = ofconn_get_ofproto(ofconn);
1928 struct ofp_desc_stats *ods;
1931 ods = ofputil_make_stats_reply(sizeof *ods, request, &msg);
1932 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1933 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1934 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1935 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1936 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1937 ofconn_send_reply(ofconn, msg);
1943 handle_table_stats_request(struct ofconn *ofconn,
1944 const struct ofp_stats_msg *request)
1946 struct ofproto *p = ofconn_get_ofproto(ofconn);
1947 struct ofp_table_stats *ots;
1951 ofputil_make_stats_reply(sizeof(struct ofp_stats_msg), request, &msg);
1953 ots = ofpbuf_put_zeros(msg, sizeof *ots * p->n_tables);
1954 for (i = 0; i < p->n_tables; i++) {
1955 ots[i].table_id = i;
1956 sprintf(ots[i].name, "table%zu", i);
1957 ots[i].wildcards = htonl(OFPFW_ALL);
1958 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
1959 ots[i].active_count = htonl(classifier_count(&p->tables[i]));
1962 p->ofproto_class->get_tables(p, ots);
1964 ofconn_send_reply(ofconn, msg);
1969 append_port_stat(struct ofport *port, struct list *replies)
1971 struct netdev_stats stats;
1972 struct ofp_port_stats *ops;
1974 /* Intentionally ignore return value, since errors will set
1975 * 'stats' to all-1s, which is correct for OpenFlow, and
1976 * netdev_get_stats() will log errors. */
1977 ofproto_port_get_stats(port, &stats);
1979 ops = ofputil_append_stats_reply(sizeof *ops, replies);
1980 ops->port_no = port->opp.port_no;
1981 memset(ops->pad, 0, sizeof ops->pad);
1982 put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
1983 put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
1984 put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
1985 put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
1986 put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
1987 put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
1988 put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
1989 put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
1990 put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
1991 put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
1992 put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
1993 put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
1997 handle_port_stats_request(struct ofconn *ofconn,
1998 const struct ofp_port_stats_request *psr)
2000 struct ofproto *p = ofconn_get_ofproto(ofconn);
2001 struct ofport *port;
2002 struct list replies;
2004 ofputil_start_stats_reply(&psr->osm, &replies);
2005 if (psr->port_no != htons(OFPP_NONE)) {
2006 port = ofproto_get_port(p, ntohs(psr->port_no));
2008 append_port_stat(port, &replies);
2011 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2012 append_port_stat(port, &replies);
2016 ofconn_send_replies(ofconn, &replies);
2021 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
2023 long long int msecs = time_msec() - start;
2024 *sec = msecs / 1000;
2025 *nsec = (msecs % 1000) * (1000 * 1000);
2028 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2029 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2031 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2033 return (table_id == 0xff || table_id < ofproto->n_tables
2035 : OFPERR_NXBRC_BAD_TABLE_ID);
2039 static struct classifier *
2040 first_matching_table(struct ofproto *ofproto, uint8_t table_id)
2042 if (table_id == 0xff) {
2043 return &ofproto->tables[0];
2044 } else if (table_id < ofproto->n_tables) {
2045 return &ofproto->tables[table_id];
2051 static struct classifier *
2052 next_matching_table(struct ofproto *ofproto,
2053 struct classifier *cls, uint8_t table_id)
2055 return (table_id == 0xff && cls != &ofproto->tables[ofproto->n_tables - 1]
2060 /* Assigns CLS to each classifier table, in turn, that matches TABLE_ID in
2063 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2066 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2067 * only once, for that table.
2069 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2070 * entered at all. (Perhaps you should have validated TABLE_ID with
2071 * check_table_id().)
2073 * All parameters are evaluated multiple times.
2075 #define FOR_EACH_MATCHING_TABLE(CLS, TABLE_ID, OFPROTO) \
2076 for ((CLS) = first_matching_table(OFPROTO, TABLE_ID); \
2078 (CLS) = next_matching_table(OFPROTO, CLS, TABLE_ID))
2080 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2081 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2082 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2085 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2086 * to 'out_port' are included.
2088 * Hidden rules are always omitted.
2090 * Returns 0 on success, otherwise an OpenFlow error code. */
2092 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2093 const struct cls_rule *match,
2094 ovs_be64 cookie, ovs_be64 cookie_mask,
2095 uint16_t out_port, struct list *rules)
2097 struct classifier *cls;
2100 error = check_table_id(ofproto, table_id);
2106 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
2107 struct cls_cursor cursor;
2110 cls_cursor_init(&cursor, cls, match);
2111 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2112 if (rule->pending) {
2113 return OFPROTO_POSTPONE;
2115 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2116 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2117 list_push_back(rules, &rule->ofproto_node);
2124 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2125 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2126 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2129 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2130 * to 'out_port' are included.
2132 * Hidden rules are always omitted.
2134 * Returns 0 on success, otherwise an OpenFlow error code. */
2136 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2137 const struct cls_rule *match,
2138 ovs_be64 cookie, ovs_be64 cookie_mask,
2139 uint16_t out_port, struct list *rules)
2141 struct classifier *cls;
2144 error = check_table_id(ofproto, table_id);
2150 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
2153 rule = rule_from_cls_rule(classifier_find_rule_exactly(cls, match));
2155 if (rule->pending) {
2156 return OFPROTO_POSTPONE;
2158 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2159 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2160 list_push_back(rules, &rule->ofproto_node);
2168 handle_flow_stats_request(struct ofconn *ofconn,
2169 const struct ofp_stats_msg *osm)
2171 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2172 struct ofputil_flow_stats_request fsr;
2173 struct list replies;
2178 error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
2183 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2184 fsr.cookie, fsr.cookie_mask,
2185 fsr.out_port, &rules);
2190 ofputil_start_stats_reply(osm, &replies);
2191 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2192 struct ofputil_flow_stats fs;
2195 fs.cookie = rule->flow_cookie;
2196 fs.table_id = rule->table_id;
2197 calc_flow_duration__(rule->created, &fs.duration_sec,
2199 fs.idle_timeout = rule->idle_timeout;
2200 fs.hard_timeout = rule->hard_timeout;
2201 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2203 fs.actions = rule->actions;
2204 fs.n_actions = rule->n_actions;
2205 ofputil_append_flow_stats_reply(&fs, &replies);
2207 ofconn_send_replies(ofconn, &replies);
2213 flow_stats_ds(struct rule *rule, struct ds *results)
2215 uint64_t packet_count, byte_count;
2217 rule->ofproto->ofproto_class->rule_get_stats(rule,
2218 &packet_count, &byte_count);
2220 if (rule->table_id != 0) {
2221 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2223 ds_put_format(results, "duration=%llds, ",
2224 (time_msec() - rule->created) / 1000);
2225 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2226 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2227 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2228 cls_rule_format(&rule->cr, results);
2229 ds_put_char(results, ',');
2230 if (rule->n_actions > 0) {
2231 ofp_print_actions(results, rule->actions, rule->n_actions);
2233 ds_put_cstr(results, "drop");
2235 ds_put_cstr(results, "\n");
2238 /* Adds a pretty-printed description of all flows to 'results', including
2239 * hidden flows (e.g., set up by in-band control). */
2241 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2243 struct classifier *cls;
2245 OFPROTO_FOR_EACH_TABLE (cls, p) {
2246 struct cls_cursor cursor;
2249 cls_cursor_init(&cursor, cls, NULL);
2250 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2251 flow_stats_ds(rule, results);
2256 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2257 * '*engine_type' and '*engine_id', respectively. */
2259 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2260 uint8_t *engine_type, uint8_t *engine_id)
2262 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2265 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns 1
2266 * if CFM is faulted (generally indiciating a connectivity problem), 0 if CFM
2267 * is not faulted, and -1 if CFM is not enabled on 'ofp_port'. */
2269 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2271 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2272 return (ofport && ofproto->ofproto_class->get_cfm_fault
2273 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2277 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2278 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2279 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2280 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2282 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2283 uint16_t ofp_port, const uint64_t **rmps,
2286 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2290 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2291 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2297 handle_aggregate_stats_request(struct ofconn *ofconn,
2298 const struct ofp_stats_msg *osm)
2300 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2301 struct ofputil_flow_stats_request request;
2302 struct ofputil_aggregate_stats stats;
2303 bool unknown_packets, unknown_bytes;
2304 struct ofpbuf *reply;
2309 error = ofputil_decode_flow_stats_request(&request, &osm->header);
2314 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2315 request.cookie, request.cookie_mask,
2316 request.out_port, &rules);
2321 memset(&stats, 0, sizeof stats);
2322 unknown_packets = unknown_bytes = false;
2323 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2324 uint64_t packet_count;
2325 uint64_t byte_count;
2327 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2330 if (packet_count == UINT64_MAX) {
2331 unknown_packets = true;
2333 stats.packet_count += packet_count;
2336 if (byte_count == UINT64_MAX) {
2337 unknown_bytes = true;
2339 stats.byte_count += byte_count;
2344 if (unknown_packets) {
2345 stats.packet_count = UINT64_MAX;
2347 if (unknown_bytes) {
2348 stats.byte_count = UINT64_MAX;
2351 reply = ofputil_encode_aggregate_stats_reply(&stats, osm);
2352 ofconn_send_reply(ofconn, reply);
2357 struct queue_stats_cbdata {
2358 struct ofport *ofport;
2359 struct list replies;
2363 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2364 const struct netdev_queue_stats *stats)
2366 struct ofp_queue_stats *reply;
2368 reply = ofputil_append_stats_reply(sizeof *reply, &cbdata->replies);
2369 reply->port_no = cbdata->ofport->opp.port_no;
2370 memset(reply->pad, 0, sizeof reply->pad);
2371 reply->queue_id = htonl(queue_id);
2372 put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2373 put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2374 put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2378 handle_queue_stats_dump_cb(uint32_t queue_id,
2379 struct netdev_queue_stats *stats,
2382 struct queue_stats_cbdata *cbdata = cbdata_;
2384 put_queue_stats(cbdata, queue_id, stats);
2388 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2389 struct queue_stats_cbdata *cbdata)
2391 cbdata->ofport = port;
2392 if (queue_id == OFPQ_ALL) {
2393 netdev_dump_queue_stats(port->netdev,
2394 handle_queue_stats_dump_cb, cbdata);
2396 struct netdev_queue_stats stats;
2398 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2399 put_queue_stats(cbdata, queue_id, &stats);
2405 handle_queue_stats_request(struct ofconn *ofconn,
2406 const struct ofp_queue_stats_request *qsr)
2408 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2409 struct queue_stats_cbdata cbdata;
2410 struct ofport *port;
2411 unsigned int port_no;
2414 COVERAGE_INC(ofproto_queue_req);
2416 ofputil_start_stats_reply(&qsr->osm, &cbdata.replies);
2418 port_no = ntohs(qsr->port_no);
2419 queue_id = ntohl(qsr->queue_id);
2420 if (port_no == OFPP_ALL) {
2421 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2422 handle_queue_stats_for_port(port, queue_id, &cbdata);
2424 } else if (port_no < OFPP_MAX) {
2425 port = ofproto_get_port(ofproto, port_no);
2427 handle_queue_stats_for_port(port, queue_id, &cbdata);
2430 ofpbuf_list_delete(&cbdata.replies);
2431 return OFPERR_OFPQOFC_BAD_PORT;
2433 ofconn_send_replies(ofconn, &cbdata.replies);
2439 is_flow_deletion_pending(const struct ofproto *ofproto,
2440 const struct cls_rule *cls_rule,
2443 if (!hmap_is_empty(&ofproto->deletions)) {
2444 struct ofoperation *op;
2446 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2447 cls_rule_hash(cls_rule, table_id),
2448 &ofproto->deletions) {
2449 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2458 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2459 * in which no matching flow already exists in the flow table.
2461 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2462 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
2463 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
2464 * initiated now but may be retried later.
2466 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2469 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
2470 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
2472 struct classifier *table;
2473 struct ofopgroup *group;
2474 struct rule *victim;
2478 error = check_table_id(ofproto, fm->table_id);
2484 if (fm->table_id == 0xff) {
2486 if (ofproto->ofproto_class->rule_choose_table) {
2487 error = ofproto->ofproto_class->rule_choose_table(ofproto, &fm->cr,
2492 assert(table_id < ofproto->n_tables);
2493 table = &ofproto->tables[table_id];
2495 table = &ofproto->tables[0];
2497 } else if (fm->table_id < ofproto->n_tables) {
2498 table = &ofproto->tables[fm->table_id];
2500 return OFPERR_NXFMFC_BAD_TABLE_ID;
2503 /* Check for overlap, if requested. */
2504 if (fm->flags & OFPFF_CHECK_OVERLAP
2505 && classifier_rule_overlaps(table, &fm->cr)) {
2506 return OFPERR_OFPFMFC_OVERLAP;
2509 /* Serialize against pending deletion. */
2510 if (is_flow_deletion_pending(ofproto, &fm->cr, table - ofproto->tables)) {
2511 return OFPROTO_POSTPONE;
2514 /* Allocate new rule. */
2515 rule = ofproto->ofproto_class->rule_alloc();
2517 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2518 ofproto->name, strerror(error));
2521 rule->ofproto = ofproto;
2523 rule->pending = NULL;
2524 rule->flow_cookie = fm->cookie;
2525 rule->created = rule->modified = time_msec();
2526 rule->idle_timeout = fm->idle_timeout;
2527 rule->hard_timeout = fm->hard_timeout;
2528 rule->table_id = table - ofproto->tables;
2529 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2530 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2531 rule->n_actions = fm->n_actions;
2533 /* Insert new rule. */
2534 victim = rule_from_cls_rule(classifier_replace(table, &rule->cr));
2535 if (victim && victim->pending) {
2536 error = OFPROTO_POSTPONE;
2538 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2539 ofoperation_create(group, rule, OFOPERATION_ADD);
2540 rule->pending->victim = victim;
2542 error = ofproto->ofproto_class->rule_construct(rule);
2544 ofoperation_destroy(rule->pending);
2546 ofopgroup_submit(group);
2549 /* Back out if an error occurred. */
2552 classifier_replace(table, &victim->cr);
2554 classifier_remove(table, &rule->cr);
2556 ofproto_rule_destroy__(rule);
2561 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2563 /* Modifies the rules listed in 'rules', changing their actions to match those
2566 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2569 * Returns 0 on success, otherwise an OpenFlow error code. */
2571 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2572 const struct ofputil_flow_mod *fm,
2573 const struct ofp_header *request, struct list *rules)
2575 struct ofopgroup *group;
2578 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2579 LIST_FOR_EACH (rule, ofproto_node, rules) {
2580 if (!ofputil_actions_equal(fm->actions, fm->n_actions,
2581 rule->actions, rule->n_actions)) {
2582 ofoperation_create(group, rule, OFOPERATION_MODIFY);
2583 rule->pending->actions = rule->actions;
2584 rule->pending->n_actions = rule->n_actions;
2585 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2586 rule->n_actions = fm->n_actions;
2587 rule->ofproto->ofproto_class->rule_modify_actions(rule);
2589 rule->modified = time_msec();
2591 rule->flow_cookie = fm->cookie;
2593 ofopgroup_submit(group);
2598 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
2601 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2604 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2605 const struct ofputil_flow_mod *fm,
2606 const struct ofp_header *request)
2611 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2612 fm->cookie, fm->cookie_mask,
2614 return (error ? error
2615 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2616 : modify_flows__(ofproto, ofconn, fm, request, &rules));
2619 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2622 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2625 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2626 const struct ofputil_flow_mod *fm,
2627 const struct ofp_header *request)
2632 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2633 fm->cookie, fm->cookie_mask,
2635 return (error ? error
2636 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2637 : list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
2638 fm, request, &rules)
2642 /* OFPFC_DELETE implementation. */
2644 /* Deletes the rules listed in 'rules'.
2646 * Returns 0 on success, otherwise an OpenFlow error code. */
2648 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2649 const struct ofp_header *request, struct list *rules)
2651 struct rule *rule, *next;
2652 struct ofopgroup *group;
2654 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
2655 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
2656 ofproto_rule_send_removed(rule, OFPRR_DELETE);
2658 ofoperation_create(group, rule, OFOPERATION_DELETE);
2659 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2660 rule->ofproto->ofproto_class->rule_destruct(rule);
2662 ofopgroup_submit(group);
2667 /* Implements OFPFC_DELETE. */
2669 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2670 const struct ofputil_flow_mod *fm,
2671 const struct ofp_header *request)
2676 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2677 fm->cookie, fm->cookie_mask,
2678 fm->out_port, &rules);
2679 return (error ? error
2680 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
2685 /* Implements OFPFC_DELETE_STRICT. */
2687 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2688 const struct ofputil_flow_mod *fm,
2689 const struct ofp_header *request)
2694 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2695 fm->cookie, fm->cookie_mask,
2696 fm->out_port, &rules);
2697 return (error ? error
2698 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
2704 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2706 struct ofputil_flow_removed fr;
2708 if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2713 fr.cookie = rule->flow_cookie;
2715 calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2716 fr.idle_timeout = rule->idle_timeout;
2717 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2720 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2723 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2724 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2727 * ofproto implementation ->run() functions should use this function to expire
2728 * OpenFlow flows. */
2730 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2732 struct ofproto *ofproto = rule->ofproto;
2733 struct ofopgroup *group;
2735 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2737 ofproto_rule_send_removed(rule, reason);
2739 group = ofopgroup_create_unattached(ofproto);
2740 ofoperation_create(group, rule, OFOPERATION_DELETE);
2741 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2742 rule->ofproto->ofproto_class->rule_destruct(rule);
2743 ofopgroup_submit(group);
2747 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2749 struct ofputil_flow_mod fm;
2752 error = reject_slave_controller(ofconn);
2757 error = ofputil_decode_flow_mod(&fm, oh,
2758 ofconn_get_flow_mod_table_id(ofconn));
2763 /* We do not support the emergency flow cache. It will hopefully get
2764 * dropped from OpenFlow in the near future. */
2765 if (fm.flags & OFPFF_EMERG) {
2766 /* There isn't a good fit for an error code, so just state that the
2767 * flow table is full. */
2768 return OFPERR_OFPFMFC_ALL_TABLES_FULL;
2771 return handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
2775 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
2776 const struct ofputil_flow_mod *fm,
2777 const struct ofp_header *oh)
2779 if (ofproto->n_pending >= 50) {
2780 assert(!list_is_empty(&ofproto->pending));
2781 return OFPROTO_POSTPONE;
2784 switch (fm->command) {
2786 return add_flow(ofproto, ofconn, fm, oh);
2789 return modify_flows_loose(ofproto, ofconn, fm, oh);
2791 case OFPFC_MODIFY_STRICT:
2792 return modify_flow_strict(ofproto, ofconn, fm, oh);
2795 return delete_flows_loose(ofproto, ofconn, fm, oh);
2797 case OFPFC_DELETE_STRICT:
2798 return delete_flow_strict(ofproto, ofconn, fm, oh);
2801 if (fm->command > 0xff) {
2802 VLOG_WARN_RL(&rl, "flow_mod has explicit table_id but "
2803 "flow_mod_table_id extension is not enabled");
2805 return OFPERR_OFPFMFC_BAD_COMMAND;
2810 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2812 struct nx_role_request *nrr = (struct nx_role_request *) oh;
2813 struct nx_role_request *reply;
2817 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2818 return OFPERR_OFPBRC_EPERM;
2821 role = ntohl(nrr->role);
2822 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2823 && role != NX_ROLE_SLAVE) {
2824 return OFPERR_NXBRC_BAD_ROLE;
2827 if (ofconn_get_role(ofconn) != role
2828 && ofconn_has_pending_opgroups(ofconn)) {
2829 return OFPROTO_POSTPONE;
2832 ofconn_set_role(ofconn, role);
2834 reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2835 reply->role = htonl(role);
2836 ofconn_send_reply(ofconn, buf);
2842 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
2843 const struct ofp_header *oh)
2845 const struct nx_flow_mod_table_id *msg
2846 = (const struct nx_flow_mod_table_id *) oh;
2848 ofconn_set_flow_mod_table_id(ofconn, msg->set != 0);
2853 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2855 const struct nx_set_flow_format *msg
2856 = (const struct nx_set_flow_format *) oh;
2859 format = ntohl(msg->format);
2860 if (format != NXFF_OPENFLOW10 && format != NXFF_NXM) {
2861 return OFPERR_OFPBRC_EPERM;
2864 if (format != ofconn_get_flow_format(ofconn)
2865 && ofconn_has_pending_opgroups(ofconn)) {
2866 /* Avoid sending async messages in surprising flow format. */
2867 return OFPROTO_POSTPONE;
2870 ofconn_set_flow_format(ofconn, format);
2875 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
2876 const struct ofp_header *oh)
2878 const struct nx_set_packet_in_format *msg;
2881 msg = (const struct nx_set_packet_in_format *) oh;
2882 format = ntohl(msg->format);
2883 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
2884 return OFPERR_OFPBRC_EPERM;
2887 if (format != ofconn_get_packet_in_format(ofconn)
2888 && ofconn_has_pending_opgroups(ofconn)) {
2889 /* Avoid sending async message in surprsing packet in format. */
2890 return OFPROTO_POSTPONE;
2893 ofconn_set_packet_in_format(ofconn, format);
2898 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2900 struct ofp_header *ob;
2903 if (ofconn_has_pending_opgroups(ofconn)) {
2904 return OFPROTO_POSTPONE;
2907 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2908 ofconn_send_reply(ofconn, buf);
2913 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2915 const struct ofp_header *oh = msg->data;
2916 const struct ofputil_msg_type *type;
2919 error = ofputil_decode_msg_type(oh, &type);
2924 switch (ofputil_msg_type_code(type)) {
2925 /* OpenFlow requests. */
2926 case OFPUTIL_OFPT_ECHO_REQUEST:
2927 return handle_echo_request(ofconn, oh);
2929 case OFPUTIL_OFPT_FEATURES_REQUEST:
2930 return handle_features_request(ofconn, oh);
2932 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2933 return handle_get_config_request(ofconn, oh);
2935 case OFPUTIL_OFPT_SET_CONFIG:
2936 return handle_set_config(ofconn, msg->data);
2938 case OFPUTIL_OFPT_PACKET_OUT:
2939 return handle_packet_out(ofconn, oh);
2941 case OFPUTIL_OFPT_PORT_MOD:
2942 return handle_port_mod(ofconn, oh);
2944 case OFPUTIL_OFPT_FLOW_MOD:
2945 return handle_flow_mod(ofconn, oh);
2947 case OFPUTIL_OFPT_BARRIER_REQUEST:
2948 return handle_barrier_request(ofconn, oh);
2950 /* OpenFlow replies. */
2951 case OFPUTIL_OFPT_ECHO_REPLY:
2954 /* Nicira extension requests. */
2955 case OFPUTIL_NXT_ROLE_REQUEST:
2956 return handle_role_request(ofconn, oh);
2958 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
2959 return handle_nxt_flow_mod_table_id(ofconn, oh);
2961 case OFPUTIL_NXT_SET_FLOW_FORMAT:
2962 return handle_nxt_set_flow_format(ofconn, oh);
2964 case OFPUTIL_NXT_SET_PACKET_IN_FORMAT:
2965 return handle_nxt_set_packet_in_format(ofconn, oh);
2967 case OFPUTIL_NXT_FLOW_MOD:
2968 return handle_flow_mod(ofconn, oh);
2970 /* Statistics requests. */
2971 case OFPUTIL_OFPST_DESC_REQUEST:
2972 return handle_desc_stats_request(ofconn, msg->data);
2974 case OFPUTIL_OFPST_FLOW_REQUEST:
2975 case OFPUTIL_NXST_FLOW_REQUEST:
2976 return handle_flow_stats_request(ofconn, msg->data);
2978 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
2979 case OFPUTIL_NXST_AGGREGATE_REQUEST:
2980 return handle_aggregate_stats_request(ofconn, msg->data);
2982 case OFPUTIL_OFPST_TABLE_REQUEST:
2983 return handle_table_stats_request(ofconn, msg->data);
2985 case OFPUTIL_OFPST_PORT_REQUEST:
2986 return handle_port_stats_request(ofconn, msg->data);
2988 case OFPUTIL_OFPST_QUEUE_REQUEST:
2989 return handle_queue_stats_request(ofconn, msg->data);
2991 case OFPUTIL_MSG_INVALID:
2992 case OFPUTIL_OFPT_HELLO:
2993 case OFPUTIL_OFPT_ERROR:
2994 case OFPUTIL_OFPT_FEATURES_REPLY:
2995 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
2996 case OFPUTIL_OFPT_PACKET_IN:
2997 case OFPUTIL_OFPT_FLOW_REMOVED:
2998 case OFPUTIL_OFPT_PORT_STATUS:
2999 case OFPUTIL_OFPT_BARRIER_REPLY:
3000 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
3001 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
3002 case OFPUTIL_OFPST_DESC_REPLY:
3003 case OFPUTIL_OFPST_FLOW_REPLY:
3004 case OFPUTIL_OFPST_QUEUE_REPLY:
3005 case OFPUTIL_OFPST_PORT_REPLY:
3006 case OFPUTIL_OFPST_TABLE_REPLY:
3007 case OFPUTIL_OFPST_AGGREGATE_REPLY:
3008 case OFPUTIL_NXT_ROLE_REPLY:
3009 case OFPUTIL_NXT_FLOW_REMOVED:
3010 case OFPUTIL_NXT_PACKET_IN:
3011 case OFPUTIL_NXST_FLOW_REPLY:
3012 case OFPUTIL_NXST_AGGREGATE_REPLY:
3014 if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
3015 return OFPERR_OFPBRC_BAD_STAT;
3017 return OFPERR_OFPBRC_BAD_TYPE;
3023 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
3025 int error = handle_openflow__(ofconn, ofp_msg);
3026 if (error && error != OFPROTO_POSTPONE) {
3027 ofconn_send_error(ofconn, ofp_msg->data, error);
3029 COVERAGE_INC(ofproto_recv_openflow);
3030 return error != OFPROTO_POSTPONE;
3033 /* Asynchronous operations. */
3035 /* Creates and returns a new ofopgroup that is not associated with any
3036 * OpenFlow connection.
3038 * The caller should add operations to the returned group with
3039 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3040 static struct ofopgroup *
3041 ofopgroup_create_unattached(struct ofproto *ofproto)
3043 struct ofopgroup *group = xzalloc(sizeof *group);
3044 group->ofproto = ofproto;
3045 list_init(&group->ofproto_node);
3046 list_init(&group->ops);
3047 list_init(&group->ofconn_node);
3051 /* Creates and returns a new ofopgroup for 'ofproto'.
3053 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
3054 * connection. The 'request' and 'buffer_id' arguments are ignored.
3056 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
3057 * If the ofopgroup eventually fails, then the error reply will include
3058 * 'request'. If the ofopgroup eventually succeeds, then the packet with
3059 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
3061 * The caller should add operations to the returned group with
3062 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3063 static struct ofopgroup *
3064 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
3065 const struct ofp_header *request, uint32_t buffer_id)
3067 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3069 size_t request_len = ntohs(request->length);
3071 assert(ofconn_get_ofproto(ofconn) == ofproto);
3073 ofconn_add_opgroup(ofconn, &group->ofconn_node);
3074 group->ofconn = ofconn;
3075 group->request = xmemdup(request, MIN(request_len, 64));
3076 group->buffer_id = buffer_id;
3081 /* Submits 'group' for processing.
3083 * If 'group' contains no operations (e.g. none were ever added, or all of the
3084 * ones that were added completed synchronously), then it is destroyed
3085 * immediately. Otherwise it is added to the ofproto's list of pending
3088 ofopgroup_submit(struct ofopgroup *group)
3090 if (list_is_empty(&group->ops)) {
3091 ofopgroup_destroy(group);
3093 list_push_back(&group->ofproto->pending, &group->ofproto_node);
3094 group->ofproto->n_pending++;
3099 ofopgroup_destroy(struct ofopgroup *group)
3101 assert(list_is_empty(&group->ops));
3102 if (!list_is_empty(&group->ofproto_node)) {
3103 assert(group->ofproto->n_pending > 0);
3104 group->ofproto->n_pending--;
3105 list_remove(&group->ofproto_node);
3107 if (!list_is_empty(&group->ofconn_node)) {
3108 list_remove(&group->ofconn_node);
3110 ofconn_send_error(group->ofconn, group->request, group->error);
3112 connmgr_retry(group->ofproto->connmgr);
3114 free(group->request);
3118 /* Initiates a new operation on 'rule', of the specified 'type', within
3119 * 'group'. Prior to calling, 'rule' must not have any pending operation. */
3121 ofoperation_create(struct ofopgroup *group, struct rule *rule,
3122 enum ofoperation_type type)
3124 struct ofoperation *op;
3126 assert(!rule->pending);
3128 op = rule->pending = xzalloc(sizeof *op);
3130 list_push_back(&group->ops, &op->group_node);
3134 op->flow_cookie = rule->flow_cookie;
3136 if (type == OFOPERATION_DELETE) {
3137 hmap_insert(&op->group->ofproto->deletions, &op->hmap_node,
3138 cls_rule_hash(&rule->cr, rule->table_id));
3143 ofoperation_destroy(struct ofoperation *op)
3145 struct ofopgroup *group = op->group;
3148 op->rule->pending = NULL;
3150 if (op->type == OFOPERATION_DELETE) {
3151 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
3153 list_remove(&op->group_node);
3157 if (list_is_empty(&group->ops) && !list_is_empty(&group->ofproto_node)) {
3158 ofopgroup_destroy(group);
3162 /* Indicates that 'op' completed with status 'error', which is either 0 to
3163 * indicate success or an OpenFlow error code on failure.
3165 * If 'error' is 0, indicating success, the operation will be committed
3166 * permanently to the flow table. There is one interesting subcase:
3168 * - If 'op' is an "add flow" operation that is replacing an existing rule in
3169 * the flow table (the "victim" rule) by a new one, then the caller must
3170 * have uninitialized any derived state in the victim rule, as in step 5 in
3171 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
3172 * performs steps 6 and 7 for the victim rule, most notably by calling its
3173 * ->rule_dealloc() function.
3175 * If 'error' is nonzero, then generally the operation will be rolled back:
3177 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
3178 * restores the original rule. The caller must have uninitialized any
3179 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
3180 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
3181 * and 7 for the new rule, calling its ->rule_dealloc() function.
3183 * - If 'op' is a "modify flow" operation, ofproto restores the original
3186 * - 'op' must not be a "delete flow" operation. Removing a rule is not
3187 * allowed to fail. It must always succeed.
3189 * Please see the large comment in ofproto/ofproto-provider.h titled
3190 * "Asynchronous Operation Support" for more information. */
3192 ofoperation_complete(struct ofoperation *op, enum ofperr error)
3194 struct ofopgroup *group = op->group;
3195 struct rule *rule = op->rule;
3196 struct ofproto *ofproto = rule->ofproto;
3197 struct classifier *table = &ofproto->tables[rule->table_id];
3199 assert(rule->pending == op);
3200 assert(op->status < 0);
3204 && op->type != OFOPERATION_DELETE
3206 && group->buffer_id != UINT32_MAX
3207 && list_is_singleton(&op->group_node)) {
3208 struct ofpbuf *packet;
3211 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
3215 error = rule_execute(rule, in_port, packet);
3218 if (!group->error) {
3219 group->error = error;
3223 case OFOPERATION_ADD:
3226 ofproto_rule_destroy__(op->victim);
3228 if ((rule->cr.wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3229 == htons(VLAN_VID_MASK)) {
3230 if (ofproto->vlan_bitmap) {
3231 uint16_t vid = vlan_tci_to_vid(rule->cr.flow.vlan_tci);
3233 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
3234 bitmap_set1(ofproto->vlan_bitmap, vid);
3235 ofproto->vlans_changed = true;
3238 ofproto->vlans_changed = true;
3243 classifier_replace(table, &op->victim->cr);
3246 classifier_remove(table, &rule->cr);
3248 ofproto_rule_destroy__(rule);
3253 case OFOPERATION_DELETE:
3255 ofproto_rule_destroy__(rule);
3259 case OFOPERATION_MODIFY:
3261 rule->modified = time_msec();
3263 free(rule->actions);
3264 rule->actions = op->actions;
3265 rule->n_actions = op->n_actions;
3273 ofoperation_destroy(op);
3277 ofoperation_get_victim(struct ofoperation *op)
3279 assert(op->type == OFOPERATION_ADD);
3284 pick_datapath_id(const struct ofproto *ofproto)
3286 const struct ofport *port;
3288 port = ofproto_get_port(ofproto, OFPP_LOCAL);
3290 uint8_t ea[ETH_ADDR_LEN];
3293 error = netdev_get_etheraddr(port->netdev, ea);
3295 return eth_addr_to_uint64(ea);
3297 VLOG_WARN("could not get MAC address for %s (%s)",
3298 netdev_get_name(port->netdev), strerror(error));
3300 return ofproto->fallback_dpid;
3304 pick_fallback_dpid(void)
3306 uint8_t ea[ETH_ADDR_LEN];
3307 eth_addr_nicira_random(ea);
3308 return eth_addr_to_uint64(ea);
3311 /* unixctl commands. */
3314 ofproto_lookup(const char *name)
3316 struct ofproto *ofproto;
3318 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
3320 if (!strcmp(ofproto->name, name)) {
3328 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
3329 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
3331 struct ofproto *ofproto;
3335 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
3336 ds_put_format(&results, "%s\n", ofproto->name);
3338 unixctl_command_reply(conn, 200, ds_cstr(&results));
3339 ds_destroy(&results);
3343 ofproto_unixctl_init(void)
3345 static bool registered;
3351 unixctl_command_register("ofproto/list", "", 0, 0,
3352 ofproto_unixctl_list, NULL);
3355 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
3357 * This is deprecated. It is only for compatibility with broken device drivers
3358 * in old versions of Linux that do not properly support VLANs when VLAN
3359 * devices are not used. When broken device drivers are no longer in
3360 * widespread use, we will delete these interfaces. */
3362 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
3363 * (exactly) by an OpenFlow rule in 'ofproto'. */
3365 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
3367 const struct classifier *cls;
3369 free(ofproto->vlan_bitmap);
3370 ofproto->vlan_bitmap = bitmap_allocate(4096);
3371 ofproto->vlans_changed = false;
3373 OFPROTO_FOR_EACH_TABLE (cls, ofproto) {
3374 const struct cls_table *table;
3376 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
3377 if ((table->wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3378 == htons(VLAN_VID_MASK)) {
3379 const struct cls_rule *rule;
3381 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
3382 uint16_t vid = vlan_tci_to_vid(rule->flow.vlan_tci);
3383 bitmap_set1(vlan_bitmap, vid);
3384 bitmap_set1(ofproto->vlan_bitmap, vid);
3391 /* Returns true if new VLANs have come into use by the flow table since the
3392 * last call to ofproto_get_vlan_usage().
3394 * We don't track when old VLANs stop being used. */
3396 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
3398 return ofproto->vlans_changed;
3401 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
3402 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
3403 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
3404 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
3405 * then the VLAN device is un-enslaved. */
3407 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
3408 uint16_t realdev_ofp_port, int vid)
3410 struct ofport *ofport;
3413 assert(vlandev_ofp_port != realdev_ofp_port);
3415 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
3417 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
3418 ofproto->name, vlandev_ofp_port);
3422 if (!ofproto->ofproto_class->set_realdev) {
3423 if (!vlandev_ofp_port) {
3426 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
3430 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
3432 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
3433 ofproto->name, vlandev_ofp_port,
3434 netdev_get_name(ofport->netdev), strerror(error));