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 /* Connectivity Fault Management configuration. */
608 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
610 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
612 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
613 if (ofport && ofproto->ofproto_class->set_cfm) {
614 ofproto->ofproto_class->set_cfm(ofport, NULL);
618 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
619 * basic configuration from the configuration members in 'cfm', and the remote
620 * maintenance point ID from remote_mpid. Ignores the statistics members of
623 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
625 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
626 const struct cfm_settings *s)
628 struct ofport *ofport;
631 ofport = ofproto_get_port(ofproto, ofp_port);
633 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
634 ofproto->name, ofp_port);
638 /* XXX: For configuration simplicity, we only support one remote_mpid
639 * outside of the CFM module. It's not clear if this is the correct long
640 * term solution or not. */
641 error = (ofproto->ofproto_class->set_cfm
642 ? ofproto->ofproto_class->set_cfm(ofport, s)
645 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
646 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
651 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
652 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
653 * 0 if LACP partner information is not current (generally indicating a
654 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
656 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
658 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
659 return (ofport && ofproto->ofproto_class->port_is_lacp_current
660 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
666 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
667 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
668 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
669 * configuration plus, if there is more than one slave, a bonding
672 * If 'aux' is already registered then this function updates its configuration
673 * to 's'. Otherwise, this function registers a new bundle.
675 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
678 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
679 const struct ofproto_bundle_settings *s)
681 return (ofproto->ofproto_class->bundle_set
682 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
686 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
687 * If no such bundle has been registered, this has no effect. */
689 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
691 return ofproto_bundle_register(ofproto, aux, NULL);
695 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
696 * If 'aux' is already registered then this function updates its configuration
697 * to 's'. Otherwise, this function registers a new mirror.
699 * Mirrors affect only the treatment of packets output to the OFPP_NORMAL
702 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
703 const struct ofproto_mirror_settings *s)
705 return (ofproto->ofproto_class->mirror_set
706 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
710 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
711 * If no mirror has been registered, this has no effect. */
713 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
715 return ofproto_mirror_register(ofproto, aux, NULL);
718 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
719 * which all packets are flooded, instead of using MAC learning. If
720 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
722 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
725 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
727 return (ofproto->ofproto_class->set_flood_vlans
728 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
732 /* Returns true if 'aux' is a registered bundle that is currently in use as the
733 * output for a mirror. */
735 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
737 return (ofproto->ofproto_class->is_mirror_output_bundle
738 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
743 ofproto_has_snoops(const struct ofproto *ofproto)
745 return connmgr_has_snoops(ofproto->connmgr);
749 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
751 connmgr_get_snoops(ofproto->connmgr, snoops);
755 ofproto_flush__(struct ofproto *ofproto)
757 struct classifier *table;
758 struct ofopgroup *group;
760 if (ofproto->ofproto_class->flush) {
761 ofproto->ofproto_class->flush(ofproto);
764 group = ofopgroup_create_unattached(ofproto);
765 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
766 struct rule *rule, *next_rule;
767 struct cls_cursor cursor;
769 cls_cursor_init(&cursor, table, NULL);
770 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
771 if (!rule->pending) {
772 ofoperation_create(group, rule, OFOPERATION_DELETE);
773 classifier_remove(table, &rule->cr);
774 ofproto->ofproto_class->rule_destruct(rule);
778 ofopgroup_submit(group);
782 ofproto_destroy__(struct ofproto *ofproto)
784 struct classifier *table;
786 assert(list_is_empty(&ofproto->pending));
787 assert(!ofproto->n_pending);
789 connmgr_destroy(ofproto->connmgr);
791 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
794 free(ofproto->mfr_desc);
795 free(ofproto->hw_desc);
796 free(ofproto->sw_desc);
797 free(ofproto->serial_desc);
798 free(ofproto->dp_desc);
799 hmap_destroy(&ofproto->ports);
800 shash_destroy(&ofproto->port_by_name);
802 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
803 assert(classifier_is_empty(table));
804 classifier_destroy(table);
806 free(ofproto->tables);
808 hmap_destroy(&ofproto->deletions);
810 ofproto->ofproto_class->dealloc(ofproto);
814 ofproto_destroy(struct ofproto *p)
816 struct ofport *ofport, *next_ofport;
823 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
824 ofport_destroy(ofport);
827 p->ofproto_class->destruct(p);
828 ofproto_destroy__(p);
831 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
832 * kernel datapath, for example, this destroys the datapath in the kernel, and
833 * with the netdev-based datapath, it tears down the data structures that
834 * represent the datapath.
836 * The datapath should not be currently open as an ofproto. */
838 ofproto_delete(const char *name, const char *type)
840 const struct ofproto_class *class = ofproto_class_find__(type);
841 return (!class ? EAFNOSUPPORT
842 : !class->del ? EACCES
843 : class->del(type, name));
847 process_port_change(struct ofproto *ofproto, int error, char *devname)
849 if (error == ENOBUFS) {
850 reinit_ports(ofproto);
852 update_port(ofproto, devname);
858 ofproto_run(struct ofproto *p)
860 struct ofport *ofport;
864 error = p->ofproto_class->run(p);
865 if (error == ENODEV) {
866 /* Someone destroyed the datapath behind our back. The caller
867 * better destroy us and give up, because we're just going to
868 * spin from here on out. */
869 static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
870 VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
875 if (p->ofproto_class->port_poll) {
876 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
877 process_port_change(p, error, devname);
881 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
882 unsigned int change_seq = netdev_change_seq(ofport->netdev);
883 if (ofport->change_seq != change_seq) {
884 ofport->change_seq = change_seq;
885 update_port(p, netdev_get_name(ofport->netdev));
892 connmgr_run(p->connmgr, handle_openflow);
896 connmgr_run(p->connmgr, NULL);
898 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
899 connmgr_flushed(p->connmgr);
900 p->state = S_OPENFLOW;
912 ofproto_wait(struct ofproto *p)
914 struct ofport *ofport;
916 p->ofproto_class->wait(p);
917 if (p->ofproto_class->port_poll_wait) {
918 p->ofproto_class->port_poll_wait(p);
921 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
922 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
923 poll_immediate_wake();
929 connmgr_wait(p->connmgr, true);
933 connmgr_wait(p->connmgr, false);
934 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
935 poll_immediate_wake();
942 ofproto_is_alive(const struct ofproto *p)
944 return connmgr_has_controllers(p->connmgr);
948 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
951 connmgr_get_controller_info(ofproto->connmgr, info);
955 ofproto_free_ofproto_controller_info(struct shash *info)
957 connmgr_free_controller_info(info);
960 /* Makes a deep copy of 'old' into 'port'. */
962 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
964 port->name = xstrdup(old->name);
965 port->type = xstrdup(old->type);
966 port->ofp_port = old->ofp_port;
969 /* Frees memory allocated to members of 'ofproto_port'.
971 * Do not call this function on an ofproto_port obtained from
972 * ofproto_port_dump_next(): that function retains ownership of the data in the
975 ofproto_port_destroy(struct ofproto_port *ofproto_port)
977 free(ofproto_port->name);
978 free(ofproto_port->type);
981 /* Initializes 'dump' to begin dumping the ports in an ofproto.
983 * This function provides no status indication. An error status for the entire
984 * dump operation is provided when it is completed by calling
985 * ofproto_port_dump_done().
988 ofproto_port_dump_start(struct ofproto_port_dump *dump,
989 const struct ofproto *ofproto)
991 dump->ofproto = ofproto;
992 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
996 /* Attempts to retrieve another port from 'dump', which must have been created
997 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
998 * 'port' and returns true. On failure, returns false.
1000 * Failure might indicate an actual error or merely that the last port has been
1001 * dumped. An error status for the entire dump operation is provided when it
1002 * is completed by calling ofproto_port_dump_done().
1004 * The ofproto owns the data stored in 'port'. It will remain valid until at
1005 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1006 * ofproto_port_dump_done(). */
1008 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1009 struct ofproto_port *port)
1011 const struct ofproto *ofproto = dump->ofproto;
1017 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1020 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1026 /* Completes port table dump operation 'dump', which must have been created
1027 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1028 * error-free, otherwise a positive errno value describing the problem. */
1030 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1032 const struct ofproto *ofproto = dump->ofproto;
1034 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1037 return dump->error == EOF ? 0 : dump->error;
1040 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
1041 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
1042 * is non-null). On failure, returns a positive errno value and sets
1043 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
1045 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1046 uint16_t *ofp_portp)
1051 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
1053 update_port(ofproto, netdev_get_name(netdev));
1056 *ofp_portp = error ? OFPP_NONE : ofp_port;
1061 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1062 * initializes '*port' appropriately; on failure, returns a positive errno
1065 * The caller owns the data in 'ofproto_port' and must free it with
1066 * ofproto_port_destroy() when it is no longer needed. */
1068 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1069 struct ofproto_port *port)
1073 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1075 memset(port, 0, sizeof *port);
1080 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1081 * Returns 0 if successful, otherwise a positive errno. */
1083 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1085 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1086 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1089 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1090 if (!error && ofport) {
1091 /* 'name' is the netdev's name and update_port() is going to close the
1092 * netdev. Just in case update_port() refers to 'name' after it
1093 * destroys 'ofport', make a copy of it around the update_port()
1095 char *devname = xstrdup(name);
1096 update_port(ofproto, devname);
1102 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1103 * performs the 'n_actions' actions in 'actions'. The new flow will not
1106 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1107 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1108 * controllers; otherwise, it will be hidden.
1110 * The caller retains ownership of 'cls_rule' and 'actions'.
1112 * This is a helper function for in-band control and fail-open. */
1114 ofproto_add_flow(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1115 const union ofp_action *actions, size_t n_actions)
1117 const struct rule *rule;
1119 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1120 &ofproto->tables[0], cls_rule));
1121 if (!rule || !ofputil_actions_equal(rule->actions, rule->n_actions,
1122 actions, n_actions)) {
1123 struct ofputil_flow_mod fm;
1125 memset(&fm, 0, sizeof fm);
1127 fm.buffer_id = UINT32_MAX;
1128 fm.actions = (union ofp_action *) actions;
1129 fm.n_actions = n_actions;
1130 add_flow(ofproto, NULL, &fm, NULL);
1134 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1135 * OpenFlow error code as encoded by ofp_mkerr() on failure, or
1136 * OFPROTO_POSTPONE if the operation cannot be initiated now but may be retried
1139 * This is a helper function for in-band control and fail-open. */
1141 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1143 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1146 /* Searches for a rule with matching criteria exactly equal to 'target' in
1147 * ofproto's table 0 and, if it finds one, deletes it.
1149 * This is a helper function for in-band control and fail-open. */
1151 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1155 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1156 &ofproto->tables[0], target));
1158 /* No such rule -> success. */
1160 } else if (rule->pending) {
1161 /* An operation on the rule is already pending -> failure.
1162 * Caller must retry later if it's important. */
1165 /* Initiate deletion -> success. */
1166 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1167 ofoperation_create(group, rule, OFOPERATION_DELETE);
1168 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
1169 rule->ofproto->ofproto_class->rule_destruct(rule);
1170 ofopgroup_submit(group);
1176 /* Starts the process of deleting all of the flows from all of ofproto's flow
1177 * tables and then reintroducing the flows required by in-band control and
1178 * fail-open. The process will complete in a later call to ofproto_run(). */
1180 ofproto_flush_flows(struct ofproto *ofproto)
1182 COVERAGE_INC(ofproto_flush);
1183 ofproto->state = S_FLUSH;
1187 reinit_ports(struct ofproto *p)
1189 struct ofproto_port_dump dump;
1190 struct sset devnames;
1191 struct ofport *ofport;
1192 struct ofproto_port ofproto_port;
1193 const char *devname;
1195 COVERAGE_INC(ofproto_reinit_ports);
1197 sset_init(&devnames);
1198 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1199 sset_add(&devnames, netdev_get_name(ofport->netdev));
1201 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1202 sset_add(&devnames, ofproto_port.name);
1205 SSET_FOR_EACH (devname, &devnames) {
1206 update_port(p, devname);
1208 sset_destroy(&devnames);
1211 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
1212 * netdev cannot be opened. On success, also fills in 'opp'. */
1213 static struct netdev *
1214 ofport_open(const struct ofproto_port *ofproto_port, struct ofp_phy_port *opp)
1216 uint32_t curr, advertised, supported, peer;
1217 enum netdev_flags flags;
1218 struct netdev *netdev;
1221 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1223 VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1224 "cannot be opened (%s)",
1225 ofproto_port->name, ofproto_port->ofp_port,
1226 ofproto_port->name, strerror(error));
1230 netdev_get_flags(netdev, &flags);
1231 netdev_get_features(netdev, &curr, &advertised, &supported, &peer);
1233 opp->port_no = htons(ofproto_port->ofp_port);
1234 netdev_get_etheraddr(netdev, opp->hw_addr);
1235 ovs_strzcpy(opp->name, ofproto_port->name, sizeof opp->name);
1236 opp->config = flags & NETDEV_UP ? 0 : htonl(OFPPC_PORT_DOWN);
1237 opp->state = netdev_get_carrier(netdev) ? 0 : htonl(OFPPS_LINK_DOWN);
1238 opp->curr = htonl(curr);
1239 opp->advertised = htonl(advertised);
1240 opp->supported = htonl(supported);
1241 opp->peer = htonl(peer);
1246 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1247 * port number, and 'config' bits other than OFPPC_PORT_DOWN are
1250 ofport_equal(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
1252 BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1253 return (!memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1254 && a->state == b->state
1255 && !((a->config ^ b->config) & htonl(OFPPC_PORT_DOWN))
1256 && a->curr == b->curr
1257 && a->advertised == b->advertised
1258 && a->supported == b->supported
1259 && a->peer == b->peer);
1262 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1263 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1264 * one with the same name or port number). */
1266 ofport_install(struct ofproto *p,
1267 struct netdev *netdev, const struct ofp_phy_port *opp)
1269 const char *netdev_name = netdev_get_name(netdev);
1270 struct ofport *ofport;
1274 /* Create ofport. */
1275 ofport = p->ofproto_class->port_alloc();
1280 ofport->ofproto = p;
1281 ofport->netdev = netdev;
1282 ofport->change_seq = netdev_change_seq(netdev);
1284 ofport->ofp_port = ntohs(opp->port_no);
1286 /* Add port to 'p'. */
1287 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1288 shash_add(&p->port_by_name, netdev_name, ofport);
1290 if (!netdev_get_mtu(netdev, &dev_mtu)) {
1291 set_internal_devs_mtu(p);
1292 ofport->mtu = dev_mtu;
1297 /* Let the ofproto_class initialize its private data. */
1298 error = p->ofproto_class->port_construct(ofport);
1302 connmgr_send_port_status(p->connmgr, opp, OFPPR_ADD);
1306 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1307 p->name, netdev_name, strerror(error));
1309 ofport_destroy__(ofport);
1311 netdev_close(netdev);
1315 /* Removes 'ofport' from 'p' and destroys it. */
1317 ofport_remove(struct ofport *ofport)
1319 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->opp,
1321 ofport_destroy(ofport);
1324 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1327 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1329 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1331 ofport_remove(port);
1335 /* Updates 'port' with new 'opp' description.
1337 * Does not handle a name or port number change. The caller must implement
1338 * such a change as a delete followed by an add. */
1340 ofport_modified(struct ofport *port, struct ofp_phy_port *opp)
1342 memcpy(port->opp.hw_addr, opp->hw_addr, ETH_ADDR_LEN);
1343 port->opp.config = ((port->opp.config & ~htonl(OFPPC_PORT_DOWN))
1344 | (opp->config & htonl(OFPPC_PORT_DOWN)));
1345 port->opp.state = opp->state;
1346 port->opp.curr = opp->curr;
1347 port->opp.advertised = opp->advertised;
1348 port->opp.supported = opp->supported;
1349 port->opp.peer = opp->peer;
1351 connmgr_send_port_status(port->ofproto->connmgr, &port->opp, OFPPR_MODIFY);
1354 /* Update OpenFlow 'state' in 'port' and notify controller. */
1356 ofproto_port_set_state(struct ofport *port, ovs_be32 state)
1358 if (port->opp.state != state) {
1359 port->opp.state = state;
1360 connmgr_send_port_status(port->ofproto->connmgr, &port->opp,
1366 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1368 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1370 if (port->ofproto->ofproto_class->set_cfm) {
1371 port->ofproto->ofproto_class->set_cfm(port, NULL);
1373 if (port->ofproto->ofproto_class->bundle_remove) {
1374 port->ofproto->ofproto_class->bundle_remove(port);
1380 ofport_destroy__(struct ofport *port)
1382 struct ofproto *ofproto = port->ofproto;
1383 const char *name = netdev_get_name(port->netdev);
1385 hmap_remove(&ofproto->ports, &port->hmap_node);
1386 shash_delete(&ofproto->port_by_name,
1387 shash_find(&ofproto->port_by_name, name));
1389 netdev_close(port->netdev);
1390 ofproto->ofproto_class->port_dealloc(port);
1394 ofport_destroy(struct ofport *port)
1397 port->ofproto->ofproto_class->port_destruct(port);
1398 ofport_destroy__(port);
1403 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1405 struct ofport *port;
1407 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1408 hash_int(ofp_port, 0), &ofproto->ports) {
1409 if (port->ofp_port == ofp_port) {
1417 update_port(struct ofproto *ofproto, const char *name)
1419 struct ofproto_port ofproto_port;
1420 struct ofp_phy_port opp;
1421 struct netdev *netdev;
1422 struct ofport *port;
1424 COVERAGE_INC(ofproto_update_port);
1426 /* Fetch 'name''s location and properties from the datapath. */
1427 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1428 ? ofport_open(&ofproto_port, &opp)
1431 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1432 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1433 struct netdev *old_netdev = port->netdev;
1436 /* 'name' hasn't changed location. Any properties changed? */
1437 if (!ofport_equal(&port->opp, &opp)) {
1438 ofport_modified(port, &opp);
1441 /* If this is a non-internal port and the MTU changed, check
1442 * if the datapath's MTU needs to be updated. */
1443 if (strcmp(netdev_get_type(netdev), "internal")
1444 && !netdev_get_mtu(netdev, &dev_mtu)
1445 && port->mtu != dev_mtu) {
1446 set_internal_devs_mtu(ofproto);
1447 port->mtu = dev_mtu;
1450 /* Install the newly opened netdev in case it has changed.
1451 * Don't close the old netdev yet in case port_modified has to
1452 * remove a retained reference to it.*/
1453 port->netdev = netdev;
1454 port->change_seq = netdev_change_seq(netdev);
1456 if (port->ofproto->ofproto_class->port_modified) {
1457 port->ofproto->ofproto_class->port_modified(port);
1460 netdev_close(old_netdev);
1462 /* If 'port' is nonnull then its name differs from 'name' and thus
1463 * we should delete it. If we think there's a port named 'name'
1464 * then its port number must be wrong now so delete it too. */
1466 ofport_remove(port);
1468 ofport_remove_with_name(ofproto, name);
1469 ofport_install(ofproto, netdev, &opp);
1472 /* Any port named 'name' is gone now. */
1473 ofport_remove_with_name(ofproto, name);
1475 ofproto_port_destroy(&ofproto_port);
1479 init_ports(struct ofproto *p)
1481 struct ofproto_port_dump dump;
1482 struct ofproto_port ofproto_port;
1484 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1485 uint16_t ofp_port = ofproto_port.ofp_port;
1486 if (ofproto_get_port(p, ofp_port)) {
1487 VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1489 } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1490 VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1493 struct ofp_phy_port opp;
1494 struct netdev *netdev;
1496 netdev = ofport_open(&ofproto_port, &opp);
1498 ofport_install(p, netdev, &opp);
1506 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1507 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1509 find_min_mtu(struct ofproto *p)
1511 struct ofport *ofport;
1514 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1515 struct netdev *netdev = ofport->netdev;
1518 /* Skip any internal ports, since that's what we're trying to
1520 if (!strcmp(netdev_get_type(netdev), "internal")) {
1524 if (netdev_get_mtu(netdev, &dev_mtu)) {
1527 if (!mtu || dev_mtu < mtu) {
1532 return mtu ? mtu: ETH_PAYLOAD_MAX;
1535 /* Set the MTU of all datapath devices on 'p' to the minimum of the
1536 * non-datapath ports. */
1538 set_internal_devs_mtu(struct ofproto *p)
1540 struct ofport *ofport;
1541 int mtu = find_min_mtu(p);
1543 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1544 struct netdev *netdev = ofport->netdev;
1546 if (!strcmp(netdev_get_type(netdev), "internal")) {
1547 netdev_set_mtu(netdev, mtu);
1553 ofproto_rule_destroy__(struct rule *rule)
1555 free(rule->actions);
1556 rule->ofproto->ofproto_class->rule_dealloc(rule);
1559 /* This function allows an ofproto implementation to destroy any rules that
1560 * remain when its ->destruct() function is called. The caller must have
1561 * already uninitialized any derived members of 'rule' (step 5 described in the
1562 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1563 * This function implements steps 6 and 7.
1565 * This function should only be called from an ofproto implementation's
1566 * ->destruct() function. It is not suitable elsewhere. */
1568 ofproto_rule_destroy(struct rule *rule)
1570 assert(!rule->pending);
1571 classifier_remove(&rule->ofproto->tables[rule->table_id], &rule->cr);
1572 ofproto_rule_destroy__(rule);
1575 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1576 * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1579 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1581 const union ofp_action *oa;
1584 if (out_port == OFPP_NONE) {
1587 OFPUTIL_ACTION_FOR_EACH_UNSAFE (oa, left, rule->actions, rule->n_actions) {
1588 if (action_outputs_to_port(oa, htons(out_port))) {
1595 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1596 * statistics appropriately. 'packet' must have at least sizeof(struct
1597 * ofp_packet_in) bytes of headroom.
1599 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1600 * with statistics for 'packet' either way.
1602 * Takes ownership of 'packet'. */
1604 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1608 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1610 flow_extract(packet, 0, in_port, &flow);
1611 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1614 /* Returns true if 'rule' should be hidden from the controller.
1616 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1617 * (e.g. by in-band control) and are intentionally hidden from the
1620 rule_is_hidden(const struct rule *rule)
1622 return rule->cr.priority > UINT16_MAX;
1626 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1628 ofconn_send_reply(ofconn, make_echo_reply(oh));
1633 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1635 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1636 struct ofp_switch_features *osf;
1638 struct ofport *port;
1642 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip, &actions);
1643 assert(actions & (1 << OFPAT_OUTPUT)); /* sanity check */
1645 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1646 osf->datapath_id = htonll(ofproto->datapath_id);
1647 osf->n_buffers = htonl(pktbuf_capacity());
1648 osf->n_tables = ofproto->n_tables;
1649 osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1650 OFPC_PORT_STATS | OFPC_QUEUE_STATS);
1652 osf->capabilities |= htonl(OFPC_ARP_MATCH_IP);
1654 osf->actions = htonl(actions);
1656 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1657 ofpbuf_put(buf, &port->opp, sizeof port->opp);
1660 ofconn_send_reply(ofconn, buf);
1665 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1667 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1668 struct ofp_switch_config *osc;
1672 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1673 osc->flags = htons(ofproto->frag_handling);
1674 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1675 ofconn_send_reply(ofconn, buf);
1681 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1683 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1684 uint16_t flags = ntohs(osc->flags);
1686 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
1687 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1688 enum ofp_config_flags cur = ofproto->frag_handling;
1689 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
1691 assert((cur & OFPC_FRAG_MASK) == cur);
1693 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
1694 ofproto->frag_handling = next;
1696 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
1698 ofputil_frag_handling_to_string(next));
1703 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1708 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1709 * error message code (composed with ofp_mkerr()) for the caller to propagate
1710 * upward. Otherwise, returns 0.
1712 * The log message mentions 'msg_type'. */
1714 reject_slave_controller(struct ofconn *ofconn, const char *msg_type)
1716 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1717 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1718 static struct vlog_rate_limit perm_rl = VLOG_RATE_LIMIT_INIT(1, 5);
1719 VLOG_WARN_RL(&perm_rl, "rejecting %s message from slave controller",
1722 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
1729 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1731 struct ofproto *p = ofconn_get_ofproto(ofconn);
1732 struct ofp_packet_out *opo;
1733 struct ofpbuf payload, *buffer;
1734 union ofp_action *ofp_actions;
1735 struct ofpbuf request;
1737 size_t n_ofp_actions;
1740 COVERAGE_INC(ofproto_packet_out);
1742 error = reject_slave_controller(ofconn, "OFPT_PACKET_OUT");
1747 /* Get ofp_packet_out. */
1748 ofpbuf_use_const(&request, oh, ntohs(oh->length));
1749 opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1752 error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1753 &ofp_actions, &n_ofp_actions);
1759 if (opo->buffer_id != htonl(UINT32_MAX)) {
1760 error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1762 if (error || !buffer) {
1771 /* Send out packet. */
1772 flow_extract(&payload, 0, ntohs(opo->in_port), &flow);
1773 error = p->ofproto_class->packet_out(p, &payload, &flow,
1774 ofp_actions, n_ofp_actions);
1775 ofpbuf_delete(buffer);
1781 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1783 ovs_be32 old_config = port->opp.config;
1785 mask &= config ^ port->opp.config;
1786 if (mask & htonl(OFPPC_PORT_DOWN)) {
1787 if (config & htonl(OFPPC_PORT_DOWN)) {
1788 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1790 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1794 port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1795 OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1796 OFPPC_NO_PACKET_IN));
1797 if (port->opp.config != old_config) {
1798 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1803 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1805 struct ofproto *p = ofconn_get_ofproto(ofconn);
1806 const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1807 struct ofport *port;
1810 error = reject_slave_controller(ofconn, "OFPT_PORT_MOD");
1815 port = ofproto_get_port(p, ntohs(opm->port_no));
1817 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
1818 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1819 return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
1821 update_port_config(port, opm->config, opm->mask);
1822 if (opm->advertise) {
1823 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1830 handle_desc_stats_request(struct ofconn *ofconn,
1831 const struct ofp_stats_msg *request)
1833 struct ofproto *p = ofconn_get_ofproto(ofconn);
1834 struct ofp_desc_stats *ods;
1837 ods = ofputil_make_stats_reply(sizeof *ods, request, &msg);
1838 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1839 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1840 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1841 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1842 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1843 ofconn_send_reply(ofconn, msg);
1849 handle_table_stats_request(struct ofconn *ofconn,
1850 const struct ofp_stats_msg *request)
1852 struct ofproto *p = ofconn_get_ofproto(ofconn);
1853 struct ofp_table_stats *ots;
1857 ofputil_make_stats_reply(sizeof(struct ofp_stats_msg), request, &msg);
1859 ots = ofpbuf_put_zeros(msg, sizeof *ots * p->n_tables);
1860 for (i = 0; i < p->n_tables; i++) {
1861 ots[i].table_id = i;
1862 sprintf(ots[i].name, "table%zu", i);
1863 ots[i].wildcards = htonl(OFPFW_ALL);
1864 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
1865 ots[i].active_count = htonl(classifier_count(&p->tables[i]));
1868 p->ofproto_class->get_tables(p, ots);
1870 ofconn_send_reply(ofconn, msg);
1875 append_port_stat(struct ofport *port, struct list *replies)
1877 struct netdev_stats stats;
1878 struct ofp_port_stats *ops;
1880 /* Intentionally ignore return value, since errors will set
1881 * 'stats' to all-1s, which is correct for OpenFlow, and
1882 * netdev_get_stats() will log errors. */
1883 netdev_get_stats(port->netdev, &stats);
1885 ops = ofputil_append_stats_reply(sizeof *ops, replies);
1886 ops->port_no = port->opp.port_no;
1887 memset(ops->pad, 0, sizeof ops->pad);
1888 put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
1889 put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
1890 put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
1891 put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
1892 put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
1893 put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
1894 put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
1895 put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
1896 put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
1897 put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
1898 put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
1899 put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
1903 handle_port_stats_request(struct ofconn *ofconn,
1904 const struct ofp_port_stats_request *psr)
1906 struct ofproto *p = ofconn_get_ofproto(ofconn);
1907 struct ofport *port;
1908 struct list replies;
1910 ofputil_start_stats_reply(&psr->osm, &replies);
1911 if (psr->port_no != htons(OFPP_NONE)) {
1912 port = ofproto_get_port(p, ntohs(psr->port_no));
1914 append_port_stat(port, &replies);
1917 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
1918 append_port_stat(port, &replies);
1922 ofconn_send_replies(ofconn, &replies);
1927 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
1929 long long int msecs = time_msec() - start;
1930 *sec = msecs / 1000;
1931 *nsec = (msecs % 1000) * (1000 * 1000);
1934 static struct classifier *
1935 first_matching_table(struct ofproto *ofproto, uint8_t table_id)
1937 if (table_id == 0xff) {
1938 return &ofproto->tables[0];
1939 } else if (table_id < ofproto->n_tables) {
1940 return &ofproto->tables[table_id];
1942 /* It would probably be better to reply with an error but there doesn't
1943 * seem to be any appropriate value, so that might just be
1945 VLOG_WARN_RL(&rl, "controller asked for invalid table %"PRIu8,
1951 static struct classifier *
1952 next_matching_table(struct ofproto *ofproto,
1953 struct classifier *cls, uint8_t table_id)
1955 return (table_id == 0xff && cls != &ofproto->tables[ofproto->n_tables - 1]
1960 /* Assigns CLS to each classifier table, in turn, that matches TABLE_ID in
1963 * - If TABLE_ID is 0xff, this iterates over every classifier table in
1966 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
1967 * only once, for that table.
1969 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so ofproto logs a warning
1970 * and does not enter the loop at all.
1972 * All parameters are evaluated multiple times.
1974 #define FOR_EACH_MATCHING_TABLE(CLS, TABLE_ID, OFPROTO) \
1975 for ((CLS) = first_matching_table(OFPROTO, TABLE_ID); \
1977 (CLS) = next_matching_table(OFPROTO, CLS, TABLE_ID))
1979 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
1980 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
1981 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
1984 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
1985 * to 'out_port' are included.
1987 * Hidden rules are always omitted.
1989 * Returns 0 on success, otherwise an OpenFlow error code. */
1991 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
1992 const struct cls_rule *match, uint16_t out_port,
1995 struct classifier *cls;
1998 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
1999 struct cls_cursor cursor;
2002 cls_cursor_init(&cursor, cls, match);
2003 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2004 if (rule->pending) {
2005 return OFPROTO_POSTPONE;
2007 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
2008 list_push_back(rules, &rule->ofproto_node);
2015 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2016 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2017 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2020 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2021 * to 'out_port' are included.
2023 * Hidden rules are always omitted.
2025 * Returns 0 on success, otherwise an OpenFlow error code. */
2027 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2028 const struct cls_rule *match, uint16_t out_port,
2031 struct classifier *cls;
2034 FOR_EACH_MATCHING_TABLE (cls, table_id, ofproto) {
2037 rule = rule_from_cls_rule(classifier_find_rule_exactly(cls, match));
2039 if (rule->pending) {
2040 return OFPROTO_POSTPONE;
2042 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)) {
2043 list_push_back(rules, &rule->ofproto_node);
2051 handle_flow_stats_request(struct ofconn *ofconn,
2052 const struct ofp_stats_msg *osm)
2054 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2055 struct ofputil_flow_stats_request fsr;
2056 struct list replies;
2061 error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
2066 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2067 fsr.out_port, &rules);
2072 ofputil_start_stats_reply(osm, &replies);
2073 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2074 struct ofputil_flow_stats fs;
2077 fs.cookie = rule->flow_cookie;
2078 fs.table_id = rule->table_id;
2079 calc_flow_duration__(rule->created, &fs.duration_sec,
2081 fs.idle_timeout = rule->idle_timeout;
2082 fs.hard_timeout = rule->hard_timeout;
2083 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2085 fs.actions = rule->actions;
2086 fs.n_actions = rule->n_actions;
2087 ofputil_append_flow_stats_reply(&fs, &replies);
2089 ofconn_send_replies(ofconn, &replies);
2095 flow_stats_ds(struct rule *rule, struct ds *results)
2097 uint64_t packet_count, byte_count;
2099 rule->ofproto->ofproto_class->rule_get_stats(rule,
2100 &packet_count, &byte_count);
2102 if (rule->table_id != 0) {
2103 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2105 ds_put_format(results, "duration=%llds, ",
2106 (time_msec() - rule->created) / 1000);
2107 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2108 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2109 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2110 cls_rule_format(&rule->cr, results);
2111 ds_put_char(results, ',');
2112 if (rule->n_actions > 0) {
2113 ofp_print_actions(results, rule->actions, rule->n_actions);
2115 ds_put_cstr(results, "drop");
2117 ds_put_cstr(results, "\n");
2120 /* Adds a pretty-printed description of all flows to 'results', including
2121 * hidden flows (e.g., set up by in-band control). */
2123 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2125 struct classifier *cls;
2127 OFPROTO_FOR_EACH_TABLE (cls, p) {
2128 struct cls_cursor cursor;
2131 cls_cursor_init(&cursor, cls, NULL);
2132 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2133 flow_stats_ds(rule, results);
2138 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2139 * '*engine_type' and '*engine_id', respectively. */
2141 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2142 uint8_t *engine_type, uint8_t *engine_id)
2144 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2147 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns 1
2148 * if CFM is faulted (generally indiciating a connectivity problem), 0 if CFM
2149 * is not faulted, and -1 if CFM is not enabled on 'ofp_port'. */
2151 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2153 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2154 return (ofport && ofproto->ofproto_class->get_cfm_fault
2155 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2159 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2160 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2161 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2162 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2164 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2165 uint16_t ofp_port, const uint64_t **rmps,
2168 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2172 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2173 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2179 handle_aggregate_stats_request(struct ofconn *ofconn,
2180 const struct ofp_stats_msg *osm)
2182 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2183 struct ofputil_flow_stats_request request;
2184 struct ofputil_aggregate_stats stats;
2185 bool unknown_packets, unknown_bytes;
2186 struct ofpbuf *reply;
2191 error = ofputil_decode_flow_stats_request(&request, &osm->header);
2196 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2197 request.out_port, &rules);
2202 memset(&stats, 0, sizeof stats);
2203 unknown_packets = unknown_bytes = false;
2204 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2205 uint64_t packet_count;
2206 uint64_t byte_count;
2208 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2211 if (packet_count == UINT64_MAX) {
2212 unknown_packets = true;
2214 stats.packet_count += packet_count;
2217 if (byte_count == UINT64_MAX) {
2218 unknown_bytes = true;
2220 stats.byte_count += byte_count;
2225 if (unknown_packets) {
2226 stats.packet_count = UINT64_MAX;
2228 if (unknown_bytes) {
2229 stats.byte_count = UINT64_MAX;
2232 reply = ofputil_encode_aggregate_stats_reply(&stats, osm);
2233 ofconn_send_reply(ofconn, reply);
2238 struct queue_stats_cbdata {
2239 struct ofport *ofport;
2240 struct list replies;
2244 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2245 const struct netdev_queue_stats *stats)
2247 struct ofp_queue_stats *reply;
2249 reply = ofputil_append_stats_reply(sizeof *reply, &cbdata->replies);
2250 reply->port_no = cbdata->ofport->opp.port_no;
2251 memset(reply->pad, 0, sizeof reply->pad);
2252 reply->queue_id = htonl(queue_id);
2253 put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2254 put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2255 put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2259 handle_queue_stats_dump_cb(uint32_t queue_id,
2260 struct netdev_queue_stats *stats,
2263 struct queue_stats_cbdata *cbdata = cbdata_;
2265 put_queue_stats(cbdata, queue_id, stats);
2269 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2270 struct queue_stats_cbdata *cbdata)
2272 cbdata->ofport = port;
2273 if (queue_id == OFPQ_ALL) {
2274 netdev_dump_queue_stats(port->netdev,
2275 handle_queue_stats_dump_cb, cbdata);
2277 struct netdev_queue_stats stats;
2279 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2280 put_queue_stats(cbdata, queue_id, &stats);
2286 handle_queue_stats_request(struct ofconn *ofconn,
2287 const struct ofp_queue_stats_request *qsr)
2289 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2290 struct queue_stats_cbdata cbdata;
2291 struct ofport *port;
2292 unsigned int port_no;
2295 COVERAGE_INC(ofproto_queue_req);
2297 ofputil_start_stats_reply(&qsr->osm, &cbdata.replies);
2299 port_no = ntohs(qsr->port_no);
2300 queue_id = ntohl(qsr->queue_id);
2301 if (port_no == OFPP_ALL) {
2302 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2303 handle_queue_stats_for_port(port, queue_id, &cbdata);
2305 } else if (port_no < OFPP_MAX) {
2306 port = ofproto_get_port(ofproto, port_no);
2308 handle_queue_stats_for_port(port, queue_id, &cbdata);
2311 ofpbuf_list_delete(&cbdata.replies);
2312 return ofp_mkerr(OFPET_QUEUE_OP_FAILED, OFPQOFC_BAD_PORT);
2314 ofconn_send_replies(ofconn, &cbdata.replies);
2320 is_flow_deletion_pending(const struct ofproto *ofproto,
2321 const struct cls_rule *cls_rule,
2324 if (!hmap_is_empty(&ofproto->deletions)) {
2325 struct ofoperation *op;
2327 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2328 cls_rule_hash(cls_rule, table_id),
2329 &ofproto->deletions) {
2330 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2339 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2340 * in which no matching flow already exists in the flow table.
2342 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2343 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
2344 * error code as encoded by ofp_mkerr() on failure, or OFPROTO_POSTPONE if the
2345 * operation cannot be initiated now but may be retried later.
2347 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2350 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
2351 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
2353 struct classifier *table;
2354 struct ofopgroup *group;
2355 struct rule *victim;
2360 if (fm->table_id == 0xff) {
2362 if (ofproto->ofproto_class->rule_choose_table) {
2363 error = ofproto->ofproto_class->rule_choose_table(ofproto, &fm->cr,
2368 assert(table_id < ofproto->n_tables);
2369 table = &ofproto->tables[table_id];
2371 table = &ofproto->tables[0];
2373 } else if (fm->table_id < ofproto->n_tables) {
2374 table = &ofproto->tables[fm->table_id];
2376 return ofp_mkerr_nicira(OFPET_FLOW_MOD_FAILED, NXFMFC_BAD_TABLE_ID);
2379 /* Check for overlap, if requested. */
2380 if (fm->flags & OFPFF_CHECK_OVERLAP
2381 && classifier_rule_overlaps(table, &fm->cr)) {
2382 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
2385 /* Serialize against pending deletion. */
2386 if (is_flow_deletion_pending(ofproto, &fm->cr, table - ofproto->tables)) {
2387 return OFPROTO_POSTPONE;
2390 /* Allocate new rule. */
2391 rule = ofproto->ofproto_class->rule_alloc();
2393 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2394 ofproto->name, strerror(error));
2397 rule->ofproto = ofproto;
2399 rule->pending = NULL;
2400 rule->flow_cookie = fm->cookie;
2401 rule->created = rule->modified = time_msec();
2402 rule->idle_timeout = fm->idle_timeout;
2403 rule->hard_timeout = fm->hard_timeout;
2404 rule->table_id = table - ofproto->tables;
2405 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2406 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2407 rule->n_actions = fm->n_actions;
2409 /* Insert new rule. */
2410 victim = rule_from_cls_rule(classifier_replace(table, &rule->cr));
2411 if (victim && victim->pending) {
2412 error = OFPROTO_POSTPONE;
2414 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2415 ofoperation_create(group, rule, OFOPERATION_ADD);
2416 rule->pending->victim = victim;
2418 error = ofproto->ofproto_class->rule_construct(rule);
2420 ofoperation_destroy(rule->pending);
2422 ofopgroup_submit(group);
2425 /* Back out if an error occurred. */
2428 classifier_replace(table, &victim->cr);
2430 classifier_remove(table, &rule->cr);
2432 ofproto_rule_destroy__(rule);
2437 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2439 /* Modifies the rules listed in 'rules', changing their actions to match those
2442 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2445 * Returns 0 on success, otherwise an OpenFlow error code. */
2447 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2448 const struct ofputil_flow_mod *fm,
2449 const struct ofp_header *request, struct list *rules)
2451 struct ofopgroup *group;
2454 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2455 LIST_FOR_EACH (rule, ofproto_node, rules) {
2456 if (!ofputil_actions_equal(fm->actions, fm->n_actions,
2457 rule->actions, rule->n_actions)) {
2458 ofoperation_create(group, rule, OFOPERATION_MODIFY);
2459 rule->pending->actions = rule->actions;
2460 rule->pending->n_actions = rule->n_actions;
2461 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2462 rule->n_actions = fm->n_actions;
2463 rule->ofproto->ofproto_class->rule_modify_actions(rule);
2465 rule->modified = time_msec();
2467 rule->flow_cookie = fm->cookie;
2469 ofopgroup_submit(group);
2474 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code as
2475 * encoded by ofp_mkerr() on failure.
2477 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2480 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2481 const struct ofputil_flow_mod *fm,
2482 const struct ofp_header *request)
2487 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr, OFPP_NONE,
2489 return (error ? error
2490 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2491 : modify_flows__(ofproto, ofconn, fm, request, &rules));
2494 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2495 * code as encoded by ofp_mkerr() on failure.
2497 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2500 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2501 const struct ofputil_flow_mod *fm,
2502 const struct ofp_header *request)
2507 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr, OFPP_NONE,
2509 return (error ? error
2510 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2511 : list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
2512 fm, request, &rules)
2516 /* OFPFC_DELETE implementation. */
2518 /* Deletes the rules listed in 'rules'.
2520 * Returns 0 on success, otherwise an OpenFlow error code. */
2522 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2523 const struct ofp_header *request, struct list *rules)
2525 struct rule *rule, *next;
2526 struct ofopgroup *group;
2528 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
2529 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
2530 ofproto_rule_send_removed(rule, OFPRR_DELETE);
2532 ofoperation_create(group, rule, OFOPERATION_DELETE);
2533 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2534 rule->ofproto->ofproto_class->rule_destruct(rule);
2536 ofopgroup_submit(group);
2541 /* Implements OFPFC_DELETE. */
2543 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2544 const struct ofputil_flow_mod *fm,
2545 const struct ofp_header *request)
2550 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr, fm->out_port,
2552 return (error ? error
2553 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
2558 /* Implements OFPFC_DELETE_STRICT. */
2560 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2561 const struct ofputil_flow_mod *fm,
2562 const struct ofp_header *request)
2567 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr, fm->out_port,
2569 return (error ? error
2570 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
2576 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2578 struct ofputil_flow_removed fr;
2580 if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2585 fr.cookie = rule->flow_cookie;
2587 calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2588 fr.idle_timeout = rule->idle_timeout;
2589 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2592 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2595 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2596 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2599 * ofproto implementation ->run() functions should use this function to expire
2600 * OpenFlow flows. */
2602 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2604 struct ofproto *ofproto = rule->ofproto;
2605 struct ofopgroup *group;
2607 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2609 ofproto_rule_send_removed(rule, reason);
2611 group = ofopgroup_create_unattached(ofproto);
2612 ofoperation_create(group, rule, OFOPERATION_DELETE);
2613 classifier_remove(&ofproto->tables[rule->table_id], &rule->cr);
2614 rule->ofproto->ofproto_class->rule_destruct(rule);
2615 ofopgroup_submit(group);
2619 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2621 struct ofputil_flow_mod fm;
2624 error = reject_slave_controller(ofconn, "flow_mod");
2629 error = ofputil_decode_flow_mod(&fm, oh,
2630 ofconn_get_flow_mod_table_id(ofconn));
2635 /* We do not support the emergency flow cache. It will hopefully get
2636 * dropped from OpenFlow in the near future. */
2637 if (fm.flags & OFPFF_EMERG) {
2638 /* There isn't a good fit for an error code, so just state that the
2639 * flow table is full. */
2640 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
2643 return handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
2647 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
2648 const struct ofputil_flow_mod *fm,
2649 const struct ofp_header *oh)
2651 if (ofproto->n_pending >= 50) {
2652 assert(!list_is_empty(&ofproto->pending));
2653 return OFPROTO_POSTPONE;
2656 switch (fm->command) {
2658 return add_flow(ofproto, ofconn, fm, oh);
2661 return modify_flows_loose(ofproto, ofconn, fm, oh);
2663 case OFPFC_MODIFY_STRICT:
2664 return modify_flow_strict(ofproto, ofconn, fm, oh);
2667 return delete_flows_loose(ofproto, ofconn, fm, oh);
2669 case OFPFC_DELETE_STRICT:
2670 return delete_flow_strict(ofproto, ofconn, fm, oh);
2673 if (fm->command > 0xff) {
2674 VLOG_WARN_RL(&rl, "flow_mod has explicit table_id but "
2675 "flow_mod_table_id extension is not enabled");
2677 return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
2682 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2684 struct nx_role_request *nrr = (struct nx_role_request *) oh;
2685 struct nx_role_request *reply;
2689 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2690 VLOG_WARN_RL(&rl, "ignoring role request on service connection");
2691 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2694 role = ntohl(nrr->role);
2695 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2696 && role != NX_ROLE_SLAVE) {
2697 VLOG_WARN_RL(&rl, "received request for unknown role %"PRIu32, role);
2699 /* There's no good error code for this. */
2700 return ofp_mkerr(OFPET_BAD_REQUEST, -1);
2703 if (ofconn_get_role(ofconn) != role
2704 && ofconn_has_pending_opgroups(ofconn)) {
2705 return OFPROTO_POSTPONE;
2708 ofconn_set_role(ofconn, role);
2710 reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2711 reply->role = htonl(role);
2712 ofconn_send_reply(ofconn, buf);
2718 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
2719 const struct ofp_header *oh)
2721 const struct nxt_flow_mod_table_id *msg
2722 = (const struct nxt_flow_mod_table_id *) oh;
2724 ofconn_set_flow_mod_table_id(ofconn, msg->set != 0);
2729 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2731 const struct nxt_set_flow_format *msg
2732 = (const struct nxt_set_flow_format *) oh;
2735 format = ntohl(msg->format);
2736 if (format != NXFF_OPENFLOW10 && format != NXFF_NXM) {
2737 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_EPERM);
2740 if (format != ofconn_get_flow_format(ofconn)
2741 && ofconn_has_pending_opgroups(ofconn)) {
2742 /* Avoid sending async messages in surprising flow format. */
2743 return OFPROTO_POSTPONE;
2746 ofconn_set_flow_format(ofconn, format);
2751 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2753 struct ofp_header *ob;
2756 if (ofconn_has_pending_opgroups(ofconn)) {
2757 return OFPROTO_POSTPONE;
2760 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2761 ofconn_send_reply(ofconn, buf);
2766 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2768 const struct ofp_header *oh = msg->data;
2769 const struct ofputil_msg_type *type;
2772 error = ofputil_decode_msg_type(oh, &type);
2777 switch (ofputil_msg_type_code(type)) {
2778 /* OpenFlow requests. */
2779 case OFPUTIL_OFPT_ECHO_REQUEST:
2780 return handle_echo_request(ofconn, oh);
2782 case OFPUTIL_OFPT_FEATURES_REQUEST:
2783 return handle_features_request(ofconn, oh);
2785 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2786 return handle_get_config_request(ofconn, oh);
2788 case OFPUTIL_OFPT_SET_CONFIG:
2789 return handle_set_config(ofconn, msg->data);
2791 case OFPUTIL_OFPT_PACKET_OUT:
2792 return handle_packet_out(ofconn, oh);
2794 case OFPUTIL_OFPT_PORT_MOD:
2795 return handle_port_mod(ofconn, oh);
2797 case OFPUTIL_OFPT_FLOW_MOD:
2798 return handle_flow_mod(ofconn, oh);
2800 case OFPUTIL_OFPT_BARRIER_REQUEST:
2801 return handle_barrier_request(ofconn, oh);
2803 /* OpenFlow replies. */
2804 case OFPUTIL_OFPT_ECHO_REPLY:
2807 /* Nicira extension requests. */
2808 case OFPUTIL_NXT_ROLE_REQUEST:
2809 return handle_role_request(ofconn, oh);
2811 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
2812 return handle_nxt_flow_mod_table_id(ofconn, oh);
2814 case OFPUTIL_NXT_SET_FLOW_FORMAT:
2815 return handle_nxt_set_flow_format(ofconn, oh);
2817 case OFPUTIL_NXT_FLOW_MOD:
2818 return handle_flow_mod(ofconn, oh);
2820 /* Statistics requests. */
2821 case OFPUTIL_OFPST_DESC_REQUEST:
2822 return handle_desc_stats_request(ofconn, msg->data);
2824 case OFPUTIL_OFPST_FLOW_REQUEST:
2825 case OFPUTIL_NXST_FLOW_REQUEST:
2826 return handle_flow_stats_request(ofconn, msg->data);
2828 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
2829 case OFPUTIL_NXST_AGGREGATE_REQUEST:
2830 return handle_aggregate_stats_request(ofconn, msg->data);
2832 case OFPUTIL_OFPST_TABLE_REQUEST:
2833 return handle_table_stats_request(ofconn, msg->data);
2835 case OFPUTIL_OFPST_PORT_REQUEST:
2836 return handle_port_stats_request(ofconn, msg->data);
2838 case OFPUTIL_OFPST_QUEUE_REQUEST:
2839 return handle_queue_stats_request(ofconn, msg->data);
2841 case OFPUTIL_MSG_INVALID:
2842 case OFPUTIL_OFPT_HELLO:
2843 case OFPUTIL_OFPT_ERROR:
2844 case OFPUTIL_OFPT_FEATURES_REPLY:
2845 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
2846 case OFPUTIL_OFPT_PACKET_IN:
2847 case OFPUTIL_OFPT_FLOW_REMOVED:
2848 case OFPUTIL_OFPT_PORT_STATUS:
2849 case OFPUTIL_OFPT_BARRIER_REPLY:
2850 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
2851 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
2852 case OFPUTIL_OFPST_DESC_REPLY:
2853 case OFPUTIL_OFPST_FLOW_REPLY:
2854 case OFPUTIL_OFPST_QUEUE_REPLY:
2855 case OFPUTIL_OFPST_PORT_REPLY:
2856 case OFPUTIL_OFPST_TABLE_REPLY:
2857 case OFPUTIL_OFPST_AGGREGATE_REPLY:
2858 case OFPUTIL_NXT_ROLE_REPLY:
2859 case OFPUTIL_NXT_FLOW_REMOVED:
2860 case OFPUTIL_NXST_FLOW_REPLY:
2861 case OFPUTIL_NXST_AGGREGATE_REPLY:
2863 if (VLOG_IS_WARN_ENABLED()) {
2864 char *s = ofp_to_string(oh, ntohs(oh->length), 2);
2865 VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
2868 if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
2869 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2871 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
2877 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
2879 int error = handle_openflow__(ofconn, ofp_msg);
2880 if (error && error != OFPROTO_POSTPONE) {
2881 ofconn_send_error(ofconn, ofp_msg->data, error);
2883 COVERAGE_INC(ofproto_recv_openflow);
2884 return error != OFPROTO_POSTPONE;
2887 /* Asynchronous operations. */
2889 /* Creates and returns a new ofopgroup that is not associated with any
2890 * OpenFlow connection.
2892 * The caller should add operations to the returned group with
2893 * ofoperation_create() and then submit it with ofopgroup_submit(). */
2894 static struct ofopgroup *
2895 ofopgroup_create_unattached(struct ofproto *ofproto)
2897 struct ofopgroup *group = xzalloc(sizeof *group);
2898 group->ofproto = ofproto;
2899 list_init(&group->ofproto_node);
2900 list_init(&group->ops);
2901 list_init(&group->ofconn_node);
2905 /* Creates and returns a new ofopgroup for 'ofproto'.
2907 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
2908 * connection. The 'request' and 'buffer_id' arguments are ignored.
2910 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
2911 * If the ofopgroup eventually fails, then the error reply will include
2912 * 'request'. If the ofopgroup eventually succeeds, then the packet with
2913 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
2915 * The caller should add operations to the returned group with
2916 * ofoperation_create() and then submit it with ofopgroup_submit(). */
2917 static struct ofopgroup *
2918 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
2919 const struct ofp_header *request, uint32_t buffer_id)
2921 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
2923 size_t request_len = ntohs(request->length);
2925 assert(ofconn_get_ofproto(ofconn) == ofproto);
2927 ofconn_add_opgroup(ofconn, &group->ofconn_node);
2928 group->ofconn = ofconn;
2929 group->request = xmemdup(request, MIN(request_len, 64));
2930 group->buffer_id = buffer_id;
2935 /* Submits 'group' for processing.
2937 * If 'group' contains no operations (e.g. none were ever added, or all of the
2938 * ones that were added completed synchronously), then it is destroyed
2939 * immediately. Otherwise it is added to the ofproto's list of pending
2942 ofopgroup_submit(struct ofopgroup *group)
2944 if (list_is_empty(&group->ops)) {
2945 ofopgroup_destroy(group);
2947 list_push_back(&group->ofproto->pending, &group->ofproto_node);
2948 group->ofproto->n_pending++;
2953 ofopgroup_destroy(struct ofopgroup *group)
2955 assert(list_is_empty(&group->ops));
2956 if (!list_is_empty(&group->ofproto_node)) {
2957 assert(group->ofproto->n_pending > 0);
2958 group->ofproto->n_pending--;
2959 list_remove(&group->ofproto_node);
2961 if (!list_is_empty(&group->ofconn_node)) {
2962 list_remove(&group->ofconn_node);
2964 ofconn_send_error(group->ofconn, group->request, group->error);
2966 connmgr_retry(group->ofproto->connmgr);
2968 free(group->request);
2972 /* Initiates a new operation on 'rule', of the specified 'type', within
2973 * 'group'. Prior to calling, 'rule' must not have any pending operation. */
2975 ofoperation_create(struct ofopgroup *group, struct rule *rule,
2976 enum ofoperation_type type)
2978 struct ofoperation *op;
2980 assert(!rule->pending);
2982 op = rule->pending = xzalloc(sizeof *op);
2984 list_push_back(&group->ops, &op->group_node);
2988 op->flow_cookie = rule->flow_cookie;
2990 if (type == OFOPERATION_DELETE) {
2991 hmap_insert(&op->group->ofproto->deletions, &op->hmap_node,
2992 cls_rule_hash(&rule->cr, rule->table_id));
2997 ofoperation_destroy(struct ofoperation *op)
2999 struct ofopgroup *group = op->group;
3002 op->rule->pending = NULL;
3004 if (op->type == OFOPERATION_DELETE) {
3005 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
3007 list_remove(&op->group_node);
3011 if (list_is_empty(&group->ops) && !list_is_empty(&group->ofproto_node)) {
3012 ofopgroup_destroy(group);
3016 /* Indicates that 'op' completed with status 'error', which is either 0 to
3017 * indicate success or an OpenFlow error code (constructed with
3018 * e.g. ofp_mkerr()).
3020 * If 'error' is 0, indicating success, the operation will be committed
3021 * permanently to the flow table. There is one interesting subcase:
3023 * - If 'op' is an "add flow" operation that is replacing an existing rule in
3024 * the flow table (the "victim" rule) by a new one, then the caller must
3025 * have uninitialized any derived state in the victim rule, as in step 5 in
3026 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
3027 * performs steps 6 and 7 for the victim rule, most notably by calling its
3028 * ->rule_dealloc() function.
3030 * If 'error' is nonzero, then generally the operation will be rolled back:
3032 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
3033 * restores the original rule. The caller must have uninitialized any
3034 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
3035 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
3036 * and 7 for the new rule, calling its ->rule_dealloc() function.
3038 * - If 'op' is a "modify flow" operation, ofproto restores the original
3041 * - 'op' must not be a "delete flow" operation. Removing a rule is not
3042 * allowed to fail. It must always succeed.
3044 * Please see the large comment in ofproto/ofproto-provider.h titled
3045 * "Asynchronous Operation Support" for more information. */
3047 ofoperation_complete(struct ofoperation *op, int error)
3049 struct ofopgroup *group = op->group;
3050 struct rule *rule = op->rule;
3051 struct classifier *table = &rule->ofproto->tables[rule->table_id];
3053 assert(rule->pending == op);
3054 assert(op->status < 0);
3059 && op->type != OFOPERATION_DELETE
3061 && group->buffer_id != UINT32_MAX
3062 && list_is_singleton(&op->group_node)) {
3063 struct ofpbuf *packet;
3066 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
3070 error = rule_execute(rule, in_port, packet);
3073 if (!group->error) {
3074 group->error = error;
3078 case OFOPERATION_ADD:
3081 ofproto_rule_destroy__(op->victim);
3085 classifier_replace(table, &op->victim->cr);
3088 classifier_remove(table, &rule->cr);
3090 ofproto_rule_destroy__(rule);
3095 case OFOPERATION_DELETE:
3097 ofproto_rule_destroy__(rule);
3101 case OFOPERATION_MODIFY:
3103 rule->modified = time_msec();
3105 free(rule->actions);
3106 rule->actions = op->actions;
3107 rule->n_actions = op->n_actions;
3115 ofoperation_destroy(op);
3119 ofoperation_get_victim(struct ofoperation *op)
3121 assert(op->type == OFOPERATION_ADD);
3126 pick_datapath_id(const struct ofproto *ofproto)
3128 const struct ofport *port;
3130 port = ofproto_get_port(ofproto, OFPP_LOCAL);
3132 uint8_t ea[ETH_ADDR_LEN];
3135 error = netdev_get_etheraddr(port->netdev, ea);
3137 return eth_addr_to_uint64(ea);
3139 VLOG_WARN("could not get MAC address for %s (%s)",
3140 netdev_get_name(port->netdev), strerror(error));
3142 return ofproto->fallback_dpid;
3146 pick_fallback_dpid(void)
3148 uint8_t ea[ETH_ADDR_LEN];
3149 eth_addr_nicira_random(ea);
3150 return eth_addr_to_uint64(ea);
3153 /* unixctl commands. */
3156 ofproto_lookup(const char *name)
3158 struct ofproto *ofproto;
3160 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
3162 if (!strcmp(ofproto->name, name)) {
3170 ofproto_unixctl_list(struct unixctl_conn *conn, const char *arg OVS_UNUSED,
3171 void *aux OVS_UNUSED)
3173 struct ofproto *ofproto;
3177 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
3178 ds_put_format(&results, "%s\n", ofproto->name);
3180 unixctl_command_reply(conn, 200, ds_cstr(&results));
3181 ds_destroy(&results);
3185 ofproto_unixctl_init(void)
3187 static bool registered;
3193 unixctl_command_register("ofproto/list", "", ofproto_unixctl_list, NULL);