2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
24 #include "byte-order.h"
25 #include "classifier.h"
28 #include "dynamic-string.h"
33 #include "ofp-print.h"
36 #include "ofproto-provider.h"
37 #include "openflow/nicira-ext.h"
38 #include "openflow/openflow.h"
42 #include "poll-loop.h"
46 #include "unaligned.h"
50 VLOG_DEFINE_THIS_MODULE(ofproto);
52 COVERAGE_DEFINE(ofproto_error);
53 COVERAGE_DEFINE(ofproto_flush);
54 COVERAGE_DEFINE(ofproto_no_packet_in);
55 COVERAGE_DEFINE(ofproto_packet_out);
56 COVERAGE_DEFINE(ofproto_queue_req);
57 COVERAGE_DEFINE(ofproto_recv_openflow);
58 COVERAGE_DEFINE(ofproto_reinit_ports);
59 COVERAGE_DEFINE(ofproto_uninstallable);
60 COVERAGE_DEFINE(ofproto_update_port);
63 S_OPENFLOW, /* Processing OpenFlow commands. */
64 S_FLUSH, /* Deleting all flow table rules. */
67 enum ofoperation_type {
73 /* A single OpenFlow request can execute any number of operations. The
74 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
75 * ofconn to which an error reply should be sent if necessary.
77 * ofproto initiates some operations internally. These operations are still
78 * assigned to groups but will not have an associated ofconn. */
80 struct ofproto *ofproto; /* Owning ofproto. */
81 struct list ofproto_node; /* In ofproto's "pending" list. */
82 struct list ops; /* List of "struct ofoperation"s. */
84 /* Data needed to send OpenFlow reply on failure or to send a buffered
87 * If list_is_empty(ofconn_node) then this ofopgroup never had an
88 * associated ofconn or its ofconn's connection dropped after it initiated
89 * the operation. In the latter case 'ofconn' is a wild pointer that
90 * refers to freed memory, so the 'ofconn' member must be used only if
91 * !list_is_empty(ofconn_node).
93 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
94 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
95 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
96 uint32_t buffer_id; /* Buffer id from original request. */
97 int error; /* 0 if no error yet, otherwise error code. */
100 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
101 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
102 const struct ofp_header *,
104 static void ofopgroup_submit(struct ofopgroup *);
105 static void ofopgroup_destroy(struct ofopgroup *);
107 /* A single flow table operation. */
109 struct ofopgroup *group; /* Owning group. */
110 struct list group_node; /* In ofopgroup's "ops" list. */
111 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
112 struct rule *rule; /* Rule being operated upon. */
113 enum ofoperation_type type; /* Type of operation. */
114 int status; /* -1 if pending, otherwise 0 or error code. */
115 struct rule *victim; /* OFOPERATION_ADDING: Replaced rule. */
116 union ofp_action *actions; /* OFOPERATION_MODIFYING: Replaced actions. */
117 int n_actions; /* OFOPERATION_MODIFYING: # of old actions. */
118 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
121 static void ofoperation_create(struct ofopgroup *, struct rule *,
122 enum ofoperation_type);
123 static void ofoperation_destroy(struct ofoperation *);
125 static void ofport_destroy__(struct ofport *);
126 static void ofport_destroy(struct ofport *);
128 static uint64_t pick_datapath_id(const struct ofproto *);
129 static uint64_t pick_fallback_dpid(void);
131 static void ofproto_destroy__(struct ofproto *);
133 static void ofproto_rule_destroy__(struct rule *);
134 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
136 static void ofopgroup_destroy(struct ofopgroup *);
138 static int add_flow(struct ofproto *, struct ofconn *,
139 const struct ofputil_flow_mod *,
140 const struct ofp_header *);
142 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
143 static int handle_flow_mod__(struct ofproto *, struct ofconn *,
144 const struct ofputil_flow_mod *,
145 const struct ofp_header *);
147 static void update_port(struct ofproto *, const char *devname);
148 static int init_ports(struct ofproto *);
149 static void reinit_ports(struct ofproto *);
150 static void set_internal_devs_mtu(struct ofproto *);
152 static void ofproto_unixctl_init(void);
154 /* All registered ofproto classes, in probe order. */
155 static const struct ofproto_class **ofproto_classes;
156 static size_t n_ofproto_classes;
157 static size_t allocated_ofproto_classes;
159 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
160 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
162 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
165 ofproto_initialize(void)
171 ofproto_class_register(&ofproto_dpif_class);
175 /* 'type' should be a normalized datapath type, as returned by
176 * ofproto_normalize_type(). Returns the corresponding ofproto_class
177 * structure, or a null pointer if there is none registered for 'type'. */
178 static const struct ofproto_class *
179 ofproto_class_find__(const char *type)
183 ofproto_initialize();
184 for (i = 0; i < n_ofproto_classes; i++) {
185 const struct ofproto_class *class = ofproto_classes[i];
190 class->enumerate_types(&types);
191 found = sset_contains(&types, type);
192 sset_destroy(&types);
198 VLOG_WARN("unknown datapath type %s", type);
202 /* Registers a new ofproto class. After successful registration, new ofprotos
203 * of that type can be created using ofproto_create(). */
205 ofproto_class_register(const struct ofproto_class *new_class)
209 for (i = 0; i < n_ofproto_classes; i++) {
210 if (ofproto_classes[i] == new_class) {
215 if (n_ofproto_classes >= allocated_ofproto_classes) {
216 ofproto_classes = x2nrealloc(ofproto_classes,
217 &allocated_ofproto_classes,
218 sizeof *ofproto_classes);
220 ofproto_classes[n_ofproto_classes++] = new_class;
224 /* Unregisters a datapath provider. 'type' must have been previously
225 * registered and not currently be in use by any ofprotos. After
226 * unregistration new datapaths of that type cannot be opened using
227 * ofproto_create(). */
229 ofproto_class_unregister(const struct ofproto_class *class)
233 for (i = 0; i < n_ofproto_classes; i++) {
234 if (ofproto_classes[i] == class) {
235 for (i++; i < n_ofproto_classes; i++) {
236 ofproto_classes[i - 1] = ofproto_classes[i];
242 VLOG_WARN("attempted to unregister an ofproto class that is not "
247 /* Clears 'types' and enumerates all registered ofproto types into it. The
248 * caller must first initialize the sset. */
250 ofproto_enumerate_types(struct sset *types)
254 ofproto_initialize();
255 for (i = 0; i < n_ofproto_classes; i++) {
256 ofproto_classes[i]->enumerate_types(types);
260 /* Returns the fully spelled out name for the given ofproto 'type'.
262 * Normalized type string can be compared with strcmp(). Unnormalized type
263 * string might be the same even if they have different spellings. */
265 ofproto_normalize_type(const char *type)
267 return type && type[0] ? type : "system";
270 /* Clears 'names' and enumerates the names of all known created ofprotos with
271 * the given 'type'. The caller must first initialize the sset. Returns 0 if
272 * successful, otherwise a positive errno value.
274 * Some kinds of datapaths might not be practically enumerable. This is not
275 * considered an error. */
277 ofproto_enumerate_names(const char *type, struct sset *names)
279 const struct ofproto_class *class = ofproto_class_find__(type);
280 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
284 ofproto_create(const char *datapath_name, const char *datapath_type,
285 struct ofproto **ofprotop)
287 const struct ofproto_class *class;
288 struct classifier *table;
289 struct ofproto *ofproto;
295 ofproto_initialize();
296 ofproto_unixctl_init();
298 datapath_type = ofproto_normalize_type(datapath_type);
299 class = ofproto_class_find__(datapath_type);
301 VLOG_WARN("could not create datapath %s of unknown type %s",
302 datapath_name, datapath_type);
306 ofproto = class->alloc();
308 VLOG_ERR("failed to allocate datapath %s of type %s",
309 datapath_name, datapath_type);
314 memset(ofproto, 0, sizeof *ofproto);
315 ofproto->ofproto_class = class;
316 ofproto->name = xstrdup(datapath_name);
317 ofproto->type = xstrdup(datapath_type);
318 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
319 hash_string(ofproto->name, 0));
320 ofproto->datapath_id = 0;
321 ofproto_set_flow_eviction_threshold(ofproto,
322 OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT);
323 ofproto->forward_bpdu = false;
324 ofproto->fallback_dpid = pick_fallback_dpid();
325 ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
326 ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
327 ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
328 ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
329 ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
330 ofproto->frag_handling = OFPC_FRAG_NORMAL;
331 hmap_init(&ofproto->ports);
332 shash_init(&ofproto->port_by_name);
333 ofproto->tables = NULL;
334 ofproto->n_tables = 0;
335 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
336 ofproto->state = S_OPENFLOW;
337 list_init(&ofproto->pending);
338 ofproto->n_pending = 0;
339 hmap_init(&ofproto->deletions);
341 error = ofproto->ofproto_class->construct(ofproto, &n_tables);
343 VLOG_ERR("failed to open datapath %s: %s",
344 datapath_name, strerror(error));
345 ofproto_destroy__(ofproto);
349 assert(n_tables >= 1 && n_tables <= 255);
350 ofproto->n_tables = n_tables;
351 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
352 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
353 classifier_init(table);
356 ofproto->datapath_id = pick_datapath_id(ofproto);
357 VLOG_INFO("using datapath ID %016"PRIx64, ofproto->datapath_id);
365 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
367 uint64_t old_dpid = p->datapath_id;
368 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
369 if (p->datapath_id != old_dpid) {
370 VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
372 /* Force all active connections to reconnect, since there is no way to
373 * notify a controller that the datapath ID has changed. */
374 ofproto_reconnect_controllers(p);
379 ofproto_set_controllers(struct ofproto *p,
380 const struct ofproto_controller *controllers,
381 size_t n_controllers)
383 connmgr_set_controllers(p->connmgr, controllers, n_controllers);
387 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
389 connmgr_set_fail_mode(p->connmgr, fail_mode);
392 /* Drops the connections between 'ofproto' and all of its controllers, forcing
393 * them to reconnect. */
395 ofproto_reconnect_controllers(struct ofproto *ofproto)
397 connmgr_reconnect(ofproto->connmgr);
400 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
401 * in-band control should guarantee access, in the same way that in-band
402 * control guarantees access to OpenFlow controllers. */
404 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
405 const struct sockaddr_in *extras, size_t n)
407 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
410 /* Sets the OpenFlow queue used by flows set up by in-band control on
411 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
412 * flows will use the default queue. */
414 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
416 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
419 /* Sets the number of flows at which eviction from the kernel flow table
422 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
424 if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
425 ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
427 ofproto->flow_eviction_threshold = threshold;
431 /* If forward_bpdu is true, the NORMAL action will forward frames with
432 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
433 * the NORMAL action will drop these frames. */
435 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
437 bool old_val = ofproto->forward_bpdu;
438 ofproto->forward_bpdu = forward_bpdu;
439 if (old_val != ofproto->forward_bpdu) {
440 if (ofproto->ofproto_class->forward_bpdu_changed) {
441 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
447 ofproto_set_desc(struct ofproto *p,
448 const char *mfr_desc, const char *hw_desc,
449 const char *sw_desc, const char *serial_desc,
452 struct ofp_desc_stats *ods;
455 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
456 VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
457 sizeof ods->mfr_desc);
460 p->mfr_desc = xstrdup(mfr_desc);
463 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
464 VLOG_WARN("truncating hw_desc, must be less than %zu characters",
465 sizeof ods->hw_desc);
468 p->hw_desc = xstrdup(hw_desc);
471 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
472 VLOG_WARN("truncating sw_desc, must be less than %zu characters",
473 sizeof ods->sw_desc);
476 p->sw_desc = xstrdup(sw_desc);
479 if (strlen(serial_desc) >= sizeof ods->serial_num) {
480 VLOG_WARN("truncating serial_desc, must be less than %zu "
482 sizeof ods->serial_num);
484 free(p->serial_desc);
485 p->serial_desc = xstrdup(serial_desc);
488 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
489 VLOG_WARN("truncating dp_desc, must be less than %zu characters",
490 sizeof ods->dp_desc);
493 p->dp_desc = xstrdup(dp_desc);
498 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
500 return connmgr_set_snoops(ofproto->connmgr, snoops);
504 ofproto_set_netflow(struct ofproto *ofproto,
505 const struct netflow_options *nf_options)
507 if (nf_options && sset_is_empty(&nf_options->collectors)) {
511 if (ofproto->ofproto_class->set_netflow) {
512 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
514 return nf_options ? EOPNOTSUPP : 0;
519 ofproto_set_sflow(struct ofproto *ofproto,
520 const struct ofproto_sflow_options *oso)
522 if (oso && sset_is_empty(&oso->targets)) {
526 if (ofproto->ofproto_class->set_sflow) {
527 return ofproto->ofproto_class->set_sflow(ofproto, oso);
529 return oso ? EOPNOTSUPP : 0;
533 /* Spanning Tree Protocol (STP) configuration. */
535 /* Configures STP on 'ofproto' using the settings defined in 's'. If
536 * 's' is NULL, disables STP.
538 * Returns 0 if successful, otherwise a positive errno value. */
540 ofproto_set_stp(struct ofproto *ofproto,
541 const struct ofproto_stp_settings *s)
543 return (ofproto->ofproto_class->set_stp
544 ? ofproto->ofproto_class->set_stp(ofproto, s)
548 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
549 * 'enabled' member of 's' is false, then the other members are not
552 * Returns 0 if successful, otherwise a positive errno value. */
554 ofproto_get_stp_status(struct ofproto *ofproto,
555 struct ofproto_stp_status *s)
557 return (ofproto->ofproto_class->get_stp_status
558 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
562 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
563 * in 's'. The caller is responsible for assigning STP port numbers
564 * (using the 'port_num' member in the range of 1 through 255, inclusive)
565 * and ensuring there are no duplicates. If the 's' is NULL, then STP
566 * is disabled on the port.
568 * Returns 0 if successful, otherwise a positive errno value.*/
570 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
571 const struct ofproto_port_stp_settings *s)
573 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
575 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
576 ofproto->name, ofp_port);
580 return (ofproto->ofproto_class->set_stp_port
581 ? ofproto->ofproto_class->set_stp_port(ofport, s)
585 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
586 * 's'. If the 'enabled' member in 's' is false, then the other members
587 * are not meaningful.
589 * Returns 0 if successful, otherwise a positive errno value.*/
591 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
592 struct ofproto_port_stp_status *s)
594 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
596 VLOG_WARN("%s: cannot get STP status on nonexistent port %"PRIu16,
597 ofproto->name, ofp_port);
601 return (ofproto->ofproto_class->get_stp_port_status
602 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
606 /* Queue DSCP configuration. */
608 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
609 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
610 * to implement QoS. Instead, it is used to implement features which require
611 * knowledge of what queues exist on a port, and some basic information about
614 * Returns 0 if successful, otherwise a positive errno value. */
616 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
617 const struct ofproto_port_queue *queues,
620 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
623 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
624 ofproto->name, ofp_port);
628 return (ofproto->ofproto_class->set_queues
629 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
633 /* Connectivity Fault Management configuration. */
635 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
637 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
639 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
640 if (ofport && ofproto->ofproto_class->set_cfm) {
641 ofproto->ofproto_class->set_cfm(ofport, NULL);
645 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
646 * basic configuration from the configuration members in 'cfm', and the remote
647 * maintenance point ID from remote_mpid. Ignores the statistics members of
650 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
652 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
653 const struct cfm_settings *s)
655 struct ofport *ofport;
658 ofport = ofproto_get_port(ofproto, ofp_port);
660 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
661 ofproto->name, ofp_port);
665 /* XXX: For configuration simplicity, we only support one remote_mpid
666 * outside of the CFM module. It's not clear if this is the correct long
667 * term solution or not. */
668 error = (ofproto->ofproto_class->set_cfm
669 ? ofproto->ofproto_class->set_cfm(ofport, s)
672 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
673 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
678 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
679 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
680 * 0 if LACP partner information is not current (generally indicating a
681 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
683 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
685 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
686 return (ofport && ofproto->ofproto_class->port_is_lacp_current
687 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
693 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
694 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
695 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
696 * configuration plus, if there is more than one slave, a bonding
699 * If 'aux' is already registered then this function updates its configuration
700 * to 's'. Otherwise, this function registers a new bundle.
702 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
705 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
706 const struct ofproto_bundle_settings *s)
708 return (ofproto->ofproto_class->bundle_set
709 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
713 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
714 * If no such bundle has been registered, this has no effect. */
716 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
718 return ofproto_bundle_register(ofproto, aux, NULL);
722 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
723 * If 'aux' is already registered then this function updates its configuration
724 * to 's'. Otherwise, this function registers a new mirror.
726 * Mirrors affect only the treatment of packets output to the OFPP_NORMAL
729 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
730 const struct ofproto_mirror_settings *s)
732 return (ofproto->ofproto_class->mirror_set
733 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
737 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
738 * If no mirror has been registered, this has no effect. */
740 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
742 return ofproto_mirror_register(ofproto, aux, NULL);
745 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
746 * which all packets are flooded, instead of using MAC learning. If
747 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
749 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
752 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
754 return (ofproto->ofproto_class->set_flood_vlans
755 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
759 /* Returns true if 'aux' is a registered bundle that is currently in use as the
760 * output for a mirror. */
762 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
764 return (ofproto->ofproto_class->is_mirror_output_bundle
765 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
770 ofproto_has_snoops(const struct ofproto *ofproto)
772 return connmgr_has_snoops(ofproto->connmgr);
776 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
778 connmgr_get_snoops(ofproto->connmgr, snoops);
782 ofproto_flush__(struct ofproto *ofproto)
784 struct classifier *table;
785 struct ofopgroup *group;
787 if (ofproto->ofproto_class->flush) {
788 ofproto->ofproto_class->flush(ofproto);
791 group = ofopgroup_create_unattached(ofproto);
792 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
793 struct rule *rule, *next_rule;
794 struct cls_cursor cursor;
796 cls_cursor_init(&cursor, table, NULL);
797 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
798 if (!rule->pending) {
799 ofoperation_create(group, rule, OFOPERATION_DELETE);
800 classifier_remove(table, &rule->cr);
801 ofproto->ofproto_class->rule_destruct(rule);
805 ofopgroup_submit(group);
809 ofproto_destroy__(struct ofproto *ofproto)
811 struct classifier *table;
813 assert(list_is_empty(&ofproto->pending));
814 assert(!ofproto->n_pending);
816 connmgr_destroy(ofproto->connmgr);
818 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
821 free(ofproto->mfr_desc);
822 free(ofproto->hw_desc);
823 free(ofproto->sw_desc);
824 free(ofproto->serial_desc);
825 free(ofproto->dp_desc);
826 hmap_destroy(&ofproto->ports);
827 shash_destroy(&ofproto->port_by_name);
829 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
830 assert(classifier_is_empty(table));
831 classifier_destroy(table);
833 free(ofproto->tables);
835 hmap_destroy(&ofproto->deletions);
837 ofproto->ofproto_class->dealloc(ofproto);
841 ofproto_destroy(struct ofproto *p)
843 struct ofport *ofport, *next_ofport;
850 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
851 ofport_destroy(ofport);
854 p->ofproto_class->destruct(p);
855 ofproto_destroy__(p);
858 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
859 * kernel datapath, for example, this destroys the datapath in the kernel, and
860 * with the netdev-based datapath, it tears down the data structures that
861 * represent the datapath.
863 * The datapath should not be currently open as an ofproto. */
865 ofproto_delete(const char *name, const char *type)
867 const struct ofproto_class *class = ofproto_class_find__(type);
868 return (!class ? EAFNOSUPPORT
869 : !class->del ? EACCES
870 : class->del(type, name));
874 process_port_change(struct ofproto *ofproto, int error, char *devname)
876 if (error == ENOBUFS) {
877 reinit_ports(ofproto);
879 update_port(ofproto, devname);
885 ofproto_run(struct ofproto *p)
887 struct ofport *ofport;
891 error = p->ofproto_class->run(p);
892 if (error == ENODEV) {
893 /* Someone destroyed the datapath behind our back. The caller
894 * better destroy us and give up, because we're just going to
895 * spin from here on out. */
896 static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
897 VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
902 if (p->ofproto_class->port_poll) {
903 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
904 process_port_change(p, error, devname);
908 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
909 unsigned int change_seq = netdev_change_seq(ofport->netdev);
910 if (ofport->change_seq != change_seq) {
911 ofport->change_seq = change_seq;
912 update_port(p, netdev_get_name(ofport->netdev));
919 connmgr_run(p->connmgr, handle_openflow);
923 connmgr_run(p->connmgr, NULL);
925 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
926 connmgr_flushed(p->connmgr);
927 p->state = S_OPENFLOW;
939 ofproto_wait(struct ofproto *p)
941 struct ofport *ofport;
943 p->ofproto_class->wait(p);
944 if (p->ofproto_class->port_poll_wait) {
945 p->ofproto_class->port_poll_wait(p);
948 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
949 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
950 poll_immediate_wake();
956 connmgr_wait(p->connmgr, true);
960 connmgr_wait(p->connmgr, false);
961 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
962 poll_immediate_wake();
969 ofproto_is_alive(const struct ofproto *p)
971 return connmgr_has_controllers(p->connmgr);
975 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
978 connmgr_get_controller_info(ofproto->connmgr, info);
982 ofproto_free_ofproto_controller_info(struct shash *info)
984 connmgr_free_controller_info(info);
987 /* Makes a deep copy of 'old' into 'port'. */
989 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
991 port->name = xstrdup(old->name);
992 port->type = xstrdup(old->type);
993 port->ofp_port = old->ofp_port;
996 /* Frees memory allocated to members of 'ofproto_port'.
998 * Do not call this function on an ofproto_port obtained from
999 * ofproto_port_dump_next(): that function retains ownership of the data in the
1002 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1004 free(ofproto_port->name);
1005 free(ofproto_port->type);
1008 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1010 * This function provides no status indication. An error status for the entire
1011 * dump operation is provided when it is completed by calling
1012 * ofproto_port_dump_done().
1015 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1016 const struct ofproto *ofproto)
1018 dump->ofproto = ofproto;
1019 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1023 /* Attempts to retrieve another port from 'dump', which must have been created
1024 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1025 * 'port' and returns true. On failure, returns false.
1027 * Failure might indicate an actual error or merely that the last port has been
1028 * dumped. An error status for the entire dump operation is provided when it
1029 * is completed by calling ofproto_port_dump_done().
1031 * The ofproto owns the data stored in 'port'. It will remain valid until at
1032 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1033 * ofproto_port_dump_done(). */
1035 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1036 struct ofproto_port *port)
1038 const struct ofproto *ofproto = dump->ofproto;
1044 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1047 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1053 /* Completes port table dump operation 'dump', which must have been created
1054 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1055 * error-free, otherwise a positive errno value describing the problem. */
1057 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1059 const struct ofproto *ofproto = dump->ofproto;
1061 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1064 return dump->error == EOF ? 0 : dump->error;
1067 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
1068 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
1069 * is non-null). On failure, returns a positive errno value and sets
1070 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
1072 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1073 uint16_t *ofp_portp)
1078 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
1080 update_port(ofproto, netdev_get_name(netdev));
1083 *ofp_portp = error ? OFPP_NONE : ofp_port;
1088 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1089 * initializes '*port' appropriately; on failure, returns a positive errno
1092 * The caller owns the data in 'ofproto_port' and must free it with
1093 * ofproto_port_destroy() when it is no longer needed. */
1095 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1096 struct ofproto_port *port)
1100 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1102 memset(port, 0, sizeof *port);
1107 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1108 * Returns 0 if successful, otherwise a positive errno. */
1110 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1112 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1113 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1116 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1117 if (!error && ofport) {
1118 /* 'name' is the netdev's name and update_port() is going to close the
1119 * netdev. Just in case update_port() refers to 'name' after it
1120 * destroys 'ofport', make a copy of it around the update_port()
1122 char *devname = xstrdup(name);
1123 update_port(ofproto, devname);
1129 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1130 * performs the 'n_actions' actions in 'actions'. The new flow will not
1133 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1134 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1135 * controllers; otherwise, it will be hidden.
1137 * The caller retains ownership of 'cls_rule' and 'actions'.
1139 * This is a helper function for in-band control and fail-open. */
1141 ofproto_add_flow(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1142 const union ofp_action *actions, size_t n_actions)
1144 const struct rule *rule;
1146 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1147 &ofproto->tables[0], cls_rule));
1148 if (!rule || !ofputil_actions_equal(rule->actions, rule->n_actions,
1149 actions, n_actions)) {
1150 struct ofputil_flow_mod fm;
1152 memset(&fm, 0, sizeof fm);
1154 fm.buffer_id = UINT32_MAX;
1155 fm.actions = (union ofp_action *) actions;
1156 fm.n_actions = n_actions;
1157 add_flow(ofproto, NULL, &fm, NULL);
1161 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1162 * OpenFlow error code as encoded by ofp_mkerr() on failure, or
1163 * OFPROTO_POSTPONE if the operation cannot be initiated now but may be retried
1166 * This is a helper function for in-band control and fail-open. */
1168 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1170 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1173 /* Searches for a rule with matching criteria exactly equal to 'target' in
1174 * ofproto's table 0 and, if it finds one, deletes it.
1176 * This is a helper function for in-band control and fail-open. */
1178 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1182 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1183 &ofproto->tables[0], target));
1185 /* No such rule -> success. */
1187 } else if (rule->pending) {
1188 /* An operation on the rule is already pending -> failure.
1189 * Caller must retry later if it's important. */
1192 /* Initiate deletion -> success. */
1193 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1194 ofoperation_create(group, rule, OFOPERATION_DELETE);
1195 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
1196 rule->ofproto->ofproto_class->rule_destruct(rule);
1197 ofopgroup_submit(group);
1203 /* Starts the process of deleting all of the flows from all of ofproto's flow
1204 * tables and then reintroducing the flows required by in-band control and
1205 * fail-open. The process will complete in a later call to ofproto_run(). */
1207 ofproto_flush_flows(struct ofproto *ofproto)
1209 COVERAGE_INC(ofproto_flush);
1210 ofproto->state = S_FLUSH;
1214 reinit_ports(struct ofproto *p)
1216 struct ofproto_port_dump dump;
1217 struct sset devnames;
1218 struct ofport *ofport;
1219 struct ofproto_port ofproto_port;
1220 const char *devname;
1222 COVERAGE_INC(ofproto_reinit_ports);
1224 sset_init(&devnames);
1225 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1226 sset_add(&devnames, netdev_get_name(ofport->netdev));
1228 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1229 sset_add(&devnames, ofproto_port.name);
1232 SSET_FOR_EACH (devname, &devnames) {
1233 update_port(p, devname);
1235 sset_destroy(&devnames);
1238 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
1239 * netdev cannot be opened. On success, also fills in 'opp'. */
1240 static struct netdev *
1241 ofport_open(const struct ofproto_port *ofproto_port, struct ofp_phy_port *opp)
1243 uint32_t curr, advertised, supported, peer;
1244 enum netdev_flags flags;
1245 struct netdev *netdev;
1248 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1250 VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1251 "cannot be opened (%s)",
1252 ofproto_port->name, ofproto_port->ofp_port,
1253 ofproto_port->name, strerror(error));
1257 netdev_get_flags(netdev, &flags);
1258 netdev_get_features(netdev, &curr, &advertised, &supported, &peer);
1260 opp->port_no = htons(ofproto_port->ofp_port);
1261 netdev_get_etheraddr(netdev, opp->hw_addr);
1262 ovs_strzcpy(opp->name, ofproto_port->name, sizeof opp->name);
1263 opp->config = flags & NETDEV_UP ? 0 : htonl(OFPPC_PORT_DOWN);
1264 opp->state = netdev_get_carrier(netdev) ? 0 : htonl(OFPPS_LINK_DOWN);
1265 opp->curr = htonl(curr);
1266 opp->advertised = htonl(advertised);
1267 opp->supported = htonl(supported);
1268 opp->peer = htonl(peer);
1273 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1274 * port number, and 'config' bits other than OFPPC_PORT_DOWN are
1277 ofport_equal(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
1279 BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1280 return (!memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1281 && a->state == b->state
1282 && !((a->config ^ b->config) & htonl(OFPPC_PORT_DOWN))
1283 && a->curr == b->curr
1284 && a->advertised == b->advertised
1285 && a->supported == b->supported
1286 && a->peer == b->peer);
1289 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1290 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1291 * one with the same name or port number). */
1293 ofport_install(struct ofproto *p,
1294 struct netdev *netdev, const struct ofp_phy_port *opp)
1296 const char *netdev_name = netdev_get_name(netdev);
1297 struct ofport *ofport;
1301 /* Create ofport. */
1302 ofport = p->ofproto_class->port_alloc();
1307 ofport->ofproto = p;
1308 ofport->netdev = netdev;
1309 ofport->change_seq = netdev_change_seq(netdev);
1311 ofport->ofp_port = ntohs(opp->port_no);
1313 /* Add port to 'p'. */
1314 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1315 shash_add(&p->port_by_name, netdev_name, ofport);
1317 if (!netdev_get_mtu(netdev, &dev_mtu)) {
1318 set_internal_devs_mtu(p);
1319 ofport->mtu = dev_mtu;
1324 /* Let the ofproto_class initialize its private data. */
1325 error = p->ofproto_class->port_construct(ofport);
1329 connmgr_send_port_status(p->connmgr, opp, OFPPR_ADD);
1333 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1334 p->name, netdev_name, strerror(error));
1336 ofport_destroy__(ofport);
1338 netdev_close(netdev);
1342 /* Removes 'ofport' from 'p' and destroys it. */
1344 ofport_remove(struct ofport *ofport)
1346 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->opp,
1348 ofport_destroy(ofport);
1351 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1354 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1356 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1358 ofport_remove(port);
1362 /* Updates 'port' with new 'opp' description.
1364 * Does not handle a name or port number change. The caller must implement
1365 * such a change as a delete followed by an add. */
1367 ofport_modified(struct ofport *port, struct ofp_phy_port *opp)
1369 memcpy(port->opp.hw_addr, opp->hw_addr, ETH_ADDR_LEN);
1370 port->opp.config = ((port->opp.config & ~htonl(OFPPC_PORT_DOWN))
1371 | (opp->config & htonl(OFPPC_PORT_DOWN)));
1372 port->opp.state = opp->state;
1373 port->opp.curr = opp->curr;
1374 port->opp.advertised = opp->advertised;
1375 port->opp.supported = opp->supported;
1376 port->opp.peer = opp->peer;
1378 connmgr_send_port_status(port->ofproto->connmgr, &port->opp, OFPPR_MODIFY);
1381 /* Update OpenFlow 'state' in 'port' and notify controller. */
1383 ofproto_port_set_state(struct ofport *port, ovs_be32 state)
1385 if (port->opp.state != state) {
1386 port->opp.state = state;
1387 connmgr_send_port_status(port->ofproto->connmgr, &port->opp,
1393 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1395 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1397 if (port->ofproto->ofproto_class->set_stp_port) {
1398 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1400 if (port->ofproto->ofproto_class->set_cfm) {
1401 port->ofproto->ofproto_class->set_cfm(port, NULL);
1403 if (port->ofproto->ofproto_class->bundle_remove) {
1404 port->ofproto->ofproto_class->bundle_remove(port);
1410 ofport_destroy__(struct ofport *port)
1412 struct ofproto *ofproto = port->ofproto;
1413 const char *name = netdev_get_name(port->netdev);
1415 hmap_remove(&ofproto->ports, &port->hmap_node);
1416 shash_delete(&ofproto->port_by_name,
1417 shash_find(&ofproto->port_by_name, name));
1419 netdev_close(port->netdev);
1420 ofproto->ofproto_class->port_dealloc(port);
1424 ofport_destroy(struct ofport *port)
1427 port->ofproto->ofproto_class->port_destruct(port);
1428 ofport_destroy__(port);
1433 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1435 struct ofport *port;
1437 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1438 hash_int(ofp_port, 0), &ofproto->ports) {
1439 if (port->ofp_port == ofp_port) {
1447 update_port(struct ofproto *ofproto, const char *name)
1449 struct ofproto_port ofproto_port;
1450 struct ofp_phy_port opp;
1451 struct netdev *netdev;
1452 struct ofport *port;
1454 COVERAGE_INC(ofproto_update_port);
1456 /* Fetch 'name''s location and properties from the datapath. */
1457 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1458 ? ofport_open(&ofproto_port, &opp)
1461 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1462 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1463 struct netdev *old_netdev = port->netdev;
1466 /* 'name' hasn't changed location. Any properties changed? */
1467 if (!ofport_equal(&port->opp, &opp)) {
1468 ofport_modified(port, &opp);
1471 /* If this is a non-internal port and the MTU changed, check
1472 * if the datapath's MTU needs to be updated. */
1473 if (strcmp(netdev_get_type(netdev), "internal")
1474 && !netdev_get_mtu(netdev, &dev_mtu)
1475 && port->mtu != dev_mtu) {
1476 set_internal_devs_mtu(ofproto);
1477 port->mtu = dev_mtu;
1480 /* Install the newly opened netdev in case it has changed.
1481 * Don't close the old netdev yet in case port_modified has to
1482 * remove a retained reference to it.*/
1483 port->netdev = netdev;
1484 port->change_seq = netdev_change_seq(netdev);
1486 if (port->ofproto->ofproto_class->port_modified) {
1487 port->ofproto->ofproto_class->port_modified(port);
1490 netdev_close(old_netdev);
1492 /* If 'port' is nonnull then its name differs from 'name' and thus
1493 * we should delete it. If we think there's a port named 'name'
1494 * then its port number must be wrong now so delete it too. */
1496 ofport_remove(port);
1498 ofport_remove_with_name(ofproto, name);
1499 ofport_install(ofproto, netdev, &opp);
1502 /* Any port named 'name' is gone now. */
1503 ofport_remove_with_name(ofproto, name);
1505 ofproto_port_destroy(&ofproto_port);
1509 init_ports(struct ofproto *p)
1511 struct ofproto_port_dump dump;
1512 struct ofproto_port ofproto_port;
1514 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1515 uint16_t ofp_port = ofproto_port.ofp_port;
1516 if (ofproto_get_port(p, ofp_port)) {
1517 VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1519 } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1520 VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1523 struct ofp_phy_port opp;
1524 struct netdev *netdev;
1526 netdev = ofport_open(&ofproto_port, &opp);
1528 ofport_install(p, netdev, &opp);
1536 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1537 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1539 find_min_mtu(struct ofproto *p)
1541 struct ofport *ofport;
1544 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1545 struct netdev *netdev = ofport->netdev;
1548 /* Skip any internal ports, since that's what we're trying to
1550 if (!strcmp(netdev_get_type(netdev), "internal")) {
1554 if (netdev_get_mtu(netdev, &dev_mtu)) {
1557 if (!mtu || dev_mtu < mtu) {
1562 return mtu ? mtu: ETH_PAYLOAD_MAX;
1565 /* Set the MTU of all datapath devices on 'p' to the minimum of the
1566 * non-datapath ports. */
1568 set_internal_devs_mtu(struct ofproto *p)
1570 struct ofport *ofport;
1571 int mtu = find_min_mtu(p);
1573 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1574 struct netdev *netdev = ofport->netdev;
1576 if (!strcmp(netdev_get_type(netdev), "internal")) {
1577 netdev_set_mtu(netdev, mtu);
1583 ofproto_rule_destroy__(struct rule *rule)
1585 free(rule->actions);
1586 rule->ofproto->ofproto_class->rule_dealloc(rule);
1589 /* This function allows an ofproto implementation to destroy any rules that
1590 * remain when its ->destruct() function is called. The caller must have
1591 * already uninitialized any derived members of 'rule' (step 5 described in the
1592 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1593 * This function implements steps 6 and 7.
1595 * This function should only be called from an ofproto implementation's
1596 * ->destruct() function. It is not suitable elsewhere. */
1598 ofproto_rule_destroy(struct rule *rule)
1600 assert(!rule->pending);
1601 classifier_remove(&rule->ofproto->tables[rule->table_id], &rule->cr);
1602 ofproto_rule_destroy__(rule);
1605 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1606 * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1609 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1611 const union ofp_action *oa;
1614 if (out_port == OFPP_NONE) {
1617 OFPUTIL_ACTION_FOR_EACH_UNSAFE (oa, left, rule->actions, rule->n_actions) {
1618 if (action_outputs_to_port(oa, htons(out_port))) {
1625 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1626 * statistics appropriately. 'packet' must have at least sizeof(struct
1627 * ofp_packet_in) bytes of headroom.
1629 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1630 * with statistics for 'packet' either way.
1632 * Takes ownership of 'packet'. */
1634 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1638 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1640 flow_extract(packet, 0, 0, in_port, &flow);
1641 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1644 /* Returns true if 'rule' should be hidden from the controller.
1646 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1647 * (e.g. by in-band control) and are intentionally hidden from the
1650 rule_is_hidden(const struct rule *rule)
1652 return rule->cr.priority > UINT16_MAX;
1656 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1658 ofconn_send_reply(ofconn, make_echo_reply(oh));
1663 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1665 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1666 struct ofp_switch_features *osf;
1668 struct ofport *port;
1672 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip, &actions);
1673 assert(actions & (1 << OFPAT_OUTPUT)); /* sanity check */
1675 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1676 osf->datapath_id = htonll(ofproto->datapath_id);
1677 osf->n_buffers = htonl(pktbuf_capacity());
1678 osf->n_tables = ofproto->n_tables;
1679 osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1680 OFPC_PORT_STATS | OFPC_QUEUE_STATS);
1682 osf->capabilities |= htonl(OFPC_ARP_MATCH_IP);
1684 osf->actions = htonl(actions);
1686 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1687 ofpbuf_put(buf, &port->opp, sizeof port->opp);
1690 ofconn_send_reply(ofconn, buf);
1695 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1697 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1698 struct ofp_switch_config *osc;
1702 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1703 osc->flags = htons(ofproto->frag_handling);
1704 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1705 ofconn_send_reply(ofconn, buf);
1711 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1713 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1714 uint16_t flags = ntohs(osc->flags);
1716 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
1717 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1718 enum ofp_config_flags cur = ofproto->frag_handling;
1719 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
1721 assert((cur & OFPC_FRAG_MASK) == cur);
1723 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
1724 ofproto->frag_handling = next;
1726 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
1728 ofputil_frag_handling_to_string(next));
1733 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1738 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1739 * error message code (composed with ofp_mkerr()) for the caller to propagate
1740 * upward. Otherwise, returns 0. */
1742 reject_slave_controller(const struct ofconn *ofconn)
1744 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1745 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1746 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
1753 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1755 struct ofproto *p = ofconn_get_ofproto(ofconn);
1756 struct ofp_packet_out *opo;
1757 struct ofpbuf payload, *buffer;
1758 union ofp_action *ofp_actions;
1759 struct ofpbuf request;
1761 size_t n_ofp_actions;
1765 COVERAGE_INC(ofproto_packet_out);
1767 error = reject_slave_controller(ofconn);
1772 /* Get ofp_packet_out. */
1773 ofpbuf_use_const(&request, oh, ntohs(oh->length));
1774 opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1777 error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1778 &ofp_actions, &n_ofp_actions);
1784 if (opo->buffer_id != htonl(UINT32_MAX)) {
1785 error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1787 if (error || !buffer) {
1796 /* Get in_port and partially validate it.
1798 * We don't know what range of ports the ofproto actually implements, but
1799 * we do know that only certain reserved ports (numbered OFPP_MAX and
1800 * above) are valid. */
1801 in_port = ntohs(opo->in_port);
1802 if (in_port >= OFPP_MAX && in_port != OFPP_LOCAL && in_port != OFPP_NONE) {
1803 return ofp_mkerr_nicira(OFPET_BAD_REQUEST, NXBRC_BAD_IN_PORT);
1806 /* Send out packet. */
1807 flow_extract(&payload, 0, 0, in_port, &flow);
1808 error = p->ofproto_class->packet_out(p, &payload, &flow,
1809 ofp_actions, n_ofp_actions);
1810 ofpbuf_delete(buffer);
1816 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1818 ovs_be32 old_config = port->opp.config;
1820 mask &= config ^ port->opp.config;
1821 if (mask & htonl(OFPPC_PORT_DOWN)) {
1822 if (config & htonl(OFPPC_PORT_DOWN)) {
1823 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1825 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1829 port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1830 OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1831 OFPPC_NO_PACKET_IN));
1832 if (port->opp.config != old_config) {
1833 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1838 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1840 struct ofproto *p = ofconn_get_ofproto(ofconn);
1841 const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1842 struct ofport *port;
1845 error = reject_slave_controller(ofconn);
1850 port = ofproto_get_port(p, ntohs(opm->port_no));
1852 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
1853 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1854 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
1856 update_port_config(port, opm->config, opm->mask);
1857 if (opm->advertise) {
1858 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1865 handle_desc_stats_request(struct ofconn *ofconn,
1866 const struct ofp_stats_msg *request)
1868 struct ofproto *p = ofconn_get_ofproto(ofconn);
1869 struct ofp_desc_stats *ods;
1872 ods = ofputil_make_stats_reply(sizeof *ods, request, &msg);
1873 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1874 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1875 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1876 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1877 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1878 ofconn_send_reply(ofconn, msg);
1884 handle_table_stats_request(struct ofconn *ofconn,
1885 const struct ofp_stats_msg *request)
1887 struct ofproto *p = ofconn_get_ofproto(ofconn);
1888 struct ofp_table_stats *ots;
1892 ofputil_make_stats_reply(sizeof(struct ofp_stats_msg), request, &msg);
1894 ots = ofpbuf_put_zeros(msg, sizeof *ots * p->n_tables);
1895 for (i = 0; i < p->n_tables; i++) {
1896 ots[i].table_id = i;
1897 sprintf(ots[i].name, "table%zu", i);
1898 ots[i].wildcards = htonl(OFPFW_ALL);
1899 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
1900 ots[i].active_count = htonl(classifier_count(&p->tables[i]));
1903 p->ofproto_class->get_tables(p, ots);
1905 ofconn_send_reply(ofconn, msg);
1910 append_port_stat(struct ofport *port, struct list *replies)
1912 struct netdev_stats stats;
1913 struct ofp_port_stats *ops;
1915 /* Intentionally ignore return value, since errors will set
1916 * 'stats' to all-1s, which is correct for OpenFlow, and
1917 * netdev_get_stats() will log errors. */
1918 netdev_get_stats(port->netdev, &stats);
1920 ops = ofputil_append_stats_reply(sizeof *ops, replies);
1921 ops->port_no = port->opp.port_no;
1922 memset(ops->pad, 0, sizeof ops->pad);
1923 put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
1924 put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
1925 put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
1926 put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
1927 put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
1928 put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
1929 put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
1930 put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
1931 put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
1932 put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
1933 put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
1934 put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
1938 handle_port_stats_request(struct ofconn *ofconn,
1939 const struct ofp_port_stats_request *psr)
1941 struct ofproto *p = ofconn_get_ofproto(ofconn);
1942 struct ofport *port;
1943 struct list replies;
1945 ofputil_start_stats_reply(&psr->osm, &replies);
1946 if (psr->port_no != htons(OFPP_NONE)) {
1947 port = ofproto_get_port(p, ntohs(psr->port_no));
1949 append_port_stat(port, &replies);
1952 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
1953 append_port_stat(port, &replies);
1957 ofconn_send_replies(ofconn, &replies);
1962 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
1964 long long int msecs = time_msec() - start;
1965 *sec = msecs / 1000;
1966 *nsec = (msecs % 1000) * (1000 * 1000);
1969 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
1970 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
1972 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
1974 return (table_id == 0xff || table_id < ofproto->n_tables
1976 : ofp_mkerr_nicira(OFPET_BAD_REQUEST, NXBRC_BAD_TABLE_ID));
1980 static struct classifier *
1981 first_matching_table(struct ofproto *ofproto, uint8_t table_id)
1983 if (table_id == 0xff) {
1984 return &ofproto->tables[0];
1985 } else if (table_id < ofproto->n_tables) {
1986 return &ofproto->tables[table_id];
1992 static struct classifier *
1993 next_matching_table(struct ofproto *ofproto,
1994 struct classifier *cls, uint8_t table_id)
1996 return (table_id == 0xff && cls != &ofproto->tables[ofproto->n_tables - 1]
2001 /* Assigns CLS to each classifier table, in turn, that matches TABLE_ID in
2004 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2007 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2008 * only once, for that table.
2010 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2011 * entered at all. (Perhaps you should have validated TABLE_ID with
2012 * check_table_id().)
2014 * All parameters are evaluated multiple times.
2016 #define FOR_EACH_MATCHING_TABLE(CLS, TABLE_ID, OFPROTO) \
2017 for ((CLS) = first_matching_table(OFPROTO, TABLE_ID); \
2019 (CLS) = next_matching_table(OFPROTO, CLS, TABLE_ID))
2021 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2022 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2023 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2026 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2027 * to 'out_port' are included.
2029 * Hidden rules are always omitted.
2031 * Returns 0 on success, otherwise an OpenFlow error code. */
2033 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2034 const struct cls_rule *match, uint16_t out_port,
2037 struct classifier *cls;
2040 error = check_table_id(ofproto, table_id);
2046 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
2047 struct cls_cursor cursor;
2050 cls_cursor_init(&cursor, cls, match);
2051 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2052 if (rule->pending) {
2053 return OFPROTO_POSTPONE;
2055 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
2056 list_push_back(rules, &rule->ofproto_node);
2063 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2064 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2065 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2068 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2069 * to 'out_port' are included.
2071 * Hidden rules are always omitted.
2073 * Returns 0 on success, otherwise an OpenFlow error code. */
2075 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2076 const struct cls_rule *match, uint16_t out_port,
2079 struct classifier *cls;
2082 error = check_table_id(ofproto, table_id);
2088 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
2091 rule = rule_from_cls_rule(classifier_find_rule_exactly(cls, match));
2093 if (rule->pending) {
2094 return OFPROTO_POSTPONE;
2096 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
2097 list_push_back(rules, &rule->ofproto_node);
2105 handle_flow_stats_request(struct ofconn *ofconn,
2106 const struct ofp_stats_msg *osm)
2108 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2109 struct ofputil_flow_stats_request fsr;
2110 struct list replies;
2115 error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
2120 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2121 fsr.out_port, &rules);
2126 ofputil_start_stats_reply(osm, &replies);
2127 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2128 struct ofputil_flow_stats fs;
2131 fs.cookie = rule->flow_cookie;
2132 fs.table_id = rule->table_id;
2133 calc_flow_duration__(rule->created, &fs.duration_sec,
2135 fs.idle_timeout = rule->idle_timeout;
2136 fs.hard_timeout = rule->hard_timeout;
2137 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2139 fs.actions = rule->actions;
2140 fs.n_actions = rule->n_actions;
2141 ofputil_append_flow_stats_reply(&fs, &replies);
2143 ofconn_send_replies(ofconn, &replies);
2149 flow_stats_ds(struct rule *rule, struct ds *results)
2151 uint64_t packet_count, byte_count;
2153 rule->ofproto->ofproto_class->rule_get_stats(rule,
2154 &packet_count, &byte_count);
2156 if (rule->table_id != 0) {
2157 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2159 ds_put_format(results, "duration=%llds, ",
2160 (time_msec() - rule->created) / 1000);
2161 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2162 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2163 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2164 cls_rule_format(&rule->cr, results);
2165 ds_put_char(results, ',');
2166 if (rule->n_actions > 0) {
2167 ofp_print_actions(results, rule->actions, rule->n_actions);
2169 ds_put_cstr(results, "drop");
2171 ds_put_cstr(results, "\n");
2174 /* Adds a pretty-printed description of all flows to 'results', including
2175 * hidden flows (e.g., set up by in-band control). */
2177 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2179 struct classifier *cls;
2181 OFPROTO_FOR_EACH_TABLE (cls, p) {
2182 struct cls_cursor cursor;
2185 cls_cursor_init(&cursor, cls, NULL);
2186 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2187 flow_stats_ds(rule, results);
2192 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2193 * '*engine_type' and '*engine_id', respectively. */
2195 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2196 uint8_t *engine_type, uint8_t *engine_id)
2198 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2201 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns 1
2202 * if CFM is faulted (generally indiciating a connectivity problem), 0 if CFM
2203 * is not faulted, and -1 if CFM is not enabled on 'ofp_port'. */
2205 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2207 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2208 return (ofport && ofproto->ofproto_class->get_cfm_fault
2209 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2213 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2214 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2215 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2216 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2218 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2219 uint16_t ofp_port, const uint64_t **rmps,
2222 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2226 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2227 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2233 handle_aggregate_stats_request(struct ofconn *ofconn,
2234 const struct ofp_stats_msg *osm)
2236 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2237 struct ofputil_flow_stats_request request;
2238 struct ofputil_aggregate_stats stats;
2239 bool unknown_packets, unknown_bytes;
2240 struct ofpbuf *reply;
2245 error = ofputil_decode_flow_stats_request(&request, &osm->header);
2250 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2251 request.out_port, &rules);
2256 memset(&stats, 0, sizeof stats);
2257 unknown_packets = unknown_bytes = false;
2258 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2259 uint64_t packet_count;
2260 uint64_t byte_count;
2262 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2265 if (packet_count == UINT64_MAX) {
2266 unknown_packets = true;
2268 stats.packet_count += packet_count;
2271 if (byte_count == UINT64_MAX) {
2272 unknown_bytes = true;
2274 stats.byte_count += byte_count;
2279 if (unknown_packets) {
2280 stats.packet_count = UINT64_MAX;
2282 if (unknown_bytes) {
2283 stats.byte_count = UINT64_MAX;
2286 reply = ofputil_encode_aggregate_stats_reply(&stats, osm);
2287 ofconn_send_reply(ofconn, reply);
2292 struct queue_stats_cbdata {
2293 struct ofport *ofport;
2294 struct list replies;
2298 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2299 const struct netdev_queue_stats *stats)
2301 struct ofp_queue_stats *reply;
2303 reply = ofputil_append_stats_reply(sizeof *reply, &cbdata->replies);
2304 reply->port_no = cbdata->ofport->opp.port_no;
2305 memset(reply->pad, 0, sizeof reply->pad);
2306 reply->queue_id = htonl(queue_id);
2307 put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2308 put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2309 put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2313 handle_queue_stats_dump_cb(uint32_t queue_id,
2314 struct netdev_queue_stats *stats,
2317 struct queue_stats_cbdata *cbdata = cbdata_;
2319 put_queue_stats(cbdata, queue_id, stats);
2323 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2324 struct queue_stats_cbdata *cbdata)
2326 cbdata->ofport = port;
2327 if (queue_id == OFPQ_ALL) {
2328 netdev_dump_queue_stats(port->netdev,
2329 handle_queue_stats_dump_cb, cbdata);
2331 struct netdev_queue_stats stats;
2333 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2334 put_queue_stats(cbdata, queue_id, &stats);
2340 handle_queue_stats_request(struct ofconn *ofconn,
2341 const struct ofp_queue_stats_request *qsr)
2343 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2344 struct queue_stats_cbdata cbdata;
2345 struct ofport *port;
2346 unsigned int port_no;
2349 COVERAGE_INC(ofproto_queue_req);
2351 ofputil_start_stats_reply(&qsr->osm, &cbdata.replies);
2353 port_no = ntohs(qsr->port_no);
2354 queue_id = ntohl(qsr->queue_id);
2355 if (port_no == OFPP_ALL) {
2356 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2357 handle_queue_stats_for_port(port, queue_id, &cbdata);
2359 } else if (port_no < OFPP_MAX) {
2360 port = ofproto_get_port(ofproto, port_no);
2362 handle_queue_stats_for_port(port, queue_id, &cbdata);
2365 ofpbuf_list_delete(&cbdata.replies);
2366 return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
2368 ofconn_send_replies(ofconn, &cbdata.replies);
2374 is_flow_deletion_pending(const struct ofproto *ofproto,
2375 const struct cls_rule *cls_rule,
2378 if (!hmap_is_empty(&ofproto->deletions)) {
2379 struct ofoperation *op;
2381 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2382 cls_rule_hash(cls_rule, table_id),
2383 &ofproto->deletions) {
2384 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2393 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2394 * in which no matching flow already exists in the flow table.
2396 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2397 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
2398 * error code as encoded by ofp_mkerr() on failure, or OFPROTO_POSTPONE if the
2399 * operation cannot be initiated now but may be retried later.
2401 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2404 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
2405 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
2407 struct classifier *table;
2408 struct ofopgroup *group;
2409 struct rule *victim;
2413 error = check_table_id(ofproto, fm->table_id);
2419 if (fm->table_id == 0xff) {
2421 if (ofproto->ofproto_class->rule_choose_table) {
2422 error = ofproto->ofproto_class->rule_choose_table(ofproto, &fm->cr,
2427 assert(table_id < ofproto->n_tables);
2428 table = &ofproto->tables[table_id];
2430 table = &ofproto->tables[0];
2432 } else if (fm->table_id < ofproto->n_tables) {
2433 table = &ofproto->tables[fm->table_id];
2435 return ofp_mkerr_nicira(OFPET_FLOW_MOD_FAILED, NXFMFC_BAD_TABLE_ID);
2438 /* Check for overlap, if requested. */
2439 if (fm->flags & OFPFF_CHECK_OVERLAP
2440 && classifier_rule_overlaps(table, &fm->cr)) {
2441 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
2444 /* Serialize against pending deletion. */
2445 if (is_flow_deletion_pending(ofproto, &fm->cr, table - ofproto->tables)) {
2446 return OFPROTO_POSTPONE;
2449 /* Allocate new rule. */
2450 rule = ofproto->ofproto_class->rule_alloc();
2452 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2453 ofproto->name, strerror(error));
2456 rule->ofproto = ofproto;
2458 rule->pending = NULL;
2459 rule->flow_cookie = fm->cookie;
2460 rule->created = rule->modified = time_msec();
2461 rule->idle_timeout = fm->idle_timeout;
2462 rule->hard_timeout = fm->hard_timeout;
2463 rule->table_id = table - ofproto->tables;
2464 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2465 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2466 rule->n_actions = fm->n_actions;
2468 /* Insert new rule. */
2469 victim = rule_from_cls_rule(classifier_replace(table, &rule->cr));
2470 if (victim && victim->pending) {
2471 error = OFPROTO_POSTPONE;
2473 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2474 ofoperation_create(group, rule, OFOPERATION_ADD);
2475 rule->pending->victim = victim;
2477 error = ofproto->ofproto_class->rule_construct(rule);
2479 ofoperation_destroy(rule->pending);
2481 ofopgroup_submit(group);
2484 /* Back out if an error occurred. */
2487 classifier_replace(table, &victim->cr);
2489 classifier_remove(table, &rule->cr);
2491 ofproto_rule_destroy__(rule);
2496 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2498 /* Modifies the rules listed in 'rules', changing their actions to match those
2501 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2504 * Returns 0 on success, otherwise an OpenFlow error code. */
2506 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2507 const struct ofputil_flow_mod *fm,
2508 const struct ofp_header *request, struct list *rules)
2510 struct ofopgroup *group;
2513 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2514 LIST_FOR_EACH (rule, ofproto_node, rules) {
2515 if (!ofputil_actions_equal(fm->actions, fm->n_actions,
2516 rule->actions, rule->n_actions)) {
2517 ofoperation_create(group, rule, OFOPERATION_MODIFY);
2518 rule->pending->actions = rule->actions;
2519 rule->pending->n_actions = rule->n_actions;
2520 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2521 rule->n_actions = fm->n_actions;
2522 rule->ofproto->ofproto_class->rule_modify_actions(rule);
2524 rule->modified = time_msec();
2526 rule->flow_cookie = fm->cookie;
2528 ofopgroup_submit(group);
2533 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code as
2534 * encoded by ofp_mkerr() on failure.
2536 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2539 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2540 const struct ofputil_flow_mod *fm,
2541 const struct ofp_header *request)
2546 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr, OFPP_NONE,
2548 return (error ? error
2549 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2550 : modify_flows__(ofproto, ofconn, fm, request, &rules));
2553 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2554 * code as encoded by ofp_mkerr() on failure.
2556 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2559 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2560 const struct ofputil_flow_mod *fm,
2561 const struct ofp_header *request)
2566 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr, OFPP_NONE,
2568 return (error ? error
2569 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2570 : list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
2571 fm, request, &rules)
2575 /* OFPFC_DELETE implementation. */
2577 /* Deletes the rules listed in 'rules'.
2579 * Returns 0 on success, otherwise an OpenFlow error code. */
2581 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2582 const struct ofp_header *request, struct list *rules)
2584 struct rule *rule, *next;
2585 struct ofopgroup *group;
2587 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
2588 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
2589 ofproto_rule_send_removed(rule, OFPRR_DELETE);
2591 ofoperation_create(group, rule, OFOPERATION_DELETE);
2592 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2593 rule->ofproto->ofproto_class->rule_destruct(rule);
2595 ofopgroup_submit(group);
2600 /* Implements OFPFC_DELETE. */
2602 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2603 const struct ofputil_flow_mod *fm,
2604 const struct ofp_header *request)
2609 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr, fm->out_port,
2611 return (error ? error
2612 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
2617 /* Implements OFPFC_DELETE_STRICT. */
2619 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2620 const struct ofputil_flow_mod *fm,
2621 const struct ofp_header *request)
2626 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr, fm->out_port,
2628 return (error ? error
2629 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
2635 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2637 struct ofputil_flow_removed fr;
2639 if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2644 fr.cookie = rule->flow_cookie;
2646 calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2647 fr.idle_timeout = rule->idle_timeout;
2648 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2651 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2654 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2655 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2658 * ofproto implementation ->run() functions should use this function to expire
2659 * OpenFlow flows. */
2661 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2663 struct ofproto *ofproto = rule->ofproto;
2664 struct ofopgroup *group;
2666 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2668 ofproto_rule_send_removed(rule, reason);
2670 group = ofopgroup_create_unattached(ofproto);
2671 ofoperation_create(group, rule, OFOPERATION_DELETE);
2672 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2673 rule->ofproto->ofproto_class->rule_destruct(rule);
2674 ofopgroup_submit(group);
2678 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2680 struct ofputil_flow_mod fm;
2683 error = reject_slave_controller(ofconn);
2688 error = ofputil_decode_flow_mod(&fm, oh,
2689 ofconn_get_flow_mod_table_id(ofconn));
2694 /* We do not support the emergency flow cache. It will hopefully get
2695 * dropped from OpenFlow in the near future. */
2696 if (fm.flags & OFPFF_EMERG) {
2697 /* There isn't a good fit for an error code, so just state that the
2698 * flow table is full. */
2699 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
2702 return handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
2706 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
2707 const struct ofputil_flow_mod *fm,
2708 const struct ofp_header *oh)
2710 if (ofproto->n_pending >= 50) {
2711 assert(!list_is_empty(&ofproto->pending));
2712 return OFPROTO_POSTPONE;
2715 switch (fm->command) {
2717 return add_flow(ofproto, ofconn, fm, oh);
2720 return modify_flows_loose(ofproto, ofconn, fm, oh);
2722 case OFPFC_MODIFY_STRICT:
2723 return modify_flow_strict(ofproto, ofconn, fm, oh);
2726 return delete_flows_loose(ofproto, ofconn, fm, oh);
2728 case OFPFC_DELETE_STRICT:
2729 return delete_flow_strict(ofproto, ofconn, fm, oh);
2732 if (fm->command > 0xff) {
2733 VLOG_WARN_RL(&rl, "flow_mod has explicit table_id but "
2734 "flow_mod_table_id extension is not enabled");
2736 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2741 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2743 struct nx_role_request *nrr = (struct nx_role_request *) oh;
2744 struct nx_role_request *reply;
2748 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2749 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2752 role = ntohl(nrr->role);
2753 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2754 && role != NX_ROLE_SLAVE) {
2755 return ofp_mkerr_nicira(OFPET_BAD_REQUEST, NXBRC_BAD_ROLE);
2758 if (ofconn_get_role(ofconn) != role
2759 && ofconn_has_pending_opgroups(ofconn)) {
2760 return OFPROTO_POSTPONE;
2763 ofconn_set_role(ofconn, role);
2765 reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2766 reply->role = htonl(role);
2767 ofconn_send_reply(ofconn, buf);
2773 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
2774 const struct ofp_header *oh)
2776 const struct nxt_flow_mod_table_id *msg
2777 = (const struct nxt_flow_mod_table_id *) oh;
2779 ofconn_set_flow_mod_table_id(ofconn, msg->set != 0);
2784 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2786 const struct nxt_set_flow_format *msg
2787 = (const struct nxt_set_flow_format *) oh;
2790 format = ntohl(msg->format);
2791 if (format != NXFF_OPENFLOW10 && format != NXFF_NXM) {
2792 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2795 if (format != ofconn_get_flow_format(ofconn)
2796 && ofconn_has_pending_opgroups(ofconn)) {
2797 /* Avoid sending async messages in surprising flow format. */
2798 return OFPROTO_POSTPONE;
2801 ofconn_set_flow_format(ofconn, format);
2806 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2808 struct ofp_header *ob;
2811 if (ofconn_has_pending_opgroups(ofconn)) {
2812 return OFPROTO_POSTPONE;
2815 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2816 ofconn_send_reply(ofconn, buf);
2821 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2823 const struct ofp_header *oh = msg->data;
2824 const struct ofputil_msg_type *type;
2827 error = ofputil_decode_msg_type(oh, &type);
2832 switch (ofputil_msg_type_code(type)) {
2833 /* OpenFlow requests. */
2834 case OFPUTIL_OFPT_ECHO_REQUEST:
2835 return handle_echo_request(ofconn, oh);
2837 case OFPUTIL_OFPT_FEATURES_REQUEST:
2838 return handle_features_request(ofconn, oh);
2840 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2841 return handle_get_config_request(ofconn, oh);
2843 case OFPUTIL_OFPT_SET_CONFIG:
2844 return handle_set_config(ofconn, msg->data);
2846 case OFPUTIL_OFPT_PACKET_OUT:
2847 return handle_packet_out(ofconn, oh);
2849 case OFPUTIL_OFPT_PORT_MOD:
2850 return handle_port_mod(ofconn, oh);
2852 case OFPUTIL_OFPT_FLOW_MOD:
2853 return handle_flow_mod(ofconn, oh);
2855 case OFPUTIL_OFPT_BARRIER_REQUEST:
2856 return handle_barrier_request(ofconn, oh);
2858 /* OpenFlow replies. */
2859 case OFPUTIL_OFPT_ECHO_REPLY:
2862 /* Nicira extension requests. */
2863 case OFPUTIL_NXT_ROLE_REQUEST:
2864 return handle_role_request(ofconn, oh);
2866 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
2867 return handle_nxt_flow_mod_table_id(ofconn, oh);
2869 case OFPUTIL_NXT_SET_FLOW_FORMAT:
2870 return handle_nxt_set_flow_format(ofconn, oh);
2872 case OFPUTIL_NXT_FLOW_MOD:
2873 return handle_flow_mod(ofconn, oh);
2875 /* Statistics requests. */
2876 case OFPUTIL_OFPST_DESC_REQUEST:
2877 return handle_desc_stats_request(ofconn, msg->data);
2879 case OFPUTIL_OFPST_FLOW_REQUEST:
2880 case OFPUTIL_NXST_FLOW_REQUEST:
2881 return handle_flow_stats_request(ofconn, msg->data);
2883 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
2884 case OFPUTIL_NXST_AGGREGATE_REQUEST:
2885 return handle_aggregate_stats_request(ofconn, msg->data);
2887 case OFPUTIL_OFPST_TABLE_REQUEST:
2888 return handle_table_stats_request(ofconn, msg->data);
2890 case OFPUTIL_OFPST_PORT_REQUEST:
2891 return handle_port_stats_request(ofconn, msg->data);
2893 case OFPUTIL_OFPST_QUEUE_REQUEST:
2894 return handle_queue_stats_request(ofconn, msg->data);
2896 case OFPUTIL_MSG_INVALID:
2897 case OFPUTIL_OFPT_HELLO:
2898 case OFPUTIL_OFPT_ERROR:
2899 case OFPUTIL_OFPT_FEATURES_REPLY:
2900 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
2901 case OFPUTIL_OFPT_PACKET_IN:
2902 case OFPUTIL_OFPT_FLOW_REMOVED:
2903 case OFPUTIL_OFPT_PORT_STATUS:
2904 case OFPUTIL_OFPT_BARRIER_REPLY:
2905 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
2906 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
2907 case OFPUTIL_OFPST_DESC_REPLY:
2908 case OFPUTIL_OFPST_FLOW_REPLY:
2909 case OFPUTIL_OFPST_QUEUE_REPLY:
2910 case OFPUTIL_OFPST_PORT_REPLY:
2911 case OFPUTIL_OFPST_TABLE_REPLY:
2912 case OFPUTIL_OFPST_AGGREGATE_REPLY:
2913 case OFPUTIL_NXT_ROLE_REPLY:
2914 case OFPUTIL_NXT_FLOW_REMOVED:
2915 case OFPUTIL_NXST_FLOW_REPLY:
2916 case OFPUTIL_NXST_AGGREGATE_REPLY:
2918 if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
2919 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2921 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
2927 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
2929 int error = handle_openflow__(ofconn, ofp_msg);
2930 if (error && error != OFPROTO_POSTPONE) {
2931 ofconn_send_error(ofconn, ofp_msg->data, error);
2933 COVERAGE_INC(ofproto_recv_openflow);
2934 return error != OFPROTO_POSTPONE;
2937 /* Asynchronous operations. */
2939 /* Creates and returns a new ofopgroup that is not associated with any
2940 * OpenFlow connection.
2942 * The caller should add operations to the returned group with
2943 * ofoperation_create() and then submit it with ofopgroup_submit(). */
2944 static struct ofopgroup *
2945 ofopgroup_create_unattached(struct ofproto *ofproto)
2947 struct ofopgroup *group = xzalloc(sizeof *group);
2948 group->ofproto = ofproto;
2949 list_init(&group->ofproto_node);
2950 list_init(&group->ops);
2951 list_init(&group->ofconn_node);
2955 /* Creates and returns a new ofopgroup for 'ofproto'.
2957 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
2958 * connection. The 'request' and 'buffer_id' arguments are ignored.
2960 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
2961 * If the ofopgroup eventually fails, then the error reply will include
2962 * 'request'. If the ofopgroup eventually succeeds, then the packet with
2963 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
2965 * The caller should add operations to the returned group with
2966 * ofoperation_create() and then submit it with ofopgroup_submit(). */
2967 static struct ofopgroup *
2968 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
2969 const struct ofp_header *request, uint32_t buffer_id)
2971 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
2973 size_t request_len = ntohs(request->length);
2975 assert(ofconn_get_ofproto(ofconn) == ofproto);
2977 ofconn_add_opgroup(ofconn, &group->ofconn_node);
2978 group->ofconn = ofconn;
2979 group->request = xmemdup(request, MIN(request_len, 64));
2980 group->buffer_id = buffer_id;
2985 /* Submits 'group' for processing.
2987 * If 'group' contains no operations (e.g. none were ever added, or all of the
2988 * ones that were added completed synchronously), then it is destroyed
2989 * immediately. Otherwise it is added to the ofproto's list of pending
2992 ofopgroup_submit(struct ofopgroup *group)
2994 if (list_is_empty(&group->ops)) {
2995 ofopgroup_destroy(group);
2997 list_push_back(&group->ofproto->pending, &group->ofproto_node);
2998 group->ofproto->n_pending++;
3003 ofopgroup_destroy(struct ofopgroup *group)
3005 assert(list_is_empty(&group->ops));
3006 if (!list_is_empty(&group->ofproto_node)) {
3007 assert(group->ofproto->n_pending > 0);
3008 group->ofproto->n_pending--;
3009 list_remove(&group->ofproto_node);
3011 if (!list_is_empty(&group->ofconn_node)) {
3012 list_remove(&group->ofconn_node);
3014 ofconn_send_error(group->ofconn, group->request, group->error);
3016 connmgr_retry(group->ofproto->connmgr);
3018 free(group->request);
3022 /* Initiates a new operation on 'rule', of the specified 'type', within
3023 * 'group'. Prior to calling, 'rule' must not have any pending operation. */
3025 ofoperation_create(struct ofopgroup *group, struct rule *rule,
3026 enum ofoperation_type type)
3028 struct ofoperation *op;
3030 assert(!rule->pending);
3032 op = rule->pending = xzalloc(sizeof *op);
3034 list_push_back(&group->ops, &op->group_node);
3038 op->flow_cookie = rule->flow_cookie;
3040 if (type == OFOPERATION_DELETE) {
3041 hmap_insert(&op->group->ofproto->deletions, &op->hmap_node,
3042 cls_rule_hash(&rule->cr, rule->table_id));
3047 ofoperation_destroy(struct ofoperation *op)
3049 struct ofopgroup *group = op->group;
3052 op->rule->pending = NULL;
3054 if (op->type == OFOPERATION_DELETE) {
3055 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
3057 list_remove(&op->group_node);
3061 if (list_is_empty(&group->ops) && !list_is_empty(&group->ofproto_node)) {
3062 ofopgroup_destroy(group);
3066 /* Indicates that 'op' completed with status 'error', which is either 0 to
3067 * indicate success or an OpenFlow error code (constructed with
3068 * e.g. ofp_mkerr()).
3070 * If 'error' is 0, indicating success, the operation will be committed
3071 * permanently to the flow table. There is one interesting subcase:
3073 * - If 'op' is an "add flow" operation that is replacing an existing rule in
3074 * the flow table (the "victim" rule) by a new one, then the caller must
3075 * have uninitialized any derived state in the victim rule, as in step 5 in
3076 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
3077 * performs steps 6 and 7 for the victim rule, most notably by calling its
3078 * ->rule_dealloc() function.
3080 * If 'error' is nonzero, then generally the operation will be rolled back:
3082 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
3083 * restores the original rule. The caller must have uninitialized any
3084 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
3085 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
3086 * and 7 for the new rule, calling its ->rule_dealloc() function.
3088 * - If 'op' is a "modify flow" operation, ofproto restores the original
3091 * - 'op' must not be a "delete flow" operation. Removing a rule is not
3092 * allowed to fail. It must always succeed.
3094 * Please see the large comment in ofproto/ofproto-provider.h titled
3095 * "Asynchronous Operation Support" for more information. */
3097 ofoperation_complete(struct ofoperation *op, int error)
3099 struct ofopgroup *group = op->group;
3100 struct rule *rule = op->rule;
3101 struct classifier *table = &rule->ofproto->tables[rule->table_id];
3103 assert(rule->pending == op);
3104 assert(op->status < 0);
3109 && op->type != OFOPERATION_DELETE
3111 && group->buffer_id != UINT32_MAX
3112 && list_is_singleton(&op->group_node)) {
3113 struct ofpbuf *packet;
3116 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
3120 error = rule_execute(rule, in_port, packet);
3123 if (!group->error) {
3124 group->error = error;
3128 case OFOPERATION_ADD:
3131 ofproto_rule_destroy__(op->victim);
3135 classifier_replace(table, &op->victim->cr);
3138 classifier_remove(table, &rule->cr);
3140 ofproto_rule_destroy__(rule);
3145 case OFOPERATION_DELETE:
3147 ofproto_rule_destroy__(rule);
3151 case OFOPERATION_MODIFY:
3153 rule->modified = time_msec();
3155 free(rule->actions);
3156 rule->actions = op->actions;
3157 rule->n_actions = op->n_actions;
3165 ofoperation_destroy(op);
3169 ofoperation_get_victim(struct ofoperation *op)
3171 assert(op->type == OFOPERATION_ADD);
3176 pick_datapath_id(const struct ofproto *ofproto)
3178 const struct ofport *port;
3180 port = ofproto_get_port(ofproto, OFPP_LOCAL);
3182 uint8_t ea[ETH_ADDR_LEN];
3185 error = netdev_get_etheraddr(port->netdev, ea);
3187 return eth_addr_to_uint64(ea);
3189 VLOG_WARN("could not get MAC address for %s (%s)",
3190 netdev_get_name(port->netdev), strerror(error));
3192 return ofproto->fallback_dpid;
3196 pick_fallback_dpid(void)
3198 uint8_t ea[ETH_ADDR_LEN];
3199 eth_addr_nicira_random(ea);
3200 return eth_addr_to_uint64(ea);
3203 /* unixctl commands. */
3206 ofproto_lookup(const char *name)
3208 struct ofproto *ofproto;
3210 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
3212 if (!strcmp(ofproto->name, name)) {
3220 ofproto_unixctl_list(struct unixctl_conn *conn, const char *arg OVS_UNUSED,
3221 void *aux OVS_UNUSED)
3223 struct ofproto *ofproto;
3227 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
3228 ds_put_format(&results, "%s\n", ofproto->name);
3230 unixctl_command_reply(conn, 200, ds_cstr(&results));
3231 ds_destroy(&results);
3235 ofproto_unixctl_init(void)
3237 static bool registered;
3243 unixctl_command_register("ofproto/list", "", ofproto_unixctl_list, NULL);