2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
25 #include "byte-order.h"
26 #include "classifier.h"
29 #include "dynamic-string.h"
34 #include "ofp-errors.h"
35 #include "ofp-print.h"
38 #include "ofproto-provider.h"
39 #include "openflow/nicira-ext.h"
40 #include "openflow/openflow.h"
44 #include "poll-loop.h"
48 #include "unaligned.h"
52 VLOG_DEFINE_THIS_MODULE(ofproto);
54 COVERAGE_DEFINE(ofproto_error);
55 COVERAGE_DEFINE(ofproto_flush);
56 COVERAGE_DEFINE(ofproto_no_packet_in);
57 COVERAGE_DEFINE(ofproto_packet_out);
58 COVERAGE_DEFINE(ofproto_queue_req);
59 COVERAGE_DEFINE(ofproto_recv_openflow);
60 COVERAGE_DEFINE(ofproto_reinit_ports);
61 COVERAGE_DEFINE(ofproto_uninstallable);
62 COVERAGE_DEFINE(ofproto_update_port);
65 S_OPENFLOW, /* Processing OpenFlow commands. */
66 S_FLUSH, /* Deleting all flow table rules. */
69 enum ofoperation_type {
75 /* A single OpenFlow request can execute any number of operations. The
76 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
77 * ofconn to which an error reply should be sent if necessary.
79 * ofproto initiates some operations internally. These operations are still
80 * assigned to groups but will not have an associated ofconn. */
82 struct ofproto *ofproto; /* Owning ofproto. */
83 struct list ofproto_node; /* In ofproto's "pending" list. */
84 struct list ops; /* List of "struct ofoperation"s. */
86 /* Data needed to send OpenFlow reply on failure or to send a buffered
89 * If list_is_empty(ofconn_node) then this ofopgroup never had an
90 * associated ofconn or its ofconn's connection dropped after it initiated
91 * the operation. In the latter case 'ofconn' is a wild pointer that
92 * refers to freed memory, so the 'ofconn' member must be used only if
93 * !list_is_empty(ofconn_node).
95 struct list ofconn_node; /* In ofconn's list of pending opgroups. */
96 struct ofconn *ofconn; /* ofconn for reply (but see note above). */
97 struct ofp_header *request; /* Original request (truncated at 64 bytes). */
98 uint32_t buffer_id; /* Buffer id from original request. */
99 int error; /* 0 if no error yet, otherwise error code. */
102 static struct ofopgroup *ofopgroup_create_unattached(struct ofproto *);
103 static struct ofopgroup *ofopgroup_create(struct ofproto *, struct ofconn *,
104 const struct ofp_header *,
106 static void ofopgroup_submit(struct ofopgroup *);
107 static void ofopgroup_destroy(struct ofopgroup *);
109 /* A single flow table operation. */
111 struct ofopgroup *group; /* Owning group. */
112 struct list group_node; /* In ofopgroup's "ops" list. */
113 struct hmap_node hmap_node; /* In ofproto's "deletions" hmap. */
114 struct rule *rule; /* Rule being operated upon. */
115 enum ofoperation_type type; /* Type of operation. */
116 int status; /* -1 if pending, otherwise 0 or error code. */
117 struct rule *victim; /* OFOPERATION_ADDING: Replaced rule. */
118 union ofp_action *actions; /* OFOPERATION_MODIFYING: Replaced actions. */
119 int n_actions; /* OFOPERATION_MODIFYING: # of old actions. */
120 ovs_be64 flow_cookie; /* Rule's old flow cookie. */
123 static void ofoperation_create(struct ofopgroup *, struct rule *,
124 enum ofoperation_type);
125 static void ofoperation_destroy(struct ofoperation *);
128 static void oftable_init(struct oftable *);
129 static void oftable_destroy(struct oftable *);
131 static void oftable_remove_rule(struct rule *);
132 static struct rule *oftable_replace_rule(struct rule *);
133 static void oftable_substitute_rule(struct rule *old, struct rule *new);
136 static void ofproto_rule_destroy__(struct rule *);
137 static void ofproto_rule_send_removed(struct rule *, uint8_t reason);
138 static bool rule_is_modifiable(const struct rule *);
139 static bool rule_is_hidden(const struct rule *);
142 static void ofport_destroy__(struct ofport *);
143 static void ofport_destroy(struct ofport *);
145 static void update_port(struct ofproto *, const char *devname);
146 static int init_ports(struct ofproto *);
147 static void reinit_ports(struct ofproto *);
150 static enum ofperr add_flow(struct ofproto *, struct ofconn *,
151 const struct ofputil_flow_mod *,
152 const struct ofp_header *);
154 static bool handle_openflow(struct ofconn *, struct ofpbuf *);
155 static enum ofperr handle_flow_mod__(struct ofproto *, struct ofconn *,
156 const struct ofputil_flow_mod *,
157 const struct ofp_header *);
160 static uint64_t pick_datapath_id(const struct ofproto *);
161 static uint64_t pick_fallback_dpid(void);
162 static void ofproto_destroy__(struct ofproto *);
163 static void set_internal_devs_mtu(struct ofproto *);
166 static void ofproto_unixctl_init(void);
168 /* All registered ofproto classes, in probe order. */
169 static const struct ofproto_class **ofproto_classes;
170 static size_t n_ofproto_classes;
171 static size_t allocated_ofproto_classes;
173 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
174 static struct hmap all_ofprotos = HMAP_INITIALIZER(&all_ofprotos);
176 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
179 ofproto_initialize(void)
185 ofproto_class_register(&ofproto_dpif_class);
189 /* 'type' should be a normalized datapath type, as returned by
190 * ofproto_normalize_type(). Returns the corresponding ofproto_class
191 * structure, or a null pointer if there is none registered for 'type'. */
192 static const struct ofproto_class *
193 ofproto_class_find__(const char *type)
197 ofproto_initialize();
198 for (i = 0; i < n_ofproto_classes; i++) {
199 const struct ofproto_class *class = ofproto_classes[i];
204 class->enumerate_types(&types);
205 found = sset_contains(&types, type);
206 sset_destroy(&types);
212 VLOG_WARN("unknown datapath type %s", type);
216 /* Registers a new ofproto class. After successful registration, new ofprotos
217 * of that type can be created using ofproto_create(). */
219 ofproto_class_register(const struct ofproto_class *new_class)
223 for (i = 0; i < n_ofproto_classes; i++) {
224 if (ofproto_classes[i] == new_class) {
229 if (n_ofproto_classes >= allocated_ofproto_classes) {
230 ofproto_classes = x2nrealloc(ofproto_classes,
231 &allocated_ofproto_classes,
232 sizeof *ofproto_classes);
234 ofproto_classes[n_ofproto_classes++] = new_class;
238 /* Unregisters a datapath provider. 'type' must have been previously
239 * registered and not currently be in use by any ofprotos. After
240 * unregistration new datapaths of that type cannot be opened using
241 * ofproto_create(). */
243 ofproto_class_unregister(const struct ofproto_class *class)
247 for (i = 0; i < n_ofproto_classes; i++) {
248 if (ofproto_classes[i] == class) {
249 for (i++; i < n_ofproto_classes; i++) {
250 ofproto_classes[i - 1] = ofproto_classes[i];
256 VLOG_WARN("attempted to unregister an ofproto class that is not "
261 /* Clears 'types' and enumerates all registered ofproto types into it. The
262 * caller must first initialize the sset. */
264 ofproto_enumerate_types(struct sset *types)
268 ofproto_initialize();
269 for (i = 0; i < n_ofproto_classes; i++) {
270 ofproto_classes[i]->enumerate_types(types);
274 /* Returns the fully spelled out name for the given ofproto 'type'.
276 * Normalized type string can be compared with strcmp(). Unnormalized type
277 * string might be the same even if they have different spellings. */
279 ofproto_normalize_type(const char *type)
281 return type && type[0] ? type : "system";
284 /* Clears 'names' and enumerates the names of all known created ofprotos with
285 * the given 'type'. The caller must first initialize the sset. Returns 0 if
286 * successful, otherwise a positive errno value.
288 * Some kinds of datapaths might not be practically enumerable. This is not
289 * considered an error. */
291 ofproto_enumerate_names(const char *type, struct sset *names)
293 const struct ofproto_class *class = ofproto_class_find__(type);
294 return class ? class->enumerate_names(type, names) : EAFNOSUPPORT;
298 ofproto_create(const char *datapath_name, const char *datapath_type,
299 struct ofproto **ofprotop)
301 const struct ofproto_class *class;
302 struct ofproto *ofproto;
307 ofproto_initialize();
308 ofproto_unixctl_init();
310 datapath_type = ofproto_normalize_type(datapath_type);
311 class = ofproto_class_find__(datapath_type);
313 VLOG_WARN("could not create datapath %s of unknown type %s",
314 datapath_name, datapath_type);
318 ofproto = class->alloc();
320 VLOG_ERR("failed to allocate datapath %s of type %s",
321 datapath_name, datapath_type);
326 memset(ofproto, 0, sizeof *ofproto);
327 ofproto->ofproto_class = class;
328 ofproto->name = xstrdup(datapath_name);
329 ofproto->type = xstrdup(datapath_type);
330 hmap_insert(&all_ofprotos, &ofproto->hmap_node,
331 hash_string(ofproto->name, 0));
332 ofproto->datapath_id = 0;
333 ofproto_set_flow_eviction_threshold(ofproto,
334 OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT);
335 ofproto->forward_bpdu = false;
336 ofproto->fallback_dpid = pick_fallback_dpid();
337 ofproto->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
338 ofproto->hw_desc = xstrdup(DEFAULT_HW_DESC);
339 ofproto->sw_desc = xstrdup(DEFAULT_SW_DESC);
340 ofproto->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
341 ofproto->dp_desc = xstrdup(DEFAULT_DP_DESC);
342 ofproto->frag_handling = OFPC_FRAG_NORMAL;
343 hmap_init(&ofproto->ports);
344 shash_init(&ofproto->port_by_name);
345 ofproto->tables = NULL;
346 ofproto->n_tables = 0;
347 ofproto->connmgr = connmgr_create(ofproto, datapath_name, datapath_name);
348 ofproto->state = S_OPENFLOW;
349 list_init(&ofproto->pending);
350 ofproto->n_pending = 0;
351 hmap_init(&ofproto->deletions);
352 ofproto->vlan_bitmap = NULL;
353 ofproto->vlans_changed = false;
355 error = ofproto->ofproto_class->construct(ofproto);
357 VLOG_ERR("failed to open datapath %s: %s",
358 datapath_name, strerror(error));
359 ofproto_destroy__(ofproto);
363 assert(ofproto->n_tables);
365 ofproto->datapath_id = pick_datapath_id(ofproto);
366 VLOG_INFO("using datapath ID %016"PRIx64, ofproto->datapath_id);
374 ofproto_init_tables(struct ofproto *ofproto, int n_tables)
376 struct oftable *table;
378 assert(!ofproto->n_tables);
379 assert(n_tables >= 1 && n_tables <= 255);
381 ofproto->n_tables = n_tables;
382 ofproto->tables = xmalloc(n_tables * sizeof *ofproto->tables);
383 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
389 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
391 uint64_t old_dpid = p->datapath_id;
392 p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
393 if (p->datapath_id != old_dpid) {
394 VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
396 /* Force all active connections to reconnect, since there is no way to
397 * notify a controller that the datapath ID has changed. */
398 ofproto_reconnect_controllers(p);
403 ofproto_set_controllers(struct ofproto *p,
404 const struct ofproto_controller *controllers,
405 size_t n_controllers)
407 connmgr_set_controllers(p->connmgr, controllers, n_controllers);
411 ofproto_set_fail_mode(struct ofproto *p, enum ofproto_fail_mode fail_mode)
413 connmgr_set_fail_mode(p->connmgr, fail_mode);
416 /* Drops the connections between 'ofproto' and all of its controllers, forcing
417 * them to reconnect. */
419 ofproto_reconnect_controllers(struct ofproto *ofproto)
421 connmgr_reconnect(ofproto->connmgr);
424 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
425 * in-band control should guarantee access, in the same way that in-band
426 * control guarantees access to OpenFlow controllers. */
428 ofproto_set_extra_in_band_remotes(struct ofproto *ofproto,
429 const struct sockaddr_in *extras, size_t n)
431 connmgr_set_extra_in_band_remotes(ofproto->connmgr, extras, n);
434 /* Sets the OpenFlow queue used by flows set up by in-band control on
435 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
436 * flows will use the default queue. */
438 ofproto_set_in_band_queue(struct ofproto *ofproto, int queue_id)
440 connmgr_set_in_band_queue(ofproto->connmgr, queue_id);
443 /* Sets the number of flows at which eviction from the kernel flow table
446 ofproto_set_flow_eviction_threshold(struct ofproto *ofproto, unsigned threshold)
448 if (threshold < OFPROTO_FLOW_EVICTION_THRESHOLD_MIN) {
449 ofproto->flow_eviction_threshold = OFPROTO_FLOW_EVICTION_THRESHOLD_MIN;
451 ofproto->flow_eviction_threshold = threshold;
455 /* If forward_bpdu is true, the NORMAL action will forward frames with
456 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
457 * the NORMAL action will drop these frames. */
459 ofproto_set_forward_bpdu(struct ofproto *ofproto, bool forward_bpdu)
461 bool old_val = ofproto->forward_bpdu;
462 ofproto->forward_bpdu = forward_bpdu;
463 if (old_val != ofproto->forward_bpdu) {
464 if (ofproto->ofproto_class->forward_bpdu_changed) {
465 ofproto->ofproto_class->forward_bpdu_changed(ofproto);
471 ofproto_set_desc(struct ofproto *p,
472 const char *mfr_desc, const char *hw_desc,
473 const char *sw_desc, const char *serial_desc,
476 struct ofp_desc_stats *ods;
479 if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
480 VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
481 sizeof ods->mfr_desc);
484 p->mfr_desc = xstrdup(mfr_desc);
487 if (strlen(hw_desc) >= sizeof ods->hw_desc) {
488 VLOG_WARN("truncating hw_desc, must be less than %zu characters",
489 sizeof ods->hw_desc);
492 p->hw_desc = xstrdup(hw_desc);
495 if (strlen(sw_desc) >= sizeof ods->sw_desc) {
496 VLOG_WARN("truncating sw_desc, must be less than %zu characters",
497 sizeof ods->sw_desc);
500 p->sw_desc = xstrdup(sw_desc);
503 if (strlen(serial_desc) >= sizeof ods->serial_num) {
504 VLOG_WARN("truncating serial_desc, must be less than %zu "
506 sizeof ods->serial_num);
508 free(p->serial_desc);
509 p->serial_desc = xstrdup(serial_desc);
512 if (strlen(dp_desc) >= sizeof ods->dp_desc) {
513 VLOG_WARN("truncating dp_desc, must be less than %zu characters",
514 sizeof ods->dp_desc);
517 p->dp_desc = xstrdup(dp_desc);
522 ofproto_set_snoops(struct ofproto *ofproto, const struct sset *snoops)
524 return connmgr_set_snoops(ofproto->connmgr, snoops);
528 ofproto_set_netflow(struct ofproto *ofproto,
529 const struct netflow_options *nf_options)
531 if (nf_options && sset_is_empty(&nf_options->collectors)) {
535 if (ofproto->ofproto_class->set_netflow) {
536 return ofproto->ofproto_class->set_netflow(ofproto, nf_options);
538 return nf_options ? EOPNOTSUPP : 0;
543 ofproto_set_sflow(struct ofproto *ofproto,
544 const struct ofproto_sflow_options *oso)
546 if (oso && sset_is_empty(&oso->targets)) {
550 if (ofproto->ofproto_class->set_sflow) {
551 return ofproto->ofproto_class->set_sflow(ofproto, oso);
553 return oso ? EOPNOTSUPP : 0;
557 /* Spanning Tree Protocol (STP) configuration. */
559 /* Configures STP on 'ofproto' using the settings defined in 's'. If
560 * 's' is NULL, disables STP.
562 * Returns 0 if successful, otherwise a positive errno value. */
564 ofproto_set_stp(struct ofproto *ofproto,
565 const struct ofproto_stp_settings *s)
567 return (ofproto->ofproto_class->set_stp
568 ? ofproto->ofproto_class->set_stp(ofproto, s)
572 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
573 * 'enabled' member of 's' is false, then the other members are not
576 * Returns 0 if successful, otherwise a positive errno value. */
578 ofproto_get_stp_status(struct ofproto *ofproto,
579 struct ofproto_stp_status *s)
581 return (ofproto->ofproto_class->get_stp_status
582 ? ofproto->ofproto_class->get_stp_status(ofproto, s)
586 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
587 * in 's'. The caller is responsible for assigning STP port numbers
588 * (using the 'port_num' member in the range of 1 through 255, inclusive)
589 * and ensuring there are no duplicates. If the 's' is NULL, then STP
590 * is disabled on the port.
592 * Returns 0 if successful, otherwise a positive errno value.*/
594 ofproto_port_set_stp(struct ofproto *ofproto, uint16_t ofp_port,
595 const struct ofproto_port_stp_settings *s)
597 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
599 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16,
600 ofproto->name, ofp_port);
604 return (ofproto->ofproto_class->set_stp_port
605 ? ofproto->ofproto_class->set_stp_port(ofport, s)
609 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
610 * 's'. If the 'enabled' member in 's' is false, then the other members
611 * are not meaningful.
613 * Returns 0 if successful, otherwise a positive errno value.*/
615 ofproto_port_get_stp_status(struct ofproto *ofproto, uint16_t ofp_port,
616 struct ofproto_port_stp_status *s)
618 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
620 VLOG_WARN("%s: cannot get STP status on nonexistent port %"PRIu16,
621 ofproto->name, ofp_port);
625 return (ofproto->ofproto_class->get_stp_port_status
626 ? ofproto->ofproto_class->get_stp_port_status(ofport, s)
630 /* Queue DSCP configuration. */
632 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
633 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
634 * to implement QoS. Instead, it is used to implement features which require
635 * knowledge of what queues exist on a port, and some basic information about
638 * Returns 0 if successful, otherwise a positive errno value. */
640 ofproto_port_set_queues(struct ofproto *ofproto, uint16_t ofp_port,
641 const struct ofproto_port_queue *queues,
644 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
647 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16,
648 ofproto->name, ofp_port);
652 return (ofproto->ofproto_class->set_queues
653 ? ofproto->ofproto_class->set_queues(ofport, queues, n_queues)
657 /* Connectivity Fault Management configuration. */
659 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
661 ofproto_port_clear_cfm(struct ofproto *ofproto, uint16_t ofp_port)
663 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
664 if (ofport && ofproto->ofproto_class->set_cfm) {
665 ofproto->ofproto_class->set_cfm(ofport, NULL);
669 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
670 * basic configuration from the configuration members in 'cfm', and the remote
671 * maintenance point ID from remote_mpid. Ignores the statistics members of
674 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
676 ofproto_port_set_cfm(struct ofproto *ofproto, uint16_t ofp_port,
677 const struct cfm_settings *s)
679 struct ofport *ofport;
682 ofport = ofproto_get_port(ofproto, ofp_port);
684 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16,
685 ofproto->name, ofp_port);
689 /* XXX: For configuration simplicity, we only support one remote_mpid
690 * outside of the CFM module. It's not clear if this is the correct long
691 * term solution or not. */
692 error = (ofproto->ofproto_class->set_cfm
693 ? ofproto->ofproto_class->set_cfm(ofport, s)
696 VLOG_WARN("%s: CFM configuration on port %"PRIu16" (%s) failed (%s)",
697 ofproto->name, ofp_port, netdev_get_name(ofport->netdev),
702 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
703 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
704 * 0 if LACP partner information is not current (generally indicating a
705 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
707 ofproto_port_is_lacp_current(struct ofproto *ofproto, uint16_t ofp_port)
709 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
710 return (ofport && ofproto->ofproto_class->port_is_lacp_current
711 ? ofproto->ofproto_class->port_is_lacp_current(ofport)
717 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
718 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
719 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
720 * configuration plus, if there is more than one slave, a bonding
723 * If 'aux' is already registered then this function updates its configuration
724 * to 's'. Otherwise, this function registers a new bundle.
726 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
729 ofproto_bundle_register(struct ofproto *ofproto, void *aux,
730 const struct ofproto_bundle_settings *s)
732 return (ofproto->ofproto_class->bundle_set
733 ? ofproto->ofproto_class->bundle_set(ofproto, aux, s)
737 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
738 * If no such bundle has been registered, this has no effect. */
740 ofproto_bundle_unregister(struct ofproto *ofproto, void *aux)
742 return ofproto_bundle_register(ofproto, aux, NULL);
746 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
747 * If 'aux' is already registered then this function updates its configuration
748 * to 's'. Otherwise, this function registers a new mirror. */
750 ofproto_mirror_register(struct ofproto *ofproto, void *aux,
751 const struct ofproto_mirror_settings *s)
753 return (ofproto->ofproto_class->mirror_set
754 ? ofproto->ofproto_class->mirror_set(ofproto, aux, s)
758 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
759 * If no mirror has been registered, this has no effect. */
761 ofproto_mirror_unregister(struct ofproto *ofproto, void *aux)
763 return ofproto_mirror_register(ofproto, aux, NULL);
766 /* Retrieves statistics from mirror associated with client data pointer
767 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
768 * 'bytes', respectively. If a particular counters is not supported,
769 * the appropriate argument is set to UINT64_MAX. */
771 ofproto_mirror_get_stats(struct ofproto *ofproto, void *aux,
772 uint64_t *packets, uint64_t *bytes)
774 if (!ofproto->ofproto_class->mirror_get_stats) {
775 *packets = *bytes = UINT64_MAX;
779 return ofproto->ofproto_class->mirror_get_stats(ofproto, aux,
783 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
784 * which all packets are flooded, instead of using MAC learning. If
785 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
787 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
790 ofproto_set_flood_vlans(struct ofproto *ofproto, unsigned long *flood_vlans)
792 return (ofproto->ofproto_class->set_flood_vlans
793 ? ofproto->ofproto_class->set_flood_vlans(ofproto, flood_vlans)
797 /* Returns true if 'aux' is a registered bundle that is currently in use as the
798 * output for a mirror. */
800 ofproto_is_mirror_output_bundle(const struct ofproto *ofproto, void *aux)
802 return (ofproto->ofproto_class->is_mirror_output_bundle
803 ? ofproto->ofproto_class->is_mirror_output_bundle(ofproto, aux)
808 ofproto_has_snoops(const struct ofproto *ofproto)
810 return connmgr_has_snoops(ofproto->connmgr);
814 ofproto_get_snoops(const struct ofproto *ofproto, struct sset *snoops)
816 connmgr_get_snoops(ofproto->connmgr, snoops);
820 ofproto_flush__(struct ofproto *ofproto)
822 struct ofopgroup *group;
823 struct oftable *table;
825 if (ofproto->ofproto_class->flush) {
826 ofproto->ofproto_class->flush(ofproto);
829 group = ofopgroup_create_unattached(ofproto);
830 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
831 struct rule *rule, *next_rule;
832 struct cls_cursor cursor;
834 if (table->flags & OFTABLE_HIDDEN) {
838 cls_cursor_init(&cursor, &table->cls, NULL);
839 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cr, &cursor) {
840 if (!rule->pending) {
841 ofoperation_create(group, rule, OFOPERATION_DELETE);
842 oftable_remove_rule(rule);
843 ofproto->ofproto_class->rule_destruct(rule);
847 ofopgroup_submit(group);
851 ofproto_destroy__(struct ofproto *ofproto)
853 struct oftable *table;
855 assert(list_is_empty(&ofproto->pending));
856 assert(!ofproto->n_pending);
858 connmgr_destroy(ofproto->connmgr);
860 hmap_remove(&all_ofprotos, &ofproto->hmap_node);
863 free(ofproto->mfr_desc);
864 free(ofproto->hw_desc);
865 free(ofproto->sw_desc);
866 free(ofproto->serial_desc);
867 free(ofproto->dp_desc);
868 hmap_destroy(&ofproto->ports);
869 shash_destroy(&ofproto->port_by_name);
871 OFPROTO_FOR_EACH_TABLE (table, ofproto) {
872 oftable_destroy(table);
874 free(ofproto->tables);
876 hmap_destroy(&ofproto->deletions);
878 free(ofproto->vlan_bitmap);
880 ofproto->ofproto_class->dealloc(ofproto);
884 ofproto_destroy(struct ofproto *p)
886 struct ofport *ofport, *next_ofport;
893 HMAP_FOR_EACH_SAFE (ofport, next_ofport, hmap_node, &p->ports) {
894 ofport_destroy(ofport);
897 p->ofproto_class->destruct(p);
898 ofproto_destroy__(p);
901 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
902 * kernel datapath, for example, this destroys the datapath in the kernel, and
903 * with the netdev-based datapath, it tears down the data structures that
904 * represent the datapath.
906 * The datapath should not be currently open as an ofproto. */
908 ofproto_delete(const char *name, const char *type)
910 const struct ofproto_class *class = ofproto_class_find__(type);
911 return (!class ? EAFNOSUPPORT
912 : !class->del ? EACCES
913 : class->del(type, name));
917 process_port_change(struct ofproto *ofproto, int error, char *devname)
919 if (error == ENOBUFS) {
920 reinit_ports(ofproto);
922 update_port(ofproto, devname);
928 ofproto_run(struct ofproto *p)
930 struct ofport *ofport;
934 error = p->ofproto_class->run(p);
935 if (error && error != EAGAIN) {
936 VLOG_ERR_RL(&rl, "%s: run failed (%s)", p->name, strerror(error));
939 if (p->ofproto_class->port_poll) {
940 while ((error = p->ofproto_class->port_poll(p, &devname)) != EAGAIN) {
941 process_port_change(p, error, devname);
945 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
946 unsigned int change_seq = netdev_change_seq(ofport->netdev);
947 if (ofport->change_seq != change_seq) {
948 ofport->change_seq = change_seq;
949 update_port(p, netdev_get_name(ofport->netdev));
956 connmgr_run(p->connmgr, handle_openflow);
960 connmgr_run(p->connmgr, NULL);
962 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
963 connmgr_flushed(p->connmgr);
964 p->state = S_OPENFLOW;
975 /* Performs periodic activity required by 'ofproto' that needs to be done
976 * with the least possible latency.
978 * It makes sense to call this function a couple of times per poll loop, to
979 * provide a significant performance boost on some benchmarks with the
980 * ofproto-dpif implementation. */
982 ofproto_run_fast(struct ofproto *p)
986 error = p->ofproto_class->run_fast ? p->ofproto_class->run_fast(p) : 0;
987 if (error && error != EAGAIN) {
988 VLOG_ERR_RL(&rl, "%s: fastpath run failed (%s)",
989 p->name, strerror(error));
995 ofproto_wait(struct ofproto *p)
997 struct ofport *ofport;
999 p->ofproto_class->wait(p);
1000 if (p->ofproto_class->port_poll_wait) {
1001 p->ofproto_class->port_poll_wait(p);
1004 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1005 if (ofport->change_seq != netdev_change_seq(ofport->netdev)) {
1006 poll_immediate_wake();
1012 connmgr_wait(p->connmgr, true);
1016 connmgr_wait(p->connmgr, false);
1017 if (list_is_empty(&p->pending) && hmap_is_empty(&p->deletions)) {
1018 poll_immediate_wake();
1025 ofproto_is_alive(const struct ofproto *p)
1027 return connmgr_has_controllers(p->connmgr);
1031 ofproto_get_ofproto_controller_info(const struct ofproto *ofproto,
1034 connmgr_get_controller_info(ofproto->connmgr, info);
1038 ofproto_free_ofproto_controller_info(struct shash *info)
1040 connmgr_free_controller_info(info);
1043 /* Makes a deep copy of 'old' into 'port'. */
1045 ofproto_port_clone(struct ofproto_port *port, const struct ofproto_port *old)
1047 port->name = xstrdup(old->name);
1048 port->type = xstrdup(old->type);
1049 port->ofp_port = old->ofp_port;
1052 /* Frees memory allocated to members of 'ofproto_port'.
1054 * Do not call this function on an ofproto_port obtained from
1055 * ofproto_port_dump_next(): that function retains ownership of the data in the
1058 ofproto_port_destroy(struct ofproto_port *ofproto_port)
1060 free(ofproto_port->name);
1061 free(ofproto_port->type);
1064 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1066 * This function provides no status indication. An error status for the entire
1067 * dump operation is provided when it is completed by calling
1068 * ofproto_port_dump_done().
1071 ofproto_port_dump_start(struct ofproto_port_dump *dump,
1072 const struct ofproto *ofproto)
1074 dump->ofproto = ofproto;
1075 dump->error = ofproto->ofproto_class->port_dump_start(ofproto,
1079 /* Attempts to retrieve another port from 'dump', which must have been created
1080 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1081 * 'port' and returns true. On failure, returns false.
1083 * Failure might indicate an actual error or merely that the last port has been
1084 * dumped. An error status for the entire dump operation is provided when it
1085 * is completed by calling ofproto_port_dump_done().
1087 * The ofproto owns the data stored in 'port'. It will remain valid until at
1088 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1089 * ofproto_port_dump_done(). */
1091 ofproto_port_dump_next(struct ofproto_port_dump *dump,
1092 struct ofproto_port *port)
1094 const struct ofproto *ofproto = dump->ofproto;
1100 dump->error = ofproto->ofproto_class->port_dump_next(ofproto, dump->state,
1103 ofproto->ofproto_class->port_dump_done(ofproto, dump->state);
1109 /* Completes port table dump operation 'dump', which must have been created
1110 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1111 * error-free, otherwise a positive errno value describing the problem. */
1113 ofproto_port_dump_done(struct ofproto_port_dump *dump)
1115 const struct ofproto *ofproto = dump->ofproto;
1117 dump->error = ofproto->ofproto_class->port_dump_done(ofproto,
1120 return dump->error == EOF ? 0 : dump->error;
1123 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
1124 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
1125 * is non-null). On failure, returns a positive errno value and sets
1126 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
1128 ofproto_port_add(struct ofproto *ofproto, struct netdev *netdev,
1129 uint16_t *ofp_portp)
1134 error = ofproto->ofproto_class->port_add(ofproto, netdev, &ofp_port);
1136 update_port(ofproto, netdev_get_name(netdev));
1139 *ofp_portp = error ? OFPP_NONE : ofp_port;
1144 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1145 * initializes '*port' appropriately; on failure, returns a positive errno
1148 * The caller owns the data in 'ofproto_port' and must free it with
1149 * ofproto_port_destroy() when it is no longer needed. */
1151 ofproto_port_query_by_name(const struct ofproto *ofproto, const char *devname,
1152 struct ofproto_port *port)
1156 error = ofproto->ofproto_class->port_query_by_name(ofproto, devname, port);
1158 memset(port, 0, sizeof *port);
1163 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1164 * Returns 0 if successful, otherwise a positive errno. */
1166 ofproto_port_del(struct ofproto *ofproto, uint16_t ofp_port)
1168 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
1169 const char *name = ofport ? netdev_get_name(ofport->netdev) : "<unknown>";
1172 error = ofproto->ofproto_class->port_del(ofproto, ofp_port);
1173 if (!error && ofport) {
1174 /* 'name' is the netdev's name and update_port() is going to close the
1175 * netdev. Just in case update_port() refers to 'name' after it
1176 * destroys 'ofport', make a copy of it around the update_port()
1178 char *devname = xstrdup(name);
1179 update_port(ofproto, devname);
1185 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1186 * performs the 'n_actions' actions in 'actions'. The new flow will not
1189 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1190 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1191 * controllers; otherwise, it will be hidden.
1193 * The caller retains ownership of 'cls_rule' and 'actions'.
1195 * This is a helper function for in-band control and fail-open. */
1197 ofproto_add_flow(struct ofproto *ofproto, const struct cls_rule *cls_rule,
1198 const union ofp_action *actions, size_t n_actions)
1200 const struct rule *rule;
1202 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1203 &ofproto->tables[0].cls, cls_rule));
1204 if (!rule || !ofputil_actions_equal(rule->actions, rule->n_actions,
1205 actions, n_actions)) {
1206 struct ofputil_flow_mod fm;
1208 memset(&fm, 0, sizeof fm);
1210 fm.buffer_id = UINT32_MAX;
1211 fm.actions = (union ofp_action *) actions;
1212 fm.n_actions = n_actions;
1213 add_flow(ofproto, NULL, &fm, NULL);
1217 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1218 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1219 * operation cannot be initiated now but may be retried later.
1221 * This is a helper function for in-band control and fail-open. */
1223 ofproto_flow_mod(struct ofproto *ofproto, const struct ofputil_flow_mod *fm)
1225 return handle_flow_mod__(ofproto, NULL, fm, NULL);
1228 /* Searches for a rule with matching criteria exactly equal to 'target' in
1229 * ofproto's table 0 and, if it finds one, deletes it.
1231 * This is a helper function for in-band control and fail-open. */
1233 ofproto_delete_flow(struct ofproto *ofproto, const struct cls_rule *target)
1237 rule = rule_from_cls_rule(classifier_find_rule_exactly(
1238 &ofproto->tables[0].cls, target));
1240 /* No such rule -> success. */
1242 } else if (rule->pending) {
1243 /* An operation on the rule is already pending -> failure.
1244 * Caller must retry later if it's important. */
1247 /* Initiate deletion -> success. */
1248 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
1249 ofoperation_create(group, rule, OFOPERATION_DELETE);
1250 oftable_remove_rule(rule);
1251 rule->ofproto->ofproto_class->rule_destruct(rule);
1252 ofopgroup_submit(group);
1258 /* Starts the process of deleting all of the flows from all of ofproto's flow
1259 * tables and then reintroducing the flows required by in-band control and
1260 * fail-open. The process will complete in a later call to ofproto_run(). */
1262 ofproto_flush_flows(struct ofproto *ofproto)
1264 COVERAGE_INC(ofproto_flush);
1265 ofproto->state = S_FLUSH;
1269 reinit_ports(struct ofproto *p)
1271 struct ofproto_port_dump dump;
1272 struct sset devnames;
1273 struct ofport *ofport;
1274 struct ofproto_port ofproto_port;
1275 const char *devname;
1277 COVERAGE_INC(ofproto_reinit_ports);
1279 sset_init(&devnames);
1280 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1281 sset_add(&devnames, netdev_get_name(ofport->netdev));
1283 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1284 sset_add(&devnames, ofproto_port.name);
1287 SSET_FOR_EACH (devname, &devnames) {
1288 update_port(p, devname);
1290 sset_destroy(&devnames);
1293 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
1294 * netdev cannot be opened. On success, also fills in 'opp'. */
1295 static struct netdev *
1296 ofport_open(const struct ofproto_port *ofproto_port, struct ofp_phy_port *opp)
1298 uint32_t curr, advertised, supported, peer;
1299 enum netdev_flags flags;
1300 struct netdev *netdev;
1303 error = netdev_open(ofproto_port->name, ofproto_port->type, &netdev);
1305 VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1306 "cannot be opened (%s)",
1307 ofproto_port->name, ofproto_port->ofp_port,
1308 ofproto_port->name, strerror(error));
1312 netdev_get_flags(netdev, &flags);
1313 netdev_get_features(netdev, &curr, &advertised, &supported, &peer);
1315 opp->port_no = htons(ofproto_port->ofp_port);
1316 netdev_get_etheraddr(netdev, opp->hw_addr);
1317 ovs_strzcpy(opp->name, ofproto_port->name, sizeof opp->name);
1318 opp->config = flags & NETDEV_UP ? 0 : htonl(OFPPC_PORT_DOWN);
1319 opp->state = netdev_get_carrier(netdev) ? 0 : htonl(OFPPS_LINK_DOWN);
1320 opp->curr = htonl(curr);
1321 opp->advertised = htonl(advertised);
1322 opp->supported = htonl(supported);
1323 opp->peer = htonl(peer);
1328 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1329 * port number, and 'config' bits other than OFPPC_PORT_DOWN are
1332 ofport_equal(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
1334 BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1335 return (!memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1336 && a->state == b->state
1337 && !((a->config ^ b->config) & htonl(OFPPC_PORT_DOWN))
1338 && a->curr == b->curr
1339 && a->advertised == b->advertised
1340 && a->supported == b->supported
1341 && a->peer == b->peer);
1344 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1345 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1346 * one with the same name or port number). */
1348 ofport_install(struct ofproto *p,
1349 struct netdev *netdev, const struct ofp_phy_port *opp)
1351 const char *netdev_name = netdev_get_name(netdev);
1352 struct ofport *ofport;
1356 /* Create ofport. */
1357 ofport = p->ofproto_class->port_alloc();
1362 ofport->ofproto = p;
1363 ofport->netdev = netdev;
1364 ofport->change_seq = netdev_change_seq(netdev);
1366 ofport->ofp_port = ntohs(opp->port_no);
1368 /* Add port to 'p'. */
1369 hmap_insert(&p->ports, &ofport->hmap_node, hash_int(ofport->ofp_port, 0));
1370 shash_add(&p->port_by_name, netdev_name, ofport);
1372 if (!netdev_get_mtu(netdev, &dev_mtu)) {
1373 set_internal_devs_mtu(p);
1374 ofport->mtu = dev_mtu;
1379 /* Let the ofproto_class initialize its private data. */
1380 error = p->ofproto_class->port_construct(ofport);
1384 connmgr_send_port_status(p->connmgr, opp, OFPPR_ADD);
1388 VLOG_WARN_RL(&rl, "%s: could not add port %s (%s)",
1389 p->name, netdev_name, strerror(error));
1391 ofport_destroy__(ofport);
1393 netdev_close(netdev);
1397 /* Removes 'ofport' from 'p' and destroys it. */
1399 ofport_remove(struct ofport *ofport)
1401 connmgr_send_port_status(ofport->ofproto->connmgr, &ofport->opp,
1403 ofport_destroy(ofport);
1406 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1409 ofport_remove_with_name(struct ofproto *ofproto, const char *name)
1411 struct ofport *port = shash_find_data(&ofproto->port_by_name, name);
1413 ofport_remove(port);
1417 /* Updates 'port' with new 'opp' description.
1419 * Does not handle a name or port number change. The caller must implement
1420 * such a change as a delete followed by an add. */
1422 ofport_modified(struct ofport *port, struct ofp_phy_port *opp)
1424 memcpy(port->opp.hw_addr, opp->hw_addr, ETH_ADDR_LEN);
1425 port->opp.config = ((port->opp.config & ~htonl(OFPPC_PORT_DOWN))
1426 | (opp->config & htonl(OFPPC_PORT_DOWN)));
1427 port->opp.state = opp->state;
1428 port->opp.curr = opp->curr;
1429 port->opp.advertised = opp->advertised;
1430 port->opp.supported = opp->supported;
1431 port->opp.peer = opp->peer;
1433 connmgr_send_port_status(port->ofproto->connmgr, &port->opp, OFPPR_MODIFY);
1436 /* Update OpenFlow 'state' in 'port' and notify controller. */
1438 ofproto_port_set_state(struct ofport *port, ovs_be32 state)
1440 if (port->opp.state != state) {
1441 port->opp.state = state;
1442 connmgr_send_port_status(port->ofproto->connmgr, &port->opp,
1448 ofproto_port_unregister(struct ofproto *ofproto, uint16_t ofp_port)
1450 struct ofport *port = ofproto_get_port(ofproto, ofp_port);
1452 if (port->ofproto->ofproto_class->set_realdev) {
1453 port->ofproto->ofproto_class->set_realdev(port, 0, 0);
1455 if (port->ofproto->ofproto_class->set_stp_port) {
1456 port->ofproto->ofproto_class->set_stp_port(port, NULL);
1458 if (port->ofproto->ofproto_class->set_cfm) {
1459 port->ofproto->ofproto_class->set_cfm(port, NULL);
1461 if (port->ofproto->ofproto_class->bundle_remove) {
1462 port->ofproto->ofproto_class->bundle_remove(port);
1468 ofport_destroy__(struct ofport *port)
1470 struct ofproto *ofproto = port->ofproto;
1471 const char *name = netdev_get_name(port->netdev);
1473 hmap_remove(&ofproto->ports, &port->hmap_node);
1474 shash_delete(&ofproto->port_by_name,
1475 shash_find(&ofproto->port_by_name, name));
1477 netdev_close(port->netdev);
1478 ofproto->ofproto_class->port_dealloc(port);
1482 ofport_destroy(struct ofport *port)
1485 port->ofproto->ofproto_class->port_destruct(port);
1486 ofport_destroy__(port);
1491 ofproto_get_port(const struct ofproto *ofproto, uint16_t ofp_port)
1493 struct ofport *port;
1495 HMAP_FOR_EACH_IN_BUCKET (port, hmap_node,
1496 hash_int(ofp_port, 0), &ofproto->ports) {
1497 if (port->ofp_port == ofp_port) {
1505 ofproto_port_get_stats(const struct ofport *port, struct netdev_stats *stats)
1507 struct ofproto *ofproto = port->ofproto;
1510 if (ofproto->ofproto_class->port_get_stats) {
1511 error = ofproto->ofproto_class->port_get_stats(port, stats);
1520 update_port(struct ofproto *ofproto, const char *name)
1522 struct ofproto_port ofproto_port;
1523 struct ofp_phy_port opp;
1524 struct netdev *netdev;
1525 struct ofport *port;
1527 COVERAGE_INC(ofproto_update_port);
1529 /* Fetch 'name''s location and properties from the datapath. */
1530 netdev = (!ofproto_port_query_by_name(ofproto, name, &ofproto_port)
1531 ? ofport_open(&ofproto_port, &opp)
1534 port = ofproto_get_port(ofproto, ofproto_port.ofp_port);
1535 if (port && !strcmp(netdev_get_name(port->netdev), name)) {
1536 struct netdev *old_netdev = port->netdev;
1539 /* 'name' hasn't changed location. Any properties changed? */
1540 if (!ofport_equal(&port->opp, &opp)) {
1541 ofport_modified(port, &opp);
1544 /* If this is a non-internal port and the MTU changed, check
1545 * if the datapath's MTU needs to be updated. */
1546 if (strcmp(netdev_get_type(netdev), "internal")
1547 && !netdev_get_mtu(netdev, &dev_mtu)
1548 && port->mtu != dev_mtu) {
1549 set_internal_devs_mtu(ofproto);
1550 port->mtu = dev_mtu;
1553 /* Install the newly opened netdev in case it has changed.
1554 * Don't close the old netdev yet in case port_modified has to
1555 * remove a retained reference to it.*/
1556 port->netdev = netdev;
1557 port->change_seq = netdev_change_seq(netdev);
1559 if (port->ofproto->ofproto_class->port_modified) {
1560 port->ofproto->ofproto_class->port_modified(port);
1563 netdev_close(old_netdev);
1565 /* If 'port' is nonnull then its name differs from 'name' and thus
1566 * we should delete it. If we think there's a port named 'name'
1567 * then its port number must be wrong now so delete it too. */
1569 ofport_remove(port);
1571 ofport_remove_with_name(ofproto, name);
1572 ofport_install(ofproto, netdev, &opp);
1575 /* Any port named 'name' is gone now. */
1576 ofport_remove_with_name(ofproto, name);
1578 ofproto_port_destroy(&ofproto_port);
1582 init_ports(struct ofproto *p)
1584 struct ofproto_port_dump dump;
1585 struct ofproto_port ofproto_port;
1587 OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, p) {
1588 uint16_t ofp_port = ofproto_port.ofp_port;
1589 if (ofproto_get_port(p, ofp_port)) {
1590 VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1592 } else if (shash_find(&p->port_by_name, ofproto_port.name)) {
1593 VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1596 struct ofp_phy_port opp;
1597 struct netdev *netdev;
1599 netdev = ofport_open(&ofproto_port, &opp);
1601 ofport_install(p, netdev, &opp);
1609 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1610 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1612 find_min_mtu(struct ofproto *p)
1614 struct ofport *ofport;
1617 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1618 struct netdev *netdev = ofport->netdev;
1621 /* Skip any internal ports, since that's what we're trying to
1623 if (!strcmp(netdev_get_type(netdev), "internal")) {
1627 if (netdev_get_mtu(netdev, &dev_mtu)) {
1630 if (!mtu || dev_mtu < mtu) {
1635 return mtu ? mtu: ETH_PAYLOAD_MAX;
1638 /* Set the MTU of all datapath devices on 'p' to the minimum of the
1639 * non-datapath ports. */
1641 set_internal_devs_mtu(struct ofproto *p)
1643 struct ofport *ofport;
1644 int mtu = find_min_mtu(p);
1646 HMAP_FOR_EACH (ofport, hmap_node, &p->ports) {
1647 struct netdev *netdev = ofport->netdev;
1649 if (!strcmp(netdev_get_type(netdev), "internal")) {
1650 netdev_set_mtu(netdev, mtu);
1656 ofproto_rule_destroy__(struct rule *rule)
1658 free(rule->actions);
1659 rule->ofproto->ofproto_class->rule_dealloc(rule);
1662 /* This function allows an ofproto implementation to destroy any rules that
1663 * remain when its ->destruct() function is called. The caller must have
1664 * already uninitialized any derived members of 'rule' (step 5 described in the
1665 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1666 * This function implements steps 6 and 7.
1668 * This function should only be called from an ofproto implementation's
1669 * ->destruct() function. It is not suitable elsewhere. */
1671 ofproto_rule_destroy(struct rule *rule)
1673 assert(!rule->pending);
1674 oftable_remove_rule(rule);
1675 ofproto_rule_destroy__(rule);
1678 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1679 * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1682 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1684 const union ofp_action *oa;
1687 if (out_port == OFPP_NONE) {
1690 OFPUTIL_ACTION_FOR_EACH_UNSAFE (oa, left, rule->actions, rule->n_actions) {
1691 if (action_outputs_to_port(oa, htons(out_port))) {
1698 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1699 * statistics appropriately. 'packet' must have at least sizeof(struct
1700 * ofp_packet_in) bytes of headroom.
1702 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1703 * with statistics for 'packet' either way.
1705 * Takes ownership of 'packet'. */
1707 rule_execute(struct rule *rule, uint16_t in_port, struct ofpbuf *packet)
1711 assert(ofpbuf_headroom(packet) >= sizeof(struct ofp_packet_in));
1713 flow_extract(packet, 0, 0, in_port, &flow);
1714 return rule->ofproto->ofproto_class->rule_execute(rule, &flow, packet);
1717 /* Returns true if 'rule' should be hidden from the controller.
1719 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1720 * (e.g. by in-band control) and are intentionally hidden from the
1723 rule_is_hidden(const struct rule *rule)
1725 return rule->cr.priority > UINT16_MAX;
1728 static enum oftable_flags
1729 rule_get_flags(const struct rule *rule)
1731 return rule->ofproto->tables[rule->table_id].flags;
1735 rule_is_modifiable(const struct rule *rule)
1737 return !(rule_get_flags(rule) & OFTABLE_READONLY);
1741 handle_echo_request(struct ofconn *ofconn, const struct ofp_header *oh)
1743 ofconn_send_reply(ofconn, make_echo_reply(oh));
1748 handle_features_request(struct ofconn *ofconn, const struct ofp_header *oh)
1750 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1751 struct ofp_switch_features *osf;
1753 struct ofport *port;
1757 ofproto->ofproto_class->get_features(ofproto, &arp_match_ip, &actions);
1758 assert(actions & (1 << OFPAT_OUTPUT)); /* sanity check */
1760 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1761 osf->datapath_id = htonll(ofproto->datapath_id);
1762 osf->n_buffers = htonl(pktbuf_capacity());
1763 osf->n_tables = ofproto->n_tables;
1764 osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1765 OFPC_PORT_STATS | OFPC_QUEUE_STATS);
1767 osf->capabilities |= htonl(OFPC_ARP_MATCH_IP);
1769 osf->actions = htonl(actions);
1771 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
1772 ofpbuf_put(buf, &port->opp, sizeof port->opp);
1775 ofconn_send_reply(ofconn, buf);
1780 handle_get_config_request(struct ofconn *ofconn, const struct ofp_header *oh)
1782 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1783 struct ofp_switch_config *osc;
1784 enum ofp_config_flags flags;
1788 osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1789 flags = ofproto->frag_handling;
1790 if (ofconn_get_invalid_ttl_to_controller(ofconn)) {
1791 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1793 osc->flags = htons(flags);
1794 osc->miss_send_len = htons(ofconn_get_miss_send_len(ofconn));
1795 ofconn_send_reply(ofconn, buf);
1801 handle_set_config(struct ofconn *ofconn, const struct ofp_switch_config *osc)
1803 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
1804 uint16_t flags = ntohs(osc->flags);
1806 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY
1807 || ofconn_get_role(ofconn) != NX_ROLE_SLAVE) {
1808 enum ofp_config_flags cur = ofproto->frag_handling;
1809 enum ofp_config_flags next = flags & OFPC_FRAG_MASK;
1811 assert((cur & OFPC_FRAG_MASK) == cur);
1813 if (ofproto->ofproto_class->set_frag_handling(ofproto, next)) {
1814 ofproto->frag_handling = next;
1816 VLOG_WARN_RL(&rl, "%s: unsupported fragment handling mode %s",
1818 ofputil_frag_handling_to_string(next));
1822 ofconn_set_invalid_ttl_to_controller(ofconn,
1823 (flags & OFPC_INVALID_TTL_TO_CONTROLLER));
1825 ofconn_set_miss_send_len(ofconn, ntohs(osc->miss_send_len));
1830 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1831 * error message code for the caller to propagate upward. Otherwise, returns
1834 * The log message mentions 'msg_type'. */
1836 reject_slave_controller(struct ofconn *ofconn)
1838 if (ofconn_get_type(ofconn) == OFCONN_PRIMARY
1839 && ofconn_get_role(ofconn) == NX_ROLE_SLAVE) {
1840 return OFPERR_OFPBRC_EPERM;
1847 handle_packet_out(struct ofconn *ofconn, const struct ofp_header *oh)
1849 struct ofproto *p = ofconn_get_ofproto(ofconn);
1850 struct ofp_packet_out *opo;
1851 struct ofpbuf payload, *buffer;
1852 union ofp_action *ofp_actions;
1853 struct ofpbuf request;
1855 size_t n_ofp_actions;
1859 COVERAGE_INC(ofproto_packet_out);
1861 error = reject_slave_controller(ofconn);
1866 /* Get ofp_packet_out. */
1867 ofpbuf_use_const(&request, oh, ntohs(oh->length));
1868 opo = ofpbuf_pull(&request, offsetof(struct ofp_packet_out, actions));
1871 error = ofputil_pull_actions(&request, ntohs(opo->actions_len),
1872 &ofp_actions, &n_ofp_actions);
1878 if (opo->buffer_id != htonl(UINT32_MAX)) {
1879 error = ofconn_pktbuf_retrieve(ofconn, ntohl(opo->buffer_id),
1881 if (error || !buffer) {
1890 /* Get in_port and partially validate it.
1892 * We don't know what range of ports the ofproto actually implements, but
1893 * we do know that only certain reserved ports (numbered OFPP_MAX and
1894 * above) are valid. */
1895 in_port = ntohs(opo->in_port);
1896 if (in_port >= OFPP_MAX && in_port != OFPP_LOCAL && in_port != OFPP_NONE) {
1897 return OFPERR_NXBRC_BAD_IN_PORT;
1900 /* Send out packet. */
1901 flow_extract(&payload, 0, 0, in_port, &flow);
1902 error = p->ofproto_class->packet_out(p, &payload, &flow,
1903 ofp_actions, n_ofp_actions);
1904 ofpbuf_delete(buffer);
1910 update_port_config(struct ofport *port, ovs_be32 config, ovs_be32 mask)
1912 ovs_be32 old_config = port->opp.config;
1914 mask &= config ^ port->opp.config;
1915 if (mask & htonl(OFPPC_PORT_DOWN)) {
1916 if (config & htonl(OFPPC_PORT_DOWN)) {
1917 netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1919 netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1923 port->opp.config ^= mask & (htonl(OFPPC_NO_RECV | OFPPC_NO_RECV_STP |
1924 OFPPC_NO_FLOOD | OFPPC_NO_FWD |
1925 OFPPC_NO_PACKET_IN));
1926 if (port->opp.config != old_config) {
1927 port->ofproto->ofproto_class->port_reconfigured(port, old_config);
1932 handle_port_mod(struct ofconn *ofconn, const struct ofp_header *oh)
1934 struct ofproto *p = ofconn_get_ofproto(ofconn);
1935 const struct ofp_port_mod *opm = (const struct ofp_port_mod *) oh;
1936 struct ofport *port;
1939 error = reject_slave_controller(ofconn);
1944 port = ofproto_get_port(p, ntohs(opm->port_no));
1946 return OFPERR_OFPPMFC_BAD_PORT;
1947 } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
1948 return OFPERR_OFPPMFC_BAD_HW_ADDR;
1950 update_port_config(port, opm->config, opm->mask);
1951 if (opm->advertise) {
1952 netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
1959 handle_desc_stats_request(struct ofconn *ofconn,
1960 const struct ofp_stats_msg *request)
1962 struct ofproto *p = ofconn_get_ofproto(ofconn);
1963 struct ofp_desc_stats *ods;
1966 ods = ofputil_make_stats_reply(sizeof *ods, request, &msg);
1967 ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
1968 ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
1969 ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
1970 ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
1971 ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
1972 ofconn_send_reply(ofconn, msg);
1978 handle_table_stats_request(struct ofconn *ofconn,
1979 const struct ofp_stats_msg *request)
1981 struct ofproto *p = ofconn_get_ofproto(ofconn);
1982 struct ofp_table_stats *ots;
1986 ofputil_make_stats_reply(sizeof(struct ofp_stats_msg), request, &msg);
1988 ots = ofpbuf_put_zeros(msg, sizeof *ots * p->n_tables);
1989 for (i = 0; i < p->n_tables; i++) {
1990 ots[i].table_id = i;
1991 sprintf(ots[i].name, "table%zu", i);
1992 ots[i].wildcards = htonl(OFPFW_ALL);
1993 ots[i].max_entries = htonl(1000000); /* An arbitrary big number. */
1994 ots[i].active_count = htonl(classifier_count(&p->tables[i].cls));
1997 p->ofproto_class->get_tables(p, ots);
1999 ofconn_send_reply(ofconn, msg);
2004 append_port_stat(struct ofport *port, struct list *replies)
2006 struct netdev_stats stats;
2007 struct ofp_port_stats *ops;
2009 /* Intentionally ignore return value, since errors will set
2010 * 'stats' to all-1s, which is correct for OpenFlow, and
2011 * netdev_get_stats() will log errors. */
2012 ofproto_port_get_stats(port, &stats);
2014 ops = ofputil_append_stats_reply(sizeof *ops, replies);
2015 ops->port_no = port->opp.port_no;
2016 memset(ops->pad, 0, sizeof ops->pad);
2017 put_32aligned_be64(&ops->rx_packets, htonll(stats.rx_packets));
2018 put_32aligned_be64(&ops->tx_packets, htonll(stats.tx_packets));
2019 put_32aligned_be64(&ops->rx_bytes, htonll(stats.rx_bytes));
2020 put_32aligned_be64(&ops->tx_bytes, htonll(stats.tx_bytes));
2021 put_32aligned_be64(&ops->rx_dropped, htonll(stats.rx_dropped));
2022 put_32aligned_be64(&ops->tx_dropped, htonll(stats.tx_dropped));
2023 put_32aligned_be64(&ops->rx_errors, htonll(stats.rx_errors));
2024 put_32aligned_be64(&ops->tx_errors, htonll(stats.tx_errors));
2025 put_32aligned_be64(&ops->rx_frame_err, htonll(stats.rx_frame_errors));
2026 put_32aligned_be64(&ops->rx_over_err, htonll(stats.rx_over_errors));
2027 put_32aligned_be64(&ops->rx_crc_err, htonll(stats.rx_crc_errors));
2028 put_32aligned_be64(&ops->collisions, htonll(stats.collisions));
2032 handle_port_stats_request(struct ofconn *ofconn,
2033 const struct ofp_port_stats_request *psr)
2035 struct ofproto *p = ofconn_get_ofproto(ofconn);
2036 struct ofport *port;
2037 struct list replies;
2039 ofputil_start_stats_reply(&psr->osm, &replies);
2040 if (psr->port_no != htons(OFPP_NONE)) {
2041 port = ofproto_get_port(p, ntohs(psr->port_no));
2043 append_port_stat(port, &replies);
2046 HMAP_FOR_EACH (port, hmap_node, &p->ports) {
2047 append_port_stat(port, &replies);
2051 ofconn_send_replies(ofconn, &replies);
2056 calc_flow_duration__(long long int start, uint32_t *sec, uint32_t *nsec)
2058 long long int msecs = time_msec() - start;
2059 *sec = msecs / 1000;
2060 *nsec = (msecs % 1000) * (1000 * 1000);
2063 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2064 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2066 check_table_id(const struct ofproto *ofproto, uint8_t table_id)
2068 return (table_id == 0xff || table_id < ofproto->n_tables
2070 : OFPERR_NXBRC_BAD_TABLE_ID);
2074 static struct oftable *
2075 next_visible_table(struct ofproto *ofproto, uint8_t table_id)
2077 struct oftable *table;
2079 for (table = &ofproto->tables[table_id];
2080 table < &ofproto->tables[ofproto->n_tables];
2082 if (!(table->flags & OFTABLE_HIDDEN)) {
2090 static struct oftable *
2091 first_matching_table(struct ofproto *ofproto, uint8_t table_id)
2093 if (table_id == 0xff) {
2094 return next_visible_table(ofproto, 0);
2095 } else if (table_id < ofproto->n_tables) {
2096 return &ofproto->tables[table_id];
2102 static struct oftable *
2103 next_matching_table(struct ofproto *ofproto,
2104 struct oftable *table, uint8_t table_id)
2106 return (table_id == 0xff
2107 ? next_visible_table(ofproto, (table - ofproto->tables) + 1)
2111 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2113 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2114 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2116 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2117 * only once, for that table. (This can be used to access tables marked
2120 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2121 * entered at all. (Perhaps you should have validated TABLE_ID with
2122 * check_table_id().)
2124 * All parameters are evaluated multiple times.
2126 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2127 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2129 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2131 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2132 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2133 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2136 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2137 * to 'out_port' are included.
2139 * Hidden rules are always omitted.
2141 * Returns 0 on success, otherwise an OpenFlow error code. */
2143 collect_rules_loose(struct ofproto *ofproto, uint8_t table_id,
2144 const struct cls_rule *match,
2145 ovs_be64 cookie, ovs_be64 cookie_mask,
2146 uint16_t out_port, struct list *rules)
2148 struct oftable *table;
2151 error = check_table_id(ofproto, table_id);
2157 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2158 struct cls_cursor cursor;
2161 cls_cursor_init(&cursor, &table->cls, match);
2162 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2163 if (rule->pending) {
2164 return OFPROTO_POSTPONE;
2166 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2167 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2168 list_push_back(rules, &rule->ofproto_node);
2175 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2176 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2177 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2180 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2181 * to 'out_port' are included.
2183 * Hidden rules are always omitted.
2185 * Returns 0 on success, otherwise an OpenFlow error code. */
2187 collect_rules_strict(struct ofproto *ofproto, uint8_t table_id,
2188 const struct cls_rule *match,
2189 ovs_be64 cookie, ovs_be64 cookie_mask,
2190 uint16_t out_port, struct list *rules)
2192 struct oftable *table;
2195 error = check_table_id(ofproto, table_id);
2201 FOR_EACH_MATCHING_TABLE (table, table_id, ofproto) {
2204 rule = rule_from_cls_rule(classifier_find_rule_exactly(&table->cls,
2207 if (rule->pending) {
2208 return OFPROTO_POSTPONE;
2210 if (!rule_is_hidden(rule) && rule_has_out_port(rule, out_port)
2211 && !((rule->flow_cookie ^ cookie) & cookie_mask)) {
2212 list_push_back(rules, &rule->ofproto_node);
2220 handle_flow_stats_request(struct ofconn *ofconn,
2221 const struct ofp_stats_msg *osm)
2223 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2224 struct ofputil_flow_stats_request fsr;
2225 struct list replies;
2230 error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
2235 error = collect_rules_loose(ofproto, fsr.table_id, &fsr.match,
2236 fsr.cookie, fsr.cookie_mask,
2237 fsr.out_port, &rules);
2242 ofputil_start_stats_reply(osm, &replies);
2243 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2244 struct ofputil_flow_stats fs;
2247 fs.cookie = rule->flow_cookie;
2248 fs.table_id = rule->table_id;
2249 calc_flow_duration__(rule->created, &fs.duration_sec,
2251 fs.idle_timeout = rule->idle_timeout;
2252 fs.hard_timeout = rule->hard_timeout;
2253 ofproto->ofproto_class->rule_get_stats(rule, &fs.packet_count,
2255 fs.actions = rule->actions;
2256 fs.n_actions = rule->n_actions;
2257 ofputil_append_flow_stats_reply(&fs, &replies);
2259 ofconn_send_replies(ofconn, &replies);
2265 flow_stats_ds(struct rule *rule, struct ds *results)
2267 uint64_t packet_count, byte_count;
2269 rule->ofproto->ofproto_class->rule_get_stats(rule,
2270 &packet_count, &byte_count);
2272 if (rule->table_id != 0) {
2273 ds_put_format(results, "table_id=%"PRIu8", ", rule->table_id);
2275 ds_put_format(results, "duration=%llds, ",
2276 (time_msec() - rule->created) / 1000);
2277 ds_put_format(results, "priority=%u, ", rule->cr.priority);
2278 ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2279 ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2280 cls_rule_format(&rule->cr, results);
2281 ds_put_char(results, ',');
2282 if (rule->n_actions > 0) {
2283 ofp_print_actions(results, rule->actions, rule->n_actions);
2285 ds_put_cstr(results, "drop");
2287 ds_put_cstr(results, "\n");
2290 /* Adds a pretty-printed description of all flows to 'results', including
2291 * hidden flows (e.g., set up by in-band control). */
2293 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2295 struct oftable *table;
2297 OFPROTO_FOR_EACH_TABLE (table, p) {
2298 struct cls_cursor cursor;
2301 cls_cursor_init(&cursor, &table->cls, NULL);
2302 CLS_CURSOR_FOR_EACH (rule, cr, &cursor) {
2303 flow_stats_ds(rule, results);
2308 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2309 * '*engine_type' and '*engine_id', respectively. */
2311 ofproto_get_netflow_ids(const struct ofproto *ofproto,
2312 uint8_t *engine_type, uint8_t *engine_id)
2314 ofproto->ofproto_class->get_netflow_ids(ofproto, engine_type, engine_id);
2317 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns 1
2318 * if CFM is faulted (generally indiciating a connectivity problem), 0 if CFM
2319 * is not faulted, and -1 if CFM is not enabled on 'ofp_port'. */
2321 ofproto_port_get_cfm_fault(const struct ofproto *ofproto, uint16_t ofp_port)
2323 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2324 return (ofport && ofproto->ofproto_class->get_cfm_fault
2325 ? ofproto->ofproto_class->get_cfm_fault(ofport)
2329 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2330 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2331 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2332 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2334 ofproto_port_get_cfm_remote_mpids(const struct ofproto *ofproto,
2335 uint16_t ofp_port, const uint64_t **rmps,
2338 struct ofport *ofport = ofproto_get_port(ofproto, ofp_port);
2342 return (ofport && ofproto->ofproto_class->get_cfm_remote_mpids
2343 ? ofproto->ofproto_class->get_cfm_remote_mpids(ofport, rmps,
2349 handle_aggregate_stats_request(struct ofconn *ofconn,
2350 const struct ofp_stats_msg *osm)
2352 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2353 struct ofputil_flow_stats_request request;
2354 struct ofputil_aggregate_stats stats;
2355 bool unknown_packets, unknown_bytes;
2356 struct ofpbuf *reply;
2361 error = ofputil_decode_flow_stats_request(&request, &osm->header);
2366 error = collect_rules_loose(ofproto, request.table_id, &request.match,
2367 request.cookie, request.cookie_mask,
2368 request.out_port, &rules);
2373 memset(&stats, 0, sizeof stats);
2374 unknown_packets = unknown_bytes = false;
2375 LIST_FOR_EACH (rule, ofproto_node, &rules) {
2376 uint64_t packet_count;
2377 uint64_t byte_count;
2379 ofproto->ofproto_class->rule_get_stats(rule, &packet_count,
2382 if (packet_count == UINT64_MAX) {
2383 unknown_packets = true;
2385 stats.packet_count += packet_count;
2388 if (byte_count == UINT64_MAX) {
2389 unknown_bytes = true;
2391 stats.byte_count += byte_count;
2396 if (unknown_packets) {
2397 stats.packet_count = UINT64_MAX;
2399 if (unknown_bytes) {
2400 stats.byte_count = UINT64_MAX;
2403 reply = ofputil_encode_aggregate_stats_reply(&stats, osm);
2404 ofconn_send_reply(ofconn, reply);
2409 struct queue_stats_cbdata {
2410 struct ofport *ofport;
2411 struct list replies;
2415 put_queue_stats(struct queue_stats_cbdata *cbdata, uint32_t queue_id,
2416 const struct netdev_queue_stats *stats)
2418 struct ofp_queue_stats *reply;
2420 reply = ofputil_append_stats_reply(sizeof *reply, &cbdata->replies);
2421 reply->port_no = cbdata->ofport->opp.port_no;
2422 memset(reply->pad, 0, sizeof reply->pad);
2423 reply->queue_id = htonl(queue_id);
2424 put_32aligned_be64(&reply->tx_bytes, htonll(stats->tx_bytes));
2425 put_32aligned_be64(&reply->tx_packets, htonll(stats->tx_packets));
2426 put_32aligned_be64(&reply->tx_errors, htonll(stats->tx_errors));
2430 handle_queue_stats_dump_cb(uint32_t queue_id,
2431 struct netdev_queue_stats *stats,
2434 struct queue_stats_cbdata *cbdata = cbdata_;
2436 put_queue_stats(cbdata, queue_id, stats);
2440 handle_queue_stats_for_port(struct ofport *port, uint32_t queue_id,
2441 struct queue_stats_cbdata *cbdata)
2443 cbdata->ofport = port;
2444 if (queue_id == OFPQ_ALL) {
2445 netdev_dump_queue_stats(port->netdev,
2446 handle_queue_stats_dump_cb, cbdata);
2448 struct netdev_queue_stats stats;
2450 if (!netdev_get_queue_stats(port->netdev, queue_id, &stats)) {
2451 put_queue_stats(cbdata, queue_id, &stats);
2457 handle_queue_stats_request(struct ofconn *ofconn,
2458 const struct ofp_queue_stats_request *qsr)
2460 struct ofproto *ofproto = ofconn_get_ofproto(ofconn);
2461 struct queue_stats_cbdata cbdata;
2462 struct ofport *port;
2463 unsigned int port_no;
2466 COVERAGE_INC(ofproto_queue_req);
2468 ofputil_start_stats_reply(&qsr->osm, &cbdata.replies);
2470 port_no = ntohs(qsr->port_no);
2471 queue_id = ntohl(qsr->queue_id);
2472 if (port_no == OFPP_ALL) {
2473 HMAP_FOR_EACH (port, hmap_node, &ofproto->ports) {
2474 handle_queue_stats_for_port(port, queue_id, &cbdata);
2476 } else if (port_no < OFPP_MAX) {
2477 port = ofproto_get_port(ofproto, port_no);
2479 handle_queue_stats_for_port(port, queue_id, &cbdata);
2482 ofpbuf_list_delete(&cbdata.replies);
2483 return OFPERR_OFPQOFC_BAD_PORT;
2485 ofconn_send_replies(ofconn, &cbdata.replies);
2491 is_flow_deletion_pending(const struct ofproto *ofproto,
2492 const struct cls_rule *cls_rule,
2495 if (!hmap_is_empty(&ofproto->deletions)) {
2496 struct ofoperation *op;
2498 HMAP_FOR_EACH_WITH_HASH (op, hmap_node,
2499 cls_rule_hash(cls_rule, table_id),
2500 &ofproto->deletions) {
2501 if (cls_rule_equal(cls_rule, &op->rule->cr)) {
2510 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2511 * in which no matching flow already exists in the flow table.
2513 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2514 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
2515 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
2516 * initiated now but may be retried later.
2518 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2521 add_flow(struct ofproto *ofproto, struct ofconn *ofconn,
2522 const struct ofputil_flow_mod *fm, const struct ofp_header *request)
2524 struct oftable *table;
2525 struct ofopgroup *group;
2526 struct rule *victim;
2530 error = check_table_id(ofproto, fm->table_id);
2536 if (fm->table_id == 0xff) {
2538 if (ofproto->ofproto_class->rule_choose_table) {
2539 error = ofproto->ofproto_class->rule_choose_table(ofproto, &fm->cr,
2544 assert(table_id < ofproto->n_tables);
2545 table = &ofproto->tables[table_id];
2547 table = &ofproto->tables[0];
2549 } else if (fm->table_id < ofproto->n_tables) {
2550 table = &ofproto->tables[fm->table_id];
2552 return OFPERR_NXFMFC_BAD_TABLE_ID;
2555 if (table->flags & OFTABLE_READONLY) {
2556 return OFPERR_OFPBRC_EPERM;
2559 /* Check for overlap, if requested. */
2560 if (fm->flags & OFPFF_CHECK_OVERLAP
2561 && classifier_rule_overlaps(&table->cls, &fm->cr)) {
2562 return OFPERR_OFPFMFC_OVERLAP;
2565 /* Serialize against pending deletion. */
2566 if (is_flow_deletion_pending(ofproto, &fm->cr, table - ofproto->tables)) {
2567 return OFPROTO_POSTPONE;
2570 /* Allocate new rule. */
2571 rule = ofproto->ofproto_class->rule_alloc();
2573 VLOG_WARN_RL(&rl, "%s: failed to create rule (%s)",
2574 ofproto->name, strerror(error));
2577 rule->ofproto = ofproto;
2579 rule->pending = NULL;
2580 rule->flow_cookie = fm->cookie;
2581 rule->created = rule->modified = time_msec();
2582 rule->idle_timeout = fm->idle_timeout;
2583 rule->hard_timeout = fm->hard_timeout;
2584 rule->table_id = table - ofproto->tables;
2585 rule->send_flow_removed = (fm->flags & OFPFF_SEND_FLOW_REM) != 0;
2586 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2587 rule->n_actions = fm->n_actions;
2589 /* Insert new rule. */
2590 victim = oftable_replace_rule(rule);
2591 if (victim && !rule_is_modifiable(victim)) {
2592 error = OFPERR_OFPBRC_EPERM;
2593 } else if (victim && victim->pending) {
2594 error = OFPROTO_POSTPONE;
2596 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2597 ofoperation_create(group, rule, OFOPERATION_ADD);
2598 rule->pending->victim = victim;
2600 error = ofproto->ofproto_class->rule_construct(rule);
2602 ofoperation_destroy(rule->pending);
2604 ofopgroup_submit(group);
2607 /* Back out if an error occurred. */
2609 oftable_substitute_rule(rule, victim);
2610 ofproto_rule_destroy__(rule);
2615 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2617 /* Modifies the rules listed in 'rules', changing their actions to match those
2620 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2623 * Returns 0 on success, otherwise an OpenFlow error code. */
2625 modify_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2626 const struct ofputil_flow_mod *fm,
2627 const struct ofp_header *request, struct list *rules)
2629 struct ofopgroup *group;
2633 group = ofopgroup_create(ofproto, ofconn, request, fm->buffer_id);
2634 error = OFPERR_OFPBRC_EPERM;
2635 LIST_FOR_EACH (rule, ofproto_node, rules) {
2636 if (rule_is_modifiable(rule)) {
2637 /* At least one rule is modifiable, don't report EPERM error. */
2643 if (!ofputil_actions_equal(fm->actions, fm->n_actions,
2644 rule->actions, rule->n_actions)) {
2645 ofoperation_create(group, rule, OFOPERATION_MODIFY);
2646 rule->pending->actions = rule->actions;
2647 rule->pending->n_actions = rule->n_actions;
2648 rule->actions = ofputil_actions_clone(fm->actions, fm->n_actions);
2649 rule->n_actions = fm->n_actions;
2650 rule->ofproto->ofproto_class->rule_modify_actions(rule);
2652 rule->modified = time_msec();
2654 rule->flow_cookie = fm->cookie;
2656 ofopgroup_submit(group);
2661 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
2664 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2667 modify_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2668 const struct ofputil_flow_mod *fm,
2669 const struct ofp_header *request)
2674 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2675 fm->cookie, fm->cookie_mask,
2677 return (error ? error
2678 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2679 : modify_flows__(ofproto, ofconn, fm, request, &rules));
2682 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2685 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2688 modify_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2689 const struct ofputil_flow_mod *fm,
2690 const struct ofp_header *request)
2695 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2696 fm->cookie, fm->cookie_mask,
2698 return (error ? error
2699 : list_is_empty(&rules) ? add_flow(ofproto, ofconn, fm, request)
2700 : list_is_singleton(&rules) ? modify_flows__(ofproto, ofconn,
2701 fm, request, &rules)
2705 /* OFPFC_DELETE implementation. */
2707 /* Deletes the rules listed in 'rules'.
2709 * Returns 0 on success, otherwise an OpenFlow error code. */
2711 delete_flows__(struct ofproto *ofproto, struct ofconn *ofconn,
2712 const struct ofp_header *request, struct list *rules)
2714 struct rule *rule, *next;
2715 struct ofopgroup *group;
2717 group = ofopgroup_create(ofproto, ofconn, request, UINT32_MAX);
2718 LIST_FOR_EACH_SAFE (rule, next, ofproto_node, rules) {
2719 ofproto_rule_send_removed(rule, OFPRR_DELETE);
2721 ofoperation_create(group, rule, OFOPERATION_DELETE);
2722 oftable_remove_rule(rule);
2723 rule->ofproto->ofproto_class->rule_destruct(rule);
2725 ofopgroup_submit(group);
2730 /* Implements OFPFC_DELETE. */
2732 delete_flows_loose(struct ofproto *ofproto, struct ofconn *ofconn,
2733 const struct ofputil_flow_mod *fm,
2734 const struct ofp_header *request)
2739 error = collect_rules_loose(ofproto, fm->table_id, &fm->cr,
2740 fm->cookie, fm->cookie_mask,
2741 fm->out_port, &rules);
2742 return (error ? error
2743 : !list_is_empty(&rules) ? delete_flows__(ofproto, ofconn, request,
2748 /* Implements OFPFC_DELETE_STRICT. */
2750 delete_flow_strict(struct ofproto *ofproto, struct ofconn *ofconn,
2751 const struct ofputil_flow_mod *fm,
2752 const struct ofp_header *request)
2757 error = collect_rules_strict(ofproto, fm->table_id, &fm->cr,
2758 fm->cookie, fm->cookie_mask,
2759 fm->out_port, &rules);
2760 return (error ? error
2761 : list_is_singleton(&rules) ? delete_flows__(ofproto, ofconn,
2767 ofproto_rule_send_removed(struct rule *rule, uint8_t reason)
2769 struct ofputil_flow_removed fr;
2771 if (rule_is_hidden(rule) || !rule->send_flow_removed) {
2776 fr.cookie = rule->flow_cookie;
2778 calc_flow_duration__(rule->created, &fr.duration_sec, &fr.duration_nsec);
2779 fr.idle_timeout = rule->idle_timeout;
2780 rule->ofproto->ofproto_class->rule_get_stats(rule, &fr.packet_count,
2783 connmgr_send_flow_removed(rule->ofproto->connmgr, &fr);
2786 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2787 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2790 * ofproto implementation ->run() functions should use this function to expire
2791 * OpenFlow flows. */
2793 ofproto_rule_expire(struct rule *rule, uint8_t reason)
2795 struct ofproto *ofproto = rule->ofproto;
2796 struct ofopgroup *group;
2798 assert(reason == OFPRR_HARD_TIMEOUT || reason == OFPRR_IDLE_TIMEOUT);
2800 ofproto_rule_send_removed(rule, reason);
2802 group = ofopgroup_create_unattached(ofproto);
2803 ofoperation_create(group, rule, OFOPERATION_DELETE);
2804 oftable_remove_rule(rule);
2805 rule->ofproto->ofproto_class->rule_destruct(rule);
2806 ofopgroup_submit(group);
2810 handle_flow_mod(struct ofconn *ofconn, const struct ofp_header *oh)
2812 struct ofputil_flow_mod fm;
2815 error = reject_slave_controller(ofconn);
2820 error = ofputil_decode_flow_mod(&fm, oh,
2821 ofconn_get_flow_mod_table_id(ofconn));
2826 /* We do not support the emergency flow cache. It will hopefully get
2827 * dropped from OpenFlow in the near future. */
2828 if (fm.flags & OFPFF_EMERG) {
2829 /* There isn't a good fit for an error code, so just state that the
2830 * flow table is full. */
2831 return OFPERR_OFPFMFC_ALL_TABLES_FULL;
2834 return handle_flow_mod__(ofconn_get_ofproto(ofconn), ofconn, &fm, oh);
2838 handle_flow_mod__(struct ofproto *ofproto, struct ofconn *ofconn,
2839 const struct ofputil_flow_mod *fm,
2840 const struct ofp_header *oh)
2842 if (ofproto->n_pending >= 50) {
2843 assert(!list_is_empty(&ofproto->pending));
2844 return OFPROTO_POSTPONE;
2847 switch (fm->command) {
2849 return add_flow(ofproto, ofconn, fm, oh);
2852 return modify_flows_loose(ofproto, ofconn, fm, oh);
2854 case OFPFC_MODIFY_STRICT:
2855 return modify_flow_strict(ofproto, ofconn, fm, oh);
2858 return delete_flows_loose(ofproto, ofconn, fm, oh);
2860 case OFPFC_DELETE_STRICT:
2861 return delete_flow_strict(ofproto, ofconn, fm, oh);
2864 if (fm->command > 0xff) {
2865 VLOG_WARN_RL(&rl, "flow_mod has explicit table_id but "
2866 "flow_mod_table_id extension is not enabled");
2868 return OFPERR_OFPFMFC_BAD_COMMAND;
2873 handle_role_request(struct ofconn *ofconn, const struct ofp_header *oh)
2875 struct nx_role_request *nrr = (struct nx_role_request *) oh;
2876 struct nx_role_request *reply;
2880 if (ofconn_get_type(ofconn) != OFCONN_PRIMARY) {
2881 return OFPERR_OFPBRC_EPERM;
2884 role = ntohl(nrr->role);
2885 if (role != NX_ROLE_OTHER && role != NX_ROLE_MASTER
2886 && role != NX_ROLE_SLAVE) {
2887 return OFPERR_NXBRC_BAD_ROLE;
2890 if (ofconn_get_role(ofconn) != role
2891 && ofconn_has_pending_opgroups(ofconn)) {
2892 return OFPROTO_POSTPONE;
2895 ofconn_set_role(ofconn, role);
2897 reply = make_nxmsg_xid(sizeof *reply, NXT_ROLE_REPLY, oh->xid, &buf);
2898 reply->role = htonl(role);
2899 ofconn_send_reply(ofconn, buf);
2905 handle_nxt_flow_mod_table_id(struct ofconn *ofconn,
2906 const struct ofp_header *oh)
2908 const struct nx_flow_mod_table_id *msg
2909 = (const struct nx_flow_mod_table_id *) oh;
2911 ofconn_set_flow_mod_table_id(ofconn, msg->set != 0);
2916 handle_nxt_set_flow_format(struct ofconn *ofconn, const struct ofp_header *oh)
2918 const struct nx_set_flow_format *msg
2919 = (const struct nx_set_flow_format *) oh;
2922 format = ntohl(msg->format);
2923 if (format != NXFF_OPENFLOW10 && format != NXFF_NXM) {
2924 return OFPERR_OFPBRC_EPERM;
2927 if (format != ofconn_get_flow_format(ofconn)
2928 && ofconn_has_pending_opgroups(ofconn)) {
2929 /* Avoid sending async messages in surprising flow format. */
2930 return OFPROTO_POSTPONE;
2933 ofconn_set_flow_format(ofconn, format);
2938 handle_nxt_set_packet_in_format(struct ofconn *ofconn,
2939 const struct ofp_header *oh)
2941 const struct nx_set_packet_in_format *msg;
2944 msg = (const struct nx_set_packet_in_format *) oh;
2945 format = ntohl(msg->format);
2946 if (format != NXPIF_OPENFLOW10 && format != NXPIF_NXM) {
2947 return OFPERR_OFPBRC_EPERM;
2950 if (format != ofconn_get_packet_in_format(ofconn)
2951 && ofconn_has_pending_opgroups(ofconn)) {
2952 /* Avoid sending async message in surprsing packet in format. */
2953 return OFPROTO_POSTPONE;
2956 ofconn_set_packet_in_format(ofconn, format);
2961 handle_barrier_request(struct ofconn *ofconn, const struct ofp_header *oh)
2963 struct ofp_header *ob;
2966 if (ofconn_has_pending_opgroups(ofconn)) {
2967 return OFPROTO_POSTPONE;
2970 ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
2971 ofconn_send_reply(ofconn, buf);
2976 handle_openflow__(struct ofconn *ofconn, const struct ofpbuf *msg)
2978 const struct ofp_header *oh = msg->data;
2979 const struct ofputil_msg_type *type;
2982 error = ofputil_decode_msg_type(oh, &type);
2987 switch (ofputil_msg_type_code(type)) {
2988 /* OpenFlow requests. */
2989 case OFPUTIL_OFPT_ECHO_REQUEST:
2990 return handle_echo_request(ofconn, oh);
2992 case OFPUTIL_OFPT_FEATURES_REQUEST:
2993 return handle_features_request(ofconn, oh);
2995 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
2996 return handle_get_config_request(ofconn, oh);
2998 case OFPUTIL_OFPT_SET_CONFIG:
2999 return handle_set_config(ofconn, msg->data);
3001 case OFPUTIL_OFPT_PACKET_OUT:
3002 return handle_packet_out(ofconn, oh);
3004 case OFPUTIL_OFPT_PORT_MOD:
3005 return handle_port_mod(ofconn, oh);
3007 case OFPUTIL_OFPT_FLOW_MOD:
3008 return handle_flow_mod(ofconn, oh);
3010 case OFPUTIL_OFPT_BARRIER_REQUEST:
3011 return handle_barrier_request(ofconn, oh);
3013 /* OpenFlow replies. */
3014 case OFPUTIL_OFPT_ECHO_REPLY:
3017 /* Nicira extension requests. */
3018 case OFPUTIL_NXT_ROLE_REQUEST:
3019 return handle_role_request(ofconn, oh);
3021 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
3022 return handle_nxt_flow_mod_table_id(ofconn, oh);
3024 case OFPUTIL_NXT_SET_FLOW_FORMAT:
3025 return handle_nxt_set_flow_format(ofconn, oh);
3027 case OFPUTIL_NXT_SET_PACKET_IN_FORMAT:
3028 return handle_nxt_set_packet_in_format(ofconn, oh);
3030 case OFPUTIL_NXT_FLOW_MOD:
3031 return handle_flow_mod(ofconn, oh);
3033 /* Statistics requests. */
3034 case OFPUTIL_OFPST_DESC_REQUEST:
3035 return handle_desc_stats_request(ofconn, msg->data);
3037 case OFPUTIL_OFPST_FLOW_REQUEST:
3038 case OFPUTIL_NXST_FLOW_REQUEST:
3039 return handle_flow_stats_request(ofconn, msg->data);
3041 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
3042 case OFPUTIL_NXST_AGGREGATE_REQUEST:
3043 return handle_aggregate_stats_request(ofconn, msg->data);
3045 case OFPUTIL_OFPST_TABLE_REQUEST:
3046 return handle_table_stats_request(ofconn, msg->data);
3048 case OFPUTIL_OFPST_PORT_REQUEST:
3049 return handle_port_stats_request(ofconn, msg->data);
3051 case OFPUTIL_OFPST_QUEUE_REQUEST:
3052 return handle_queue_stats_request(ofconn, msg->data);
3054 case OFPUTIL_MSG_INVALID:
3055 case OFPUTIL_OFPT_HELLO:
3056 case OFPUTIL_OFPT_ERROR:
3057 case OFPUTIL_OFPT_FEATURES_REPLY:
3058 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
3059 case OFPUTIL_OFPT_PACKET_IN:
3060 case OFPUTIL_OFPT_FLOW_REMOVED:
3061 case OFPUTIL_OFPT_PORT_STATUS:
3062 case OFPUTIL_OFPT_BARRIER_REPLY:
3063 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
3064 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
3065 case OFPUTIL_OFPST_DESC_REPLY:
3066 case OFPUTIL_OFPST_FLOW_REPLY:
3067 case OFPUTIL_OFPST_QUEUE_REPLY:
3068 case OFPUTIL_OFPST_PORT_REPLY:
3069 case OFPUTIL_OFPST_TABLE_REPLY:
3070 case OFPUTIL_OFPST_AGGREGATE_REPLY:
3071 case OFPUTIL_NXT_ROLE_REPLY:
3072 case OFPUTIL_NXT_FLOW_REMOVED:
3073 case OFPUTIL_NXT_PACKET_IN:
3074 case OFPUTIL_NXST_FLOW_REPLY:
3075 case OFPUTIL_NXST_AGGREGATE_REPLY:
3077 if (oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY) {
3078 return OFPERR_OFPBRC_BAD_STAT;
3080 return OFPERR_OFPBRC_BAD_TYPE;
3086 handle_openflow(struct ofconn *ofconn, struct ofpbuf *ofp_msg)
3088 int error = handle_openflow__(ofconn, ofp_msg);
3089 if (error && error != OFPROTO_POSTPONE) {
3090 ofconn_send_error(ofconn, ofp_msg->data, error);
3092 COVERAGE_INC(ofproto_recv_openflow);
3093 return error != OFPROTO_POSTPONE;
3096 /* Asynchronous operations. */
3098 /* Creates and returns a new ofopgroup that is not associated with any
3099 * OpenFlow connection.
3101 * The caller should add operations to the returned group with
3102 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3103 static struct ofopgroup *
3104 ofopgroup_create_unattached(struct ofproto *ofproto)
3106 struct ofopgroup *group = xzalloc(sizeof *group);
3107 group->ofproto = ofproto;
3108 list_init(&group->ofproto_node);
3109 list_init(&group->ops);
3110 list_init(&group->ofconn_node);
3114 /* Creates and returns a new ofopgroup for 'ofproto'.
3116 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
3117 * connection. The 'request' and 'buffer_id' arguments are ignored.
3119 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
3120 * If the ofopgroup eventually fails, then the error reply will include
3121 * 'request'. If the ofopgroup eventually succeeds, then the packet with
3122 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
3124 * The caller should add operations to the returned group with
3125 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3126 static struct ofopgroup *
3127 ofopgroup_create(struct ofproto *ofproto, struct ofconn *ofconn,
3128 const struct ofp_header *request, uint32_t buffer_id)
3130 struct ofopgroup *group = ofopgroup_create_unattached(ofproto);
3132 size_t request_len = ntohs(request->length);
3134 assert(ofconn_get_ofproto(ofconn) == ofproto);
3136 ofconn_add_opgroup(ofconn, &group->ofconn_node);
3137 group->ofconn = ofconn;
3138 group->request = xmemdup(request, MIN(request_len, 64));
3139 group->buffer_id = buffer_id;
3144 /* Submits 'group' for processing.
3146 * If 'group' contains no operations (e.g. none were ever added, or all of the
3147 * ones that were added completed synchronously), then it is destroyed
3148 * immediately. Otherwise it is added to the ofproto's list of pending
3151 ofopgroup_submit(struct ofopgroup *group)
3153 if (list_is_empty(&group->ops)) {
3154 ofopgroup_destroy(group);
3156 list_push_back(&group->ofproto->pending, &group->ofproto_node);
3157 group->ofproto->n_pending++;
3162 ofopgroup_destroy(struct ofopgroup *group)
3164 assert(list_is_empty(&group->ops));
3165 if (!list_is_empty(&group->ofproto_node)) {
3166 assert(group->ofproto->n_pending > 0);
3167 group->ofproto->n_pending--;
3168 list_remove(&group->ofproto_node);
3170 if (!list_is_empty(&group->ofconn_node)) {
3171 list_remove(&group->ofconn_node);
3173 ofconn_send_error(group->ofconn, group->request, group->error);
3175 connmgr_retry(group->ofproto->connmgr);
3177 free(group->request);
3181 /* Initiates a new operation on 'rule', of the specified 'type', within
3182 * 'group'. Prior to calling, 'rule' must not have any pending operation. */
3184 ofoperation_create(struct ofopgroup *group, struct rule *rule,
3185 enum ofoperation_type type)
3187 struct ofoperation *op;
3189 assert(!rule->pending);
3191 op = rule->pending = xzalloc(sizeof *op);
3193 list_push_back(&group->ops, &op->group_node);
3197 op->flow_cookie = rule->flow_cookie;
3199 if (type == OFOPERATION_DELETE) {
3200 hmap_insert(&op->group->ofproto->deletions, &op->hmap_node,
3201 cls_rule_hash(&rule->cr, rule->table_id));
3206 ofoperation_destroy(struct ofoperation *op)
3208 struct ofopgroup *group = op->group;
3211 op->rule->pending = NULL;
3213 if (op->type == OFOPERATION_DELETE) {
3214 hmap_remove(&group->ofproto->deletions, &op->hmap_node);
3216 list_remove(&op->group_node);
3220 if (list_is_empty(&group->ops) && !list_is_empty(&group->ofproto_node)) {
3221 ofopgroup_destroy(group);
3225 /* Indicates that 'op' completed with status 'error', which is either 0 to
3226 * indicate success or an OpenFlow error code on failure.
3228 * If 'error' is 0, indicating success, the operation will be committed
3229 * permanently to the flow table. There is one interesting subcase:
3231 * - If 'op' is an "add flow" operation that is replacing an existing rule in
3232 * the flow table (the "victim" rule) by a new one, then the caller must
3233 * have uninitialized any derived state in the victim rule, as in step 5 in
3234 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
3235 * performs steps 6 and 7 for the victim rule, most notably by calling its
3236 * ->rule_dealloc() function.
3238 * If 'error' is nonzero, then generally the operation will be rolled back:
3240 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
3241 * restores the original rule. The caller must have uninitialized any
3242 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
3243 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
3244 * and 7 for the new rule, calling its ->rule_dealloc() function.
3246 * - If 'op' is a "modify flow" operation, ofproto restores the original
3249 * - 'op' must not be a "delete flow" operation. Removing a rule is not
3250 * allowed to fail. It must always succeed.
3252 * Please see the large comment in ofproto/ofproto-provider.h titled
3253 * "Asynchronous Operation Support" for more information. */
3255 ofoperation_complete(struct ofoperation *op, enum ofperr error)
3257 struct ofopgroup *group = op->group;
3258 struct rule *rule = op->rule;
3259 struct ofproto *ofproto = rule->ofproto;
3261 assert(rule->pending == op);
3262 assert(op->status < 0);
3266 && op->type != OFOPERATION_DELETE
3268 && group->buffer_id != UINT32_MAX
3269 && list_is_singleton(&op->group_node)) {
3270 struct ofpbuf *packet;
3273 error = ofconn_pktbuf_retrieve(group->ofconn, group->buffer_id,
3277 error = rule_execute(rule, in_port, packet);
3280 if (!group->error) {
3281 group->error = error;
3285 case OFOPERATION_ADD:
3288 ofproto_rule_destroy__(op->victim);
3290 if ((rule->cr.wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3291 == htons(VLAN_VID_MASK)) {
3292 if (ofproto->vlan_bitmap) {
3293 uint16_t vid = vlan_tci_to_vid(rule->cr.flow.vlan_tci);
3295 if (!bitmap_is_set(ofproto->vlan_bitmap, vid)) {
3296 bitmap_set1(ofproto->vlan_bitmap, vid);
3297 ofproto->vlans_changed = true;
3300 ofproto->vlans_changed = true;
3304 oftable_substitute_rule(rule, op->victim);
3305 ofproto_rule_destroy__(rule);
3310 case OFOPERATION_DELETE:
3312 ofproto_rule_destroy__(rule);
3316 case OFOPERATION_MODIFY:
3318 rule->modified = time_msec();
3320 free(rule->actions);
3321 rule->actions = op->actions;
3322 rule->n_actions = op->n_actions;
3330 ofoperation_destroy(op);
3334 ofoperation_get_victim(struct ofoperation *op)
3336 assert(op->type == OFOPERATION_ADD);
3341 pick_datapath_id(const struct ofproto *ofproto)
3343 const struct ofport *port;
3345 port = ofproto_get_port(ofproto, OFPP_LOCAL);
3347 uint8_t ea[ETH_ADDR_LEN];
3350 error = netdev_get_etheraddr(port->netdev, ea);
3352 return eth_addr_to_uint64(ea);
3354 VLOG_WARN("could not get MAC address for %s (%s)",
3355 netdev_get_name(port->netdev), strerror(error));
3357 return ofproto->fallback_dpid;
3361 pick_fallback_dpid(void)
3363 uint8_t ea[ETH_ADDR_LEN];
3364 eth_addr_nicira_random(ea);
3365 return eth_addr_to_uint64(ea);
3370 /* Initializes 'table'. */
3372 oftable_init(struct oftable *table)
3374 memset(table, 0, sizeof *table);
3375 classifier_init(&table->cls);
3378 /* Destroys 'table'.
3380 * The caller is responsible for freeing 'table' itself. */
3382 oftable_destroy(struct oftable *table)
3384 assert(classifier_is_empty(&table->cls));
3385 classifier_destroy(&table->cls);
3388 /* Removes 'rule' from the oftable that contains it. */
3390 oftable_remove_rule(struct rule *rule)
3392 struct ofproto *ofproto = rule->ofproto;
3393 struct oftable *table = &ofproto->tables[rule->table_id];
3395 classifier_remove(&table->cls, &rule->cr);
3398 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
3399 * oftable that has an identical cls_rule. Returns the rule that was removed,
3400 * if any, and otherwise NULL. */
3401 static struct rule *
3402 oftable_replace_rule(struct rule *rule)
3404 struct ofproto *ofproto = rule->ofproto;
3405 struct oftable *table = &ofproto->tables[rule->table_id];
3407 return rule_from_cls_rule(classifier_replace(&table->cls, &rule->cr));
3410 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
3412 oftable_substitute_rule(struct rule *old, struct rule *new)
3415 oftable_replace_rule(new);
3417 oftable_remove_rule(old);
3421 /* unixctl commands. */
3424 ofproto_lookup(const char *name)
3426 struct ofproto *ofproto;
3428 HMAP_FOR_EACH_WITH_HASH (ofproto, hmap_node, hash_string(name, 0),
3430 if (!strcmp(ofproto->name, name)) {
3438 ofproto_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
3439 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
3441 struct ofproto *ofproto;
3445 HMAP_FOR_EACH (ofproto, hmap_node, &all_ofprotos) {
3446 ds_put_format(&results, "%s\n", ofproto->name);
3448 unixctl_command_reply(conn, 200, ds_cstr(&results));
3449 ds_destroy(&results);
3453 ofproto_unixctl_init(void)
3455 static bool registered;
3461 unixctl_command_register("ofproto/list", "", 0, 0,
3462 ofproto_unixctl_list, NULL);
3465 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
3467 * This is deprecated. It is only for compatibility with broken device drivers
3468 * in old versions of Linux that do not properly support VLANs when VLAN
3469 * devices are not used. When broken device drivers are no longer in
3470 * widespread use, we will delete these interfaces. */
3472 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
3473 * (exactly) by an OpenFlow rule in 'ofproto'. */
3475 ofproto_get_vlan_usage(struct ofproto *ofproto, unsigned long int *vlan_bitmap)
3477 const struct oftable *oftable;
3479 free(ofproto->vlan_bitmap);
3480 ofproto->vlan_bitmap = bitmap_allocate(4096);
3481 ofproto->vlans_changed = false;
3483 OFPROTO_FOR_EACH_TABLE (oftable, ofproto) {
3484 const struct cls_table *table;
3486 HMAP_FOR_EACH (table, hmap_node, &oftable->cls.tables) {
3487 if ((table->wc.vlan_tci_mask & htons(VLAN_VID_MASK))
3488 == htons(VLAN_VID_MASK)) {
3489 const struct cls_rule *rule;
3491 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
3492 uint16_t vid = vlan_tci_to_vid(rule->flow.vlan_tci);
3493 bitmap_set1(vlan_bitmap, vid);
3494 bitmap_set1(ofproto->vlan_bitmap, vid);
3501 /* Returns true if new VLANs have come into use by the flow table since the
3502 * last call to ofproto_get_vlan_usage().
3504 * We don't track when old VLANs stop being used. */
3506 ofproto_has_vlan_usage_changed(const struct ofproto *ofproto)
3508 return ofproto->vlans_changed;
3511 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
3512 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
3513 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
3514 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
3515 * then the VLAN device is un-enslaved. */
3517 ofproto_port_set_realdev(struct ofproto *ofproto, uint16_t vlandev_ofp_port,
3518 uint16_t realdev_ofp_port, int vid)
3520 struct ofport *ofport;
3523 assert(vlandev_ofp_port != realdev_ofp_port);
3525 ofport = ofproto_get_port(ofproto, vlandev_ofp_port);
3527 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16,
3528 ofproto->name, vlandev_ofp_port);
3532 if (!ofproto->ofproto_class->set_realdev) {
3533 if (!vlandev_ofp_port) {
3536 VLOG_WARN("%s: vlan splinters not supported", ofproto->name);
3540 error = ofproto->ofproto_class->set_realdev(ofport, realdev_ofp_port, vid);
3542 VLOG_WARN("%s: setting realdev on port %"PRIu16" (%s) failed (%s)",
3543 ofproto->name, vlandev_ofp_port,
3544 netdev_get_name(ofport->netdev), strerror(error));