2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks.
3 * Copyright (c) 2010 Jean Tourrilhes - HP-Labs.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
25 #include "byte-order.h"
26 #include "classifier.h"
29 #include "dynamic-string.h"
34 #include "ofp-errors.h"
35 #include "ofp-print.h"
38 #include "ofproto-provider.h"
39 #include "openflow/nicira-ext.h"
40 #include "openflow/openflow.h"
44 #include "poll-loop.h"
48 #include "unaligned.h"
52 VLOG_DEFINE_THIS_MODULE(ofproto
);
54 COVERAGE_DEFINE(ofproto_error
);
55 COVERAGE_DEFINE(ofproto_flush
);
56 COVERAGE_DEFINE(ofproto_no_packet_in
);
57 COVERAGE_DEFINE(ofproto_packet_out
);
58 COVERAGE_DEFINE(ofproto_queue_req
);
59 COVERAGE_DEFINE(ofproto_recv_openflow
);
60 COVERAGE_DEFINE(ofproto_reinit_ports
);
61 COVERAGE_DEFINE(ofproto_uninstallable
);
62 COVERAGE_DEFINE(ofproto_update_port
);
65 S_OPENFLOW
, /* Processing OpenFlow commands. */
66 S_FLUSH
, /* Deleting all flow table rules. */
69 enum ofoperation_type
{
75 /* A single OpenFlow request can execute any number of operations. The
76 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
77 * ofconn to which an error reply should be sent if necessary.
79 * ofproto initiates some operations internally. These operations are still
80 * assigned to groups but will not have an associated ofconn. */
82 struct ofproto
*ofproto
; /* Owning ofproto. */
83 struct list ofproto_node
; /* In ofproto's "pending" list. */
84 struct list ops
; /* List of "struct ofoperation"s. */
86 /* Data needed to send OpenFlow reply on failure or to send a buffered
89 * If list_is_empty(ofconn_node) then this ofopgroup never had an
90 * associated ofconn or its ofconn's connection dropped after it initiated
91 * the operation. In the latter case 'ofconn' is a wild pointer that
92 * refers to freed memory, so the 'ofconn' member must be used only if
93 * !list_is_empty(ofconn_node).
95 struct list ofconn_node
; /* In ofconn's list of pending opgroups. */
96 struct ofconn
*ofconn
; /* ofconn for reply (but see note above). */
97 struct ofp_header
*request
; /* Original request (truncated at 64 bytes). */
98 uint32_t buffer_id
; /* Buffer id from original request. */
99 int error
; /* 0 if no error yet, otherwise error code. */
102 static struct ofopgroup
*ofopgroup_create_unattached(struct ofproto
*);
103 static struct ofopgroup
*ofopgroup_create(struct ofproto
*, struct ofconn
*,
104 const struct ofp_header
*,
106 static void ofopgroup_submit(struct ofopgroup
*);
107 static void ofopgroup_destroy(struct ofopgroup
*);
109 /* A single flow table operation. */
111 struct ofopgroup
*group
; /* Owning group. */
112 struct list group_node
; /* In ofopgroup's "ops" list. */
113 struct hmap_node hmap_node
; /* In ofproto's "deletions" hmap. */
114 struct rule
*rule
; /* Rule being operated upon. */
115 enum ofoperation_type type
; /* Type of operation. */
116 int status
; /* -1 if pending, otherwise 0 or error code. */
117 struct rule
*victim
; /* OFOPERATION_ADDING: Replaced rule. */
118 union ofp_action
*actions
; /* OFOPERATION_MODIFYING: Replaced actions. */
119 int n_actions
; /* OFOPERATION_MODIFYING: # of old actions. */
120 ovs_be64 flow_cookie
; /* Rule's old flow cookie. */
123 static void ofoperation_create(struct ofopgroup
*, struct rule
*,
124 enum ofoperation_type
);
125 static void ofoperation_destroy(struct ofoperation
*);
127 static void ofport_destroy__(struct ofport
*);
128 static void ofport_destroy(struct ofport
*);
130 static uint64_t pick_datapath_id(const struct ofproto
*);
131 static uint64_t pick_fallback_dpid(void);
133 static void ofproto_destroy__(struct ofproto
*);
135 static void ofproto_rule_destroy__(struct rule
*);
136 static void ofproto_rule_send_removed(struct rule
*, uint8_t reason
);
138 static void ofopgroup_destroy(struct ofopgroup
*);
140 static enum ofperr
add_flow(struct ofproto
*, struct ofconn
*,
141 const struct ofputil_flow_mod
*,
142 const struct ofp_header
*);
144 static bool handle_openflow(struct ofconn
*, struct ofpbuf
*);
145 static enum ofperr
handle_flow_mod__(struct ofproto
*, struct ofconn
*,
146 const struct ofputil_flow_mod
*,
147 const struct ofp_header
*);
149 static void update_port(struct ofproto
*, const char *devname
);
150 static int init_ports(struct ofproto
*);
151 static void reinit_ports(struct ofproto
*);
152 static void set_internal_devs_mtu(struct ofproto
*);
154 static void ofproto_unixctl_init(void);
156 /* All registered ofproto classes, in probe order. */
157 static const struct ofproto_class
**ofproto_classes
;
158 static size_t n_ofproto_classes
;
159 static size_t allocated_ofproto_classes
;
161 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
162 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
164 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
167 ofproto_initialize(void)
173 ofproto_class_register(&ofproto_dpif_class
);
177 /* 'type' should be a normalized datapath type, as returned by
178 * ofproto_normalize_type(). Returns the corresponding ofproto_class
179 * structure, or a null pointer if there is none registered for 'type'. */
180 static const struct ofproto_class
*
181 ofproto_class_find__(const char *type
)
185 ofproto_initialize();
186 for (i
= 0; i
< n_ofproto_classes
; i
++) {
187 const struct ofproto_class
*class = ofproto_classes
[i
];
192 class->enumerate_types(&types
);
193 found
= sset_contains(&types
, type
);
194 sset_destroy(&types
);
200 VLOG_WARN("unknown datapath type %s", type
);
204 /* Registers a new ofproto class. After successful registration, new ofprotos
205 * of that type can be created using ofproto_create(). */
207 ofproto_class_register(const struct ofproto_class
*new_class
)
211 for (i
= 0; i
< n_ofproto_classes
; i
++) {
212 if (ofproto_classes
[i
] == new_class
) {
217 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
218 ofproto_classes
= x2nrealloc(ofproto_classes
,
219 &allocated_ofproto_classes
,
220 sizeof *ofproto_classes
);
222 ofproto_classes
[n_ofproto_classes
++] = new_class
;
226 /* Unregisters a datapath provider. 'type' must have been previously
227 * registered and not currently be in use by any ofprotos. After
228 * unregistration new datapaths of that type cannot be opened using
229 * ofproto_create(). */
231 ofproto_class_unregister(const struct ofproto_class
*class)
235 for (i
= 0; i
< n_ofproto_classes
; i
++) {
236 if (ofproto_classes
[i
] == class) {
237 for (i
++; i
< n_ofproto_classes
; i
++) {
238 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
244 VLOG_WARN("attempted to unregister an ofproto class that is not "
249 /* Clears 'types' and enumerates all registered ofproto types into it. The
250 * caller must first initialize the sset. */
252 ofproto_enumerate_types(struct sset
*types
)
256 ofproto_initialize();
257 for (i
= 0; i
< n_ofproto_classes
; i
++) {
258 ofproto_classes
[i
]->enumerate_types(types
);
262 /* Returns the fully spelled out name for the given ofproto 'type'.
264 * Normalized type string can be compared with strcmp(). Unnormalized type
265 * string might be the same even if they have different spellings. */
267 ofproto_normalize_type(const char *type
)
269 return type
&& type
[0] ? type
: "system";
272 /* Clears 'names' and enumerates the names of all known created ofprotos with
273 * the given 'type'. The caller must first initialize the sset. Returns 0 if
274 * successful, otherwise a positive errno value.
276 * Some kinds of datapaths might not be practically enumerable. This is not
277 * considered an error. */
279 ofproto_enumerate_names(const char *type
, struct sset
*names
)
281 const struct ofproto_class
*class = ofproto_class_find__(type
);
282 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
286 ofproto_create(const char *datapath_name
, const char *datapath_type
,
287 struct ofproto
**ofprotop
)
289 const struct ofproto_class
*class;
290 struct classifier
*table
;
291 struct ofproto
*ofproto
;
297 ofproto_initialize();
298 ofproto_unixctl_init();
300 datapath_type
= ofproto_normalize_type(datapath_type
);
301 class = ofproto_class_find__(datapath_type
);
303 VLOG_WARN("could not create datapath %s of unknown type %s",
304 datapath_name
, datapath_type
);
308 ofproto
= class->alloc();
310 VLOG_ERR("failed to allocate datapath %s of type %s",
311 datapath_name
, datapath_type
);
316 memset(ofproto
, 0, sizeof *ofproto
);
317 ofproto
->ofproto_class
= class;
318 ofproto
->name
= xstrdup(datapath_name
);
319 ofproto
->type
= xstrdup(datapath_type
);
320 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
321 hash_string(ofproto
->name
, 0));
322 ofproto
->datapath_id
= 0;
323 ofproto_set_flow_eviction_threshold(ofproto
,
324 OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT
);
325 ofproto
->forward_bpdu
= false;
326 ofproto
->fallback_dpid
= pick_fallback_dpid();
327 ofproto
->mfr_desc
= xstrdup(DEFAULT_MFR_DESC
);
328 ofproto
->hw_desc
= xstrdup(DEFAULT_HW_DESC
);
329 ofproto
->sw_desc
= xstrdup(DEFAULT_SW_DESC
);
330 ofproto
->serial_desc
= xstrdup(DEFAULT_SERIAL_DESC
);
331 ofproto
->dp_desc
= xstrdup(DEFAULT_DP_DESC
);
332 ofproto
->frag_handling
= OFPC_FRAG_NORMAL
;
333 hmap_init(&ofproto
->ports
);
334 shash_init(&ofproto
->port_by_name
);
335 ofproto
->tables
= NULL
;
336 ofproto
->n_tables
= 0;
337 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
338 ofproto
->state
= S_OPENFLOW
;
339 list_init(&ofproto
->pending
);
340 ofproto
->n_pending
= 0;
341 hmap_init(&ofproto
->deletions
);
342 ofproto
->vlan_bitmap
= NULL
;
343 ofproto
->vlans_changed
= false;
345 error
= ofproto
->ofproto_class
->construct(ofproto
, &n_tables
);
347 VLOG_ERR("failed to open datapath %s: %s",
348 datapath_name
, strerror(error
));
349 ofproto_destroy__(ofproto
);
353 assert(n_tables
>= 1 && n_tables
<= 255);
354 ofproto
->n_tables
= n_tables
;
355 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
356 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
357 classifier_init(table
);
360 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
361 VLOG_INFO("using datapath ID %016"PRIx64
, ofproto
->datapath_id
);
369 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
371 uint64_t old_dpid
= p
->datapath_id
;
372 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
373 if (p
->datapath_id
!= old_dpid
) {
374 VLOG_INFO("datapath ID changed to %016"PRIx64
, p
->datapath_id
);
376 /* Force all active connections to reconnect, since there is no way to
377 * notify a controller that the datapath ID has changed. */
378 ofproto_reconnect_controllers(p
);
383 ofproto_set_controllers(struct ofproto
*p
,
384 const struct ofproto_controller
*controllers
,
385 size_t n_controllers
)
387 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
);
391 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
393 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
396 /* Drops the connections between 'ofproto' and all of its controllers, forcing
397 * them to reconnect. */
399 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
401 connmgr_reconnect(ofproto
->connmgr
);
404 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
405 * in-band control should guarantee access, in the same way that in-band
406 * control guarantees access to OpenFlow controllers. */
408 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
409 const struct sockaddr_in
*extras
, size_t n
)
411 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
414 /* Sets the OpenFlow queue used by flows set up by in-band control on
415 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
416 * flows will use the default queue. */
418 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
420 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
423 /* Sets the number of flows at which eviction from the kernel flow table
426 ofproto_set_flow_eviction_threshold(struct ofproto
*ofproto
, unsigned threshold
)
428 if (threshold
< OFPROTO_FLOW_EVICTION_THRESHOLD_MIN
) {
429 ofproto
->flow_eviction_threshold
= OFPROTO_FLOW_EVICTION_THRESHOLD_MIN
;
431 ofproto
->flow_eviction_threshold
= threshold
;
435 /* If forward_bpdu is true, the NORMAL action will forward frames with
436 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
437 * the NORMAL action will drop these frames. */
439 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
441 bool old_val
= ofproto
->forward_bpdu
;
442 ofproto
->forward_bpdu
= forward_bpdu
;
443 if (old_val
!= ofproto
->forward_bpdu
) {
444 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
445 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
451 ofproto_set_desc(struct ofproto
*p
,
452 const char *mfr_desc
, const char *hw_desc
,
453 const char *sw_desc
, const char *serial_desc
,
456 struct ofp_desc_stats
*ods
;
459 if (strlen(mfr_desc
) >= sizeof ods
->mfr_desc
) {
460 VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
461 sizeof ods
->mfr_desc
);
464 p
->mfr_desc
= xstrdup(mfr_desc
);
467 if (strlen(hw_desc
) >= sizeof ods
->hw_desc
) {
468 VLOG_WARN("truncating hw_desc, must be less than %zu characters",
469 sizeof ods
->hw_desc
);
472 p
->hw_desc
= xstrdup(hw_desc
);
475 if (strlen(sw_desc
) >= sizeof ods
->sw_desc
) {
476 VLOG_WARN("truncating sw_desc, must be less than %zu characters",
477 sizeof ods
->sw_desc
);
480 p
->sw_desc
= xstrdup(sw_desc
);
483 if (strlen(serial_desc
) >= sizeof ods
->serial_num
) {
484 VLOG_WARN("truncating serial_desc, must be less than %zu "
486 sizeof ods
->serial_num
);
488 free(p
->serial_desc
);
489 p
->serial_desc
= xstrdup(serial_desc
);
492 if (strlen(dp_desc
) >= sizeof ods
->dp_desc
) {
493 VLOG_WARN("truncating dp_desc, must be less than %zu characters",
494 sizeof ods
->dp_desc
);
497 p
->dp_desc
= xstrdup(dp_desc
);
502 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
504 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
508 ofproto_set_netflow(struct ofproto
*ofproto
,
509 const struct netflow_options
*nf_options
)
511 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
515 if (ofproto
->ofproto_class
->set_netflow
) {
516 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
518 return nf_options
? EOPNOTSUPP
: 0;
523 ofproto_set_sflow(struct ofproto
*ofproto
,
524 const struct ofproto_sflow_options
*oso
)
526 if (oso
&& sset_is_empty(&oso
->targets
)) {
530 if (ofproto
->ofproto_class
->set_sflow
) {
531 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
533 return oso
? EOPNOTSUPP
: 0;
537 /* Spanning Tree Protocol (STP) configuration. */
539 /* Configures STP on 'ofproto' using the settings defined in 's'. If
540 * 's' is NULL, disables STP.
542 * Returns 0 if successful, otherwise a positive errno value. */
544 ofproto_set_stp(struct ofproto
*ofproto
,
545 const struct ofproto_stp_settings
*s
)
547 return (ofproto
->ofproto_class
->set_stp
548 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
552 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
553 * 'enabled' member of 's' is false, then the other members are not
556 * Returns 0 if successful, otherwise a positive errno value. */
558 ofproto_get_stp_status(struct ofproto
*ofproto
,
559 struct ofproto_stp_status
*s
)
561 return (ofproto
->ofproto_class
->get_stp_status
562 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
566 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
567 * in 's'. The caller is responsible for assigning STP port numbers
568 * (using the 'port_num' member in the range of 1 through 255, inclusive)
569 * and ensuring there are no duplicates. If the 's' is NULL, then STP
570 * is disabled on the port.
572 * Returns 0 if successful, otherwise a positive errno value.*/
574 ofproto_port_set_stp(struct ofproto
*ofproto
, uint16_t ofp_port
,
575 const struct ofproto_port_stp_settings
*s
)
577 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
579 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
580 ofproto
->name
, ofp_port
);
584 return (ofproto
->ofproto_class
->set_stp_port
585 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
589 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
590 * 's'. If the 'enabled' member in 's' is false, then the other members
591 * are not meaningful.
593 * Returns 0 if successful, otherwise a positive errno value.*/
595 ofproto_port_get_stp_status(struct ofproto
*ofproto
, uint16_t ofp_port
,
596 struct ofproto_port_stp_status
*s
)
598 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
600 VLOG_WARN("%s: cannot get STP status on nonexistent port %"PRIu16
,
601 ofproto
->name
, ofp_port
);
605 return (ofproto
->ofproto_class
->get_stp_port_status
606 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
610 /* Queue DSCP configuration. */
612 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
613 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
614 * to implement QoS. Instead, it is used to implement features which require
615 * knowledge of what queues exist on a port, and some basic information about
618 * Returns 0 if successful, otherwise a positive errno value. */
620 ofproto_port_set_queues(struct ofproto
*ofproto
, uint16_t ofp_port
,
621 const struct ofproto_port_queue
*queues
,
624 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
627 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
628 ofproto
->name
, ofp_port
);
632 return (ofproto
->ofproto_class
->set_queues
633 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
637 /* Connectivity Fault Management configuration. */
639 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
641 ofproto_port_clear_cfm(struct ofproto
*ofproto
, uint16_t ofp_port
)
643 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
644 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
645 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
649 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
650 * basic configuration from the configuration members in 'cfm', and the remote
651 * maintenance point ID from remote_mpid. Ignores the statistics members of
654 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
656 ofproto_port_set_cfm(struct ofproto
*ofproto
, uint16_t ofp_port
,
657 const struct cfm_settings
*s
)
659 struct ofport
*ofport
;
662 ofport
= ofproto_get_port(ofproto
, ofp_port
);
664 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
665 ofproto
->name
, ofp_port
);
669 /* XXX: For configuration simplicity, we only support one remote_mpid
670 * outside of the CFM module. It's not clear if this is the correct long
671 * term solution or not. */
672 error
= (ofproto
->ofproto_class
->set_cfm
673 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
676 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
677 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
682 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
683 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
684 * 0 if LACP partner information is not current (generally indicating a
685 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
687 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, uint16_t ofp_port
)
689 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
690 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
691 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
697 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
698 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
699 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
700 * configuration plus, if there is more than one slave, a bonding
703 * If 'aux' is already registered then this function updates its configuration
704 * to 's'. Otherwise, this function registers a new bundle.
706 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
709 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
710 const struct ofproto_bundle_settings
*s
)
712 return (ofproto
->ofproto_class
->bundle_set
713 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
717 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
718 * If no such bundle has been registered, this has no effect. */
720 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
722 return ofproto_bundle_register(ofproto
, aux
, NULL
);
726 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
727 * If 'aux' is already registered then this function updates its configuration
728 * to 's'. Otherwise, this function registers a new mirror. */
730 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
731 const struct ofproto_mirror_settings
*s
)
733 return (ofproto
->ofproto_class
->mirror_set
734 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
738 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
739 * If no mirror has been registered, this has no effect. */
741 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
743 return ofproto_mirror_register(ofproto
, aux
, NULL
);
746 /* Retrieves statistics from mirror associated with client data pointer
747 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
748 * 'bytes', respectively. If a particular counters is not supported,
749 * the appropriate argument is set to UINT64_MAX. */
751 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
752 uint64_t *packets
, uint64_t *bytes
)
754 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
755 *packets
= *bytes
= UINT64_MAX
;
759 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
763 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
764 * which all packets are flooded, instead of using MAC learning. If
765 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
767 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
770 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
772 return (ofproto
->ofproto_class
->set_flood_vlans
773 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
777 /* Returns true if 'aux' is a registered bundle that is currently in use as the
778 * output for a mirror. */
780 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
782 return (ofproto
->ofproto_class
->is_mirror_output_bundle
783 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
788 ofproto_has_snoops(const struct ofproto
*ofproto
)
790 return connmgr_has_snoops(ofproto
->connmgr
);
794 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
796 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
800 ofproto_flush__(struct ofproto
*ofproto
)
802 struct classifier
*table
;
803 struct ofopgroup
*group
;
805 if (ofproto
->ofproto_class
->flush
) {
806 ofproto
->ofproto_class
->flush(ofproto
);
809 group
= ofopgroup_create_unattached(ofproto
);
810 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
811 struct rule
*rule
, *next_rule
;
812 struct cls_cursor cursor
;
814 cls_cursor_init(&cursor
, table
, NULL
);
815 CLS_CURSOR_FOR_EACH_SAFE (rule
, next_rule
, cr
, &cursor
) {
816 if (!rule
->pending
) {
817 ofoperation_create(group
, rule
, OFOPERATION_DELETE
);
818 classifier_remove(table
, &rule
->cr
);
819 ofproto
->ofproto_class
->rule_destruct(rule
);
823 ofopgroup_submit(group
);
827 ofproto_destroy__(struct ofproto
*ofproto
)
829 struct classifier
*table
;
831 assert(list_is_empty(&ofproto
->pending
));
832 assert(!ofproto
->n_pending
);
834 connmgr_destroy(ofproto
->connmgr
);
836 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
839 free(ofproto
->mfr_desc
);
840 free(ofproto
->hw_desc
);
841 free(ofproto
->sw_desc
);
842 free(ofproto
->serial_desc
);
843 free(ofproto
->dp_desc
);
844 hmap_destroy(&ofproto
->ports
);
845 shash_destroy(&ofproto
->port_by_name
);
847 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
848 assert(classifier_is_empty(table
));
849 classifier_destroy(table
);
851 free(ofproto
->tables
);
853 hmap_destroy(&ofproto
->deletions
);
855 free(ofproto
->vlan_bitmap
);
857 ofproto
->ofproto_class
->dealloc(ofproto
);
861 ofproto_destroy(struct ofproto
*p
)
863 struct ofport
*ofport
, *next_ofport
;
870 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
871 ofport_destroy(ofport
);
874 p
->ofproto_class
->destruct(p
);
875 ofproto_destroy__(p
);
878 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
879 * kernel datapath, for example, this destroys the datapath in the kernel, and
880 * with the netdev-based datapath, it tears down the data structures that
881 * represent the datapath.
883 * The datapath should not be currently open as an ofproto. */
885 ofproto_delete(const char *name
, const char *type
)
887 const struct ofproto_class
*class = ofproto_class_find__(type
);
888 return (!class ? EAFNOSUPPORT
889 : !class->del
? EACCES
890 : class->del(type
, name
));
894 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
896 if (error
== ENOBUFS
) {
897 reinit_ports(ofproto
);
899 update_port(ofproto
, devname
);
905 ofproto_run(struct ofproto
*p
)
907 struct ofport
*ofport
;
911 error
= p
->ofproto_class
->run(p
);
912 if (error
&& error
!= EAGAIN
) {
913 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, strerror(error
));
916 if (p
->ofproto_class
->port_poll
) {
917 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
918 process_port_change(p
, error
, devname
);
922 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
923 unsigned int change_seq
= netdev_change_seq(ofport
->netdev
);
924 if (ofport
->change_seq
!= change_seq
) {
925 ofport
->change_seq
= change_seq
;
926 update_port(p
, netdev_get_name(ofport
->netdev
));
933 connmgr_run(p
->connmgr
, handle_openflow
);
937 connmgr_run(p
->connmgr
, NULL
);
939 if (list_is_empty(&p
->pending
) && hmap_is_empty(&p
->deletions
)) {
940 connmgr_flushed(p
->connmgr
);
941 p
->state
= S_OPENFLOW
;
952 /* Performs periodic activity required by 'ofproto' that needs to be done
953 * with the least possible latency.
955 * It makes sense to call this function a couple of times per poll loop, to
956 * provide a significant performance boost on some benchmarks with the
957 * ofproto-dpif implementation. */
959 ofproto_run_fast(struct ofproto
*p
)
963 error
= p
->ofproto_class
->run_fast
? p
->ofproto_class
->run_fast(p
) : 0;
964 if (error
&& error
!= EAGAIN
) {
965 VLOG_ERR_RL(&rl
, "%s: fastpath run failed (%s)",
966 p
->name
, strerror(error
));
972 ofproto_wait(struct ofproto
*p
)
974 struct ofport
*ofport
;
976 p
->ofproto_class
->wait(p
);
977 if (p
->ofproto_class
->port_poll_wait
) {
978 p
->ofproto_class
->port_poll_wait(p
);
981 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
982 if (ofport
->change_seq
!= netdev_change_seq(ofport
->netdev
)) {
983 poll_immediate_wake();
989 connmgr_wait(p
->connmgr
, true);
993 connmgr_wait(p
->connmgr
, false);
994 if (list_is_empty(&p
->pending
) && hmap_is_empty(&p
->deletions
)) {
995 poll_immediate_wake();
1002 ofproto_is_alive(const struct ofproto
*p
)
1004 return connmgr_has_controllers(p
->connmgr
);
1008 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1011 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1015 ofproto_free_ofproto_controller_info(struct shash
*info
)
1017 connmgr_free_controller_info(info
);
1020 /* Makes a deep copy of 'old' into 'port'. */
1022 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1024 port
->name
= xstrdup(old
->name
);
1025 port
->type
= xstrdup(old
->type
);
1026 port
->ofp_port
= old
->ofp_port
;
1029 /* Frees memory allocated to members of 'ofproto_port'.
1031 * Do not call this function on an ofproto_port obtained from
1032 * ofproto_port_dump_next(): that function retains ownership of the data in the
1035 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1037 free(ofproto_port
->name
);
1038 free(ofproto_port
->type
);
1041 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1043 * This function provides no status indication. An error status for the entire
1044 * dump operation is provided when it is completed by calling
1045 * ofproto_port_dump_done().
1048 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1049 const struct ofproto
*ofproto
)
1051 dump
->ofproto
= ofproto
;
1052 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1056 /* Attempts to retrieve another port from 'dump', which must have been created
1057 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1058 * 'port' and returns true. On failure, returns false.
1060 * Failure might indicate an actual error or merely that the last port has been
1061 * dumped. An error status for the entire dump operation is provided when it
1062 * is completed by calling ofproto_port_dump_done().
1064 * The ofproto owns the data stored in 'port'. It will remain valid until at
1065 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1066 * ofproto_port_dump_done(). */
1068 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1069 struct ofproto_port
*port
)
1071 const struct ofproto
*ofproto
= dump
->ofproto
;
1077 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1080 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1086 /* Completes port table dump operation 'dump', which must have been created
1087 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1088 * error-free, otherwise a positive errno value describing the problem. */
1090 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1092 const struct ofproto
*ofproto
= dump
->ofproto
;
1094 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1097 return dump
->error
== EOF
? 0 : dump
->error
;
1100 /* Attempts to add 'netdev' as a port on 'ofproto'. If successful, returns 0
1101 * and sets '*ofp_portp' to the new port's OpenFlow port number (if 'ofp_portp'
1102 * is non-null). On failure, returns a positive errno value and sets
1103 * '*ofp_portp' to OFPP_NONE (if 'ofp_portp' is non-null). */
1105 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1106 uint16_t *ofp_portp
)
1111 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
, &ofp_port
);
1113 update_port(ofproto
, netdev_get_name(netdev
));
1116 *ofp_portp
= error
? OFPP_NONE
: ofp_port
;
1121 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1122 * initializes '*port' appropriately; on failure, returns a positive errno
1125 * The caller owns the data in 'ofproto_port' and must free it with
1126 * ofproto_port_destroy() when it is no longer needed. */
1128 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1129 struct ofproto_port
*port
)
1133 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1135 memset(port
, 0, sizeof *port
);
1140 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1141 * Returns 0 if successful, otherwise a positive errno. */
1143 ofproto_port_del(struct ofproto
*ofproto
, uint16_t ofp_port
)
1145 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1146 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
1149 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
1150 if (!error
&& ofport
) {
1151 /* 'name' is the netdev's name and update_port() is going to close the
1152 * netdev. Just in case update_port() refers to 'name' after it
1153 * destroys 'ofport', make a copy of it around the update_port()
1155 char *devname
= xstrdup(name
);
1156 update_port(ofproto
, devname
);
1162 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1163 * performs the 'n_actions' actions in 'actions'. The new flow will not
1166 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1167 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1168 * controllers; otherwise, it will be hidden.
1170 * The caller retains ownership of 'cls_rule' and 'actions'.
1172 * This is a helper function for in-band control and fail-open. */
1174 ofproto_add_flow(struct ofproto
*ofproto
, const struct cls_rule
*cls_rule
,
1175 const union ofp_action
*actions
, size_t n_actions
)
1177 const struct rule
*rule
;
1179 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
1180 &ofproto
->tables
[0], cls_rule
));
1181 if (!rule
|| !ofputil_actions_equal(rule
->actions
, rule
->n_actions
,
1182 actions
, n_actions
)) {
1183 struct ofputil_flow_mod fm
;
1185 memset(&fm
, 0, sizeof fm
);
1187 fm
.buffer_id
= UINT32_MAX
;
1188 fm
.actions
= (union ofp_action
*) actions
;
1189 fm
.n_actions
= n_actions
;
1190 add_flow(ofproto
, NULL
, &fm
, NULL
);
1194 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1195 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1196 * operation cannot be initiated now but may be retried later.
1198 * This is a helper function for in-band control and fail-open. */
1200 ofproto_flow_mod(struct ofproto
*ofproto
, const struct ofputil_flow_mod
*fm
)
1202 return handle_flow_mod__(ofproto
, NULL
, fm
, NULL
);
1205 /* Searches for a rule with matching criteria exactly equal to 'target' in
1206 * ofproto's table 0 and, if it finds one, deletes it.
1208 * This is a helper function for in-band control and fail-open. */
1210 ofproto_delete_flow(struct ofproto
*ofproto
, const struct cls_rule
*target
)
1214 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
1215 &ofproto
->tables
[0], target
));
1217 /* No such rule -> success. */
1219 } else if (rule
->pending
) {
1220 /* An operation on the rule is already pending -> failure.
1221 * Caller must retry later if it's important. */
1224 /* Initiate deletion -> success. */
1225 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
1226 ofoperation_create(group
, rule
, OFOPERATION_DELETE
);
1227 classifier_remove(&ofproto
->tables
[rule
->table_id
], &rule
->cr
);
1228 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
1229 ofopgroup_submit(group
);
1235 /* Starts the process of deleting all of the flows from all of ofproto's flow
1236 * tables and then reintroducing the flows required by in-band control and
1237 * fail-open. The process will complete in a later call to ofproto_run(). */
1239 ofproto_flush_flows(struct ofproto
*ofproto
)
1241 COVERAGE_INC(ofproto_flush
);
1242 ofproto
->state
= S_FLUSH
;
1246 reinit_ports(struct ofproto
*p
)
1248 struct ofproto_port_dump dump
;
1249 struct sset devnames
;
1250 struct ofport
*ofport
;
1251 struct ofproto_port ofproto_port
;
1252 const char *devname
;
1254 COVERAGE_INC(ofproto_reinit_ports
);
1256 sset_init(&devnames
);
1257 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1258 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1260 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
1261 sset_add(&devnames
, ofproto_port
.name
);
1264 SSET_FOR_EACH (devname
, &devnames
) {
1265 update_port(p
, devname
);
1267 sset_destroy(&devnames
);
1270 /* Opens and returns a netdev for 'ofproto_port', or a null pointer if the
1271 * netdev cannot be opened. On success, also fills in 'opp'. */
1272 static struct netdev
*
1273 ofport_open(const struct ofproto_port
*ofproto_port
, struct ofp_phy_port
*opp
)
1275 uint32_t curr
, advertised
, supported
, peer
;
1276 enum netdev_flags flags
;
1277 struct netdev
*netdev
;
1280 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
1282 VLOG_WARN_RL(&rl
, "ignoring port %s (%"PRIu16
") because netdev %s "
1283 "cannot be opened (%s)",
1284 ofproto_port
->name
, ofproto_port
->ofp_port
,
1285 ofproto_port
->name
, strerror(error
));
1289 netdev_get_flags(netdev
, &flags
);
1290 netdev_get_features(netdev
, &curr
, &advertised
, &supported
, &peer
);
1292 opp
->port_no
= htons(ofproto_port
->ofp_port
);
1293 netdev_get_etheraddr(netdev
, opp
->hw_addr
);
1294 ovs_strzcpy(opp
->name
, ofproto_port
->name
, sizeof opp
->name
);
1295 opp
->config
= flags
& NETDEV_UP
? 0 : htonl(OFPPC_PORT_DOWN
);
1296 opp
->state
= netdev_get_carrier(netdev
) ? 0 : htonl(OFPPS_LINK_DOWN
);
1297 opp
->curr
= htonl(curr
);
1298 opp
->advertised
= htonl(advertised
);
1299 opp
->supported
= htonl(supported
);
1300 opp
->peer
= htonl(peer
);
1305 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1306 * port number, and 'config' bits other than OFPPC_PORT_DOWN are
1309 ofport_equal(const struct ofp_phy_port
*a
, const struct ofp_phy_port
*b
)
1311 BUILD_ASSERT_DECL(sizeof *a
== 48); /* Detect ofp_phy_port changes. */
1312 return (!memcmp(a
->hw_addr
, b
->hw_addr
, sizeof a
->hw_addr
)
1313 && a
->state
== b
->state
1314 && !((a
->config
^ b
->config
) & htonl(OFPPC_PORT_DOWN
))
1315 && a
->curr
== b
->curr
1316 && a
->advertised
== b
->advertised
1317 && a
->supported
== b
->supported
1318 && a
->peer
== b
->peer
);
1321 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1322 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1323 * one with the same name or port number). */
1325 ofport_install(struct ofproto
*p
,
1326 struct netdev
*netdev
, const struct ofp_phy_port
*opp
)
1328 const char *netdev_name
= netdev_get_name(netdev
);
1329 struct ofport
*ofport
;
1333 /* Create ofport. */
1334 ofport
= p
->ofproto_class
->port_alloc();
1339 ofport
->ofproto
= p
;
1340 ofport
->netdev
= netdev
;
1341 ofport
->change_seq
= netdev_change_seq(netdev
);
1343 ofport
->ofp_port
= ntohs(opp
->port_no
);
1345 /* Add port to 'p'. */
1346 hmap_insert(&p
->ports
, &ofport
->hmap_node
, hash_int(ofport
->ofp_port
, 0));
1347 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
1349 if (!netdev_get_mtu(netdev
, &dev_mtu
)) {
1350 set_internal_devs_mtu(p
);
1351 ofport
->mtu
= dev_mtu
;
1356 /* Let the ofproto_class initialize its private data. */
1357 error
= p
->ofproto_class
->port_construct(ofport
);
1361 connmgr_send_port_status(p
->connmgr
, opp
, OFPPR_ADD
);
1365 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
1366 p
->name
, netdev_name
, strerror(error
));
1368 ofport_destroy__(ofport
);
1370 netdev_close(netdev
);
1374 /* Removes 'ofport' from 'p' and destroys it. */
1376 ofport_remove(struct ofport
*ofport
)
1378 connmgr_send_port_status(ofport
->ofproto
->connmgr
, &ofport
->opp
,
1380 ofport_destroy(ofport
);
1383 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1386 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
1388 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
1390 ofport_remove(port
);
1394 /* Updates 'port' with new 'opp' description.
1396 * Does not handle a name or port number change. The caller must implement
1397 * such a change as a delete followed by an add. */
1399 ofport_modified(struct ofport
*port
, struct ofp_phy_port
*opp
)
1401 memcpy(port
->opp
.hw_addr
, opp
->hw_addr
, ETH_ADDR_LEN
);
1402 port
->opp
.config
= ((port
->opp
.config
& ~htonl(OFPPC_PORT_DOWN
))
1403 | (opp
->config
& htonl(OFPPC_PORT_DOWN
)));
1404 port
->opp
.state
= opp
->state
;
1405 port
->opp
.curr
= opp
->curr
;
1406 port
->opp
.advertised
= opp
->advertised
;
1407 port
->opp
.supported
= opp
->supported
;
1408 port
->opp
.peer
= opp
->peer
;
1410 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->opp
, OFPPR_MODIFY
);
1413 /* Update OpenFlow 'state' in 'port' and notify controller. */
1415 ofproto_port_set_state(struct ofport
*port
, ovs_be32 state
)
1417 if (port
->opp
.state
!= state
) {
1418 port
->opp
.state
= state
;
1419 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->opp
,
1425 ofproto_port_unregister(struct ofproto
*ofproto
, uint16_t ofp_port
)
1427 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
1429 if (port
->ofproto
->ofproto_class
->set_realdev
) {
1430 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
1432 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
1433 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
1435 if (port
->ofproto
->ofproto_class
->set_cfm
) {
1436 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
1438 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
1439 port
->ofproto
->ofproto_class
->bundle_remove(port
);
1445 ofport_destroy__(struct ofport
*port
)
1447 struct ofproto
*ofproto
= port
->ofproto
;
1448 const char *name
= netdev_get_name(port
->netdev
);
1450 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
1451 shash_delete(&ofproto
->port_by_name
,
1452 shash_find(&ofproto
->port_by_name
, name
));
1454 netdev_close(port
->netdev
);
1455 ofproto
->ofproto_class
->port_dealloc(port
);
1459 ofport_destroy(struct ofport
*port
)
1462 port
->ofproto
->ofproto_class
->port_destruct(port
);
1463 ofport_destroy__(port
);
1468 ofproto_get_port(const struct ofproto
*ofproto
, uint16_t ofp_port
)
1470 struct ofport
*port
;
1472 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
,
1473 hash_int(ofp_port
, 0), &ofproto
->ports
) {
1474 if (port
->ofp_port
== ofp_port
) {
1482 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
1484 struct ofproto
*ofproto
= port
->ofproto
;
1487 if (ofproto
->ofproto_class
->port_get_stats
) {
1488 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
1497 update_port(struct ofproto
*ofproto
, const char *name
)
1499 struct ofproto_port ofproto_port
;
1500 struct ofp_phy_port opp
;
1501 struct netdev
*netdev
;
1502 struct ofport
*port
;
1504 COVERAGE_INC(ofproto_update_port
);
1506 /* Fetch 'name''s location and properties from the datapath. */
1507 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
1508 ? ofport_open(&ofproto_port
, &opp
)
1511 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
1512 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
1513 struct netdev
*old_netdev
= port
->netdev
;
1516 /* 'name' hasn't changed location. Any properties changed? */
1517 if (!ofport_equal(&port
->opp
, &opp
)) {
1518 ofport_modified(port
, &opp
);
1521 /* If this is a non-internal port and the MTU changed, check
1522 * if the datapath's MTU needs to be updated. */
1523 if (strcmp(netdev_get_type(netdev
), "internal")
1524 && !netdev_get_mtu(netdev
, &dev_mtu
)
1525 && port
->mtu
!= dev_mtu
) {
1526 set_internal_devs_mtu(ofproto
);
1527 port
->mtu
= dev_mtu
;
1530 /* Install the newly opened netdev in case it has changed.
1531 * Don't close the old netdev yet in case port_modified has to
1532 * remove a retained reference to it.*/
1533 port
->netdev
= netdev
;
1534 port
->change_seq
= netdev_change_seq(netdev
);
1536 if (port
->ofproto
->ofproto_class
->port_modified
) {
1537 port
->ofproto
->ofproto_class
->port_modified(port
);
1540 netdev_close(old_netdev
);
1542 /* If 'port' is nonnull then its name differs from 'name' and thus
1543 * we should delete it. If we think there's a port named 'name'
1544 * then its port number must be wrong now so delete it too. */
1546 ofport_remove(port
);
1548 ofport_remove_with_name(ofproto
, name
);
1549 ofport_install(ofproto
, netdev
, &opp
);
1552 /* Any port named 'name' is gone now. */
1553 ofport_remove_with_name(ofproto
, name
);
1555 ofproto_port_destroy(&ofproto_port
);
1559 init_ports(struct ofproto
*p
)
1561 struct ofproto_port_dump dump
;
1562 struct ofproto_port ofproto_port
;
1564 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
1565 uint16_t ofp_port
= ofproto_port
.ofp_port
;
1566 if (ofproto_get_port(p
, ofp_port
)) {
1567 VLOG_WARN_RL(&rl
, "ignoring duplicate port %"PRIu16
" in datapath",
1569 } else if (shash_find(&p
->port_by_name
, ofproto_port
.name
)) {
1570 VLOG_WARN_RL(&rl
, "ignoring duplicate device %s in datapath",
1573 struct ofp_phy_port opp
;
1574 struct netdev
*netdev
;
1576 netdev
= ofport_open(&ofproto_port
, &opp
);
1578 ofport_install(p
, netdev
, &opp
);
1586 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1587 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1589 find_min_mtu(struct ofproto
*p
)
1591 struct ofport
*ofport
;
1594 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1595 struct netdev
*netdev
= ofport
->netdev
;
1598 /* Skip any internal ports, since that's what we're trying to
1600 if (!strcmp(netdev_get_type(netdev
), "internal")) {
1604 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
1607 if (!mtu
|| dev_mtu
< mtu
) {
1612 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
1615 /* Set the MTU of all datapath devices on 'p' to the minimum of the
1616 * non-datapath ports. */
1618 set_internal_devs_mtu(struct ofproto
*p
)
1620 struct ofport
*ofport
;
1621 int mtu
= find_min_mtu(p
);
1623 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1624 struct netdev
*netdev
= ofport
->netdev
;
1626 if (!strcmp(netdev_get_type(netdev
), "internal")) {
1627 netdev_set_mtu(netdev
, mtu
);
1633 ofproto_rule_destroy__(struct rule
*rule
)
1635 free(rule
->actions
);
1636 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
1639 /* This function allows an ofproto implementation to destroy any rules that
1640 * remain when its ->destruct() function is called. The caller must have
1641 * already uninitialized any derived members of 'rule' (step 5 described in the
1642 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
1643 * This function implements steps 6 and 7.
1645 * This function should only be called from an ofproto implementation's
1646 * ->destruct() function. It is not suitable elsewhere. */
1648 ofproto_rule_destroy(struct rule
*rule
)
1650 assert(!rule
->pending
);
1651 classifier_remove(&rule
->ofproto
->tables
[rule
->table_id
], &rule
->cr
);
1652 ofproto_rule_destroy__(rule
);
1655 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
1656 * that outputs to 'out_port' (output to OFPP_FLOOD and OFPP_ALL doesn't
1659 rule_has_out_port(const struct rule
*rule
, uint16_t out_port
)
1661 const union ofp_action
*oa
;
1664 if (out_port
== OFPP_NONE
) {
1667 OFPUTIL_ACTION_FOR_EACH_UNSAFE (oa
, left
, rule
->actions
, rule
->n_actions
) {
1668 if (action_outputs_to_port(oa
, htons(out_port
))) {
1675 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
1676 * statistics appropriately. 'packet' must have at least sizeof(struct
1677 * ofp_packet_in) bytes of headroom.
1679 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
1680 * with statistics for 'packet' either way.
1682 * Takes ownership of 'packet'. */
1684 rule_execute(struct rule
*rule
, uint16_t in_port
, struct ofpbuf
*packet
)
1688 assert(ofpbuf_headroom(packet
) >= sizeof(struct ofp_packet_in
));
1690 flow_extract(packet
, 0, 0, in_port
, &flow
);
1691 return rule
->ofproto
->ofproto_class
->rule_execute(rule
, &flow
, packet
);
1694 /* Returns true if 'rule' should be hidden from the controller.
1696 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1697 * (e.g. by in-band control) and are intentionally hidden from the
1700 rule_is_hidden(const struct rule
*rule
)
1702 return rule
->cr
.priority
> UINT16_MAX
;
1706 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
1708 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
1713 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
1715 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
1716 struct ofp_switch_features
*osf
;
1718 struct ofport
*port
;
1722 ofproto
->ofproto_class
->get_features(ofproto
, &arp_match_ip
, &actions
);
1723 assert(actions
& (1 << OFPAT_OUTPUT
)); /* sanity check */
1725 osf
= make_openflow_xid(sizeof *osf
, OFPT_FEATURES_REPLY
, oh
->xid
, &buf
);
1726 osf
->datapath_id
= htonll(ofproto
->datapath_id
);
1727 osf
->n_buffers
= htonl(pktbuf_capacity());
1728 osf
->n_tables
= ofproto
->n_tables
;
1729 osf
->capabilities
= htonl(OFPC_FLOW_STATS
| OFPC_TABLE_STATS
|
1730 OFPC_PORT_STATS
| OFPC_QUEUE_STATS
);
1732 osf
->capabilities
|= htonl(OFPC_ARP_MATCH_IP
);
1734 osf
->actions
= htonl(actions
);
1736 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
1737 ofpbuf_put(buf
, &port
->opp
, sizeof port
->opp
);
1740 ofconn_send_reply(ofconn
, buf
);
1745 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
1747 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
1748 struct ofp_switch_config
*osc
;
1752 osc
= make_openflow_xid(sizeof *osc
, OFPT_GET_CONFIG_REPLY
, oh
->xid
, &buf
);
1753 osc
->flags
= htons(ofproto
->frag_handling
);
1754 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
1755 ofconn_send_reply(ofconn
, buf
);
1761 handle_set_config(struct ofconn
*ofconn
, const struct ofp_switch_config
*osc
)
1763 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
1764 uint16_t flags
= ntohs(osc
->flags
);
1766 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
1767 || ofconn_get_role(ofconn
) != NX_ROLE_SLAVE
) {
1768 enum ofp_config_flags cur
= ofproto
->frag_handling
;
1769 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
1771 assert((cur
& OFPC_FRAG_MASK
) == cur
);
1773 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
1774 ofproto
->frag_handling
= next
;
1776 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
1778 ofputil_frag_handling_to_string(next
));
1783 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
1788 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
1789 * error message code for the caller to propagate upward. Otherwise, returns
1792 * The log message mentions 'msg_type'. */
1794 reject_slave_controller(struct ofconn
*ofconn
)
1796 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
1797 && ofconn_get_role(ofconn
) == NX_ROLE_SLAVE
) {
1798 return OFPERR_OFPBRC_EPERM
;
1805 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
1807 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
1808 struct ofp_packet_out
*opo
;
1809 struct ofpbuf payload
, *buffer
;
1810 union ofp_action
*ofp_actions
;
1811 struct ofpbuf request
;
1813 size_t n_ofp_actions
;
1817 COVERAGE_INC(ofproto_packet_out
);
1819 error
= reject_slave_controller(ofconn
);
1824 /* Get ofp_packet_out. */
1825 ofpbuf_use_const(&request
, oh
, ntohs(oh
->length
));
1826 opo
= ofpbuf_pull(&request
, offsetof(struct ofp_packet_out
, actions
));
1829 error
= ofputil_pull_actions(&request
, ntohs(opo
->actions_len
),
1830 &ofp_actions
, &n_ofp_actions
);
1836 if (opo
->buffer_id
!= htonl(UINT32_MAX
)) {
1837 error
= ofconn_pktbuf_retrieve(ofconn
, ntohl(opo
->buffer_id
),
1839 if (error
|| !buffer
) {
1848 /* Get in_port and partially validate it.
1850 * We don't know what range of ports the ofproto actually implements, but
1851 * we do know that only certain reserved ports (numbered OFPP_MAX and
1852 * above) are valid. */
1853 in_port
= ntohs(opo
->in_port
);
1854 if (in_port
>= OFPP_MAX
&& in_port
!= OFPP_LOCAL
&& in_port
!= OFPP_NONE
) {
1855 return OFPERR_NXBRC_BAD_IN_PORT
;
1858 /* Send out packet. */
1859 flow_extract(&payload
, 0, 0, in_port
, &flow
);
1860 error
= p
->ofproto_class
->packet_out(p
, &payload
, &flow
,
1861 ofp_actions
, n_ofp_actions
);
1862 ofpbuf_delete(buffer
);
1868 update_port_config(struct ofport
*port
, ovs_be32 config
, ovs_be32 mask
)
1870 ovs_be32 old_config
= port
->opp
.config
;
1872 mask
&= config
^ port
->opp
.config
;
1873 if (mask
& htonl(OFPPC_PORT_DOWN
)) {
1874 if (config
& htonl(OFPPC_PORT_DOWN
)) {
1875 netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, true);
1877 netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, true);
1881 port
->opp
.config
^= mask
& (htonl(OFPPC_NO_RECV
| OFPPC_NO_RECV_STP
|
1882 OFPPC_NO_FLOOD
| OFPPC_NO_FWD
|
1883 OFPPC_NO_PACKET_IN
));
1884 if (port
->opp
.config
!= old_config
) {
1885 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
1890 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
1892 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
1893 const struct ofp_port_mod
*opm
= (const struct ofp_port_mod
*) oh
;
1894 struct ofport
*port
;
1897 error
= reject_slave_controller(ofconn
);
1902 port
= ofproto_get_port(p
, ntohs(opm
->port_no
));
1904 return OFPERR_OFPPMFC_BAD_PORT
;
1905 } else if (memcmp(port
->opp
.hw_addr
, opm
->hw_addr
, OFP_ETH_ALEN
)) {
1906 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
1908 update_port_config(port
, opm
->config
, opm
->mask
);
1909 if (opm
->advertise
) {
1910 netdev_set_advertisements(port
->netdev
, ntohl(opm
->advertise
));
1917 handle_desc_stats_request(struct ofconn
*ofconn
,
1918 const struct ofp_stats_msg
*request
)
1920 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
1921 struct ofp_desc_stats
*ods
;
1924 ods
= ofputil_make_stats_reply(sizeof *ods
, request
, &msg
);
1925 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
, sizeof ods
->mfr_desc
);
1926 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
, sizeof ods
->hw_desc
);
1927 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
, sizeof ods
->sw_desc
);
1928 ovs_strlcpy(ods
->serial_num
, p
->serial_desc
, sizeof ods
->serial_num
);
1929 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
, sizeof ods
->dp_desc
);
1930 ofconn_send_reply(ofconn
, msg
);
1936 handle_table_stats_request(struct ofconn
*ofconn
,
1937 const struct ofp_stats_msg
*request
)
1939 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
1940 struct ofp_table_stats
*ots
;
1944 ofputil_make_stats_reply(sizeof(struct ofp_stats_msg
), request
, &msg
);
1946 ots
= ofpbuf_put_zeros(msg
, sizeof *ots
* p
->n_tables
);
1947 for (i
= 0; i
< p
->n_tables
; i
++) {
1948 ots
[i
].table_id
= i
;
1949 sprintf(ots
[i
].name
, "table%zu", i
);
1950 ots
[i
].wildcards
= htonl(OFPFW_ALL
);
1951 ots
[i
].max_entries
= htonl(1000000); /* An arbitrary big number. */
1952 ots
[i
].active_count
= htonl(classifier_count(&p
->tables
[i
]));
1955 p
->ofproto_class
->get_tables(p
, ots
);
1957 ofconn_send_reply(ofconn
, msg
);
1962 append_port_stat(struct ofport
*port
, struct list
*replies
)
1964 struct netdev_stats stats
;
1965 struct ofp_port_stats
*ops
;
1967 /* Intentionally ignore return value, since errors will set
1968 * 'stats' to all-1s, which is correct for OpenFlow, and
1969 * netdev_get_stats() will log errors. */
1970 ofproto_port_get_stats(port
, &stats
);
1972 ops
= ofputil_append_stats_reply(sizeof *ops
, replies
);
1973 ops
->port_no
= port
->opp
.port_no
;
1974 memset(ops
->pad
, 0, sizeof ops
->pad
);
1975 put_32aligned_be64(&ops
->rx_packets
, htonll(stats
.rx_packets
));
1976 put_32aligned_be64(&ops
->tx_packets
, htonll(stats
.tx_packets
));
1977 put_32aligned_be64(&ops
->rx_bytes
, htonll(stats
.rx_bytes
));
1978 put_32aligned_be64(&ops
->tx_bytes
, htonll(stats
.tx_bytes
));
1979 put_32aligned_be64(&ops
->rx_dropped
, htonll(stats
.rx_dropped
));
1980 put_32aligned_be64(&ops
->tx_dropped
, htonll(stats
.tx_dropped
));
1981 put_32aligned_be64(&ops
->rx_errors
, htonll(stats
.rx_errors
));
1982 put_32aligned_be64(&ops
->tx_errors
, htonll(stats
.tx_errors
));
1983 put_32aligned_be64(&ops
->rx_frame_err
, htonll(stats
.rx_frame_errors
));
1984 put_32aligned_be64(&ops
->rx_over_err
, htonll(stats
.rx_over_errors
));
1985 put_32aligned_be64(&ops
->rx_crc_err
, htonll(stats
.rx_crc_errors
));
1986 put_32aligned_be64(&ops
->collisions
, htonll(stats
.collisions
));
1990 handle_port_stats_request(struct ofconn
*ofconn
,
1991 const struct ofp_port_stats_request
*psr
)
1993 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
1994 struct ofport
*port
;
1995 struct list replies
;
1997 ofputil_start_stats_reply(&psr
->osm
, &replies
);
1998 if (psr
->port_no
!= htons(OFPP_NONE
)) {
1999 port
= ofproto_get_port(p
, ntohs(psr
->port_no
));
2001 append_port_stat(port
, &replies
);
2004 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
2005 append_port_stat(port
, &replies
);
2009 ofconn_send_replies(ofconn
, &replies
);
2014 calc_flow_duration__(long long int start
, uint32_t *sec
, uint32_t *nsec
)
2016 long long int msecs
= time_msec() - start
;
2017 *sec
= msecs
/ 1000;
2018 *nsec
= (msecs
% 1000) * (1000 * 1000);
2021 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2022 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2024 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
2026 return (table_id
== 0xff || table_id
< ofproto
->n_tables
2028 : OFPERR_NXBRC_BAD_TABLE_ID
);
2032 static struct classifier
*
2033 first_matching_table(struct ofproto
*ofproto
, uint8_t table_id
)
2035 if (table_id
== 0xff) {
2036 return &ofproto
->tables
[0];
2037 } else if (table_id
< ofproto
->n_tables
) {
2038 return &ofproto
->tables
[table_id
];
2044 static struct classifier
*
2045 next_matching_table(struct ofproto
*ofproto
,
2046 struct classifier
*cls
, uint8_t table_id
)
2048 return (table_id
== 0xff && cls
!= &ofproto
->tables
[ofproto
->n_tables
- 1]
2053 /* Assigns CLS to each classifier table, in turn, that matches TABLE_ID in
2056 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2059 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2060 * only once, for that table.
2062 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2063 * entered at all. (Perhaps you should have validated TABLE_ID with
2064 * check_table_id().)
2066 * All parameters are evaluated multiple times.
2068 #define FOR_EACH_MATCHING_TABLE(CLS, TABLE_ID, OFPROTO) \
2069 for ((CLS) = first_matching_table(OFPROTO, TABLE_ID); \
2071 (CLS) = next_matching_table(OFPROTO, CLS, TABLE_ID))
2073 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2074 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2075 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2078 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2079 * to 'out_port' are included.
2081 * Hidden rules are always omitted.
2083 * Returns 0 on success, otherwise an OpenFlow error code. */
2085 collect_rules_loose(struct ofproto
*ofproto
, uint8_t table_id
,
2086 const struct cls_rule
*match
,
2087 ovs_be64 cookie
, ovs_be64 cookie_mask
,
2088 uint16_t out_port
, struct list
*rules
)
2090 struct classifier
*cls
;
2093 error
= check_table_id(ofproto
, table_id
);
2099 FOR_EACH_MATCHING_TABLE (cls
, table_id
, ofproto
) {
2100 struct cls_cursor cursor
;
2103 cls_cursor_init(&cursor
, cls
, match
);
2104 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
2105 if (rule
->pending
) {
2106 return OFPROTO_POSTPONE
;
2108 if (!rule_is_hidden(rule
) && rule_has_out_port(rule
, out_port
)
2109 && !((rule
->flow_cookie
^ cookie
) & cookie_mask
)) {
2110 list_push_back(rules
, &rule
->ofproto_node
);
2117 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2118 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2119 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2122 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2123 * to 'out_port' are included.
2125 * Hidden rules are always omitted.
2127 * Returns 0 on success, otherwise an OpenFlow error code. */
2129 collect_rules_strict(struct ofproto
*ofproto
, uint8_t table_id
,
2130 const struct cls_rule
*match
,
2131 ovs_be64 cookie
, ovs_be64 cookie_mask
,
2132 uint16_t out_port
, struct list
*rules
)
2134 struct classifier
*cls
;
2137 error
= check_table_id(ofproto
, table_id
);
2143 FOR_EACH_MATCHING_TABLE (cls
, table_id
, ofproto
) {
2146 rule
= rule_from_cls_rule(classifier_find_rule_exactly(cls
, match
));
2148 if (rule
->pending
) {
2149 return OFPROTO_POSTPONE
;
2151 if (!rule_is_hidden(rule
) && rule_has_out_port(rule
, out_port
)
2152 && !((rule
->flow_cookie
^ cookie
) & cookie_mask
)) {
2153 list_push_back(rules
, &rule
->ofproto_node
);
2161 handle_flow_stats_request(struct ofconn
*ofconn
,
2162 const struct ofp_stats_msg
*osm
)
2164 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2165 struct ofputil_flow_stats_request fsr
;
2166 struct list replies
;
2171 error
= ofputil_decode_flow_stats_request(&fsr
, &osm
->header
);
2176 error
= collect_rules_loose(ofproto
, fsr
.table_id
, &fsr
.match
,
2177 fsr
.cookie
, fsr
.cookie_mask
,
2178 fsr
.out_port
, &rules
);
2183 ofputil_start_stats_reply(osm
, &replies
);
2184 LIST_FOR_EACH (rule
, ofproto_node
, &rules
) {
2185 struct ofputil_flow_stats fs
;
2188 fs
.cookie
= rule
->flow_cookie
;
2189 fs
.table_id
= rule
->table_id
;
2190 calc_flow_duration__(rule
->created
, &fs
.duration_sec
,
2192 fs
.idle_timeout
= rule
->idle_timeout
;
2193 fs
.hard_timeout
= rule
->hard_timeout
;
2194 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
2196 fs
.actions
= rule
->actions
;
2197 fs
.n_actions
= rule
->n_actions
;
2198 ofputil_append_flow_stats_reply(&fs
, &replies
);
2200 ofconn_send_replies(ofconn
, &replies
);
2206 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
2208 uint64_t packet_count
, byte_count
;
2210 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
,
2211 &packet_count
, &byte_count
);
2213 if (rule
->table_id
!= 0) {
2214 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
2216 ds_put_format(results
, "duration=%llds, ",
2217 (time_msec() - rule
->created
) / 1000);
2218 ds_put_format(results
, "priority=%u, ", rule
->cr
.priority
);
2219 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
2220 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
2221 cls_rule_format(&rule
->cr
, results
);
2222 ds_put_char(results
, ',');
2223 if (rule
->n_actions
> 0) {
2224 ofp_print_actions(results
, rule
->actions
, rule
->n_actions
);
2226 ds_put_cstr(results
, "drop");
2228 ds_put_cstr(results
, "\n");
2231 /* Adds a pretty-printed description of all flows to 'results', including
2232 * hidden flows (e.g., set up by in-band control). */
2234 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
2236 struct classifier
*cls
;
2238 OFPROTO_FOR_EACH_TABLE (cls
, p
) {
2239 struct cls_cursor cursor
;
2242 cls_cursor_init(&cursor
, cls
, NULL
);
2243 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
2244 flow_stats_ds(rule
, results
);
2249 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2250 * '*engine_type' and '*engine_id', respectively. */
2252 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
2253 uint8_t *engine_type
, uint8_t *engine_id
)
2255 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
2258 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns 1
2259 * if CFM is faulted (generally indiciating a connectivity problem), 0 if CFM
2260 * is not faulted, and -1 if CFM is not enabled on 'ofp_port'. */
2262 ofproto_port_get_cfm_fault(const struct ofproto
*ofproto
, uint16_t ofp_port
)
2264 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2265 return (ofport
&& ofproto
->ofproto_class
->get_cfm_fault
2266 ? ofproto
->ofproto_class
->get_cfm_fault(ofport
)
2270 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2271 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2272 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2273 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2275 ofproto_port_get_cfm_remote_mpids(const struct ofproto
*ofproto
,
2276 uint16_t ofp_port
, const uint64_t **rmps
,
2279 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2283 return (ofport
&& ofproto
->ofproto_class
->get_cfm_remote_mpids
2284 ? ofproto
->ofproto_class
->get_cfm_remote_mpids(ofport
, rmps
,
2290 handle_aggregate_stats_request(struct ofconn
*ofconn
,
2291 const struct ofp_stats_msg
*osm
)
2293 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2294 struct ofputil_flow_stats_request request
;
2295 struct ofputil_aggregate_stats stats
;
2296 bool unknown_packets
, unknown_bytes
;
2297 struct ofpbuf
*reply
;
2302 error
= ofputil_decode_flow_stats_request(&request
, &osm
->header
);
2307 error
= collect_rules_loose(ofproto
, request
.table_id
, &request
.match
,
2308 request
.cookie
, request
.cookie_mask
,
2309 request
.out_port
, &rules
);
2314 memset(&stats
, 0, sizeof stats
);
2315 unknown_packets
= unknown_bytes
= false;
2316 LIST_FOR_EACH (rule
, ofproto_node
, &rules
) {
2317 uint64_t packet_count
;
2318 uint64_t byte_count
;
2320 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
2323 if (packet_count
== UINT64_MAX
) {
2324 unknown_packets
= true;
2326 stats
.packet_count
+= packet_count
;
2329 if (byte_count
== UINT64_MAX
) {
2330 unknown_bytes
= true;
2332 stats
.byte_count
+= byte_count
;
2337 if (unknown_packets
) {
2338 stats
.packet_count
= UINT64_MAX
;
2340 if (unknown_bytes
) {
2341 stats
.byte_count
= UINT64_MAX
;
2344 reply
= ofputil_encode_aggregate_stats_reply(&stats
, osm
);
2345 ofconn_send_reply(ofconn
, reply
);
2350 struct queue_stats_cbdata
{
2351 struct ofport
*ofport
;
2352 struct list replies
;
2356 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
2357 const struct netdev_queue_stats
*stats
)
2359 struct ofp_queue_stats
*reply
;
2361 reply
= ofputil_append_stats_reply(sizeof *reply
, &cbdata
->replies
);
2362 reply
->port_no
= cbdata
->ofport
->opp
.port_no
;
2363 memset(reply
->pad
, 0, sizeof reply
->pad
);
2364 reply
->queue_id
= htonl(queue_id
);
2365 put_32aligned_be64(&reply
->tx_bytes
, htonll(stats
->tx_bytes
));
2366 put_32aligned_be64(&reply
->tx_packets
, htonll(stats
->tx_packets
));
2367 put_32aligned_be64(&reply
->tx_errors
, htonll(stats
->tx_errors
));
2371 handle_queue_stats_dump_cb(uint32_t queue_id
,
2372 struct netdev_queue_stats
*stats
,
2375 struct queue_stats_cbdata
*cbdata
= cbdata_
;
2377 put_queue_stats(cbdata
, queue_id
, stats
);
2381 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
2382 struct queue_stats_cbdata
*cbdata
)
2384 cbdata
->ofport
= port
;
2385 if (queue_id
== OFPQ_ALL
) {
2386 netdev_dump_queue_stats(port
->netdev
,
2387 handle_queue_stats_dump_cb
, cbdata
);
2389 struct netdev_queue_stats stats
;
2391 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
2392 put_queue_stats(cbdata
, queue_id
, &stats
);
2398 handle_queue_stats_request(struct ofconn
*ofconn
,
2399 const struct ofp_queue_stats_request
*qsr
)
2401 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2402 struct queue_stats_cbdata cbdata
;
2403 struct ofport
*port
;
2404 unsigned int port_no
;
2407 COVERAGE_INC(ofproto_queue_req
);
2409 ofputil_start_stats_reply(&qsr
->osm
, &cbdata
.replies
);
2411 port_no
= ntohs(qsr
->port_no
);
2412 queue_id
= ntohl(qsr
->queue_id
);
2413 if (port_no
== OFPP_ALL
) {
2414 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
2415 handle_queue_stats_for_port(port
, queue_id
, &cbdata
);
2417 } else if (port_no
< OFPP_MAX
) {
2418 port
= ofproto_get_port(ofproto
, port_no
);
2420 handle_queue_stats_for_port(port
, queue_id
, &cbdata
);
2423 ofpbuf_list_delete(&cbdata
.replies
);
2424 return OFPERR_OFPQOFC_BAD_PORT
;
2426 ofconn_send_replies(ofconn
, &cbdata
.replies
);
2432 is_flow_deletion_pending(const struct ofproto
*ofproto
,
2433 const struct cls_rule
*cls_rule
,
2436 if (!hmap_is_empty(&ofproto
->deletions
)) {
2437 struct ofoperation
*op
;
2439 HMAP_FOR_EACH_WITH_HASH (op
, hmap_node
,
2440 cls_rule_hash(cls_rule
, table_id
),
2441 &ofproto
->deletions
) {
2442 if (cls_rule_equal(cls_rule
, &op
->rule
->cr
)) {
2451 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2452 * in which no matching flow already exists in the flow table.
2454 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2455 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
2456 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
2457 * initiated now but may be retried later.
2459 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2462 add_flow(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
2463 const struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
)
2465 struct classifier
*table
;
2466 struct ofopgroup
*group
;
2467 struct rule
*victim
;
2471 error
= check_table_id(ofproto
, fm
->table_id
);
2477 if (fm
->table_id
== 0xff) {
2479 if (ofproto
->ofproto_class
->rule_choose_table
) {
2480 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
, &fm
->cr
,
2485 assert(table_id
< ofproto
->n_tables
);
2486 table
= &ofproto
->tables
[table_id
];
2488 table
= &ofproto
->tables
[0];
2490 } else if (fm
->table_id
< ofproto
->n_tables
) {
2491 table
= &ofproto
->tables
[fm
->table_id
];
2493 return OFPERR_NXFMFC_BAD_TABLE_ID
;
2496 /* Check for overlap, if requested. */
2497 if (fm
->flags
& OFPFF_CHECK_OVERLAP
2498 && classifier_rule_overlaps(table
, &fm
->cr
)) {
2499 return OFPERR_OFPFMFC_OVERLAP
;
2502 /* Serialize against pending deletion. */
2503 if (is_flow_deletion_pending(ofproto
, &fm
->cr
, table
- ofproto
->tables
)) {
2504 return OFPROTO_POSTPONE
;
2507 /* Allocate new rule. */
2508 rule
= ofproto
->ofproto_class
->rule_alloc();
2510 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
2511 ofproto
->name
, strerror(error
));
2514 rule
->ofproto
= ofproto
;
2516 rule
->pending
= NULL
;
2517 rule
->flow_cookie
= fm
->cookie
;
2518 rule
->created
= rule
->modified
= time_msec();
2519 rule
->idle_timeout
= fm
->idle_timeout
;
2520 rule
->hard_timeout
= fm
->hard_timeout
;
2521 rule
->table_id
= table
- ofproto
->tables
;
2522 rule
->send_flow_removed
= (fm
->flags
& OFPFF_SEND_FLOW_REM
) != 0;
2523 rule
->actions
= ofputil_actions_clone(fm
->actions
, fm
->n_actions
);
2524 rule
->n_actions
= fm
->n_actions
;
2526 /* Insert new rule. */
2527 victim
= rule_from_cls_rule(classifier_replace(table
, &rule
->cr
));
2528 if (victim
&& victim
->pending
) {
2529 error
= OFPROTO_POSTPONE
;
2531 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
2532 ofoperation_create(group
, rule
, OFOPERATION_ADD
);
2533 rule
->pending
->victim
= victim
;
2535 error
= ofproto
->ofproto_class
->rule_construct(rule
);
2537 ofoperation_destroy(rule
->pending
);
2539 ofopgroup_submit(group
);
2542 /* Back out if an error occurred. */
2545 classifier_replace(table
, &victim
->cr
);
2547 classifier_remove(table
, &rule
->cr
);
2549 ofproto_rule_destroy__(rule
);
2554 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2556 /* Modifies the rules listed in 'rules', changing their actions to match those
2559 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2562 * Returns 0 on success, otherwise an OpenFlow error code. */
2564 modify_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
2565 const struct ofputil_flow_mod
*fm
,
2566 const struct ofp_header
*request
, struct list
*rules
)
2568 struct ofopgroup
*group
;
2571 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
2572 LIST_FOR_EACH (rule
, ofproto_node
, rules
) {
2573 if (!ofputil_actions_equal(fm
->actions
, fm
->n_actions
,
2574 rule
->actions
, rule
->n_actions
)) {
2575 ofoperation_create(group
, rule
, OFOPERATION_MODIFY
);
2576 rule
->pending
->actions
= rule
->actions
;
2577 rule
->pending
->n_actions
= rule
->n_actions
;
2578 rule
->actions
= ofputil_actions_clone(fm
->actions
, fm
->n_actions
);
2579 rule
->n_actions
= fm
->n_actions
;
2580 rule
->ofproto
->ofproto_class
->rule_modify_actions(rule
);
2582 rule
->modified
= time_msec();
2584 rule
->flow_cookie
= fm
->cookie
;
2586 ofopgroup_submit(group
);
2591 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
2594 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2597 modify_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
2598 const struct ofputil_flow_mod
*fm
,
2599 const struct ofp_header
*request
)
2604 error
= collect_rules_loose(ofproto
, fm
->table_id
, &fm
->cr
,
2605 fm
->cookie
, fm
->cookie_mask
,
2607 return (error
? error
2608 : list_is_empty(&rules
) ? add_flow(ofproto
, ofconn
, fm
, request
)
2609 : modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
));
2612 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
2615 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
2618 modify_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
2619 const struct ofputil_flow_mod
*fm
,
2620 const struct ofp_header
*request
)
2625 error
= collect_rules_strict(ofproto
, fm
->table_id
, &fm
->cr
,
2626 fm
->cookie
, fm
->cookie_mask
,
2628 return (error
? error
2629 : list_is_empty(&rules
) ? add_flow(ofproto
, ofconn
, fm
, request
)
2630 : list_is_singleton(&rules
) ? modify_flows__(ofproto
, ofconn
,
2631 fm
, request
, &rules
)
2635 /* OFPFC_DELETE implementation. */
2637 /* Deletes the rules listed in 'rules'.
2639 * Returns 0 on success, otherwise an OpenFlow error code. */
2641 delete_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
2642 const struct ofp_header
*request
, struct list
*rules
)
2644 struct rule
*rule
, *next
;
2645 struct ofopgroup
*group
;
2647 group
= ofopgroup_create(ofproto
, ofconn
, request
, UINT32_MAX
);
2648 LIST_FOR_EACH_SAFE (rule
, next
, ofproto_node
, rules
) {
2649 ofproto_rule_send_removed(rule
, OFPRR_DELETE
);
2651 ofoperation_create(group
, rule
, OFOPERATION_DELETE
);
2652 classifier_remove(&ofproto
->tables
[rule
->table_id
], &rule
->cr
);
2653 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2655 ofopgroup_submit(group
);
2660 /* Implements OFPFC_DELETE. */
2662 delete_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
2663 const struct ofputil_flow_mod
*fm
,
2664 const struct ofp_header
*request
)
2669 error
= collect_rules_loose(ofproto
, fm
->table_id
, &fm
->cr
,
2670 fm
->cookie
, fm
->cookie_mask
,
2671 fm
->out_port
, &rules
);
2672 return (error
? error
2673 : !list_is_empty(&rules
) ? delete_flows__(ofproto
, ofconn
, request
,
2678 /* Implements OFPFC_DELETE_STRICT. */
2680 delete_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
2681 const struct ofputil_flow_mod
*fm
,
2682 const struct ofp_header
*request
)
2687 error
= collect_rules_strict(ofproto
, fm
->table_id
, &fm
->cr
,
2688 fm
->cookie
, fm
->cookie_mask
,
2689 fm
->out_port
, &rules
);
2690 return (error
? error
2691 : list_is_singleton(&rules
) ? delete_flows__(ofproto
, ofconn
,
2697 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
2699 struct ofputil_flow_removed fr
;
2701 if (rule_is_hidden(rule
) || !rule
->send_flow_removed
) {
2706 fr
.cookie
= rule
->flow_cookie
;
2708 calc_flow_duration__(rule
->created
, &fr
.duration_sec
, &fr
.duration_nsec
);
2709 fr
.idle_timeout
= rule
->idle_timeout
;
2710 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
2713 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
2716 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
2717 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
2720 * ofproto implementation ->run() functions should use this function to expire
2721 * OpenFlow flows. */
2723 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
2725 struct ofproto
*ofproto
= rule
->ofproto
;
2726 struct ofopgroup
*group
;
2728 assert(reason
== OFPRR_HARD_TIMEOUT
|| reason
== OFPRR_IDLE_TIMEOUT
);
2730 ofproto_rule_send_removed(rule
, reason
);
2732 group
= ofopgroup_create_unattached(ofproto
);
2733 ofoperation_create(group
, rule
, OFOPERATION_DELETE
);
2734 classifier_remove(&ofproto
->tables
[rule
->table_id
], &rule
->cr
);
2735 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2736 ofopgroup_submit(group
);
2740 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2742 struct ofputil_flow_mod fm
;
2745 error
= reject_slave_controller(ofconn
);
2750 error
= ofputil_decode_flow_mod(&fm
, oh
,
2751 ofconn_get_flow_mod_table_id(ofconn
));
2756 /* We do not support the emergency flow cache. It will hopefully get
2757 * dropped from OpenFlow in the near future. */
2758 if (fm
.flags
& OFPFF_EMERG
) {
2759 /* There isn't a good fit for an error code, so just state that the
2760 * flow table is full. */
2761 return OFPERR_OFPFMFC_ALL_TABLES_FULL
;
2764 return handle_flow_mod__(ofconn_get_ofproto(ofconn
), ofconn
, &fm
, oh
);
2768 handle_flow_mod__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
2769 const struct ofputil_flow_mod
*fm
,
2770 const struct ofp_header
*oh
)
2772 if (ofproto
->n_pending
>= 50) {
2773 assert(!list_is_empty(&ofproto
->pending
));
2774 return OFPROTO_POSTPONE
;
2777 switch (fm
->command
) {
2779 return add_flow(ofproto
, ofconn
, fm
, oh
);
2782 return modify_flows_loose(ofproto
, ofconn
, fm
, oh
);
2784 case OFPFC_MODIFY_STRICT
:
2785 return modify_flow_strict(ofproto
, ofconn
, fm
, oh
);
2788 return delete_flows_loose(ofproto
, ofconn
, fm
, oh
);
2790 case OFPFC_DELETE_STRICT
:
2791 return delete_flow_strict(ofproto
, ofconn
, fm
, oh
);
2794 if (fm
->command
> 0xff) {
2795 VLOG_WARN_RL(&rl
, "flow_mod has explicit table_id but "
2796 "flow_mod_table_id extension is not enabled");
2798 return OFPERR_OFPFMFC_BAD_COMMAND
;
2803 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2805 struct nx_role_request
*nrr
= (struct nx_role_request
*) oh
;
2806 struct nx_role_request
*reply
;
2810 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
) {
2811 return OFPERR_OFPBRC_EPERM
;
2814 role
= ntohl(nrr
->role
);
2815 if (role
!= NX_ROLE_OTHER
&& role
!= NX_ROLE_MASTER
2816 && role
!= NX_ROLE_SLAVE
) {
2817 return OFPERR_NXBRC_BAD_ROLE
;
2820 if (ofconn_get_role(ofconn
) != role
2821 && ofconn_has_pending_opgroups(ofconn
)) {
2822 return OFPROTO_POSTPONE
;
2825 ofconn_set_role(ofconn
, role
);
2827 reply
= make_nxmsg_xid(sizeof *reply
, NXT_ROLE_REPLY
, oh
->xid
, &buf
);
2828 reply
->role
= htonl(role
);
2829 ofconn_send_reply(ofconn
, buf
);
2835 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
2836 const struct ofp_header
*oh
)
2838 const struct nx_flow_mod_table_id
*msg
2839 = (const struct nx_flow_mod_table_id
*) oh
;
2841 ofconn_set_flow_mod_table_id(ofconn
, msg
->set
!= 0);
2846 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2848 const struct nx_set_flow_format
*msg
2849 = (const struct nx_set_flow_format
*) oh
;
2852 format
= ntohl(msg
->format
);
2853 if (format
!= NXFF_OPENFLOW10
&& format
!= NXFF_NXM
) {
2854 return OFPERR_OFPBRC_EPERM
;
2857 if (format
!= ofconn_get_flow_format(ofconn
)
2858 && ofconn_has_pending_opgroups(ofconn
)) {
2859 /* Avoid sending async messages in surprising flow format. */
2860 return OFPROTO_POSTPONE
;
2863 ofconn_set_flow_format(ofconn
, format
);
2868 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
2869 const struct ofp_header
*oh
)
2871 const struct nx_set_packet_in_format
*msg
;
2874 msg
= (const struct nx_set_packet_in_format
*) oh
;
2875 format
= ntohl(msg
->format
);
2876 if (format
!= NXFF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
2877 return OFPERR_OFPBRC_EPERM
;
2880 if (format
!= ofconn_get_packet_in_format(ofconn
)
2881 && ofconn_has_pending_opgroups(ofconn
)) {
2882 /* Avoid sending async message in surprsing packet in format. */
2883 return OFPROTO_POSTPONE
;
2886 ofconn_set_packet_in_format(ofconn
, format
);
2891 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2893 struct ofp_header
*ob
;
2896 if (ofconn_has_pending_opgroups(ofconn
)) {
2897 return OFPROTO_POSTPONE
;
2900 ob
= make_openflow_xid(sizeof *ob
, OFPT_BARRIER_REPLY
, oh
->xid
, &buf
);
2901 ofconn_send_reply(ofconn
, buf
);
2906 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
2908 const struct ofp_header
*oh
= msg
->data
;
2909 const struct ofputil_msg_type
*type
;
2912 error
= ofputil_decode_msg_type(oh
, &type
);
2917 switch (ofputil_msg_type_code(type
)) {
2918 /* OpenFlow requests. */
2919 case OFPUTIL_OFPT_ECHO_REQUEST
:
2920 return handle_echo_request(ofconn
, oh
);
2922 case OFPUTIL_OFPT_FEATURES_REQUEST
:
2923 return handle_features_request(ofconn
, oh
);
2925 case OFPUTIL_OFPT_GET_CONFIG_REQUEST
:
2926 return handle_get_config_request(ofconn
, oh
);
2928 case OFPUTIL_OFPT_SET_CONFIG
:
2929 return handle_set_config(ofconn
, msg
->data
);
2931 case OFPUTIL_OFPT_PACKET_OUT
:
2932 return handle_packet_out(ofconn
, oh
);
2934 case OFPUTIL_OFPT_PORT_MOD
:
2935 return handle_port_mod(ofconn
, oh
);
2937 case OFPUTIL_OFPT_FLOW_MOD
:
2938 return handle_flow_mod(ofconn
, oh
);
2940 case OFPUTIL_OFPT_BARRIER_REQUEST
:
2941 return handle_barrier_request(ofconn
, oh
);
2943 /* OpenFlow replies. */
2944 case OFPUTIL_OFPT_ECHO_REPLY
:
2947 /* Nicira extension requests. */
2948 case OFPUTIL_NXT_ROLE_REQUEST
:
2949 return handle_role_request(ofconn
, oh
);
2951 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID
:
2952 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
2954 case OFPUTIL_NXT_SET_FLOW_FORMAT
:
2955 return handle_nxt_set_flow_format(ofconn
, oh
);
2957 case OFPUTIL_NXT_SET_PACKET_IN_FORMAT
:
2958 return handle_nxt_set_packet_in_format(ofconn
, oh
);
2960 case OFPUTIL_NXT_FLOW_MOD
:
2961 return handle_flow_mod(ofconn
, oh
);
2963 /* Statistics requests. */
2964 case OFPUTIL_OFPST_DESC_REQUEST
:
2965 return handle_desc_stats_request(ofconn
, msg
->data
);
2967 case OFPUTIL_OFPST_FLOW_REQUEST
:
2968 case OFPUTIL_NXST_FLOW_REQUEST
:
2969 return handle_flow_stats_request(ofconn
, msg
->data
);
2971 case OFPUTIL_OFPST_AGGREGATE_REQUEST
:
2972 case OFPUTIL_NXST_AGGREGATE_REQUEST
:
2973 return handle_aggregate_stats_request(ofconn
, msg
->data
);
2975 case OFPUTIL_OFPST_TABLE_REQUEST
:
2976 return handle_table_stats_request(ofconn
, msg
->data
);
2978 case OFPUTIL_OFPST_PORT_REQUEST
:
2979 return handle_port_stats_request(ofconn
, msg
->data
);
2981 case OFPUTIL_OFPST_QUEUE_REQUEST
:
2982 return handle_queue_stats_request(ofconn
, msg
->data
);
2984 case OFPUTIL_MSG_INVALID
:
2985 case OFPUTIL_OFPT_HELLO
:
2986 case OFPUTIL_OFPT_ERROR
:
2987 case OFPUTIL_OFPT_FEATURES_REPLY
:
2988 case OFPUTIL_OFPT_GET_CONFIG_REPLY
:
2989 case OFPUTIL_OFPT_PACKET_IN
:
2990 case OFPUTIL_OFPT_FLOW_REMOVED
:
2991 case OFPUTIL_OFPT_PORT_STATUS
:
2992 case OFPUTIL_OFPT_BARRIER_REPLY
:
2993 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST
:
2994 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY
:
2995 case OFPUTIL_OFPST_DESC_REPLY
:
2996 case OFPUTIL_OFPST_FLOW_REPLY
:
2997 case OFPUTIL_OFPST_QUEUE_REPLY
:
2998 case OFPUTIL_OFPST_PORT_REPLY
:
2999 case OFPUTIL_OFPST_TABLE_REPLY
:
3000 case OFPUTIL_OFPST_AGGREGATE_REPLY
:
3001 case OFPUTIL_NXT_ROLE_REPLY
:
3002 case OFPUTIL_NXT_FLOW_REMOVED
:
3003 case OFPUTIL_NXT_PACKET_IN
:
3004 case OFPUTIL_NXST_FLOW_REPLY
:
3005 case OFPUTIL_NXST_AGGREGATE_REPLY
:
3007 if (oh
->type
== OFPT_STATS_REQUEST
|| oh
->type
== OFPT_STATS_REPLY
) {
3008 return OFPERR_OFPBRC_BAD_STAT
;
3010 return OFPERR_OFPBRC_BAD_TYPE
;
3016 handle_openflow(struct ofconn
*ofconn
, struct ofpbuf
*ofp_msg
)
3018 int error
= handle_openflow__(ofconn
, ofp_msg
);
3019 if (error
&& error
!= OFPROTO_POSTPONE
) {
3020 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
3022 COVERAGE_INC(ofproto_recv_openflow
);
3023 return error
!= OFPROTO_POSTPONE
;
3026 /* Asynchronous operations. */
3028 /* Creates and returns a new ofopgroup that is not associated with any
3029 * OpenFlow connection.
3031 * The caller should add operations to the returned group with
3032 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3033 static struct ofopgroup
*
3034 ofopgroup_create_unattached(struct ofproto
*ofproto
)
3036 struct ofopgroup
*group
= xzalloc(sizeof *group
);
3037 group
->ofproto
= ofproto
;
3038 list_init(&group
->ofproto_node
);
3039 list_init(&group
->ops
);
3040 list_init(&group
->ofconn_node
);
3044 /* Creates and returns a new ofopgroup for 'ofproto'.
3046 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
3047 * connection. The 'request' and 'buffer_id' arguments are ignored.
3049 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
3050 * If the ofopgroup eventually fails, then the error reply will include
3051 * 'request'. If the ofopgroup eventually succeeds, then the packet with
3052 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
3054 * The caller should add operations to the returned group with
3055 * ofoperation_create() and then submit it with ofopgroup_submit(). */
3056 static struct ofopgroup
*
3057 ofopgroup_create(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3058 const struct ofp_header
*request
, uint32_t buffer_id
)
3060 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
3062 size_t request_len
= ntohs(request
->length
);
3064 assert(ofconn_get_ofproto(ofconn
) == ofproto
);
3066 ofconn_add_opgroup(ofconn
, &group
->ofconn_node
);
3067 group
->ofconn
= ofconn
;
3068 group
->request
= xmemdup(request
, MIN(request_len
, 64));
3069 group
->buffer_id
= buffer_id
;
3074 /* Submits 'group' for processing.
3076 * If 'group' contains no operations (e.g. none were ever added, or all of the
3077 * ones that were added completed synchronously), then it is destroyed
3078 * immediately. Otherwise it is added to the ofproto's list of pending
3081 ofopgroup_submit(struct ofopgroup
*group
)
3083 if (list_is_empty(&group
->ops
)) {
3084 ofopgroup_destroy(group
);
3086 list_push_back(&group
->ofproto
->pending
, &group
->ofproto_node
);
3087 group
->ofproto
->n_pending
++;
3092 ofopgroup_destroy(struct ofopgroup
*group
)
3094 assert(list_is_empty(&group
->ops
));
3095 if (!list_is_empty(&group
->ofproto_node
)) {
3096 assert(group
->ofproto
->n_pending
> 0);
3097 group
->ofproto
->n_pending
--;
3098 list_remove(&group
->ofproto_node
);
3100 if (!list_is_empty(&group
->ofconn_node
)) {
3101 list_remove(&group
->ofconn_node
);
3103 ofconn_send_error(group
->ofconn
, group
->request
, group
->error
);
3105 connmgr_retry(group
->ofproto
->connmgr
);
3107 free(group
->request
);
3111 /* Initiates a new operation on 'rule', of the specified 'type', within
3112 * 'group'. Prior to calling, 'rule' must not have any pending operation. */
3114 ofoperation_create(struct ofopgroup
*group
, struct rule
*rule
,
3115 enum ofoperation_type type
)
3117 struct ofoperation
*op
;
3119 assert(!rule
->pending
);
3121 op
= rule
->pending
= xzalloc(sizeof *op
);
3123 list_push_back(&group
->ops
, &op
->group_node
);
3127 op
->flow_cookie
= rule
->flow_cookie
;
3129 if (type
== OFOPERATION_DELETE
) {
3130 hmap_insert(&op
->group
->ofproto
->deletions
, &op
->hmap_node
,
3131 cls_rule_hash(&rule
->cr
, rule
->table_id
));
3136 ofoperation_destroy(struct ofoperation
*op
)
3138 struct ofopgroup
*group
= op
->group
;
3141 op
->rule
->pending
= NULL
;
3143 if (op
->type
== OFOPERATION_DELETE
) {
3144 hmap_remove(&group
->ofproto
->deletions
, &op
->hmap_node
);
3146 list_remove(&op
->group_node
);
3150 if (list_is_empty(&group
->ops
) && !list_is_empty(&group
->ofproto_node
)) {
3151 ofopgroup_destroy(group
);
3155 /* Indicates that 'op' completed with status 'error', which is either 0 to
3156 * indicate success or an OpenFlow error code on failure.
3158 * If 'error' is 0, indicating success, the operation will be committed
3159 * permanently to the flow table. There is one interesting subcase:
3161 * - If 'op' is an "add flow" operation that is replacing an existing rule in
3162 * the flow table (the "victim" rule) by a new one, then the caller must
3163 * have uninitialized any derived state in the victim rule, as in step 5 in
3164 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
3165 * performs steps 6 and 7 for the victim rule, most notably by calling its
3166 * ->rule_dealloc() function.
3168 * If 'error' is nonzero, then generally the operation will be rolled back:
3170 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
3171 * restores the original rule. The caller must have uninitialized any
3172 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
3173 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
3174 * and 7 for the new rule, calling its ->rule_dealloc() function.
3176 * - If 'op' is a "modify flow" operation, ofproto restores the original
3179 * - 'op' must not be a "delete flow" operation. Removing a rule is not
3180 * allowed to fail. It must always succeed.
3182 * Please see the large comment in ofproto/ofproto-provider.h titled
3183 * "Asynchronous Operation Support" for more information. */
3185 ofoperation_complete(struct ofoperation
*op
, enum ofperr error
)
3187 struct ofopgroup
*group
= op
->group
;
3188 struct rule
*rule
= op
->rule
;
3189 struct ofproto
*ofproto
= rule
->ofproto
;
3190 struct classifier
*table
= &ofproto
->tables
[rule
->table_id
];
3192 assert(rule
->pending
== op
);
3193 assert(op
->status
< 0);
3197 && op
->type
!= OFOPERATION_DELETE
3199 && group
->buffer_id
!= UINT32_MAX
3200 && list_is_singleton(&op
->group_node
)) {
3201 struct ofpbuf
*packet
;
3204 error
= ofconn_pktbuf_retrieve(group
->ofconn
, group
->buffer_id
,
3208 error
= rule_execute(rule
, in_port
, packet
);
3211 if (!group
->error
) {
3212 group
->error
= error
;
3216 case OFOPERATION_ADD
:
3219 ofproto_rule_destroy__(op
->victim
);
3221 if ((rule
->cr
.wc
.vlan_tci_mask
& htons(VLAN_VID_MASK
))
3222 == htons(VLAN_VID_MASK
)) {
3223 if (ofproto
->vlan_bitmap
) {
3224 uint16_t vid
= vlan_tci_to_vid(rule
->cr
.flow
.vlan_tci
);
3226 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
3227 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
3228 ofproto
->vlans_changed
= true;
3231 ofproto
->vlans_changed
= true;
3236 classifier_replace(table
, &op
->victim
->cr
);
3239 classifier_remove(table
, &rule
->cr
);
3241 ofproto_rule_destroy__(rule
);
3246 case OFOPERATION_DELETE
:
3248 ofproto_rule_destroy__(rule
);
3252 case OFOPERATION_MODIFY
:
3254 rule
->modified
= time_msec();
3256 free(rule
->actions
);
3257 rule
->actions
= op
->actions
;
3258 rule
->n_actions
= op
->n_actions
;
3266 ofoperation_destroy(op
);
3270 ofoperation_get_victim(struct ofoperation
*op
)
3272 assert(op
->type
== OFOPERATION_ADD
);
3277 pick_datapath_id(const struct ofproto
*ofproto
)
3279 const struct ofport
*port
;
3281 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
3283 uint8_t ea
[ETH_ADDR_LEN
];
3286 error
= netdev_get_etheraddr(port
->netdev
, ea
);
3288 return eth_addr_to_uint64(ea
);
3290 VLOG_WARN("could not get MAC address for %s (%s)",
3291 netdev_get_name(port
->netdev
), strerror(error
));
3293 return ofproto
->fallback_dpid
;
3297 pick_fallback_dpid(void)
3299 uint8_t ea
[ETH_ADDR_LEN
];
3300 eth_addr_nicira_random(ea
);
3301 return eth_addr_to_uint64(ea
);
3304 /* unixctl commands. */
3307 ofproto_lookup(const char *name
)
3309 struct ofproto
*ofproto
;
3311 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
3313 if (!strcmp(ofproto
->name
, name
)) {
3321 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
3322 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
3324 struct ofproto
*ofproto
;
3328 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
3329 ds_put_format(&results
, "%s\n", ofproto
->name
);
3331 unixctl_command_reply(conn
, 200, ds_cstr(&results
));
3332 ds_destroy(&results
);
3336 ofproto_unixctl_init(void)
3338 static bool registered
;
3344 unixctl_command_register("ofproto/list", "", 0, 0,
3345 ofproto_unixctl_list
, NULL
);
3348 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
3350 * This is deprecated. It is only for compatibility with broken device drivers
3351 * in old versions of Linux that do not properly support VLANs when VLAN
3352 * devices are not used. When broken device drivers are no longer in
3353 * widespread use, we will delete these interfaces. */
3355 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
3356 * (exactly) by an OpenFlow rule in 'ofproto'. */
3358 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
3360 const struct classifier
*cls
;
3362 free(ofproto
->vlan_bitmap
);
3363 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
3364 ofproto
->vlans_changed
= false;
3366 OFPROTO_FOR_EACH_TABLE (cls
, ofproto
) {
3367 const struct cls_table
*table
;
3369 HMAP_FOR_EACH (table
, hmap_node
, &cls
->tables
) {
3370 if ((table
->wc
.vlan_tci_mask
& htons(VLAN_VID_MASK
))
3371 == htons(VLAN_VID_MASK
)) {
3372 const struct cls_rule
*rule
;
3374 HMAP_FOR_EACH (rule
, hmap_node
, &table
->rules
) {
3375 uint16_t vid
= vlan_tci_to_vid(rule
->flow
.vlan_tci
);
3376 bitmap_set1(vlan_bitmap
, vid
);
3377 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
3384 /* Returns true if new VLANs have come into use by the flow table since the
3385 * last call to ofproto_get_vlan_usage().
3387 * We don't track when old VLANs stop being used. */
3389 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
3391 return ofproto
->vlans_changed
;
3394 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
3395 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
3396 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
3397 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
3398 * then the VLAN device is un-enslaved. */
3400 ofproto_port_set_realdev(struct ofproto
*ofproto
, uint16_t vlandev_ofp_port
,
3401 uint16_t realdev_ofp_port
, int vid
)
3403 struct ofport
*ofport
;
3406 assert(vlandev_ofp_port
!= realdev_ofp_port
);
3408 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
3410 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
3411 ofproto
->name
, vlandev_ofp_port
);
3415 if (!ofproto
->ofproto_class
->set_realdev
) {
3416 if (!vlandev_ofp_port
) {
3419 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
3423 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
3425 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
3426 ofproto
->name
, vlandev_ofp_port
,
3427 netdev_get_name(ofport
->netdev
), strerror(error
));