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 *);
128 static void oftable_init(struct oftable *);
129 static void oftable_destroy(struct oftable *);
131 static void oftable_remove_rule(struct rule *);
132 static struct rule *oftable_replace_rule(struct rule *);
133 static void oftable_substitute_rule(struct rule *old, struct rule *new);
136 static void ofproto_rule_destroy__(struct rule *);
137 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
140 static void ofport_destroy__(struct ofport *);
141 static void ofport_destroy(struct ofport *);
143 static void update_port(struct ofproto *, const char *devname);
144 static int init_ports(struct ofproto *);
145 static void reinit_ports(struct ofproto *);
148 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
149 const struct ofputil_flow_mod *,
150 const struct ofp_header *);
152 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
153 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
154 const struct ofputil_flow_mod *,
155 const struct ofp_header *);
158 static uint64_t pick_datapath_id(const struct ofproto *);
159 static uint64_t pick_fallback_dpid(void);
160 static void ofproto_destroy__(struct ofproto *);
161 static void set_internal_devs_mtu(struct ofproto *);
164 static void ofproto_unixctl_init(void);
166 /* All registered ofproto classes, in probe order. */
167 static const struct ofproto_class **ofproto_classes;
168 static size_t n_ofproto_classes;
169 static size_t allocated_ofproto_classes;
171 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
172 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
174 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
177 ofproto_initialize(void)
183 ofproto_class_register(&ofproto_dpif_class);
187 /* 'type' should be a normalized datapath type, as returned by
188 * ofproto_normalize_type(). Returns the corresponding ofproto_class
189 * structure, or a null pointer if there is none registered for 'type'. */
190 static const struct ofproto_class *
191 ofproto_class_find__(const char *type)
195 ofproto_initialize();
196 for (i = 0; i < n_ofproto_classes; i++) {
197 const struct ofproto_class *class = ofproto_classes[i];
202 class->enumerate_types(&types);
203 found = sset_contains(&types, type);
204 sset_destroy(&types);
210 VLOG_WARN("unknown datapath type %s", type);
214 /* Registers a new ofproto class. After successful registration, new ofprotos
215 * of that type can be created using ofproto_create(). */
217 ofproto_class_register(const struct ofproto_class *new_class)
221 for (i = 0; i < n_ofproto_classes; i++) {
222 if (ofproto_classes[i] == new_class) {
227 if (n_ofproto_classes >= allocated_ofproto_classes) {
228 ofproto_classes = x2nrealloc(ofproto_classes,
229 &allocated_ofproto_classes,
230 sizeof *ofproto_classes);
232 ofproto_classes[n_ofproto_classes++] = new_class;
236 /* Unregisters a datapath provider. 'type' must have been previously
237 * registered and not currently be in use by any ofprotos. After
238 * unregistration new datapaths of that type cannot be opened using
239 * ofproto_create(). */
241 ofproto_class_unregister(const struct ofproto_class *class)
245 for (i = 0; i < n_ofproto_classes; i++) {
246 if (ofproto_classes[i] == class) {
247 for (i++; i < n_ofproto_classes; i++) {
248 ofproto_classes[i - 1] = ofproto_classes[i];
254 VLOG_WARN("attempted to unregister an ofproto class that is not "
259 /* Clears 'types' and enumerates all registered ofproto types into it. The
260 * caller must first initialize the sset. */
262 ofproto_enumerate_types(struct sset *types)
266 ofproto_initialize();
267 for (i = 0; i < n_ofproto_classes; i++) {
268 ofproto_classes[i]->enumerate_types(types);
272 /* Returns the fully spelled out name for the given ofproto 'type'.
274 * Normalized type string can be compared with strcmp(). Unnormalized type
275 * string might be the same even if they have different spellings. */
277 ofproto_normalize_type(const char *type)
279 return type && type[0] ? type : "system";
282 /* Clears 'names' and enumerates the names of all known created ofprotos with
283 * the given 'type'. The caller must first initialize the sset. Returns 0 if
284 * successful, otherwise a positive errno value.
286 * Some kinds of datapaths might not be practically enumerable. This is not
287 * considered an error. */
289 ofproto_enumerate_names(const char *type, struct sset *names)
291 const struct ofproto_class *class = ofproto_class_find__(type);
292 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
296 ofproto_create(const char *datapath_name, const char *datapath_type,
297 struct ofproto **ofprotop)
299 const struct ofproto_class *class;
300 struct ofproto *ofproto;
305 ofproto_initialize();
306 ofproto_unixctl_init();
308 datapath_type = ofproto_normalize_type(datapath_type);
309 class = ofproto_class_find__(datapath_type);
311 VLOG_WARN("could not create datapath %s of unknown type %s",
312 datapath_name, datapath_type);
316 ofproto = class->alloc();
318 VLOG_ERR("failed to allocate datapath %s of type %s",
319 datapath_name, datapath_type);
324 memset(ofproto, 0, sizeof *ofproto);
325 ofproto->ofproto_class = class;
326 ofproto->name = xstrdup(datapath_name);
327 ofproto->type = xstrdup(datapath_type);
328 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
329 hash_string(ofproto->name, 0));
330 ofproto->datapath_id = 0;
331 ofproto_set_flow_eviction_threshold(ofproto,
332 OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT);
333 ofproto->forward_bpdu = false;
334 ofproto->fallback_dpid = pick_fallback_dpid();
335 ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
336 ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
337 ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
338 ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
339 ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
340 ofproto->frag_handling = OFPC_FRAG_NORMAL;
341 hmap_init(&ofproto->ports);
342 shash_init(&ofproto->port_by_name);
343 ofproto->tables = NULL;
344 ofproto->n_tables = 0;
345 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
346 ofproto->state = S_OPENFLOW;
347 list_init(&ofproto->pending);
348 ofproto->n_pending = 0;
349 hmap_init(&ofproto->deletions);
350 ofproto->vlan_bitmap = NULL;
351 ofproto->vlans_changed = false;
353 error = ofproto->ofproto_class->construct(ofproto);
355 VLOG_ERR("failed to open datapath %s: %s",
356 datapath_name, strerror(error));
357 ofproto_destroy__(ofproto);
361 assert(ofproto->n_tables);
363 ofproto->datapath_id = pick_datapath_id(ofproto);
364 VLOG_INFO("using datapath ID %016"PRIx64, ofproto->datapath_id);
372 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
374 struct oftable *table;
376 assert(!ofproto->n_tables);
377 assert(n_tables >= 1 && n_tables <= 255);
379 ofproto->n_tables = n_tables;
380 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
381 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
387 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
389 uint64_t old_dpid = p->datapath_id;
390 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
391 if (p->datapath_id != old_dpid) {
392 VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
394 /* Force all active connections to reconnect, since there is no way to
395 * notify a controller that the datapath ID has changed. */
396 ofproto_reconnect_controllers(p);
401 ofproto_set_controllers(struct ofproto *p,
402 const struct ofproto_controller *controllers,
403 size_t n_controllers)
405 connmgr_set_controllers(p->connmgr, controllers, n_controllers);
409 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
411 connmgr_set_fail_mode(p->connmgr, fail_mode);
414 /* Drops the connections between 'ofproto' and all of its controllers, forcing
415 * them to reconnect. */
417 ofproto_reconnect_controllers(struct ofproto *ofproto)
419 connmgr_reconnect(ofproto->connmgr);
422 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
423 * in-band control should guarantee access, in the same way that in-band
424 * control guarantees access to OpenFlow controllers. */
426 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
427 const struct sockaddr_in *extras, size_t n)
429 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
432 /* Sets the OpenFlow queue used by flows set up by in-band control on
433 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
434 * flows will use the default queue. */
436 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
438 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
441 /* Sets the number of flows at which eviction from the kernel flow table
444 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
446 if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
447 ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
449 ofproto->flow_eviction_threshold = threshold;
453 /* If forward_bpdu is true, the NORMAL action will forward frames with
454 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
455 * the NORMAL action will drop these frames. */
457 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
459 bool old_val = ofproto->forward_bpdu;
460 ofproto->forward_bpdu = forward_bpdu;
461 if (old_val != ofproto->forward_bpdu) {
462 if (ofproto->ofproto_class->forward_bpdu_changed) {
463 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
469 ofproto_set_desc(struct ofproto *p,
470 const char *mfr_desc, const char *hw_desc,
471 const char *sw_desc, const char *serial_desc,
474 struct ofp_desc_stats *ods;
477 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
478 VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
479 sizeof ods->mfr_desc);
482 p->mfr_desc = xstrdup(mfr_desc);
485 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
486 VLOG_WARN("truncating hw_desc, must be less than %zu characters",
487 sizeof ods->hw_desc);
490 p->hw_desc = xstrdup(hw_desc);
493 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
494 VLOG_WARN("truncating sw_desc, must be less than %zu characters",
495 sizeof ods->sw_desc);
498 p->sw_desc = xstrdup(sw_desc);
501 if (strlen(serial_desc) >= sizeof ods->serial_num) {
502 VLOG_WARN("truncating serial_desc, must be less than %zu "
504 sizeof ods->serial_num);
506 free(p->serial_desc);
507 p->serial_desc = xstrdup(serial_desc);
510 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
511 VLOG_WARN("truncating dp_desc, must be less than %zu characters",
512 sizeof ods->dp_desc);
515 p->dp_desc = xstrdup(dp_desc);
520 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
522 return connmgr_set_snoops(ofproto->connmgr, snoops);
526 ofproto_set_netflow(struct ofproto *ofproto,
527 const struct netflow_options *nf_options)
529 if (nf_options && sset_is_empty(&nf_options->collectors)) {
533 if (ofproto->ofproto_class->set_netflow) {
534 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
536 return nf_options ? EOPNOTSUPP : 0;
541 ofproto_set_sflow(struct ofproto *ofproto,
542 const struct ofproto_sflow_options *oso)
544 if (oso && sset_is_empty(&oso->targets)) {
548 if (ofproto->ofproto_class->set_sflow) {
549 return ofproto->ofproto_class->set_sflow(ofproto, oso);
551 return oso ? EOPNOTSUPP : 0;
555 /* Spanning Tree Protocol (STP) configuration. */
557 /* Configures STP on 'ofproto' using the settings defined in 's'. If
558 * 's' is NULL, disables STP.
560 * Returns 0 if successful, otherwise a positive errno value. */
562 ofproto_set_stp(struct ofproto *ofproto,
563 const struct ofproto_stp_settings *s)
565 return (ofproto->ofproto_class->set_stp
566 ? ofproto->ofproto_class->set_stp(ofproto, s)
570 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
571 * 'enabled' member of 's' is false, then the other members are not
574 * Returns 0 if successful, otherwise a positive errno value. */
576 ofproto_get_stp_status(struct ofproto *ofproto,
577 struct ofproto_stp_status *s)
579 return (ofproto->ofproto_class->get_stp_status
580 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
584 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
585 * in 's'. The caller is responsible for assigning STP port numbers
586 * (using the 'port_num' member in the range of 1 through 255, inclusive)
587 * and ensuring there are no duplicates. If the 's' is NULL, then STP
588 * is disabled on the port.
590 * Returns 0 if successful, otherwise a positive errno value.*/
592 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
593 const struct ofproto_port_stp_settings *s)
595 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
597 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
598 ofproto->name, ofp_port);
602 return (ofproto->ofproto_class->set_stp_port
603 ? ofproto->ofproto_class->set_stp_port(ofport, s)
607 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
608 * 's'. If the 'enabled' member in 's' is false, then the other members
609 * are not meaningful.
611 * Returns 0 if successful, otherwise a positive errno value.*/
613 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
614 struct ofproto_port_stp_status *s)
616 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
618 VLOG_WARN("%s: cannot get STP status on nonexistent port %"PRIu16,
619 ofproto->name, ofp_port);
623 return (ofproto->ofproto_class->get_stp_port_status
624 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
628 /* Queue DSCP configuration. */
630 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
631 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
632 * to implement QoS. Instead, it is used to implement features which require
633 * knowledge of what queues exist on a port, and some basic information about
636 * Returns 0 if successful, otherwise a positive errno value. */
638 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
639 const struct ofproto_port_queue *queues,
642 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
645 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
646 ofproto->name, ofp_port);
650 return (ofproto->ofproto_class->set_queues
651 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
655 /* Connectivity Fault Management configuration. */
657 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
659 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
661 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
662 if (ofport && ofproto->ofproto_class->set_cfm) {
663 ofproto->ofproto_class->set_cfm(ofport, NULL);
667 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
668 * basic configuration from the configuration members in 'cfm', and the remote
669 * maintenance point ID from remote_mpid. Ignores the statistics members of
672 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
674 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
675 const struct cfm_settings *s)
677 struct ofport *ofport;
680 ofport = ofproto_get_port(ofproto, ofp_port);
682 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
683 ofproto->name, ofp_port);
687 /* XXX: For configuration simplicity, we only support one remote_mpid
688 * outside of the CFM module. It's not clear if this is the correct long
689 * term solution or not. */
690 error = (ofproto->ofproto_class->set_cfm
691 ? ofproto->ofproto_class->set_cfm(ofport, s)
694 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
695 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
700 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
701 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
702 * 0 if LACP partner information is not current (generally indicating a
703 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
705 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
707 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
708 return (ofport && ofproto->ofproto_class->port_is_lacp_current
709 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
715 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
716 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
717 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
718 * configuration plus, if there is more than one slave, a bonding
721 * If 'aux' is already registered then this function updates its configuration
722 * to 's'. Otherwise, this function registers a new bundle.
724 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
727 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
728 const struct ofproto_bundle_settings *s)
730 return (ofproto->ofproto_class->bundle_set
731 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
735 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
736 * If no such bundle has been registered, this has no effect. */
738 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
740 return ofproto_bundle_register(ofproto, aux, NULL);
744 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
745 * If 'aux' is already registered then this function updates its configuration
746 * to 's'. Otherwise, this function registers a new mirror. */
748 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
749 const struct ofproto_mirror_settings *s)
751 return (ofproto->ofproto_class->mirror_set
752 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
756 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
757 * If no mirror has been registered, this has no effect. */
759 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
761 return ofproto_mirror_register(ofproto, aux, NULL);
764 /* Retrieves statistics from mirror associated with client data pointer
765 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
766 * 'bytes', respectively. If a particular counters is not supported,
767 * the appropriate argument is set to UINT64_MAX. */
769 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
770 uint64_t *packets, uint64_t *bytes)
772 if (!ofproto->ofproto_class->mirror_get_stats) {
773 *packets = *bytes = UINT64_MAX;
777 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
781 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
782 * which all packets are flooded, instead of using MAC learning. If
783 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
785 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
788 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
790 return (ofproto->ofproto_class->set_flood_vlans
791 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
795 /* Returns true if 'aux' is a registered bundle that is currently in use as the
796 * output for a mirror. */
798 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
800 return (ofproto->ofproto_class->is_mirror_output_bundle
801 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
806 ofproto_has_snoops(const struct ofproto *ofproto)
808 return connmgr_has_snoops(ofproto->connmgr);
812 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
814 connmgr_get_snoops(ofproto->connmgr, snoops);
818 ofproto_flush__(struct ofproto *ofproto)
820 struct ofopgroup *group;
821 struct oftable *table;
823 if (ofproto->ofproto_class->flush) {
824 ofproto->ofproto_class->flush(ofproto);
827 group = ofopgroup_create_unattached(ofproto);
828 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
829 struct rule *rule, *next_rule;
830 struct cls_cursor cursor;
832 cls_cursor_init(&cursor, &table->cls, NULL);
833 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
834 if (!rule->pending) {
835 ofoperation_create(group, rule, OFOPERATION_DELETE);
836 oftable_remove_rule(rule);
837 ofproto->ofproto_class->rule_destruct(rule);
841 ofopgroup_submit(group);
845 ofproto_destroy__(struct ofproto *ofproto)
847 struct oftable *table;
849 assert(list_is_empty(&ofproto->pending));
850 assert(!ofproto->n_pending);
852 connmgr_destroy(ofproto->connmgr);
854 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
857 free(ofproto->mfr_desc);
858 free(ofproto->hw_desc);
859 free(ofproto->sw_desc);
860 free(ofproto->serial_desc);
861 free(ofproto->dp_desc);
862 hmap_destroy(&ofproto->ports);
863 shash_destroy(&ofproto->port_by_name);
865 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
866 oftable_destroy(table);
868 free(ofproto->tables);
870 hmap_destroy(&ofproto->deletions);
872 free(ofproto->vlan_bitmap);
874 ofproto->ofproto_class->dealloc(ofproto);
878 ofproto_destroy(struct ofproto *p)
880 struct ofport *ofport, *next_ofport;
887 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
888 ofport_destroy(ofport);
891 p->ofproto_class->destruct(p);
892 ofproto_destroy__(p);
895 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
896 * kernel datapath, for example, this destroys the datapath in the kernel, and
897 * with the netdev-based datapath, it tears down the data structures that
898 * represent the datapath.
900 * The datapath should not be currently open as an ofproto. */
902 ofproto_delete(const char *name, const char *type)
904 const struct ofproto_class *class = ofproto_class_find__(type);
905 return (!class ? EAFNOSUPPORT
906 : !class->del ? EACCES
907 : class->del(type, name));
911 process_port_change(struct ofproto *ofproto, int error, char *devname)
913 if (error == ENOBUFS) {
914 reinit_ports(ofproto);
916 update_port(ofproto, devname);
922 ofproto_run(struct ofproto *p)
924 struct ofport *ofport;
928 error = p->ofproto_class->run(p);
929 if (error && error != EAGAIN) {
930 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, strerror(error));
933 if (p->ofproto_class->port_poll) {
934 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
935 process_port_change(p, error, devname);
939 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
940 unsigned int change_seq = netdev_change_seq(ofport->netdev);
941 if (ofport->change_seq != change_seq) {
942 ofport->change_seq = change_seq;
943 update_port(p, netdev_get_name(ofport->netdev));
950 connmgr_run(p->connmgr, handle_openflow);
954 connmgr_run(p->connmgr, NULL);
956 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
957 connmgr_flushed(p->connmgr);
958 p->state = S_OPENFLOW;
969 /* Performs periodic activity required by 'ofproto' that needs to be done
970 * with the least possible latency.
972 * It makes sense to call this function a couple of times per poll loop, to
973 * provide a significant performance boost on some benchmarks with the
974 * ofproto-dpif implementation. */
976 ofproto_run_fast(struct ofproto *p)
980 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
981 if (error && error != EAGAIN) {
982 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
983 p->name, strerror(error));
989 ofproto_wait(struct ofproto *p)
991 struct ofport *ofport;
993 p->ofproto_class->wait(p);
994 if (p->ofproto_class->port_poll_wait) {
995 p->ofproto_class->port_poll_wait(p);
998 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
999 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1000 poll_immediate_wake();
1006 connmgr_wait(p->connmgr, true);
1010 connmgr_wait(p->connmgr, false);
1011 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1012 poll_immediate_wake();
1019 ofproto_is_alive(const struct ofproto *p)
1021 return connmgr_has_controllers(p->connmgr);
1025 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1028 connmgr_get_controller_info(ofproto->connmgr, info);
1032 ofproto_free_ofproto_controller_info(struct shash *info)
1034 connmgr_free_controller_info(info);
1037 /* Makes a deep copy of 'old' into 'port'. */
1039 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1041 port->name = xstrdup(old->name);
1042 port->type = xstrdup(old->type);
1043 port->ofp_port = old->ofp_port;
1046 /* Frees memory allocated to members of 'ofproto_port'.
1048 * Do not call this function on an ofproto_port obtained from
1049 * ofproto_port_dump_next(): that function retains ownership of the data in the
1052 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1054 free(ofproto_port->name);
1055 free(ofproto_port->type);
1058 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1060 * This function provides no status indication. An error status for the entire
1061 * dump operation is provided when it is completed by calling
1062 * ofproto_port_dump_done().
1065 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1066 const struct ofproto *ofproto)
1068 dump->ofproto = ofproto;
1069 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1073 /* Attempts to retrieve another port from 'dump', which must have been created
1074 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1075 * 'port' and returns true. On failure, returns false.
1077 * Failure might indicate an actual error or merely that the last port has been
1078 * dumped. An error status for the entire dump operation is provided when it
1079 * is completed by calling ofproto_port_dump_done().
1081 * The ofproto owns the data stored in 'port'. It will remain valid until at
1082 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1083 * ofproto_port_dump_done(). */
1085 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1086 struct ofproto_port *port)
1088 const struct ofproto *ofproto = dump->ofproto;
1094 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1097 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1103 /* Completes port table dump operation 'dump', which must have been created
1104 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1105 * error-free, otherwise a positive errno value describing the problem. */
1107 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1109 const struct ofproto *ofproto = dump->ofproto;
1111 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1114 return dump->error == EOF ? 0 : dump->error;
1117 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
1118 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
1119 * is non-null). On failure, returns a positive errno value and sets
1120 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
1122 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1123 uint16_t *ofp_portp)
1128 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
1130 update_port(ofproto, netdev_get_name(netdev));
1133 *ofp_portp = error ? OFPP_NONE : ofp_port;
1138 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1139 * initializes '*port' appropriately; on failure, returns a positive errno
1142 * The caller owns the data in 'ofproto_port' and must free it with
1143 * ofproto_port_destroy() when it is no longer needed. */
1145 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1146 struct ofproto_port *port)
1150 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1152 memset(port, 0, sizeof *port);
1157 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1158 * Returns 0 if successful, otherwise a positive errno. */
1160 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1162 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1163 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1166 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1167 if (!error && ofport) {
1168 /* 'name' is the netdev's name and update_port() is going to close the
1169 * netdev. Just in case update_port() refers to 'name' after it
1170 * destroys 'ofport', make a copy of it around the update_port()
1172 char *devname = xstrdup(name);
1173 update_port(ofproto, devname);
1179 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1180 * performs the 'n_actions' actions in 'actions'. The new flow will not
1183 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1184 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1185 * controllers; otherwise, it will be hidden.
1187 * The caller retains ownership of 'cls_rule' and 'actions'.
1189 * This is a helper function for in-band control and fail-open. */
1191 ofproto_add_flow(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1192 const union ofp_action *actions, size_t n_actions)
1194 const struct rule *rule;
1196 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1197 &ofproto->tables[0].cls, cls_rule));
1198 if (!rule || !ofputil_actions_equal(rule->actions, rule->n_actions,
1199 actions, n_actions)) {
1200 struct ofputil_flow_mod fm;
1202 memset(&fm, 0, sizeof fm);
1204 fm.buffer_id = UINT32_MAX;
1205 fm.actions = (union ofp_action *) actions;
1206 fm.n_actions = n_actions;
1207 add_flow(ofproto, NULL, &fm, NULL);
1211 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1212 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1213 * operation cannot be initiated now but may be retried later.
1215 * This is a helper function for in-band control and fail-open. */
1217 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1219 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1222 /* Searches for a rule with matching criteria exactly equal to 'target' in
1223 * ofproto's table 0 and, if it finds one, deletes it.
1225 * This is a helper function for in-band control and fail-open. */
1227 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1231 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1232 &ofproto->tables[0].cls, target));
1234 /* No such rule -> success. */
1236 } else if (rule->pending) {
1237 /* An operation on the rule is already pending -> failure.
1238 * Caller must retry later if it's important. */
1241 /* Initiate deletion -> success. */
1242 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1243 ofoperation_create(group, rule, OFOPERATION_DELETE);
1244 oftable_remove_rule(rule);
1245 rule->ofproto->ofproto_class->rule_destruct(rule);
1246 ofopgroup_submit(group);
1252 /* Starts the process of deleting all of the flows from all of ofproto's flow
1253 * tables and then reintroducing the flows required by in-band control and
1254 * fail-open. The process will complete in a later call to ofproto_run(). */
1256 ofproto_flush_flows(struct ofproto *ofproto)
1258 COVERAGE_INC(ofproto_flush);
1259 ofproto->state = S_FLUSH;
1263 reinit_ports(struct ofproto *p)
1265 struct ofproto_port_dump dump;
1266 struct sset devnames;
1267 struct ofport *ofport;
1268 struct ofproto_port ofproto_port;
1269 const char *devname;
1271 COVERAGE_INC(ofproto_reinit_ports);
1273 sset_init(&devnames);
1274 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1275 sset_add(&devnames, netdev_get_name(ofport->netdev));
1277 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1278 sset_add(&devnames, ofproto_port.name);
1281 SSET_FOR_EACH (devname, &devnames) {
1282 update_port(p, devname);
1284 sset_destroy(&devnames);
1287 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
1288 * netdev cannot be opened. On success, also fills in 'opp'. */
1289 static struct netdev *
1290 ofport_open(const struct ofproto_port *ofproto_port, struct ofp_phy_port *opp)
1292 uint32_t curr, advertised, supported, peer;
1293 enum netdev_flags flags;
1294 struct netdev *netdev;
1297 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1299 VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1300 "cannot be opened (%s)",
1301 ofproto_port->name, ofproto_port->ofp_port,
1302 ofproto_port->name, strerror(error));
1306 netdev_get_flags(netdev, &flags);
1307 netdev_get_features(netdev, &curr, &advertised, &supported, &peer);
1309 opp->port_no = htons(ofproto_port->ofp_port);
1310 netdev_get_etheraddr(netdev, opp->hw_addr);
1311 ovs_strzcpy(opp->name, ofproto_port->name, sizeof opp->name);
1312 opp->config = flags & NETDEV_UP ? 0 : htonl(OFPPC_PORT_DOWN);
1313 opp->state = netdev_get_carrier(netdev) ? 0 : htonl(OFPPS_LINK_DOWN);
1314 opp->curr = htonl(curr);
1315 opp->advertised = htonl(advertised);
1316 opp->supported = htonl(supported);
1317 opp->peer = htonl(peer);
1322 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1323 * port number, and 'config' bits other than OFPPC_PORT_DOWN are
1326 ofport_equal(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
1328 BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1329 return (!memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1330 && a->state == b->state
1331 && !((a->config ^ b->config) & htonl(OFPPC_PORT_DOWN))
1332 && a->curr == b->curr
1333 && a->advertised == b->advertised
1334 && a->supported == b->supported
1335 && a->peer == b->peer);
1338 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1339 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1340 * one with the same name or port number). */
1342 ofport_install(struct ofproto *p,
1343 struct netdev *netdev, const struct ofp_phy_port *opp)
1345 const char *netdev_name = netdev_get_name(netdev);
1346 struct ofport *ofport;
1350 /* Create ofport. */
1351 ofport = p->ofproto_class->port_alloc();
1356 ofport->ofproto = p;
1357 ofport->netdev = netdev;
1358 ofport->change_seq = netdev_change_seq(netdev);
1360 ofport->ofp_port = ntohs(opp->port_no);
1362 /* Add port to 'p'. */
1363 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1364 shash_add(&p->port_by_name, netdev_name, ofport);
1366 if (!netdev_get_mtu(netdev, &dev_mtu)) {
1367 set_internal_devs_mtu(p);
1368 ofport->mtu = dev_mtu;
1373 /* Let the ofproto_class initialize its private data. */
1374 error = p->ofproto_class->port_construct(ofport);
1378 connmgr_send_port_status(p->connmgr, opp, OFPPR_ADD);
1382 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1383 p->name, netdev_name, strerror(error));
1385 ofport_destroy__(ofport);
1387 netdev_close(netdev);
1391 /* Removes 'ofport' from 'p' and destroys it. */
1393 ofport_remove(struct ofport *ofport)
1395 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->opp,
1397 ofport_destroy(ofport);
1400 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1403 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1405 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1407 ofport_remove(port);
1411 /* Updates 'port' with new 'opp' description.
1413 * Does not handle a name or port number change. The caller must implement
1414 * such a change as a delete followed by an add. */
1416 ofport_modified(struct ofport *port, struct ofp_phy_port *opp)
1418 memcpy(port->opp.hw_addr, opp->hw_addr, ETH_ADDR_LEN);
1419 port->opp.config = ((port->opp.config & ~htonl(OFPPC_PORT_DOWN))
1420 | (opp->config & htonl(OFPPC_PORT_DOWN)));
1421 port->opp.state = opp->state;
1422 port->opp.curr = opp->curr;
1423 port->opp.advertised = opp->advertised;
1424 port->opp.supported = opp->supported;
1425 port->opp.peer = opp->peer;
1427 connmgr_send_port_status(port->ofproto->connmgr, &port->opp, OFPPR_MODIFY);
1430 /* Update OpenFlow 'state' in 'port' and notify controller. */
1432 ofproto_port_set_state(struct ofport *port, ovs_be32 state)
1434 if (port->opp.state != state) {
1435 port->opp.state = state;
1436 connmgr_send_port_status(port->ofproto->connmgr, &port->opp,
1442 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1444 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1446 if (port->ofproto->ofproto_class->set_realdev) {
1447 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1449 if (port->ofproto->ofproto_class->set_stp_port) {
1450 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1452 if (port->ofproto->ofproto_class->set_cfm) {
1453 port->ofproto->ofproto_class->set_cfm(port, NULL);
1455 if (port->ofproto->ofproto_class->bundle_remove) {
1456 port->ofproto->ofproto_class->bundle_remove(port);
1462 ofport_destroy__(struct ofport *port)
1464 struct ofproto *ofproto = port->ofproto;
1465 const char *name = netdev_get_name(port->netdev);
1467 hmap_remove(&ofproto->ports, &port->hmap_node);
1468 shash_delete(&ofproto->port_by_name,
1469 shash_find(&ofproto->port_by_name, name));
1471 netdev_close(port->netdev);
1472 ofproto->ofproto_class->port_dealloc(port);
1476 ofport_destroy(struct ofport *port)
1479 port->ofproto->ofproto_class->port_destruct(port);
1480 ofport_destroy__(port);
1485 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1487 struct ofport *port;
1489 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1490 hash_int(ofp_port, 0), &ofproto->ports) {
1491 if (port->ofp_port == ofp_port) {
1499 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1501 struct ofproto *ofproto = port->ofproto;
1504 if (ofproto->ofproto_class->port_get_stats) {
1505 error = ofproto->ofproto_class->port_get_stats(port, stats);
1514 update_port(struct ofproto *ofproto, const char *name)
1516 struct ofproto_port ofproto_port;
1517 struct ofp_phy_port opp;
1518 struct netdev *netdev;
1519 struct ofport *port;
1521 COVERAGE_INC(ofproto_update_port);
1523 /* Fetch 'name''s location and properties from the datapath. */
1524 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1525 ? ofport_open(&ofproto_port, &opp)
1528 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1529 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1530 struct netdev *old_netdev = port->netdev;
1533 /* 'name' hasn't changed location. Any properties changed? */
1534 if (!ofport_equal(&port->opp, &opp)) {
1535 ofport_modified(port, &opp);
1538 /* If this is a non-internal port and the MTU changed, check
1539 * if the datapath's MTU needs to be updated. */
1540 if (strcmp(netdev_get_type(netdev), "internal")
1541 && !netdev_get_mtu(netdev, &dev_mtu)
1542 && port->mtu != dev_mtu) {
1543 set_internal_devs_mtu(ofproto);
1544 port->mtu = dev_mtu;
1547 /* Install the newly opened netdev in case it has changed.
1548 * Don't close the old netdev yet in case port_modified has to
1549 * remove a retained reference to it.*/
1550 port->netdev = netdev;
1551 port->change_seq = netdev_change_seq(netdev);
1553 if (port->ofproto->ofproto_class->port_modified) {
1554 port->ofproto->ofproto_class->port_modified(port);
1557 netdev_close(old_netdev);
1559 /* If 'port' is nonnull then its name differs from 'name' and thus
1560 * we should delete it. If we think there's a port named 'name'
1561 * then its port number must be wrong now so delete it too. */
1563 ofport_remove(port);
1565 ofport_remove_with_name(ofproto, name);
1566 ofport_install(ofproto, netdev, &opp);
1569 /* Any port named 'name' is gone now. */
1570 ofport_remove_with_name(ofproto, name);
1572 ofproto_port_destroy(&ofproto_port);
1576 init_ports(struct ofproto *p)
1578 struct ofproto_port_dump dump;
1579 struct ofproto_port ofproto_port;
1581 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1582 uint16_t ofp_port = ofproto_port.ofp_port;
1583 if (ofproto_get_port(p, ofp_port)) {
1584 VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1586 } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1587 VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1590 struct ofp_phy_port opp;
1591 struct netdev *netdev;
1593 netdev = ofport_open(&ofproto_port, &opp);
1595 ofport_install(p, netdev, &opp);
1603 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1604 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1606 find_min_mtu(struct ofproto *p)
1608 struct ofport *ofport;
1611 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1612 struct netdev *netdev = ofport->netdev;
1615 /* Skip any internal ports, since that's what we're trying to
1617 if (!strcmp(netdev_get_type(netdev), "internal")) {
1621 if (netdev_get_mtu(netdev, &dev_mtu)) {
1624 if (!mtu || dev_mtu < mtu) {
1629 return mtu ? mtu: ETH_PAYLOAD_MAX;
1632 /* Set the MTU of all datapath devices on 'p' to the minimum of the
1633 * non-datapath ports. */
1635 set_internal_devs_mtu(struct ofproto *p)
1637 struct ofport *ofport;
1638 int mtu = find_min_mtu(p);
1640 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1641 struct netdev *netdev = ofport->netdev;
1643 if (!strcmp(netdev_get_type(netdev), "internal")) {
1644 netdev_set_mtu(netdev, mtu);
1650 ofproto_rule_destroy__(struct rule *rule)
1652 free(rule->actions);
1653 rule->ofproto->ofproto_class->rule_dealloc(rule);
1656 /* This function allows an ofproto implementation to destroy any rules that
1657 * remain when its ->destruct() function is called. The caller must have
1658 * already uninitialized any derived members of 'rule' (step 5 described in the
1659 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1660 * This function implements steps 6 and 7.
1662 * This function should only be called from an ofproto implementation's
1663 * ->destruct() function. It is not suitable elsewhere. */
1665 ofproto_rule_destroy(struct rule *rule)
1667 assert(!rule->pending);
1668 oftable_remove_rule(rule);
1669 ofproto_rule_destroy__(rule);
1672 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1673 * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1676 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1678 const union ofp_action *oa;
1681 if (out_port == OFPP_NONE) {
1684 OFPUTIL_ACTION_FOR_EACH_UNSAFE (oa, left, rule->actions, rule->n_actions) {
1685 if (action_outputs_to_port(oa, htons(out_port))) {
1692 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1693 * statistics appropriately. 'packet' must have at least sizeof(struct
1694 * ofp_packet_in) bytes of headroom.
1696 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1697 * with statistics for 'packet' either way.
1699 * Takes ownership of 'packet'. */
1701 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1705 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1707 flow_extract(packet, 0, 0, in_port, &flow);
1708 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1711 /* Returns true if 'rule' should be hidden from the controller.
1713 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1714 * (e.g. by in-band control) and are intentionally hidden from the
1717 rule_is_hidden(const struct rule *rule)
1719 return rule->cr.priority > UINT16_MAX;
1723 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1725 ofconn_send_reply(ofconn, make_echo_reply(oh));
1730 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1732 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1733 struct ofp_switch_features *osf;
1735 struct ofport *port;
1739 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip, &actions);
1740 assert(actions & (1 << OFPAT_OUTPUT)); /* sanity check */
1742 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1743 osf->datapath_id = htonll(ofproto->datapath_id);
1744 osf->n_buffers = htonl(pktbuf_capacity());
1745 osf->n_tables = ofproto->n_tables;
1746 osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1747 OFPC_PORT_STATS | OFPC_QUEUE_STATS);
1749 osf->capabilities |= htonl(OFPC_ARP_MATCH_IP);
1751 osf->actions = htonl(actions);
1753 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1754 ofpbuf_put(buf, &port->opp, sizeof port->opp);
1757 ofconn_send_reply(ofconn, buf);
1762 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1764 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1765 struct ofp_switch_config *osc;
1766 enum ofp_config_flags flags;
1770 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1771 flags = ofproto->frag_handling;
1772 if (ofconn_get_invalid_ttl_to_controller(ofconn)) {
1773 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1775 osc->flags = htons(flags);
1776 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1777 ofconn_send_reply(ofconn, buf);
1783 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1785 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1786 uint16_t flags = ntohs(osc->flags);
1788 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
1789 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1790 enum ofp_config_flags cur = ofproto->frag_handling;
1791 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
1793 assert((cur & OFPC_FRAG_MASK) == cur);
1795 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
1796 ofproto->frag_handling = next;
1798 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
1800 ofputil_frag_handling_to_string(next));
1804 ofconn_set_invalid_ttl_to_controller(ofconn,
1805 (flags & OFPC_INVALID_TTL_TO_CONTROLLER));
1807 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1812 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1813 * error message code for the caller to propagate upward. Otherwise, returns
1816 * The log message mentions 'msg_type'. */
1818 reject_slave_controller(struct ofconn *ofconn)
1820 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1821 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1822 return OFPERR_OFPBRC_EPERM;
1829 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1831 struct ofproto *p = ofconn_get_ofproto(ofconn);
1832 struct ofp_packet_out *opo;
1833 struct ofpbuf payload, *buffer;
1834 union ofp_action *ofp_actions;
1835 struct ofpbuf request;
1837 size_t n_ofp_actions;
1841 COVERAGE_INC(ofproto_packet_out);
1843 error = reject_slave_controller(ofconn);
1848 /* Get ofp_packet_out. */
1849 ofpbuf_use_const(&request, oh, ntohs(oh->length));
1850 opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1853 error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1854 &ofp_actions, &n_ofp_actions);
1860 if (opo->buffer_id != htonl(UINT32_MAX)) {
1861 error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1863 if (error || !buffer) {
1872 /* Get in_port and partially validate it.
1874 * We don't know what range of ports the ofproto actually implements, but
1875 * we do know that only certain reserved ports (numbered OFPP_MAX and
1876 * above) are valid. */
1877 in_port = ntohs(opo->in_port);
1878 if (in_port >= OFPP_MAX && in_port != OFPP_LOCAL && in_port != OFPP_NONE) {
1879 return OFPERR_NXBRC_BAD_IN_PORT;
1882 /* Send out packet. */
1883 flow_extract(&payload, 0, 0, in_port, &flow);
1884 error = p->ofproto_class->packet_out(p, &payload, &flow,
1885 ofp_actions, n_ofp_actions);
1886 ofpbuf_delete(buffer);
1892 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1894 ovs_be32 old_config = port->opp.config;
1896 mask &= config ^ port->opp.config;
1897 if (mask & htonl(OFPPC_PORT_DOWN)) {
1898 if (config & htonl(OFPPC_PORT_DOWN)) {
1899 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1901 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1905 port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1906 OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1907 OFPPC_NO_PACKET_IN));
1908 if (port->opp.config != old_config) {
1909 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1914 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1916 struct ofproto *p = ofconn_get_ofproto(ofconn);
1917 const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1918 struct ofport *port;
1921 error = reject_slave_controller(ofconn);
1926 port = ofproto_get_port(p, ntohs(opm->port_no));
1928 return OFPERR_OFPPMFC_BAD_PORT;
1929 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1930 return OFPERR_OFPPMFC_BAD_HW_ADDR;
1932 update_port_config(port, opm->config, opm->mask);
1933 if (opm->advertise) {
1934 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1941 handle_desc_stats_request(struct ofconn *ofconn,
1942 const struct ofp_stats_msg *request)
1944 struct ofproto *p = ofconn_get_ofproto(ofconn);
1945 struct ofp_desc_stats *ods;
1948 ods = ofputil_make_stats_reply(sizeof *ods, request, &msg);
1949 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1950 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1951 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1952 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1953 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1954 ofconn_send_reply(ofconn, msg);
1960 handle_table_stats_request(struct ofconn *ofconn,
1961 const struct ofp_stats_msg *request)
1963 struct ofproto *p = ofconn_get_ofproto(ofconn);
1964 struct ofp_table_stats *ots;
1968 ofputil_make_stats_reply(sizeof(struct ofp_stats_msg), request, &msg);
1970 ots = ofpbuf_put_zeros(msg, sizeof *ots * p->n_tables);
1971 for (i = 0; i < p->n_tables; i++) {
1972 ots[i].table_id = i;
1973 sprintf(ots[i].name, "table%zu", i);
1974 ots[i].wildcards = htonl(OFPFW_ALL);
1975 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
1976 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
1979 p->ofproto_class->get_tables(p, ots);
1981 ofconn_send_reply(ofconn, msg);
1986 append_port_stat(struct ofport *port, struct list *replies)
1988 struct netdev_stats stats;
1989 struct ofp_port_stats *ops;
1991 /* Intentionally ignore return value, since errors will set
1992 * 'stats' to all-1s, which is correct for OpenFlow, and
1993 * netdev_get_stats() will log errors. */
1994 ofproto_port_get_stats(port, &stats);
1996 ops = ofputil_append_stats_reply(sizeof *ops, replies);
1997 ops->port_no = port->opp.port_no;
1998 memset(ops->pad, 0, sizeof ops->pad);
1999 put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
2000 put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
2001 put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
2002 put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
2003 put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
2004 put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
2005 put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
2006 put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
2007 put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
2008 put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
2009 put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
2010 put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
2014 handle_port_stats_request(struct ofconn *ofconn,
2015 const struct ofp_port_stats_request *psr)
2017 struct ofproto *p = ofconn_get_ofproto(ofconn);
2018 struct ofport *port;
2019 struct list replies;
2021 ofputil_start_stats_reply(&psr->osm, &replies);
2022 if (psr->port_no != htons(OFPP_NONE)) {
2023 port = ofproto_get_port(p, ntohs(psr->port_no));
2025 append_port_stat(port, &replies);
2028 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2029 append_port_stat(port, &replies);
2033 ofconn_send_replies(ofconn, &replies);
2038 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
2040 long long int msecs = time_msec() - start;
2041 *sec = msecs / 1000;
2042 *nsec = (msecs % 1000) * (1000 * 1000);
2045 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2046 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2048 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2050 return (table_id == 0xff || table_id < ofproto->n_tables
2052 : OFPERR_NXBRC_BAD_TABLE_ID);
2056 static struct oftable *
2057 first_matching_table(struct ofproto *ofproto, uint8_t table_id)
2059 if (table_id == 0xff) {
2060 return &ofproto->tables[0];
2061 } else if (table_id < ofproto->n_tables) {
2062 return &ofproto->tables[table_id];
2068 static struct oftable *
2069 next_matching_table(struct ofproto *ofproto,
2070 struct oftable *table, uint8_t table_id)
2072 return (table_id == 0xff && table < &ofproto->tables[ofproto->n_tables - 1]
2077 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2079 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2082 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2083 * only once, for that table.
2085 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2086 * entered at all. (Perhaps you should have validated TABLE_ID with
2087 * check_table_id().)
2089 * All parameters are evaluated multiple times.
2091 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2092 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2094 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2096 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2097 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2098 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2101 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2102 * to 'out_port' are included.
2104 * Hidden rules are always omitted.
2106 * Returns 0 on success, otherwise an OpenFlow error code. */
2108 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2109 const struct cls_rule *match,
2110 ovs_be64 cookie, ovs_be64 cookie_mask,
2111 uint16_t out_port, struct list *rules)
2113 struct oftable *table;
2116 error = check_table_id(ofproto, table_id);
2122 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2123 struct cls_cursor cursor;
2126 cls_cursor_init(&cursor, &table->cls, match);
2127 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2128 if (rule->pending) {
2129 return OFPROTO_POSTPONE;
2131 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2132 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2133 list_push_back(rules, &rule->ofproto_node);
2140 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2141 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2142 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2145 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2146 * to 'out_port' are included.
2148 * Hidden rules are always omitted.
2150 * Returns 0 on success, otherwise an OpenFlow error code. */
2152 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2153 const struct cls_rule *match,
2154 ovs_be64 cookie, ovs_be64 cookie_mask,
2155 uint16_t out_port, struct list *rules)
2157 struct oftable *table;
2160 error = check_table_id(ofproto, table_id);
2166 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2169 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2172 if (rule->pending) {
2173 return OFPROTO_POSTPONE;
2175 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2176 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2177 list_push_back(rules, &rule->ofproto_node);
2185 handle_flow_stats_request(struct ofconn *ofconn,
2186 const struct ofp_stats_msg *osm)
2188 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2189 struct ofputil_flow_stats_request fsr;
2190 struct list replies;
2195 error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
2200 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2201 fsr.cookie, fsr.cookie_mask,
2202 fsr.out_port, &rules);
2207 ofputil_start_stats_reply(osm, &replies);
2208 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2209 struct ofputil_flow_stats fs;
2212 fs.cookie = rule->flow_cookie;
2213 fs.table_id = rule->table_id;
2214 calc_flow_duration__(rule->created, &fs.duration_sec,
2216 fs.idle_timeout = rule->idle_timeout;
2217 fs.hard_timeout = rule->hard_timeout;
2218 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2220 fs.actions = rule->actions;
2221 fs.n_actions = rule->n_actions;
2222 ofputil_append_flow_stats_reply(&fs, &replies);
2224 ofconn_send_replies(ofconn, &replies);
2230 flow_stats_ds(struct rule *rule, struct ds *results)
2232 uint64_t packet_count, byte_count;
2234 rule->ofproto->ofproto_class->rule_get_stats(rule,
2235 &packet_count, &byte_count);
2237 if (rule->table_id != 0) {
2238 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2240 ds_put_format(results, "duration=%llds, ",
2241 (time_msec() - rule->created) / 1000);
2242 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2243 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2244 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2245 cls_rule_format(&rule->cr, results);
2246 ds_put_char(results, ',');
2247 if (rule->n_actions > 0) {
2248 ofp_print_actions(results, rule->actions, rule->n_actions);
2250 ds_put_cstr(results, "drop");
2252 ds_put_cstr(results, "\n");
2255 /* Adds a pretty-printed description of all flows to 'results', including
2256 * hidden flows (e.g., set up by in-band control). */
2258 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2260 struct oftable *table;
2262 OFPROTO_FOR_EACH_TABLE (table, p) {
2263 struct cls_cursor cursor;
2266 cls_cursor_init(&cursor, &table->cls, NULL);
2267 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2268 flow_stats_ds(rule, results);
2273 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2274 * '*engine_type' and '*engine_id', respectively. */
2276 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2277 uint8_t *engine_type, uint8_t *engine_id)
2279 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2282 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns 1
2283 * if CFM is faulted (generally indiciating a connectivity problem), 0 if CFM
2284 * is not faulted, and -1 if CFM is not enabled on 'ofp_port'. */
2286 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2288 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2289 return (ofport && ofproto->ofproto_class->get_cfm_fault
2290 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2294 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2295 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2296 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2297 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2299 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2300 uint16_t ofp_port, const uint64_t **rmps,
2303 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2307 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2308 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2314 handle_aggregate_stats_request(struct ofconn *ofconn,
2315 const struct ofp_stats_msg *osm)
2317 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2318 struct ofputil_flow_stats_request request;
2319 struct ofputil_aggregate_stats stats;
2320 bool unknown_packets, unknown_bytes;
2321 struct ofpbuf *reply;
2326 error = ofputil_decode_flow_stats_request(&request, &osm->header);
2331 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2332 request.cookie, request.cookie_mask,
2333 request.out_port, &rules);
2338 memset(&stats, 0, sizeof stats);
2339 unknown_packets = unknown_bytes = false;
2340 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2341 uint64_t packet_count;
2342 uint64_t byte_count;
2344 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2347 if (packet_count == UINT64_MAX) {
2348 unknown_packets = true;
2350 stats.packet_count += packet_count;
2353 if (byte_count == UINT64_MAX) {
2354 unknown_bytes = true;
2356 stats.byte_count += byte_count;
2361 if (unknown_packets) {
2362 stats.packet_count = UINT64_MAX;
2364 if (unknown_bytes) {
2365 stats.byte_count = UINT64_MAX;
2368 reply = ofputil_encode_aggregate_stats_reply(&stats, osm);
2369 ofconn_send_reply(ofconn, reply);
2374 struct queue_stats_cbdata {
2375 struct ofport *ofport;
2376 struct list replies;
2380 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2381 const struct netdev_queue_stats *stats)
2383 struct ofp_queue_stats *reply;
2385 reply = ofputil_append_stats_reply(sizeof *reply, &cbdata->replies);
2386 reply->port_no = cbdata->ofport->opp.port_no;
2387 memset(reply->pad, 0, sizeof reply->pad);
2388 reply->queue_id = htonl(queue_id);
2389 put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2390 put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2391 put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2395 handle_queue_stats_dump_cb(uint32_t queue_id,
2396 struct netdev_queue_stats *stats,
2399 struct queue_stats_cbdata *cbdata = cbdata_;
2401 put_queue_stats(cbdata, queue_id, stats);
2405 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2406 struct queue_stats_cbdata *cbdata)
2408 cbdata->ofport = port;
2409 if (queue_id == OFPQ_ALL) {
2410 netdev_dump_queue_stats(port->netdev,
2411 handle_queue_stats_dump_cb, cbdata);
2413 struct netdev_queue_stats stats;
2415 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2416 put_queue_stats(cbdata, queue_id, &stats);
2422 handle_queue_stats_request(struct ofconn *ofconn,
2423 const struct ofp_queue_stats_request *qsr)
2425 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2426 struct queue_stats_cbdata cbdata;
2427 struct ofport *port;
2428 unsigned int port_no;
2431 COVERAGE_INC(ofproto_queue_req);
2433 ofputil_start_stats_reply(&qsr->osm, &cbdata.replies);
2435 port_no = ntohs(qsr->port_no);
2436 queue_id = ntohl(qsr->queue_id);
2437 if (port_no == OFPP_ALL) {
2438 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2439 handle_queue_stats_for_port(port, queue_id, &cbdata);
2441 } else if (port_no < OFPP_MAX) {
2442 port = ofproto_get_port(ofproto, port_no);
2444 handle_queue_stats_for_port(port, queue_id, &cbdata);
2447 ofpbuf_list_delete(&cbdata.replies);
2448 return OFPERR_OFPQOFC_BAD_PORT;
2450 ofconn_send_replies(ofconn, &cbdata.replies);
2456 is_flow_deletion_pending(const struct ofproto *ofproto,
2457 const struct cls_rule *cls_rule,
2460 if (!hmap_is_empty(&ofproto->deletions)) {
2461 struct ofoperation *op;
2463 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2464 cls_rule_hash(cls_rule, table_id),
2465 &ofproto->deletions) {
2466 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2475 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2476 * in which no matching flow already exists in the flow table.
2478 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2479 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
2480 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
2481 * initiated now but may be retried later.
2483 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2486 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
2487 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
2489 struct oftable *table;
2490 struct ofopgroup *group;
2491 struct rule *victim;
2495 error = check_table_id(ofproto, fm->table_id);
2501 if (fm->table_id == 0xff) {
2503 if (ofproto->ofproto_class->rule_choose_table) {
2504 error = ofproto->ofproto_class->rule_choose_table(ofproto, &fm->cr,
2509 assert(table_id < ofproto->n_tables);
2510 table = &ofproto->tables[table_id];
2512 table = &ofproto->tables[0];
2514 } else if (fm->table_id < ofproto->n_tables) {
2515 table = &ofproto->tables[fm->table_id];
2517 return OFPERR_NXFMFC_BAD_TABLE_ID;
2520 /* Check for overlap, if requested. */
2521 if (fm->flags & OFPFF_CHECK_OVERLAP
2522 && classifier_rule_overlaps(&table->cls, &fm->cr)) {
2523 return OFPERR_OFPFMFC_OVERLAP;
2526 /* Serialize against pending deletion. */
2527 if (is_flow_deletion_pending(ofproto, &fm->cr, table - ofproto->tables)) {
2528 return OFPROTO_POSTPONE;
2531 /* Allocate new rule. */
2532 rule = ofproto->ofproto_class->rule_alloc();
2534 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2535 ofproto->name, strerror(error));
2538 rule->ofproto = ofproto;
2540 rule->pending = NULL;
2541 rule->flow_cookie = fm->cookie;
2542 rule->created = rule->modified = time_msec();
2543 rule->idle_timeout = fm->idle_timeout;
2544 rule->hard_timeout = fm->hard_timeout;
2545 rule->table_id = table - ofproto->tables;
2546 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2547 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2548 rule->n_actions = fm->n_actions;
2550 /* Insert new rule. */
2551 victim = oftable_replace_rule(rule);
2552 if (victim && victim->pending) {
2553 error = OFPROTO_POSTPONE;
2555 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2556 ofoperation_create(group, rule, OFOPERATION_ADD);
2557 rule->pending->victim = victim;
2559 error = ofproto->ofproto_class->rule_construct(rule);
2561 ofoperation_destroy(rule->pending);
2563 ofopgroup_submit(group);
2566 /* Back out if an error occurred. */
2568 oftable_substitute_rule(rule, victim);
2569 ofproto_rule_destroy__(rule);
2574 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2576 /* Modifies the rules listed in 'rules', changing their actions to match those
2579 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2582 * Returns 0 on success, otherwise an OpenFlow error code. */
2584 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2585 const struct ofputil_flow_mod *fm,
2586 const struct ofp_header *request, struct list *rules)
2588 struct ofopgroup *group;
2591 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2592 LIST_FOR_EACH (rule, ofproto_node, rules) {
2593 if (!ofputil_actions_equal(fm->actions, fm->n_actions,
2594 rule->actions, rule->n_actions)) {
2595 ofoperation_create(group, rule, OFOPERATION_MODIFY);
2596 rule->pending->actions = rule->actions;
2597 rule->pending->n_actions = rule->n_actions;
2598 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2599 rule->n_actions = fm->n_actions;
2600 rule->ofproto->ofproto_class->rule_modify_actions(rule);
2602 rule->modified = time_msec();
2604 rule->flow_cookie = fm->cookie;
2606 ofopgroup_submit(group);
2611 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
2614 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2617 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2618 const struct ofputil_flow_mod *fm,
2619 const struct ofp_header *request)
2624 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2625 fm->cookie, fm->cookie_mask,
2627 return (error ? error
2628 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2629 : modify_flows__(ofproto, ofconn, fm, request, &rules));
2632 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2635 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2638 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2639 const struct ofputil_flow_mod *fm,
2640 const struct ofp_header *request)
2645 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2646 fm->cookie, fm->cookie_mask,
2648 return (error ? error
2649 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2650 : list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
2651 fm, request, &rules)
2655 /* OFPFC_DELETE implementation. */
2657 /* Deletes the rules listed in 'rules'.
2659 * Returns 0 on success, otherwise an OpenFlow error code. */
2661 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2662 const struct ofp_header *request, struct list *rules)
2664 struct rule *rule, *next;
2665 struct ofopgroup *group;
2667 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
2668 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
2669 ofproto_rule_send_removed(rule, OFPRR_DELETE);
2671 ofoperation_create(group, rule, OFOPERATION_DELETE);
2672 oftable_remove_rule(rule);
2673 rule->ofproto->ofproto_class->rule_destruct(rule);
2675 ofopgroup_submit(group);
2680 /* Implements OFPFC_DELETE. */
2682 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2683 const struct ofputil_flow_mod *fm,
2684 const struct ofp_header *request)
2689 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2690 fm->cookie, fm->cookie_mask,
2691 fm->out_port, &rules);
2692 return (error ? error
2693 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
2698 /* Implements OFPFC_DELETE_STRICT. */
2700 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2701 const struct ofputil_flow_mod *fm,
2702 const struct ofp_header *request)
2707 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2708 fm->cookie, fm->cookie_mask,
2709 fm->out_port, &rules);
2710 return (error ? error
2711 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
2717 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2719 struct ofputil_flow_removed fr;
2721 if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2726 fr.cookie = rule->flow_cookie;
2728 calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2729 fr.idle_timeout = rule->idle_timeout;
2730 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2733 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2736 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2737 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2740 * ofproto implementation ->run() functions should use this function to expire
2741 * OpenFlow flows. */
2743 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2745 struct ofproto *ofproto = rule->ofproto;
2746 struct ofopgroup *group;
2748 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2750 ofproto_rule_send_removed(rule, reason);
2752 group = ofopgroup_create_unattached(ofproto);
2753 ofoperation_create(group, rule, OFOPERATION_DELETE);
2754 oftable_remove_rule(rule);
2755 rule->ofproto->ofproto_class->rule_destruct(rule);
2756 ofopgroup_submit(group);
2760 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2762 struct ofputil_flow_mod fm;
2765 error = reject_slave_controller(ofconn);
2770 error = ofputil_decode_flow_mod(&fm, oh,
2771 ofconn_get_flow_mod_table_id(ofconn));
2776 /* We do not support the emergency flow cache. It will hopefully get
2777 * dropped from OpenFlow in the near future. */
2778 if (fm.flags & OFPFF_EMERG) {
2779 /* There isn't a good fit for an error code, so just state that the
2780 * flow table is full. */
2781 return OFPERR_OFPFMFC_ALL_TABLES_FULL;
2784 return handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
2788 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
2789 const struct ofputil_flow_mod *fm,
2790 const struct ofp_header *oh)
2792 if (ofproto->n_pending >= 50) {
2793 assert(!list_is_empty(&ofproto->pending));
2794 return OFPROTO_POSTPONE;
2797 switch (fm->command) {
2799 return add_flow(ofproto, ofconn, fm, oh);
2802 return modify_flows_loose(ofproto, ofconn, fm, oh);
2804 case OFPFC_MODIFY_STRICT:
2805 return modify_flow_strict(ofproto, ofconn, fm, oh);
2808 return delete_flows_loose(ofproto, ofconn, fm, oh);
2810 case OFPFC_DELETE_STRICT:
2811 return delete_flow_strict(ofproto, ofconn, fm, oh);
2814 if (fm->command > 0xff) {
2815 VLOG_WARN_RL(&rl, "flow_mod has explicit table_id but "
2816 "flow_mod_table_id extension is not enabled");
2818 return OFPERR_OFPFMFC_BAD_COMMAND;
2823 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2825 struct nx_role_request *nrr = (struct nx_role_request *) oh;
2826 struct nx_role_request *reply;
2830 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2831 return OFPERR_OFPBRC_EPERM;
2834 role = ntohl(nrr->role);
2835 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2836 && role != NX_ROLE_SLAVE) {
2837 return OFPERR_NXBRC_BAD_ROLE;
2840 if (ofconn_get_role(ofconn) != role
2841 && ofconn_has_pending_opgroups(ofconn)) {
2842 return OFPROTO_POSTPONE;
2845 ofconn_set_role(ofconn, role);
2847 reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2848 reply->role = htonl(role);
2849 ofconn_send_reply(ofconn, buf);
2855 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
2856 const struct ofp_header *oh)
2858 const struct nx_flow_mod_table_id *msg
2859 = (const struct nx_flow_mod_table_id *) oh;
2861 ofconn_set_flow_mod_table_id(ofconn, msg->set != 0);
2866 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2868 const struct nx_set_flow_format *msg
2869 = (const struct nx_set_flow_format *) oh;
2872 format = ntohl(msg->format);
2873 if (format != NXFF_OPENFLOW10 && format != NXFF_NXM) {
2874 return OFPERR_OFPBRC_EPERM;
2877 if (format != ofconn_get_flow_format(ofconn)
2878 && ofconn_has_pending_opgroups(ofconn)) {
2879 /* Avoid sending async messages in surprising flow format. */
2880 return OFPROTO_POSTPONE;
2883 ofconn_set_flow_format(ofconn, format);
2888 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
2889 const struct ofp_header *oh)
2891 const struct nx_set_packet_in_format *msg;
2894 msg = (const struct nx_set_packet_in_format *) oh;
2895 format = ntohl(msg->format);
2896 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
2897 return OFPERR_OFPBRC_EPERM;
2900 if (format != ofconn_get_packet_in_format(ofconn)
2901 && ofconn_has_pending_opgroups(ofconn)) {
2902 /* Avoid sending async message in surprsing packet in format. */
2903 return OFPROTO_POSTPONE;
2906 ofconn_set_packet_in_format(ofconn, format);
2911 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2913 struct ofp_header *ob;
2916 if (ofconn_has_pending_opgroups(ofconn)) {
2917 return OFPROTO_POSTPONE;
2920 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2921 ofconn_send_reply(ofconn, buf);
2926 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2928 const struct ofp_header *oh = msg->data;
2929 const struct ofputil_msg_type *type;
2932 error = ofputil_decode_msg_type(oh, &type);
2937 switch (ofputil_msg_type_code(type)) {
2938 /* OpenFlow requests. */
2939 case OFPUTIL_OFPT_ECHO_REQUEST:
2940 return handle_echo_request(ofconn, oh);
2942 case OFPUTIL_OFPT_FEATURES_REQUEST:
2943 return handle_features_request(ofconn, oh);
2945 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2946 return handle_get_config_request(ofconn, oh);
2948 case OFPUTIL_OFPT_SET_CONFIG:
2949 return handle_set_config(ofconn, msg->data);
2951 case OFPUTIL_OFPT_PACKET_OUT:
2952 return handle_packet_out(ofconn, oh);
2954 case OFPUTIL_OFPT_PORT_MOD:
2955 return handle_port_mod(ofconn, oh);
2957 case OFPUTIL_OFPT_FLOW_MOD:
2958 return handle_flow_mod(ofconn, oh);
2960 case OFPUTIL_OFPT_BARRIER_REQUEST:
2961 return handle_barrier_request(ofconn, oh);
2963 /* OpenFlow replies. */
2964 case OFPUTIL_OFPT_ECHO_REPLY:
2967 /* Nicira extension requests. */
2968 case OFPUTIL_NXT_ROLE_REQUEST:
2969 return handle_role_request(ofconn, oh);
2971 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
2972 return handle_nxt_flow_mod_table_id(ofconn, oh);
2974 case OFPUTIL_NXT_SET_FLOW_FORMAT:
2975 return handle_nxt_set_flow_format(ofconn, oh);
2977 case OFPUTIL_NXT_SET_PACKET_IN_FORMAT:
2978 return handle_nxt_set_packet_in_format(ofconn, oh);
2980 case OFPUTIL_NXT_FLOW_MOD:
2981 return handle_flow_mod(ofconn, oh);
2983 /* Statistics requests. */
2984 case OFPUTIL_OFPST_DESC_REQUEST:
2985 return handle_desc_stats_request(ofconn, msg->data);
2987 case OFPUTIL_OFPST_FLOW_REQUEST:
2988 case OFPUTIL_NXST_FLOW_REQUEST:
2989 return handle_flow_stats_request(ofconn, msg->data);
2991 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
2992 case OFPUTIL_NXST_AGGREGATE_REQUEST:
2993 return handle_aggregate_stats_request(ofconn, msg->data);
2995 case OFPUTIL_OFPST_TABLE_REQUEST:
2996 return handle_table_stats_request(ofconn, msg->data);
2998 case OFPUTIL_OFPST_PORT_REQUEST:
2999 return handle_port_stats_request(ofconn, msg->data);
3001 case OFPUTIL_OFPST_QUEUE_REQUEST:
3002 return handle_queue_stats_request(ofconn, msg->data);
3004 case OFPUTIL_MSG_INVALID:
3005 case OFPUTIL_OFPT_HELLO:
3006 case OFPUTIL_OFPT_ERROR:
3007 case OFPUTIL_OFPT_FEATURES_REPLY:
3008 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
3009 case OFPUTIL_OFPT_PACKET_IN:
3010 case OFPUTIL_OFPT_FLOW_REMOVED:
3011 case OFPUTIL_OFPT_PORT_STATUS:
3012 case OFPUTIL_OFPT_BARRIER_REPLY:
3013 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
3014 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
3015 case OFPUTIL_OFPST_DESC_REPLY:
3016 case OFPUTIL_OFPST_FLOW_REPLY:
3017 case OFPUTIL_OFPST_QUEUE_REPLY:
3018 case OFPUTIL_OFPST_PORT_REPLY:
3019 case OFPUTIL_OFPST_TABLE_REPLY:
3020 case OFPUTIL_OFPST_AGGREGATE_REPLY:
3021 case OFPUTIL_NXT_ROLE_REPLY:
3022 case OFPUTIL_NXT_FLOW_REMOVED:
3023 case OFPUTIL_NXT_PACKET_IN:
3024 case OFPUTIL_NXST_FLOW_REPLY:
3025 case OFPUTIL_NXST_AGGREGATE_REPLY:
3027 if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
3028 return OFPERR_OFPBRC_BAD_STAT;
3030 return OFPERR_OFPBRC_BAD_TYPE;
3036 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
3038 int error = handle_openflow__(ofconn, ofp_msg);
3039 if (error && error != OFPROTO_POSTPONE) {
3040 ofconn_send_error(ofconn, ofp_msg->data, error);
3042 COVERAGE_INC(ofproto_recv_openflow);
3043 return error != OFPROTO_POSTPONE;
3046 /* Asynchronous operations. */
3048 /* Creates and returns a new ofopgroup that is not associated with any
3049 * OpenFlow connection.
3051 * The caller should add operations to the returned group with
3052 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3053 static struct ofopgroup *
3054 ofopgroup_create_unattached(struct ofproto *ofproto)
3056 struct ofopgroup *group = xzalloc(sizeof *group);
3057 group->ofproto = ofproto;
3058 list_init(&group->ofproto_node);
3059 list_init(&group->ops);
3060 list_init(&group->ofconn_node);
3064 /* Creates and returns a new ofopgroup for 'ofproto'.
3066 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
3067 * connection. The 'request' and 'buffer_id' arguments are ignored.
3069 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
3070 * If the ofopgroup eventually fails, then the error reply will include
3071 * 'request'. If the ofopgroup eventually succeeds, then the packet with
3072 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
3074 * The caller should add operations to the returned group with
3075 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3076 static struct ofopgroup *
3077 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
3078 const struct ofp_header *request, uint32_t buffer_id)
3080 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3082 size_t request_len = ntohs(request->length);
3084 assert(ofconn_get_ofproto(ofconn) == ofproto);
3086 ofconn_add_opgroup(ofconn, &group->ofconn_node);
3087 group->ofconn = ofconn;
3088 group->request = xmemdup(request, MIN(request_len, 64));
3089 group->buffer_id = buffer_id;
3094 /* Submits 'group' for processing.
3096 * If 'group' contains no operations (e.g. none were ever added, or all of the
3097 * ones that were added completed synchronously), then it is destroyed
3098 * immediately. Otherwise it is added to the ofproto's list of pending
3101 ofopgroup_submit(struct ofopgroup *group)
3103 if (list_is_empty(&group->ops)) {
3104 ofopgroup_destroy(group);
3106 list_push_back(&group->ofproto->pending, &group->ofproto_node);
3107 group->ofproto->n_pending++;
3112 ofopgroup_destroy(struct ofopgroup *group)
3114 assert(list_is_empty(&group->ops));
3115 if (!list_is_empty(&group->ofproto_node)) {
3116 assert(group->ofproto->n_pending > 0);
3117 group->ofproto->n_pending--;
3118 list_remove(&group->ofproto_node);
3120 if (!list_is_empty(&group->ofconn_node)) {
3121 list_remove(&group->ofconn_node);
3123 ofconn_send_error(group->ofconn, group->request, group->error);
3125 connmgr_retry(group->ofproto->connmgr);
3127 free(group->request);
3131 /* Initiates a new operation on 'rule', of the specified 'type', within
3132 * 'group'. Prior to calling, 'rule' must not have any pending operation. */
3134 ofoperation_create(struct ofopgroup *group, struct rule *rule,
3135 enum ofoperation_type type)
3137 struct ofoperation *op;
3139 assert(!rule->pending);
3141 op = rule->pending = xzalloc(sizeof *op);
3143 list_push_back(&group->ops, &op->group_node);
3147 op->flow_cookie = rule->flow_cookie;
3149 if (type == OFOPERATION_DELETE) {
3150 hmap_insert(&op->group->ofproto->deletions, &op->hmap_node,
3151 cls_rule_hash(&rule->cr, rule->table_id));
3156 ofoperation_destroy(struct ofoperation *op)
3158 struct ofopgroup *group = op->group;
3161 op->rule->pending = NULL;
3163 if (op->type == OFOPERATION_DELETE) {
3164 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
3166 list_remove(&op->group_node);
3170 if (list_is_empty(&group->ops) && !list_is_empty(&group->ofproto_node)) {
3171 ofopgroup_destroy(group);
3175 /* Indicates that 'op' completed with status 'error', which is either 0 to
3176 * indicate success or an OpenFlow error code on failure.
3178 * If 'error' is 0, indicating success, the operation will be committed
3179 * permanently to the flow table. There is one interesting subcase:
3181 * - If 'op' is an "add flow" operation that is replacing an existing rule in
3182 * the flow table (the "victim" rule) by a new one, then the caller must
3183 * have uninitialized any derived state in the victim rule, as in step 5 in
3184 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
3185 * performs steps 6 and 7 for the victim rule, most notably by calling its
3186 * ->rule_dealloc() function.
3188 * If 'error' is nonzero, then generally the operation will be rolled back:
3190 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
3191 * restores the original rule. The caller must have uninitialized any
3192 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
3193 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
3194 * and 7 for the new rule, calling its ->rule_dealloc() function.
3196 * - If 'op' is a "modify flow" operation, ofproto restores the original
3199 * - 'op' must not be a "delete flow" operation. Removing a rule is not
3200 * allowed to fail. It must always succeed.
3202 * Please see the large comment in ofproto/ofproto-provider.h titled
3203 * "Asynchronous Operation Support" for more information. */
3205 ofoperation_complete(struct ofoperation *op, enum ofperr error)
3207 struct ofopgroup *group = op->group;
3208 struct rule *rule = op->rule;
3209 struct ofproto *ofproto = rule->ofproto;
3211 assert(rule->pending == op);
3212 assert(op->status < 0);
3216 && op->type != OFOPERATION_DELETE
3218 && group->buffer_id != UINT32_MAX
3219 && list_is_singleton(&op->group_node)) {
3220 struct ofpbuf *packet;
3223 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
3227 error = rule_execute(rule, in_port, packet);
3230 if (!group->error) {
3231 group->error = error;
3235 case OFOPERATION_ADD:
3238 ofproto_rule_destroy__(op->victim);
3240 if ((rule->cr.wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3241 == htons(VLAN_VID_MASK)) {
3242 if (ofproto->vlan_bitmap) {
3243 uint16_t vid = vlan_tci_to_vid(rule->cr.flow.vlan_tci);
3245 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
3246 bitmap_set1(ofproto->vlan_bitmap, vid);
3247 ofproto->vlans_changed = true;
3250 ofproto->vlans_changed = true;
3254 oftable_substitute_rule(rule, op->victim);
3255 ofproto_rule_destroy__(rule);
3260 case OFOPERATION_DELETE:
3262 ofproto_rule_destroy__(rule);
3266 case OFOPERATION_MODIFY:
3268 rule->modified = time_msec();
3270 free(rule->actions);
3271 rule->actions = op->actions;
3272 rule->n_actions = op->n_actions;
3280 ofoperation_destroy(op);
3284 ofoperation_get_victim(struct ofoperation *op)
3286 assert(op->type == OFOPERATION_ADD);
3291 pick_datapath_id(const struct ofproto *ofproto)
3293 const struct ofport *port;
3295 port = ofproto_get_port(ofproto, OFPP_LOCAL);
3297 uint8_t ea[ETH_ADDR_LEN];
3300 error = netdev_get_etheraddr(port->netdev, ea);
3302 return eth_addr_to_uint64(ea);
3304 VLOG_WARN("could not get MAC address for %s (%s)",
3305 netdev_get_name(port->netdev), strerror(error));
3307 return ofproto->fallback_dpid;
3311 pick_fallback_dpid(void)
3313 uint8_t ea[ETH_ADDR_LEN];
3314 eth_addr_nicira_random(ea);
3315 return eth_addr_to_uint64(ea);
3320 /* Initializes 'table'. */
3322 oftable_init(struct oftable *table)
3324 classifier_init(&table->cls);
3327 /* Destroys 'table'.
3329 * The caller is responsible for freeing 'table' itself. */
3331 oftable_destroy(struct oftable *table)
3333 assert(classifier_is_empty(&table->cls));
3334 classifier_destroy(&table->cls);
3337 /* Removes 'rule' from the oftable that contains it. */
3339 oftable_remove_rule(struct rule *rule)
3341 struct ofproto *ofproto = rule->ofproto;
3342 struct oftable *table = &ofproto->tables[rule->table_id];
3344 classifier_remove(&table->cls, &rule->cr);
3347 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
3348 * oftable that has an identical cls_rule. Returns the rule that was removed,
3349 * if any, and otherwise NULL. */
3350 static struct rule *
3351 oftable_replace_rule(struct rule *rule)
3353 struct ofproto *ofproto = rule->ofproto;
3354 struct oftable *table = &ofproto->tables[rule->table_id];
3356 return rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
3359 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
3361 oftable_substitute_rule(struct rule *old, struct rule *new)
3364 oftable_replace_rule(new);
3366 oftable_remove_rule(old);
3370 /* unixctl commands. */
3373 ofproto_lookup(const char *name)
3375 struct ofproto *ofproto;
3377 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
3379 if (!strcmp(ofproto->name, name)) {
3387 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
3388 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
3390 struct ofproto *ofproto;
3394 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
3395 ds_put_format(&results, "%s\n", ofproto->name);
3397 unixctl_command_reply(conn, 200, ds_cstr(&results));
3398 ds_destroy(&results);
3402 ofproto_unixctl_init(void)
3404 static bool registered;
3410 unixctl_command_register("ofproto/list", "", 0, 0,
3411 ofproto_unixctl_list, NULL);
3414 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
3416 * This is deprecated. It is only for compatibility with broken device drivers
3417 * in old versions of Linux that do not properly support VLANs when VLAN
3418 * devices are not used. When broken device drivers are no longer in
3419 * widespread use, we will delete these interfaces. */
3421 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
3422 * (exactly) by an OpenFlow rule in 'ofproto'. */
3424 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
3426 const struct oftable *oftable;
3428 free(ofproto->vlan_bitmap);
3429 ofproto->vlan_bitmap = bitmap_allocate(4096);
3430 ofproto->vlans_changed = false;
3432 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
3433 const struct cls_table *table;
3435 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
3436 if ((table->wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3437 == htons(VLAN_VID_MASK)) {
3438 const struct cls_rule *rule;
3440 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
3441 uint16_t vid = vlan_tci_to_vid(rule->flow.vlan_tci);
3442 bitmap_set1(vlan_bitmap, vid);
3443 bitmap_set1(ofproto->vlan_bitmap, vid);
3450 /* Returns true if new VLANs have come into use by the flow table since the
3451 * last call to ofproto_get_vlan_usage().
3453 * We don't track when old VLANs stop being used. */
3455 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
3457 return ofproto->vlans_changed;
3460 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
3461 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
3462 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
3463 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
3464 * then the VLAN device is un-enslaved. */
3466 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
3467 uint16_t realdev_ofp_port, int vid)
3469 struct ofport *ofport;
3472 assert(vlandev_ofp_port != realdev_ofp_port);
3474 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
3476 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
3477 ofproto->name, vlandev_ofp_port);
3481 if (!ofproto->ofproto_class->set_realdev) {
3482 if (!vlandev_ofp_port) {
3485 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
3489 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
3491 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
3492 ofproto->name, vlandev_ofp_port,
3493 netdev_get_name(ofport->netdev), strerror(error));