2 * Copyright (c) 2009-2017 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.
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "connectivity.h"
32 #include "dp-packet.h"
34 #include "openvswitch/hmap.h"
38 #include "ofproto-provider.h"
39 #include "openflow/nicira-ext.h"
40 #include "openflow/openflow.h"
41 #include "openvswitch/dynamic-string.h"
42 #include "openvswitch/meta-flow.h"
43 #include "openvswitch/ofp-actions.h"
44 #include "openvswitch/ofp-errors.h"
45 #include "openvswitch/ofp-msgs.h"
46 #include "openvswitch/ofp-print.h"
47 #include "openvswitch/ofp-util.h"
48 #include "openvswitch/ofpbuf.h"
49 #include "openvswitch/vlog.h"
53 #include "poll-loop.h"
56 #include "openvswitch/shash.h"
61 #include "tun-metadata.h"
62 #include "unaligned.h"
66 VLOG_DEFINE_THIS_MODULE(ofproto
);
68 COVERAGE_DEFINE(ofproto_flush
);
69 COVERAGE_DEFINE(ofproto_packet_out
);
70 COVERAGE_DEFINE(ofproto_queue_req
);
71 COVERAGE_DEFINE(ofproto_recv_openflow
);
72 COVERAGE_DEFINE(ofproto_reinit_ports
);
73 COVERAGE_DEFINE(ofproto_update_port
);
75 /* Default fields to use for prefix tries in each flow table, unless something
76 * else is configured. */
77 const enum mf_field_id default_prefix_fields
[2] =
78 { MFF_IPV4_DST
, MFF_IPV4_SRC
};
81 static void oftable_init(struct oftable
*);
82 static void oftable_destroy(struct oftable
*);
84 static void oftable_set_name(struct oftable
*, const char *name
);
86 static enum ofperr
evict_rules_from_table(struct oftable
*)
87 OVS_REQUIRES(ofproto_mutex
);
88 static void oftable_configure_eviction(struct oftable
*,
89 unsigned int eviction
,
90 const struct mf_subfield
*fields
,
92 OVS_REQUIRES(ofproto_mutex
);
94 /* This is the only combination of OpenFlow eviction flags that OVS supports: a
95 * combination of OF1.4+ importance, the remaining lifetime of the flow, and
96 * fairness based on user-specified fields. */
97 #define OFPROTO_EVICTION_FLAGS \
98 (OFPTMPEF14_OTHER | OFPTMPEF14_IMPORTANCE | OFPTMPEF14_LIFETIME)
100 /* A set of rules within a single OpenFlow table (oftable) that have the same
101 * values for the oftable's eviction_fields. A rule to be evicted, when one is
102 * needed, is taken from the eviction group that contains the greatest number
105 * An oftable owns any number of eviction groups, each of which contains any
108 * Membership in an eviction group is imprecise, based on the hash of the
109 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
110 * That is, if two rules have different eviction_fields, but those
111 * eviction_fields hash to the same value, then they will belong to the same
112 * eviction_group anyway.
114 * (When eviction is not enabled on an oftable, we don't track any eviction
115 * groups, to save time and space.) */
116 struct eviction_group
{
117 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
118 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
119 struct heap rules
; /* Contains "struct rule"s. */
122 static bool choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
123 OVS_REQUIRES(ofproto_mutex
);
124 static uint64_t rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*)
125 OVS_REQUIRES(ofproto_mutex
);
126 static void eviction_group_add_rule(struct rule
*)
127 OVS_REQUIRES(ofproto_mutex
);
128 static void eviction_group_remove_rule(struct rule
*)
129 OVS_REQUIRES(ofproto_mutex
);
131 static void rule_criteria_init(struct rule_criteria
*, uint8_t table_id
,
132 const struct match
*match
, int priority
,
133 ovs_version_t version
,
134 ovs_be64 cookie
, ovs_be64 cookie_mask
,
135 ofp_port_t out_port
, uint32_t out_group
);
136 static void rule_criteria_require_rw(struct rule_criteria
*,
137 bool can_write_readonly
);
138 static void rule_criteria_destroy(struct rule_criteria
*);
140 static enum ofperr
collect_rules_loose(struct ofproto
*,
141 const struct rule_criteria
*,
142 struct rule_collection
*);
144 struct learned_cookie
{
146 /* In struct ofproto's 'learned_cookies' hmap. */
147 struct hmap_node hmap_node
OVS_GUARDED_BY(ofproto_mutex
);
149 /* In 'dead_cookies' list when removed from hmap. */
150 struct ovs_list list_node
;
154 ovs_be64 cookie
OVS_GUARDED_BY(ofproto_mutex
);
155 uint8_t table_id
OVS_GUARDED_BY(ofproto_mutex
);
157 /* Number of references from "learn" actions.
159 * When this drops to 0, all of the flows in 'table_id' with the specified
160 * 'cookie' are deleted. */
161 int n
OVS_GUARDED_BY(ofproto_mutex
);
164 static const struct ofpact_learn
*next_learn_with_delete(
165 const struct rule_actions
*, const struct ofpact_learn
*start
);
167 static void learned_cookies_inc(struct ofproto
*, const struct rule_actions
*)
168 OVS_REQUIRES(ofproto_mutex
);
169 static void learned_cookies_dec(struct ofproto
*, const struct rule_actions
*,
170 struct ovs_list
*dead_cookies
)
171 OVS_REQUIRES(ofproto_mutex
);
172 static void learned_cookies_flush(struct ofproto
*, struct ovs_list
*dead_cookies
)
173 OVS_REQUIRES(ofproto_mutex
);
176 static void ofport_destroy__(struct ofport
*) OVS_EXCLUDED(ofproto_mutex
);
177 static void ofport_destroy(struct ofport
*, bool del
);
178 static bool ofport_is_mtu_overridden(const struct ofproto
*,
179 const struct ofport
*);
181 static int update_port(struct ofproto
*, const char *devname
);
182 static int init_ports(struct ofproto
*);
183 static void reinit_ports(struct ofproto
*);
185 static long long int ofport_get_usage(const struct ofproto
*,
186 ofp_port_t ofp_port
);
187 static void ofport_set_usage(struct ofproto
*, ofp_port_t ofp_port
,
188 long long int last_used
);
189 static void ofport_remove_usage(struct ofproto
*, ofp_port_t ofp_port
);
193 * Keeps track of the currently used and recently used ofport values and is
194 * used to prevent immediate recycling of ofport values. */
195 struct ofport_usage
{
196 struct hmap_node hmap_node
; /* In struct ofproto's "ofport_usage" hmap. */
197 ofp_port_t ofp_port
; /* OpenFlow port number. */
198 long long int last_used
; /* Last time the 'ofp_port' was used. LLONG_MAX
199 represents in-use ofports. */
203 static void ofproto_rule_send_removed(struct rule
*)
204 OVS_EXCLUDED(ofproto_mutex
);
205 static bool rule_is_readonly(const struct rule
*);
206 static void ofproto_rule_insert__(struct ofproto
*, struct rule
*)
207 OVS_REQUIRES(ofproto_mutex
);
208 static void ofproto_rule_remove__(struct ofproto
*, struct rule
*)
209 OVS_REQUIRES(ofproto_mutex
);
211 /* The source of an OpenFlow request.
213 * A table modification request can be generated externally, via OpenFlow, or
214 * internally through a function call. This structure indicates the source of
215 * an OpenFlow-generated table modification. For an internal flow_mod, it
216 * isn't meaningful and thus supplied as NULL. */
217 struct openflow_mod_requester
{
218 struct ofconn
*ofconn
; /* Connection on which flow_mod arrived. */
219 const struct ofp_header
*request
;
223 static enum ofperr
ofproto_rule_create(struct ofproto
*, struct cls_rule
*,
224 uint8_t table_id
, ovs_be64 new_cookie
,
225 uint16_t idle_timeout
,
226 uint16_t hard_timeout
,
227 enum ofputil_flow_mod_flags flags
,
229 const struct ofpact
*ofpacts
,
231 uint64_t match_tlv_bitmap
,
232 uint64_t ofpacts_tlv_bitmap
,
233 struct rule
**new_rule
)
234 OVS_NO_THREAD_SAFETY_ANALYSIS
;
236 static void replace_rule_start(struct ofproto
*, struct ofproto_flow_mod
*,
237 struct rule
*old_rule
, struct rule
*new_rule
)
238 OVS_REQUIRES(ofproto_mutex
);
240 static void replace_rule_revert(struct ofproto
*, struct rule
*old_rule
,
241 struct rule
*new_rule
)
242 OVS_REQUIRES(ofproto_mutex
);
244 static void replace_rule_finish(struct ofproto
*, struct ofproto_flow_mod
*,
245 const struct openflow_mod_requester
*,
246 struct rule
*old_rule
, struct rule
*new_rule
,
247 struct ovs_list
*dead_cookies
)
248 OVS_REQUIRES(ofproto_mutex
);
249 static void delete_flows__(struct rule_collection
*,
250 enum ofp_flow_removed_reason
,
251 const struct openflow_mod_requester
*)
252 OVS_REQUIRES(ofproto_mutex
);
254 static bool ofproto_group_exists(const struct ofproto
*, uint32_t group_id
);
255 static void handle_openflow(struct ofconn
*, const struct ofpbuf
*);
256 static enum ofperr
ofproto_flow_mod_init(struct ofproto
*,
257 struct ofproto_flow_mod
*,
258 const struct ofputil_flow_mod
*fm
,
260 OVS_EXCLUDED(ofproto_mutex
);
261 static enum ofperr
ofproto_flow_mod_start(struct ofproto
*,
262 struct ofproto_flow_mod
*)
263 OVS_REQUIRES(ofproto_mutex
);
264 static void ofproto_flow_mod_revert(struct ofproto
*,
265 struct ofproto_flow_mod
*)
266 OVS_REQUIRES(ofproto_mutex
);
267 static void ofproto_flow_mod_finish(struct ofproto
*,
268 struct ofproto_flow_mod
*,
269 const struct openflow_mod_requester
*)
270 OVS_REQUIRES(ofproto_mutex
);
271 static enum ofperr
handle_flow_mod__(struct ofproto
*,
272 const struct ofputil_flow_mod
*,
273 const struct openflow_mod_requester
*)
274 OVS_EXCLUDED(ofproto_mutex
);
275 static void calc_duration(long long int start
, long long int now
,
276 uint32_t *sec
, uint32_t *nsec
);
279 static uint64_t pick_datapath_id(const struct ofproto
*);
280 static uint64_t pick_fallback_dpid(void);
281 static void ofproto_destroy__(struct ofproto
*);
282 static void update_mtu(struct ofproto
*, struct ofport
*);
283 static void update_mtu_ofproto(struct ofproto
*);
284 static void meter_delete(struct ofproto
*, uint32_t);
285 static void meter_delete_all(struct ofproto
*);
286 static void meter_insert_rule(struct rule
*);
289 static void ofproto_unixctl_init(void);
291 /* All registered ofproto classes, in probe order. */
292 static const struct ofproto_class
**ofproto_classes
;
293 static size_t n_ofproto_classes
;
294 static size_t allocated_ofproto_classes
;
296 /* Global lock that protects all flow table operations. */
297 struct ovs_mutex ofproto_mutex
= OVS_MUTEX_INITIALIZER
;
299 unsigned ofproto_flow_limit
= OFPROTO_FLOW_LIMIT_DEFAULT
;
300 unsigned ofproto_max_idle
= OFPROTO_MAX_IDLE_DEFAULT
;
302 size_t n_handlers
, n_revalidators
;
304 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
305 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
307 /* Initial mappings of port to OpenFlow number mappings. */
308 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
310 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
312 /* The default value of true waits for flow restore. */
313 static bool flow_restore_wait
= true;
315 /* Must be called to initialize the ofproto library.
317 * The caller may pass in 'iface_hints', which contains an shash of
318 * "iface_hint" elements indexed by the interface's name. The provider
319 * may use these hints to describe the startup configuration in order to
320 * reinitialize its state. The caller owns the provided data, so a
321 * provider will make copies of anything required. An ofproto provider
322 * will remove any existing state that is not described by the hint, and
323 * may choose to remove it all. */
325 ofproto_init(const struct shash
*iface_hints
)
327 struct shash_node
*node
;
330 ofproto_class_register(&ofproto_dpif_class
);
332 /* Make a local copy, since we don't own 'iface_hints' elements. */
333 SHASH_FOR_EACH(node
, iface_hints
) {
334 const struct iface_hint
*orig_hint
= node
->data
;
335 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
336 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
338 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
339 new_hint
->br_type
= xstrdup(br_type
);
340 new_hint
->ofp_port
= orig_hint
->ofp_port
;
342 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
345 for (i
= 0; i
< n_ofproto_classes
; i
++) {
346 ofproto_classes
[i
]->init(&init_ofp_ports
);
349 ofproto_unixctl_init();
352 /* 'type' should be a normalized datapath type, as returned by
353 * ofproto_normalize_type(). Returns the corresponding ofproto_class
354 * structure, or a null pointer if there is none registered for 'type'. */
355 static const struct ofproto_class
*
356 ofproto_class_find__(const char *type
)
360 for (i
= 0; i
< n_ofproto_classes
; i
++) {
361 const struct ofproto_class
*class = ofproto_classes
[i
];
366 class->enumerate_types(&types
);
367 found
= sset_contains(&types
, type
);
368 sset_destroy(&types
);
374 VLOG_WARN("unknown datapath type %s", type
);
378 /* Registers a new ofproto class. After successful registration, new ofprotos
379 * of that type can be created using ofproto_create(). */
381 ofproto_class_register(const struct ofproto_class
*new_class
)
385 for (i
= 0; i
< n_ofproto_classes
; i
++) {
386 if (ofproto_classes
[i
] == new_class
) {
391 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
392 ofproto_classes
= x2nrealloc(ofproto_classes
,
393 &allocated_ofproto_classes
,
394 sizeof *ofproto_classes
);
396 ofproto_classes
[n_ofproto_classes
++] = new_class
;
400 /* Unregisters a datapath provider. 'type' must have been previously
401 * registered and not currently be in use by any ofprotos. After
402 * unregistration new datapaths of that type cannot be opened using
403 * ofproto_create(). */
405 ofproto_class_unregister(const struct ofproto_class
*class)
409 for (i
= 0; i
< n_ofproto_classes
; i
++) {
410 if (ofproto_classes
[i
] == class) {
411 for (i
++; i
< n_ofproto_classes
; i
++) {
412 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
418 VLOG_WARN("attempted to unregister an ofproto class that is not "
423 /* Clears 'types' and enumerates all registered ofproto types into it. The
424 * caller must first initialize the sset. */
426 ofproto_enumerate_types(struct sset
*types
)
431 for (i
= 0; i
< n_ofproto_classes
; i
++) {
432 ofproto_classes
[i
]->enumerate_types(types
);
436 /* Returns the fully spelled out name for the given ofproto 'type'.
438 * Normalized type string can be compared with strcmp(). Unnormalized type
439 * string might be the same even if they have different spellings. */
441 ofproto_normalize_type(const char *type
)
443 return type
&& type
[0] ? type
: "system";
446 /* Clears 'names' and enumerates the names of all known created ofprotos with
447 * the given 'type'. The caller must first initialize the sset. Returns 0 if
448 * successful, otherwise a positive errno value.
450 * Some kinds of datapaths might not be practically enumerable. This is not
451 * considered an error. */
453 ofproto_enumerate_names(const char *type
, struct sset
*names
)
455 const struct ofproto_class
*class = ofproto_class_find__(type
);
456 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
460 ofproto_bump_tables_version(struct ofproto
*ofproto
)
462 ++ofproto
->tables_version
;
463 ofproto
->ofproto_class
->set_tables_version(ofproto
,
464 ofproto
->tables_version
);
468 ofproto_create(const char *datapath_name
, const char *datapath_type
,
469 struct ofproto
**ofprotop
)
470 OVS_EXCLUDED(ofproto_mutex
)
472 const struct ofproto_class
*class;
473 struct ofproto
*ofproto
;
479 datapath_type
= ofproto_normalize_type(datapath_type
);
480 class = ofproto_class_find__(datapath_type
);
482 VLOG_WARN("could not create datapath %s of unknown type %s",
483 datapath_name
, datapath_type
);
487 ofproto
= class->alloc();
489 VLOG_ERR("failed to allocate datapath %s of type %s",
490 datapath_name
, datapath_type
);
495 ovs_mutex_lock(&ofproto_mutex
);
496 memset(ofproto
, 0, sizeof *ofproto
);
497 ofproto
->ofproto_class
= class;
498 ofproto
->name
= xstrdup(datapath_name
);
499 ofproto
->type
= xstrdup(datapath_type
);
500 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
501 hash_string(ofproto
->name
, 0));
502 ofproto
->datapath_id
= 0;
503 ofproto
->forward_bpdu
= false;
504 ofproto
->fallback_dpid
= pick_fallback_dpid();
505 ofproto
->mfr_desc
= NULL
;
506 ofproto
->hw_desc
= NULL
;
507 ofproto
->sw_desc
= NULL
;
508 ofproto
->serial_desc
= NULL
;
509 ofproto
->dp_desc
= NULL
;
510 ofproto
->frag_handling
= OFPUTIL_FRAG_NORMAL
;
511 hmap_init(&ofproto
->ports
);
512 hmap_init(&ofproto
->ofport_usage
);
513 shash_init(&ofproto
->port_by_name
);
514 simap_init(&ofproto
->ofp_requests
);
515 ofproto
->max_ports
= ofp_to_u16(OFPP_MAX
);
516 ofproto
->eviction_group_timer
= LLONG_MIN
;
517 ofproto
->tables
= NULL
;
518 ofproto
->n_tables
= 0;
519 ofproto
->tables_version
= OVS_VERSION_MIN
;
520 hindex_init(&ofproto
->cookies
);
521 hmap_init(&ofproto
->learned_cookies
);
522 ovs_list_init(&ofproto
->expirable
);
523 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
524 ofproto
->min_mtu
= INT_MAX
;
525 cmap_init(&ofproto
->groups
);
526 ovs_mutex_unlock(&ofproto_mutex
);
527 ofproto
->ogf
.types
= 0xf;
528 ofproto
->ogf
.capabilities
= OFPGFC_CHAINING
| OFPGFC_SELECT_LIVENESS
|
529 OFPGFC_SELECT_WEIGHT
;
530 for (i
= 0; i
< 4; i
++) {
531 ofproto
->ogf
.max_groups
[i
] = OFPG_MAX
;
532 ofproto
->ogf
.ofpacts
[i
] = (UINT64_C(1) << N_OFPACTS
) - 1;
534 ovsrcu_set(&ofproto
->metadata_tab
, tun_metadata_alloc(NULL
));
536 ovs_mutex_init(&ofproto
->vl_mff_map
.mutex
);
537 cmap_init(&ofproto
->vl_mff_map
.cmap
);
539 error
= ofproto
->ofproto_class
->construct(ofproto
);
541 VLOG_ERR("failed to open datapath %s: %s",
542 datapath_name
, ovs_strerror(error
));
543 ovs_mutex_lock(&ofproto_mutex
);
544 connmgr_destroy(ofproto
->connmgr
);
545 ofproto
->connmgr
= NULL
;
546 ovs_mutex_unlock(&ofproto_mutex
);
547 ofproto_destroy__(ofproto
);
551 /* Check that hidden tables, if any, are at the end. */
552 ovs_assert(ofproto
->n_tables
);
553 for (i
= 0; i
+ 1 < ofproto
->n_tables
; i
++) {
554 enum oftable_flags flags
= ofproto
->tables
[i
].flags
;
555 enum oftable_flags next_flags
= ofproto
->tables
[i
+ 1].flags
;
557 ovs_assert(!(flags
& OFTABLE_HIDDEN
) || next_flags
& OFTABLE_HIDDEN
);
560 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
563 /* Initialize meters table. */
564 if (ofproto
->ofproto_class
->meter_get_features
) {
565 ofproto
->ofproto_class
->meter_get_features(ofproto
,
566 &ofproto
->meter_features
);
568 memset(&ofproto
->meter_features
, 0, sizeof ofproto
->meter_features
);
570 hmap_init(&ofproto
->meters
);
571 ofproto
->slowpath_meter_id
= UINT32_MAX
;
572 ofproto
->controller_meter_id
= UINT32_MAX
;
574 /* Set the initial tables version. */
575 ofproto_bump_tables_version(ofproto
);
581 /* Must be called (only) by an ofproto implementation in its constructor
582 * function. See the large comment on 'construct' in struct ofproto_class for
585 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
587 struct oftable
*table
;
589 ovs_assert(!ofproto
->n_tables
);
590 ovs_assert(n_tables
>= 1 && n_tables
<= 255);
592 ofproto
->n_tables
= n_tables
;
593 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
594 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
599 /* To be optionally called (only) by an ofproto implementation in its
600 * constructor function. See the large comment on 'construct' in struct
601 * ofproto_class for details.
603 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
604 * will then ensure that actions passed into the ofproto implementation will
605 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
606 * function is not called, there will be no such restriction.
608 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
609 * the 'max_ports' restriction. */
611 ofproto_init_max_ports(struct ofproto
*ofproto
, uint16_t max_ports
)
613 ovs_assert(max_ports
<= ofp_to_u16(OFPP_MAX
));
614 ofproto
->max_ports
= max_ports
;
618 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
620 return ofproto
->datapath_id
;
624 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
626 uint64_t old_dpid
= p
->datapath_id
;
627 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
628 if (p
->datapath_id
!= old_dpid
) {
629 /* Force all active connections to reconnect, since there is no way to
630 * notify a controller that the datapath ID has changed. */
631 ofproto_reconnect_controllers(p
);
636 ofproto_set_controllers(struct ofproto
*p
,
637 const struct ofproto_controller
*controllers
,
638 size_t n_controllers
, uint32_t allowed_versions
)
640 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
,
645 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
647 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
650 /* Drops the connections between 'ofproto' and all of its controllers, forcing
651 * them to reconnect. */
653 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
655 connmgr_reconnect(ofproto
->connmgr
);
658 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
659 * in-band control should guarantee access, in the same way that in-band
660 * control guarantees access to OpenFlow controllers. */
662 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
663 const struct sockaddr_in
*extras
, size_t n
)
665 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
668 /* Sets the OpenFlow queue used by flows set up by in-band control on
669 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
670 * flows will use the default queue. */
672 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
674 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
677 /* Sets the number of flows at which eviction from the kernel flow table
680 ofproto_set_flow_limit(unsigned limit
)
682 ofproto_flow_limit
= limit
;
685 /* Sets the maximum idle time for flows in the datapath before they are
688 ofproto_set_max_idle(unsigned max_idle
)
690 ofproto_max_idle
= max_idle
;
693 /* If forward_bpdu is true, the NORMAL action will forward frames with
694 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
695 * the NORMAL action will drop these frames. */
697 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
699 bool old_val
= ofproto
->forward_bpdu
;
700 ofproto
->forward_bpdu
= forward_bpdu
;
701 if (old_val
!= ofproto
->forward_bpdu
) {
702 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
703 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
708 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
709 * 'idle_time', in seconds, and the maximum number of MAC table entries to
712 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
715 if (ofproto
->ofproto_class
->set_mac_table_config
) {
716 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
721 /* Multicast snooping configuration. */
723 /* Configures multicast snooping on 'ofproto' using the settings
724 * defined in 's'. If 's' is NULL, disables multicast snooping.
726 * Returns 0 if successful, otherwise a positive errno value. */
728 ofproto_set_mcast_snooping(struct ofproto
*ofproto
,
729 const struct ofproto_mcast_snooping_settings
*s
)
731 return (ofproto
->ofproto_class
->set_mcast_snooping
732 ? ofproto
->ofproto_class
->set_mcast_snooping(ofproto
, s
)
736 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
738 * Returns 0 if successful, otherwise a positive errno value.*/
740 ofproto_port_set_mcast_snooping(struct ofproto
*ofproto
, void *aux
,
741 const struct ofproto_mcast_snooping_port_settings
*s
)
743 return (ofproto
->ofproto_class
->set_mcast_snooping_port
744 ? ofproto
->ofproto_class
->set_mcast_snooping_port(ofproto
, aux
, s
)
749 ofproto_type_set_config(const char *datapath_type
, const struct smap
*cfg
)
751 const struct ofproto_class
*class;
753 datapath_type
= ofproto_normalize_type(datapath_type
);
754 class = ofproto_class_find__(datapath_type
);
756 if (class->type_set_config
) {
757 class->type_set_config(datapath_type
, cfg
);
762 ofproto_set_threads(int n_handlers_
, int n_revalidators_
)
764 int threads
= MAX(count_cpu_cores(), 2);
766 n_revalidators
= MAX(n_revalidators_
, 0);
767 n_handlers
= MAX(n_handlers_
, 0);
769 if (!n_revalidators
) {
770 n_revalidators
= n_handlers
771 ? MAX(threads
- (int) n_handlers
, 1)
776 n_handlers
= MAX(threads
- (int) n_revalidators
, 1);
781 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
784 p
->dp_desc
= nullable_xstrdup(dp_desc
);
788 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
790 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
794 ofproto_set_netflow(struct ofproto
*ofproto
,
795 const struct netflow_options
*nf_options
)
797 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
801 if (ofproto
->ofproto_class
->set_netflow
) {
802 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
804 return nf_options
? EOPNOTSUPP
: 0;
809 ofproto_set_sflow(struct ofproto
*ofproto
,
810 const struct ofproto_sflow_options
*oso
)
812 if (oso
&& sset_is_empty(&oso
->targets
)) {
816 if (ofproto
->ofproto_class
->set_sflow
) {
817 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
819 return oso
? EOPNOTSUPP
: 0;
824 ofproto_set_ipfix(struct ofproto
*ofproto
,
825 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
826 const struct ofproto_ipfix_flow_exporter_options
*fo
,
829 if (ofproto
->ofproto_class
->set_ipfix
) {
830 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
832 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
837 ofproto_get_ipfix_stats(struct ofproto
*ofproto
,
839 struct ovs_list
*replies
)
843 if (ofproto
->ofproto_class
->get_ipfix_stats
) {
844 error
= ofproto
->ofproto_class
->get_ipfix_stats(ofproto
,
855 handle_ipfix_bridge_stats_request(struct ofconn
*ofconn
,
856 const struct ofp_header
*request
)
858 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
859 struct ovs_list replies
;
862 ofpmp_init(&replies
, request
);
863 error
= ofproto_get_ipfix_stats(ofproto
, true, &replies
);
866 ofconn_send_replies(ofconn
, &replies
);
868 ofpbuf_list_delete(&replies
);
875 handle_ipfix_flow_stats_request(struct ofconn
*ofconn
,
876 const struct ofp_header
*request
)
878 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
879 struct ovs_list replies
;
882 ofpmp_init(&replies
, request
);
883 error
= ofproto_get_ipfix_stats(ofproto
, false, &replies
);
886 ofconn_send_replies(ofconn
, &replies
);
888 ofpbuf_list_delete(&replies
);
895 handle_nxt_ct_flush_zone(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
897 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
898 const struct nx_zone_id
*nzi
= ofpmsg_body(oh
);
900 if (!is_all_zeros(nzi
->zero
, sizeof nzi
->zero
)) {
901 return OFPERR_NXBRC_MUST_BE_ZERO
;
904 uint16_t zone
= ntohs(nzi
->zone_id
);
905 if (ofproto
->ofproto_class
->ct_flush
) {
906 ofproto
->ofproto_class
->ct_flush(ofproto
, &zone
);
915 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
917 flow_restore_wait
= flow_restore_wait_db
;
921 ofproto_get_flow_restore_wait(void)
923 return flow_restore_wait
;
927 /* Spanning Tree Protocol (STP) configuration. */
929 /* Configures STP on 'ofproto' using the settings defined in 's'. If
930 * 's' is NULL, disables STP.
932 * Returns 0 if successful, otherwise a positive errno value. */
934 ofproto_set_stp(struct ofproto
*ofproto
,
935 const struct ofproto_stp_settings
*s
)
937 return (ofproto
->ofproto_class
->set_stp
938 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
942 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
943 * 'enabled' member of 's' is false, then the other members are not
946 * Returns 0 if successful, otherwise a positive errno value. */
948 ofproto_get_stp_status(struct ofproto
*ofproto
,
949 struct ofproto_stp_status
*s
)
951 return (ofproto
->ofproto_class
->get_stp_status
952 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
956 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
957 * in 's'. The caller is responsible for assigning STP port numbers
958 * (using the 'port_num' member in the range of 1 through 255, inclusive)
959 * and ensuring there are no duplicates. If the 's' is NULL, then STP
960 * is disabled on the port.
962 * Returns 0 if successful, otherwise a positive errno value.*/
964 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
965 const struct ofproto_port_stp_settings
*s
)
967 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
969 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu32
,
970 ofproto
->name
, ofp_port
);
974 return (ofproto
->ofproto_class
->set_stp_port
975 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
979 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
980 * 's'. If the 'enabled' member in 's' is false, then the other members
981 * are not meaningful.
983 * Returns 0 if successful, otherwise a positive errno value.*/
985 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
986 struct ofproto_port_stp_status
*s
)
988 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
990 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
991 "port %"PRIu32
, ofproto
->name
, ofp_port
);
995 return (ofproto
->ofproto_class
->get_stp_port_status
996 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
1000 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
1001 * 's'. If the 'enabled' member in 's' is false, then the other members
1002 * are not meaningful.
1004 * Returns 0 if successful, otherwise a positive errno value.*/
1006 ofproto_port_get_stp_stats(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1007 struct ofproto_port_stp_stats
*s
)
1009 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1011 VLOG_WARN_RL(&rl
, "%s: cannot get STP stats on nonexistent "
1012 "port %"PRIu32
, ofproto
->name
, ofp_port
);
1016 return (ofproto
->ofproto_class
->get_stp_port_stats
1017 ? ofproto
->ofproto_class
->get_stp_port_stats(ofport
, s
)
1021 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
1023 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
1024 * 's' is NULL, disables RSTP.
1026 * Returns 0 if successful, otherwise a positive errno value. */
1028 ofproto_set_rstp(struct ofproto
*ofproto
,
1029 const struct ofproto_rstp_settings
*s
)
1031 if (!ofproto
->ofproto_class
->set_rstp
) {
1034 ofproto
->ofproto_class
->set_rstp(ofproto
, s
);
1038 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
1039 * 'enabled' member of 's' is false, then the other members are not
1042 * Returns 0 if successful, otherwise a positive errno value. */
1044 ofproto_get_rstp_status(struct ofproto
*ofproto
,
1045 struct ofproto_rstp_status
*s
)
1047 if (!ofproto
->ofproto_class
->get_rstp_status
) {
1050 ofproto
->ofproto_class
->get_rstp_status(ofproto
, s
);
1054 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1055 * in 's'. The caller is responsible for assigning RSTP port numbers
1056 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1057 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1058 * is disabled on the port.
1060 * Returns 0 if successful, otherwise a positive errno value.*/
1062 ofproto_port_set_rstp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1063 const struct ofproto_port_rstp_settings
*s
)
1065 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1067 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu32
,
1068 ofproto
->name
, ofp_port
);
1072 if (!ofproto
->ofproto_class
->set_rstp_port
) {
1075 ofproto
->ofproto_class
->set_rstp_port(ofport
, s
);
1079 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1080 * 's'. If the 'enabled' member in 's' is false, then the other members
1081 * are not meaningful.
1083 * Returns 0 if successful, otherwise a positive errno value.*/
1085 ofproto_port_get_rstp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1086 struct ofproto_port_rstp_status
*s
)
1088 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1090 VLOG_WARN_RL(&rl
, "%s: cannot get RSTP status on nonexistent "
1091 "port %"PRIu32
, ofproto
->name
, ofp_port
);
1095 if (!ofproto
->ofproto_class
->get_rstp_port_status
) {
1098 ofproto
->ofproto_class
->get_rstp_port_status(ofport
, s
);
1102 /* Queue DSCP configuration. */
1104 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1105 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1106 * to implement QoS. Instead, it is used to implement features which require
1107 * knowledge of what queues exist on a port, and some basic information about
1110 * Returns 0 if successful, otherwise a positive errno value. */
1112 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1113 const struct ofproto_port_queue
*queues
,
1116 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1119 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu32
,
1120 ofproto
->name
, ofp_port
);
1124 return (ofproto
->ofproto_class
->set_queues
1125 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
1129 /* LLDP configuration. */
1131 ofproto_port_set_lldp(struct ofproto
*ofproto
,
1132 ofp_port_t ofp_port
,
1133 const struct smap
*cfg
)
1135 struct ofport
*ofport
;
1138 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1140 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu32
,
1141 ofproto
->name
, ofp_port
);
1144 error
= (ofproto
->ofproto_class
->set_lldp
1145 ? ofproto
->ofproto_class
->set_lldp(ofport
, cfg
)
1148 VLOG_WARN("%s: lldp configuration on port %"PRIu32
" (%s) failed (%s)",
1149 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1150 ovs_strerror(error
));
1155 ofproto_set_aa(struct ofproto
*ofproto
, void *aux OVS_UNUSED
,
1156 const struct aa_settings
*s
)
1158 if (!ofproto
->ofproto_class
->set_aa
) {
1161 ofproto
->ofproto_class
->set_aa(ofproto
, s
);
1166 ofproto_aa_mapping_register(struct ofproto
*ofproto
, void *aux
,
1167 const struct aa_mapping_settings
*s
)
1169 if (!ofproto
->ofproto_class
->aa_mapping_set
) {
1172 ofproto
->ofproto_class
->aa_mapping_set(ofproto
, aux
, s
);
1177 ofproto_aa_mapping_unregister(struct ofproto
*ofproto
, void *aux
)
1179 if (!ofproto
->ofproto_class
->aa_mapping_unset
) {
1182 ofproto
->ofproto_class
->aa_mapping_unset(ofproto
, aux
);
1187 ofproto_aa_vlan_get_queued(struct ofproto
*ofproto
,
1188 struct ovs_list
*list
)
1190 if (!ofproto
->ofproto_class
->aa_vlan_get_queued
) {
1193 ofproto
->ofproto_class
->aa_vlan_get_queued(ofproto
, list
);
1198 ofproto_aa_vlan_get_queue_size(struct ofproto
*ofproto
)
1200 if (!ofproto
->ofproto_class
->aa_vlan_get_queue_size
) {
1203 return ofproto
->ofproto_class
->aa_vlan_get_queue_size(ofproto
);
1206 /* Connectivity Fault Management configuration. */
1208 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1210 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1212 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1213 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
1214 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
1218 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1219 * basic configuration from the configuration members in 'cfm', and the remote
1220 * maintenance point ID from remote_mpid. Ignores the statistics members of
1223 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1225 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1226 const struct cfm_settings
*s
)
1228 struct ofport
*ofport
;
1231 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1233 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu32
,
1234 ofproto
->name
, ofp_port
);
1238 /* XXX: For configuration simplicity, we only support one remote_mpid
1239 * outside of the CFM module. It's not clear if this is the correct long
1240 * term solution or not. */
1241 error
= (ofproto
->ofproto_class
->set_cfm
1242 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
1245 VLOG_WARN("%s: CFM configuration on port %"PRIu32
" (%s) failed (%s)",
1246 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1247 ovs_strerror(error
));
1251 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1252 * 'ofproto' does not have a port 'ofp_port'. */
1254 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1255 const struct smap
*cfg
)
1257 struct ofport
*ofport
;
1260 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1262 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu32
,
1263 ofproto
->name
, ofp_port
);
1267 error
= (ofproto
->ofproto_class
->set_bfd
1268 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
1271 VLOG_WARN("%s: bfd configuration on port %"PRIu32
" (%s) failed (%s)",
1272 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1273 ovs_strerror(error
));
1277 /* Checks the status change of BFD on 'ofport'.
1279 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1281 ofproto_port_bfd_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1283 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1284 return (ofport
&& ofproto
->ofproto_class
->bfd_status_changed
1285 ? ofproto
->ofproto_class
->bfd_status_changed(ofport
)
1289 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1290 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1291 * is not an OpenFlow port in 'ofproto'.
1293 * The caller must provide and own '*status'. */
1295 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1296 struct smap
*status
)
1298 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1299 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
1300 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
1304 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1305 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1306 * 0 if LACP partner information is not current (generally indicating a
1307 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1309 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1311 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1312 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
1313 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
1318 ofproto_port_get_lacp_stats(const struct ofport
*port
, struct lacp_slave_stats
*stats
)
1320 struct ofproto
*ofproto
= port
->ofproto
;
1323 if (ofproto
->ofproto_class
->port_get_lacp_stats
) {
1324 error
= ofproto
->ofproto_class
->port_get_lacp_stats(port
, stats
);
1334 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1335 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1336 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1337 * configuration plus, if there is more than one slave, a bonding
1340 * If 'aux' is already registered then this function updates its configuration
1341 * to 's'. Otherwise, this function registers a new bundle.
1343 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1346 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
1347 const struct ofproto_bundle_settings
*s
)
1349 return (ofproto
->ofproto_class
->bundle_set
1350 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
1354 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1355 * If no such bundle has been registered, this has no effect. */
1357 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
1359 return ofproto_bundle_register(ofproto
, aux
, NULL
);
1363 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1364 * If 'aux' is already registered then this function updates its configuration
1365 * to 's'. Otherwise, this function registers a new mirror. */
1367 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
1368 const struct ofproto_mirror_settings
*s
)
1370 return (ofproto
->ofproto_class
->mirror_set
1371 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
1375 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1376 * If no mirror has been registered, this has no effect. */
1378 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
1380 return ofproto_mirror_register(ofproto
, aux
, NULL
);
1383 /* Retrieves statistics from mirror associated with client data pointer
1384 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1385 * 'bytes', respectively. If a particular counters is not supported,
1386 * the appropriate argument is set to UINT64_MAX.
1389 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
1390 uint64_t *packets
, uint64_t *bytes
)
1392 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
1393 *packets
= *bytes
= UINT64_MAX
;
1397 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
1401 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1402 * which all packets are flooded, instead of using MAC learning. If
1403 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1405 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1408 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
1410 return (ofproto
->ofproto_class
->set_flood_vlans
1411 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
1415 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1416 * output for a mirror. */
1418 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
1420 return (ofproto
->ofproto_class
->is_mirror_output_bundle
1421 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
1425 /* Configuration of OpenFlow tables. */
1427 /* Returns the number of OpenFlow tables in 'ofproto'. */
1429 ofproto_get_n_tables(const struct ofproto
*ofproto
)
1431 return ofproto
->n_tables
;
1434 /* Returns the number of Controller visible OpenFlow tables
1435 * in 'ofproto'. This number will exclude Hidden tables.
1436 * This funtion's return value should be less or equal to that of
1437 * ofproto_get_n_tables() . */
1439 ofproto_get_n_visible_tables(const struct ofproto
*ofproto
)
1441 uint8_t n
= ofproto
->n_tables
;
1443 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1444 * if present, are always at the end.) */
1445 while(n
&& (ofproto
->tables
[n
- 1].flags
& OFTABLE_HIDDEN
)) {
1452 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1453 * settings from 's'. 'table_id' must be in the range 0 through the number of
1454 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1456 * For read-only tables, only the name may be configured. */
1458 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
1459 const struct ofproto_table_settings
*s
)
1461 struct oftable
*table
;
1463 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
1464 table
= &ofproto
->tables
[table_id
];
1466 oftable_set_name(table
, s
->name
);
1468 if (table
->flags
& OFTABLE_READONLY
) {
1472 if (classifier_set_prefix_fields(&table
->cls
,
1473 s
->prefix_fields
, s
->n_prefix_fields
)) {
1474 /* XXX: Trigger revalidation. */
1477 ovs_mutex_lock(&ofproto_mutex
);
1478 unsigned int new_eviction
= (s
->enable_eviction
1479 ? table
->eviction
| EVICTION_CLIENT
1480 : table
->eviction
& ~EVICTION_CLIENT
);
1481 oftable_configure_eviction(table
, new_eviction
, s
->groups
, s
->n_groups
);
1482 table
->max_flows
= s
->max_flows
;
1483 evict_rules_from_table(table
);
1484 ovs_mutex_unlock(&ofproto_mutex
);
1488 ofproto_has_snoops(const struct ofproto
*ofproto
)
1490 return connmgr_has_snoops(ofproto
->connmgr
);
1494 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1496 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1499 /* Deletes 'rule' from 'ofproto'.
1501 * Within an ofproto implementation, this function allows an ofproto
1502 * implementation to destroy any rules that remain when its ->destruct()
1503 * function is called. This function is not suitable for use elsewhere in an
1504 * ofproto implementation.
1506 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1507 * Cycle" in ofproto-provider.h. */
1509 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1510 OVS_EXCLUDED(ofproto_mutex
)
1512 /* This skips the ofmonitor and flow-removed notifications because the
1513 * switch is being deleted and any OpenFlow channels have been or soon will
1515 ovs_mutex_lock(&ofproto_mutex
);
1517 if (rule
->state
== RULE_INSERTED
) {
1518 /* Make sure there is no postponed removal of the rule. */
1519 ovs_assert(cls_rule_visible_in_version(&rule
->cr
, OVS_VERSION_MAX
));
1521 if (!classifier_remove(&rule
->ofproto
->tables
[rule
->table_id
].cls
,
1525 ofproto_rule_remove__(rule
->ofproto
, rule
);
1526 if (ofproto
->ofproto_class
->rule_delete
) {
1527 ofproto
->ofproto_class
->rule_delete(rule
);
1530 /* This may not be the last reference to the rule. */
1531 ofproto_rule_unref(rule
);
1533 ovs_mutex_unlock(&ofproto_mutex
);
1537 ofproto_flush__(struct ofproto
*ofproto
)
1538 OVS_EXCLUDED(ofproto_mutex
)
1540 struct oftable
*table
;
1542 /* This will flush all datapath flows. */
1543 if (ofproto
->ofproto_class
->flush
) {
1544 ofproto
->ofproto_class
->flush(ofproto
);
1547 /* XXX: There is a small race window here, where new datapath flows can be
1548 * created by upcall handlers based on the existing flow table. We can not
1549 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1550 * as then we could deadlock on syncing with the handler threads waiting on
1551 * the same mutex. */
1553 ovs_mutex_lock(&ofproto_mutex
);
1554 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1555 struct rule_collection rules
;
1558 if (table
->flags
& OFTABLE_HIDDEN
) {
1562 rule_collection_init(&rules
);
1564 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1565 rule_collection_add(&rules
, rule
);
1567 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
1569 /* XXX: Concurrent handler threads may insert new learned flows based on
1570 * learn actions of the now deleted flows right after we release
1571 * 'ofproto_mutex'. */
1572 ovs_mutex_unlock(&ofproto_mutex
);
1576 ofproto_destroy__(struct ofproto
*ofproto
)
1577 OVS_EXCLUDED(ofproto_mutex
)
1579 struct oftable
*table
;
1581 cmap_destroy(&ofproto
->groups
);
1583 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1585 free(ofproto
->name
);
1586 free(ofproto
->type
);
1587 free(ofproto
->mfr_desc
);
1588 free(ofproto
->hw_desc
);
1589 free(ofproto
->sw_desc
);
1590 free(ofproto
->serial_desc
);
1591 free(ofproto
->dp_desc
);
1592 hmap_destroy(&ofproto
->ports
);
1593 hmap_destroy(&ofproto
->ofport_usage
);
1594 shash_destroy(&ofproto
->port_by_name
);
1595 simap_destroy(&ofproto
->ofp_requests
);
1597 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1598 oftable_destroy(table
);
1600 free(ofproto
->tables
);
1602 ovs_mutex_lock(&ofproto
->vl_mff_map
.mutex
);
1603 mf_vl_mff_map_clear(&ofproto
->vl_mff_map
, true);
1604 ovs_mutex_unlock(&ofproto
->vl_mff_map
.mutex
);
1605 cmap_destroy(&ofproto
->vl_mff_map
.cmap
);
1606 ovs_mutex_destroy(&ofproto
->vl_mff_map
.mutex
);
1607 tun_metadata_free(ovsrcu_get_protected(struct tun_table
*,
1608 &ofproto
->metadata_tab
));
1610 ovs_assert(hindex_is_empty(&ofproto
->cookies
));
1611 hindex_destroy(&ofproto
->cookies
);
1613 ovs_assert(hmap_is_empty(&ofproto
->learned_cookies
));
1614 hmap_destroy(&ofproto
->learned_cookies
);
1616 ofproto
->ofproto_class
->dealloc(ofproto
);
1619 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1620 * - 1st we defer the removal of the rules from the classifier
1621 * - 2nd we defer the actual destruction of the rules. */
1623 ofproto_destroy_defer__(struct ofproto
*ofproto
)
1624 OVS_EXCLUDED(ofproto_mutex
)
1626 ovsrcu_postpone(ofproto_destroy__
, ofproto
);
1630 ofproto_destroy(struct ofproto
*p
, bool del
)
1631 OVS_EXCLUDED(ofproto_mutex
)
1633 struct ofport
*ofport
, *next_ofport
;
1634 struct ofport_usage
*usage
;
1640 meter_delete_all(p
);
1641 hmap_destroy(&p
->meters
);
1644 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1645 ofport_destroy(ofport
, del
);
1648 HMAP_FOR_EACH_POP (usage
, hmap_node
, &p
->ofport_usage
) {
1652 p
->ofproto_class
->destruct(p
, del
);
1654 /* We should not postpone this because it involves deleting a listening
1655 * socket which we may want to reopen soon. 'connmgr' may be used by other
1656 * threads only if they take the ofproto_mutex and read a non-NULL
1657 * 'ofproto->connmgr'. */
1658 ovs_mutex_lock(&ofproto_mutex
);
1659 connmgr_destroy(p
->connmgr
);
1661 ovs_mutex_unlock(&ofproto_mutex
);
1663 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1664 ovsrcu_postpone(ofproto_destroy_defer__
, p
);
1667 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1668 * kernel datapath, for example, this destroys the datapath in the kernel, and
1669 * with the netdev-based datapath, it tears down the data structures that
1670 * represent the datapath.
1672 * The datapath should not be currently open as an ofproto. */
1674 ofproto_delete(const char *name
, const char *type
)
1676 const struct ofproto_class
*class = ofproto_class_find__(type
);
1677 return (!class ? EAFNOSUPPORT
1678 : !class->del
? EACCES
1679 : class->del(type
, name
));
1683 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1685 if (error
== ENOBUFS
) {
1686 reinit_ports(ofproto
);
1687 } else if (!error
) {
1688 update_port(ofproto
, devname
);
1694 ofproto_type_run(const char *datapath_type
)
1696 const struct ofproto_class
*class;
1699 datapath_type
= ofproto_normalize_type(datapath_type
);
1700 class = ofproto_class_find__(datapath_type
);
1702 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1703 if (error
&& error
!= EAGAIN
) {
1704 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1705 datapath_type
, ovs_strerror(error
));
1711 ofproto_type_wait(const char *datapath_type
)
1713 const struct ofproto_class
*class;
1715 datapath_type
= ofproto_normalize_type(datapath_type
);
1716 class = ofproto_class_find__(datapath_type
);
1718 if (class->type_wait
) {
1719 class->type_wait(datapath_type
);
1724 ofproto_run(struct ofproto
*p
)
1729 error
= p
->ofproto_class
->run(p
);
1730 if (error
&& error
!= EAGAIN
) {
1731 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, ovs_strerror(error
));
1734 /* Restore the eviction group heap invariant occasionally. */
1735 if (p
->eviction_group_timer
< time_msec()) {
1738 p
->eviction_group_timer
= time_msec() + 1000;
1740 for (i
= 0; i
< p
->n_tables
; i
++) {
1741 struct oftable
*table
= &p
->tables
[i
];
1742 struct eviction_group
*evg
;
1745 if (!table
->eviction
) {
1749 if (table
->n_flows
> 100000) {
1750 static struct vlog_rate_limit count_rl
=
1751 VLOG_RATE_LIMIT_INIT(1, 1);
1752 VLOG_WARN_RL(&count_rl
, "Table %"PRIuSIZE
" has an excessive"
1753 " number of rules: %d", i
, table
->n_flows
);
1756 ovs_mutex_lock(&ofproto_mutex
);
1757 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1758 if (rule
->idle_timeout
|| rule
->hard_timeout
) {
1759 if (!rule
->eviction_group
) {
1760 eviction_group_add_rule(rule
);
1762 heap_raw_change(&rule
->evg_node
,
1763 rule_eviction_priority(p
, rule
));
1768 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1769 heap_rebuild(&evg
->rules
);
1771 ovs_mutex_unlock(&ofproto_mutex
);
1775 if (p
->ofproto_class
->port_poll
) {
1778 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1779 process_port_change(p
, error
, devname
);
1783 new_seq
= seq_read(connectivity_seq_get());
1784 if (new_seq
!= p
->change_seq
) {
1785 struct sset devnames
;
1786 const char *devname
;
1787 struct ofport
*ofport
;
1789 /* Update OpenFlow port status for any port whose netdev has changed.
1791 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1792 * destroyed, so it's not safe to update ports directly from the
1793 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1794 * need this two-phase approach. */
1795 sset_init(&devnames
);
1796 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1797 uint64_t port_change_seq
;
1799 port_change_seq
= netdev_get_change_seq(ofport
->netdev
);
1800 if (ofport
->change_seq
!= port_change_seq
) {
1801 ofport
->change_seq
= port_change_seq
;
1802 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1805 SSET_FOR_EACH (devname
, &devnames
) {
1806 update_port(p
, devname
);
1808 sset_destroy(&devnames
);
1810 p
->change_seq
= new_seq
;
1813 connmgr_run(p
->connmgr
, handle_openflow
);
1819 ofproto_wait(struct ofproto
*p
)
1821 p
->ofproto_class
->wait(p
);
1822 if (p
->ofproto_class
->port_poll_wait
) {
1823 p
->ofproto_class
->port_poll_wait(p
);
1825 seq_wait(connectivity_seq_get(), p
->change_seq
);
1826 connmgr_wait(p
->connmgr
);
1830 ofproto_is_alive(const struct ofproto
*p
)
1832 return connmgr_has_controllers(p
->connmgr
);
1835 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1836 * memory_report(). */
1838 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1840 const struct oftable
*table
;
1841 unsigned int n_rules
;
1843 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1846 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1847 n_rules
+= table
->n_flows
;
1849 simap_increase(usage
, "rules", n_rules
);
1851 if (ofproto
->ofproto_class
->get_memory_usage
) {
1852 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1855 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1859 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1861 const struct ofproto_class
*class;
1863 datapath_type
= ofproto_normalize_type(datapath_type
);
1864 class = ofproto_class_find__(datapath_type
);
1866 if (class && class->type_get_memory_usage
) {
1867 class->type_get_memory_usage(datapath_type
, usage
);
1872 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1875 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1879 ofproto_free_ofproto_controller_info(struct shash
*info
)
1881 connmgr_free_controller_info(info
);
1884 /* Makes a deep copy of 'old' into 'port'. */
1886 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1888 port
->name
= xstrdup(old
->name
);
1889 port
->type
= xstrdup(old
->type
);
1890 port
->ofp_port
= old
->ofp_port
;
1893 /* Frees memory allocated to members of 'ofproto_port'.
1895 * Do not call this function on an ofproto_port obtained from
1896 * ofproto_port_dump_next(): that function retains ownership of the data in the
1899 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1901 free(ofproto_port
->name
);
1902 free(ofproto_port
->type
);
1905 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1907 * This function provides no status indication. An error status for the entire
1908 * dump operation is provided when it is completed by calling
1909 * ofproto_port_dump_done().
1912 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1913 const struct ofproto
*ofproto
)
1915 dump
->ofproto
= ofproto
;
1916 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1920 /* Attempts to retrieve another port from 'dump', which must have been created
1921 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1922 * 'port' and returns true. On failure, returns false.
1924 * Failure might indicate an actual error or merely that the last port has been
1925 * dumped. An error status for the entire dump operation is provided when it
1926 * is completed by calling ofproto_port_dump_done().
1928 * The ofproto owns the data stored in 'port'. It will remain valid until at
1929 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1930 * ofproto_port_dump_done(). */
1932 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1933 struct ofproto_port
*port
)
1935 const struct ofproto
*ofproto
= dump
->ofproto
;
1941 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1944 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1950 /* Completes port table dump operation 'dump', which must have been created
1951 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1952 * error-free, otherwise a positive errno value describing the problem. */
1954 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1956 const struct ofproto
*ofproto
= dump
->ofproto
;
1958 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1961 return dump
->error
== EOF
? 0 : dump
->error
;
1964 /* Returns the type to pass to netdev_open() when a datapath of type
1965 * 'datapath_type' has a port of type 'port_type', for a few special
1966 * cases when a netdev type differs from a port type. For example, when
1967 * using the userspace datapath, a port of type "internal" needs to be
1970 * Returns either 'type' itself or a string literal, which must not be
1973 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1975 const struct ofproto_class
*class;
1977 datapath_type
= ofproto_normalize_type(datapath_type
);
1978 class = ofproto_class_find__(datapath_type
);
1983 return (class->port_open_type
1984 ? class->port_open_type(datapath_type
, port_type
)
1988 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1989 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1990 * the port's OpenFlow port number.
1992 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1993 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1994 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1995 * 'ofp_portp' is non-null). */
1997 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1998 ofp_port_t
*ofp_portp
)
2000 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
2003 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
2005 const char *netdev_name
= netdev_get_name(netdev
);
2007 simap_put(&ofproto
->ofp_requests
, netdev_name
,
2008 ofp_to_u16(ofp_port
));
2009 error
= update_port(ofproto
, netdev_name
);
2012 *ofp_portp
= OFPP_NONE
;
2014 struct ofproto_port ofproto_port
;
2016 error
= ofproto_port_query_by_name(ofproto
,
2017 netdev_get_name(netdev
),
2020 *ofp_portp
= ofproto_port
.ofp_port
;
2021 ofproto_port_destroy(&ofproto_port
);
2028 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
2029 * initializes '*port' appropriately; on failure, returns a positive errno
2032 * The caller owns the data in 'ofproto_port' and must free it with
2033 * ofproto_port_destroy() when it is no longer needed. */
2035 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
2036 struct ofproto_port
*port
)
2040 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
2042 memset(port
, 0, sizeof *port
);
2047 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
2048 * Returns 0 if successful, otherwise a positive errno. */
2050 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2052 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2053 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
2054 struct simap_node
*ofp_request_node
;
2057 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
2058 if (ofp_request_node
) {
2059 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
2062 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
2063 if (!error
&& ofport
) {
2064 /* 'name' is the netdev's name and update_port() is going to close the
2065 * netdev. Just in case update_port() refers to 'name' after it
2066 * destroys 'ofport', make a copy of it around the update_port()
2068 char *devname
= xstrdup(name
);
2069 update_port(ofproto
, devname
);
2075 /* Refreshes datapath configuration of port number 'ofp_port' in 'ofproto'.
2077 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
2079 ofproto_port_set_config(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2080 const struct smap
*cfg
)
2082 struct ofport
*ofport
;
2085 ofport
= ofproto_get_port(ofproto
, ofp_port
);
2087 VLOG_WARN("%s: cannot configure datapath on nonexistent port %"PRIu32
,
2088 ofproto
->name
, ofp_port
);
2092 error
= (ofproto
->ofproto_class
->port_set_config
2093 ? ofproto
->ofproto_class
->port_set_config(ofport
, cfg
)
2096 VLOG_WARN("%s: datapath configuration on port %"PRIu32
2097 " (%s) failed (%s)",
2098 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
2099 ovs_strerror(error
));
2105 flow_mod_init(struct ofputil_flow_mod
*fm
,
2106 const struct match
*match
, int priority
,
2107 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
2108 enum ofp_flow_mod_command command
)
2110 *fm
= (struct ofputil_flow_mod
) {
2112 .priority
= priority
,
2115 .buffer_id
= UINT32_MAX
,
2116 .out_port
= OFPP_ANY
,
2117 .out_group
= OFPG_ANY
,
2118 .ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
),
2119 .ofpacts_len
= ofpacts_len
,
2124 simple_flow_mod(struct ofproto
*ofproto
,
2125 const struct match
*match
, int priority
,
2126 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
2127 enum ofp_flow_mod_command command
)
2129 struct ofputil_flow_mod fm
;
2131 flow_mod_init(&fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
2133 return handle_flow_mod__(ofproto
, &fm
, NULL
);
2136 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2137 * performs the 'n_actions' actions in 'actions'. The new flow will not
2140 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2141 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2142 * controllers; otherwise, it will be hidden.
2144 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2146 * This is a helper function for in-band control and fail-open. */
2148 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
2150 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2151 OVS_EXCLUDED(ofproto_mutex
)
2153 const struct rule
*rule
;
2156 /* First do a cheap check whether the rule we're looking for already exists
2157 * with the actions that we want. If it does, then we're done. */
2158 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2159 &ofproto
->tables
[0].cls
, match
, priority
,
2162 const struct rule_actions
*actions
= rule_get_actions(rule
);
2163 must_add
= !ofpacts_equal(actions
->ofpacts
, actions
->ofpacts_len
,
2164 ofpacts
, ofpacts_len
);
2169 /* If there's no such rule or the rule doesn't have the actions we want,
2170 * fall back to a executing a full flow mod. We can't optimize this at
2171 * all because we didn't take enough locks above to ensure that the flow
2172 * table didn't already change beneath us. */
2174 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
2175 OFPFC_MODIFY_STRICT
);
2179 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2180 * an OFPERR_* OpenFlow error code on failure.
2182 * This is a helper function for in-band control and fail-open. */
2184 ofproto_flow_mod(struct ofproto
*ofproto
, const struct ofputil_flow_mod
*fm
)
2185 OVS_EXCLUDED(ofproto_mutex
)
2187 return handle_flow_mod__(ofproto
, fm
, NULL
);
2190 /* Searches for a rule with matching criteria exactly equal to 'target' in
2191 * ofproto's table 0 and, if it finds one, deletes it.
2193 * This is a helper function for in-band control and fail-open. */
2195 ofproto_delete_flow(struct ofproto
*ofproto
,
2196 const struct match
*target
, int priority
)
2197 OVS_REQUIRES(ofproto_mutex
)
2199 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
2202 /* First do a cheap check whether the rule we're looking for has already
2203 * been deleted. If so, then we're done. */
2204 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2205 cls
, target
, priority
, OVS_VERSION_MAX
));
2210 struct rule_collection rules
;
2212 rule_collection_init(&rules
);
2213 rule_collection_add(&rules
, rule
);
2214 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
2215 rule_collection_destroy(&rules
);
2218 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2219 * the flows required by in-band control and fail-open. */
2221 ofproto_flush_flows(struct ofproto
*ofproto
)
2223 COVERAGE_INC(ofproto_flush
);
2224 ofproto_flush__(ofproto
);
2225 connmgr_flushed(ofproto
->connmgr
);
2229 reinit_ports(struct ofproto
*p
)
2231 struct ofproto_port_dump dump
;
2232 struct sset devnames
;
2233 struct ofport
*ofport
;
2234 struct ofproto_port ofproto_port
;
2235 const char *devname
;
2237 COVERAGE_INC(ofproto_reinit_ports
);
2239 sset_init(&devnames
);
2240 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2241 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
2243 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2244 sset_add(&devnames
, ofproto_port
.name
);
2247 SSET_FOR_EACH (devname
, &devnames
) {
2248 update_port(p
, devname
);
2250 sset_destroy(&devnames
);
2254 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2258 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2259 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2261 if (port_idx
>= ofproto
->max_ports
2262 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2263 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2264 long long int last_used_at
, lru
= LLONG_MAX
;
2266 /* Search for a free OpenFlow port number. We try not to
2267 * immediately reuse them to prevent problems due to old
2270 * We limit the automatically assigned port numbers to the lower half
2271 * of the port range, to reserve the upper half for assignment by
2274 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2275 ofproto
->alloc_port_no
= 1;
2277 last_used_at
= ofport_get_usage(ofproto
,
2278 u16_to_ofp(ofproto
->alloc_port_no
));
2279 if (!last_used_at
) {
2280 port_idx
= ofproto
->alloc_port_no
;
2282 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2283 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2284 * more than an hour ago, consider it usable. */
2285 ofport_remove_usage(ofproto
,
2286 u16_to_ofp(ofproto
->alloc_port_no
));
2287 port_idx
= ofproto
->alloc_port_no
;
2289 } else if (last_used_at
< lru
) {
2291 lru_ofport
= ofproto
->alloc_port_no
;
2294 if (ofproto
->alloc_port_no
== end_port_no
) {
2296 port_idx
= lru_ofport
;
2303 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2304 return u16_to_ofp(port_idx
);
2308 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2310 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2311 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2315 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2316 * pointer if the netdev cannot be opened. On success, also fills in
2318 static struct netdev
*
2319 ofport_open(struct ofproto
*ofproto
,
2320 struct ofproto_port
*ofproto_port
,
2321 struct ofputil_phy_port
*pp
)
2323 enum netdev_flags flags
;
2324 struct netdev
*netdev
;
2327 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2329 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu32
") because netdev %s "
2330 "cannot be opened (%s)",
2332 ofproto_port
->name
, ofproto_port
->ofp_port
,
2333 ofproto_port
->name
, ovs_strerror(error
));
2337 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2338 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2339 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2341 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2342 ofproto_port
->name
);
2345 pp
->port_no
= ofproto_port
->ofp_port
;
2346 netdev_get_etheraddr(netdev
, &pp
->hw_addr
);
2347 pp
->hw_addr64
= eth_addr64_zero
;
2348 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2349 netdev_get_flags(netdev
, &flags
);
2350 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2351 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2352 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2353 &pp
->supported
, &pp
->peer
);
2354 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2355 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2360 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2361 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2364 ofport_equal(const struct ofputil_phy_port
*a
,
2365 const struct ofputil_phy_port
*b
)
2367 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2368 && eth_addr64_equals(a
->hw_addr64
, b
->hw_addr64
)
2369 && a
->state
== b
->state
2370 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2371 && a
->curr
== b
->curr
2372 && a
->advertised
== b
->advertised
2373 && a
->supported
== b
->supported
2374 && a
->peer
== b
->peer
2375 && a
->curr_speed
== b
->curr_speed
2376 && a
->max_speed
== b
->max_speed
);
2379 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2380 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2381 * one with the same name or port number). */
2383 ofport_install(struct ofproto
*p
,
2384 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2386 const char *netdev_name
= netdev_get_name(netdev
);
2387 struct ofport
*ofport
;
2390 /* Create ofport. */
2391 ofport
= p
->ofproto_class
->port_alloc();
2396 ofport
->ofproto
= p
;
2397 ofport
->netdev
= netdev
;
2398 ofport
->change_seq
= netdev_get_change_seq(netdev
);
2400 ofport
->ofp_port
= pp
->port_no
;
2401 ofport
->created
= time_msec();
2403 /* Add port to 'p'. */
2404 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2405 hash_ofp_port(ofport
->ofp_port
));
2406 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2408 update_mtu(p
, ofport
);
2410 /* Let the ofproto_class initialize its private data. */
2411 error
= p
->ofproto_class
->port_construct(ofport
);
2415 connmgr_send_port_status(p
->connmgr
, NULL
, pp
, OFPPR_ADD
);
2419 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2420 p
->name
, netdev_name
, ovs_strerror(error
));
2422 ofport_destroy__(ofport
);
2424 netdev_close(netdev
);
2429 /* Removes 'ofport' from 'p' and destroys it. */
2431 ofport_remove(struct ofport
*ofport
)
2433 struct ofproto
*p
= ofport
->ofproto
;
2434 bool is_mtu_overridden
= ofport_is_mtu_overridden(p
, ofport
);
2436 connmgr_send_port_status(ofport
->ofproto
->connmgr
, NULL
, &ofport
->pp
,
2438 ofport_destroy(ofport
, true);
2439 if (!is_mtu_overridden
) {
2440 update_mtu_ofproto(p
);
2444 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2447 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2449 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2451 ofport_remove(port
);
2455 /* Updates 'port' with new 'pp' description.
2457 * Does not handle a name or port number change. The caller must implement
2458 * such a change as a delete followed by an add. */
2460 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2462 port
->pp
.hw_addr
= pp
->hw_addr
;
2463 port
->pp
.hw_addr64
= pp
->hw_addr64
;
2464 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2465 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2466 port
->pp
.state
= ((port
->pp
.state
& ~OFPUTIL_PS_LINK_DOWN
)
2467 | (pp
->state
& OFPUTIL_PS_LINK_DOWN
));
2468 port
->pp
.curr
= pp
->curr
;
2469 port
->pp
.advertised
= pp
->advertised
;
2470 port
->pp
.supported
= pp
->supported
;
2471 port
->pp
.peer
= pp
->peer
;
2472 port
->pp
.curr_speed
= pp
->curr_speed
;
2473 port
->pp
.max_speed
= pp
->max_speed
;
2476 /* Update OpenFlow 'state' in 'port' and notify controller. */
2478 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2480 if (port
->pp
.state
!= state
) {
2481 port
->pp
.state
= state
;
2482 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2483 &port
->pp
, OFPPR_MODIFY
);
2488 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2490 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2492 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2493 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2495 if (port
->ofproto
->ofproto_class
->set_rstp_port
) {
2496 port
->ofproto
->ofproto_class
->set_rstp_port(port
, NULL
);
2498 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2499 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2501 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2502 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2508 ofport_destroy__(struct ofport
*port
)
2510 struct ofproto
*ofproto
= port
->ofproto
;
2511 const char *name
= netdev_get_name(port
->netdev
);
2513 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2514 shash_find_and_delete(&ofproto
->port_by_name
, name
);
2516 netdev_close(port
->netdev
);
2517 ofproto
->ofproto_class
->port_dealloc(port
);
2521 ofport_destroy(struct ofport
*port
, bool del
)
2524 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2525 port
->ofproto
->ofproto_class
->port_destruct(port
, del
);
2526 ofport_destroy__(port
);
2531 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2533 struct ofport
*port
;
2535 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2537 if (port
->ofp_port
== ofp_port
) {
2544 static long long int
2545 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2547 struct ofport_usage
*usage
;
2549 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2550 &ofproto
->ofport_usage
) {
2551 if (usage
->ofp_port
== ofp_port
) {
2552 return usage
->last_used
;
2559 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2560 long long int last_used
)
2562 struct ofport_usage
*usage
;
2563 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2564 &ofproto
->ofport_usage
) {
2565 if (usage
->ofp_port
== ofp_port
) {
2566 usage
->last_used
= last_used
;
2570 ovs_assert(last_used
== LLONG_MAX
);
2572 usage
= xmalloc(sizeof *usage
);
2573 usage
->ofp_port
= ofp_port
;
2574 usage
->last_used
= last_used
;
2575 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2576 hash_ofp_port(ofp_port
));
2580 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2582 struct ofport_usage
*usage
;
2583 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2584 &ofproto
->ofport_usage
) {
2585 if (usage
->ofp_port
== ofp_port
) {
2586 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2594 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2596 struct ofproto
*ofproto
= port
->ofproto
;
2599 if (ofproto
->ofproto_class
->port_get_stats
) {
2600 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2609 update_port(struct ofproto
*ofproto
, const char *name
)
2611 struct ofproto_port ofproto_port
;
2612 struct ofputil_phy_port pp
;
2613 struct netdev
*netdev
;
2614 struct ofport
*port
;
2617 COVERAGE_INC(ofproto_update_port
);
2619 /* Fetch 'name''s location and properties from the datapath. */
2620 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2621 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2625 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2626 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2627 struct netdev
*old_netdev
= port
->netdev
;
2629 /* 'name' hasn't changed location. Any properties changed? */
2630 bool port_changed
= !ofport_equal(&port
->pp
, &pp
);
2632 ofport_modified(port
, &pp
);
2635 update_mtu(ofproto
, port
);
2637 /* Install the newly opened netdev in case it has changed.
2638 * Don't close the old netdev yet in case port_modified has to
2639 * remove a retained reference to it.*/
2640 port
->netdev
= netdev
;
2641 port
->change_seq
= netdev_get_change_seq(netdev
);
2643 if (port
->ofproto
->ofproto_class
->port_modified
) {
2644 port
->ofproto
->ofproto_class
->port_modified(port
);
2647 /* Send status update, if any port property changed */
2649 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2650 &port
->pp
, OFPPR_MODIFY
);
2653 netdev_close(old_netdev
);
2655 /* If 'port' is nonnull then its name differs from 'name' and thus
2656 * we should delete it. If we think there's a port named 'name'
2657 * then its port number must be wrong now so delete it too. */
2659 ofport_remove(port
);
2661 ofport_remove_with_name(ofproto
, name
);
2662 error
= ofport_install(ofproto
, netdev
, &pp
);
2665 /* Any port named 'name' is gone now. */
2666 ofport_remove_with_name(ofproto
, name
);
2668 ofproto_port_destroy(&ofproto_port
);
2674 init_ports(struct ofproto
*p
)
2676 struct ofproto_port_dump dump
;
2677 struct ofproto_port ofproto_port
;
2678 struct shash_node
*node
, *next
;
2680 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2681 const char *name
= ofproto_port
.name
;
2683 if (shash_find(&p
->port_by_name
, name
)) {
2684 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2687 struct ofputil_phy_port pp
;
2688 struct netdev
*netdev
;
2690 /* Check if an OpenFlow port number had been requested. */
2691 node
= shash_find(&init_ofp_ports
, name
);
2693 const struct iface_hint
*iface_hint
= node
->data
;
2694 simap_put(&p
->ofp_requests
, name
,
2695 ofp_to_u16(iface_hint
->ofp_port
));
2698 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2700 ofport_install(p
, netdev
, &pp
);
2701 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2702 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2703 ofp_to_u16(ofproto_port
.ofp_port
));
2709 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2710 struct iface_hint
*iface_hint
= node
->data
;
2712 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2713 free(iface_hint
->br_name
);
2714 free(iface_hint
->br_type
);
2716 shash_delete(&init_ofp_ports
, node
);
2724 ofport_is_internal(const struct ofproto
*p
, const struct ofport
*port
)
2726 return !strcmp(netdev_get_type(port
->netdev
),
2727 ofproto_port_open_type(p
->type
, "internal"));
2730 /* If 'port' is internal and if the user didn't explicitly specify an mtu
2731 * through the database, we have to override it. */
2733 ofport_is_mtu_overridden(const struct ofproto
*p
, const struct ofport
*port
)
2735 return ofport_is_internal(p
, port
)
2736 && !netdev_mtu_is_user_config(port
->netdev
);
2739 /* Find the minimum MTU of all non-overridden devices attached to 'p'.
2740 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2742 find_min_mtu(struct ofproto
*p
)
2744 struct ofport
*ofport
;
2747 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2748 struct netdev
*netdev
= ofport
->netdev
;
2751 /* Skip any overridden port, since that's what we're trying to set. */
2752 if (ofport_is_mtu_overridden(p
, ofport
)) {
2756 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2759 if (!mtu
|| dev_mtu
< mtu
) {
2764 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2767 /* Update MTU of all overridden devices on 'p' to the minimum of the
2768 * non-overridden ports in event of 'port' added or changed. */
2770 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2772 struct netdev
*netdev
= port
->netdev
;
2775 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2779 if (ofport_is_mtu_overridden(p
, port
)) {
2780 if (dev_mtu
> p
->min_mtu
) {
2781 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2782 dev_mtu
= p
->min_mtu
;
2785 port
->mtu
= dev_mtu
;
2789 port
->mtu
= dev_mtu
;
2790 /* For non-overridden port find new min mtu. */
2792 update_mtu_ofproto(p
);
2796 update_mtu_ofproto(struct ofproto
*p
)
2798 struct ofport
*ofport
;
2799 int old_min
= p
->min_mtu
;
2801 p
->min_mtu
= find_min_mtu(p
);
2802 if (p
->min_mtu
== old_min
) {
2806 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2807 struct netdev
*netdev
= ofport
->netdev
;
2809 if (ofport_is_mtu_overridden(p
, ofport
)) {
2810 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2811 ofport
->mtu
= p
->min_mtu
;
2818 ofproto_rule_destroy__(struct rule
*rule
)
2819 OVS_NO_THREAD_SAFETY_ANALYSIS
2821 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2822 rule_actions_destroy(rule_get_actions(rule
));
2823 ovs_mutex_destroy(&rule
->mutex
);
2824 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2828 rule_destroy_cb(struct rule
*rule
)
2829 OVS_NO_THREAD_SAFETY_ANALYSIS
2831 /* Send rule removed if needed. */
2832 if (rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
2833 && rule
->removed_reason
!= OVS_OFPRR_NONE
2834 && !rule_is_hidden(rule
)) {
2835 ofproto_rule_send_removed(rule
);
2837 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2838 mf_vl_mff_unref(&rule
->ofproto
->vl_mff_map
, rule
->match_tlv_bitmap
);
2839 mf_vl_mff_unref(&rule
->ofproto
->vl_mff_map
, rule
->ofpacts_tlv_bitmap
);
2840 ofproto_rule_destroy__(rule
);
2844 ofproto_rule_ref(struct rule
*rule
)
2847 ovs_refcount_ref(&rule
->ref_count
);
2852 ofproto_rule_try_ref(struct rule
*rule
)
2855 return ovs_refcount_try_ref_rcu(&rule
->ref_count
);
2860 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2861 * ref_count reaches 0.
2863 * Use of RCU allows short term use (between RCU quiescent periods) without
2864 * keeping a reference. A reference must be taken if the rule needs to
2865 * stay around accross the RCU quiescent periods. */
2867 ofproto_rule_unref(struct rule
*rule
)
2869 if (rule
&& ovs_refcount_unref_relaxed(&rule
->ref_count
) == 1) {
2870 ovs_assert(rule
->state
!= RULE_INSERTED
);
2871 ovsrcu_postpone(rule_destroy_cb
, rule
);
2876 remove_rule_rcu__(struct rule
*rule
)
2877 OVS_REQUIRES(ofproto_mutex
)
2879 struct ofproto
*ofproto
= rule
->ofproto
;
2880 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
2882 ovs_assert(!cls_rule_visible_in_version(&rule
->cr
, OVS_VERSION_MAX
));
2883 if (!classifier_remove(&table
->cls
, &rule
->cr
)) {
2886 if (ofproto
->ofproto_class
->rule_delete
) {
2887 ofproto
->ofproto_class
->rule_delete(rule
);
2889 ofproto_rule_unref(rule
);
2893 remove_rule_rcu(struct rule
*rule
)
2894 OVS_EXCLUDED(ofproto_mutex
)
2896 ovs_mutex_lock(&ofproto_mutex
);
2897 remove_rule_rcu__(rule
);
2898 ovs_mutex_unlock(&ofproto_mutex
);
2901 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2903 remove_rules_rcu(struct rule
**rules
)
2904 OVS_EXCLUDED(ofproto_mutex
)
2906 struct rule
**orig_rules
= rules
;
2909 struct ofproto
*ofproto
= rules
[0]->ofproto
;
2910 unsigned long tables
[BITMAP_N_LONGS(256)];
2914 memset(tables
, 0, sizeof tables
);
2916 ovs_mutex_lock(&ofproto_mutex
);
2917 while ((rule
= *rules
++)) {
2918 /* Defer once for each new table. This defers the subtable cleanup
2919 * until later, so that when removing large number of flows the
2920 * operation is faster. */
2921 if (!bitmap_is_set(tables
, rule
->table_id
)) {
2922 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
2924 bitmap_set1(tables
, rule
->table_id
);
2925 classifier_defer(cls
);
2927 remove_rule_rcu__(rule
);
2930 BITMAP_FOR_EACH_1(table_id
, 256, tables
) {
2931 struct classifier
*cls
= &ofproto
->tables
[table_id
].cls
;
2933 classifier_publish(cls
);
2935 ovs_mutex_unlock(&ofproto_mutex
);
2942 ofproto_group_ref(struct ofgroup
*group
)
2945 ovs_refcount_ref(&group
->ref_count
);
2950 ofproto_group_try_ref(struct ofgroup
*group
)
2953 return ovs_refcount_try_ref_rcu(&group
->ref_count
);
2959 group_destroy_cb(struct ofgroup
*group
)
2961 group
->ofproto
->ofproto_class
->group_destruct(group
);
2962 ofputil_group_properties_destroy(CONST_CAST(struct ofputil_group_props
*,
2964 ofputil_bucket_list_destroy(CONST_CAST(struct ovs_list
*,
2966 group
->ofproto
->ofproto_class
->group_dealloc(group
);
2970 ofproto_group_unref(struct ofgroup
*group
)
2971 OVS_NO_THREAD_SAFETY_ANALYSIS
2973 if (group
&& ovs_refcount_unref_relaxed(&group
->ref_count
) == 1) {
2974 ovs_assert(rule_collection_n(&group
->rules
) == 0);
2975 ovsrcu_postpone(group_destroy_cb
, group
);
2980 remove_group_rcu__(struct ofgroup
*group
)
2981 OVS_REQUIRES(ofproto_mutex
)
2983 struct ofproto
*ofproto
= group
->ofproto
;
2985 ovs_assert(!versions_visible_in_version(&group
->versions
, OVS_VERSION_MAX
));
2987 cmap_remove(&ofproto
->groups
, &group
->cmap_node
,
2988 hash_int(group
->group_id
, 0));
2989 ofproto_group_unref(group
);
2993 remove_group_rcu(struct ofgroup
*group
)
2994 OVS_EXCLUDED(ofproto_mutex
)
2996 ovs_mutex_lock(&ofproto_mutex
);
2997 remove_group_rcu__(group
);
2998 ovs_mutex_unlock(&ofproto_mutex
);
3001 /* Removes and deletes groups from a NULL-terminated array of group
3004 remove_groups_rcu(struct ofgroup
**groups
)
3005 OVS_EXCLUDED(ofproto_mutex
)
3007 ovs_mutex_lock(&ofproto_mutex
);
3008 for (struct ofgroup
**g
= groups
; *g
; g
++) {
3009 remove_group_rcu__(*g
);
3011 ovs_mutex_unlock(&ofproto_mutex
);
3015 static bool ofproto_fix_meter_action(const struct ofproto
*,
3016 struct ofpact_meter
*);
3018 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
3019 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
3020 const struct rule_actions
*
3021 rule_actions_create(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
3023 struct rule_actions
*actions
;
3025 actions
= xmalloc(sizeof *actions
+ ofpacts_len
);
3026 actions
->ofpacts_len
= ofpacts_len
;
3027 memcpy(actions
->ofpacts
, ofpacts
, ofpacts_len
);
3028 actions
->has_meter
= ofpacts_get_meter(ofpacts
, ofpacts_len
) != 0;
3029 actions
->has_groups
=
3030 (ofpact_find_type_flattened(ofpacts
, OFPACT_GROUP
,
3031 ofpact_end(ofpacts
, ofpacts_len
))
3033 actions
->has_learn_with_delete
= (next_learn_with_delete(actions
, NULL
)
3039 /* Free the actions after the RCU quiescent period is reached. */
3041 rule_actions_destroy(const struct rule_actions
*actions
)
3044 ovsrcu_postpone(free
, CONST_CAST(struct rule_actions
*, actions
));
3048 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
3049 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
3051 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
3052 OVS_REQUIRES(ofproto_mutex
)
3054 if (port
== OFPP_ANY
) {
3057 const struct rule_actions
*actions
= rule_get_actions(rule
);
3058 return ofpacts_output_to_port(actions
->ofpacts
,
3059 actions
->ofpacts_len
, port
);
3063 /* Returns true if 'rule' has group and equals group_id. */
3065 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
3066 OVS_REQUIRES(ofproto_mutex
)
3068 if (group_id
== OFPG_ANY
) {
3071 const struct rule_actions
*actions
= rule_get_actions(rule
);
3072 return ofpacts_output_to_group(actions
->ofpacts
,
3073 actions
->ofpacts_len
, group_id
);
3078 rule_is_readonly(const struct rule
*rule
)
3080 const struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
3081 return (table
->flags
& OFTABLE_READONLY
) != 0;
3085 hash_learned_cookie(ovs_be64 cookie_
, uint8_t table_id
)
3087 uint64_t cookie
= (OVS_FORCE
uint64_t) cookie_
;
3088 return hash_3words(cookie
, cookie
>> 32, table_id
);
3092 learned_cookies_update_one__(struct ofproto
*ofproto
,
3093 const struct ofpact_learn
*learn
,
3094 int delta
, struct ovs_list
*dead_cookies
)
3095 OVS_REQUIRES(ofproto_mutex
)
3097 uint32_t hash
= hash_learned_cookie(learn
->cookie
, learn
->table_id
);
3098 struct learned_cookie
*c
;
3100 HMAP_FOR_EACH_WITH_HASH (c
, u
.hmap_node
, hash
, &ofproto
->learned_cookies
) {
3101 if (c
->cookie
== learn
->cookie
&& c
->table_id
== learn
->table_id
) {
3103 ovs_assert(c
->n
>= 0);
3106 hmap_remove(&ofproto
->learned_cookies
, &c
->u
.hmap_node
);
3107 ovs_list_push_back(dead_cookies
, &c
->u
.list_node
);
3114 ovs_assert(delta
> 0);
3115 c
= xmalloc(sizeof *c
);
3116 hmap_insert(&ofproto
->learned_cookies
, &c
->u
.hmap_node
, hash
);
3117 c
->cookie
= learn
->cookie
;
3118 c
->table_id
= learn
->table_id
;
3122 static const struct ofpact_learn
*
3123 next_learn_with_delete(const struct rule_actions
*actions
,
3124 const struct ofpact_learn
*start
)
3126 const struct ofpact
*pos
;
3128 for (pos
= start
? ofpact_next(&start
->ofpact
) : actions
->ofpacts
;
3129 pos
< ofpact_end(actions
->ofpacts
, actions
->ofpacts_len
);
3130 pos
= ofpact_next(pos
)) {
3131 if (pos
->type
== OFPACT_LEARN
) {
3132 const struct ofpact_learn
*learn
= ofpact_get_LEARN(pos
);
3133 if (learn
->flags
& NX_LEARN_F_DELETE_LEARNED
) {
3143 learned_cookies_update__(struct ofproto
*ofproto
,
3144 const struct rule_actions
*actions
,
3145 int delta
, struct ovs_list
*dead_cookies
)
3146 OVS_REQUIRES(ofproto_mutex
)
3148 if (actions
->has_learn_with_delete
) {
3149 const struct ofpact_learn
*learn
;
3151 for (learn
= next_learn_with_delete(actions
, NULL
); learn
;
3152 learn
= next_learn_with_delete(actions
, learn
)) {
3153 learned_cookies_update_one__(ofproto
, learn
, delta
, dead_cookies
);
3159 learned_cookies_inc(struct ofproto
*ofproto
,
3160 const struct rule_actions
*actions
)
3161 OVS_REQUIRES(ofproto_mutex
)
3163 learned_cookies_update__(ofproto
, actions
, +1, NULL
);
3167 learned_cookies_dec(struct ofproto
*ofproto
,
3168 const struct rule_actions
*actions
,
3169 struct ovs_list
*dead_cookies
)
3170 OVS_REQUIRES(ofproto_mutex
)
3172 learned_cookies_update__(ofproto
, actions
, -1, dead_cookies
);
3176 learned_cookies_flush(struct ofproto
*ofproto
, struct ovs_list
*dead_cookies
)
3177 OVS_REQUIRES(ofproto_mutex
)
3179 struct learned_cookie
*c
;
3181 LIST_FOR_EACH_POP (c
, u
.list_node
, dead_cookies
) {
3182 struct rule_criteria criteria
;
3183 struct rule_collection rules
;
3186 match_init_catchall(&match
);
3187 rule_criteria_init(&criteria
, c
->table_id
, &match
, 0, OVS_VERSION_MAX
,
3188 c
->cookie
, OVS_BE64_MAX
, OFPP_ANY
, OFPG_ANY
);
3189 rule_criteria_require_rw(&criteria
, false);
3190 collect_rules_loose(ofproto
, &criteria
, &rules
);
3191 rule_criteria_destroy(&criteria
);
3192 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
3199 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3201 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
3206 query_tables(struct ofproto
*ofproto
,
3207 struct ofputil_table_features
**featuresp
,
3208 struct ofputil_table_stats
**statsp
)
3210 struct mf_bitmap rw_fields
= oxm_writable_fields();
3211 struct mf_bitmap match
= oxm_matchable_fields();
3212 struct mf_bitmap mask
= oxm_maskable_fields();
3214 struct ofputil_table_features
*features
;
3215 struct ofputil_table_stats
*stats
;
3218 features
= *featuresp
= xcalloc(ofproto
->n_tables
, sizeof *features
);
3219 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3220 struct ofputil_table_features
*f
= &features
[i
];
3223 sprintf(f
->name
, "table%d", i
);
3224 f
->metadata_match
= OVS_BE64_MAX
;
3225 f
->metadata_write
= OVS_BE64_MAX
;
3226 atomic_read_relaxed(&ofproto
->tables
[i
].miss_config
, &f
->miss_config
);
3227 f
->max_entries
= 1000000;
3229 bool more_tables
= false;
3230 for (int j
= i
+ 1; j
< ofproto
->n_tables
; j
++) {
3231 if (!(ofproto
->tables
[j
].flags
& OFTABLE_HIDDEN
)) {
3232 bitmap_set1(f
->nonmiss
.next
, j
);
3236 f
->nonmiss
.instructions
= (1u << N_OVS_INSTRUCTIONS
) - 1;
3238 f
->nonmiss
.instructions
&= ~(1u << OVSINST_OFPIT11_GOTO_TABLE
);
3240 f
->nonmiss
.write
.ofpacts
= (UINT64_C(1) << N_OFPACTS
) - 1;
3241 f
->nonmiss
.write
.set_fields
= rw_fields
;
3242 f
->nonmiss
.apply
= f
->nonmiss
.write
;
3243 f
->miss
= f
->nonmiss
;
3247 f
->wildcard
= match
;
3251 stats
= *statsp
= xcalloc(ofproto
->n_tables
, sizeof *stats
);
3252 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3253 struct ofputil_table_stats
*s
= &stats
[i
];
3256 s
->active_count
= ofproto
->tables
[i
].n_flows
;
3258 s
->active_count
-= connmgr_count_hidden_rules(
3266 ofproto
->ofproto_class
->query_tables(ofproto
, features
, stats
);
3268 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3269 const struct oftable
*table
= &ofproto
->tables
[i
];
3270 struct ofputil_table_features
*f
= &features
[i
];
3273 ovs_strzcpy(f
->name
, table
->name
, sizeof f
->name
);
3276 if (table
->max_flows
< f
->max_entries
) {
3277 f
->max_entries
= table
->max_flows
;
3283 query_switch_features(struct ofproto
*ofproto
,
3284 bool *arp_match_ip
, uint64_t *ofpacts
)
3286 struct ofputil_table_features
*features
, *f
;
3288 *arp_match_ip
= false;
3291 query_tables(ofproto
, &features
, NULL
);
3292 for (f
= features
; f
< &features
[ofproto
->n_tables
]; f
++) {
3293 *ofpacts
|= f
->nonmiss
.apply
.ofpacts
| f
->miss
.apply
.ofpacts
;
3294 if (bitmap_is_set(f
->match
.bm
, MFF_ARP_SPA
) ||
3295 bitmap_is_set(f
->match
.bm
, MFF_ARP_TPA
)) {
3296 *arp_match_ip
= true;
3302 ovs_assert(*ofpacts
& (UINT64_C(1) << OFPACT_OUTPUT
));
3306 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3308 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3309 struct ofputil_switch_features features
;
3310 struct ofport
*port
;
3314 query_switch_features(ofproto
, &arp_match_ip
, &features
.ofpacts
);
3316 features
.datapath_id
= ofproto
->datapath_id
;
3317 features
.n_buffers
= 0;
3318 features
.n_tables
= ofproto_get_n_visible_tables(ofproto
);
3319 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
3320 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
|
3321 OFPUTIL_C_GROUP_STATS
| OFPUTIL_C_BUNDLES
);
3323 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
3325 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3326 features
.auxiliary_id
= 0;
3327 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
3329 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3330 ofputil_put_switch_features_port(&port
->pp
, b
);
3333 ofconn_send_reply(ofconn
, b
);
3338 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3340 struct ofputil_switch_config config
;
3341 config
.frag
= ofconn_get_ofproto(ofconn
)->frag_handling
;
3342 config
.invalid_ttl_to_controller
3343 = ofconn_get_invalid_ttl_to_controller(ofconn
);
3344 config
.miss_send_len
= ofconn_get_miss_send_len(ofconn
);
3346 ofconn_send_reply(ofconn
, ofputil_encode_get_config_reply(oh
, &config
));
3352 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3354 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3355 struct ofputil_switch_config config
;
3358 error
= ofputil_decode_set_config(oh
, &config
);
3363 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
3364 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
3365 enum ofputil_frag_handling cur
= ofproto
->frag_handling
;
3366 enum ofputil_frag_handling next
= config
.frag
;
3369 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
3370 ofproto
->frag_handling
= next
;
3372 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
3374 ofputil_frag_handling_to_string(next
));
3379 if (config
.invalid_ttl_to_controller
>= 0) {
3380 ofconn_set_invalid_ttl_to_controller(ofconn
,
3381 config
.invalid_ttl_to_controller
);
3384 ofconn_set_miss_send_len(ofconn
, config
.miss_send_len
);
3389 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3390 * error message code for the caller to propagate upward. Otherwise, returns
3393 * The log message mentions 'msg_type'. */
3395 reject_slave_controller(struct ofconn
*ofconn
)
3397 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
3398 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
3399 return OFPERR_OFPBRC_IS_SLAVE
;
3405 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3408 * - If they use a meter, then 'ofproto' has that meter configured.
3409 * Updates the meter action with ofproto's datapath's provider_meter_id.
3411 * - If they use any groups, then 'ofproto' has that group configured.
3413 * Returns 0 if successful, otherwise an OpenFlow error. Caller must hold
3414 * 'ofproto_mutex' for the result to be valid also after this function
3417 ofproto_check_ofpacts(struct ofproto
*ofproto
,
3418 const struct ofpact ofpacts
[], size_t ofpacts_len
)
3419 OVS_REQUIRES(ofproto_mutex
)
3421 const struct ofpact
*a
;
3423 OFPACT_FOR_EACH_FLATTENED (a
, ofpacts
, ofpacts_len
) {
3424 if (a
->type
== OFPACT_METER
&&
3425 !ofproto_fix_meter_action(ofproto
, ofpact_get_METER(a
))) {
3426 return OFPERR_OFPMMFC_INVALID_METER
;
3429 if (a
->type
== OFPACT_GROUP
3430 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
3431 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
3439 ofproto_packet_out_uninit(struct ofproto_packet_out
*opo
)
3441 dp_packet_delete(opo
->packet
);
3446 opo
->ofpacts
= NULL
;
3447 opo
->ofpacts_len
= 0;
3448 ovs_assert(!opo
->aux
);
3451 /* Takes ownership of po->ofpacts, which must have been malloc'ed. */
3453 ofproto_packet_out_init(struct ofproto
*ofproto
,
3454 struct ofconn
*ofconn
,
3455 struct ofproto_packet_out
*opo
,
3456 const struct ofputil_packet_out
*po
)
3462 uint64_t buf
[FLOW_U64S
];
3465 uint16_t in_port
= ofp_to_u16(po
->flow_metadata
.flow
.in_port
.ofp_port
);
3466 if (in_port
>= ofproto
->max_ports
&& in_port
< ofp_to_u16(OFPP_MAX
)) {
3467 return OFPERR_OFPBRC_BAD_PORT
;
3471 if (po
->buffer_id
!= UINT32_MAX
) {
3472 return OFPERR_OFPBRC_BUFFER_UNKNOWN
;
3475 /* Ensure that the L3 header is 32-bit aligned. */
3476 opo
->packet
= dp_packet_clone_data_with_headroom(po
->packet
,
3478 /* Store struct flow. */
3479 opo
->flow
= xmalloc(sizeof *opo
->flow
);
3480 *opo
->flow
= po
->flow_metadata
.flow
;
3481 miniflow_extract(opo
->packet
, &m
.mf
);
3482 flow_union_with_miniflow(opo
->flow
, &m
.mf
);
3484 /* Check actions like for flow mods. We pass a 'table_id' of 0 to
3485 * ofproto_check_consistency(), which isn't strictly correct because these
3486 * actions aren't in any table. This is OK as 'table_id' is only used to
3487 * check instructions (e.g., goto-table), which can't appear on the action
3488 * list of a packet-out. */
3489 match_wc_init(&match
, opo
->flow
);
3490 error
= ofpacts_check_consistency(po
->ofpacts
, po
->ofpacts_len
, &match
,
3491 u16_to_ofp(ofproto
->max_ports
), 0,
3493 ofconn_get_protocol(ofconn
));
3495 dp_packet_delete(opo
->packet
);
3500 opo
->ofpacts
= po
->ofpacts
;
3501 opo
->ofpacts_len
= po
->ofpacts_len
;
3508 ofproto_packet_out_start(struct ofproto
*ofproto
,
3509 struct ofproto_packet_out
*opo
)
3510 OVS_REQUIRES(ofproto_mutex
)
3514 error
= ofproto_check_ofpacts(ofproto
, opo
->ofpacts
, opo
->ofpacts_len
);
3519 return ofproto
->ofproto_class
->packet_xlate(ofproto
, opo
);
3523 ofproto_packet_out_revert(struct ofproto
*ofproto
,
3524 struct ofproto_packet_out
*opo
)
3525 OVS_REQUIRES(ofproto_mutex
)
3527 ofproto
->ofproto_class
->packet_xlate_revert(ofproto
, opo
);
3531 ofproto_packet_out_finish(struct ofproto
*ofproto
,
3532 struct ofproto_packet_out
*opo
)
3533 OVS_REQUIRES(ofproto_mutex
)
3535 ofproto
->ofproto_class
->packet_execute(ofproto
, opo
);
3539 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3540 OVS_EXCLUDED(ofproto_mutex
)
3542 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3543 struct ofputil_packet_out po
;
3544 struct ofproto_packet_out opo
;
3545 uint64_t ofpacts_stub
[1024 / 8];
3546 struct ofpbuf ofpacts
;
3549 COVERAGE_INC(ofproto_packet_out
);
3551 error
= reject_slave_controller(ofconn
);
3556 /* Decode message. */
3557 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3558 error
= ofputil_decode_packet_out(&po
, oh
, ofproto_get_tun_tab(p
),
3561 ofpbuf_uninit(&ofpacts
);
3565 po
.ofpacts
= ofpbuf_steal_data(&ofpacts
); /* Move to heap. */
3566 error
= ofproto_packet_out_init(p
, ofconn
, &opo
, &po
);
3572 ovs_mutex_lock(&ofproto_mutex
);
3573 opo
.version
= p
->tables_version
;
3574 error
= ofproto_packet_out_start(p
, &opo
);
3576 ofproto_packet_out_finish(p
, &opo
);
3578 ovs_mutex_unlock(&ofproto_mutex
);
3580 ofproto_packet_out_uninit(&opo
);
3585 handle_nxt_resume(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3587 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3588 struct ofputil_packet_in_private pin
;
3591 error
= ofputil_decode_packet_in_private(oh
, false,
3592 ofproto_get_tun_tab(ofproto
),
3593 &ofproto
->vl_mff_map
, &pin
, NULL
,
3599 error
= (ofproto
->ofproto_class
->nxt_resume
3600 ? ofproto
->ofproto_class
->nxt_resume(ofproto
, &pin
)
3601 : OFPERR_NXR_NOT_SUPPORTED
);
3603 ofputil_packet_in_private_destroy(&pin
);
3609 update_port_config(struct ofconn
*ofconn
, struct ofport
*port
,
3610 enum ofputil_port_config config
,
3611 enum ofputil_port_config mask
)
3613 enum ofputil_port_config toggle
= (config
^ port
->pp
.config
) & mask
;
3615 if (toggle
& OFPUTIL_PC_PORT_DOWN
3616 && (config
& OFPUTIL_PC_PORT_DOWN
3617 ? netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
)
3618 : netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
))) {
3619 /* We tried to bring the port up or down, but it failed, so don't
3620 * update the "down" bit. */
3621 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
3625 enum ofputil_port_config old_config
= port
->pp
.config
;
3626 port
->pp
.config
^= toggle
;
3627 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
3628 connmgr_send_port_status(port
->ofproto
->connmgr
, ofconn
, &port
->pp
,
3634 port_mod_start(struct ofconn
*ofconn
, struct ofputil_port_mod
*pm
,
3635 struct ofport
**port
)
3637 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3639 *port
= ofproto_get_port(p
, pm
->port_no
);
3641 return OFPERR_OFPPMFC_BAD_PORT
;
3643 if (!eth_addr_equals((*port
)->pp
.hw_addr
, pm
->hw_addr
) ||
3644 !eth_addr64_equals((*port
)->pp
.hw_addr64
, pm
->hw_addr64
)) {
3645 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3651 port_mod_finish(struct ofconn
*ofconn
, struct ofputil_port_mod
*pm
,
3652 struct ofport
*port
)
3654 update_port_config(ofconn
, port
, pm
->config
, pm
->mask
);
3655 if (pm
->advertise
) {
3656 netdev_set_advertisements(port
->netdev
, pm
->advertise
);
3661 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3663 struct ofputil_port_mod pm
;
3664 struct ofport
*port
;
3667 error
= reject_slave_controller(ofconn
);
3672 error
= ofputil_decode_port_mod(oh
, &pm
, false);
3677 error
= port_mod_start(ofconn
, &pm
, &port
);
3679 port_mod_finish(ofconn
, &pm
, port
);
3685 handle_desc_stats_request(struct ofconn
*ofconn
,
3686 const struct ofp_header
*request
)
3688 static const char *default_mfr_desc
= "Nicira, Inc.";
3689 static const char *default_hw_desc
= "Open vSwitch";
3690 static const char *default_sw_desc
= VERSION
;
3691 static const char *default_serial_desc
= "None";
3692 static const char *default_dp_desc
= "None";
3694 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3695 struct ofp_desc_stats
*ods
;
3698 msg
= ofpraw_alloc_stats_reply(request
, 0);
3699 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3700 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3701 sizeof ods
->mfr_desc
);
3702 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3703 sizeof ods
->hw_desc
);
3704 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3705 sizeof ods
->sw_desc
);
3706 ovs_strlcpy(ods
->serial_num
,
3707 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3708 sizeof ods
->serial_num
);
3709 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3710 sizeof ods
->dp_desc
);
3711 ofconn_send_reply(ofconn
, msg
);
3717 handle_table_stats_request(struct ofconn
*ofconn
,
3718 const struct ofp_header
*request
)
3720 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3721 struct ofputil_table_features
*features
;
3722 struct ofputil_table_stats
*stats
;
3723 struct ofpbuf
*reply
;
3726 query_tables(ofproto
, &features
, &stats
);
3728 reply
= ofputil_encode_table_stats_reply(request
);
3729 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3730 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3731 ofputil_append_table_stats_reply(reply
, &stats
[i
], &features
[i
]);
3734 ofconn_send_reply(ofconn
, reply
);
3743 handle_table_features_request(struct ofconn
*ofconn
,
3744 const struct ofp_header
*request
)
3746 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3747 struct ofpbuf msg
= ofpbuf_const_initializer(request
,
3748 ntohs(request
->length
));
3749 ofpraw_pull_assert(&msg
);
3750 if (msg
.size
|| ofpmp_more(request
)) {
3751 return OFPERR_OFPTFFC_EPERM
;
3754 struct ofputil_table_features
*features
;
3755 query_tables(ofproto
, &features
, NULL
);
3757 struct ovs_list replies
;
3758 ofpmp_init(&replies
, request
);
3759 for (size_t i
= 0; i
< ofproto
->n_tables
; i
++) {
3760 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3761 ofputil_append_table_features_reply(&features
[i
], &replies
);
3764 ofconn_send_replies(ofconn
, &replies
);
3771 /* Returns the vacancy of 'oftable', a number that ranges from 0 (if the table
3772 * is full) to 100 (if the table is empty).
3774 * A table without a limit on flows is considered to be empty. */
3776 oftable_vacancy(const struct oftable
*t
)
3778 return (!t
->max_flows
? 100
3779 : t
->n_flows
>= t
->max_flows
? 0
3780 : (t
->max_flows
- t
->n_flows
) * 100.0 / t
->max_flows
);
3784 query_table_desc__(struct ofputil_table_desc
*td
,
3785 struct ofproto
*ofproto
, uint8_t table_id
)
3787 const struct oftable
*t
= &ofproto
->tables
[table_id
];
3789 td
->table_id
= table_id
;
3790 td
->eviction
= (t
->eviction
& EVICTION_OPENFLOW
3791 ? OFPUTIL_TABLE_EVICTION_ON
3792 : OFPUTIL_TABLE_EVICTION_OFF
);
3793 td
->eviction_flags
= OFPROTO_EVICTION_FLAGS
;
3794 td
->vacancy
= (t
->vacancy_event
3795 ? OFPUTIL_TABLE_VACANCY_ON
3796 : OFPUTIL_TABLE_VACANCY_OFF
);
3797 td
->table_vacancy
.vacancy_down
= t
->vacancy_down
;
3798 td
->table_vacancy
.vacancy_up
= t
->vacancy_up
;
3799 td
->table_vacancy
.vacancy
= oftable_vacancy(t
);
3802 /* This function queries the database for dumping table-desc. */
3804 query_tables_desc(struct ofproto
*ofproto
, struct ofputil_table_desc
**descp
)
3806 struct ofputil_table_desc
*table_desc
;
3809 table_desc
= *descp
= xcalloc(ofproto
->n_tables
, sizeof *table_desc
);
3810 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3811 struct ofputil_table_desc
*td
= &table_desc
[i
];
3812 query_table_desc__(td
, ofproto
, i
);
3816 /* Function to handle dump-table-desc request. */
3818 handle_table_desc_request(struct ofconn
*ofconn
,
3819 const struct ofp_header
*request
)
3821 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3822 struct ofputil_table_desc
*table_desc
;
3823 struct ovs_list replies
;
3826 query_tables_desc(ofproto
, &table_desc
);
3827 ofpmp_init(&replies
, request
);
3828 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3829 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3830 ofputil_append_table_desc_reply(&table_desc
[i
], &replies
,
3834 ofconn_send_replies(ofconn
, &replies
);
3839 /* This function determines and sends the vacancy event, based on the value
3840 * of current vacancy and threshold vacancy. If the current vacancy is less
3841 * than or equal to vacancy_down, vacancy up events must be enabled, and when
3842 * the current vacancy is greater or equal to vacancy_up, vacancy down events
3843 * must be enabled. */
3845 send_table_status(struct ofproto
*ofproto
, uint8_t table_id
)
3847 struct oftable
*t
= &ofproto
->tables
[table_id
];
3848 if (!t
->vacancy_event
) {
3852 uint8_t vacancy
= oftable_vacancy(t
);
3853 enum ofp14_table_reason event
;
3854 if (vacancy
< t
->vacancy_down
) {
3855 event
= OFPTR_VACANCY_DOWN
;
3856 } else if (vacancy
> t
->vacancy_up
) {
3857 event
= OFPTR_VACANCY_UP
;
3862 if (event
== t
->vacancy_event
) {
3863 struct ofputil_table_desc td
;
3864 query_table_desc__(&td
, ofproto
, table_id
);
3865 connmgr_send_table_status(ofproto
->connmgr
, &td
, event
);
3867 t
->vacancy_event
= (event
== OFPTR_VACANCY_DOWN
3869 : OFPTR_VACANCY_DOWN
);
3874 append_port_stat(struct ofport
*port
, struct ovs_list
*replies
)
3876 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3878 calc_duration(port
->created
, time_msec(),
3879 &ops
.duration_sec
, &ops
.duration_nsec
);
3881 /* Intentionally ignore return value, since errors will set
3882 * 'stats' to all-1s, which is correct for OpenFlow, and
3883 * netdev_get_stats() will log errors. */
3884 ofproto_port_get_stats(port
, &ops
.stats
);
3886 ofputil_append_port_stat(replies
, &ops
);
3890 handle_port_request(struct ofconn
*ofconn
,
3891 const struct ofp_header
*request
, ofp_port_t port_no
,
3892 void (*cb
)(struct ofport
*, struct ovs_list
*replies
))
3894 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3895 struct ofport
*port
;
3896 struct ovs_list replies
;
3898 ofpmp_init(&replies
, request
);
3899 if (port_no
!= OFPP_ANY
) {
3900 port
= ofproto_get_port(ofproto
, port_no
);
3905 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3910 ofconn_send_replies(ofconn
, &replies
);
3914 handle_port_stats_request(struct ofconn
*ofconn
,
3915 const struct ofp_header
*request
)
3920 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3922 handle_port_request(ofconn
, request
, port_no
, append_port_stat
);
3928 append_port_desc(struct ofport
*port
, struct ovs_list
*replies
)
3930 ofputil_append_port_desc_stats_reply(&port
->pp
, replies
);
3934 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3935 const struct ofp_header
*request
)
3940 error
= ofputil_decode_port_desc_stats_request(request
, &port_no
);
3942 handle_port_request(ofconn
, request
, port_no
, append_port_desc
);
3948 hash_cookie(ovs_be64 cookie
)
3950 return hash_uint64((OVS_FORCE
uint64_t)cookie
);
3954 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3955 OVS_REQUIRES(ofproto_mutex
)
3957 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3958 hash_cookie(rule
->flow_cookie
));
3962 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3963 OVS_REQUIRES(ofproto_mutex
)
3965 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3969 calc_duration(long long int start
, long long int now
,
3970 uint32_t *sec
, uint32_t *nsec
)
3972 long long int msecs
= now
- start
;
3973 *sec
= msecs
/ 1000;
3974 *nsec
= (msecs
% 1000) * (1000 * 1000);
3977 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3978 * true if 'table_id' is OK, false otherwise. */
3980 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3982 return table_id
== OFPTT_ALL
|| table_id
< ofproto
->n_tables
;
3985 static struct oftable
*
3986 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3988 struct oftable
*table
;
3990 for (table
= &ofproto
->tables
[table_id
];
3991 table
< &ofproto
->tables
[ofproto
->n_tables
];
3993 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
4001 static struct oftable
*
4002 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
4004 if (table_id
== 0xff) {
4005 return next_visible_table(ofproto
, 0);
4006 } else if (table_id
< ofproto
->n_tables
) {
4007 return &ofproto
->tables
[table_id
];
4013 static struct oftable
*
4014 next_matching_table(const struct ofproto
*ofproto
,
4015 const struct oftable
*table
, uint8_t table_id
)
4017 return (table_id
== 0xff
4018 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
4022 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
4024 * - If TABLE_ID is 0xff, this iterates over every classifier table in
4025 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
4027 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
4028 * only once, for that table. (This can be used to access tables marked
4031 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
4032 * entered at all. (Perhaps you should have validated TABLE_ID with
4033 * check_table_id().)
4035 * All parameters are evaluated multiple times.
4037 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
4038 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
4040 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
4042 /* Initializes 'criteria' in a straightforward way based on the other
4045 * By default, the criteria include flows that are read-only, on the assumption
4046 * that the collected flows won't be modified. Call rule_criteria_require_rw()
4047 * if flows will be modified.
4049 * For "loose" matching, the 'priority' parameter is unimportant and may be
4052 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
4053 const struct match
*match
, int priority
,
4054 ovs_version_t version
, ovs_be64 cookie
,
4055 ovs_be64 cookie_mask
, ofp_port_t out_port
,
4058 criteria
->table_id
= table_id
;
4059 cls_rule_init(&criteria
->cr
, match
, priority
);
4060 criteria
->version
= version
;
4061 criteria
->cookie
= cookie
;
4062 criteria
->cookie_mask
= cookie_mask
;
4063 criteria
->out_port
= out_port
;
4064 criteria
->out_group
= out_group
;
4066 /* We ordinarily want to skip hidden rules, but there has to be a way for
4067 * code internal to OVS to modify and delete them, so if the criteria
4068 * specify a priority that can only be for a hidden flow, then allow hidden
4069 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
4070 * with hidden flows because OpenFlow uses only a 16-bit field to specify
4072 criteria
->include_hidden
= priority
> UINT16_MAX
;
4074 /* We assume that the criteria are being used to collect flows for reading
4075 * but not modification. Thus, we should collect read-only flows. */
4076 criteria
->include_readonly
= true;
4079 /* By default, criteria initialized by rule_criteria_init() will match flows
4080 * that are read-only, on the assumption that the collected flows won't be
4081 * modified. Call this function to match only flows that are be modifiable.
4083 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
4084 * caller has special privileges that allow it to modify even "read-only"
4087 rule_criteria_require_rw(struct rule_criteria
*criteria
,
4088 bool can_write_readonly
)
4090 criteria
->include_readonly
= can_write_readonly
;
4094 rule_criteria_destroy(struct rule_criteria
*criteria
)
4096 cls_rule_destroy(&criteria
->cr
);
4097 criteria
->version
= OVS_VERSION_NOT_REMOVED
; /* Mark as destroyed. */
4100 /* Schedules postponed removal of rules, destroys 'rules'. */
4102 remove_rules_postponed(struct rule_collection
*rules
)
4103 OVS_REQUIRES(ofproto_mutex
)
4105 if (rule_collection_n(rules
) > 0) {
4106 if (rule_collection_n(rules
) == 1) {
4107 ovsrcu_postpone(remove_rule_rcu
, rule_collection_rules(rules
)[0]);
4108 rule_collection_init(rules
);
4110 ovsrcu_postpone(remove_rules_rcu
, rule_collection_detach(rules
));
4115 /* Schedules postponed removal of groups, destroys 'groups'. */
4117 remove_groups_postponed(struct group_collection
*groups
)
4118 OVS_REQUIRES(ofproto_mutex
)
4120 if (group_collection_n(groups
) > 0) {
4121 if (group_collection_n(groups
) == 1) {
4122 ovsrcu_postpone(remove_group_rcu
,
4123 group_collection_groups(groups
)[0]);
4124 group_collection_init(groups
);
4126 ovsrcu_postpone(remove_groups_rcu
,
4127 group_collection_detach(groups
));
4132 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
4133 * function verifies most of the criteria in 'c' itself, but the caller must
4134 * check 'c->cr' itself.
4136 * Rules that have already been marked for removal are not collected.
4138 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
4139 * 'c' only includes modifiable rules). */
4141 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
4142 struct rule_collection
*rules
, size_t *n_readonly
)
4143 OVS_REQUIRES(ofproto_mutex
)
4145 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
4146 && ofproto_rule_has_out_port(rule
, c
->out_port
)
4147 && ofproto_rule_has_out_group(rule
, c
->out_group
)
4148 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)
4149 && (!rule_is_hidden(rule
) || c
->include_hidden
)
4150 && cls_rule_visible_in_version(&rule
->cr
, c
->version
)) {
4151 /* Rule matches all the criteria... */
4152 if (!rule_is_readonly(rule
) || c
->include_readonly
) {
4154 rule_collection_add(rules
, rule
);
4156 /* ...except it's read-only. */
4162 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4163 * on classifiers rules are done in the "loose" way required for OpenFlow
4164 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
4167 * Returns 0 on success, otherwise an OpenFlow error code. */
4169 collect_rules_loose(struct ofproto
*ofproto
,
4170 const struct rule_criteria
*criteria
,
4171 struct rule_collection
*rules
)
4172 OVS_REQUIRES(ofproto_mutex
)
4174 struct oftable
*table
;
4175 enum ofperr error
= 0;
4176 size_t n_readonly
= 0;
4178 rule_collection_init(rules
);
4180 if (!check_table_id(ofproto
, criteria
->table_id
)) {
4181 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4185 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
4188 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
4189 hash_cookie(criteria
->cookie
),
4190 &ofproto
->cookies
) {
4191 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
4192 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4196 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
4199 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &criteria
->cr
,
4200 criteria
->version
) {
4201 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4207 if (!error
&& !rule_collection_n(rules
) && n_readonly
) {
4208 /* We didn't find any rules to modify. We did find some read-only
4209 * rules that we're not allowed to modify, so report that. */
4210 error
= OFPERR_OFPBRC_EPERM
;
4213 rule_collection_destroy(rules
);
4218 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4219 * on classifiers rules are done in the "strict" way required for OpenFlow
4220 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
4221 * rules on list 'rules'.
4223 * Returns 0 on success, otherwise an OpenFlow error code. */
4225 collect_rules_strict(struct ofproto
*ofproto
,
4226 const struct rule_criteria
*criteria
,
4227 struct rule_collection
*rules
)
4228 OVS_REQUIRES(ofproto_mutex
)
4230 struct oftable
*table
;
4231 size_t n_readonly
= 0;
4232 enum ofperr error
= 0;
4234 rule_collection_init(rules
);
4236 if (!check_table_id(ofproto
, criteria
->table_id
)) {
4237 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4241 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
4244 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
4245 hash_cookie(criteria
->cookie
),
4246 &ofproto
->cookies
) {
4247 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
4248 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4252 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
4255 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
4256 &table
->cls
, &criteria
->cr
,
4257 criteria
->version
));
4259 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4265 if (!error
&& !rule_collection_n(rules
) && n_readonly
) {
4266 /* We didn't find any rules to modify. We did find some read-only
4267 * rules that we're not allowed to modify, so report that. */
4268 error
= OFPERR_OFPBRC_EPERM
;
4271 rule_collection_destroy(rules
);
4276 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4277 * forced into the range of a uint16_t. */
4279 age_secs(long long int age_ms
)
4281 return (age_ms
< 0 ? 0
4282 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
4283 : (unsigned int) age_ms
/ 1000);
4287 handle_flow_stats_request(struct ofconn
*ofconn
,
4288 const struct ofp_header
*request
)
4289 OVS_EXCLUDED(ofproto_mutex
)
4291 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4292 struct ofputil_flow_stats_request fsr
;
4293 struct rule_criteria criteria
;
4294 struct rule_collection rules
;
4295 struct ovs_list replies
;
4298 error
= ofputil_decode_flow_stats_request(&fsr
, request
,
4299 ofproto_get_tun_tab(ofproto
),
4300 &ofproto
->vl_mff_map
);
4305 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, OVS_VERSION_MAX
,
4306 fsr
.cookie
, fsr
.cookie_mask
, fsr
.out_port
,
4309 ovs_mutex_lock(&ofproto_mutex
);
4310 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4311 rule_criteria_destroy(&criteria
);
4313 rule_collection_ref(&rules
);
4315 ovs_mutex_unlock(&ofproto_mutex
);
4321 ofpmp_init(&replies
, request
);
4323 RULE_COLLECTION_FOR_EACH (rule
, &rules
) {
4324 long long int now
= time_msec();
4325 struct ofputil_flow_stats fs
;
4326 long long int created
, used
, modified
;
4327 const struct rule_actions
*actions
;
4328 enum ofputil_flow_mod_flags flags
;
4330 ovs_mutex_lock(&rule
->mutex
);
4331 fs
.cookie
= rule
->flow_cookie
;
4332 fs
.idle_timeout
= rule
->idle_timeout
;
4333 fs
.hard_timeout
= rule
->hard_timeout
;
4334 fs
.importance
= rule
->importance
;
4335 created
= rule
->created
;
4336 modified
= rule
->modified
;
4337 actions
= rule_get_actions(rule
);
4338 flags
= rule
->flags
;
4339 ovs_mutex_unlock(&rule
->mutex
);
4341 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
4342 &fs
.byte_count
, &used
);
4344 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
4345 fs
.table_id
= rule
->table_id
;
4346 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
4347 fs
.priority
= rule
->cr
.priority
;
4348 fs
.idle_age
= age_secs(now
- used
);
4349 fs
.hard_age
= age_secs(now
- modified
);
4350 fs
.ofpacts
= actions
->ofpacts
;
4351 fs
.ofpacts_len
= actions
->ofpacts_len
;
4354 ofputil_append_flow_stats_reply(&fs
, &replies
,
4355 ofproto_get_tun_tab(ofproto
));
4358 rule_collection_unref(&rules
);
4359 rule_collection_destroy(&rules
);
4361 ofconn_send_replies(ofconn
, &replies
);
4367 flow_stats_ds(struct ofproto
*ofproto
, struct rule
*rule
, struct ds
*results
)
4369 uint64_t packet_count
, byte_count
;
4370 const struct rule_actions
*actions
;
4371 long long int created
, used
;
4373 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
4374 &byte_count
, &used
);
4376 ovs_mutex_lock(&rule
->mutex
);
4377 actions
= rule_get_actions(rule
);
4378 created
= rule
->created
;
4379 ovs_mutex_unlock(&rule
->mutex
);
4381 if (rule
->table_id
!= 0) {
4382 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
4384 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
4385 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
4386 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
4387 cls_rule_format(&rule
->cr
, ofproto_get_tun_tab(ofproto
), NULL
, results
);
4388 ds_put_char(results
, ',');
4390 ds_put_cstr(results
, "actions=");
4391 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, NULL
, results
);
4393 ds_put_cstr(results
, "\n");
4396 /* Adds a pretty-printed description of all flows to 'results', including
4397 * hidden flows (e.g., set up by in-band control). */
4399 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
4401 struct oftable
*table
;
4403 OFPROTO_FOR_EACH_TABLE (table
, p
) {
4406 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
4407 flow_stats_ds(p
, rule
, results
);
4412 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4413 * '*engine_type' and '*engine_id', respectively. */
4415 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
4416 uint8_t *engine_type
, uint8_t *engine_id
)
4418 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
4421 /* Checks the status change of CFM on 'ofport'.
4423 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4425 ofproto_port_cfm_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
4427 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
4428 return (ofport
&& ofproto
->ofproto_class
->cfm_status_changed
4429 ? ofproto
->ofproto_class
->cfm_status_changed(ofport
)
4433 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4434 * Returns 0 if the port's CFM status was successfully stored into
4435 * '*status'. Returns positive errno if the port did not have CFM
4438 * The caller must provide and own '*status', and must free 'status->rmps'.
4439 * '*status' is indeterminate if the return value is non-zero. */
4441 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
4442 struct cfm_status
*status
)
4444 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
4445 return (ofport
&& ofproto
->ofproto_class
->get_cfm_status
4446 ? ofproto
->ofproto_class
->get_cfm_status(ofport
, status
)
4451 handle_aggregate_stats_request(struct ofconn
*ofconn
,
4452 const struct ofp_header
*oh
)
4453 OVS_EXCLUDED(ofproto_mutex
)
4455 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4456 struct ofputil_flow_stats_request request
;
4457 struct ofputil_aggregate_stats stats
;
4458 bool unknown_packets
, unknown_bytes
;
4459 struct rule_criteria criteria
;
4460 struct rule_collection rules
;
4461 struct ofpbuf
*reply
;
4464 error
= ofputil_decode_flow_stats_request(&request
, oh
,
4465 ofproto_get_tun_tab(ofproto
),
4466 &ofproto
->vl_mff_map
);
4471 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
4472 OVS_VERSION_MAX
, request
.cookie
, request
.cookie_mask
,
4473 request
.out_port
, request
.out_group
);
4475 ovs_mutex_lock(&ofproto_mutex
);
4476 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4477 rule_criteria_destroy(&criteria
);
4479 rule_collection_ref(&rules
);
4481 ovs_mutex_unlock(&ofproto_mutex
);
4487 memset(&stats
, 0, sizeof stats
);
4488 unknown_packets
= unknown_bytes
= false;
4491 RULE_COLLECTION_FOR_EACH (rule
, &rules
) {
4492 uint64_t packet_count
;
4493 uint64_t byte_count
;
4496 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
4497 &byte_count
, &used
);
4499 if (packet_count
== UINT64_MAX
) {
4500 unknown_packets
= true;
4502 stats
.packet_count
+= packet_count
;
4505 if (byte_count
== UINT64_MAX
) {
4506 unknown_bytes
= true;
4508 stats
.byte_count
+= byte_count
;
4513 if (unknown_packets
) {
4514 stats
.packet_count
= UINT64_MAX
;
4516 if (unknown_bytes
) {
4517 stats
.byte_count
= UINT64_MAX
;
4520 rule_collection_unref(&rules
);
4521 rule_collection_destroy(&rules
);
4523 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
4524 ofconn_send_reply(ofconn
, reply
);
4529 struct queue_stats_cbdata
{
4530 struct ofport
*ofport
;
4531 struct ovs_list replies
;
4536 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
4537 const struct netdev_queue_stats
*stats
)
4539 struct ofputil_queue_stats oqs
;
4541 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
4542 oqs
.queue_id
= queue_id
;
4543 oqs
.tx_bytes
= stats
->tx_bytes
;
4544 oqs
.tx_packets
= stats
->tx_packets
;
4545 oqs
.tx_errors
= stats
->tx_errors
;
4546 if (stats
->created
!= LLONG_MIN
) {
4547 calc_duration(stats
->created
, cbdata
->now
,
4548 &oqs
.duration_sec
, &oqs
.duration_nsec
);
4550 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
4552 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
4556 handle_queue_stats_dump_cb(uint32_t queue_id
,
4557 struct netdev_queue_stats
*stats
,
4560 struct queue_stats_cbdata
*cbdata
= cbdata_
;
4562 put_queue_stats(cbdata
, queue_id
, stats
);
4566 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
4567 struct queue_stats_cbdata
*cbdata
)
4569 cbdata
->ofport
= port
;
4570 if (queue_id
== OFPQ_ALL
) {
4571 netdev_dump_queue_stats(port
->netdev
,
4572 handle_queue_stats_dump_cb
, cbdata
);
4574 struct netdev_queue_stats stats
;
4576 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
4577 put_queue_stats(cbdata
, queue_id
, &stats
);
4579 return OFPERR_OFPQOFC_BAD_QUEUE
;
4586 handle_queue_stats_request(struct ofconn
*ofconn
,
4587 const struct ofp_header
*rq
)
4589 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4590 struct queue_stats_cbdata cbdata
;
4591 struct ofport
*port
;
4593 struct ofputil_queue_stats_request oqsr
;
4595 COVERAGE_INC(ofproto_queue_req
);
4597 ofpmp_init(&cbdata
.replies
, rq
);
4598 cbdata
.now
= time_msec();
4600 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
4605 if (oqsr
.port_no
== OFPP_ANY
) {
4606 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
4607 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
4608 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
4613 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
4615 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
4616 : OFPERR_OFPQOFC_BAD_PORT
);
4619 ofconn_send_replies(ofconn
, &cbdata
.replies
);
4621 ofpbuf_list_delete(&cbdata
.replies
);
4628 evict_rules_from_table(struct oftable
*table
)
4629 OVS_REQUIRES(ofproto_mutex
)
4631 enum ofperr error
= 0;
4632 struct rule_collection rules
;
4633 unsigned int count
= table
->n_flows
;
4634 unsigned int max_flows
= table
->max_flows
;
4636 rule_collection_init(&rules
);
4638 while (count
-- > max_flows
) {
4641 if (!choose_rule_to_evict(table
, &rule
)) {
4642 error
= OFPERR_OFPFMFC_TABLE_FULL
;
4645 eviction_group_remove_rule(rule
);
4646 rule_collection_add(&rules
, rule
);
4649 delete_flows__(&rules
, OFPRR_EVICTION
, NULL
);
4655 get_conjunctions(const struct ofputil_flow_mod
*fm
,
4656 struct cls_conjunction
**conjsp
, size_t *n_conjsp
)
4658 struct cls_conjunction
*conjs
= NULL
;
4661 const struct ofpact
*ofpact
;
4662 OFPACT_FOR_EACH (ofpact
, fm
->ofpacts
, fm
->ofpacts_len
) {
4663 if (ofpact
->type
== OFPACT_CONJUNCTION
) {
4665 } else if (ofpact
->type
!= OFPACT_NOTE
) {
4666 /* "conjunction" may appear with "note" actions but not with any
4667 * other type of actions. */
4668 ovs_assert(!n_conjs
);
4675 conjs
= xzalloc(n_conjs
* sizeof *conjs
);
4676 OFPACT_FOR_EACH (ofpact
, fm
->ofpacts
, fm
->ofpacts_len
) {
4677 if (ofpact
->type
== OFPACT_CONJUNCTION
) {
4678 struct ofpact_conjunction
*oc
= ofpact_get_CONJUNCTION(ofpact
);
4679 conjs
[i
].clause
= oc
->clause
;
4680 conjs
[i
].n_clauses
= oc
->n_clauses
;
4681 conjs
[i
].id
= oc
->id
;
4688 *n_conjsp
= n_conjs
;
4691 /* add_flow_init(), add_flow_start(), add_flow_revert(), and add_flow_finish()
4692 * implement OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4693 * in which no matching flow already exists in the flow table.
4695 * add_flow_init() creates a new flow according to 'fm' and stores it to 'ofm'
4696 * for later reference. If the flow replaces other flow, it will be updated to
4697 * match modify semantics later by add_flow_start() (by calling
4698 * replace_rule_start()).
4700 * Returns 0 on success, or an OpenFlow error code on failure.
4702 * On successful return the caller must complete the operation by calling
4703 * add_flow_start(), and if that succeeds, then either add_flow_finish(), or
4704 * add_flow_revert() if the operation needs to be reverted due to a later
4708 add_flow_init(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
4709 const struct ofputil_flow_mod
*fm
)
4710 OVS_EXCLUDED(ofproto_mutex
)
4712 struct oftable
*table
;
4717 if (!check_table_id(ofproto
, fm
->table_id
)) {
4718 return OFPERR_OFPBRC_BAD_TABLE_ID
;
4722 if (fm
->table_id
== 0xff) {
4723 if (ofproto
->ofproto_class
->rule_choose_table
) {
4724 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
4730 ovs_assert(table_id
< ofproto
->n_tables
);
4734 } else if (fm
->table_id
< ofproto
->n_tables
) {
4735 table_id
= fm
->table_id
;
4737 return OFPERR_OFPBRC_BAD_TABLE_ID
;
4740 table
= &ofproto
->tables
[table_id
];
4741 if (table
->flags
& OFTABLE_READONLY
4742 && !(fm
->flags
& OFPUTIL_FF_NO_READONLY
)) {
4743 return OFPERR_OFPBRC_EPERM
;
4746 if (!(fm
->flags
& OFPUTIL_FF_HIDDEN_FIELDS
)
4747 && !match_has_default_hidden_fields(&fm
->match
)) {
4748 VLOG_WARN_RL(&rl
, "%s: (add_flow) only internal flows can set "
4749 "non-default values to hidden fields", ofproto
->name
);
4750 return OFPERR_OFPBRC_EPERM
;
4753 if (!ofm
->temp_rule
) {
4754 cls_rule_init(&cr
, &fm
->match
, fm
->priority
);
4756 /* Allocate new rule. Destroys 'cr'. */
4757 error
= ofproto_rule_create(ofproto
, &cr
, table
- ofproto
->tables
,
4758 fm
->new_cookie
, fm
->idle_timeout
,
4759 fm
->hard_timeout
, fm
->flags
,
4760 fm
->importance
, fm
->ofpacts
,
4762 fm
->match
.flow
.tunnel
.metadata
.present
.map
,
4763 fm
->ofpacts_tlv_bitmap
, &ofm
->temp_rule
);
4768 get_conjunctions(fm
, &ofm
->conjs
, &ofm
->n_conjs
);
4773 /* ofm->temp_rule is consumed only in the successful case. */
4775 add_flow_start(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
4776 OVS_REQUIRES(ofproto_mutex
)
4778 struct rule
*old_rule
= NULL
;
4779 struct rule
*new_rule
= ofm
->temp_rule
;
4780 const struct rule_actions
*actions
= rule_get_actions(new_rule
);
4781 struct oftable
*table
= &ofproto
->tables
[new_rule
->table_id
];
4784 /* Must check actions while holding ofproto_mutex to avoid a race. */
4785 error
= ofproto_check_ofpacts(ofproto
, actions
->ofpacts
,
4786 actions
->ofpacts_len
);
4791 /* Check for the existence of an identical rule.
4792 * This will not return rules earlier marked for removal. */
4793 old_rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
,
4797 /* Check for overlap, if requested. */
4798 if (new_rule
->flags
& OFPUTIL_FF_CHECK_OVERLAP
4799 && classifier_rule_overlaps(&table
->cls
, &new_rule
->cr
,
4801 return OFPERR_OFPFMFC_OVERLAP
;
4804 /* If necessary, evict an existing rule to clear out space. */
4805 if (table
->n_flows
>= table
->max_flows
) {
4806 if (!choose_rule_to_evict(table
, &old_rule
)) {
4807 return OFPERR_OFPFMFC_TABLE_FULL
;
4809 eviction_group_remove_rule(old_rule
);
4810 /* Marks 'old_rule' as an evicted rule rather than replaced rule.
4812 old_rule
->removed_reason
= OFPRR_EVICTION
;
4815 ofm
->modify_cookie
= true;
4819 rule_collection_add(&ofm
->old_rules
, old_rule
);
4821 /* Take ownership of the temp_rule. */
4822 rule_collection_add(&ofm
->new_rules
, new_rule
);
4823 ofm
->temp_rule
= NULL
;
4825 replace_rule_start(ofproto
, ofm
, old_rule
, new_rule
);
4829 /* Revert the effects of add_flow_start(). */
4831 add_flow_revert(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
4832 OVS_REQUIRES(ofproto_mutex
)
4834 struct rule
*old_rule
= rule_collection_n(&ofm
->old_rules
)
4835 ? rule_collection_rules(&ofm
->old_rules
)[0] : NULL
;
4836 struct rule
*new_rule
= rule_collection_rules(&ofm
->new_rules
)[0];
4838 replace_rule_revert(ofproto
, old_rule
, new_rule
);
4841 /* To be called after version bump. */
4843 add_flow_finish(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
4844 const struct openflow_mod_requester
*req
)
4845 OVS_REQUIRES(ofproto_mutex
)
4847 struct rule
*old_rule
= rule_collection_n(&ofm
->old_rules
)
4848 ? rule_collection_rules(&ofm
->old_rules
)[0] : NULL
;
4849 struct rule
*new_rule
= rule_collection_rules(&ofm
->new_rules
)[0];
4850 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
4852 replace_rule_finish(ofproto
, ofm
, req
, old_rule
, new_rule
, &dead_cookies
);
4853 learned_cookies_flush(ofproto
, &dead_cookies
);
4856 ovsrcu_postpone(remove_rule_rcu
, old_rule
);
4858 ofmonitor_report(ofproto
->connmgr
, new_rule
, NXFME_ADDED
, 0,
4859 req
? req
->ofconn
: NULL
,
4860 req
? req
->request
->xid
: 0, NULL
);
4862 /* Send Vacancy Events for OF1.4+. */
4863 send_table_status(ofproto
, new_rule
->table_id
);
4867 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4869 /* Create a new rule. Note that the rule is NOT inserted into a any data
4870 * structures yet. Takes ownership of 'cr'. Only assigns '*new_rule' if
4873 ofproto_rule_create(struct ofproto
*ofproto
, struct cls_rule
*cr
,
4874 uint8_t table_id
, ovs_be64 new_cookie
,
4875 uint16_t idle_timeout
, uint16_t hard_timeout
,
4876 enum ofputil_flow_mod_flags flags
, uint16_t importance
,
4877 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
4878 uint64_t match_tlv_bitmap
, uint64_t ofpacts_tlv_bitmap
,
4879 struct rule
**new_rule
)
4880 OVS_NO_THREAD_SAFETY_ANALYSIS
4885 /* Allocate new rule. */
4886 rule
= ofproto
->ofproto_class
->rule_alloc();
4888 cls_rule_destroy(cr
);
4889 VLOG_WARN_RL(&rl
, "%s: failed to allocate a rule.", ofproto
->name
);
4890 return OFPERR_OFPFMFC_UNKNOWN
;
4893 /* Initialize base state. */
4894 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4895 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), cr
);
4896 ovs_refcount_init(&rule
->ref_count
);
4898 ovs_mutex_init(&rule
->mutex
);
4899 ovs_mutex_lock(&rule
->mutex
);
4900 *CONST_CAST(ovs_be64
*, &rule
->flow_cookie
) = new_cookie
;
4901 rule
->created
= rule
->modified
= time_msec();
4902 rule
->idle_timeout
= idle_timeout
;
4903 rule
->hard_timeout
= hard_timeout
;
4904 *CONST_CAST(uint16_t *, &rule
->importance
) = importance
;
4905 rule
->removed_reason
= OVS_OFPRR_NONE
;
4907 *CONST_CAST(uint8_t *, &rule
->table_id
) = table_id
;
4908 rule
->flags
= flags
& OFPUTIL_FF_STATE
;
4910 *CONST_CAST(const struct rule_actions
**, &rule
->actions
)
4911 = rule_actions_create(ofpacts
, ofpacts_len
);
4913 ovs_list_init(&rule
->meter_list_node
);
4914 rule
->eviction_group
= NULL
;
4915 rule
->monitor_flags
= 0;
4916 rule
->add_seqno
= 0;
4917 rule
->modify_seqno
= 0;
4918 ovs_list_init(&rule
->expirable
);
4919 ovs_mutex_unlock(&rule
->mutex
);
4921 /* Construct rule, initializing derived state. */
4922 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4924 ofproto_rule_destroy__(rule
);
4928 rule
->state
= RULE_INITIALIZED
;
4929 rule
->match_tlv_bitmap
= match_tlv_bitmap
;
4930 rule
->ofpacts_tlv_bitmap
= ofpacts_tlv_bitmap
;
4931 mf_vl_mff_ref(&rule
->ofproto
->vl_mff_map
, match_tlv_bitmap
);
4932 mf_vl_mff_ref(&rule
->ofproto
->vl_mff_map
, ofpacts_tlv_bitmap
);
4938 /* Initialize 'ofm' for a learn action. If the rule already existed, reference
4939 * to that rule is taken, otherwise a new rule is created. 'ofm' keeps the
4940 * rule reference in both. This does not take the global 'ofproto_mutex'. */
4942 ofproto_flow_mod_init_for_learn(struct ofproto
*ofproto
,
4943 const struct ofputil_flow_mod
*fm
,
4944 struct ofproto_flow_mod
*ofm
)
4945 OVS_EXCLUDED(ofproto_mutex
)
4949 /* Reject flow mods that do not look like they were generated by a learn
4951 if (fm
->command
!= OFPFC_MODIFY_STRICT
|| fm
->table_id
== OFPTT_ALL
4952 || fm
->flags
& OFPUTIL_FF_RESET_COUNTS
4953 || fm
->buffer_id
!= UINT32_MAX
) {
4954 return OFPERR_OFPFMFC_UNKNOWN
;
4957 /* Check if the rule already exists, and we can get a reference to it. */
4958 struct oftable
*table
= &ofproto
->tables
[fm
->table_id
];
4961 rule
= rule_from_cls_rule(classifier_find_match_exactly(
4962 &table
->cls
, &fm
->match
, fm
->priority
,
4965 /* Check if the rule's attributes match as well. */
4966 const struct rule_actions
*actions
;
4968 ovs_mutex_lock(&rule
->mutex
);
4969 actions
= rule_get_actions(rule
);
4970 if (rule
->idle_timeout
== fm
->idle_timeout
4971 && rule
->hard_timeout
== fm
->hard_timeout
4972 && rule
->importance
== fm
->importance
4973 && rule
->flags
== (fm
->flags
& OFPUTIL_FF_STATE
)
4974 && (!fm
->modify_cookie
|| (fm
->new_cookie
== rule
->flow_cookie
))
4975 && ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
4976 actions
->ofpacts
, actions
->ofpacts_len
)) {
4977 /* Rule already exists and need not change, except for the modified
4978 * timestamp. Get a reference to the existing rule. */
4979 ovs_mutex_unlock(&rule
->mutex
);
4980 if (!ofproto_rule_try_ref(rule
)) {
4981 rule
= NULL
; /* Pretend it did not exist. */
4984 ovs_mutex_unlock(&rule
->mutex
);
4989 /* Initialize ofproto_flow_mod for future use. */
4990 error
= ofproto_flow_mod_init(ofproto
, ofm
, fm
, rule
);
4992 ofproto_rule_unref(rule
);
4999 ofproto_flow_mod_learn_refresh(struct ofproto_flow_mod
*ofm
)
5001 enum ofperr error
= 0;
5003 /* ofm->temp_rule is our reference to the learned rule. We have a
5004 * reference to an existing rule, if it already was in the classifier,
5005 * otherwise we may have a fresh rule that we need to insert. */
5006 struct rule
*rule
= ofm
->temp_rule
;
5008 return OFPERR_OFPFMFC_UNKNOWN
;
5011 /* Create a new rule if the current one has been removed from the
5012 * classifier. We need to do this since RCU does not allow a current rule
5013 * to be reinserted before all threads have quiesced.
5015 * It is possible that the rule is removed asynchronously, e.g., right
5016 * after we have read the 'rule->state' below. In this case the next time
5017 * this function is executed the rule will be reinstated. */
5018 if (rule
->state
== RULE_REMOVED
) {
5021 cls_rule_clone(&cr
, &rule
->cr
);
5022 ovs_mutex_lock(&rule
->mutex
);
5023 error
= ofproto_rule_create(rule
->ofproto
, &cr
, rule
->table_id
,
5026 rule
->hard_timeout
, rule
->flags
,
5028 rule
->actions
->ofpacts
,
5029 rule
->actions
->ofpacts_len
,
5030 rule
->match_tlv_bitmap
,
5031 rule
->ofpacts_tlv_bitmap
,
5033 ovs_mutex_unlock(&rule
->mutex
);
5035 ofproto_rule_unref(rule
); /* Release old reference. */
5038 /* Refresh the existing rule. */
5039 ovs_mutex_lock(&rule
->mutex
);
5040 rule
->modified
= time_msec();
5041 ovs_mutex_unlock(&rule
->mutex
);
5047 ofproto_flow_mod_learn_start(struct ofproto_flow_mod
*ofm
)
5048 OVS_REQUIRES(ofproto_mutex
)
5050 struct rule
*rule
= ofm
->temp_rule
;
5052 /* ofproto_flow_mod_start() consumes the reference, so we
5053 * take a new one. */
5054 ofproto_rule_ref(rule
);
5055 enum ofperr error
= ofproto_flow_mod_start(rule
->ofproto
, ofm
);
5056 ofm
->temp_rule
= rule
;
5062 ofproto_flow_mod_learn_revert(struct ofproto_flow_mod
*ofm
)
5063 OVS_REQUIRES(ofproto_mutex
)
5065 struct rule
*rule
= rule_collection_rules(&ofm
->new_rules
)[0];
5066 ofproto_flow_mod_revert(rule
->ofproto
, ofm
);
5070 ofproto_flow_mod_learn_finish(struct ofproto_flow_mod
*ofm
,
5071 struct ofproto
*orig_ofproto
)
5072 OVS_REQUIRES(ofproto_mutex
)
5074 struct rule
*rule
= rule_collection_rules(&ofm
->new_rules
)[0];
5076 /* If learning on a different bridge, must bump its version
5077 * number and flush connmgr afterwards. */
5078 if (rule
->ofproto
!= orig_ofproto
) {
5079 ofproto_bump_tables_version(rule
->ofproto
);
5081 ofproto_flow_mod_finish(rule
->ofproto
, ofm
, NULL
);
5082 if (rule
->ofproto
!= orig_ofproto
) {
5083 ofmonitor_flush(rule
->ofproto
->connmgr
);
5087 /* Refresh 'ofm->temp_rule', for which the caller holds a reference, if already
5088 * in the classifier, insert it otherwise. If the rule has already been
5089 * removed from the classifier, a new rule is created using 'ofm->temp_rule' as
5090 * a template and the reference to the old 'ofm->temp_rule' is freed. If
5091 * 'keep_ref' is true, then a reference to the current rule is held, otherwise
5092 * it is released and 'ofm->temp_rule' is set to NULL.
5094 * If 'limit' != 0, insertion will fail if there are more than 'limit' rules
5095 * in the same table with the same cookie. If insertion succeeds,
5096 * '*below_limitp' will be set to true. If insertion fails '*below_limitp'
5097 * will be set to false.
5099 * Caller needs to be the exclusive owner of 'ofm' as it is being manipulated
5100 * during the call. */
5102 ofproto_flow_mod_learn(struct ofproto_flow_mod
*ofm
, bool keep_ref
,
5103 unsigned limit
, bool *below_limitp
)
5104 OVS_EXCLUDED(ofproto_mutex
)
5106 enum ofperr error
= ofproto_flow_mod_learn_refresh(ofm
);
5107 struct rule
*rule
= ofm
->temp_rule
;
5108 bool below_limit
= true;
5110 /* Do we need to insert the rule? */
5111 if (!error
&& rule
->state
== RULE_INITIALIZED
) {
5112 ovs_mutex_lock(&ofproto_mutex
);
5115 struct rule_criteria criteria
;
5116 struct rule_collection rules
;
5119 match_init_catchall(&match
);
5120 rule_criteria_init(&criteria
, rule
->table_id
, &match
, 0,
5121 OVS_VERSION_MAX
, rule
->flow_cookie
,
5122 OVS_BE64_MAX
, OFPP_ANY
, OFPG_ANY
);
5123 rule_criteria_require_rw(&criteria
, false);
5124 collect_rules_loose(rule
->ofproto
, &criteria
, &rules
);
5125 if (rule_collection_n(&rules
) >= limit
) {
5126 below_limit
= false;
5128 rule_collection_destroy(&rules
);
5129 rule_criteria_destroy(&criteria
);
5133 ofm
->version
= rule
->ofproto
->tables_version
+ 1;
5135 error
= ofproto_flow_mod_learn_start(ofm
);
5137 ofproto_flow_mod_learn_finish(ofm
, NULL
);
5140 ofproto_flow_mod_uninit(ofm
);
5142 ovs_mutex_unlock(&ofproto_mutex
);
5145 static struct vlog_rate_limit learn_rl
= VLOG_RATE_LIMIT_INIT(1, 5);
5146 VLOG_INFO_RL(&learn_rl
, "Learn limit for flow %"PRIu64
" reached.",
5151 if (!keep_ref
&& below_limit
) {
5152 ofproto_rule_unref(rule
);
5153 ofm
->temp_rule
= NULL
;
5156 *below_limitp
= below_limit
;
5162 replace_rule_start(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
5163 struct rule
*old_rule
, struct rule
*new_rule
)
5165 struct oftable
*table
= &ofproto
->tables
[new_rule
->table_id
];
5167 /* 'old_rule' may be either an evicted rule or replaced rule. */
5169 /* Copy values from old rule for modify semantics. */
5170 if (old_rule
->removed_reason
!= OFPRR_EVICTION
) {
5171 bool change_cookie
= (ofm
->modify_cookie
5172 && new_rule
->flow_cookie
!= OVS_BE64_MAX
5173 && new_rule
->flow_cookie
!= old_rule
->flow_cookie
);
5175 ovs_mutex_lock(&new_rule
->mutex
);
5176 ovs_mutex_lock(&old_rule
->mutex
);
5177 if (ofm
->command
!= OFPFC_ADD
) {
5178 new_rule
->idle_timeout
= old_rule
->idle_timeout
;
5179 new_rule
->hard_timeout
= old_rule
->hard_timeout
;
5180 *CONST_CAST(uint16_t *, &new_rule
->importance
) = old_rule
->importance
;
5181 new_rule
->flags
= old_rule
->flags
;
5182 new_rule
->created
= old_rule
->created
;
5184 if (!change_cookie
) {
5185 *CONST_CAST(ovs_be64
*, &new_rule
->flow_cookie
)
5186 = old_rule
->flow_cookie
;
5188 ovs_mutex_unlock(&old_rule
->mutex
);
5189 ovs_mutex_unlock(&new_rule
->mutex
);
5192 /* Mark the old rule for removal in the next version. */
5193 cls_rule_make_invisible_in_version(&old_rule
->cr
, ofm
->version
);
5195 /* Remove the old rule from data structures. */
5196 ofproto_rule_remove__(ofproto
, old_rule
);
5200 /* Insert flow to ofproto data structures, so that later flow_mods may
5201 * relate to it. This is reversible, in case later errors require this to
5203 ofproto_rule_insert__(ofproto
, new_rule
);
5204 /* Make the new rule visible for classifier lookups only from the next
5206 classifier_insert(&table
->cls
, &new_rule
->cr
, ofm
->version
, ofm
->conjs
,
5211 replace_rule_revert(struct ofproto
*ofproto
,
5212 struct rule
*old_rule
, struct rule
*new_rule
)
5214 struct oftable
*table
= &ofproto
->tables
[new_rule
->table_id
];
5217 if (old_rule
->removed_reason
== OFPRR_EVICTION
) {
5218 /* Revert the eviction. */
5219 eviction_group_add_rule(old_rule
);
5222 /* Restore the old rule to data structures. */
5223 ofproto_rule_insert__(ofproto
, old_rule
);
5225 /* Restore the original visibility of the old rule. */
5226 cls_rule_restore_visibility(&old_rule
->cr
);
5228 /* Restore table's rule count. */
5232 /* Remove the new rule immediately. It was never visible to lookups. */
5233 if (!classifier_remove(&table
->cls
, &new_rule
->cr
)) {
5236 ofproto_rule_remove__(ofproto
, new_rule
);
5237 ofproto_rule_unref(new_rule
);
5240 /* Adds the 'new_rule', replacing the 'old_rule'. */
5242 replace_rule_finish(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
5243 const struct openflow_mod_requester
*req
,
5244 struct rule
*old_rule
, struct rule
*new_rule
,
5245 struct ovs_list
*dead_cookies
)
5246 OVS_REQUIRES(ofproto_mutex
)
5248 struct rule
*replaced_rule
;
5250 replaced_rule
= (old_rule
&& old_rule
->removed_reason
!= OFPRR_EVICTION
)
5253 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
5254 * is a duplicate rule the 'new_rule' is replacing. The provider should
5255 * link the packet and byte counts from the old rule to the new one if
5256 * 'modify_keep_counts' is 'true'. The 'replaced_rule' will be deleted
5257 * right after this call. */
5258 ofproto
->ofproto_class
->rule_insert(new_rule
, replaced_rule
,
5259 ofm
->modify_keep_counts
);
5260 learned_cookies_inc(ofproto
, rule_get_actions(new_rule
));
5263 const struct rule_actions
*old_actions
= rule_get_actions(old_rule
);
5264 const struct rule_actions
*new_actions
= rule_get_actions(new_rule
);
5266 learned_cookies_dec(ofproto
, old_actions
, dead_cookies
);
5268 if (replaced_rule
) {
5269 enum nx_flow_update_event event
= ofm
->command
== OFPFC_ADD
5270 ? NXFME_ADDED
: NXFME_MODIFIED
;
5272 bool changed_cookie
= (new_rule
->flow_cookie
5273 != old_rule
->flow_cookie
);
5275 bool changed_actions
= !ofpacts_equal(new_actions
->ofpacts
,
5276 new_actions
->ofpacts_len
,
5277 old_actions
->ofpacts
,
5278 old_actions
->ofpacts_len
);
5280 if (event
!= NXFME_MODIFIED
|| changed_actions
5281 || changed_cookie
) {
5282 ofmonitor_report(ofproto
->connmgr
, new_rule
, event
, 0,
5283 req
? req
->ofconn
: NULL
,
5284 req
? req
->request
->xid
: 0,
5285 changed_actions
? old_actions
: NULL
);
5288 /* XXX: This is slight duplication with delete_flows_finish__() */
5289 ofmonitor_report(ofproto
->connmgr
, old_rule
, NXFME_DELETED
,
5291 req
? req
->ofconn
: NULL
,
5292 req
? req
->request
->xid
: 0, NULL
);
5297 /* ofm->temp_rule is consumed only in the successful case. */
5299 modify_flows_start__(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5300 OVS_REQUIRES(ofproto_mutex
)
5302 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5303 struct rule_collection
*new_rules
= &ofm
->new_rules
;
5306 if (rule_collection_n(old_rules
) > 0) {
5307 /* Create a new 'modified' rule for each old rule. */
5308 struct rule
*old_rule
, *new_rule
;
5309 const struct rule_actions
*actions
= rule_get_actions(ofm
->temp_rule
);
5311 /* Must check actions while holding ofproto_mutex to avoid a race. */
5312 error
= ofproto_check_ofpacts(ofproto
, actions
->ofpacts
,
5313 actions
->ofpacts_len
);
5318 /* Use the temp rule as the first new rule, and as the template for
5320 struct rule
*temp
= ofm
->temp_rule
;
5321 ofm
->temp_rule
= NULL
; /* We consume the template. */
5324 RULE_COLLECTION_FOR_EACH (old_rule
, old_rules
) {
5326 /* The template rule's match is possibly a loose one, so it
5327 * must be replaced with the old rule's match so that the new
5328 * rule actually replaces the old one. */
5329 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &temp
->cr
));
5330 cls_rule_clone(CONST_CAST(struct cls_rule
*, &temp
->cr
),
5332 if (temp
->match_tlv_bitmap
!= old_rule
->match_tlv_bitmap
) {
5333 mf_vl_mff_unref(&temp
->ofproto
->vl_mff_map
,
5334 temp
->match_tlv_bitmap
);
5335 temp
->match_tlv_bitmap
= old_rule
->match_tlv_bitmap
;
5336 mf_vl_mff_ref(&temp
->ofproto
->vl_mff_map
,
5337 temp
->match_tlv_bitmap
);
5339 *CONST_CAST(uint8_t *, &temp
->table_id
) = old_rule
->table_id
;
5340 rule_collection_add(new_rules
, temp
);
5344 cls_rule_clone(&cr
, &old_rule
->cr
);
5345 error
= ofproto_rule_create(ofproto
, &cr
, old_rule
->table_id
,
5348 temp
->hard_timeout
, temp
->flags
,
5350 temp
->actions
->ofpacts
,
5351 temp
->actions
->ofpacts_len
,
5352 old_rule
->match_tlv_bitmap
,
5353 temp
->ofpacts_tlv_bitmap
,
5356 rule_collection_add(new_rules
, new_rule
);
5358 /* Return the template rule in place in the error case. */
5359 ofm
->temp_rule
= temp
;
5360 rule_collection_rules(new_rules
)[0] = NULL
;
5362 rule_collection_unref(new_rules
);
5363 rule_collection_destroy(new_rules
);
5368 ovs_assert(rule_collection_n(new_rules
)
5369 == rule_collection_n(old_rules
));
5371 RULE_COLLECTIONS_FOR_EACH (old_rule
, new_rule
, old_rules
, new_rules
) {
5372 replace_rule_start(ofproto
, ofm
, old_rule
, new_rule
);
5374 } else if (ofm
->modify_may_add_flow
) {
5375 /* No match, add a new flow, consumes 'temp'. */
5376 error
= add_flow_start(ofproto
, ofm
);
5378 /* No flow to modify and may not add a flow. */
5379 ofproto_rule_unref(ofm
->temp_rule
);
5380 ofm
->temp_rule
= NULL
; /* We consume the template. */
5388 modify_flows_init_loose(struct ofproto
*ofproto
,
5389 struct ofproto_flow_mod
*ofm
,
5390 const struct ofputil_flow_mod
*fm
)
5391 OVS_EXCLUDED(ofproto_mutex
)
5393 rule_criteria_init(&ofm
->criteria
, fm
->table_id
, &fm
->match
, 0,
5394 OVS_VERSION_MAX
, fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
,
5396 rule_criteria_require_rw(&ofm
->criteria
,
5397 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5398 /* Must create a new flow in advance for the case that no matches are
5399 * found. Also used for template for multiple modified flows. */
5400 add_flow_init(ofproto
, ofm
, fm
);
5405 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5408 modify_flows_start_loose(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5409 OVS_REQUIRES(ofproto_mutex
)
5411 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5414 error
= collect_rules_loose(ofproto
, &ofm
->criteria
, old_rules
);
5417 error
= modify_flows_start__(ofproto
, ofm
);
5421 rule_collection_destroy(old_rules
);
5428 modify_flows_revert(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5429 OVS_REQUIRES(ofproto_mutex
)
5431 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5432 struct rule_collection
*new_rules
= &ofm
->new_rules
;
5434 /* Old rules were not changed yet, only need to revert new rules. */
5435 if (rule_collection_n(old_rules
) > 0) {
5436 struct rule
*old_rule
, *new_rule
;
5437 RULE_COLLECTIONS_FOR_EACH (old_rule
, new_rule
, old_rules
, new_rules
) {
5438 replace_rule_revert(ofproto
, old_rule
, new_rule
);
5440 rule_collection_destroy(new_rules
);
5441 rule_collection_destroy(old_rules
);
5446 modify_flows_finish(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
5447 const struct openflow_mod_requester
*req
)
5448 OVS_REQUIRES(ofproto_mutex
)
5450 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5451 struct rule_collection
*new_rules
= &ofm
->new_rules
;
5453 if (rule_collection_n(old_rules
) == 0
5454 && rule_collection_n(new_rules
) == 1) {
5455 add_flow_finish(ofproto
, ofm
, req
);
5456 } else if (rule_collection_n(old_rules
) > 0) {
5457 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
5459 ovs_assert(rule_collection_n(new_rules
)
5460 == rule_collection_n(old_rules
));
5462 struct rule
*old_rule
, *new_rule
;
5463 RULE_COLLECTIONS_FOR_EACH (old_rule
, new_rule
, old_rules
, new_rules
) {
5464 replace_rule_finish(ofproto
, ofm
, req
, old_rule
, new_rule
,
5467 learned_cookies_flush(ofproto
, &dead_cookies
);
5468 remove_rules_postponed(old_rules
);
5473 modify_flow_init_strict(struct ofproto
*ofproto OVS_UNUSED
,
5474 struct ofproto_flow_mod
*ofm
,
5475 const struct ofputil_flow_mod
*fm
)
5476 OVS_EXCLUDED(ofproto_mutex
)
5478 rule_criteria_init(&ofm
->criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
5479 OVS_VERSION_MAX
, fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
,
5481 rule_criteria_require_rw(&ofm
->criteria
,
5482 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5483 /* Must create a new flow in advance for the case that no matches are
5484 * found. Also used for template for multiple modified flows. */
5485 add_flow_init(ofproto
, ofm
, fm
);
5490 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
5491 * code on failure. */
5493 modify_flow_start_strict(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5494 OVS_REQUIRES(ofproto_mutex
)
5496 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5499 error
= collect_rules_strict(ofproto
, &ofm
->criteria
, old_rules
);
5502 /* collect_rules_strict() can return max 1 rule. */
5503 error
= modify_flows_start__(ofproto
, ofm
);
5509 /* OFPFC_DELETE implementation. */
5512 delete_flows_start__(struct ofproto
*ofproto
, ovs_version_t version
,
5513 const struct rule_collection
*rules
)
5514 OVS_REQUIRES(ofproto_mutex
)
5518 RULE_COLLECTION_FOR_EACH (rule
, rules
) {
5519 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
5522 cls_rule_make_invisible_in_version(&rule
->cr
, version
);
5524 /* Remove rule from ofproto data structures. */
5525 ofproto_rule_remove__(ofproto
, rule
);
5530 delete_flows_revert__(struct ofproto
*ofproto
,
5531 const struct rule_collection
*rules
)
5532 OVS_REQUIRES(ofproto_mutex
)
5536 RULE_COLLECTION_FOR_EACH (rule
, rules
) {
5537 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
5539 /* Add rule back to ofproto data structures. */
5540 ofproto_rule_insert__(ofproto
, rule
);
5542 /* Restore table's rule count. */
5545 /* Restore the original visibility of the rule. */
5546 cls_rule_restore_visibility(&rule
->cr
);
5551 delete_flows_finish__(struct ofproto
*ofproto
,
5552 struct rule_collection
*rules
,
5553 enum ofp_flow_removed_reason reason
,
5554 const struct openflow_mod_requester
*req
)
5555 OVS_REQUIRES(ofproto_mutex
)
5557 if (rule_collection_n(rules
)) {
5558 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
5561 RULE_COLLECTION_FOR_EACH (rule
, rules
) {
5562 /* This value will be used to send the flow removed message right
5563 * before the rule is actually destroyed. */
5564 rule
->removed_reason
= reason
;
5566 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_DELETED
, reason
,
5567 req
? req
->ofconn
: NULL
,
5568 req
? req
->request
->xid
: 0, NULL
);
5570 /* Send Vacancy Event for OF1.4+. */
5571 send_table_status(ofproto
, rule
->table_id
);
5573 learned_cookies_dec(ofproto
, rule_get_actions(rule
),
5576 remove_rules_postponed(rules
);
5578 learned_cookies_flush(ofproto
, &dead_cookies
);
5582 /* Deletes the rules listed in 'rules'.
5583 * The deleted rules will become invisible to the lookups in the next version.
5584 * Destroys 'rules'. */
5586 delete_flows__(struct rule_collection
*rules
,
5587 enum ofp_flow_removed_reason reason
,
5588 const struct openflow_mod_requester
*req
)
5589 OVS_REQUIRES(ofproto_mutex
)
5591 if (rule_collection_n(rules
)) {
5592 struct ofproto
*ofproto
= rule_collection_rules(rules
)[0]->ofproto
;
5594 delete_flows_start__(ofproto
, ofproto
->tables_version
+ 1, rules
);
5595 ofproto_bump_tables_version(ofproto
);
5596 delete_flows_finish__(ofproto
, rules
, reason
, req
);
5597 ofmonitor_flush(ofproto
->connmgr
);
5602 delete_flows_init_loose(struct ofproto
*ofproto OVS_UNUSED
,
5603 struct ofproto_flow_mod
*ofm
,
5604 const struct ofputil_flow_mod
*fm
)
5605 OVS_EXCLUDED(ofproto_mutex
)
5607 rule_criteria_init(&ofm
->criteria
, fm
->table_id
, &fm
->match
, 0,
5608 OVS_VERSION_MAX
, fm
->cookie
, fm
->cookie_mask
,
5609 fm
->out_port
, fm
->out_group
);
5610 rule_criteria_require_rw(&ofm
->criteria
,
5611 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5615 /* Implements OFPFC_DELETE. */
5617 delete_flows_start_loose(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5618 OVS_REQUIRES(ofproto_mutex
)
5620 struct rule_collection
*rules
= &ofm
->old_rules
;
5623 error
= collect_rules_loose(ofproto
, &ofm
->criteria
, rules
);
5626 delete_flows_start__(ofproto
, ofm
->version
, rules
);
5633 delete_flows_revert(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5634 OVS_REQUIRES(ofproto_mutex
)
5636 delete_flows_revert__(ofproto
, &ofm
->old_rules
);
5640 delete_flows_finish(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
5641 const struct openflow_mod_requester
*req
)
5642 OVS_REQUIRES(ofproto_mutex
)
5644 delete_flows_finish__(ofproto
, &ofm
->old_rules
, OFPRR_DELETE
, req
);
5648 delete_flows_init_strict(struct ofproto
*ofproto OVS_UNUSED
,
5649 struct ofproto_flow_mod
*ofm
,
5650 const struct ofputil_flow_mod
*fm
)
5651 OVS_EXCLUDED(ofproto_mutex
)
5653 rule_criteria_init(&ofm
->criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
5654 OVS_VERSION_MAX
, fm
->cookie
, fm
->cookie_mask
,
5655 fm
->out_port
, fm
->out_group
);
5656 rule_criteria_require_rw(&ofm
->criteria
,
5657 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5661 /* Implements OFPFC_DELETE_STRICT. */
5663 delete_flow_start_strict(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5664 OVS_REQUIRES(ofproto_mutex
)
5666 struct rule_collection
*rules
= &ofm
->old_rules
;
5669 error
= collect_rules_strict(ofproto
, &ofm
->criteria
, rules
);
5672 delete_flows_start__(ofproto
, ofm
->version
, rules
);
5678 /* This may only be called by rule_destroy_cb()! */
5680 ofproto_rule_send_removed(struct rule
*rule
)
5681 OVS_EXCLUDED(ofproto_mutex
)
5683 struct ofputil_flow_removed fr
;
5686 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
5687 fr
.priority
= rule
->cr
.priority
;
5689 /* Synchronize with connmgr_destroy() calls to prevent connmgr disappearing
5690 * while we use it. */
5691 ovs_mutex_lock(&ofproto_mutex
);
5692 struct connmgr
*connmgr
= rule
->ofproto
->connmgr
;
5694 ovs_mutex_unlock(&ofproto_mutex
);
5698 fr
.cookie
= rule
->flow_cookie
;
5699 fr
.reason
= rule
->removed_reason
;
5700 fr
.table_id
= rule
->table_id
;
5701 calc_duration(rule
->created
, time_msec(),
5702 &fr
.duration_sec
, &fr
.duration_nsec
);
5703 ovs_mutex_lock(&rule
->mutex
);
5704 fr
.idle_timeout
= rule
->idle_timeout
;
5705 fr
.hard_timeout
= rule
->hard_timeout
;
5706 ovs_mutex_unlock(&rule
->mutex
);
5707 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
5708 &fr
.byte_count
, &used
);
5709 connmgr_send_flow_removed(connmgr
, &fr
);
5710 ovs_mutex_unlock(&ofproto_mutex
);
5713 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5714 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5717 * ofproto implementation ->run() functions should use this function to expire
5718 * OpenFlow flows. */
5720 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
5721 OVS_REQUIRES(ofproto_mutex
)
5723 struct rule_collection rules
;
5725 rule_collection_init(&rules
);
5726 rule_collection_add(&rules
, rule
);
5727 delete_flows__(&rules
, reason
, NULL
);
5730 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5731 * means "infinite". */
5733 reduce_timeout(uint16_t max
, uint16_t *timeout
)
5735 if (max
&& (!*timeout
|| *timeout
> max
)) {
5740 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5741 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5742 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5744 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5746 ofproto_rule_reduce_timeouts__(struct rule
*rule
,
5747 uint16_t idle_timeout
, uint16_t hard_timeout
)
5748 OVS_REQUIRES(ofproto_mutex
)
5749 OVS_EXCLUDED(rule
->mutex
)
5751 if (!idle_timeout
&& !hard_timeout
) {
5755 if (ovs_list_is_empty(&rule
->expirable
)) {
5756 ovs_list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
5759 ovs_mutex_lock(&rule
->mutex
);
5760 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
5761 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
5762 ovs_mutex_unlock(&rule
->mutex
);
5766 ofproto_rule_reduce_timeouts(struct rule
*rule
,
5767 uint16_t idle_timeout
, uint16_t hard_timeout
)
5768 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
5770 if (!idle_timeout
&& !hard_timeout
) {
5774 ovs_mutex_lock(&ofproto_mutex
);
5775 if (ovs_list_is_empty(&rule
->expirable
)) {
5776 ovs_list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
5778 ovs_mutex_unlock(&ofproto_mutex
);
5780 ovs_mutex_lock(&rule
->mutex
);
5781 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
5782 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
5783 ovs_mutex_unlock(&rule
->mutex
);
5787 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5788 OVS_EXCLUDED(ofproto_mutex
)
5790 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5791 struct ofputil_flow_mod fm
;
5792 uint64_t ofpacts_stub
[1024 / 8];
5793 struct ofpbuf ofpacts
;
5796 error
= reject_slave_controller(ofconn
);
5801 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
5802 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
5803 ofproto_get_tun_tab(ofproto
),
5804 &ofproto
->vl_mff_map
, &ofpacts
,
5805 u16_to_ofp(ofproto
->max_ports
),
5808 struct openflow_mod_requester req
= { ofconn
, oh
};
5809 error
= handle_flow_mod__(ofproto
, &fm
, &req
);
5812 ofpbuf_uninit(&ofpacts
);
5817 handle_flow_mod__(struct ofproto
*ofproto
, const struct ofputil_flow_mod
*fm
,
5818 const struct openflow_mod_requester
*req
)
5819 OVS_EXCLUDED(ofproto_mutex
)
5821 struct ofproto_flow_mod ofm
;
5824 error
= ofproto_flow_mod_init(ofproto
, &ofm
, fm
, NULL
);
5829 ovs_mutex_lock(&ofproto_mutex
);
5830 ofm
.version
= ofproto
->tables_version
+ 1;
5831 error
= ofproto_flow_mod_start(ofproto
, &ofm
);
5833 ofproto_bump_tables_version(ofproto
);
5834 ofproto_flow_mod_finish(ofproto
, &ofm
, req
);
5835 ofmonitor_flush(ofproto
->connmgr
);
5837 ovs_mutex_unlock(&ofproto_mutex
);
5843 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5845 struct ofputil_role_request request
;
5846 struct ofputil_role_request reply
;
5850 error
= ofputil_decode_role_message(oh
, &request
);
5855 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
5856 if (request
.role
!= OFPCR12_ROLE_EQUAL
5857 && request
.have_generation_id
5858 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
5859 return OFPERR_OFPRRFC_STALE
;
5862 ofconn_set_role(ofconn
, request
.role
);
5865 reply
.role
= ofconn_get_role(ofconn
);
5866 reply
.have_generation_id
= ofconn_get_master_election_id(
5867 ofconn
, &reply
.generation_id
);
5868 buf
= ofputil_encode_role_reply(oh
, &reply
);
5869 ofconn_send_reply(ofconn
, buf
);
5875 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
5876 const struct ofp_header
*oh
)
5878 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
5879 enum ofputil_protocol cur
, next
;
5881 cur
= ofconn_get_protocol(ofconn
);
5882 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
5883 ofconn_set_protocol(ofconn
, next
);
5889 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5891 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
5892 enum ofputil_protocol cur
, next
;
5893 enum ofputil_protocol next_base
;
5895 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
5897 return OFPERR_OFPBRC_EPERM
;
5900 cur
= ofconn_get_protocol(ofconn
);
5901 next
= ofputil_protocol_set_base(cur
, next_base
);
5902 ofconn_set_protocol(ofconn
, next
);
5908 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
5909 const struct ofp_header
*oh
)
5911 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
5914 format
= ntohl(msg
->format
);
5915 if (!ofputil_packet_in_format_is_valid(format
)) {
5916 return OFPERR_OFPBRC_EPERM
;
5919 ofconn_set_packet_in_format(ofconn
, format
);
5924 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5926 struct ofputil_async_cfg basis
= ofconn_get_async_config(ofconn
);
5927 struct ofputil_async_cfg ac
;
5930 error
= ofputil_decode_set_async_config(oh
, false, &basis
, &ac
);
5935 ofconn_set_async_config(ofconn
, &ac
);
5936 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
5937 !ofconn_get_miss_send_len(ofconn
)) {
5938 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
5945 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5947 struct ofputil_async_cfg ac
= ofconn_get_async_config(ofconn
);
5948 ofconn_send_reply(ofconn
, ofputil_encode_get_async_reply(oh
, &ac
));
5954 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
5955 const struct ofp_header
*oh
)
5957 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
5959 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
5960 return OFPERR_NXBRC_MUST_BE_ZERO
;
5963 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
5968 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5972 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
5973 ? OFPRAW_OFPT10_BARRIER_REPLY
5974 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
5975 ofconn_send_reply(ofconn
, buf
);
5980 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
5981 enum nx_flow_monitor_flags flags
,
5982 struct ovs_list
*msgs
,
5983 const struct tun_table
*tun_table
)
5984 OVS_REQUIRES(ofproto_mutex
)
5986 const struct rule_actions
*actions
;
5987 struct ofputil_flow_update fu
;
5989 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
5990 ? NXFME_ADDED
: NXFME_MODIFIED
);
5992 ovs_mutex_lock(&rule
->mutex
);
5993 fu
.idle_timeout
= rule
->idle_timeout
;
5994 fu
.hard_timeout
= rule
->hard_timeout
;
5995 ovs_mutex_unlock(&rule
->mutex
);
5996 fu
.table_id
= rule
->table_id
;
5997 fu
.cookie
= rule
->flow_cookie
;
5998 minimatch_expand(&rule
->cr
.match
, &fu
.match
);
5999 fu
.priority
= rule
->cr
.priority
;
6001 actions
= flags
& NXFMF_ACTIONS
? rule_get_actions(rule
) : NULL
;
6002 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
6003 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
6005 if (ovs_list_is_empty(msgs
)) {
6006 ofputil_start_flow_update(msgs
);
6008 ofputil_append_flow_update(&fu
, msgs
, tun_table
);
6012 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
6013 struct ovs_list
*msgs
)
6014 OVS_REQUIRES(ofproto_mutex
)
6018 RULE_COLLECTION_FOR_EACH (rule
, rules
) {
6019 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
6020 rule
->monitor_flags
= 0;
6022 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
,
6023 ofproto_get_tun_tab(rule
->ofproto
));
6028 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
6029 struct rule
*rule
, uint64_t seqno
,
6030 struct rule_collection
*rules
)
6031 OVS_REQUIRES(ofproto_mutex
)
6033 enum nx_flow_monitor_flags update
;
6035 if (rule_is_hidden(rule
)) {
6039 if (!ofproto_rule_has_out_port(rule
, m
->out_port
)) {
6044 if (rule
->add_seqno
> seqno
) {
6045 update
= NXFMF_ADD
| NXFMF_MODIFY
;
6046 } else if (rule
->modify_seqno
> seqno
) {
6047 update
= NXFMF_MODIFY
;
6052 if (!(m
->flags
& update
)) {
6056 update
= NXFMF_INITIAL
;
6059 if (!rule
->monitor_flags
) {
6060 rule_collection_add(rules
, rule
);
6062 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
6066 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
6068 struct rule_collection
*rules
)
6069 OVS_REQUIRES(ofproto_mutex
)
6071 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
6072 const struct oftable
*table
;
6073 struct cls_rule target
;
6075 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
6076 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
6079 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &target
, OVS_VERSION_MAX
) {
6080 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
6083 cls_rule_destroy(&target
);
6087 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
6088 struct rule_collection
*rules
)
6089 OVS_REQUIRES(ofproto_mutex
)
6091 if (m
->flags
& NXFMF_INITIAL
) {
6092 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
6097 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
6098 uint64_t seqno
, struct rule_collection
*rules
)
6099 OVS_REQUIRES(ofproto_mutex
)
6101 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
6105 flow_monitor_delete(struct ofconn
*ofconn
, uint32_t id
)
6106 OVS_REQUIRES(ofproto_mutex
)
6108 struct ofmonitor
*m
;
6111 m
= ofmonitor_lookup(ofconn
, id
);
6113 ofmonitor_destroy(m
);
6116 error
= OFPERR_OFPMOFC_UNKNOWN_MONITOR
;
6123 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6124 OVS_EXCLUDED(ofproto_mutex
)
6126 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6128 struct ofpbuf b
= ofpbuf_const_initializer(oh
, ntohs(oh
->length
));
6130 struct ofmonitor
**monitors
= NULL
;
6131 size_t allocated_monitors
= 0;
6132 size_t n_monitors
= 0;
6136 ovs_mutex_lock(&ofproto_mutex
);
6138 struct ofputil_flow_monitor_request request
;
6139 struct ofmonitor
*m
;
6142 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
6143 if (retval
== EOF
) {
6145 } else if (retval
) {
6150 if (request
.table_id
!= 0xff
6151 && request
.table_id
>= ofproto
->n_tables
) {
6152 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
6156 error
= ofmonitor_create(&request
, ofconn
, &m
);
6161 if (n_monitors
>= allocated_monitors
) {
6162 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
6165 monitors
[n_monitors
++] = m
;
6168 struct rule_collection rules
;
6169 rule_collection_init(&rules
);
6170 for (size_t i
= 0; i
< n_monitors
; i
++) {
6171 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
6174 struct ovs_list replies
;
6175 ofpmp_init(&replies
, oh
);
6176 ofmonitor_compose_refresh_updates(&rules
, &replies
);
6177 ovs_mutex_unlock(&ofproto_mutex
);
6179 rule_collection_destroy(&rules
);
6181 ofconn_send_replies(ofconn
, &replies
);
6187 for (size_t i
= 0; i
< n_monitors
; i
++) {
6188 ofmonitor_destroy(monitors
[i
]);
6191 ovs_mutex_unlock(&ofproto_mutex
);
6197 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6198 OVS_EXCLUDED(ofproto_mutex
)
6203 id
= ofputil_decode_flow_monitor_cancel(oh
);
6205 ovs_mutex_lock(&ofproto_mutex
);
6206 error
= flow_monitor_delete(ofconn
, id
);
6207 ovs_mutex_unlock(&ofproto_mutex
);
6212 /* Meters implementation.
6214 * Meter table entry, indexed by the OpenFlow meter_id.
6215 * 'created' is used to compute the duration for meter stats.
6216 * 'list rules' is needed so that we can delete the dependent rules when the
6217 * meter table entry is deleted.
6218 * 'provider_meter_id' is for the provider's private use.
6221 struct hmap_node node
; /* In ofproto->meters. */
6222 long long int created
; /* Time created. */
6223 struct ovs_list rules
; /* List of "struct rule_dpif"s. */
6224 uint32_t id
; /* OpenFlow meter_id. */
6225 ofproto_meter_id provider_meter_id
;
6226 uint16_t flags
; /* Meter flags. */
6227 uint16_t n_bands
; /* Number of meter bands. */
6228 struct ofputil_meter_band
*bands
;
6231 static struct meter
*
6232 ofproto_get_meter(const struct ofproto
*ofproto
, uint32_t meter_id
)
6234 struct meter
*meter
;
6235 uint32_t hash
= hash_int(meter_id
, 0);
6237 HMAP_FOR_EACH_WITH_HASH (meter
, node
, hash
, &ofproto
->meters
) {
6238 if (meter
->id
== meter_id
) {
6247 ofproto_upcall_meter_ptr(struct ofproto
*ofproto
, uint32_t meter_id
)
6250 case OFPM13_SLOWPATH
:
6251 return &ofproto
->slowpath_meter_id
;
6253 case OFPM13_CONTROLLER
:
6254 return &ofproto
->controller_meter_id
;
6264 ofproto_add_meter(struct ofproto
*ofproto
, struct meter
*meter
)
6266 uint32_t *upcall_meter_ptr
= ofproto_upcall_meter_ptr(ofproto
, meter
->id
);
6268 /* Cache datapath meter IDs of special meters. */
6269 if (upcall_meter_ptr
) {
6270 *upcall_meter_ptr
= meter
->provider_meter_id
.uint32
;
6273 hmap_insert(&ofproto
->meters
, &meter
->node
, hash_int(meter
->id
, 0));
6277 * This is used in instruction validation at flow set-up time, to map
6278 * the OpenFlow meter ID to the corresponding datapath provider meter
6279 * ID. If either does not exist, returns false. Otherwise updates
6280 * the meter action and returns true.
6283 ofproto_fix_meter_action(const struct ofproto
*ofproto
,
6284 struct ofpact_meter
*ma
)
6287 const struct meter
*meter
= ofproto_get_meter(ofproto
, ma
->meter_id
);
6289 if (meter
&& meter
->provider_meter_id
.uint32
!= UINT32_MAX
) {
6290 /* Update the action with the provider's meter ID, so that we
6291 * do not need any synchronization between ofproto_dpif_xlate
6292 * and ofproto for meter table access. */
6293 ma
->provider_meter_id
= meter
->provider_meter_id
.uint32
;
6300 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
6303 meter_insert_rule(struct rule
*rule
)
6305 const struct rule_actions
*a
= rule_get_actions(rule
);
6306 uint32_t meter_id
= ofpacts_get_meter(a
->ofpacts
, a
->ofpacts_len
);
6307 struct meter
*meter
= ofproto_get_meter(rule
->ofproto
, meter_id
);
6309 ovs_list_insert(&meter
->rules
, &rule
->meter_list_node
);
6313 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
6317 meter
->flags
= config
->flags
;
6318 meter
->n_bands
= config
->n_bands
;
6319 meter
->bands
= xmemdup(config
->bands
,
6320 config
->n_bands
* sizeof *meter
->bands
);
6323 static struct meter
*
6324 meter_create(const struct ofputil_meter_config
*config
,
6325 ofproto_meter_id provider_meter_id
)
6327 struct meter
*meter
;
6329 meter
= xzalloc(sizeof *meter
);
6330 meter
->provider_meter_id
= provider_meter_id
;
6331 meter
->created
= time_msec();
6332 meter
->id
= config
->meter_id
;
6333 ovs_list_init(&meter
->rules
);
6335 meter_update(meter
, config
);
6341 meter_destroy(struct ofproto
*ofproto
, struct meter
*meter
)
6342 OVS_REQUIRES(ofproto_mutex
)
6344 uint32_t *upcall_meter_ptr
;
6345 upcall_meter_ptr
= ofproto_upcall_meter_ptr(ofproto
, meter
->id
);
6346 if (upcall_meter_ptr
) {
6347 *upcall_meter_ptr
= UINT32_MAX
;
6350 if (!ovs_list_is_empty(&meter
->rules
)) {
6351 struct rule_collection rules
;
6354 rule_collection_init(&rules
);
6355 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
6356 rule_collection_add(&rules
, rule
);
6358 delete_flows__(&rules
, OFPRR_METER_DELETE
, NULL
);
6361 ofproto
->ofproto_class
->meter_del(ofproto
, meter
->provider_meter_id
);
6367 meter_delete(struct ofproto
*ofproto
, uint32_t meter_id
)
6368 OVS_REQUIRES(ofproto_mutex
)
6370 struct meter
*meter
= ofproto_get_meter(ofproto
, meter_id
);
6373 hmap_remove(&ofproto
->meters
, &meter
->node
);
6374 meter_destroy(ofproto
, meter
);
6379 meter_delete_all(struct ofproto
*ofproto
)
6380 OVS_REQUIRES(ofproto_mutex
)
6382 struct meter
*meter
, *next
;
6384 HMAP_FOR_EACH_SAFE (meter
, next
, node
, &ofproto
->meters
) {
6385 hmap_remove(&ofproto
->meters
, &meter
->node
);
6386 meter_destroy(ofproto
, meter
);
6391 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
6393 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
6394 struct meter
*meter
= ofproto_get_meter(ofproto
, mm
->meter
.meter_id
);
6398 return OFPERR_OFPMMFC_METER_EXISTS
;
6401 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
6404 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
6405 meter
= meter_create(&mm
->meter
, provider_meter_id
);
6406 ofproto_add_meter(ofproto
, meter
);
6412 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
6414 struct meter
*meter
= ofproto_get_meter(ofproto
, mm
->meter
.meter_id
);
6416 uint32_t provider_meter_id
;
6419 return OFPERR_OFPMMFC_UNKNOWN_METER
;
6422 provider_meter_id
= meter
->provider_meter_id
.uint32
;
6423 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
6424 &meter
->provider_meter_id
,
6426 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
6428 meter_update(meter
, &mm
->meter
);
6434 handle_delete_meter(struct ofconn
*ofconn
, struct ofputil_meter_mod
*mm
)
6435 OVS_EXCLUDED(ofproto_mutex
)
6437 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6438 uint32_t meter_id
= mm
->meter
.meter_id
;
6440 /* OpenFlow does not support Meter ID 0. */
6442 ovs_mutex_lock(&ofproto_mutex
);
6444 if (meter_id
== OFPM13_ALL
) {
6445 meter_delete_all(ofproto
);
6447 meter_delete(ofproto
, meter_id
);
6450 ovs_mutex_unlock(&ofproto_mutex
);
6457 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6459 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6460 struct ofputil_meter_mod mm
;
6461 uint64_t bands_stub
[256 / 8];
6462 struct ofpbuf bands
;
6466 error
= reject_slave_controller(ofconn
);
6471 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
6473 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
6475 goto exit_free_bands
;
6478 meter_id
= mm
.meter
.meter_id
;
6480 if (mm
.command
!= OFPMC13_DELETE
) {
6481 /* Fails also when meters are not implemented by the provider. */
6482 if (ofproto
->meter_features
.max_meters
== 0) {
6483 error
= OFPERR_OFPMMFC_INVALID_METER
;
6484 goto exit_free_bands
;
6487 if (meter_id
== 0) {
6488 error
= OFPERR_OFPMMFC_INVALID_METER
;
6489 goto exit_free_bands
;
6490 } else if (meter_id
> OFPM13_MAX
) {
6492 case OFPM13_SLOWPATH
:
6493 case OFPM13_CONTROLLER
:
6497 error
= OFPERR_OFPMMFC_INVALID_METER
;
6498 goto exit_free_bands
;
6501 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
6502 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
6503 goto exit_free_bands
;
6507 switch (mm
.command
) {
6509 error
= handle_add_meter(ofproto
, &mm
);
6512 case OFPMC13_MODIFY
:
6513 error
= handle_modify_meter(ofproto
, &mm
);
6516 case OFPMC13_DELETE
:
6517 error
= handle_delete_meter(ofconn
, &mm
);
6521 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
6526 struct ofputil_requestforward rf
;
6528 rf
.reason
= OFPRFR_METER_MOD
;
6530 connmgr_send_requestforward(ofproto
->connmgr
, ofconn
, &rf
);
6534 ofpbuf_uninit(&bands
);
6539 handle_meter_features_request(struct ofconn
*ofconn
,
6540 const struct ofp_header
*request
)
6542 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6543 struct ofputil_meter_features features
;
6546 if (ofproto
->ofproto_class
->meter_get_features
) {
6547 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
6549 memset(&features
, 0, sizeof features
);
6551 b
= ofputil_encode_meter_features_reply(&features
, request
);
6553 ofconn_send_reply(ofconn
, b
);
6558 meter_request_reply(struct ofproto
*ofproto
, struct meter
*meter
,
6559 enum ofptype type
, struct ovs_list
*replies
)
6561 uint64_t bands_stub
[256 / 8];
6562 struct ofpbuf bands
;
6564 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
6566 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
6567 struct ofputil_meter_stats stats
;
6569 stats
.meter_id
= meter
->id
;
6571 /* Provider sets the packet and byte counts, we do the rest. */
6572 stats
.flow_count
= ovs_list_size(&meter
->rules
);
6573 calc_duration(meter
->created
, time_msec(),
6574 &stats
.duration_sec
, &stats
.duration_nsec
);
6575 stats
.n_bands
= meter
->n_bands
;
6576 ofpbuf_clear(&bands
);
6577 stats
.bands
= ofpbuf_put_uninit(&bands
, meter
->n_bands
6578 * sizeof *stats
.bands
);
6580 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
6581 meter
->provider_meter_id
,
6582 &stats
, meter
->n_bands
)) {
6583 ofputil_append_meter_stats(replies
, &stats
);
6585 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
6586 struct ofputil_meter_config config
;
6588 config
.meter_id
= meter
->id
;
6589 config
.flags
= meter
->flags
;
6590 config
.n_bands
= meter
->n_bands
;
6591 config
.bands
= meter
->bands
;
6592 ofputil_append_meter_config(replies
, &config
);
6595 ofpbuf_uninit(&bands
);
6599 meter_request_reply_all(struct ofproto
*ofproto
, enum ofptype type
,
6600 struct ovs_list
*replies
)
6602 struct meter
*meter
;
6604 HMAP_FOR_EACH (meter
, node
, &ofproto
->meters
) {
6605 meter_request_reply(ofproto
, meter
, type
, replies
);
6610 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
6613 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6614 struct ovs_list replies
;
6616 struct meter
*meter
;
6618 ofputil_decode_meter_request(request
, &meter_id
);
6620 if (meter_id
!= OFPM13_ALL
) {
6621 meter
= ofproto_get_meter(ofproto
, meter_id
);
6623 /* Meter does not exist. */
6624 return OFPERR_OFPMMFC_UNKNOWN_METER
;
6627 /* GCC 4.9.2 complains about 'meter' can potentially be used
6628 * uninitialized. Logically, this is a false alarm since
6629 * meter is only used when meter_id != OFPM13_ALL.
6630 * Set NULL to make compiler happy. */
6634 ofpmp_init(&replies
, request
);
6635 if (meter_id
== OFPM13_ALL
) {
6636 meter_request_reply_all(ofproto
, type
, &replies
);
6638 meter_request_reply(ofproto
, meter
, type
, &replies
);
6640 ofconn_send_replies(ofconn
, &replies
);
6644 /* Returned group is RCU protected. */
6645 static struct ofgroup
*
6646 ofproto_group_lookup__(const struct ofproto
*ofproto
, uint32_t group_id
,
6647 ovs_version_t version
)
6649 struct ofgroup
*group
;
6651 CMAP_FOR_EACH_WITH_HASH (group
, cmap_node
, hash_int(group_id
, 0),
6653 if (group
->group_id
== group_id
6654 && versions_visible_in_version(&group
->versions
, version
)) {
6662 /* If the group exists, this function increments the groups's reference count.
6664 * Make sure to call ofproto_group_unref() after no longer needing to maintain
6665 * a reference to the group. */
6667 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
6668 ovs_version_t version
, bool take_ref
)
6670 struct ofgroup
*group
;
6672 group
= ofproto_group_lookup__(ofproto
, group_id
, version
);
6673 if (group
&& take_ref
) {
6674 /* Not holding a lock, so it is possible that another thread releases
6675 * the last reference just before we manage to get one. */
6676 return ofproto_group_try_ref(group
) ? group
: NULL
;
6681 /* Caller should hold 'ofproto_mutex' if it is important that the
6682 * group is not removed by someone else. */
6684 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
6686 return ofproto_group_lookup__(ofproto
, group_id
, OVS_VERSION_MAX
) != NULL
;
6690 group_add_rule(struct ofgroup
*group
, struct rule
*rule
)
6692 rule_collection_add(&group
->rules
, rule
);
6696 group_remove_rule(struct ofgroup
*group
, struct rule
*rule
)
6698 rule_collection_remove(&group
->rules
, rule
);
6702 append_group_stats(struct ofgroup
*group
, struct ovs_list
*replies
)
6703 OVS_REQUIRES(ofproto_mutex
)
6705 struct ofputil_group_stats ogs
;
6706 const struct ofproto
*ofproto
= group
->ofproto
;
6707 long long int now
= time_msec();
6710 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
6712 /* Provider sets the packet and byte counts, we do the rest. */
6713 ogs
.ref_count
= rule_collection_n(&group
->rules
);
6714 ogs
.n_buckets
= group
->n_buckets
;
6716 error
= (ofproto
->ofproto_class
->group_get_stats
6717 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
6720 ogs
.packet_count
= UINT64_MAX
;
6721 ogs
.byte_count
= UINT64_MAX
;
6722 memset(ogs
.bucket_stats
, 0xff,
6723 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
6726 ogs
.group_id
= group
->group_id
;
6727 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
6729 ofputil_append_group_stats(replies
, &ogs
);
6731 free(ogs
.bucket_stats
);
6735 handle_group_request(struct ofconn
*ofconn
,
6736 const struct ofp_header
*request
, uint32_t group_id
,
6737 void (*cb
)(struct ofgroup
*, struct ovs_list
*replies
))
6738 OVS_EXCLUDED(ofproto_mutex
)
6740 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6741 struct ofgroup
*group
;
6742 struct ovs_list replies
;
6744 ofpmp_init(&replies
, request
);
6745 /* Must exclude modifications to guarantee iterating groups. */
6746 ovs_mutex_lock(&ofproto_mutex
);
6747 if (group_id
== OFPG_ALL
) {
6748 CMAP_FOR_EACH (group
, cmap_node
, &ofproto
->groups
) {
6749 if (versions_visible_in_version(&group
->versions
,
6751 cb(group
, &replies
);
6755 group
= ofproto_group_lookup__(ofproto
, group_id
, OVS_VERSION_MAX
);
6757 cb(group
, &replies
);
6760 ovs_mutex_unlock(&ofproto_mutex
);
6761 ofconn_send_replies(ofconn
, &replies
);
6765 handle_group_stats_request(struct ofconn
*ofconn
,
6766 const struct ofp_header
*request
)
6771 error
= ofputil_decode_group_stats_request(request
, &group_id
);
6776 handle_group_request(ofconn
, request
, group_id
, append_group_stats
);
6781 append_group_desc(struct ofgroup
*group
, struct ovs_list
*replies
)
6783 struct ofputil_group_desc gds
;
6785 gds
.group_id
= group
->group_id
;
6786 gds
.type
= group
->type
;
6787 gds
.props
= group
->props
;
6789 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, replies
);
6793 handle_group_desc_stats_request(struct ofconn
*ofconn
,
6794 const struct ofp_header
*request
)
6796 handle_group_request(ofconn
, request
,
6797 ofputil_decode_group_desc_request(request
),
6803 handle_group_features_stats_request(struct ofconn
*ofconn
,
6804 const struct ofp_header
*request
)
6806 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
6809 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
6811 ofconn_send_reply(ofconn
, msg
);
6818 put_queue_get_config_reply(struct ofport
*port
, uint32_t queue
,
6819 struct ovs_list
*replies
)
6821 struct ofputil_queue_config qc
;
6823 /* None of the existing queues have compatible properties, so we hard-code
6824 * omitting min_rate and max_rate. */
6825 qc
.port
= port
->ofp_port
;
6827 qc
.min_rate
= UINT16_MAX
;
6828 qc
.max_rate
= UINT16_MAX
;
6829 ofputil_append_queue_get_config_reply(&qc
, replies
);
6833 handle_queue_get_config_request_for_port(struct ofport
*port
, uint32_t queue
,
6834 struct ovs_list
*replies
)
6836 struct smap details
= SMAP_INITIALIZER(&details
);
6837 if (queue
!= OFPQ_ALL
) {
6838 int error
= netdev_get_queue(port
->netdev
, queue
, &details
);
6841 put_queue_get_config_reply(port
, queue
, replies
);
6845 return OFPERR_OFPQOFC_BAD_QUEUE
;
6847 return OFPERR_NXQOFC_QUEUE_ERROR
;
6850 struct netdev_queue_dump queue_dump
;
6853 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
,
6855 put_queue_get_config_reply(port
, queue_id
, replies
);
6858 smap_destroy(&details
);
6863 handle_queue_get_config_request(struct ofconn
*ofconn
,
6864 const struct ofp_header
*oh
)
6866 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6867 struct ovs_list replies
;
6868 struct ofport
*port
;
6869 ofp_port_t req_port
;
6873 error
= ofputil_decode_queue_get_config_request(oh
, &req_port
, &req_queue
);
6878 ofputil_start_queue_get_config_reply(oh
, &replies
);
6879 if (req_port
== OFPP_ANY
) {
6880 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
6881 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
6882 if (!handle_queue_get_config_request_for_port(port
, req_queue
,
6888 port
= ofproto_get_port(ofproto
, req_port
);
6890 ? handle_queue_get_config_request_for_port(port
, req_queue
,
6892 : OFPERR_OFPQOFC_BAD_PORT
);
6895 ofconn_send_replies(ofconn
, &replies
);
6897 ofpbuf_list_delete(&replies
);
6904 init_group(struct ofproto
*ofproto
, const struct ofputil_group_mod
*gm
,
6905 ovs_version_t version
, struct ofgroup
**ofgroup
)
6908 const long long int now
= time_msec();
6910 if (gm
->group_id
> OFPG_MAX
) {
6911 return OFPERR_OFPGMFC_INVALID_GROUP
;
6913 if (gm
->type
> OFPGT11_FF
) {
6914 return OFPERR_OFPGMFC_BAD_TYPE
;
6917 *ofgroup
= ofproto
->ofproto_class
->group_alloc();
6919 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
6920 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6923 *CONST_CAST(struct ofproto
**, &(*ofgroup
)->ofproto
) = ofproto
;
6924 *CONST_CAST(uint32_t *, &((*ofgroup
)->group_id
)) = gm
->group_id
;
6925 *CONST_CAST(enum ofp11_group_type
*, &(*ofgroup
)->type
) = gm
->type
;
6926 *CONST_CAST(long long int *, &((*ofgroup
)->created
)) = now
;
6927 *CONST_CAST(long long int *, &((*ofgroup
)->modified
)) = now
;
6928 ovs_refcount_init(&(*ofgroup
)->ref_count
);
6929 (*ofgroup
)->being_deleted
= false;
6931 ovs_list_init(CONST_CAST(struct ovs_list
*, &(*ofgroup
)->buckets
));
6932 ofputil_bucket_clone_list(CONST_CAST(struct ovs_list
*,
6933 &(*ofgroup
)->buckets
),
6934 &gm
->buckets
, NULL
);
6936 *CONST_CAST(uint32_t *, &(*ofgroup
)->n_buckets
) =
6937 ovs_list_size(&(*ofgroup
)->buckets
);
6939 ofputil_group_properties_copy(CONST_CAST(struct ofputil_group_props
*,
6940 &(*ofgroup
)->props
),
6942 rule_collection_init(&(*ofgroup
)->rules
);
6944 /* Make group visible from 'version'. */
6945 (*ofgroup
)->versions
= VERSIONS_INITIALIZER(version
,
6946 OVS_VERSION_NOT_REMOVED
);
6948 /* Construct called BEFORE any locks are held. */
6949 error
= ofproto
->ofproto_class
->group_construct(*ofgroup
);
6951 ofputil_group_properties_destroy(CONST_CAST(struct ofputil_group_props
*,
6952 &(*ofgroup
)->props
));
6953 ofputil_bucket_list_destroy(CONST_CAST(struct ovs_list
*,
6954 &(*ofgroup
)->buckets
));
6955 ofproto
->ofproto_class
->group_dealloc(*ofgroup
);
6960 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6961 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6964 add_group_start(struct ofproto
*ofproto
, struct ofproto_group_mod
*ogm
)
6965 OVS_REQUIRES(ofproto_mutex
)
6969 if (ofproto_group_exists(ofproto
, ogm
->gm
.group_id
)) {
6970 return OFPERR_OFPGMFC_GROUP_EXISTS
;
6973 if (ofproto
->n_groups
[ogm
->gm
.type
]
6974 >= ofproto
->ogf
.max_groups
[ogm
->gm
.type
]) {
6975 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6978 /* Allocate new group and initialize it. */
6979 error
= init_group(ofproto
, &ogm
->gm
, ogm
->version
, &ogm
->new_group
);
6981 /* Insert new group. */
6982 cmap_insert(&ofproto
->groups
, &ogm
->new_group
->cmap_node
,
6983 hash_int(ogm
->new_group
->group_id
, 0));
6984 ofproto
->n_groups
[ogm
->new_group
->type
]++;
6989 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6990 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6991 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6992 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6995 copy_buckets_for_insert_bucket(const struct ofgroup
*ofgroup
,
6996 struct ofgroup
*new_ofgroup
,
6997 uint32_t command_bucket_id
)
6999 struct ofputil_bucket
*last
= NULL
;
7001 if (command_bucket_id
<= OFPG15_BUCKET_MAX
) {
7002 /* Check here to ensure that a bucket corresponding to
7003 * command_bucket_id exists in the old bucket list.
7005 * The subsequent search of below of new_ofgroup covers
7006 * both buckets in the old bucket list and buckets added
7007 * by the insert buckets group mod message this function processes. */
7008 if (!ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
)) {
7009 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
7012 if (!ovs_list_is_empty(&new_ofgroup
->buckets
)) {
7013 last
= ofputil_bucket_list_back(&new_ofgroup
->buckets
);
7017 ofputil_bucket_clone_list(CONST_CAST(struct ovs_list
*,
7018 &new_ofgroup
->buckets
),
7019 &ofgroup
->buckets
, NULL
);
7021 if (ofputil_bucket_check_duplicate_id(&new_ofgroup
->buckets
)) {
7022 VLOG_INFO_RL(&rl
, "Duplicate bucket id");
7023 return OFPERR_OFPGMFC_BUCKET_EXISTS
;
7026 /* Rearrange list according to command_bucket_id */
7027 if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
7028 if (!ovs_list_is_empty(&ofgroup
->buckets
)) {
7029 struct ofputil_bucket
*new_first
;
7030 const struct ofputil_bucket
*first
;
7032 first
= ofputil_bucket_list_front(&ofgroup
->buckets
);
7033 new_first
= ofputil_bucket_find(&new_ofgroup
->buckets
,
7036 ovs_list_splice(new_ofgroup
->buckets
.next
, &new_first
->list_node
,
7037 CONST_CAST(struct ovs_list
*,
7038 &new_ofgroup
->buckets
));
7040 } else if (command_bucket_id
<= OFPG15_BUCKET_MAX
&& last
) {
7041 struct ofputil_bucket
*after
;
7043 /* Presence of bucket is checked above so after should never be NULL */
7044 after
= ofputil_bucket_find(&new_ofgroup
->buckets
, command_bucket_id
);
7046 ovs_list_splice(after
->list_node
.next
, new_ofgroup
->buckets
.next
,
7047 last
->list_node
.next
);
7053 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
7054 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
7055 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
7056 * and OFPG15_BUCKET_ALL are also honored. */
7058 copy_buckets_for_remove_bucket(const struct ofgroup
*ofgroup
,
7059 struct ofgroup
*new_ofgroup
,
7060 uint32_t command_bucket_id
)
7062 const struct ofputil_bucket
*skip
= NULL
;
7064 if (command_bucket_id
== OFPG15_BUCKET_ALL
) {
7068 if (command_bucket_id
== OFPG15_BUCKET_FIRST
) {
7069 if (!ovs_list_is_empty(&ofgroup
->buckets
)) {
7070 skip
= ofputil_bucket_list_front(&ofgroup
->buckets
);
7072 } else if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
7073 if (!ovs_list_is_empty(&ofgroup
->buckets
)) {
7074 skip
= ofputil_bucket_list_back(&ofgroup
->buckets
);
7077 skip
= ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
);
7079 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
7083 ofputil_bucket_clone_list(CONST_CAST(struct ovs_list
*,
7084 &new_ofgroup
->buckets
),
7085 &ofgroup
->buckets
, skip
);
7090 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
7091 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
7094 * Note that the group is re-created and then replaces the old group in
7095 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
7096 * the xlate module hold a pointer to the group. */
7098 modify_group_start(struct ofproto
*ofproto
, struct ofproto_group_mod
*ogm
)
7099 OVS_REQUIRES(ofproto_mutex
)
7101 struct ofgroup
*old_group
; /* Modified group. */
7102 struct ofgroup
*new_group
;
7105 old_group
= ofproto_group_lookup__(ofproto
, ogm
->gm
.group_id
,
7108 return OFPERR_OFPGMFC_UNKNOWN_GROUP
;
7111 if (old_group
->type
!= ogm
->gm
.type
7112 && (ofproto
->n_groups
[ogm
->gm
.type
]
7113 >= ofproto
->ogf
.max_groups
[ogm
->gm
.type
])) {
7114 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
7117 error
= init_group(ofproto
, &ogm
->gm
, ogm
->version
, &ogm
->new_group
);
7121 new_group
= ogm
->new_group
;
7123 /* Manipulate bucket list for bucket commands */
7124 if (ogm
->gm
.command
== OFPGC15_INSERT_BUCKET
) {
7125 error
= copy_buckets_for_insert_bucket(old_group
, new_group
,
7126 ogm
->gm
.command_bucket_id
);
7127 } else if (ogm
->gm
.command
== OFPGC15_REMOVE_BUCKET
) {
7128 error
= copy_buckets_for_remove_bucket(old_group
, new_group
,
7129 ogm
->gm
.command_bucket_id
);
7135 /* The group creation time does not change during modification. */
7136 *CONST_CAST(long long int *, &(new_group
->created
)) = old_group
->created
;
7137 *CONST_CAST(long long int *, &(new_group
->modified
)) = time_msec();
7139 group_collection_add(&ogm
->old_groups
, old_group
);
7141 /* Mark the old group for deletion. */
7142 versions_set_remove_version(&old_group
->versions
, ogm
->version
);
7143 /* Insert replacement group. */
7144 cmap_insert(&ofproto
->groups
, &new_group
->cmap_node
,
7145 hash_int(new_group
->group_id
, 0));
7146 /* Transfer rules. */
7147 rule_collection_move(&new_group
->rules
, &old_group
->rules
);
7149 if (old_group
->type
!= new_group
->type
) {
7150 ofproto
->n_groups
[old_group
->type
]--;
7151 ofproto
->n_groups
[new_group
->type
]++;
7156 ofproto_group_unref(new_group
);
7160 /* Implements the OFPGC11_ADD_OR_MOD command which creates the group when it does not
7161 * exist yet and modifies it otherwise */
7163 add_or_modify_group_start(struct ofproto
*ofproto
,
7164 struct ofproto_group_mod
*ogm
)
7165 OVS_REQUIRES(ofproto_mutex
)
7169 if (!ofproto_group_exists(ofproto
, ogm
->gm
.group_id
)) {
7170 error
= add_group_start(ofproto
, ogm
);
7172 error
= modify_group_start(ofproto
, ogm
);
7179 delete_group_start(struct ofproto
*ofproto
, ovs_version_t version
,
7180 struct group_collection
*groups
, struct ofgroup
*group
)
7181 OVS_REQUIRES(ofproto_mutex
)
7183 /* Makes flow deletion code leave the rule pointers in 'group->rules'
7184 * intact, so that we can later refer to the rules deleted due to the group
7185 * deletion. Rule pointers will be removed from all other groups, if any,
7186 * so we will never try to delete the same rule twice. */
7187 group
->being_deleted
= true;
7189 /* Mark all the referring groups for deletion. */
7190 delete_flows_start__(ofproto
, version
, &group
->rules
);
7191 group_collection_add(groups
, group
);
7192 versions_set_remove_version(&group
->versions
, version
);
7193 ofproto
->n_groups
[group
->type
]--;
7197 delete_group_finish(struct ofproto
*ofproto
, struct ofgroup
*group
)
7198 OVS_REQUIRES(ofproto_mutex
)
7200 /* Finish deletion of all flow entries containing this group in a group
7202 delete_flows_finish__(ofproto
, &group
->rules
, OFPRR_GROUP_DELETE
, NULL
);
7204 /* Group removal is postponed by the caller. */
7207 /* Implements OFPGC11_DELETE. */
7209 delete_groups_start(struct ofproto
*ofproto
, struct ofproto_group_mod
*ogm
)
7210 OVS_REQUIRES(ofproto_mutex
)
7212 struct ofgroup
*group
;
7214 if (ogm
->gm
.group_id
== OFPG_ALL
) {
7215 CMAP_FOR_EACH (group
, cmap_node
, &ofproto
->groups
) {
7216 if (versions_visible_in_version(&group
->versions
, ogm
->version
)) {
7217 delete_group_start(ofproto
, ogm
->version
, &ogm
->old_groups
,
7222 group
= ofproto_group_lookup__(ofproto
, ogm
->gm
.group_id
, ogm
->version
);
7224 delete_group_start(ofproto
, ogm
->version
, &ogm
->old_groups
, group
);
7230 ofproto_group_mod_start(struct ofproto
*ofproto
, struct ofproto_group_mod
*ogm
)
7231 OVS_REQUIRES(ofproto_mutex
)
7235 ogm
->new_group
= NULL
;
7236 group_collection_init(&ogm
->old_groups
);
7238 switch (ogm
->gm
.command
) {
7240 error
= add_group_start(ofproto
, ogm
);
7243 case OFPGC11_MODIFY
:
7244 error
= modify_group_start(ofproto
, ogm
);
7247 case OFPGC11_ADD_OR_MOD
:
7248 error
= add_or_modify_group_start(ofproto
, ogm
);
7251 case OFPGC11_DELETE
:
7252 delete_groups_start(ofproto
, ogm
);
7256 case OFPGC15_INSERT_BUCKET
:
7257 error
= modify_group_start(ofproto
, ogm
);
7260 case OFPGC15_REMOVE_BUCKET
:
7261 error
= modify_group_start(ofproto
, ogm
);
7265 if (ogm
->gm
.command
> OFPGC11_DELETE
) {
7266 VLOG_INFO_RL(&rl
, "%s: Invalid group_mod command type %d",
7267 ofproto
->name
, ogm
->gm
.command
);
7269 error
= OFPERR_OFPGMFC_BAD_COMMAND
;
7276 ofproto_group_mod_revert(struct ofproto
*ofproto
,
7277 struct ofproto_group_mod
*ogm
)
7278 OVS_REQUIRES(ofproto_mutex
)
7280 struct ofgroup
*new_group
= ogm
->new_group
;
7281 struct ofgroup
*old_group
;
7283 /* Restore replaced or deleted groups. */
7284 GROUP_COLLECTION_FOR_EACH (old_group
, &ogm
->old_groups
) {
7285 ofproto
->n_groups
[old_group
->type
]++;
7287 ovs_assert(group_collection_n(&ogm
->old_groups
) == 1);
7288 /* Transfer rules back. */
7289 rule_collection_move(&old_group
->rules
, &new_group
->rules
);
7291 old_group
->being_deleted
= false;
7292 /* Revert rule deletion. */
7293 delete_flows_revert__(ofproto
, &old_group
->rules
);
7295 /* Restore visibility. */
7296 versions_set_remove_version(&old_group
->versions
,
7297 OVS_VERSION_NOT_REMOVED
);
7300 /* Remove the new group immediately. It was never visible to
7302 cmap_remove(&ofproto
->groups
, &new_group
->cmap_node
,
7303 hash_int(new_group
->group_id
, 0));
7304 ofproto
->n_groups
[new_group
->type
]--;
7305 ofproto_group_unref(new_group
);
7310 ofproto_group_mod_finish(struct ofproto
*ofproto
,
7311 struct ofproto_group_mod
*ogm
,
7312 const struct openflow_mod_requester
*req
)
7313 OVS_REQUIRES(ofproto_mutex
)
7315 struct ofgroup
*new_group
= ogm
->new_group
;
7316 struct ofgroup
*old_group
;
7318 if (new_group
&& group_collection_n(&ogm
->old_groups
) &&
7319 ofproto
->ofproto_class
->group_modify
) {
7320 /* Modify a group. */
7321 ovs_assert(group_collection_n(&ogm
->old_groups
) == 1);
7323 /* XXX: OK to lose old group's stats? */
7324 ofproto
->ofproto_class
->group_modify(new_group
);
7327 /* Delete old groups. */
7328 GROUP_COLLECTION_FOR_EACH(old_group
, &ogm
->old_groups
) {
7329 delete_group_finish(ofproto
, old_group
);
7331 remove_groups_postponed(&ogm
->old_groups
);
7334 struct ofputil_requestforward rf
;
7335 rf
.xid
= req
->request
->xid
;
7336 rf
.reason
= OFPRFR_GROUP_MOD
;
7337 rf
.group_mod
= &ogm
->gm
;
7338 connmgr_send_requestforward(ofproto
->connmgr
, req
->ofconn
, &rf
);
7342 /* Delete all groups from 'ofproto'.
7344 * This is intended for use within an ofproto provider's 'destruct'
7347 ofproto_group_delete_all(struct ofproto
*ofproto
)
7348 OVS_EXCLUDED(ofproto_mutex
)
7350 struct ofproto_group_mod ogm
;
7352 ogm
.gm
.command
= OFPGC11_DELETE
;
7353 ogm
.gm
.group_id
= OFPG_ALL
;
7355 ovs_mutex_lock(&ofproto_mutex
);
7356 ogm
.version
= ofproto
->tables_version
+ 1;
7357 ofproto_group_mod_start(ofproto
, &ogm
);
7358 ofproto_bump_tables_version(ofproto
);
7359 ofproto_group_mod_finish(ofproto
, &ogm
, NULL
);
7360 ovs_mutex_unlock(&ofproto_mutex
);
7364 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7365 OVS_EXCLUDED(ofproto_mutex
)
7367 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
7368 struct ofproto_group_mod ogm
;
7371 error
= reject_slave_controller(ofconn
);
7376 error
= ofputil_decode_group_mod(oh
, &ogm
.gm
);
7381 ovs_mutex_lock(&ofproto_mutex
);
7382 ogm
.version
= ofproto
->tables_version
+ 1;
7383 error
= ofproto_group_mod_start(ofproto
, &ogm
);
7385 struct openflow_mod_requester req
= { ofconn
, oh
};
7387 ofproto_bump_tables_version(ofproto
);
7388 ofproto_group_mod_finish(ofproto
, &ogm
, &req
);
7389 ofmonitor_flush(ofproto
->connmgr
);
7391 ovs_mutex_unlock(&ofproto_mutex
);
7393 ofputil_uninit_group_mod(&ogm
.gm
);
7398 enum ofputil_table_miss
7399 ofproto_table_get_miss_config(const struct ofproto
*ofproto
, uint8_t table_id
)
7401 enum ofputil_table_miss miss
;
7403 atomic_read_relaxed(&ofproto
->tables
[table_id
].miss_config
, &miss
);
7408 table_mod__(struct oftable
*oftable
,
7409 const struct ofputil_table_mod
*tm
)
7411 if (tm
->miss
== OFPUTIL_TABLE_MISS_DEFAULT
) {
7412 /* This is how an OFPT_TABLE_MOD decodes if it doesn't specify any
7413 * table-miss configuration (because the protocol used doesn't have
7414 * such a concept), so there's nothing to do. */
7416 atomic_store_relaxed(&oftable
->miss_config
, tm
->miss
);
7419 unsigned int new_eviction
= oftable
->eviction
;
7420 if (tm
->eviction
== OFPUTIL_TABLE_EVICTION_ON
) {
7421 new_eviction
|= EVICTION_OPENFLOW
;
7422 } else if (tm
->eviction
== OFPUTIL_TABLE_EVICTION_OFF
) {
7423 new_eviction
&= ~EVICTION_OPENFLOW
;
7426 if (new_eviction
!= oftable
->eviction
) {
7427 ovs_mutex_lock(&ofproto_mutex
);
7428 oftable_configure_eviction(oftable
, new_eviction
,
7429 oftable
->eviction_fields
,
7430 oftable
->n_eviction_fields
);
7431 ovs_mutex_unlock(&ofproto_mutex
);
7434 if (tm
->vacancy
!= OFPUTIL_TABLE_VACANCY_DEFAULT
) {
7435 ovs_mutex_lock(&ofproto_mutex
);
7436 oftable
->vacancy_down
= tm
->table_vacancy
.vacancy_down
;
7437 oftable
->vacancy_up
= tm
->table_vacancy
.vacancy_up
;
7438 if (tm
->vacancy
== OFPUTIL_TABLE_VACANCY_OFF
) {
7439 oftable
->vacancy_event
= 0;
7440 } else if (!oftable
->vacancy_event
) {
7441 uint8_t vacancy
= oftable_vacancy(oftable
);
7442 oftable
->vacancy_event
= (vacancy
< oftable
->vacancy_up
7444 : OFPTR_VACANCY_DOWN
);
7446 ovs_mutex_unlock(&ofproto_mutex
);
7451 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
7453 if (!check_table_id(ofproto
, tm
->table_id
)) {
7454 return OFPERR_OFPTMFC_BAD_TABLE
;
7457 /* Don't allow the eviction flags to be changed (except to the only fixed
7458 * value that OVS supports). OF1.4 says this is normal: "The
7459 * OFPTMPT_EVICTION property usually cannot be modified using a
7460 * OFP_TABLE_MOD request, because the eviction mechanism is switch
7462 if (tm
->eviction_flags
!= UINT32_MAX
7463 && tm
->eviction_flags
!= OFPROTO_EVICTION_FLAGS
) {
7464 return OFPERR_OFPTMFC_BAD_CONFIG
;
7467 if (tm
->table_id
== OFPTT_ALL
) {
7468 struct oftable
*oftable
;
7469 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
7470 if (!(oftable
->flags
& (OFTABLE_HIDDEN
| OFTABLE_READONLY
))) {
7471 table_mod__(oftable
, tm
);
7475 struct oftable
*oftable
= &ofproto
->tables
[tm
->table_id
];
7476 if (oftable
->flags
& OFTABLE_READONLY
) {
7477 return OFPERR_OFPTMFC_EPERM
;
7479 table_mod__(oftable
, tm
);
7486 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7488 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
7489 struct ofputil_table_mod tm
;
7492 error
= reject_slave_controller(ofconn
);
7497 error
= ofputil_decode_table_mod(oh
, &tm
);
7502 return table_mod(ofproto
, &tm
);
7505 /* Free resources that may be allocated by ofproto_flow_mod_init(). */
7507 ofproto_flow_mod_uninit(struct ofproto_flow_mod
*ofm
)
7509 if (ofm
->temp_rule
) {
7510 ofproto_rule_unref(ofm
->temp_rule
);
7511 ofm
->temp_rule
= NULL
;
7513 if (ofm
->criteria
.version
!= OVS_VERSION_NOT_REMOVED
) {
7514 rule_criteria_destroy(&ofm
->criteria
);
7524 ofproto_flow_mod_init(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
7525 const struct ofputil_flow_mod
*fm
, struct rule
*rule
)
7526 OVS_EXCLUDED(ofproto_mutex
)
7530 /* Forward flow mod fields we need later. */
7531 ofm
->command
= fm
->command
;
7532 ofm
->modify_cookie
= fm
->modify_cookie
;
7534 ofm
->modify_may_add_flow
= (fm
->new_cookie
!= OVS_BE64_MAX
7535 && fm
->cookie_mask
== htonll(0));
7536 /* Old flags must be kept when modifying a flow, but we still must
7537 * honor the reset counts flag if present in the flow mod. */
7538 ofm
->modify_keep_counts
= !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
);
7540 /* Initialize state needed by ofproto_flow_mod_uninit(). */
7541 ofm
->temp_rule
= rule
;
7542 ofm
->criteria
.version
= OVS_VERSION_NOT_REMOVED
;
7546 bool check_buffer_id
= false;
7548 switch (ofm
->command
) {
7550 check_buffer_id
= true;
7551 error
= add_flow_init(ofproto
, ofm
, fm
);
7554 check_buffer_id
= true;
7555 error
= modify_flows_init_loose(ofproto
, ofm
, fm
);
7557 case OFPFC_MODIFY_STRICT
:
7558 check_buffer_id
= true;
7559 error
= modify_flow_init_strict(ofproto
, ofm
, fm
);
7562 error
= delete_flows_init_loose(ofproto
, ofm
, fm
);
7564 case OFPFC_DELETE_STRICT
:
7565 error
= delete_flows_init_strict(ofproto
, ofm
, fm
);
7568 error
= OFPERR_OFPFMFC_BAD_COMMAND
;
7571 if (!error
&& check_buffer_id
&& fm
->buffer_id
!= UINT32_MAX
) {
7572 error
= OFPERR_OFPBRC_BUFFER_UNKNOWN
;
7576 ofproto_flow_mod_uninit(ofm
);
7582 ofproto_flow_mod_start(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
7583 OVS_REQUIRES(ofproto_mutex
)
7587 rule_collection_init(&ofm
->old_rules
);
7588 rule_collection_init(&ofm
->new_rules
);
7590 switch (ofm
->command
) {
7592 error
= add_flow_start(ofproto
, ofm
);
7595 error
= modify_flows_start_loose(ofproto
, ofm
);
7597 case OFPFC_MODIFY_STRICT
:
7598 error
= modify_flow_start_strict(ofproto
, ofm
);
7601 error
= delete_flows_start_loose(ofproto
, ofm
);
7603 case OFPFC_DELETE_STRICT
:
7604 error
= delete_flow_start_strict(ofproto
, ofm
);
7609 /* Release resources not needed after start. */
7610 ofproto_flow_mod_uninit(ofm
);
7613 rule_collection_destroy(&ofm
->old_rules
);
7614 rule_collection_destroy(&ofm
->new_rules
);
7620 ofproto_flow_mod_revert(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
7621 OVS_REQUIRES(ofproto_mutex
)
7623 switch (ofm
->command
) {
7625 add_flow_revert(ofproto
, ofm
);
7629 case OFPFC_MODIFY_STRICT
:
7630 modify_flows_revert(ofproto
, ofm
);
7634 case OFPFC_DELETE_STRICT
:
7635 delete_flows_revert(ofproto
, ofm
);
7642 rule_collection_destroy(&ofm
->old_rules
);
7643 rule_collection_destroy(&ofm
->new_rules
);
7647 ofproto_flow_mod_finish(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
7648 const struct openflow_mod_requester
*req
)
7649 OVS_REQUIRES(ofproto_mutex
)
7651 switch (ofm
->command
) {
7653 add_flow_finish(ofproto
, ofm
, req
);
7657 case OFPFC_MODIFY_STRICT
:
7658 modify_flows_finish(ofproto
, ofm
, req
);
7662 case OFPFC_DELETE_STRICT
:
7663 delete_flows_finish(ofproto
, ofm
, req
);
7670 rule_collection_destroy(&ofm
->old_rules
);
7671 rule_collection_destroy(&ofm
->new_rules
);
7674 ofconn_report_flow_mod(req
->ofconn
, ofm
->command
);
7678 /* Commit phases (all while locking ofproto_mutex):
7680 * 1. Begin: Gather resources and make changes visible in the next version.
7681 * - Mark affected rules for removal in the next version.
7682 * - Create new replacement rules, make visible in the next
7684 * - Do not send any events or notifications.
7686 * 2. Revert: Fail if any errors are found. After this point no errors are
7687 * possible. No visible changes were made, so rollback is minimal (remove
7688 * added invisible rules, restore visibility of rules marked for removal).
7690 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
7691 * the ofproto provider. Remove replaced and deleted rules from ofproto data
7692 * structures, and Schedule postponed removal of deleted rules from the
7693 * classifier. Send notifications, buffered packets, etc.
7696 do_bundle_commit(struct ofconn
*ofconn
, uint32_t id
, uint16_t flags
)
7698 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
7699 ovs_version_t version
= ofproto
->tables_version
+ 1;
7700 struct ofp_bundle
*bundle
;
7701 struct ofp_bundle_entry
*be
;
7704 bundle
= ofconn_get_bundle(ofconn
, id
);
7707 return OFPERR_OFPBFC_BAD_ID
;
7709 if (bundle
->flags
!= flags
) {
7710 error
= OFPERR_OFPBFC_BAD_FLAGS
;
7712 bool prev_is_port_mod
= false;
7715 ovs_mutex_lock(&ofproto_mutex
);
7718 LIST_FOR_EACH (be
, node
, &bundle
->msg_list
) {
7719 if (be
->type
== OFPTYPE_PORT_MOD
) {
7720 /* Our port mods are not atomic. */
7721 if (flags
& OFPBF_ATOMIC
) {
7722 error
= OFPERR_OFPBFC_MSG_FAILED
;
7724 prev_is_port_mod
= true;
7725 error
= port_mod_start(ofconn
, &be
->opm
.pm
, &be
->opm
.port
);
7728 /* Flow & group mods between port mods are applied as a single
7729 * version, but the versions are published only after we know
7730 * the commit is successful. */
7731 if (prev_is_port_mod
) {
7732 prev_is_port_mod
= false;
7735 if (be
->type
== OFPTYPE_FLOW_MOD
) {
7736 /* Store the version in which the changes should take
7738 be
->ofm
.version
= version
;
7739 error
= ofproto_flow_mod_start(ofproto
, &be
->ofm
);
7740 } else if (be
->type
== OFPTYPE_GROUP_MOD
) {
7741 /* Store the version in which the changes should take
7743 be
->ogm
.version
= version
;
7744 error
= ofproto_group_mod_start(ofproto
, &be
->ogm
);
7745 } else if (be
->type
== OFPTYPE_PACKET_OUT
) {
7746 be
->opo
.version
= version
;
7747 error
= ofproto_packet_out_start(ofproto
, &be
->opo
);
7758 /* Send error referring to the original message. */
7760 ofconn_send_error(ofconn
, &be
->ofp_msg
, error
);
7761 error
= OFPERR_OFPBFC_MSG_FAILED
;
7764 /* 2. Revert. Undo all the changes made above. */
7765 LIST_FOR_EACH_REVERSE_CONTINUE(be
, node
, &bundle
->msg_list
) {
7766 if (be
->type
== OFPTYPE_FLOW_MOD
) {
7767 ofproto_flow_mod_revert(ofproto
, &be
->ofm
);
7768 } else if (be
->type
== OFPTYPE_GROUP_MOD
) {
7769 ofproto_group_mod_revert(ofproto
, &be
->ogm
);
7770 } else if (be
->type
== OFPTYPE_PACKET_OUT
) {
7771 ofproto_packet_out_revert(ofproto
, &be
->opo
);
7773 /* Nothing needs to be reverted for a port mod. */
7777 LIST_FOR_EACH (be
, node
, &bundle
->msg_list
) {
7778 if (be
->type
== OFPTYPE_PORT_MOD
) {
7779 /* Perform the actual port mod. This is not atomic, i.e.,
7780 * the effects will be immediately seen by upcall
7781 * processing regardless of the lookup version. It should
7782 * be noted that port configuration changes can originate
7783 * also from OVSDB changes asynchronously to all upcall
7785 port_mod_finish(ofconn
, &be
->opm
.pm
, be
->opm
.port
);
7788 (be
->type
== OFPTYPE_FLOW_MOD
) ? be
->ofm
.version
:
7789 (be
->type
== OFPTYPE_GROUP_MOD
) ? be
->ogm
.version
:
7790 (be
->type
== OFPTYPE_PACKET_OUT
) ? be
->opo
.version
:
7793 /* Bump the lookup version to the one of the current
7794 * message. This makes all the changes in the bundle at
7795 * this version visible to lookups at once. */
7796 if (ofproto
->tables_version
< version
) {
7797 ofproto
->tables_version
= version
;
7798 ofproto
->ofproto_class
->set_tables_version(
7799 ofproto
, ofproto
->tables_version
);
7802 struct openflow_mod_requester req
= { ofconn
,
7805 if (be
->type
== OFPTYPE_FLOW_MOD
) {
7806 ofproto_flow_mod_finish(ofproto
, &be
->ofm
, &req
);
7807 } else if (be
->type
== OFPTYPE_GROUP_MOD
) {
7808 ofproto_group_mod_finish(ofproto
, &be
->ogm
, &req
);
7809 } else if (be
->type
== OFPTYPE_PACKET_OUT
) {
7810 ofproto_packet_out_finish(ofproto
, &be
->opo
);
7816 ofmonitor_flush(ofproto
->connmgr
);
7817 ovs_mutex_unlock(&ofproto_mutex
);
7820 /* The bundle is discarded regardless the outcome. */
7821 ofp_bundle_remove__(ofconn
, bundle
);
7826 handle_bundle_control(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7828 struct ofputil_bundle_ctrl_msg bctrl
;
7829 struct ofputil_bundle_ctrl_msg reply
;
7833 error
= reject_slave_controller(ofconn
);
7838 error
= ofputil_decode_bundle_ctrl(oh
, &bctrl
);
7843 reply
.bundle_id
= bctrl
.bundle_id
;
7845 switch (bctrl
.type
) {
7846 case OFPBCT_OPEN_REQUEST
:
7847 error
= ofp_bundle_open(ofconn
, bctrl
.bundle_id
, bctrl
.flags
, oh
);
7848 reply
.type
= OFPBCT_OPEN_REPLY
;
7850 case OFPBCT_CLOSE_REQUEST
:
7851 error
= ofp_bundle_close(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
7852 reply
.type
= OFPBCT_CLOSE_REPLY
;
7854 case OFPBCT_COMMIT_REQUEST
:
7855 error
= do_bundle_commit(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
7856 reply
.type
= OFPBCT_COMMIT_REPLY
;
7858 case OFPBCT_DISCARD_REQUEST
:
7859 error
= ofp_bundle_discard(ofconn
, bctrl
.bundle_id
);
7860 reply
.type
= OFPBCT_DISCARD_REPLY
;
7863 case OFPBCT_OPEN_REPLY
:
7864 case OFPBCT_CLOSE_REPLY
:
7865 case OFPBCT_COMMIT_REPLY
:
7866 case OFPBCT_DISCARD_REPLY
:
7867 return OFPERR_OFPBFC_BAD_TYPE
;
7872 buf
= ofputil_encode_bundle_ctrl_reply(oh
, &reply
);
7873 ofconn_send_reply(ofconn
, buf
);
7879 handle_bundle_add(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7880 OVS_EXCLUDED(ofproto_mutex
)
7882 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
7884 struct ofputil_bundle_add_msg badd
;
7885 struct ofp_bundle_entry
*bmsg
;
7888 error
= reject_slave_controller(ofconn
);
7893 error
= ofputil_decode_bundle_add(oh
, &badd
, &type
);
7898 bmsg
= ofp_bundle_entry_alloc(type
, badd
.msg
);
7900 struct ofpbuf ofpacts
;
7901 uint64_t ofpacts_stub
[1024 / 8];
7902 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
7904 if (type
== OFPTYPE_PORT_MOD
) {
7905 error
= ofputil_decode_port_mod(badd
.msg
, &bmsg
->opm
.pm
, false);
7906 } else if (type
== OFPTYPE_FLOW_MOD
) {
7907 struct ofputil_flow_mod fm
;
7909 error
= ofputil_decode_flow_mod(&fm
, badd
.msg
,
7910 ofconn_get_protocol(ofconn
),
7911 ofproto_get_tun_tab(ofproto
),
7912 &ofproto
->vl_mff_map
, &ofpacts
,
7913 u16_to_ofp(ofproto
->max_ports
),
7916 error
= ofproto_flow_mod_init(ofproto
, &bmsg
->ofm
, &fm
, NULL
);
7918 } else if (type
== OFPTYPE_GROUP_MOD
) {
7919 error
= ofputil_decode_group_mod(badd
.msg
, &bmsg
->ogm
.gm
);
7920 } else if (type
== OFPTYPE_PACKET_OUT
) {
7921 struct ofputil_packet_out po
;
7923 COVERAGE_INC(ofproto_packet_out
);
7925 /* Decode message. */
7926 error
= ofputil_decode_packet_out(&po
, badd
.msg
,
7927 ofproto_get_tun_tab(ofproto
),
7930 po
.ofpacts
= ofpbuf_steal_data(&ofpacts
); /* Move to heap. */
7931 error
= ofproto_packet_out_init(ofproto
, ofconn
, &bmsg
->opo
, &po
);
7937 ofpbuf_uninit(&ofpacts
);
7940 error
= ofp_bundle_add_message(ofconn
, badd
.bundle_id
, badd
.flags
,
7945 ofp_bundle_entry_free(bmsg
);
7952 handle_tlv_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7954 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
7955 struct tun_table
*old_tab
, *new_tab
;
7956 struct ofputil_tlv_table_mod ttm
;
7959 error
= reject_slave_controller(ofconn
);
7964 error
= ofputil_decode_tlv_table_mod(oh
, &ttm
);
7969 old_tab
= ovsrcu_get_protected(struct tun_table
*, &ofproto
->metadata_tab
);
7970 error
= tun_metadata_table_mod(&ttm
, old_tab
, &new_tab
);
7972 ovs_mutex_lock(&ofproto
->vl_mff_map
.mutex
);
7973 error
= mf_vl_mff_map_mod_from_tun_metadata(&ofproto
->vl_mff_map
,
7975 ovs_mutex_unlock(&ofproto
->vl_mff_map
.mutex
);
7977 ovsrcu_set(&ofproto
->metadata_tab
, new_tab
);
7978 tun_metadata_postpone_free(old_tab
);
7980 tun_metadata_free(new_tab
);
7984 ofputil_uninit_tlv_table(&ttm
.mappings
);
7989 handle_tlv_table_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7991 const struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
7992 struct ofputil_tlv_table_reply ttr
;
7995 tun_metadata_table_request(ofproto_get_tun_tab(ofproto
), &ttr
);
7997 b
= ofputil_encode_tlv_table_reply(oh
, &ttr
);
7998 ofputil_uninit_tlv_table(&ttr
.mappings
);
8000 ofconn_send_reply(ofconn
, b
);
8005 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
8006 OVS_EXCLUDED(ofproto_mutex
)
8008 const struct ofp_header
*oh
= msg
->data
;
8012 error
= ofptype_decode(&type
, oh
);
8016 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
8017 && ofpmp_more(oh
)) {
8018 /* We have no buffer implementation for multipart requests.
8019 * Report overflow for requests which consists of multiple
8021 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
8025 /* OpenFlow requests. */
8026 case OFPTYPE_ECHO_REQUEST
:
8027 return handle_echo_request(ofconn
, oh
);
8029 case OFPTYPE_FEATURES_REQUEST
:
8030 return handle_features_request(ofconn
, oh
);
8032 case OFPTYPE_GET_CONFIG_REQUEST
:
8033 return handle_get_config_request(ofconn
, oh
);
8035 case OFPTYPE_SET_CONFIG
:
8036 return handle_set_config(ofconn
, oh
);
8038 case OFPTYPE_PACKET_OUT
:
8039 return handle_packet_out(ofconn
, oh
);
8041 case OFPTYPE_PORT_MOD
:
8042 return handle_port_mod(ofconn
, oh
);
8044 case OFPTYPE_FLOW_MOD
:
8045 return handle_flow_mod(ofconn
, oh
);
8047 case OFPTYPE_GROUP_MOD
:
8048 return handle_group_mod(ofconn
, oh
);
8050 case OFPTYPE_TABLE_MOD
:
8051 return handle_table_mod(ofconn
, oh
);
8053 case OFPTYPE_METER_MOD
:
8054 return handle_meter_mod(ofconn
, oh
);
8056 case OFPTYPE_BARRIER_REQUEST
:
8057 return handle_barrier_request(ofconn
, oh
);
8059 case OFPTYPE_ROLE_REQUEST
:
8060 return handle_role_request(ofconn
, oh
);
8062 /* OpenFlow replies. */
8063 case OFPTYPE_ECHO_REPLY
:
8066 /* Nicira extension requests. */
8067 case OFPTYPE_FLOW_MOD_TABLE_ID
:
8068 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
8070 case OFPTYPE_SET_FLOW_FORMAT
:
8071 return handle_nxt_set_flow_format(ofconn
, oh
);
8073 case OFPTYPE_SET_PACKET_IN_FORMAT
:
8074 return handle_nxt_set_packet_in_format(ofconn
, oh
);
8076 case OFPTYPE_SET_CONTROLLER_ID
:
8077 return handle_nxt_set_controller_id(ofconn
, oh
);
8079 case OFPTYPE_FLOW_AGE
:
8080 /* Nothing to do. */
8083 case OFPTYPE_FLOW_MONITOR_CANCEL
:
8084 return handle_flow_monitor_cancel(ofconn
, oh
);
8086 case OFPTYPE_SET_ASYNC_CONFIG
:
8087 return handle_nxt_set_async_config(ofconn
, oh
);
8089 case OFPTYPE_GET_ASYNC_REQUEST
:
8090 return handle_nxt_get_async_request(ofconn
, oh
);
8092 case OFPTYPE_NXT_RESUME
:
8093 return handle_nxt_resume(ofconn
, oh
);
8095 /* Statistics requests. */
8096 case OFPTYPE_DESC_STATS_REQUEST
:
8097 return handle_desc_stats_request(ofconn
, oh
);
8099 case OFPTYPE_FLOW_STATS_REQUEST
:
8100 return handle_flow_stats_request(ofconn
, oh
);
8102 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
8103 return handle_aggregate_stats_request(ofconn
, oh
);
8105 case OFPTYPE_TABLE_STATS_REQUEST
:
8106 return handle_table_stats_request(ofconn
, oh
);
8108 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
8109 return handle_table_features_request(ofconn
, oh
);
8111 case OFPTYPE_TABLE_DESC_REQUEST
:
8112 return handle_table_desc_request(ofconn
, oh
);
8114 case OFPTYPE_PORT_STATS_REQUEST
:
8115 return handle_port_stats_request(ofconn
, oh
);
8117 case OFPTYPE_QUEUE_STATS_REQUEST
:
8118 return handle_queue_stats_request(ofconn
, oh
);
8120 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
8121 return handle_port_desc_stats_request(ofconn
, oh
);
8123 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
8124 return handle_flow_monitor_request(ofconn
, oh
);
8126 case OFPTYPE_METER_STATS_REQUEST
:
8127 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
8128 return handle_meter_request(ofconn
, oh
, type
);
8130 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
8131 return handle_meter_features_request(ofconn
, oh
);
8133 case OFPTYPE_GROUP_STATS_REQUEST
:
8134 return handle_group_stats_request(ofconn
, oh
);
8136 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
8137 return handle_group_desc_stats_request(ofconn
, oh
);
8139 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
8140 return handle_group_features_stats_request(ofconn
, oh
);
8142 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
8143 return handle_queue_get_config_request(ofconn
, oh
);
8145 case OFPTYPE_BUNDLE_CONTROL
:
8146 return handle_bundle_control(ofconn
, oh
);
8148 case OFPTYPE_BUNDLE_ADD_MESSAGE
:
8149 return handle_bundle_add(ofconn
, oh
);
8151 case OFPTYPE_NXT_TLV_TABLE_MOD
:
8152 return handle_tlv_table_mod(ofconn
, oh
);
8154 case OFPTYPE_NXT_TLV_TABLE_REQUEST
:
8155 return handle_tlv_table_request(ofconn
, oh
);
8157 case OFPTYPE_IPFIX_BRIDGE_STATS_REQUEST
:
8158 return handle_ipfix_bridge_stats_request(ofconn
, oh
);
8160 case OFPTYPE_IPFIX_FLOW_STATS_REQUEST
:
8161 return handle_ipfix_flow_stats_request(ofconn
, oh
);
8163 case OFPTYPE_CT_FLUSH_ZONE
:
8164 return handle_nxt_ct_flush_zone(ofconn
, oh
);
8168 case OFPTYPE_FEATURES_REPLY
:
8169 case OFPTYPE_GET_CONFIG_REPLY
:
8170 case OFPTYPE_PACKET_IN
:
8171 case OFPTYPE_FLOW_REMOVED
:
8172 case OFPTYPE_PORT_STATUS
:
8173 case OFPTYPE_BARRIER_REPLY
:
8174 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
8175 case OFPTYPE_DESC_STATS_REPLY
:
8176 case OFPTYPE_FLOW_STATS_REPLY
:
8177 case OFPTYPE_QUEUE_STATS_REPLY
:
8178 case OFPTYPE_PORT_STATS_REPLY
:
8179 case OFPTYPE_TABLE_STATS_REPLY
:
8180 case OFPTYPE_AGGREGATE_STATS_REPLY
:
8181 case OFPTYPE_PORT_DESC_STATS_REPLY
:
8182 case OFPTYPE_ROLE_REPLY
:
8183 case OFPTYPE_FLOW_MONITOR_PAUSED
:
8184 case OFPTYPE_FLOW_MONITOR_RESUMED
:
8185 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
8186 case OFPTYPE_GET_ASYNC_REPLY
:
8187 case OFPTYPE_GROUP_STATS_REPLY
:
8188 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
8189 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
8190 case OFPTYPE_METER_STATS_REPLY
:
8191 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
8192 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
8193 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
8194 case OFPTYPE_TABLE_DESC_REPLY
:
8195 case OFPTYPE_ROLE_STATUS
:
8196 case OFPTYPE_REQUESTFORWARD
:
8197 case OFPTYPE_TABLE_STATUS
:
8198 case OFPTYPE_NXT_TLV_TABLE_REPLY
:
8199 case OFPTYPE_IPFIX_BRIDGE_STATS_REPLY
:
8200 case OFPTYPE_IPFIX_FLOW_STATS_REPLY
:
8202 if (ofpmsg_is_stat_request(oh
)) {
8203 return OFPERR_OFPBRC_BAD_STAT
;
8205 return OFPERR_OFPBRC_BAD_TYPE
;
8211 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
8212 OVS_EXCLUDED(ofproto_mutex
)
8214 enum ofperr error
= handle_openflow__(ofconn
, ofp_msg
);
8217 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
8219 COVERAGE_INC(ofproto_recv_openflow
);
8223 pick_datapath_id(const struct ofproto
*ofproto
)
8225 const struct ofport
*port
;
8227 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
8232 error
= netdev_get_etheraddr(port
->netdev
, &ea
);
8234 return eth_addr_to_uint64(ea
);
8236 VLOG_WARN("%s: could not get MAC address for %s (%s)",
8237 ofproto
->name
, netdev_get_name(port
->netdev
),
8238 ovs_strerror(error
));
8240 return ofproto
->fallback_dpid
;
8244 pick_fallback_dpid(void)
8247 eth_addr_nicira_random(&ea
);
8248 return eth_addr_to_uint64(ea
);
8251 /* Table overflow policy. */
8253 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
8254 * to NULL if the table is not configured to evict rules or if the table
8255 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
8256 * or with no timeouts are not evictable.) */
8258 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
8259 OVS_REQUIRES(ofproto_mutex
)
8261 struct eviction_group
*evg
;
8264 if (!table
->eviction
) {
8268 /* In the common case, the outer and inner loops here will each be entered
8271 * - The inner loop normally "return"s in its first iteration. If the
8272 * eviction group has any evictable rules, then it always returns in
8275 * - The outer loop only iterates more than once if the largest eviction
8276 * group has no evictable rules.
8278 * - The outer loop can exit only if table's 'max_flows' is all filled up
8279 * by unevictable rules. */
8280 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
8283 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
8292 /* Eviction groups. */
8294 /* Returns the priority to use for an eviction_group that contains 'n_rules'
8295 * rules. The priority contains low-order random bits to ensure that eviction
8296 * groups with the same number of rules are prioritized randomly. */
8298 eviction_group_priority(size_t n_rules
)
8300 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
8301 return (size
<< 16) | random_uint16();
8304 /* Updates 'evg', an eviction_group within 'table', following a change that
8305 * adds or removes rules in 'evg'. */
8307 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
8308 OVS_REQUIRES(ofproto_mutex
)
8310 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
8311 eviction_group_priority(heap_count(&evg
->rules
)));
8314 /* Destroys 'evg', an eviction_group within 'table':
8316 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
8317 * rules themselves, just removes them from the eviction group.)
8319 * - Removes 'evg' from 'table'.
8323 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
8324 OVS_REQUIRES(ofproto_mutex
)
8326 while (!heap_is_empty(&evg
->rules
)) {
8329 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
8330 rule
->eviction_group
= NULL
;
8332 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
8333 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
8334 heap_destroy(&evg
->rules
);
8338 /* Removes 'rule' from its eviction group, if any. */
8340 eviction_group_remove_rule(struct rule
*rule
)
8341 OVS_REQUIRES(ofproto_mutex
)
8343 if (rule
->eviction_group
) {
8344 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
8345 struct eviction_group
*evg
= rule
->eviction_group
;
8347 rule
->eviction_group
= NULL
;
8348 heap_remove(&evg
->rules
, &rule
->evg_node
);
8349 if (heap_is_empty(&evg
->rules
)) {
8350 eviction_group_destroy(table
, evg
);
8352 eviction_group_resized(table
, evg
);
8357 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
8358 * returns the hash value. */
8360 eviction_group_hash_rule(struct rule
*rule
)
8361 OVS_REQUIRES(ofproto_mutex
)
8363 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
8364 const struct mf_subfield
*sf
;
8368 hash
= table
->eviction_group_id_basis
;
8369 miniflow_expand(rule
->cr
.match
.flow
, &flow
);
8370 for (sf
= table
->eviction_fields
;
8371 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
8374 if (mf_are_prereqs_ok(sf
->field
, &flow
, NULL
)) {
8375 union mf_value value
;
8377 mf_get_value(sf
->field
, &flow
, &value
);
8379 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
8381 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
8382 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
8383 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
8384 sf
->field
->n_bytes
* 8 - start
);
8386 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
8388 hash
= hash_int(hash
, 0);
8395 /* Returns an eviction group within 'table' with the given 'id', creating one
8397 static struct eviction_group
*
8398 eviction_group_find(struct oftable
*table
, uint32_t id
)
8399 OVS_REQUIRES(ofproto_mutex
)
8401 struct eviction_group
*evg
;
8403 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
8407 evg
= xmalloc(sizeof *evg
);
8408 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
8409 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
8410 eviction_group_priority(0));
8411 heap_init(&evg
->rules
);
8416 /* Returns an eviction priority for 'rule'. The return value should be
8417 * interpreted so that higher priorities make a rule a more attractive
8418 * candidate for eviction. */
8420 rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*rule
)
8421 OVS_REQUIRES(ofproto_mutex
)
8423 /* Calculate absolute time when this flow will expire. If it will never
8424 * expire, then return 0 to make it unevictable. */
8425 long long int expiration
= LLONG_MAX
;
8426 if (rule
->hard_timeout
) {
8427 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
8428 ovs_mutex_lock(&rule
->mutex
);
8429 long long int modified
= rule
->modified
;
8430 ovs_mutex_unlock(&rule
->mutex
);
8432 expiration
= modified
+ rule
->hard_timeout
* 1000;
8434 if (rule
->idle_timeout
) {
8435 uint64_t packets
, bytes
;
8437 long long int idle_expiration
;
8439 ofproto
->ofproto_class
->rule_get_stats(rule
, &packets
, &bytes
, &used
);
8440 idle_expiration
= used
+ rule
->idle_timeout
* 1000;
8441 expiration
= MIN(expiration
, idle_expiration
);
8443 if (expiration
== LLONG_MAX
) {
8447 /* Calculate the time of expiration as a number of (approximate) seconds
8448 * after program startup.
8450 * This should work OK for program runs that last UINT32_MAX seconds or
8451 * less. Therefore, please restart OVS at least once every 136 years. */
8452 uint32_t expiration_ofs
= (expiration
>> 10) - (time_boot_msec() >> 10);
8454 /* Combine expiration time with OpenFlow "importance" to form a single
8455 * priority value. We want flows with relatively low "importance" to be
8456 * evicted before even considering expiration time, so put "importance" in
8457 * the most significant bits and expiration time in the least significant
8460 * Small 'priority' should be evicted before those with large 'priority'.
8461 * The caller expects the opposite convention (a large return value being
8462 * more attractive for eviction) so we invert it before returning. */
8463 uint64_t priority
= ((uint64_t) rule
->importance
<< 32) + expiration_ofs
;
8464 return UINT64_MAX
- priority
;
8467 /* Adds 'rule' to an appropriate eviction group for its oftable's
8468 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
8469 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
8472 * The caller must ensure that 'rule' is not already in an eviction group. */
8474 eviction_group_add_rule(struct rule
*rule
)
8475 OVS_REQUIRES(ofproto_mutex
)
8477 struct ofproto
*ofproto
= rule
->ofproto
;
8478 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
8481 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
8482 * so no additional protection is needed. */
8483 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
8485 if (table
->eviction
&& has_timeout
) {
8486 struct eviction_group
*evg
;
8488 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
8490 rule
->eviction_group
= evg
;
8491 heap_insert(&evg
->rules
, &rule
->evg_node
,
8492 rule_eviction_priority(ofproto
, rule
));
8493 eviction_group_resized(table
, evg
);
8499 /* Initializes 'table'. */
8501 oftable_init(struct oftable
*table
)
8503 memset(table
, 0, sizeof *table
);
8504 classifier_init(&table
->cls
, flow_segment_u64s
);
8505 table
->max_flows
= UINT_MAX
;
8507 hmap_init(&table
->eviction_groups_by_id
);
8508 heap_init(&table
->eviction_groups_by_size
);
8509 atomic_init(&table
->miss_config
, OFPUTIL_TABLE_MISS_DEFAULT
);
8511 classifier_set_prefix_fields(&table
->cls
, default_prefix_fields
,
8512 ARRAY_SIZE(default_prefix_fields
));
8514 atomic_init(&table
->n_matched
, 0);
8515 atomic_init(&table
->n_missed
, 0);
8518 /* Destroys 'table', including its classifier and eviction groups.
8520 * The caller is responsible for freeing 'table' itself. */
8522 oftable_destroy(struct oftable
*table
)
8524 ovs_assert(classifier_is_empty(&table
->cls
));
8526 ovs_mutex_lock(&ofproto_mutex
);
8527 oftable_configure_eviction(table
, 0, NULL
, 0);
8528 ovs_mutex_unlock(&ofproto_mutex
);
8530 hmap_destroy(&table
->eviction_groups_by_id
);
8531 heap_destroy(&table
->eviction_groups_by_size
);
8532 classifier_destroy(&table
->cls
);
8536 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
8537 * string, then 'table' will use its default name.
8539 * This only affects the name exposed for a table exposed through the OpenFlow
8540 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
8542 oftable_set_name(struct oftable
*table
, const char *name
)
8544 if (name
&& name
[0]) {
8545 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
8546 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
8548 table
->name
= xmemdup0(name
, len
);
8556 /* oftables support a choice of two policies when adding a rule would cause the
8557 * number of flows in the table to exceed the configured maximum number: either
8558 * they can refuse to add the new flow or they can evict some existing flow.
8559 * This function configures the latter policy on 'table', with fairness based
8560 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
8561 * 'n_fields' as 0 disables fairness.) */
8563 oftable_configure_eviction(struct oftable
*table
, unsigned int eviction
,
8564 const struct mf_subfield
*fields
, size_t n_fields
)
8565 OVS_REQUIRES(ofproto_mutex
)
8569 if ((table
->eviction
!= 0) == (eviction
!= 0)
8570 && n_fields
== table
->n_eviction_fields
8572 || !memcmp(fields
, table
->eviction_fields
,
8573 n_fields
* sizeof *fields
))) {
8574 /* The set of eviction fields did not change. If 'eviction' changed,
8575 * it remains nonzero, so that we can just update table->eviction
8576 * without fussing with the eviction groups. */
8577 table
->eviction
= eviction
;
8581 /* Destroy existing eviction groups, then destroy and recreate data
8582 * structures to recover memory. */
8583 struct eviction_group
*evg
, *next
;
8584 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
, &table
->eviction_groups_by_id
) {
8585 eviction_group_destroy(table
, evg
);
8587 hmap_destroy(&table
->eviction_groups_by_id
);
8588 hmap_init(&table
->eviction_groups_by_id
);
8589 heap_destroy(&table
->eviction_groups_by_size
);
8590 heap_init(&table
->eviction_groups_by_size
);
8592 /* Replace eviction groups by the new ones, if there is a change. Free the
8593 * old fields only after allocating the new ones, because 'fields ==
8594 * table->eviction_fields' is possible. */
8595 struct mf_subfield
*old_fields
= table
->eviction_fields
;
8596 table
->n_eviction_fields
= n_fields
;
8597 table
->eviction_fields
= (fields
8598 ? xmemdup(fields
, n_fields
* sizeof *fields
)
8602 /* Add the new eviction groups, if enabled. */
8603 table
->eviction
= eviction
;
8604 if (table
->eviction
) {
8605 table
->eviction_group_id_basis
= random_uint32();
8606 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
8607 eviction_group_add_rule(rule
);
8612 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
8613 * it to the classifier. */
8615 ofproto_rule_insert__(struct ofproto
*ofproto
, struct rule
*rule
)
8616 OVS_REQUIRES(ofproto_mutex
)
8618 const struct rule_actions
*actions
= rule_get_actions(rule
);
8620 /* A rule may not be reinserted. */
8621 ovs_assert(rule
->state
== RULE_INITIALIZED
);
8623 if (rule
->hard_timeout
|| rule
->idle_timeout
) {
8624 ovs_list_insert(&ofproto
->expirable
, &rule
->expirable
);
8626 cookies_insert(ofproto
, rule
);
8627 eviction_group_add_rule(rule
);
8628 if (actions
->has_meter
) {
8629 meter_insert_rule(rule
);
8631 if (actions
->has_groups
) {
8632 const struct ofpact_group
*a
;
8633 OFPACT_FOR_EACH_TYPE_FLATTENED (a
, GROUP
, actions
->ofpacts
,
8634 actions
->ofpacts_len
) {
8635 struct ofgroup
*group
;
8637 group
= ofproto_group_lookup(ofproto
, a
->group_id
, OVS_VERSION_MAX
,
8639 ovs_assert(group
!= NULL
);
8640 group_add_rule(group
, rule
);
8644 rule
->state
= RULE_INSERTED
;
8647 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
8648 * the removal from the classifier. */
8650 ofproto_rule_remove__(struct ofproto
*ofproto
, struct rule
*rule
)
8651 OVS_REQUIRES(ofproto_mutex
)
8653 ovs_assert(rule
->state
== RULE_INSERTED
);
8655 cookies_remove(ofproto
, rule
);
8657 eviction_group_remove_rule(rule
);
8658 if (!ovs_list_is_empty(&rule
->expirable
)) {
8659 ovs_list_remove(&rule
->expirable
);
8661 if (!ovs_list_is_empty(&rule
->meter_list_node
)) {
8662 ovs_list_remove(&rule
->meter_list_node
);
8663 ovs_list_init(&rule
->meter_list_node
);
8666 /* Remove the rule from any groups, except from the group that is being
8667 * deleted, if any. */
8668 const struct rule_actions
*actions
= rule_get_actions(rule
);
8670 if (actions
->has_groups
) {
8671 const struct ofpact_group
*a
;
8673 OFPACT_FOR_EACH_TYPE_FLATTENED(a
, GROUP
, actions
->ofpacts
,
8674 actions
->ofpacts_len
) {
8675 struct ofgroup
*group
;
8677 group
= ofproto_group_lookup(ofproto
, a
->group_id
, OVS_VERSION_MAX
,
8681 /* Leave the rule for the group that is being deleted, if any,
8682 * as we still need the list of rules for clean-up. */
8683 if (!group
->being_deleted
) {
8684 group_remove_rule(group
, rule
);
8689 rule
->state
= RULE_REMOVED
;
8692 /* unixctl commands. */
8695 ofproto_lookup(const char *name
)
8697 struct ofproto
*ofproto
;
8699 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
8701 if (!strcmp(ofproto
->name
, name
)) {
8709 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
8710 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
8712 struct ofproto
*ofproto
;
8716 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
8717 ds_put_format(&results
, "%s\n", ofproto
->name
);
8719 unixctl_command_reply(conn
, ds_cstr(&results
));
8720 ds_destroy(&results
);
8724 ofproto_unixctl_init(void)
8726 static bool registered
;
8732 unixctl_command_register("ofproto/list", "", 0, 0,
8733 ofproto_unixctl_list
, NULL
);
8737 ofproto_set_vlan_limit(int vlan_limit
)
8739 flow_limit_vlans(vlan_limit
);