2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
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"
32 #include "meta-flow.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
38 #include "ofp-print.h"
41 #include "ofproto-provider.h"
42 #include "openflow/nicira-ext.h"
43 #include "openflow/openflow.h"
47 #include "poll-loop.h"
53 #include "unaligned.h"
57 VLOG_DEFINE_THIS_MODULE(ofproto
);
59 COVERAGE_DEFINE(ofproto_error
);
60 COVERAGE_DEFINE(ofproto_flush
);
61 COVERAGE_DEFINE(ofproto_no_packet_in
);
62 COVERAGE_DEFINE(ofproto_packet_out
);
63 COVERAGE_DEFINE(ofproto_queue_req
);
64 COVERAGE_DEFINE(ofproto_recv_openflow
);
65 COVERAGE_DEFINE(ofproto_reinit_ports
);
66 COVERAGE_DEFINE(ofproto_uninstallable
);
67 COVERAGE_DEFINE(ofproto_update_port
);
70 S_OPENFLOW
, /* Processing OpenFlow commands. */
71 S_EVICT
, /* Evicting flows from over-limit tables. */
72 S_FLUSH
, /* Deleting all flow table rules. */
75 enum ofoperation_type
{
81 /* A single OpenFlow request can execute any number of operations. The
82 * ofopgroup maintain OpenFlow state common to all of the operations, e.g. the
83 * ofconn to which an error reply should be sent if necessary.
85 * ofproto initiates some operations internally. These operations are still
86 * assigned to groups but will not have an associated ofconn. */
88 struct ofproto
*ofproto
; /* Owning ofproto. */
89 struct list ofproto_node
; /* In ofproto's "pending" list. */
90 struct list ops
; /* List of "struct ofoperation"s. */
91 int n_running
; /* Number of ops still pending. */
93 /* Data needed to send OpenFlow reply on failure or to send a buffered
96 * If list_is_empty(ofconn_node) then this ofopgroup never had an
97 * associated ofconn or its ofconn's connection dropped after it initiated
98 * the operation. In the latter case 'ofconn' is a wild pointer that
99 * refers to freed memory, so the 'ofconn' member must be used only if
100 * !list_is_empty(ofconn_node).
102 struct list ofconn_node
; /* In ofconn's list of pending opgroups. */
103 struct ofconn
*ofconn
; /* ofconn for reply (but see note above). */
104 struct ofp_header
*request
; /* Original request (truncated at 64 bytes). */
105 uint32_t buffer_id
; /* Buffer id from original request. */
108 static struct ofopgroup
*ofopgroup_create_unattached(struct ofproto
*);
109 static struct ofopgroup
*ofopgroup_create(struct ofproto
*, struct ofconn
*,
110 const struct ofp_header
*,
112 static void ofopgroup_submit(struct ofopgroup
*);
113 static void ofopgroup_complete(struct ofopgroup
*);
115 /* A single flow table operation. */
117 struct ofopgroup
*group
; /* Owning group. */
118 struct list group_node
; /* In ofopgroup's "ops" list. */
119 struct hmap_node hmap_node
; /* In ofproto's "deletions" hmap. */
120 struct rule
*rule
; /* Rule being operated upon. */
121 enum ofoperation_type type
; /* Type of operation. */
123 /* OFOPERATION_ADD. */
124 struct rule
*victim
; /* Rule being replaced, if any.. */
126 /* OFOPERATION_MODIFY: The old actions, if the actions are changing. */
127 struct ofpact
*ofpacts
;
130 /* OFOPERATION_DELETE. */
131 enum ofp_flow_removed_reason reason
; /* Reason flow was removed. */
133 ovs_be64 flow_cookie
; /* Rule's old flow cookie. */
134 enum ofperr error
; /* 0 if no error. */
137 static struct ofoperation
*ofoperation_create(struct ofopgroup
*,
139 enum ofoperation_type
,
140 enum ofp_flow_removed_reason
);
141 static void ofoperation_destroy(struct ofoperation
*);
144 static void oftable_init(struct oftable
*);
145 static void oftable_destroy(struct oftable
*);
147 static void oftable_set_name(struct oftable
*, const char *name
);
149 static void oftable_disable_eviction(struct oftable
*);
150 static void oftable_enable_eviction(struct oftable
*,
151 const struct mf_subfield
*fields
,
154 static void oftable_remove_rule(struct rule
*);
155 static struct rule
*oftable_replace_rule(struct rule
*);
156 static void oftable_substitute_rule(struct rule
*old
, struct rule
*new);
158 /* A set of rules within a single OpenFlow table (oftable) that have the same
159 * values for the oftable's eviction_fields. A rule to be evicted, when one is
160 * needed, is taken from the eviction group that contains the greatest number
163 * An oftable owns any number of eviction groups, each of which contains any
166 * Membership in an eviction group is imprecise, based on the hash of the
167 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
168 * That is, if two rules have different eviction_fields, but those
169 * eviction_fields hash to the same value, then they will belong to the same
170 * eviction_group anyway.
172 * (When eviction is not enabled on an oftable, we don't track any eviction
173 * groups, to save time and space.) */
174 struct eviction_group
{
175 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
176 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
177 struct heap rules
; /* Contains "struct rule"s. */
180 static struct rule
*choose_rule_to_evict(struct oftable
*);
181 static void ofproto_evict(struct ofproto
*);
182 static uint32_t rule_eviction_priority(struct rule
*);
185 static void ofport_destroy__(struct ofport
*);
186 static void ofport_destroy(struct ofport
*);
188 static void update_port(struct ofproto
*, const char *devname
);
189 static int init_ports(struct ofproto
*);
190 static void reinit_ports(struct ofproto
*);
193 static void ofproto_rule_destroy__(struct rule
*);
194 static void ofproto_rule_send_removed(struct rule
*, uint8_t reason
);
195 static bool rule_is_modifiable(const struct rule
*);
198 static enum ofperr
add_flow(struct ofproto
*, struct ofconn
*,
199 const struct ofputil_flow_mod
*,
200 const struct ofp_header
*);
201 static void delete_flow__(struct rule
*, struct ofopgroup
*);
202 static bool handle_openflow(struct ofconn
*, struct ofpbuf
*);
203 static enum ofperr
handle_flow_mod__(struct ofproto
*, struct ofconn
*,
204 const struct ofputil_flow_mod
*,
205 const struct ofp_header
*);
208 static uint64_t pick_datapath_id(const struct ofproto
*);
209 static uint64_t pick_fallback_dpid(void);
210 static void ofproto_destroy__(struct ofproto
*);
211 static void update_mtu(struct ofproto
*, struct ofport
*);
214 static void ofproto_unixctl_init(void);
216 /* All registered ofproto classes, in probe order. */
217 static const struct ofproto_class
**ofproto_classes
;
218 static size_t n_ofproto_classes
;
219 static size_t allocated_ofproto_classes
;
221 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
222 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
224 /* Initial mappings of port to OpenFlow number mappings. */
225 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
227 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
229 /* Must be called to initialize the ofproto library.
231 * The caller may pass in 'iface_hints', which contains an shash of
232 * "iface_hint" elements indexed by the interface's name. The provider
233 * may use these hints to describe the startup configuration in order to
234 * reinitialize its state. The caller owns the provided data, so a
235 * provider will make copies of anything required. An ofproto provider
236 * will remove any existing state that is not described by the hint, and
237 * may choose to remove it all. */
239 ofproto_init(const struct shash
*iface_hints
)
241 struct shash_node
*node
;
244 ofproto_class_register(&ofproto_dpif_class
);
246 /* Make a local copy, since we don't own 'iface_hints' elements. */
247 SHASH_FOR_EACH(node
, iface_hints
) {
248 const struct iface_hint
*orig_hint
= node
->data
;
249 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
250 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
252 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
253 new_hint
->br_type
= xstrdup(br_type
);
254 new_hint
->ofp_port
= orig_hint
->ofp_port
;
256 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
259 for (i
= 0; i
< n_ofproto_classes
; i
++) {
260 ofproto_classes
[i
]->init(&init_ofp_ports
);
264 /* 'type' should be a normalized datapath type, as returned by
265 * ofproto_normalize_type(). Returns the corresponding ofproto_class
266 * structure, or a null pointer if there is none registered for 'type'. */
267 static const struct ofproto_class
*
268 ofproto_class_find__(const char *type
)
272 for (i
= 0; i
< n_ofproto_classes
; i
++) {
273 const struct ofproto_class
*class = ofproto_classes
[i
];
278 class->enumerate_types(&types
);
279 found
= sset_contains(&types
, type
);
280 sset_destroy(&types
);
286 VLOG_WARN("unknown datapath type %s", type
);
290 /* Registers a new ofproto class. After successful registration, new ofprotos
291 * of that type can be created using ofproto_create(). */
293 ofproto_class_register(const struct ofproto_class
*new_class
)
297 for (i
= 0; i
< n_ofproto_classes
; i
++) {
298 if (ofproto_classes
[i
] == new_class
) {
303 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
304 ofproto_classes
= x2nrealloc(ofproto_classes
,
305 &allocated_ofproto_classes
,
306 sizeof *ofproto_classes
);
308 ofproto_classes
[n_ofproto_classes
++] = new_class
;
312 /* Unregisters a datapath provider. 'type' must have been previously
313 * registered and not currently be in use by any ofprotos. After
314 * unregistration new datapaths of that type cannot be opened using
315 * ofproto_create(). */
317 ofproto_class_unregister(const struct ofproto_class
*class)
321 for (i
= 0; i
< n_ofproto_classes
; i
++) {
322 if (ofproto_classes
[i
] == class) {
323 for (i
++; i
< n_ofproto_classes
; i
++) {
324 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
330 VLOG_WARN("attempted to unregister an ofproto class that is not "
335 /* Clears 'types' and enumerates all registered ofproto types into it. The
336 * caller must first initialize the sset. */
338 ofproto_enumerate_types(struct sset
*types
)
342 for (i
= 0; i
< n_ofproto_classes
; i
++) {
343 ofproto_classes
[i
]->enumerate_types(types
);
347 /* Returns the fully spelled out name for the given ofproto 'type'.
349 * Normalized type string can be compared with strcmp(). Unnormalized type
350 * string might be the same even if they have different spellings. */
352 ofproto_normalize_type(const char *type
)
354 return type
&& type
[0] ? type
: "system";
357 /* Clears 'names' and enumerates the names of all known created ofprotos with
358 * the given 'type'. The caller must first initialize the sset. Returns 0 if
359 * successful, otherwise a positive errno value.
361 * Some kinds of datapaths might not be practically enumerable. This is not
362 * considered an error. */
364 ofproto_enumerate_names(const char *type
, struct sset
*names
)
366 const struct ofproto_class
*class = ofproto_class_find__(type
);
367 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
371 ofproto_create(const char *datapath_name
, const char *datapath_type
,
372 struct ofproto
**ofprotop
)
374 const struct ofproto_class
*class;
375 struct ofproto
*ofproto
;
380 ofproto_unixctl_init();
382 datapath_type
= ofproto_normalize_type(datapath_type
);
383 class = ofproto_class_find__(datapath_type
);
385 VLOG_WARN("could not create datapath %s of unknown type %s",
386 datapath_name
, datapath_type
);
390 ofproto
= class->alloc();
392 VLOG_ERR("failed to allocate datapath %s of type %s",
393 datapath_name
, datapath_type
);
398 memset(ofproto
, 0, sizeof *ofproto
);
399 ofproto
->ofproto_class
= class;
400 ofproto
->name
= xstrdup(datapath_name
);
401 ofproto
->type
= xstrdup(datapath_type
);
402 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
403 hash_string(ofproto
->name
, 0));
404 ofproto
->datapath_id
= 0;
405 ofproto_set_flow_eviction_threshold(ofproto
,
406 OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT
);
407 ofproto
->forward_bpdu
= false;
408 ofproto
->fallback_dpid
= pick_fallback_dpid();
409 ofproto
->mfr_desc
= xstrdup(DEFAULT_MFR_DESC
);
410 ofproto
->hw_desc
= xstrdup(DEFAULT_HW_DESC
);
411 ofproto
->sw_desc
= xstrdup(DEFAULT_SW_DESC
);
412 ofproto
->serial_desc
= xstrdup(DEFAULT_SERIAL_DESC
);
413 ofproto
->dp_desc
= xstrdup(DEFAULT_DP_DESC
);
414 ofproto
->frag_handling
= OFPC_FRAG_NORMAL
;
415 hmap_init(&ofproto
->ports
);
416 shash_init(&ofproto
->port_by_name
);
417 simap_init(&ofproto
->ofp_requests
);
418 ofproto
->max_ports
= OFPP_MAX
;
419 ofproto
->tables
= NULL
;
420 ofproto
->n_tables
= 0;
421 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
422 ofproto
->state
= S_OPENFLOW
;
423 list_init(&ofproto
->pending
);
424 ofproto
->n_pending
= 0;
425 hmap_init(&ofproto
->deletions
);
426 ofproto
->n_add
= ofproto
->n_delete
= ofproto
->n_modify
= 0;
427 ofproto
->first_op
= ofproto
->last_op
= LLONG_MIN
;
428 ofproto
->next_op_report
= LLONG_MAX
;
429 ofproto
->op_backoff
= LLONG_MIN
;
430 ofproto
->vlan_bitmap
= NULL
;
431 ofproto
->vlans_changed
= false;
432 ofproto
->min_mtu
= INT_MAX
;
434 error
= ofproto
->ofproto_class
->construct(ofproto
);
436 VLOG_ERR("failed to open datapath %s: %s",
437 datapath_name
, strerror(error
));
438 ofproto_destroy__(ofproto
);
442 /* The "max_ports" member should have been set by ->construct(ofproto).
443 * Port 0 is not a valid OpenFlow port, so mark that as unavailable. */
444 ofproto
->ofp_port_ids
= bitmap_allocate(ofproto
->max_ports
);
445 bitmap_set1(ofproto
->ofp_port_ids
, 0);
447 assert(ofproto
->n_tables
);
449 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
456 /* Must be called (only) by an ofproto implementation in its constructor
457 * function. See the large comment on 'construct' in struct ofproto_class for
460 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
462 struct oftable
*table
;
464 assert(!ofproto
->n_tables
);
465 assert(n_tables
>= 1 && n_tables
<= 255);
467 ofproto
->n_tables
= n_tables
;
468 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
469 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
474 /* To be optionally called (only) by an ofproto implementation in its
475 * constructor function. See the large comment on 'construct' in struct
476 * ofproto_class for details.
478 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
479 * will then ensure that actions passed into the ofproto implementation will
480 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
481 * function is not called, there will be no such restriction.
483 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
484 * the 'max_ports' restriction. */
486 ofproto_init_max_ports(struct ofproto
*ofproto
, uint16_t max_ports
)
488 assert(max_ports
<= OFPP_MAX
);
489 ofproto
->max_ports
= max_ports
;
493 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
495 return ofproto
->datapath_id
;
499 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
501 uint64_t old_dpid
= p
->datapath_id
;
502 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
503 if (p
->datapath_id
!= old_dpid
) {
504 /* Force all active connections to reconnect, since there is no way to
505 * notify a controller that the datapath ID has changed. */
506 ofproto_reconnect_controllers(p
);
511 ofproto_set_controllers(struct ofproto
*p
,
512 const struct ofproto_controller
*controllers
,
513 size_t n_controllers
)
515 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
);
519 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
521 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
524 /* Drops the connections between 'ofproto' and all of its controllers, forcing
525 * them to reconnect. */
527 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
529 connmgr_reconnect(ofproto
->connmgr
);
532 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
533 * in-band control should guarantee access, in the same way that in-band
534 * control guarantees access to OpenFlow controllers. */
536 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
537 const struct sockaddr_in
*extras
, size_t n
)
539 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
542 /* Sets the OpenFlow queue used by flows set up by in-band control on
543 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
544 * flows will use the default queue. */
546 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
548 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
551 /* Sets the number of flows at which eviction from the kernel flow table
554 ofproto_set_flow_eviction_threshold(struct ofproto
*ofproto
, unsigned threshold
)
556 if (threshold
< OFPROTO_FLOW_EVICTION_THRESHOLD_MIN
) {
557 ofproto
->flow_eviction_threshold
= OFPROTO_FLOW_EVICTION_THRESHOLD_MIN
;
559 ofproto
->flow_eviction_threshold
= threshold
;
563 /* If forward_bpdu is true, the NORMAL action will forward frames with
564 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
565 * the NORMAL action will drop these frames. */
567 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
569 bool old_val
= ofproto
->forward_bpdu
;
570 ofproto
->forward_bpdu
= forward_bpdu
;
571 if (old_val
!= ofproto
->forward_bpdu
) {
572 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
573 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
578 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
579 * 'idle_time', in seconds. */
581 ofproto_set_mac_idle_time(struct ofproto
*ofproto
, unsigned idle_time
)
583 if (ofproto
->ofproto_class
->set_mac_idle_time
) {
584 ofproto
->ofproto_class
->set_mac_idle_time(ofproto
, idle_time
);
589 ofproto_set_desc(struct ofproto
*p
,
590 const char *mfr_desc
, const char *hw_desc
,
591 const char *sw_desc
, const char *serial_desc
,
594 struct ofp_desc_stats
*ods
;
597 if (strlen(mfr_desc
) >= sizeof ods
->mfr_desc
) {
598 VLOG_WARN("%s: truncating mfr_desc, must be less than %zu bytes",
599 p
->name
, sizeof ods
->mfr_desc
);
602 p
->mfr_desc
= xstrdup(mfr_desc
);
605 if (strlen(hw_desc
) >= sizeof ods
->hw_desc
) {
606 VLOG_WARN("%s: truncating hw_desc, must be less than %zu bytes",
607 p
->name
, sizeof ods
->hw_desc
);
610 p
->hw_desc
= xstrdup(hw_desc
);
613 if (strlen(sw_desc
) >= sizeof ods
->sw_desc
) {
614 VLOG_WARN("%s: truncating sw_desc, must be less than %zu bytes",
615 p
->name
, sizeof ods
->sw_desc
);
618 p
->sw_desc
= xstrdup(sw_desc
);
621 if (strlen(serial_desc
) >= sizeof ods
->serial_num
) {
622 VLOG_WARN("%s: truncating serial_desc, must be less than %zu "
623 "bytes", p
->name
, sizeof ods
->serial_num
);
625 free(p
->serial_desc
);
626 p
->serial_desc
= xstrdup(serial_desc
);
629 if (strlen(dp_desc
) >= sizeof ods
->dp_desc
) {
630 VLOG_WARN("%s: truncating dp_desc, must be less than %zu bytes",
631 p
->name
, sizeof ods
->dp_desc
);
634 p
->dp_desc
= xstrdup(dp_desc
);
639 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
641 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
645 ofproto_set_netflow(struct ofproto
*ofproto
,
646 const struct netflow_options
*nf_options
)
648 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
652 if (ofproto
->ofproto_class
->set_netflow
) {
653 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
655 return nf_options
? EOPNOTSUPP
: 0;
660 ofproto_set_sflow(struct ofproto
*ofproto
,
661 const struct ofproto_sflow_options
*oso
)
663 if (oso
&& sset_is_empty(&oso
->targets
)) {
667 if (ofproto
->ofproto_class
->set_sflow
) {
668 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
670 return oso
? EOPNOTSUPP
: 0;
674 /* Spanning Tree Protocol (STP) configuration. */
676 /* Configures STP on 'ofproto' using the settings defined in 's'. If
677 * 's' is NULL, disables STP.
679 * Returns 0 if successful, otherwise a positive errno value. */
681 ofproto_set_stp(struct ofproto
*ofproto
,
682 const struct ofproto_stp_settings
*s
)
684 return (ofproto
->ofproto_class
->set_stp
685 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
689 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
690 * 'enabled' member of 's' is false, then the other members are not
693 * Returns 0 if successful, otherwise a positive errno value. */
695 ofproto_get_stp_status(struct ofproto
*ofproto
,
696 struct ofproto_stp_status
*s
)
698 return (ofproto
->ofproto_class
->get_stp_status
699 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
703 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
704 * in 's'. The caller is responsible for assigning STP port numbers
705 * (using the 'port_num' member in the range of 1 through 255, inclusive)
706 * and ensuring there are no duplicates. If the 's' is NULL, then STP
707 * is disabled on the port.
709 * Returns 0 if successful, otherwise a positive errno value.*/
711 ofproto_port_set_stp(struct ofproto
*ofproto
, uint16_t ofp_port
,
712 const struct ofproto_port_stp_settings
*s
)
714 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
716 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
717 ofproto
->name
, ofp_port
);
721 return (ofproto
->ofproto_class
->set_stp_port
722 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
726 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
727 * 's'. If the 'enabled' member in 's' is false, then the other members
728 * are not meaningful.
730 * Returns 0 if successful, otherwise a positive errno value.*/
732 ofproto_port_get_stp_status(struct ofproto
*ofproto
, uint16_t ofp_port
,
733 struct ofproto_port_stp_status
*s
)
735 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
737 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
738 "port %"PRIu16
, ofproto
->name
, ofp_port
);
742 return (ofproto
->ofproto_class
->get_stp_port_status
743 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
747 /* Queue DSCP configuration. */
749 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
750 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
751 * to implement QoS. Instead, it is used to implement features which require
752 * knowledge of what queues exist on a port, and some basic information about
755 * Returns 0 if successful, otherwise a positive errno value. */
757 ofproto_port_set_queues(struct ofproto
*ofproto
, uint16_t ofp_port
,
758 const struct ofproto_port_queue
*queues
,
761 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
764 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
765 ofproto
->name
, ofp_port
);
769 return (ofproto
->ofproto_class
->set_queues
770 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
774 /* Connectivity Fault Management configuration. */
776 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
778 ofproto_port_clear_cfm(struct ofproto
*ofproto
, uint16_t ofp_port
)
780 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
781 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
782 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
786 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
787 * basic configuration from the configuration members in 'cfm', and the remote
788 * maintenance point ID from remote_mpid. Ignores the statistics members of
791 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
793 ofproto_port_set_cfm(struct ofproto
*ofproto
, uint16_t ofp_port
,
794 const struct cfm_settings
*s
)
796 struct ofport
*ofport
;
799 ofport
= ofproto_get_port(ofproto
, ofp_port
);
801 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
802 ofproto
->name
, ofp_port
);
806 /* XXX: For configuration simplicity, we only support one remote_mpid
807 * outside of the CFM module. It's not clear if this is the correct long
808 * term solution or not. */
809 error
= (ofproto
->ofproto_class
->set_cfm
810 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
813 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
814 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
819 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
820 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
821 * 0 if LACP partner information is not current (generally indicating a
822 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
824 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, uint16_t ofp_port
)
826 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
827 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
828 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
834 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
835 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
836 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
837 * configuration plus, if there is more than one slave, a bonding
840 * If 'aux' is already registered then this function updates its configuration
841 * to 's'. Otherwise, this function registers a new bundle.
843 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
846 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
847 const struct ofproto_bundle_settings
*s
)
849 return (ofproto
->ofproto_class
->bundle_set
850 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
854 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
855 * If no such bundle has been registered, this has no effect. */
857 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
859 return ofproto_bundle_register(ofproto
, aux
, NULL
);
863 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
864 * If 'aux' is already registered then this function updates its configuration
865 * to 's'. Otherwise, this function registers a new mirror. */
867 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
868 const struct ofproto_mirror_settings
*s
)
870 return (ofproto
->ofproto_class
->mirror_set
871 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
875 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
876 * If no mirror has been registered, this has no effect. */
878 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
880 return ofproto_mirror_register(ofproto
, aux
, NULL
);
883 /* Retrieves statistics from mirror associated with client data pointer
884 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
885 * 'bytes', respectively. If a particular counters is not supported,
886 * the appropriate argument is set to UINT64_MAX. */
888 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
889 uint64_t *packets
, uint64_t *bytes
)
891 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
892 *packets
= *bytes
= UINT64_MAX
;
896 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
900 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
901 * which all packets are flooded, instead of using MAC learning. If
902 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
904 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
907 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
909 return (ofproto
->ofproto_class
->set_flood_vlans
910 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
914 /* Returns true if 'aux' is a registered bundle that is currently in use as the
915 * output for a mirror. */
917 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
919 return (ofproto
->ofproto_class
->is_mirror_output_bundle
920 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
924 /* Configuration of OpenFlow tables. */
926 /* Returns the number of OpenFlow tables in 'ofproto'. */
928 ofproto_get_n_tables(const struct ofproto
*ofproto
)
930 return ofproto
->n_tables
;
933 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
934 * settings from 's'. 'table_id' must be in the range 0 through the number of
935 * OpenFlow tables in 'ofproto' minus 1, inclusive.
937 * For read-only tables, only the name may be configured. */
939 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
940 const struct ofproto_table_settings
*s
)
942 struct oftable
*table
;
944 assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
945 table
= &ofproto
->tables
[table_id
];
947 oftable_set_name(table
, s
->name
);
949 if (table
->flags
& OFTABLE_READONLY
) {
954 oftable_enable_eviction(table
, s
->groups
, s
->n_groups
);
956 oftable_disable_eviction(table
);
959 table
->max_flows
= s
->max_flows
;
960 if (classifier_count(&table
->cls
) > table
->max_flows
961 && table
->eviction_fields
) {
962 /* 'table' contains more flows than allowed. We might not be able to
963 * evict them right away because of the asynchronous nature of flow
964 * table changes. Schedule eviction for later. */
965 switch (ofproto
->state
) {
967 ofproto
->state
= S_EVICT
;
971 /* We're already deleting flows, nothing more to do. */
978 ofproto_has_snoops(const struct ofproto
*ofproto
)
980 return connmgr_has_snoops(ofproto
->connmgr
);
984 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
986 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
990 ofproto_flush__(struct ofproto
*ofproto
)
992 struct ofopgroup
*group
;
993 struct oftable
*table
;
995 if (ofproto
->ofproto_class
->flush
) {
996 ofproto
->ofproto_class
->flush(ofproto
);
999 group
= ofopgroup_create_unattached(ofproto
);
1000 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1001 struct rule
*rule
, *next_rule
;
1002 struct cls_cursor cursor
;
1004 if (table
->flags
& OFTABLE_HIDDEN
) {
1008 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
1009 CLS_CURSOR_FOR_EACH_SAFE (rule
, next_rule
, cr
, &cursor
) {
1010 if (!rule
->pending
) {
1011 ofoperation_create(group
, rule
, OFOPERATION_DELETE
,
1013 oftable_remove_rule(rule
);
1014 ofproto
->ofproto_class
->rule_destruct(rule
);
1018 ofopgroup_submit(group
);
1022 ofproto_destroy__(struct ofproto
*ofproto
)
1024 struct oftable
*table
;
1026 assert(list_is_empty(&ofproto
->pending
));
1027 assert(!ofproto
->n_pending
);
1029 connmgr_destroy(ofproto
->connmgr
);
1031 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1032 free(ofproto
->name
);
1033 free(ofproto
->type
);
1034 free(ofproto
->mfr_desc
);
1035 free(ofproto
->hw_desc
);
1036 free(ofproto
->sw_desc
);
1037 free(ofproto
->serial_desc
);
1038 free(ofproto
->dp_desc
);
1039 hmap_destroy(&ofproto
->ports
);
1040 shash_destroy(&ofproto
->port_by_name
);
1041 bitmap_free(ofproto
->ofp_port_ids
);
1042 simap_destroy(&ofproto
->ofp_requests
);
1044 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1045 oftable_destroy(table
);
1047 free(ofproto
->tables
);
1049 hmap_destroy(&ofproto
->deletions
);
1051 free(ofproto
->vlan_bitmap
);
1053 ofproto
->ofproto_class
->dealloc(ofproto
);
1057 ofproto_destroy(struct ofproto
*p
)
1059 struct ofport
*ofport
, *next_ofport
;
1066 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1067 ofport_destroy(ofport
);
1070 p
->ofproto_class
->destruct(p
);
1071 ofproto_destroy__(p
);
1074 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1075 * kernel datapath, for example, this destroys the datapath in the kernel, and
1076 * with the netdev-based datapath, it tears down the data structures that
1077 * represent the datapath.
1079 * The datapath should not be currently open as an ofproto. */
1081 ofproto_delete(const char *name
, const char *type
)
1083 const struct ofproto_class
*class = ofproto_class_find__(type
);
1084 return (!class ? EAFNOSUPPORT
1085 : !class->del
? EACCES
1086 : class->del(type
, name
));
1090 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1092 if (error
== ENOBUFS
) {
1093 reinit_ports(ofproto
);
1094 } else if (!error
) {
1095 update_port(ofproto
, devname
);
1101 ofproto_type_run(const char *datapath_type
)
1103 const struct ofproto_class
*class;
1106 datapath_type
= ofproto_normalize_type(datapath_type
);
1107 class = ofproto_class_find__(datapath_type
);
1109 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1110 if (error
&& error
!= EAGAIN
) {
1111 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1112 datapath_type
, strerror(error
));
1118 ofproto_type_run_fast(const char *datapath_type
)
1120 const struct ofproto_class
*class;
1123 datapath_type
= ofproto_normalize_type(datapath_type
);
1124 class = ofproto_class_find__(datapath_type
);
1126 error
= class->type_run_fast
? class->type_run_fast(datapath_type
) : 0;
1127 if (error
&& error
!= EAGAIN
) {
1128 VLOG_ERR_RL(&rl
, "%s: type_run_fast failed (%s)",
1129 datapath_type
, strerror(error
));
1135 ofproto_type_wait(const char *datapath_type
)
1137 const struct ofproto_class
*class;
1139 datapath_type
= ofproto_normalize_type(datapath_type
);
1140 class = ofproto_class_find__(datapath_type
);
1142 if (class->type_wait
) {
1143 class->type_wait(datapath_type
);
1148 ofproto_run(struct ofproto
*p
)
1150 struct sset changed_netdevs
;
1151 const char *changed_netdev
;
1152 struct ofport
*ofport
;
1155 error
= p
->ofproto_class
->run(p
);
1156 if (error
&& error
!= EAGAIN
) {
1157 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, strerror(error
));
1160 if (p
->ofproto_class
->port_poll
) {
1163 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1164 process_port_change(p
, error
, devname
);
1168 /* Update OpenFlow port status for any port whose netdev has changed.
1170 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1171 * destroyed, so it's not safe to update ports directly from the
1172 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1173 * need this two-phase approach. */
1174 sset_init(&changed_netdevs
);
1175 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1176 unsigned int change_seq
= netdev_change_seq(ofport
->netdev
);
1177 if (ofport
->change_seq
!= change_seq
) {
1178 ofport
->change_seq
= change_seq
;
1179 sset_add(&changed_netdevs
, netdev_get_name(ofport
->netdev
));
1182 SSET_FOR_EACH (changed_netdev
, &changed_netdevs
) {
1183 update_port(p
, changed_netdev
);
1185 sset_destroy(&changed_netdevs
);
1189 connmgr_run(p
->connmgr
, handle_openflow
);
1193 connmgr_run(p
->connmgr
, NULL
);
1195 if (list_is_empty(&p
->pending
) && hmap_is_empty(&p
->deletions
)) {
1196 p
->state
= S_OPENFLOW
;
1201 connmgr_run(p
->connmgr
, NULL
);
1203 if (list_is_empty(&p
->pending
) && hmap_is_empty(&p
->deletions
)) {
1204 connmgr_flushed(p
->connmgr
);
1205 p
->state
= S_OPENFLOW
;
1213 if (time_msec() >= p
->next_op_report
) {
1214 long long int ago
= (time_msec() - p
->first_op
) / 1000;
1215 long long int interval
= (p
->last_op
- p
->first_op
) / 1000;
1219 ds_put_format(&s
, "%d flow_mods ",
1220 p
->n_add
+ p
->n_delete
+ p
->n_modify
);
1221 if (interval
== ago
) {
1222 ds_put_format(&s
, "in the last %lld s", ago
);
1223 } else if (interval
) {
1224 ds_put_format(&s
, "in the %lld s starting %lld s ago",
1227 ds_put_format(&s
, "%lld s ago", ago
);
1230 ds_put_cstr(&s
, " (");
1232 ds_put_format(&s
, "%d adds, ", p
->n_add
);
1235 ds_put_format(&s
, "%d deletes, ", p
->n_delete
);
1238 ds_put_format(&s
, "%d modifications, ", p
->n_modify
);
1241 ds_put_char(&s
, ')');
1243 VLOG_INFO("%s: %s", p
->name
, ds_cstr(&s
));
1246 p
->n_add
= p
->n_delete
= p
->n_modify
= 0;
1247 p
->next_op_report
= LLONG_MAX
;
1253 /* Performs periodic activity required by 'ofproto' that needs to be done
1254 * with the least possible latency.
1256 * It makes sense to call this function a couple of times per poll loop, to
1257 * provide a significant performance boost on some benchmarks with the
1258 * ofproto-dpif implementation. */
1260 ofproto_run_fast(struct ofproto
*p
)
1264 error
= p
->ofproto_class
->run_fast
? p
->ofproto_class
->run_fast(p
) : 0;
1265 if (error
&& error
!= EAGAIN
) {
1266 VLOG_ERR_RL(&rl
, "%s: fastpath run failed (%s)",
1267 p
->name
, strerror(error
));
1273 ofproto_wait(struct ofproto
*p
)
1275 struct ofport
*ofport
;
1277 p
->ofproto_class
->wait(p
);
1278 if (p
->ofproto_class
->port_poll_wait
) {
1279 p
->ofproto_class
->port_poll_wait(p
);
1282 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1283 if (ofport
->change_seq
!= netdev_change_seq(ofport
->netdev
)) {
1284 poll_immediate_wake();
1290 connmgr_wait(p
->connmgr
, true);
1295 connmgr_wait(p
->connmgr
, false);
1296 if (list_is_empty(&p
->pending
) && hmap_is_empty(&p
->deletions
)) {
1297 poll_immediate_wake();
1304 ofproto_is_alive(const struct ofproto
*p
)
1306 return connmgr_has_controllers(p
->connmgr
);
1309 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1310 * memory_report(). */
1312 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1314 const struct oftable
*table
;
1315 unsigned int n_rules
;
1317 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1318 simap_increase(usage
, "ops",
1319 ofproto
->n_pending
+ hmap_count(&ofproto
->deletions
));
1322 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1323 n_rules
+= classifier_count(&table
->cls
);
1325 simap_increase(usage
, "rules", n_rules
);
1327 if (ofproto
->ofproto_class
->get_memory_usage
) {
1328 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1331 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1335 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1338 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1342 ofproto_free_ofproto_controller_info(struct shash
*info
)
1344 connmgr_free_controller_info(info
);
1347 /* Makes a deep copy of 'old' into 'port'. */
1349 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1351 port
->name
= xstrdup(old
->name
);
1352 port
->type
= xstrdup(old
->type
);
1353 port
->ofp_port
= old
->ofp_port
;
1356 /* Frees memory allocated to members of 'ofproto_port'.
1358 * Do not call this function on an ofproto_port obtained from
1359 * ofproto_port_dump_next(): that function retains ownership of the data in the
1362 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1364 free(ofproto_port
->name
);
1365 free(ofproto_port
->type
);
1368 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1370 * This function provides no status indication. An error status for the entire
1371 * dump operation is provided when it is completed by calling
1372 * ofproto_port_dump_done().
1375 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1376 const struct ofproto
*ofproto
)
1378 dump
->ofproto
= ofproto
;
1379 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1383 /* Attempts to retrieve another port from 'dump', which must have been created
1384 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1385 * 'port' and returns true. On failure, returns false.
1387 * Failure might indicate an actual error or merely that the last port has been
1388 * dumped. An error status for the entire dump operation is provided when it
1389 * is completed by calling ofproto_port_dump_done().
1391 * The ofproto owns the data stored in 'port'. It will remain valid until at
1392 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1393 * ofproto_port_dump_done(). */
1395 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1396 struct ofproto_port
*port
)
1398 const struct ofproto
*ofproto
= dump
->ofproto
;
1404 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1407 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1413 /* Completes port table dump operation 'dump', which must have been created
1414 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1415 * error-free, otherwise a positive errno value describing the problem. */
1417 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1419 const struct ofproto
*ofproto
= dump
->ofproto
;
1421 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1424 return dump
->error
== EOF
? 0 : dump
->error
;
1427 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1428 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1429 * the port's OpenFlow port number.
1431 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1432 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1433 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1434 * 'ofp_portp' is non-null). */
1436 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1437 uint16_t *ofp_portp
)
1439 uint16_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1442 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1444 const char *netdev_name
= netdev_get_name(netdev
);
1446 simap_put(&ofproto
->ofp_requests
, netdev_name
, ofp_port
);
1447 update_port(ofproto
, netdev_name
);
1450 struct ofproto_port ofproto_port
;
1452 ofproto_port_query_by_name(ofproto
, netdev_get_name(netdev
),
1454 *ofp_portp
= error
? OFPP_NONE
: ofproto_port
.ofp_port
;
1455 ofproto_port_destroy(&ofproto_port
);
1460 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1461 * initializes '*port' appropriately; on failure, returns a positive errno
1464 * The caller owns the data in 'ofproto_port' and must free it with
1465 * ofproto_port_destroy() when it is no longer needed. */
1467 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1468 struct ofproto_port
*port
)
1472 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1474 memset(port
, 0, sizeof *port
);
1479 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1480 * Returns 0 if successful, otherwise a positive errno. */
1482 ofproto_port_del(struct ofproto
*ofproto
, uint16_t ofp_port
)
1484 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1485 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
1486 struct simap_node
*ofp_request_node
;
1489 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
1490 if (ofp_request_node
) {
1491 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
1494 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
1495 if (!error
&& ofport
) {
1496 /* 'name' is the netdev's name and update_port() is going to close the
1497 * netdev. Just in case update_port() refers to 'name' after it
1498 * destroys 'ofport', make a copy of it around the update_port()
1500 char *devname
= xstrdup(name
);
1501 update_port(ofproto
, devname
);
1507 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1508 * performs the 'n_actions' actions in 'actions'. The new flow will not
1511 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1512 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1513 * controllers; otherwise, it will be hidden.
1515 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1517 * This is a helper function for in-band control and fail-open. */
1519 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
1520 unsigned int priority
,
1521 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1523 const struct rule
*rule
;
1525 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1526 &ofproto
->tables
[0].cls
, match
, priority
));
1527 if (!rule
|| !ofpacts_equal(rule
->ofpacts
, rule
->ofpacts_len
,
1528 ofpacts
, ofpacts_len
)) {
1529 struct ofputil_flow_mod fm
;
1531 memset(&fm
, 0, sizeof fm
);
1533 fm
.priority
= priority
;
1534 fm
.buffer_id
= UINT32_MAX
;
1535 fm
.ofpacts
= xmemdup(ofpacts
, ofpacts_len
);
1536 fm
.ofpacts_len
= ofpacts_len
;
1537 add_flow(ofproto
, NULL
, &fm
, NULL
);
1542 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1543 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1544 * operation cannot be initiated now but may be retried later.
1546 * This is a helper function for in-band control and fail-open. */
1548 ofproto_flow_mod(struct ofproto
*ofproto
, const struct ofputil_flow_mod
*fm
)
1550 return handle_flow_mod__(ofproto
, NULL
, fm
, NULL
);
1553 /* Searches for a rule with matching criteria exactly equal to 'target' in
1554 * ofproto's table 0 and, if it finds one, deletes it.
1556 * This is a helper function for in-band control and fail-open. */
1558 ofproto_delete_flow(struct ofproto
*ofproto
,
1559 const struct match
*target
, unsigned int priority
)
1563 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1564 &ofproto
->tables
[0].cls
, target
, priority
));
1566 /* No such rule -> success. */
1568 } else if (rule
->pending
) {
1569 /* An operation on the rule is already pending -> failure.
1570 * Caller must retry later if it's important. */
1573 /* Initiate deletion -> success. */
1574 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
1575 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, OFPRR_DELETE
);
1576 oftable_remove_rule(rule
);
1577 ofproto
->ofproto_class
->rule_destruct(rule
);
1578 ofopgroup_submit(group
);
1584 /* Starts the process of deleting all of the flows from all of ofproto's flow
1585 * tables and then reintroducing the flows required by in-band control and
1586 * fail-open. The process will complete in a later call to ofproto_run(). */
1588 ofproto_flush_flows(struct ofproto
*ofproto
)
1590 COVERAGE_INC(ofproto_flush
);
1591 ofproto
->state
= S_FLUSH
;
1595 reinit_ports(struct ofproto
*p
)
1597 struct ofproto_port_dump dump
;
1598 struct sset devnames
;
1599 struct ofport
*ofport
;
1600 struct ofproto_port ofproto_port
;
1601 const char *devname
;
1603 COVERAGE_INC(ofproto_reinit_ports
);
1605 sset_init(&devnames
);
1606 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1607 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1609 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
1610 sset_add(&devnames
, ofproto_port
.name
);
1613 SSET_FOR_EACH (devname
, &devnames
) {
1614 update_port(p
, devname
);
1616 sset_destroy(&devnames
);
1620 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
1624 ofp_port
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
1625 ofp_port
= ofp_port
? ofp_port
: OFPP_NONE
;
1627 if (ofp_port
>= ofproto
->max_ports
1628 || bitmap_is_set(ofproto
->ofp_port_ids
, ofp_port
)) {
1629 bool retry
= ofproto
->alloc_port_no
? true : false;
1631 /* Search for a free OpenFlow port number. We try not to
1632 * immediately reuse them to prevent problems due to old
1634 while (ofp_port
>= ofproto
->max_ports
) {
1635 for (ofproto
->alloc_port_no
++;
1636 ofproto
->alloc_port_no
< ofproto
->max_ports
; ) {
1637 if (!bitmap_is_set(ofproto
->ofp_port_ids
,
1638 ofproto
->alloc_port_no
)) {
1639 ofp_port
= ofproto
->alloc_port_no
;
1643 if (ofproto
->alloc_port_no
>= ofproto
->max_ports
) {
1645 ofproto
->alloc_port_no
= 0;
1654 bitmap_set1(ofproto
->ofp_port_ids
, ofp_port
);
1659 dealloc_ofp_port(const struct ofproto
*ofproto
, uint16_t ofp_port
)
1661 bitmap_set0(ofproto
->ofp_port_ids
, ofp_port
);
1664 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
1665 * pointer if the netdev cannot be opened. On success, also fills in
1667 static struct netdev
*
1668 ofport_open(struct ofproto
*ofproto
,
1669 struct ofproto_port
*ofproto_port
,
1670 struct ofputil_phy_port
*pp
)
1672 enum netdev_flags flags
;
1673 struct netdev
*netdev
;
1676 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
1678 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
1679 "cannot be opened (%s)",
1681 ofproto_port
->name
, ofproto_port
->ofp_port
,
1682 ofproto_port
->name
, strerror(error
));
1686 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
1687 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
1688 ofproto_port
->ofp_port
= OFPP_LOCAL
;
1690 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
1691 ofproto_port
->name
);
1694 pp
->port_no
= ofproto_port
->ofp_port
;
1695 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
1696 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
1697 netdev_get_flags(netdev
, &flags
);
1698 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
1699 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
1700 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
1701 &pp
->supported
, &pp
->peer
);
1702 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
);
1703 pp
->max_speed
= netdev_features_to_bps(pp
->supported
);
1708 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
1709 * port number, and 'config' bits other than OFPUTIL_PS_LINK_DOWN are
1712 ofport_equal(const struct ofputil_phy_port
*a
,
1713 const struct ofputil_phy_port
*b
)
1715 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
1716 && a
->state
== b
->state
1717 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
1718 && a
->curr
== b
->curr
1719 && a
->advertised
== b
->advertised
1720 && a
->supported
== b
->supported
1721 && a
->peer
== b
->peer
1722 && a
->curr_speed
== b
->curr_speed
1723 && a
->max_speed
== b
->max_speed
);
1726 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
1727 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
1728 * one with the same name or port number). */
1730 ofport_install(struct ofproto
*p
,
1731 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
1733 const char *netdev_name
= netdev_get_name(netdev
);
1734 struct ofport
*ofport
;
1737 /* Create ofport. */
1738 ofport
= p
->ofproto_class
->port_alloc();
1743 ofport
->ofproto
= p
;
1744 ofport
->netdev
= netdev
;
1745 ofport
->change_seq
= netdev_change_seq(netdev
);
1747 ofport
->ofp_port
= pp
->port_no
;
1749 /* Add port to 'p'. */
1750 hmap_insert(&p
->ports
, &ofport
->hmap_node
, hash_int(ofport
->ofp_port
, 0));
1751 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
1753 update_mtu(p
, ofport
);
1755 /* Let the ofproto_class initialize its private data. */
1756 error
= p
->ofproto_class
->port_construct(ofport
);
1760 connmgr_send_port_status(p
->connmgr
, pp
, OFPPR_ADD
);
1764 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
1765 p
->name
, netdev_name
, strerror(error
));
1767 ofport_destroy__(ofport
);
1769 netdev_close(netdev
);
1773 /* Removes 'ofport' from 'p' and destroys it. */
1775 ofport_remove(struct ofport
*ofport
)
1777 connmgr_send_port_status(ofport
->ofproto
->connmgr
, &ofport
->pp
,
1779 ofport_destroy(ofport
);
1782 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
1785 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
1787 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
1789 ofport_remove(port
);
1793 /* Updates 'port' with new 'pp' description.
1795 * Does not handle a name or port number change. The caller must implement
1796 * such a change as a delete followed by an add. */
1798 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
1800 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
1801 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
1802 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
1803 port
->pp
.state
= pp
->state
;
1804 port
->pp
.curr
= pp
->curr
;
1805 port
->pp
.advertised
= pp
->advertised
;
1806 port
->pp
.supported
= pp
->supported
;
1807 port
->pp
.peer
= pp
->peer
;
1808 port
->pp
.curr_speed
= pp
->curr_speed
;
1809 port
->pp
.max_speed
= pp
->max_speed
;
1811 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->pp
, OFPPR_MODIFY
);
1814 /* Update OpenFlow 'state' in 'port' and notify controller. */
1816 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
1818 if (port
->pp
.state
!= state
) {
1819 port
->pp
.state
= state
;
1820 connmgr_send_port_status(port
->ofproto
->connmgr
, &port
->pp
,
1826 ofproto_port_unregister(struct ofproto
*ofproto
, uint16_t ofp_port
)
1828 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
1830 if (port
->ofproto
->ofproto_class
->set_realdev
) {
1831 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
1833 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
1834 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
1836 if (port
->ofproto
->ofproto_class
->set_cfm
) {
1837 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
1839 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
1840 port
->ofproto
->ofproto_class
->bundle_remove(port
);
1846 ofport_destroy__(struct ofport
*port
)
1848 struct ofproto
*ofproto
= port
->ofproto
;
1849 const char *name
= netdev_get_name(port
->netdev
);
1851 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
1852 shash_delete(&ofproto
->port_by_name
,
1853 shash_find(&ofproto
->port_by_name
, name
));
1855 netdev_close(port
->netdev
);
1856 ofproto
->ofproto_class
->port_dealloc(port
);
1860 ofport_destroy(struct ofport
*port
)
1863 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
1864 port
->ofproto
->ofproto_class
->port_destruct(port
);
1865 ofport_destroy__(port
);
1870 ofproto_get_port(const struct ofproto
*ofproto
, uint16_t ofp_port
)
1872 struct ofport
*port
;
1874 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
,
1875 hash_int(ofp_port
, 0), &ofproto
->ports
) {
1876 if (port
->ofp_port
== ofp_port
) {
1884 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
1886 struct ofproto
*ofproto
= port
->ofproto
;
1889 if (ofproto
->ofproto_class
->port_get_stats
) {
1890 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
1899 update_port(struct ofproto
*ofproto
, const char *name
)
1901 struct ofproto_port ofproto_port
;
1902 struct ofputil_phy_port pp
;
1903 struct netdev
*netdev
;
1904 struct ofport
*port
;
1906 COVERAGE_INC(ofproto_update_port
);
1908 /* Fetch 'name''s location and properties from the datapath. */
1909 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
1910 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
1913 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
1914 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
1915 struct netdev
*old_netdev
= port
->netdev
;
1917 /* 'name' hasn't changed location. Any properties changed? */
1918 if (!ofport_equal(&port
->pp
, &pp
)) {
1919 ofport_modified(port
, &pp
);
1922 update_mtu(ofproto
, port
);
1924 /* Install the newly opened netdev in case it has changed.
1925 * Don't close the old netdev yet in case port_modified has to
1926 * remove a retained reference to it.*/
1927 port
->netdev
= netdev
;
1928 port
->change_seq
= netdev_change_seq(netdev
);
1930 if (port
->ofproto
->ofproto_class
->port_modified
) {
1931 port
->ofproto
->ofproto_class
->port_modified(port
);
1934 netdev_close(old_netdev
);
1936 /* If 'port' is nonnull then its name differs from 'name' and thus
1937 * we should delete it. If we think there's a port named 'name'
1938 * then its port number must be wrong now so delete it too. */
1940 ofport_remove(port
);
1942 ofport_remove_with_name(ofproto
, name
);
1943 ofport_install(ofproto
, netdev
, &pp
);
1946 /* Any port named 'name' is gone now. */
1947 ofport_remove_with_name(ofproto
, name
);
1949 ofproto_port_destroy(&ofproto_port
);
1953 init_ports(struct ofproto
*p
)
1955 struct ofproto_port_dump dump
;
1956 struct ofproto_port ofproto_port
;
1957 struct shash_node
*node
, *next
;
1959 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
1960 const char *name
= ofproto_port
.name
;
1962 if (shash_find(&p
->port_by_name
, name
)) {
1963 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
1966 struct ofputil_phy_port pp
;
1967 struct netdev
*netdev
;
1969 /* Check if an OpenFlow port number had been requested. */
1970 node
= shash_find(&init_ofp_ports
, name
);
1972 const struct iface_hint
*iface_hint
= node
->data
;
1973 simap_put(&p
->ofp_requests
, name
, iface_hint
->ofp_port
);
1976 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
1978 ofport_install(p
, netdev
, &pp
);
1983 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
1984 const struct iface_hint
*iface_hint
= node
->data
;
1986 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
1987 free(iface_hint
->br_name
);
1988 free(iface_hint
->br_type
);
1989 shash_delete(&init_ofp_ports
, node
);
1996 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
1997 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
1999 find_min_mtu(struct ofproto
*p
)
2001 struct ofport
*ofport
;
2004 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2005 struct netdev
*netdev
= ofport
->netdev
;
2008 /* Skip any internal ports, since that's what we're trying to
2010 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2014 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2017 if (!mtu
|| dev_mtu
< mtu
) {
2022 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2025 /* Update MTU of all datapath devices on 'p' to the minimum of the
2026 * non-datapath ports in event of 'port' added or changed. */
2028 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2030 struct ofport
*ofport
;
2031 struct netdev
*netdev
= port
->netdev
;
2032 int dev_mtu
, old_min
;
2034 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2038 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2039 if (dev_mtu
> p
->min_mtu
) {
2040 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2041 dev_mtu
= p
->min_mtu
;
2044 port
->mtu
= dev_mtu
;
2048 /* For non-internal port find new min mtu. */
2049 old_min
= p
->min_mtu
;
2050 port
->mtu
= dev_mtu
;
2051 p
->min_mtu
= find_min_mtu(p
);
2052 if (p
->min_mtu
== old_min
) {
2056 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2057 struct netdev
*netdev
= ofport
->netdev
;
2059 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2060 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2061 ofport
->mtu
= p
->min_mtu
;
2068 ofproto_rule_destroy__(struct rule
*rule
)
2071 cls_rule_destroy(&rule
->cr
);
2072 free(rule
->ofpacts
);
2073 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2077 /* This function allows an ofproto implementation to destroy any rules that
2078 * remain when its ->destruct() function is called. The caller must have
2079 * already uninitialized any derived members of 'rule' (step 5 described in the
2080 * large comment in ofproto/ofproto-provider.h titled "Life Cycle").
2081 * This function implements steps 6 and 7.
2083 * This function should only be called from an ofproto implementation's
2084 * ->destruct() function. It is not suitable elsewhere. */
2086 ofproto_rule_destroy(struct rule
*rule
)
2088 assert(!rule
->pending
);
2089 oftable_remove_rule(rule
);
2090 ofproto_rule_destroy__(rule
);
2093 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2094 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2096 ofproto_rule_has_out_port(const struct rule
*rule
, uint16_t port
)
2098 return (port
== OFPP_NONE
2099 || ofpacts_output_to_port(rule
->ofpacts
, rule
->ofpacts_len
, port
));
2102 /* Returns true if a rule related to 'op' has an OpenFlow OFPAT_OUTPUT or
2103 * OFPAT_ENQUEUE action that outputs to 'out_port'. */
2105 ofoperation_has_out_port(const struct ofoperation
*op
, uint16_t out_port
)
2107 if (ofproto_rule_has_out_port(op
->rule
, out_port
)) {
2112 case OFOPERATION_ADD
:
2113 return op
->victim
&& ofproto_rule_has_out_port(op
->victim
, out_port
);
2115 case OFOPERATION_DELETE
:
2118 case OFOPERATION_MODIFY
:
2119 return ofpacts_output_to_port(op
->ofpacts
, op
->ofpacts_len
, out_port
);
2125 /* Executes the actions indicated by 'rule' on 'packet' and credits 'rule''s
2126 * statistics appropriately. 'packet' must have at least sizeof(struct
2127 * ofp_packet_in) bytes of headroom.
2129 * 'packet' doesn't necessarily have to match 'rule'. 'rule' will be credited
2130 * with statistics for 'packet' either way.
2132 * Takes ownership of 'packet'. */
2134 rule_execute(struct rule
*rule
, uint16_t in_port
, struct ofpbuf
*packet
)
2138 assert(ofpbuf_headroom(packet
) >= sizeof(struct ofp_packet_in
));
2140 flow_extract(packet
, 0, NULL
, in_port
, &flow
);
2141 return rule
->ofproto
->ofproto_class
->rule_execute(rule
, &flow
, packet
);
2144 /* Returns true if 'rule' should be hidden from the controller.
2146 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
2147 * (e.g. by in-band control) and are intentionally hidden from the
2150 ofproto_rule_is_hidden(const struct rule
*rule
)
2152 return rule
->cr
.priority
> UINT16_MAX
;
2155 static enum oftable_flags
2156 rule_get_flags(const struct rule
*rule
)
2158 return rule
->ofproto
->tables
[rule
->table_id
].flags
;
2162 rule_is_modifiable(const struct rule
*rule
)
2164 return !(rule_get_flags(rule
) & OFTABLE_READONLY
);
2168 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2170 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
2175 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2177 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2178 struct ofputil_switch_features features
;
2179 struct ofport
*port
;
2183 ofproto
->ofproto_class
->get_features(ofproto
, &arp_match_ip
,
2185 assert(features
.actions
& OFPUTIL_A_OUTPUT
); /* sanity check */
2187 features
.datapath_id
= ofproto
->datapath_id
;
2188 features
.n_buffers
= pktbuf_capacity();
2189 features
.n_tables
= ofproto
->n_tables
;
2190 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
2191 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
);
2193 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
2196 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
2198 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
2199 ofputil_put_switch_features_port(&port
->pp
, b
);
2202 ofconn_send_reply(ofconn
, b
);
2207 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2209 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2210 struct ofp_switch_config
*osc
;
2211 enum ofp_config_flags flags
;
2215 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
2216 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
2217 flags
= ofproto
->frag_handling
;
2218 if (ofconn_get_invalid_ttl_to_controller(ofconn
)) {
2219 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
2221 osc
->flags
= htons(flags
);
2222 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
2223 ofconn_send_reply(ofconn
, buf
);
2229 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2231 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
2232 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2233 uint16_t flags
= ntohs(osc
->flags
);
2235 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
2236 || ofconn_get_role(ofconn
) != NX_ROLE_SLAVE
) {
2237 enum ofp_config_flags cur
= ofproto
->frag_handling
;
2238 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
2240 assert((cur
& OFPC_FRAG_MASK
) == cur
);
2242 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
2243 ofproto
->frag_handling
= next
;
2245 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
2247 ofputil_frag_handling_to_string(next
));
2251 ofconn_set_invalid_ttl_to_controller(ofconn
,
2252 (flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
2254 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
2259 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
2260 * error message code for the caller to propagate upward. Otherwise, returns
2263 * The log message mentions 'msg_type'. */
2265 reject_slave_controller(struct ofconn
*ofconn
)
2267 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
2268 && ofconn_get_role(ofconn
) == NX_ROLE_SLAVE
) {
2269 return OFPERR_OFPBRC_EPERM
;
2276 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2278 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2279 struct ofputil_packet_out po
;
2280 struct ofpbuf
*payload
;
2281 uint64_t ofpacts_stub
[1024 / 8];
2282 struct ofpbuf ofpacts
;
2286 COVERAGE_INC(ofproto_packet_out
);
2288 error
= reject_slave_controller(ofconn
);
2293 /* Decode message. */
2294 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
2295 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
2297 goto exit_free_ofpacts
;
2299 if (po
.in_port
>= p
->max_ports
&& po
.in_port
< OFPP_MAX
) {
2300 error
= OFPERR_OFPBRC_BAD_PORT
;
2301 goto exit_free_ofpacts
;
2306 if (po
.buffer_id
!= UINT32_MAX
) {
2307 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
2308 if (error
|| !payload
) {
2309 goto exit_free_ofpacts
;
2312 payload
= xmalloc(sizeof *payload
);
2313 ofpbuf_use_const(payload
, po
.packet
, po
.packet_len
);
2316 /* Verify actions against packet, then send packet if successful. */
2317 flow_extract(payload
, 0, NULL
, po
.in_port
, &flow
);
2318 error
= ofpacts_check(po
.ofpacts
, po
.ofpacts_len
, &flow
, p
->max_ports
);
2320 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
2321 po
.ofpacts
, po
.ofpacts_len
);
2323 ofpbuf_delete(payload
);
2326 ofpbuf_uninit(&ofpacts
);
2332 update_port_config(struct ofport
*port
,
2333 enum ofputil_port_config config
,
2334 enum ofputil_port_config mask
)
2336 enum ofputil_port_config old_config
= port
->pp
.config
;
2337 enum ofputil_port_config toggle
;
2339 toggle
= (config
^ port
->pp
.config
) & mask
;
2340 if (toggle
& OFPUTIL_PC_PORT_DOWN
) {
2341 if (config
& OFPUTIL_PC_PORT_DOWN
) {
2342 netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, true);
2344 netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, true);
2346 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
2349 port
->pp
.config
^= toggle
;
2350 if (port
->pp
.config
!= old_config
) {
2351 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
2356 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2358 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2359 struct ofputil_port_mod pm
;
2360 struct ofport
*port
;
2363 error
= reject_slave_controller(ofconn
);
2368 error
= ofputil_decode_port_mod(oh
, &pm
);
2373 port
= ofproto_get_port(p
, pm
.port_no
);
2375 return OFPERR_OFPPMFC_BAD_PORT
;
2376 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
2377 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
2379 update_port_config(port
, pm
.config
, pm
.mask
);
2381 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
2388 handle_desc_stats_request(struct ofconn
*ofconn
,
2389 const struct ofp_header
*request
)
2391 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2392 struct ofp_desc_stats
*ods
;
2395 msg
= ofpraw_alloc_stats_reply(request
, 0);
2396 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
2397 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
, sizeof ods
->mfr_desc
);
2398 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
, sizeof ods
->hw_desc
);
2399 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
, sizeof ods
->sw_desc
);
2400 ovs_strlcpy(ods
->serial_num
, p
->serial_desc
, sizeof ods
->serial_num
);
2401 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
, sizeof ods
->dp_desc
);
2402 ofconn_send_reply(ofconn
, msg
);
2408 handle_table_stats_request(struct ofconn
*ofconn
,
2409 const struct ofp_header
*request
)
2411 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2412 struct ofp12_table_stats
*ots
;
2416 /* Set up default values.
2418 * ofp12_table_stats is used as a generic structure as
2419 * it is able to hold all the fields for ofp10_table_stats
2420 * and ofp11_table_stats (and of course itself).
2422 ots
= xcalloc(p
->n_tables
, sizeof *ots
);
2423 for (i
= 0; i
< p
->n_tables
; i
++) {
2424 ots
[i
].table_id
= i
;
2425 sprintf(ots
[i
].name
, "table%zu", i
);
2426 ots
[i
].match
= htonll(OFPXMT12_MASK
);
2427 ots
[i
].wildcards
= htonll(OFPXMT12_MASK
);
2428 ots
[i
].write_actions
= htonl(OFPAT11_OUTPUT
);
2429 ots
[i
].apply_actions
= htonl(OFPAT11_OUTPUT
);
2430 ots
[i
].write_setfields
= htonll(OFPXMT12_MASK
);
2431 ots
[i
].apply_setfields
= htonll(OFPXMT12_MASK
);
2432 ots
[i
].metadata_match
= htonll(UINT64_MAX
);
2433 ots
[i
].metadata_write
= htonll(UINT64_MAX
);
2434 ots
[i
].instructions
= htonl(OFPIT11_ALL
);
2435 ots
[i
].config
= htonl(OFPTC11_TABLE_MISS_MASK
);
2436 ots
[i
].max_entries
= htonl(1000000); /* An arbitrary big number. */
2437 ots
[i
].active_count
= htonl(classifier_count(&p
->tables
[i
].cls
));
2440 p
->ofproto_class
->get_tables(p
, ots
);
2442 for (i
= 0; i
< p
->n_tables
; i
++) {
2443 const struct oftable
*table
= &p
->tables
[i
];
2446 ovs_strzcpy(ots
[i
].name
, table
->name
, sizeof ots
[i
].name
);
2449 if (table
->max_flows
< ntohl(ots
[i
].max_entries
)) {
2450 ots
[i
].max_entries
= htonl(table
->max_flows
);
2454 msg
= ofputil_encode_table_stats_reply(ots
, p
->n_tables
, request
);
2455 ofconn_send_reply(ofconn
, msg
);
2463 append_port_stat(struct ofport
*port
, struct list
*replies
)
2465 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
2467 /* Intentionally ignore return value, since errors will set
2468 * 'stats' to all-1s, which is correct for OpenFlow, and
2469 * netdev_get_stats() will log errors. */
2470 ofproto_port_get_stats(port
, &ops
.stats
);
2472 ofputil_append_port_stat(replies
, &ops
);
2476 handle_port_stats_request(struct ofconn
*ofconn
,
2477 const struct ofp_header
*request
)
2479 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2480 struct ofport
*port
;
2481 struct list replies
;
2485 error
= ofputil_decode_port_stats_request(request
, &port_no
);
2490 ofpmp_init(&replies
, request
);
2491 if (port_no
!= OFPP_NONE
) {
2492 port
= ofproto_get_port(p
, port_no
);
2494 append_port_stat(port
, &replies
);
2497 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
2498 append_port_stat(port
, &replies
);
2502 ofconn_send_replies(ofconn
, &replies
);
2507 handle_port_desc_stats_request(struct ofconn
*ofconn
,
2508 const struct ofp_header
*request
)
2510 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
2511 enum ofp_version version
;
2512 struct ofport
*port
;
2513 struct list replies
;
2515 ofpmp_init(&replies
, request
);
2517 version
= ofputil_protocol_to_ofp_version(ofconn_get_protocol(ofconn
));
2518 HMAP_FOR_EACH (port
, hmap_node
, &p
->ports
) {
2519 ofputil_append_port_desc_stats_reply(version
, &port
->pp
, &replies
);
2522 ofconn_send_replies(ofconn
, &replies
);
2527 calc_flow_duration__(long long int start
, long long int now
,
2528 uint32_t *sec
, uint32_t *nsec
)
2530 long long int msecs
= now
- start
;
2531 *sec
= msecs
/ 1000;
2532 *nsec
= (msecs
% 1000) * (1000 * 1000);
2535 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
2536 * 0 if 'table_id' is OK, otherwise an OpenFlow error code. */
2538 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
2540 return (table_id
== 0xff || table_id
< ofproto
->n_tables
2542 : OFPERR_OFPBRC_BAD_TABLE_ID
);
2546 static struct oftable
*
2547 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
2549 struct oftable
*table
;
2551 for (table
= &ofproto
->tables
[table_id
];
2552 table
< &ofproto
->tables
[ofproto
->n_tables
];
2554 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
2562 static struct oftable
*
2563 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
2565 if (table_id
== 0xff) {
2566 return next_visible_table(ofproto
, 0);
2567 } else if (table_id
< ofproto
->n_tables
) {
2568 return &ofproto
->tables
[table_id
];
2574 static struct oftable
*
2575 next_matching_table(const struct ofproto
*ofproto
,
2576 const struct oftable
*table
, uint8_t table_id
)
2578 return (table_id
== 0xff
2579 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
2583 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
2585 * - If TABLE_ID is 0xff, this iterates over every classifier table in
2586 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
2588 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
2589 * only once, for that table. (This can be used to access tables marked
2592 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
2593 * entered at all. (Perhaps you should have validated TABLE_ID with
2594 * check_table_id().)
2596 * All parameters are evaluated multiple times.
2598 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
2599 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
2601 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
2603 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2604 * 'table_id' is 0xff) that match 'match' in the "loose" way required for
2605 * OpenFlow OFPFC_MODIFY and OFPFC_DELETE requests and puts them on list
2608 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2609 * to 'out_port' are included.
2611 * Hidden rules are always omitted.
2613 * Returns 0 on success, otherwise an OpenFlow error code. */
2615 collect_rules_loose(struct ofproto
*ofproto
, uint8_t table_id
,
2616 const struct match
*match
,
2617 ovs_be64 cookie
, ovs_be64 cookie_mask
,
2618 uint16_t out_port
, struct list
*rules
)
2620 struct oftable
*table
;
2624 error
= check_table_id(ofproto
, table_id
);
2630 cls_rule_init(&cr
, match
, 0);
2631 FOR_EACH_MATCHING_TABLE (table
, table_id
, ofproto
) {
2632 struct cls_cursor cursor
;
2635 cls_cursor_init(&cursor
, &table
->cls
, &cr
);
2636 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
2637 if (rule
->pending
) {
2638 error
= OFPROTO_POSTPONE
;
2641 if (!ofproto_rule_is_hidden(rule
)
2642 && ofproto_rule_has_out_port(rule
, out_port
)
2643 && !((rule
->flow_cookie
^ cookie
) & cookie_mask
)) {
2644 list_push_back(rules
, &rule
->ofproto_node
);
2650 cls_rule_destroy(&cr
);
2654 /* Searches 'ofproto' for rules in table 'table_id' (or in all tables, if
2655 * 'table_id' is 0xff) that match 'match' in the "strict" way required for
2656 * OpenFlow OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests and puts them
2659 * If 'out_port' is anything other than OFPP_NONE, then only rules that output
2660 * to 'out_port' are included.
2662 * Hidden rules are always omitted.
2664 * Returns 0 on success, otherwise an OpenFlow error code. */
2666 collect_rules_strict(struct ofproto
*ofproto
, uint8_t table_id
,
2667 const struct match
*match
, unsigned int priority
,
2668 ovs_be64 cookie
, ovs_be64 cookie_mask
,
2669 uint16_t out_port
, struct list
*rules
)
2671 struct oftable
*table
;
2675 error
= check_table_id(ofproto
, table_id
);
2681 cls_rule_init(&cr
, match
, priority
);
2682 FOR_EACH_MATCHING_TABLE (table
, table_id
, ofproto
) {
2685 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
,
2688 if (rule
->pending
) {
2689 error
= OFPROTO_POSTPONE
;
2692 if (!ofproto_rule_is_hidden(rule
)
2693 && ofproto_rule_has_out_port(rule
, out_port
)
2694 && !((rule
->flow_cookie
^ cookie
) & cookie_mask
)) {
2695 list_push_back(rules
, &rule
->ofproto_node
);
2701 cls_rule_destroy(&cr
);
2705 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
2706 * forced into the range of a uint16_t. */
2708 age_secs(long long int age_ms
)
2710 return (age_ms
< 0 ? 0
2711 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
2712 : (unsigned int) age_ms
/ 1000);
2716 handle_flow_stats_request(struct ofconn
*ofconn
,
2717 const struct ofp_header
*request
)
2719 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2720 struct ofputil_flow_stats_request fsr
;
2721 struct list replies
;
2726 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
2731 error
= collect_rules_loose(ofproto
, fsr
.table_id
, &fsr
.match
,
2732 fsr
.cookie
, fsr
.cookie_mask
,
2733 fsr
.out_port
, &rules
);
2738 ofpmp_init(&replies
, request
);
2739 LIST_FOR_EACH (rule
, ofproto_node
, &rules
) {
2740 long long int now
= time_msec();
2741 struct ofputil_flow_stats fs
;
2743 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
2744 fs
.priority
= rule
->cr
.priority
;
2745 fs
.cookie
= rule
->flow_cookie
;
2746 fs
.table_id
= rule
->table_id
;
2747 calc_flow_duration__(rule
->created
, now
, &fs
.duration_sec
,
2749 fs
.idle_timeout
= rule
->idle_timeout
;
2750 fs
.hard_timeout
= rule
->hard_timeout
;
2751 fs
.idle_age
= age_secs(now
- rule
->used
);
2752 fs
.hard_age
= age_secs(now
- rule
->modified
);
2753 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
2755 fs
.ofpacts
= rule
->ofpacts
;
2756 fs
.ofpacts_len
= rule
->ofpacts_len
;
2757 ofputil_append_flow_stats_reply(&fs
, &replies
);
2759 ofconn_send_replies(ofconn
, &replies
);
2765 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
2767 uint64_t packet_count
, byte_count
;
2769 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
,
2770 &packet_count
, &byte_count
);
2772 if (rule
->table_id
!= 0) {
2773 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
2775 ds_put_format(results
, "duration=%llds, ",
2776 (time_msec() - rule
->created
) / 1000);
2777 ds_put_format(results
, "priority=%u, ", rule
->cr
.priority
);
2778 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
2779 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
2780 cls_rule_format(&rule
->cr
, results
);
2781 ds_put_char(results
, ',');
2782 if (rule
->ofpacts_len
> 0) {
2783 ofpacts_format(rule
->ofpacts
, rule
->ofpacts_len
, results
);
2785 ds_put_cstr(results
, "drop");
2787 ds_put_cstr(results
, "\n");
2790 /* Adds a pretty-printed description of all flows to 'results', including
2791 * hidden flows (e.g., set up by in-band control). */
2793 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
2795 struct oftable
*table
;
2797 OFPROTO_FOR_EACH_TABLE (table
, p
) {
2798 struct cls_cursor cursor
;
2801 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
2802 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
2803 flow_stats_ds(rule
, results
);
2808 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
2809 * '*engine_type' and '*engine_id', respectively. */
2811 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
2812 uint8_t *engine_type
, uint8_t *engine_id
)
2814 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
2817 /* Checks the fault status of CFM for 'ofp_port' within 'ofproto'. Returns a
2818 * bitmask of 'cfm_fault_reason's to indicate a CFM fault (generally
2819 * indicating a connectivity problem). Returns zero if CFM is not faulted,
2820 * and -1 if CFM is not enabled on 'ofp_port'. */
2822 ofproto_port_get_cfm_fault(const struct ofproto
*ofproto
, uint16_t ofp_port
)
2824 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2825 return (ofport
&& ofproto
->ofproto_class
->get_cfm_fault
2826 ? ofproto
->ofproto_class
->get_cfm_fault(ofport
)
2830 /* Checks the operational status reported by the remote CFM endpoint of
2831 * 'ofp_port' Returns 1 if operationally up, 0 if operationally down, and -1
2832 * if CFM is not enabled on 'ofp_port' or does not support operational status.
2835 ofproto_port_get_cfm_opup(const struct ofproto
*ofproto
, uint16_t ofp_port
)
2837 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2838 return (ofport
&& ofproto
->ofproto_class
->get_cfm_opup
2839 ? ofproto
->ofproto_class
->get_cfm_opup(ofport
)
2843 /* Gets the MPIDs of the remote maintenance points broadcasting to 'ofp_port'
2844 * within 'ofproto'. Populates 'rmps' with an array of MPIDs owned by
2845 * 'ofproto', and 'n_rmps' with the number of MPIDs in 'rmps'. Returns a
2846 * number less than 0 if CFM is not enabled on 'ofp_port'. */
2848 ofproto_port_get_cfm_remote_mpids(const struct ofproto
*ofproto
,
2849 uint16_t ofp_port
, const uint64_t **rmps
,
2852 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2856 return (ofport
&& ofproto
->ofproto_class
->get_cfm_remote_mpids
2857 ? ofproto
->ofproto_class
->get_cfm_remote_mpids(ofport
, rmps
,
2862 /* Checks the health of the CFM for 'ofp_port' within 'ofproto'. Returns an
2863 * integer value between 0 and 100 to indicate the health of the port as a
2864 * percentage which is the average of cfm health of all the remote_mpids or
2865 * returns -1 if CFM is not enabled on 'ofport'. */
2867 ofproto_port_get_cfm_health(const struct ofproto
*ofproto
, uint16_t ofp_port
)
2869 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2870 return (ofport
&& ofproto
->ofproto_class
->get_cfm_health
2871 ? ofproto
->ofproto_class
->get_cfm_health(ofport
)
2876 handle_aggregate_stats_request(struct ofconn
*ofconn
,
2877 const struct ofp_header
*oh
)
2879 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2880 struct ofputil_flow_stats_request request
;
2881 struct ofputil_aggregate_stats stats
;
2882 bool unknown_packets
, unknown_bytes
;
2883 struct ofpbuf
*reply
;
2888 error
= ofputil_decode_flow_stats_request(&request
, oh
);
2893 error
= collect_rules_loose(ofproto
, request
.table_id
, &request
.match
,
2894 request
.cookie
, request
.cookie_mask
,
2895 request
.out_port
, &rules
);
2900 memset(&stats
, 0, sizeof stats
);
2901 unknown_packets
= unknown_bytes
= false;
2902 LIST_FOR_EACH (rule
, ofproto_node
, &rules
) {
2903 uint64_t packet_count
;
2904 uint64_t byte_count
;
2906 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
2909 if (packet_count
== UINT64_MAX
) {
2910 unknown_packets
= true;
2912 stats
.packet_count
+= packet_count
;
2915 if (byte_count
== UINT64_MAX
) {
2916 unknown_bytes
= true;
2918 stats
.byte_count
+= byte_count
;
2923 if (unknown_packets
) {
2924 stats
.packet_count
= UINT64_MAX
;
2926 if (unknown_bytes
) {
2927 stats
.byte_count
= UINT64_MAX
;
2930 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
2931 ofconn_send_reply(ofconn
, reply
);
2936 struct queue_stats_cbdata
{
2937 struct ofport
*ofport
;
2938 struct list replies
;
2942 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
2943 const struct netdev_queue_stats
*stats
)
2946 struct ofputil_queue_stats oqs
= {
2947 .port_no
= cbdata
->ofport
->pp
.port_no
,
2948 .queue_id
= queue_id
,
2951 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
2955 handle_queue_stats_dump_cb(uint32_t queue_id
,
2956 struct netdev_queue_stats
*stats
,
2959 struct queue_stats_cbdata
*cbdata
= cbdata_
;
2961 put_queue_stats(cbdata
, queue_id
, stats
);
2965 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
2966 struct queue_stats_cbdata
*cbdata
)
2968 cbdata
->ofport
= port
;
2969 if (queue_id
== OFPQ_ALL
) {
2970 netdev_dump_queue_stats(port
->netdev
,
2971 handle_queue_stats_dump_cb
, cbdata
);
2973 struct netdev_queue_stats stats
;
2975 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
2976 put_queue_stats(cbdata
, queue_id
, &stats
);
2978 return OFPERR_OFPQOFC_BAD_QUEUE
;
2985 handle_queue_stats_request(struct ofconn
*ofconn
,
2986 const struct ofp_header
*rq
)
2988 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2989 struct queue_stats_cbdata cbdata
;
2990 struct ofport
*port
;
2992 struct ofputil_queue_stats_request oqsr
;
2994 COVERAGE_INC(ofproto_queue_req
);
2996 ofpmp_init(&cbdata
.replies
, rq
);
2998 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
3003 if (oqsr
.port_no
== OFPP_ALL
) {
3004 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
3005 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3006 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
3011 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
3013 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
3014 : OFPERR_OFPQOFC_BAD_PORT
);
3017 ofconn_send_replies(ofconn
, &cbdata
.replies
);
3019 ofpbuf_list_delete(&cbdata
.replies
);
3026 is_flow_deletion_pending(const struct ofproto
*ofproto
,
3027 const struct cls_rule
*cls_rule
,
3030 if (!hmap_is_empty(&ofproto
->deletions
)) {
3031 struct ofoperation
*op
;
3033 HMAP_FOR_EACH_WITH_HASH (op
, hmap_node
,
3034 cls_rule_hash(cls_rule
, table_id
),
3035 &ofproto
->deletions
) {
3036 if (cls_rule_equal(cls_rule
, &op
->rule
->cr
)) {
3045 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
3046 * in which no matching flow already exists in the flow table.
3048 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
3049 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
3050 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
3051 * initiated now but may be retried later.
3053 * Upon successful return, takes ownership of 'fm->ofpacts'. On failure,
3054 * ownership remains with the caller.
3056 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3059 add_flow(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3060 const struct ofputil_flow_mod
*fm
, const struct ofp_header
*request
)
3062 struct oftable
*table
;
3063 struct ofopgroup
*group
;
3064 struct rule
*victim
;
3069 error
= check_table_id(ofproto
, fm
->table_id
);
3075 if (fm
->table_id
== 0xff) {
3077 if (ofproto
->ofproto_class
->rule_choose_table
) {
3078 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
3084 assert(table_id
< ofproto
->n_tables
);
3085 table
= &ofproto
->tables
[table_id
];
3087 table
= &ofproto
->tables
[0];
3089 } else if (fm
->table_id
< ofproto
->n_tables
) {
3090 table
= &ofproto
->tables
[fm
->table_id
];
3092 return OFPERR_OFPBRC_BAD_TABLE_ID
;
3095 if (table
->flags
& OFTABLE_READONLY
) {
3096 return OFPERR_OFPBRC_EPERM
;
3099 /* Allocate new rule and initialize classifier rule. */
3100 rule
= ofproto
->ofproto_class
->rule_alloc();
3102 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
3103 ofproto
->name
, strerror(error
));
3106 cls_rule_init(&rule
->cr
, &fm
->match
, fm
->priority
);
3108 /* Serialize against pending deletion. */
3109 if (is_flow_deletion_pending(ofproto
, &cr
, table
- ofproto
->tables
)) {
3110 cls_rule_destroy(&rule
->cr
);
3111 ofproto
->ofproto_class
->rule_dealloc(rule
);
3112 return OFPROTO_POSTPONE
;
3115 /* Check for overlap, if requested. */
3116 if (fm
->flags
& OFPFF_CHECK_OVERLAP
3117 && classifier_rule_overlaps(&table
->cls
, &rule
->cr
)) {
3118 cls_rule_destroy(&rule
->cr
);
3119 ofproto
->ofproto_class
->rule_dealloc(rule
);
3120 return OFPERR_OFPFMFC_OVERLAP
;
3123 rule
->ofproto
= ofproto
;
3124 rule
->pending
= NULL
;
3125 rule
->flow_cookie
= fm
->new_cookie
;
3126 rule
->created
= rule
->modified
= rule
->used
= time_msec();
3127 rule
->idle_timeout
= fm
->idle_timeout
;
3128 rule
->hard_timeout
= fm
->hard_timeout
;
3129 rule
->table_id
= table
- ofproto
->tables
;
3130 rule
->send_flow_removed
= (fm
->flags
& OFPFF_SEND_FLOW_REM
) != 0;
3131 rule
->ofpacts
= xmemdup(fm
->ofpacts
, fm
->ofpacts_len
);
3132 rule
->ofpacts_len
= fm
->ofpacts_len
;
3133 rule
->evictable
= true;
3134 rule
->eviction_group
= NULL
;
3135 rule
->monitor_flags
= 0;
3136 rule
->add_seqno
= 0;
3137 rule
->modify_seqno
= 0;
3139 /* Insert new rule. */
3140 victim
= oftable_replace_rule(rule
);
3141 if (victim
&& !rule_is_modifiable(victim
)) {
3142 error
= OFPERR_OFPBRC_EPERM
;
3143 } else if (victim
&& victim
->pending
) {
3144 error
= OFPROTO_POSTPONE
;
3146 struct ofoperation
*op
;
3149 if (classifier_count(&table
->cls
) > table
->max_flows
) {
3152 was_evictable
= rule
->evictable
;
3153 rule
->evictable
= false;
3154 evict
= choose_rule_to_evict(table
);
3155 rule
->evictable
= was_evictable
;
3158 error
= OFPERR_OFPFMFC_TABLE_FULL
;
3160 } else if (evict
->pending
) {
3161 error
= OFPROTO_POSTPONE
;
3168 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
3169 op
= ofoperation_create(group
, rule
, OFOPERATION_ADD
, 0);
3170 op
->victim
= victim
;
3172 error
= ofproto
->ofproto_class
->rule_construct(rule
);
3174 op
->group
->n_running
--;
3175 ofoperation_destroy(rule
->pending
);
3177 delete_flow__(evict
, group
);
3179 ofopgroup_submit(group
);
3183 /* Back out if an error occurred. */
3185 oftable_substitute_rule(rule
, victim
);
3186 ofproto_rule_destroy__(rule
);
3191 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
3193 /* Modifies the rules listed in 'rules', changing their actions to match those
3196 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3199 * Returns 0 on success, otherwise an OpenFlow error code. */
3201 modify_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3202 const struct ofputil_flow_mod
*fm
,
3203 const struct ofp_header
*request
, struct list
*rules
)
3205 struct ofopgroup
*group
;
3209 group
= ofopgroup_create(ofproto
, ofconn
, request
, fm
->buffer_id
);
3210 error
= OFPERR_OFPBRC_EPERM
;
3211 LIST_FOR_EACH (rule
, ofproto_node
, rules
) {
3212 struct ofoperation
*op
;
3213 bool actions_changed
;
3214 ovs_be64 new_cookie
;
3216 if (rule_is_modifiable(rule
)) {
3217 /* At least one rule is modifiable, don't report EPERM error. */
3223 actions_changed
= !ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
3224 rule
->ofpacts
, rule
->ofpacts_len
);
3225 new_cookie
= (fm
->new_cookie
!= htonll(UINT64_MAX
)
3227 : rule
->flow_cookie
);
3228 if (!actions_changed
&& new_cookie
== rule
->flow_cookie
) {
3229 /* No change at all. */
3233 op
= ofoperation_create(group
, rule
, OFOPERATION_MODIFY
, 0);
3234 rule
->flow_cookie
= new_cookie
;
3235 if (actions_changed
) {
3236 op
->ofpacts
= rule
->ofpacts
;
3237 op
->ofpacts_len
= rule
->ofpacts_len
;
3238 rule
->ofpacts
= xmemdup(fm
->ofpacts
, fm
->ofpacts_len
);
3239 rule
->ofpacts_len
= fm
->ofpacts_len
;
3240 rule
->ofproto
->ofproto_class
->rule_modify_actions(rule
);
3242 ofoperation_complete(op
, 0);
3245 ofopgroup_submit(group
);
3251 modify_flows_add(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3252 const struct ofputil_flow_mod
*fm
,
3253 const struct ofp_header
*request
)
3255 if (fm
->cookie_mask
!= htonll(0) || fm
->new_cookie
== htonll(UINT64_MAX
)) {
3258 return add_flow(ofproto
, ofconn
, fm
, request
);
3261 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
3264 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3267 modify_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3268 const struct ofputil_flow_mod
*fm
,
3269 const struct ofp_header
*request
)
3274 error
= collect_rules_loose(ofproto
, fm
->table_id
, &fm
->match
,
3275 fm
->cookie
, fm
->cookie_mask
,
3279 } else if (list_is_empty(&rules
)) {
3280 return modify_flows_add(ofproto
, ofconn
, fm
, request
);
3282 return modify_flows__(ofproto
, ofconn
, fm
, request
, &rules
);
3286 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
3289 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
3292 modify_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3293 const struct ofputil_flow_mod
*fm
,
3294 const struct ofp_header
*request
)
3299 error
= collect_rules_strict(ofproto
, fm
->table_id
, &fm
->match
,
3300 fm
->priority
, fm
->cookie
, fm
->cookie_mask
,
3305 } else if (list_is_empty(&rules
)) {
3306 return modify_flows_add(ofproto
, ofconn
, fm
, request
);
3308 return list_is_singleton(&rules
) ? modify_flows__(ofproto
, ofconn
,
3309 fm
, request
, &rules
)
3314 /* OFPFC_DELETE implementation. */
3317 delete_flow__(struct rule
*rule
, struct ofopgroup
*group
)
3319 struct ofproto
*ofproto
= rule
->ofproto
;
3321 ofproto_rule_send_removed(rule
, OFPRR_DELETE
);
3323 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, OFPRR_DELETE
);
3324 oftable_remove_rule(rule
);
3325 ofproto
->ofproto_class
->rule_destruct(rule
);
3328 /* Deletes the rules listed in 'rules'.
3330 * Returns 0 on success, otherwise an OpenFlow error code. */
3332 delete_flows__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3333 const struct ofp_header
*request
, struct list
*rules
)
3335 struct rule
*rule
, *next
;
3336 struct ofopgroup
*group
;
3338 group
= ofopgroup_create(ofproto
, ofconn
, request
, UINT32_MAX
);
3339 LIST_FOR_EACH_SAFE (rule
, next
, ofproto_node
, rules
) {
3340 delete_flow__(rule
, group
);
3342 ofopgroup_submit(group
);
3347 /* Implements OFPFC_DELETE. */
3349 delete_flows_loose(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3350 const struct ofputil_flow_mod
*fm
,
3351 const struct ofp_header
*request
)
3356 error
= collect_rules_loose(ofproto
, fm
->table_id
, &fm
->match
,
3357 fm
->cookie
, fm
->cookie_mask
,
3358 fm
->out_port
, &rules
);
3359 return (error
? error
3360 : !list_is_empty(&rules
) ? delete_flows__(ofproto
, ofconn
, request
,
3365 /* Implements OFPFC_DELETE_STRICT. */
3367 delete_flow_strict(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3368 const struct ofputil_flow_mod
*fm
,
3369 const struct ofp_header
*request
)
3374 error
= collect_rules_strict(ofproto
, fm
->table_id
, &fm
->match
,
3375 fm
->priority
, fm
->cookie
, fm
->cookie_mask
,
3376 fm
->out_port
, &rules
);
3377 return (error
? error
3378 : list_is_singleton(&rules
) ? delete_flows__(ofproto
, ofconn
,
3384 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
3386 struct ofputil_flow_removed fr
;
3388 if (ofproto_rule_is_hidden(rule
) || !rule
->send_flow_removed
) {
3392 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
3393 fr
.priority
= rule
->cr
.priority
;
3394 fr
.cookie
= rule
->flow_cookie
;
3396 fr
.table_id
= rule
->table_id
;
3397 calc_flow_duration__(rule
->created
, time_msec(),
3398 &fr
.duration_sec
, &fr
.duration_nsec
);
3399 fr
.idle_timeout
= rule
->idle_timeout
;
3400 fr
.hard_timeout
= rule
->hard_timeout
;
3401 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
3404 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
3408 ofproto_rule_update_used(struct rule
*rule
, long long int used
)
3410 if (used
> rule
->used
) {
3411 struct eviction_group
*evg
= rule
->eviction_group
;
3415 heap_change(&evg
->rules
, &rule
->evg_node
,
3416 rule_eviction_priority(rule
));
3421 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
3422 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
3425 * 'rule' must not have a pending operation (that is, 'rule->pending' must be
3428 * ofproto implementation ->run() functions should use this function to expire
3429 * OpenFlow flows. */
3431 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
3433 struct ofproto
*ofproto
= rule
->ofproto
;
3434 struct ofopgroup
*group
;
3436 assert(reason
== OFPRR_HARD_TIMEOUT
|| reason
== OFPRR_IDLE_TIMEOUT
);
3438 ofproto_rule_send_removed(rule
, reason
);
3440 group
= ofopgroup_create_unattached(ofproto
);
3441 ofoperation_create(group
, rule
, OFOPERATION_DELETE
, reason
);
3442 oftable_remove_rule(rule
);
3443 ofproto
->ofproto_class
->rule_destruct(rule
);
3444 ofopgroup_submit(group
);
3448 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3450 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3451 struct ofputil_flow_mod fm
;
3452 uint64_t ofpacts_stub
[1024 / 8];
3453 struct ofpbuf ofpacts
;
3457 error
= reject_slave_controller(ofconn
);
3462 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3463 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
3466 goto exit_free_ofpacts
;
3469 if (fm
.flags
& OFPFF10_EMERG
) {
3470 /* We do not support the OpenFlow 1.0 emergency flow cache, which
3471 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
3472 * There is no good error code, so just state that the flow table
3474 error
= OFPERR_OFPFMFC_TABLE_FULL
;
3477 error
= ofpacts_check(fm
.ofpacts
, fm
.ofpacts_len
,
3478 &fm
.match
.flow
, ofproto
->max_ports
);
3481 error
= handle_flow_mod__(ofconn_get_ofproto(ofconn
), ofconn
, &fm
, oh
);
3484 goto exit_free_ofpacts
;
3487 /* Record the operation for logging a summary report. */
3488 switch (fm
.command
) {
3494 case OFPFC_MODIFY_STRICT
:
3495 ofproto
->n_modify
++;
3499 case OFPFC_DELETE_STRICT
:
3500 ofproto
->n_delete
++;
3505 if (ofproto
->next_op_report
== LLONG_MAX
) {
3506 ofproto
->first_op
= now
;
3507 ofproto
->next_op_report
= MAX(now
+ 10 * 1000,
3508 ofproto
->op_backoff
);
3509 ofproto
->op_backoff
= ofproto
->next_op_report
+ 60 * 1000;
3511 ofproto
->last_op
= now
;
3514 ofpbuf_uninit(&ofpacts
);
3520 handle_flow_mod__(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
3521 const struct ofputil_flow_mod
*fm
,
3522 const struct ofp_header
*oh
)
3524 if (ofproto
->n_pending
>= 50) {
3525 assert(!list_is_empty(&ofproto
->pending
));
3526 return OFPROTO_POSTPONE
;
3529 switch (fm
->command
) {
3531 return add_flow(ofproto
, ofconn
, fm
, oh
);
3534 return modify_flows_loose(ofproto
, ofconn
, fm
, oh
);
3536 case OFPFC_MODIFY_STRICT
:
3537 return modify_flow_strict(ofproto
, ofconn
, fm
, oh
);
3540 return delete_flows_loose(ofproto
, ofconn
, fm
, oh
);
3542 case OFPFC_DELETE_STRICT
:
3543 return delete_flow_strict(ofproto
, ofconn
, fm
, oh
);
3546 if (fm
->command
> 0xff) {
3547 VLOG_WARN_RL(&rl
, "%s: flow_mod has explicit table_id but "
3548 "flow_mod_table_id extension is not enabled",
3551 return OFPERR_OFPFMFC_BAD_COMMAND
;
3556 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3558 const struct nx_role_request
*nrr
= ofpmsg_body(oh
);
3559 struct nx_role_request
*reply
;
3563 role
= ntohl(nrr
->role
);
3564 if (role
!= NX_ROLE_OTHER
&& role
!= NX_ROLE_MASTER
3565 && role
!= NX_ROLE_SLAVE
) {
3566 return OFPERR_OFPRRFC_BAD_ROLE
;
3569 if (ofconn_get_role(ofconn
) != role
3570 && ofconn_has_pending_opgroups(ofconn
)) {
3571 return OFPROTO_POSTPONE
;
3574 ofconn_set_role(ofconn
, role
);
3576 buf
= ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY
, oh
, 0);
3577 reply
= ofpbuf_put_zeros(buf
, sizeof *reply
);
3578 reply
->role
= htonl(role
);
3579 ofconn_send_reply(ofconn
, buf
);
3585 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
3586 const struct ofp_header
*oh
)
3588 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
3589 enum ofputil_protocol cur
, next
;
3591 cur
= ofconn_get_protocol(ofconn
);
3592 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
3593 ofconn_set_protocol(ofconn
, next
);
3599 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3601 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
3602 enum ofputil_protocol cur
, next
;
3603 enum ofputil_protocol next_base
;
3605 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
3607 return OFPERR_OFPBRC_EPERM
;
3610 cur
= ofconn_get_protocol(ofconn
);
3611 next
= ofputil_protocol_set_base(cur
, next_base
);
3612 if (cur
!= next
&& ofconn_has_pending_opgroups(ofconn
)) {
3613 /* Avoid sending async messages in surprising protocol. */
3614 return OFPROTO_POSTPONE
;
3617 ofconn_set_protocol(ofconn
, next
);
3622 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
3623 const struct ofp_header
*oh
)
3625 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
3628 format
= ntohl(msg
->format
);
3629 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
3630 return OFPERR_OFPBRC_EPERM
;
3633 if (format
!= ofconn_get_packet_in_format(ofconn
)
3634 && ofconn_has_pending_opgroups(ofconn
)) {
3635 /* Avoid sending async message in surprsing packet in format. */
3636 return OFPROTO_POSTPONE
;
3639 ofconn_set_packet_in_format(ofconn
, format
);
3644 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3646 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
3647 uint32_t master
[OAM_N_TYPES
];
3648 uint32_t slave
[OAM_N_TYPES
];
3650 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
3651 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
3652 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
3654 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
3655 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
3656 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
3658 ofconn_set_async_config(ofconn
, master
, slave
);
3659 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
3660 !ofconn_get_miss_send_len(ofconn
)) {
3661 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
3668 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
3669 const struct ofp_header
*oh
)
3671 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
3673 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
3674 return OFPERR_NXBRC_MUST_BE_ZERO
;
3677 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
3682 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3686 if (ofconn_has_pending_opgroups(ofconn
)) {
3687 return OFPROTO_POSTPONE
;
3690 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
3691 ? OFPRAW_OFPT10_BARRIER_REPLY
3692 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
3693 ofconn_send_reply(ofconn
, buf
);
3698 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
3699 enum nx_flow_monitor_flags flags
,
3702 struct ofoperation
*op
= rule
->pending
;
3703 struct ofputil_flow_update fu
;
3706 if (op
&& op
->type
== OFOPERATION_ADD
&& !op
->victim
) {
3707 /* We'll report the final flow when the operation completes. Reporting
3708 * it now would cause a duplicate report later. */
3712 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
3713 ? NXFME_ADDED
: NXFME_MODIFIED
);
3715 fu
.idle_timeout
= rule
->idle_timeout
;
3716 fu
.hard_timeout
= rule
->hard_timeout
;
3717 fu
.table_id
= rule
->table_id
;
3718 fu
.cookie
= rule
->flow_cookie
;
3719 minimatch_expand(&rule
->cr
.match
, &match
);
3721 fu
.priority
= rule
->cr
.priority
;
3722 if (!(flags
& NXFMF_ACTIONS
)) {
3726 fu
.ofpacts
= rule
->ofpacts
;
3727 fu
.ofpacts_len
= rule
->ofpacts_len
;
3729 /* An operation is in progress. Use the previous version of the flow's
3730 * actions, so that when the operation commits we report the change. */
3732 case OFOPERATION_ADD
:
3733 /* We already verified that there was a victim. */
3734 fu
.ofpacts
= op
->victim
->ofpacts
;
3735 fu
.ofpacts_len
= op
->victim
->ofpacts_len
;
3738 case OFOPERATION_MODIFY
:
3740 fu
.ofpacts
= op
->ofpacts
;
3741 fu
.ofpacts_len
= op
->ofpacts_len
;
3743 fu
.ofpacts
= rule
->ofpacts
;
3744 fu
.ofpacts_len
= rule
->ofpacts_len
;
3748 case OFOPERATION_DELETE
:
3749 fu
.ofpacts
= rule
->ofpacts
;
3750 fu
.ofpacts_len
= rule
->ofpacts_len
;
3758 if (list_is_empty(msgs
)) {
3759 ofputil_start_flow_update(msgs
);
3761 ofputil_append_flow_update(&fu
, msgs
);
3765 ofmonitor_compose_refresh_updates(struct list
*rules
, struct list
*msgs
)
3769 LIST_FOR_EACH (rule
, ofproto_node
, rules
) {
3770 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
3771 rule
->monitor_flags
= 0;
3773 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
3778 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
3779 struct rule
*rule
, uint64_t seqno
,
3782 enum nx_flow_monitor_flags update
;
3784 if (ofproto_rule_is_hidden(rule
)) {
3789 ? ofoperation_has_out_port(rule
->pending
, m
->out_port
)
3790 : ofproto_rule_has_out_port(rule
, m
->out_port
))) {
3795 if (rule
->add_seqno
> seqno
) {
3796 update
= NXFMF_ADD
| NXFMF_MODIFY
;
3797 } else if (rule
->modify_seqno
> seqno
) {
3798 update
= NXFMF_MODIFY
;
3803 if (!(m
->flags
& update
)) {
3807 update
= NXFMF_INITIAL
;
3810 if (!rule
->monitor_flags
) {
3811 list_push_back(rules
, &rule
->ofproto_node
);
3813 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
3817 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
3821 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
3822 const struct ofoperation
*op
;
3823 const struct oftable
*table
;
3824 struct cls_rule target
;
3826 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
3827 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
3828 struct cls_cursor cursor
;
3831 cls_cursor_init(&cursor
, &table
->cls
, &target
);
3832 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
3833 assert(!rule
->pending
); /* XXX */
3834 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
3838 HMAP_FOR_EACH (op
, hmap_node
, &ofproto
->deletions
) {
3839 struct rule
*rule
= op
->rule
;
3841 if (((m
->table_id
== 0xff
3842 ? !(ofproto
->tables
[rule
->table_id
].flags
& OFTABLE_HIDDEN
)
3843 : m
->table_id
== rule
->table_id
))
3844 && cls_rule_is_loose_match(&rule
->cr
, &target
.match
)) {
3845 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
3848 cls_rule_destroy(&target
);
3852 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
3855 if (m
->flags
& NXFMF_INITIAL
) {
3856 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
3861 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
3862 uint64_t seqno
, struct list
*rules
)
3864 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
3868 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3870 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3871 struct ofmonitor
**monitors
;
3872 size_t n_monitors
, allocated_monitors
;
3873 struct list replies
;
3880 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
3882 n_monitors
= allocated_monitors
= 0;
3884 struct ofputil_flow_monitor_request request
;
3885 struct ofmonitor
*m
;
3888 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
3889 if (retval
== EOF
) {
3891 } else if (retval
) {
3896 if (request
.table_id
!= 0xff
3897 && request
.table_id
>= ofproto
->n_tables
) {
3898 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3902 error
= ofmonitor_create(&request
, ofconn
, &m
);
3907 if (n_monitors
>= allocated_monitors
) {
3908 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
3911 monitors
[n_monitors
++] = m
;
3915 for (i
= 0; i
< n_monitors
; i
++) {
3916 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
3919 ofpmp_init(&replies
, oh
);
3920 ofmonitor_compose_refresh_updates(&rules
, &replies
);
3921 ofconn_send_replies(ofconn
, &replies
);
3928 for (i
= 0; i
< n_monitors
; i
++) {
3929 ofmonitor_destroy(monitors
[i
]);
3936 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3938 struct ofmonitor
*m
;
3941 id
= ofputil_decode_flow_monitor_cancel(oh
);
3942 m
= ofmonitor_lookup(ofconn
, id
);
3944 return OFPERR_NXBRC_FM_BAD_ID
;
3947 ofmonitor_destroy(m
);
3952 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
3954 const struct ofp_header
*oh
= msg
->data
;
3958 error
= ofptype_decode(&type
, oh
);
3964 /* OpenFlow requests. */
3965 case OFPTYPE_ECHO_REQUEST
:
3966 return handle_echo_request(ofconn
, oh
);
3968 case OFPTYPE_FEATURES_REQUEST
:
3969 return handle_features_request(ofconn
, oh
);
3971 case OFPTYPE_GET_CONFIG_REQUEST
:
3972 return handle_get_config_request(ofconn
, oh
);
3974 case OFPTYPE_SET_CONFIG
:
3975 return handle_set_config(ofconn
, oh
);
3977 case OFPTYPE_PACKET_OUT
:
3978 return handle_packet_out(ofconn
, oh
);
3980 case OFPTYPE_PORT_MOD
:
3981 return handle_port_mod(ofconn
, oh
);
3983 case OFPTYPE_FLOW_MOD
:
3984 return handle_flow_mod(ofconn
, oh
);
3986 case OFPTYPE_BARRIER_REQUEST
:
3987 return handle_barrier_request(ofconn
, oh
);
3989 /* OpenFlow replies. */
3990 case OFPTYPE_ECHO_REPLY
:
3993 /* Nicira extension requests. */
3994 case OFPTYPE_ROLE_REQUEST
:
3995 return handle_role_request(ofconn
, oh
);
3997 case OFPTYPE_FLOW_MOD_TABLE_ID
:
3998 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
4000 case OFPTYPE_SET_FLOW_FORMAT
:
4001 return handle_nxt_set_flow_format(ofconn
, oh
);
4003 case OFPTYPE_SET_PACKET_IN_FORMAT
:
4004 return handle_nxt_set_packet_in_format(ofconn
, oh
);
4006 case OFPTYPE_SET_CONTROLLER_ID
:
4007 return handle_nxt_set_controller_id(ofconn
, oh
);
4009 case OFPTYPE_FLOW_AGE
:
4010 /* Nothing to do. */
4013 case OFPTYPE_FLOW_MONITOR_CANCEL
:
4014 return handle_flow_monitor_cancel(ofconn
, oh
);
4016 case OFPTYPE_SET_ASYNC_CONFIG
:
4017 return handle_nxt_set_async_config(ofconn
, oh
);
4019 /* Statistics requests. */
4020 case OFPTYPE_DESC_STATS_REQUEST
:
4021 return handle_desc_stats_request(ofconn
, oh
);
4023 case OFPTYPE_FLOW_STATS_REQUEST
:
4024 return handle_flow_stats_request(ofconn
, oh
);
4026 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
4027 return handle_aggregate_stats_request(ofconn
, oh
);
4029 case OFPTYPE_TABLE_STATS_REQUEST
:
4030 return handle_table_stats_request(ofconn
, oh
);
4032 case OFPTYPE_PORT_STATS_REQUEST
:
4033 return handle_port_stats_request(ofconn
, oh
);
4035 case OFPTYPE_QUEUE_STATS_REQUEST
:
4036 return handle_queue_stats_request(ofconn
, oh
);
4038 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
4039 return handle_port_desc_stats_request(ofconn
, oh
);
4041 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
4042 return handle_flow_monitor_request(ofconn
, oh
);
4046 case OFPTYPE_FEATURES_REPLY
:
4047 case OFPTYPE_GET_CONFIG_REPLY
:
4048 case OFPTYPE_PACKET_IN
:
4049 case OFPTYPE_FLOW_REMOVED
:
4050 case OFPTYPE_PORT_STATUS
:
4051 case OFPTYPE_BARRIER_REPLY
:
4052 case OFPTYPE_DESC_STATS_REPLY
:
4053 case OFPTYPE_FLOW_STATS_REPLY
:
4054 case OFPTYPE_QUEUE_STATS_REPLY
:
4055 case OFPTYPE_PORT_STATS_REPLY
:
4056 case OFPTYPE_TABLE_STATS_REPLY
:
4057 case OFPTYPE_AGGREGATE_STATS_REPLY
:
4058 case OFPTYPE_PORT_DESC_STATS_REPLY
:
4059 case OFPTYPE_ROLE_REPLY
:
4060 case OFPTYPE_FLOW_MONITOR_PAUSED
:
4061 case OFPTYPE_FLOW_MONITOR_RESUMED
:
4062 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
4064 return OFPERR_OFPBRC_BAD_TYPE
;
4069 handle_openflow(struct ofconn
*ofconn
, struct ofpbuf
*ofp_msg
)
4071 int error
= handle_openflow__(ofconn
, ofp_msg
);
4072 if (error
&& error
!= OFPROTO_POSTPONE
) {
4073 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
4075 COVERAGE_INC(ofproto_recv_openflow
);
4076 return error
!= OFPROTO_POSTPONE
;
4079 /* Asynchronous operations. */
4081 /* Creates and returns a new ofopgroup that is not associated with any
4082 * OpenFlow connection.
4084 * The caller should add operations to the returned group with
4085 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4086 static struct ofopgroup
*
4087 ofopgroup_create_unattached(struct ofproto
*ofproto
)
4089 struct ofopgroup
*group
= xzalloc(sizeof *group
);
4090 group
->ofproto
= ofproto
;
4091 list_init(&group
->ofproto_node
);
4092 list_init(&group
->ops
);
4093 list_init(&group
->ofconn_node
);
4097 /* Creates and returns a new ofopgroup for 'ofproto'.
4099 * If 'ofconn' is NULL, the new ofopgroup is not associated with any OpenFlow
4100 * connection. The 'request' and 'buffer_id' arguments are ignored.
4102 * If 'ofconn' is nonnull, then the new ofopgroup is associated with 'ofconn'.
4103 * If the ofopgroup eventually fails, then the error reply will include
4104 * 'request'. If the ofopgroup eventually succeeds, then the packet with
4105 * buffer id 'buffer_id' on 'ofconn' will be sent by 'ofconn''s ofproto.
4107 * The caller should add operations to the returned group with
4108 * ofoperation_create() and then submit it with ofopgroup_submit(). */
4109 static struct ofopgroup
*
4110 ofopgroup_create(struct ofproto
*ofproto
, struct ofconn
*ofconn
,
4111 const struct ofp_header
*request
, uint32_t buffer_id
)
4113 struct ofopgroup
*group
= ofopgroup_create_unattached(ofproto
);
4115 size_t request_len
= ntohs(request
->length
);
4117 assert(ofconn_get_ofproto(ofconn
) == ofproto
);
4119 ofconn_add_opgroup(ofconn
, &group
->ofconn_node
);
4120 group
->ofconn
= ofconn
;
4121 group
->request
= xmemdup(request
, MIN(request_len
, 64));
4122 group
->buffer_id
= buffer_id
;
4127 /* Submits 'group' for processing.
4129 * If 'group' contains no operations (e.g. none were ever added, or all of the
4130 * ones that were added completed synchronously), then it is destroyed
4131 * immediately. Otherwise it is added to the ofproto's list of pending
4134 ofopgroup_submit(struct ofopgroup
*group
)
4136 if (!group
->n_running
) {
4137 ofopgroup_complete(group
);
4139 list_push_back(&group
->ofproto
->pending
, &group
->ofproto_node
);
4140 group
->ofproto
->n_pending
++;
4145 ofopgroup_complete(struct ofopgroup
*group
)
4147 struct ofproto
*ofproto
= group
->ofproto
;
4149 struct ofconn
*abbrev_ofconn
;
4150 ovs_be32 abbrev_xid
;
4152 struct ofoperation
*op
, *next_op
;
4155 assert(!group
->n_running
);
4158 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
4165 if (!error
&& group
->ofconn
&& group
->buffer_id
!= UINT32_MAX
) {
4166 LIST_FOR_EACH (op
, group_node
, &group
->ops
) {
4167 if (op
->type
!= OFOPERATION_DELETE
) {
4168 struct ofpbuf
*packet
;
4171 error
= ofconn_pktbuf_retrieve(group
->ofconn
, group
->buffer_id
,
4175 error
= rule_execute(op
->rule
, in_port
, packet
);
4182 if (!error
&& !list_is_empty(&group
->ofconn_node
)) {
4183 abbrev_ofconn
= group
->ofconn
;
4184 abbrev_xid
= group
->request
->xid
;
4186 abbrev_ofconn
= NULL
;
4187 abbrev_xid
= htonl(0);
4189 LIST_FOR_EACH_SAFE (op
, next_op
, group_node
, &group
->ops
) {
4190 struct rule
*rule
= op
->rule
;
4192 if (!op
->error
&& !ofproto_rule_is_hidden(rule
)) {
4193 /* Check that we can just cast from ofoperation_type to
4194 * nx_flow_update_event. */
4195 BUILD_ASSERT_DECL((enum nx_flow_update_event
) OFOPERATION_ADD
4197 BUILD_ASSERT_DECL((enum nx_flow_update_event
) OFOPERATION_DELETE
4199 BUILD_ASSERT_DECL((enum nx_flow_update_event
) OFOPERATION_MODIFY
4202 ofmonitor_report(ofproto
->connmgr
, rule
,
4203 (enum nx_flow_update_event
) op
->type
,
4204 op
->reason
, abbrev_ofconn
, abbrev_xid
);
4207 rule
->pending
= NULL
;
4210 case OFOPERATION_ADD
:
4214 ofproto_rule_destroy__(op
->victim
);
4215 vid_mask
= minimask_get_vid_mask(&rule
->cr
.match
.mask
);
4216 if (vid_mask
== VLAN_VID_MASK
) {
4217 if (ofproto
->vlan_bitmap
) {
4218 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
4219 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
4220 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
4221 ofproto
->vlans_changed
= true;
4224 ofproto
->vlans_changed
= true;
4228 oftable_substitute_rule(rule
, op
->victim
);
4229 ofproto_rule_destroy__(rule
);
4233 case OFOPERATION_DELETE
:
4235 ofproto_rule_destroy__(rule
);
4239 case OFOPERATION_MODIFY
:
4241 rule
->modified
= time_msec();
4243 rule
->flow_cookie
= op
->flow_cookie
;
4245 free(rule
->ofpacts
);
4246 rule
->ofpacts
= op
->ofpacts
;
4247 rule
->ofpacts_len
= op
->ofpacts_len
;
4249 op
->ofpacts_len
= 0;
4258 ofoperation_destroy(op
);
4261 ofmonitor_flush(ofproto
->connmgr
);
4263 if (!list_is_empty(&group
->ofproto_node
)) {
4264 assert(ofproto
->n_pending
> 0);
4265 ofproto
->n_pending
--;
4266 list_remove(&group
->ofproto_node
);
4268 if (!list_is_empty(&group
->ofconn_node
)) {
4269 list_remove(&group
->ofconn_node
);
4271 ofconn_send_error(group
->ofconn
, group
->request
, error
);
4273 connmgr_retry(ofproto
->connmgr
);
4275 free(group
->request
);
4279 /* Initiates a new operation on 'rule', of the specified 'type', within
4280 * 'group'. Prior to calling, 'rule' must not have any pending operation.
4282 * For a 'type' of OFOPERATION_DELETE, 'reason' should specify the reason that
4283 * the flow is being deleted. For other 'type's, 'reason' is ignored (use 0).
4285 * Returns the newly created ofoperation (which is also available as
4286 * rule->pending). */
4287 static struct ofoperation
*
4288 ofoperation_create(struct ofopgroup
*group
, struct rule
*rule
,
4289 enum ofoperation_type type
,
4290 enum ofp_flow_removed_reason reason
)
4292 struct ofproto
*ofproto
= group
->ofproto
;
4293 struct ofoperation
*op
;
4295 assert(!rule
->pending
);
4297 op
= rule
->pending
= xzalloc(sizeof *op
);
4299 list_push_back(&group
->ops
, &op
->group_node
);
4302 op
->reason
= reason
;
4303 op
->flow_cookie
= rule
->flow_cookie
;
4307 if (type
== OFOPERATION_DELETE
) {
4308 hmap_insert(&ofproto
->deletions
, &op
->hmap_node
,
4309 cls_rule_hash(&rule
->cr
, rule
->table_id
));
4316 ofoperation_destroy(struct ofoperation
*op
)
4318 struct ofopgroup
*group
= op
->group
;
4321 op
->rule
->pending
= NULL
;
4323 if (op
->type
== OFOPERATION_DELETE
) {
4324 hmap_remove(&group
->ofproto
->deletions
, &op
->hmap_node
);
4326 list_remove(&op
->group_node
);
4331 /* Indicates that 'op' completed with status 'error', which is either 0 to
4332 * indicate success or an OpenFlow error code on failure.
4334 * If 'error' is 0, indicating success, the operation will be committed
4335 * permanently to the flow table. There is one interesting subcase:
4337 * - If 'op' is an "add flow" operation that is replacing an existing rule in
4338 * the flow table (the "victim" rule) by a new one, then the caller must
4339 * have uninitialized any derived state in the victim rule, as in step 5 in
4340 * the "Life Cycle" in ofproto/ofproto-provider.h. ofoperation_complete()
4341 * performs steps 6 and 7 for the victim rule, most notably by calling its
4342 * ->rule_dealloc() function.
4344 * If 'error' is nonzero, then generally the operation will be rolled back:
4346 * - If 'op' is an "add flow" operation, ofproto removes the new rule or
4347 * restores the original rule. The caller must have uninitialized any
4348 * derived state in the new rule, as in step 5 of in the "Life Cycle" in
4349 * ofproto/ofproto-provider.h. ofoperation_complete() performs steps 6 and
4350 * and 7 for the new rule, calling its ->rule_dealloc() function.
4352 * - If 'op' is a "modify flow" operation, ofproto restores the original
4355 * - 'op' must not be a "delete flow" operation. Removing a rule is not
4356 * allowed to fail. It must always succeed.
4358 * Please see the large comment in ofproto/ofproto-provider.h titled
4359 * "Asynchronous Operation Support" for more information. */
4361 ofoperation_complete(struct ofoperation
*op
, enum ofperr error
)
4363 struct ofopgroup
*group
= op
->group
;
4365 assert(op
->rule
->pending
== op
);
4366 assert(group
->n_running
> 0);
4367 assert(!error
|| op
->type
!= OFOPERATION_DELETE
);
4370 if (!--group
->n_running
&& !list_is_empty(&group
->ofproto_node
)) {
4371 ofopgroup_complete(group
);
4376 ofoperation_get_victim(struct ofoperation
*op
)
4378 assert(op
->type
== OFOPERATION_ADD
);
4383 pick_datapath_id(const struct ofproto
*ofproto
)
4385 const struct ofport
*port
;
4387 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
4389 uint8_t ea
[ETH_ADDR_LEN
];
4392 error
= netdev_get_etheraddr(port
->netdev
, ea
);
4394 return eth_addr_to_uint64(ea
);
4396 VLOG_WARN("%s: could not get MAC address for %s (%s)",
4397 ofproto
->name
, netdev_get_name(port
->netdev
),
4400 return ofproto
->fallback_dpid
;
4404 pick_fallback_dpid(void)
4406 uint8_t ea
[ETH_ADDR_LEN
];
4407 eth_addr_nicira_random(ea
);
4408 return eth_addr_to_uint64(ea
);
4411 /* Table overflow policy. */
4413 /* Chooses and returns a rule to evict from 'table'. Returns NULL if the table
4414 * is not configured to evict rules or if the table contains no evictable
4415 * rules. (Rules with 'evictable' set to false or with no timeouts are not
4417 static struct rule
*
4418 choose_rule_to_evict(struct oftable
*table
)
4420 struct eviction_group
*evg
;
4422 if (!table
->eviction_fields
) {
4426 /* In the common case, the outer and inner loops here will each be entered
4429 * - The inner loop normally "return"s in its first iteration. If the
4430 * eviction group has any evictable rules, then it always returns in
4433 * - The outer loop only iterates more than once if the largest eviction
4434 * group has no evictable rules.
4436 * - The outer loop can exit only if table's 'max_flows' is all filled up
4437 * by unevictable rules'. */
4438 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
4441 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
4442 if (rule
->evictable
) {
4451 /* Searches 'ofproto' for tables that have more flows than their configured
4452 * maximum and that have flow eviction enabled, and evicts as many flows as
4453 * necessary and currently feasible from them.
4455 * This triggers only when an OpenFlow table has N flows in it and then the
4456 * client configures a maximum number of flows less than N. */
4458 ofproto_evict(struct ofproto
*ofproto
)
4460 struct ofopgroup
*group
;
4461 struct oftable
*table
;
4463 group
= ofopgroup_create_unattached(ofproto
);
4464 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
4465 while (classifier_count(&table
->cls
) > table
->max_flows
4466 && table
->eviction_fields
) {
4469 rule
= choose_rule_to_evict(table
);
4470 if (!rule
|| rule
->pending
) {
4474 ofoperation_create(group
, rule
,
4475 OFOPERATION_DELETE
, OFPRR_EVICTION
);
4476 oftable_remove_rule(rule
);
4477 ofproto
->ofproto_class
->rule_destruct(rule
);
4480 ofopgroup_submit(group
);
4483 /* Eviction groups. */
4485 /* Returns the priority to use for an eviction_group that contains 'n_rules'
4486 * rules. The priority contains low-order random bits to ensure that eviction
4487 * groups with the same number of rules are prioritized randomly. */
4489 eviction_group_priority(size_t n_rules
)
4491 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
4492 return (size
<< 16) | random_uint16();
4495 /* Updates 'evg', an eviction_group within 'table', following a change that
4496 * adds or removes rules in 'evg'. */
4498 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
4500 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
4501 eviction_group_priority(heap_count(&evg
->rules
)));
4504 /* Destroys 'evg', an eviction_group within 'table':
4506 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
4507 * rules themselves, just removes them from the eviction group.)
4509 * - Removes 'evg' from 'table'.
4513 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
4515 while (!heap_is_empty(&evg
->rules
)) {
4518 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
4519 rule
->eviction_group
= NULL
;
4521 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
4522 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
4523 heap_destroy(&evg
->rules
);
4527 /* Removes 'rule' from its eviction group, if any. */
4529 eviction_group_remove_rule(struct rule
*rule
)
4531 if (rule
->eviction_group
) {
4532 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
4533 struct eviction_group
*evg
= rule
->eviction_group
;
4535 rule
->eviction_group
= NULL
;
4536 heap_remove(&evg
->rules
, &rule
->evg_node
);
4537 if (heap_is_empty(&evg
->rules
)) {
4538 eviction_group_destroy(table
, evg
);
4540 eviction_group_resized(table
, evg
);
4545 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
4546 * returns the hash value. */
4548 eviction_group_hash_rule(struct rule
*rule
)
4550 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
4551 const struct mf_subfield
*sf
;
4555 hash
= table
->eviction_group_id_basis
;
4556 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
4557 for (sf
= table
->eviction_fields
;
4558 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
4561 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
4562 union mf_value value
;
4564 mf_get_value(sf
->field
, &flow
, &value
);
4566 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
4568 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
4569 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
4570 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
4571 sf
->field
->n_bytes
* 8 - start
);
4573 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
4575 hash
= hash_int(hash
, 0);
4582 /* Returns an eviction group within 'table' with the given 'id', creating one
4584 static struct eviction_group
*
4585 eviction_group_find(struct oftable
*table
, uint32_t id
)
4587 struct eviction_group
*evg
;
4589 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
4593 evg
= xmalloc(sizeof *evg
);
4594 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
4595 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
4596 eviction_group_priority(0));
4597 heap_init(&evg
->rules
);
4602 /* Returns an eviction priority for 'rule'. The return value should be
4603 * interpreted so that higher priorities make a rule more attractive candidates
4606 rule_eviction_priority(struct rule
*rule
)
4608 long long int hard_expiration
;
4609 long long int idle_expiration
;
4610 long long int expiration
;
4611 uint32_t expiration_offset
;
4613 /* Calculate time of expiration. */
4614 hard_expiration
= (rule
->hard_timeout
4615 ? rule
->modified
+ rule
->hard_timeout
* 1000
4617 idle_expiration
= (rule
->idle_timeout
4618 ? rule
->used
+ rule
->idle_timeout
* 1000
4620 expiration
= MIN(hard_expiration
, idle_expiration
);
4621 if (expiration
== LLONG_MAX
) {
4625 /* Calculate the time of expiration as a number of (approximate) seconds
4626 * after program startup.
4628 * This should work OK for program runs that last UINT32_MAX seconds or
4629 * less. Therefore, please restart OVS at least once every 136 years. */
4630 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
4632 /* Invert the expiration offset because we're using a max-heap. */
4633 return UINT32_MAX
- expiration_offset
;
4636 /* Adds 'rule' to an appropriate eviction group for its oftable's
4637 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
4638 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
4641 * The caller must ensure that 'rule' is not already in an eviction group. */
4643 eviction_group_add_rule(struct rule
*rule
)
4645 struct ofproto
*ofproto
= rule
->ofproto
;
4646 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
4648 if (table
->eviction_fields
4649 && (rule
->hard_timeout
|| rule
->idle_timeout
)) {
4650 struct eviction_group
*evg
;
4652 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
4654 rule
->eviction_group
= evg
;
4655 heap_insert(&evg
->rules
, &rule
->evg_node
,
4656 rule_eviction_priority(rule
));
4657 eviction_group_resized(table
, evg
);
4663 /* Initializes 'table'. */
4665 oftable_init(struct oftable
*table
)
4667 memset(table
, 0, sizeof *table
);
4668 classifier_init(&table
->cls
);
4669 table
->max_flows
= UINT_MAX
;
4672 /* Destroys 'table', including its classifier and eviction groups.
4674 * The caller is responsible for freeing 'table' itself. */
4676 oftable_destroy(struct oftable
*table
)
4678 assert(classifier_is_empty(&table
->cls
));
4679 oftable_disable_eviction(table
);
4680 classifier_destroy(&table
->cls
);
4684 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
4685 * string, then 'table' will use its default name.
4687 * This only affects the name exposed for a table exposed through the OpenFlow
4688 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
4690 oftable_set_name(struct oftable
*table
, const char *name
)
4692 if (name
&& name
[0]) {
4693 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
4694 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
4696 table
->name
= xmemdup0(name
, len
);
4704 /* oftables support a choice of two policies when adding a rule would cause the
4705 * number of flows in the table to exceed the configured maximum number: either
4706 * they can refuse to add the new flow or they can evict some existing flow.
4707 * This function configures the former policy on 'table'. */
4709 oftable_disable_eviction(struct oftable
*table
)
4711 if (table
->eviction_fields
) {
4712 struct eviction_group
*evg
, *next
;
4714 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
4715 &table
->eviction_groups_by_id
) {
4716 eviction_group_destroy(table
, evg
);
4718 hmap_destroy(&table
->eviction_groups_by_id
);
4719 heap_destroy(&table
->eviction_groups_by_size
);
4721 free(table
->eviction_fields
);
4722 table
->eviction_fields
= NULL
;
4723 table
->n_eviction_fields
= 0;
4727 /* oftables support a choice of two policies when adding a rule would cause the
4728 * number of flows in the table to exceed the configured maximum number: either
4729 * they can refuse to add the new flow or they can evict some existing flow.
4730 * This function configures the latter policy on 'table', with fairness based
4731 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
4732 * 'n_fields' as 0 disables fairness.) */
4734 oftable_enable_eviction(struct oftable
*table
,
4735 const struct mf_subfield
*fields
, size_t n_fields
)
4737 struct cls_cursor cursor
;
4740 if (table
->eviction_fields
4741 && n_fields
== table
->n_eviction_fields
4743 || !memcmp(fields
, table
->eviction_fields
,
4744 n_fields
* sizeof *fields
))) {
4749 oftable_disable_eviction(table
);
4751 table
->n_eviction_fields
= n_fields
;
4752 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
4754 table
->eviction_group_id_basis
= random_uint32();
4755 hmap_init(&table
->eviction_groups_by_id
);
4756 heap_init(&table
->eviction_groups_by_size
);
4758 cls_cursor_init(&cursor
, &table
->cls
, NULL
);
4759 CLS_CURSOR_FOR_EACH (rule
, cr
, &cursor
) {
4760 eviction_group_add_rule(rule
);
4764 /* Removes 'rule' from the oftable that contains it. */
4766 oftable_remove_rule(struct rule
*rule
)
4768 struct ofproto
*ofproto
= rule
->ofproto
;
4769 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
4771 classifier_remove(&table
->cls
, &rule
->cr
);
4772 eviction_group_remove_rule(rule
);
4775 /* Inserts 'rule' into its oftable. Removes any existing rule from 'rule''s
4776 * oftable that has an identical cls_rule. Returns the rule that was removed,
4777 * if any, and otherwise NULL. */
4778 static struct rule
*
4779 oftable_replace_rule(struct rule
*rule
)
4781 struct ofproto
*ofproto
= rule
->ofproto
;
4782 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
4783 struct rule
*victim
;
4785 victim
= rule_from_cls_rule(classifier_replace(&table
->cls
, &rule
->cr
));
4787 eviction_group_remove_rule(victim
);
4789 eviction_group_add_rule(rule
);
4793 /* Removes 'old' from its oftable then, if 'new' is nonnull, inserts 'new'. */
4795 oftable_substitute_rule(struct rule
*old
, struct rule
*new)
4798 oftable_replace_rule(new);
4800 oftable_remove_rule(old
);
4804 /* unixctl commands. */
4807 ofproto_lookup(const char *name
)
4809 struct ofproto
*ofproto
;
4811 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
4813 if (!strcmp(ofproto
->name
, name
)) {
4821 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
4822 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
4824 struct ofproto
*ofproto
;
4828 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
4829 ds_put_format(&results
, "%s\n", ofproto
->name
);
4831 unixctl_command_reply(conn
, ds_cstr(&results
));
4832 ds_destroy(&results
);
4836 ofproto_unixctl_init(void)
4838 static bool registered
;
4844 unixctl_command_register("ofproto/list", "", 0, 0,
4845 ofproto_unixctl_list
, NULL
);
4848 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
4850 * This is deprecated. It is only for compatibility with broken device drivers
4851 * in old versions of Linux that do not properly support VLANs when VLAN
4852 * devices are not used. When broken device drivers are no longer in
4853 * widespread use, we will delete these interfaces. */
4855 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
4856 * (exactly) by an OpenFlow rule in 'ofproto'. */
4858 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
4860 const struct oftable
*oftable
;
4862 free(ofproto
->vlan_bitmap
);
4863 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
4864 ofproto
->vlans_changed
= false;
4866 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
4867 const struct cls_table
*table
;
4869 HMAP_FOR_EACH (table
, hmap_node
, &oftable
->cls
.tables
) {
4870 if (minimask_get_vid_mask(&table
->mask
) == VLAN_VID_MASK
) {
4871 const struct cls_rule
*rule
;
4873 HMAP_FOR_EACH (rule
, hmap_node
, &table
->rules
) {
4874 uint16_t vid
= miniflow_get_vid(&rule
->match
.flow
);
4875 bitmap_set1(vlan_bitmap
, vid
);
4876 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
4883 /* Returns true if new VLANs have come into use by the flow table since the
4884 * last call to ofproto_get_vlan_usage().
4886 * We don't track when old VLANs stop being used. */
4888 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
4890 return ofproto
->vlans_changed
;
4893 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
4894 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
4895 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
4896 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
4897 * then the VLAN device is un-enslaved. */
4899 ofproto_port_set_realdev(struct ofproto
*ofproto
, uint16_t vlandev_ofp_port
,
4900 uint16_t realdev_ofp_port
, int vid
)
4902 struct ofport
*ofport
;
4905 assert(vlandev_ofp_port
!= realdev_ofp_port
);
4907 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
4909 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
4910 ofproto
->name
, vlandev_ofp_port
);
4914 if (!ofproto
->ofproto_class
->set_realdev
) {
4915 if (!vlandev_ofp_port
) {
4918 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
4922 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
4924 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
4925 ofproto
->name
, vlandev_ofp_port
,
4926 netdev_get_name(ofport
->netdev
), strerror(error
));