2 * Copyright (c) 2009-2016 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"
54 #include "poll-loop.h"
57 #include "openvswitch/shash.h"
62 #include "tun-metadata.h"
63 #include "unaligned.h"
67 VLOG_DEFINE_THIS_MODULE(ofproto
);
69 COVERAGE_DEFINE(ofproto_flush
);
70 COVERAGE_DEFINE(ofproto_packet_out
);
71 COVERAGE_DEFINE(ofproto_queue_req
);
72 COVERAGE_DEFINE(ofproto_recv_openflow
);
73 COVERAGE_DEFINE(ofproto_reinit_ports
);
74 COVERAGE_DEFINE(ofproto_update_port
);
76 /* Default fields to use for prefix tries in each flow table, unless something
77 * else is configured. */
78 const enum mf_field_id default_prefix_fields
[2] =
79 { MFF_IPV4_DST
, MFF_IPV4_SRC
};
82 static void oftable_init(struct oftable
*);
83 static void oftable_destroy(struct oftable
*);
85 static void oftable_set_name(struct oftable
*, const char *name
);
87 static enum ofperr
evict_rules_from_table(struct oftable
*)
88 OVS_REQUIRES(ofproto_mutex
);
89 static void oftable_configure_eviction(struct oftable
*,
90 unsigned int eviction
,
91 const struct mf_subfield
*fields
,
93 OVS_REQUIRES(ofproto_mutex
);
95 /* This is the only combination of OpenFlow eviction flags that OVS supports: a
96 * combination of OF1.4+ importance, the remaining lifetime of the flow, and
97 * fairness based on user-specified fields. */
98 #define OFPROTO_EVICTION_FLAGS \
99 (OFPTMPEF14_OTHER | OFPTMPEF14_IMPORTANCE | OFPTMPEF14_LIFETIME)
101 /* A set of rules within a single OpenFlow table (oftable) that have the same
102 * values for the oftable's eviction_fields. A rule to be evicted, when one is
103 * needed, is taken from the eviction group that contains the greatest number
106 * An oftable owns any number of eviction groups, each of which contains any
109 * Membership in an eviction group is imprecise, based on the hash of the
110 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
111 * That is, if two rules have different eviction_fields, but those
112 * eviction_fields hash to the same value, then they will belong to the same
113 * eviction_group anyway.
115 * (When eviction is not enabled on an oftable, we don't track any eviction
116 * groups, to save time and space.) */
117 struct eviction_group
{
118 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
119 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
120 struct heap rules
; /* Contains "struct rule"s. */
123 static bool choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
124 OVS_REQUIRES(ofproto_mutex
);
125 static uint64_t rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*)
126 OVS_REQUIRES(ofproto_mutex
);
127 static void eviction_group_add_rule(struct rule
*)
128 OVS_REQUIRES(ofproto_mutex
);
129 static void eviction_group_remove_rule(struct rule
*)
130 OVS_REQUIRES(ofproto_mutex
);
132 /* Criteria that flow_mod and other operations use for selecting rules on
133 * which to operate. */
134 struct rule_criteria
{
135 /* An OpenFlow table or 255 for all tables. */
138 /* OpenFlow matching criteria. Interpreted different in "loose" way by
139 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
140 * defined in the OpenFlow spec. */
142 ovs_version_t version
;
144 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
145 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
146 * The rule will not be selected if M is 1 and B != C. */
148 ovs_be64 cookie_mask
;
150 /* Selection based on actions within a rule:
152 * If out_port != OFPP_ANY, selects only rules that output to out_port.
153 * If out_group != OFPG_ALL, select only rules that output to out_group. */
157 /* If true, collects only rules that are modifiable. */
159 bool include_readonly
;
162 static void rule_criteria_init(struct rule_criteria
*, uint8_t table_id
,
163 const struct match
*match
, int priority
,
164 ovs_version_t version
,
165 ovs_be64 cookie
, ovs_be64 cookie_mask
,
166 ofp_port_t out_port
, uint32_t out_group
);
167 static void rule_criteria_require_rw(struct rule_criteria
*,
168 bool can_write_readonly
);
169 static void rule_criteria_destroy(struct rule_criteria
*);
171 static enum ofperr
collect_rules_loose(struct ofproto
*,
172 const struct rule_criteria
*,
173 struct rule_collection
*);
175 /* A packet that needs to be passed to rule_execute().
177 * (We can't do this immediately from ofopgroup_complete() because that holds
178 * ofproto_mutex, which rule_execute() needs released.) */
179 struct rule_execute
{
180 struct ovs_list list_node
; /* In struct ofproto's "rule_executes" list. */
181 struct rule
*rule
; /* Owns a reference to the rule. */
183 struct dp_packet
*packet
; /* Owns the packet. */
186 static void run_rule_executes(struct ofproto
*) OVS_EXCLUDED(ofproto_mutex
);
187 static void destroy_rule_executes(struct ofproto
*);
189 struct learned_cookie
{
191 /* In struct ofproto's 'learned_cookies' hmap. */
192 struct hmap_node hmap_node
OVS_GUARDED_BY(ofproto_mutex
);
194 /* In 'dead_cookies' list when removed from hmap. */
195 struct ovs_list list_node
;
199 ovs_be64 cookie
OVS_GUARDED_BY(ofproto_mutex
);
200 uint8_t table_id
OVS_GUARDED_BY(ofproto_mutex
);
202 /* Number of references from "learn" actions.
204 * When this drops to 0, all of the flows in 'table_id' with the specified
205 * 'cookie' are deleted. */
206 int n
OVS_GUARDED_BY(ofproto_mutex
);
209 static const struct ofpact_learn
*next_learn_with_delete(
210 const struct rule_actions
*, const struct ofpact_learn
*start
);
212 static void learned_cookies_inc(struct ofproto
*, const struct rule_actions
*)
213 OVS_REQUIRES(ofproto_mutex
);
214 static void learned_cookies_dec(struct ofproto
*, const struct rule_actions
*,
215 struct ovs_list
*dead_cookies
)
216 OVS_REQUIRES(ofproto_mutex
);
217 static void learned_cookies_flush(struct ofproto
*, struct ovs_list
*dead_cookies
)
218 OVS_REQUIRES(ofproto_mutex
);
221 static void ofport_destroy__(struct ofport
*) OVS_EXCLUDED(ofproto_mutex
);
222 static void ofport_destroy(struct ofport
*, bool del
);
223 static inline bool ofport_is_internal(const struct ofport
*);
225 static int update_port(struct ofproto
*, const char *devname
);
226 static int init_ports(struct ofproto
*);
227 static void reinit_ports(struct ofproto
*);
229 static long long int ofport_get_usage(const struct ofproto
*,
230 ofp_port_t ofp_port
);
231 static void ofport_set_usage(struct ofproto
*, ofp_port_t ofp_port
,
232 long long int last_used
);
233 static void ofport_remove_usage(struct ofproto
*, ofp_port_t ofp_port
);
237 * Keeps track of the currently used and recently used ofport values and is
238 * used to prevent immediate recycling of ofport values. */
239 struct ofport_usage
{
240 struct hmap_node hmap_node
; /* In struct ofproto's "ofport_usage" hmap. */
241 ofp_port_t ofp_port
; /* OpenFlow port number. */
242 long long int last_used
; /* Last time the 'ofp_port' was used. LLONG_MAX
243 represents in-use ofports. */
247 static void ofproto_rule_send_removed(struct rule
*)
248 OVS_EXCLUDED(ofproto_mutex
);
249 static bool rule_is_readonly(const struct rule
*);
250 static void ofproto_rule_insert__(struct ofproto
*, struct rule
*)
251 OVS_REQUIRES(ofproto_mutex
);
252 static void ofproto_rule_remove__(struct ofproto
*, struct rule
*)
253 OVS_REQUIRES(ofproto_mutex
);
255 /* The source of a flow_mod request, in the code that processes flow_mods.
257 * A flow table modification request can be generated externally, via OpenFlow,
258 * or internally through a function call. This structure indicates the source
259 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
260 * meaningful and thus supplied as NULL. */
261 struct flow_mod_requester
{
262 struct ofconn
*ofconn
; /* Connection on which flow_mod arrived. */
263 const struct ofp_header
*request
;
267 static enum ofperr
replace_rule_create(struct ofproto
*,
268 struct ofputil_flow_mod
*,
269 struct cls_rule
*cr
, uint8_t table_id
,
270 struct rule
*old_rule
,
271 struct rule
**new_rule
)
272 OVS_REQUIRES(ofproto_mutex
);
274 static void replace_rule_start(struct ofproto
*, ovs_version_t version
,
275 struct rule
*old_rule
, struct rule
*new_rule
,
276 struct cls_conjunction
*, size_t n_conjs
)
277 OVS_REQUIRES(ofproto_mutex
);
279 static void replace_rule_revert(struct ofproto
*, struct rule
*old_rule
,
280 struct rule
*new_rule
)
281 OVS_REQUIRES(ofproto_mutex
);
283 static void replace_rule_finish(struct ofproto
*, struct ofputil_flow_mod
*,
284 const struct flow_mod_requester
*,
285 struct rule
*old_rule
, struct rule
*new_rule
,
286 struct ovs_list
*dead_cookies
)
287 OVS_REQUIRES(ofproto_mutex
);
288 static void delete_flows__(struct rule_collection
*,
289 enum ofp_flow_removed_reason
,
290 const struct flow_mod_requester
*)
291 OVS_REQUIRES(ofproto_mutex
);
293 static void send_buffered_packet(const struct flow_mod_requester
*,
294 uint32_t buffer_id
, struct rule
*)
295 OVS_REQUIRES(ofproto_mutex
);
297 static bool ofproto_group_exists(const struct ofproto
*, uint32_t group_id
);
298 static enum ofperr
add_group(struct ofproto
*,
299 const struct ofputil_group_mod
*);
300 static void handle_openflow(struct ofconn
*, const struct ofpbuf
*);
301 static enum ofperr
ofproto_flow_mod_start(struct ofproto
*,
302 struct ofproto_flow_mod
*)
303 OVS_REQUIRES(ofproto_mutex
);
304 static void ofproto_flow_mod_finish(struct ofproto
*,
305 struct ofproto_flow_mod
*,
306 const struct flow_mod_requester
*)
307 OVS_REQUIRES(ofproto_mutex
);
308 static enum ofperr
handle_flow_mod__(struct ofproto
*,
309 struct ofproto_flow_mod
*,
310 const struct flow_mod_requester
*)
311 OVS_EXCLUDED(ofproto_mutex
);
312 static void calc_duration(long long int start
, long long int now
,
313 uint32_t *sec
, uint32_t *nsec
);
316 static uint64_t pick_datapath_id(const struct ofproto
*);
317 static uint64_t pick_fallback_dpid(void);
318 static void ofproto_destroy__(struct ofproto
*);
319 static void update_mtu(struct ofproto
*, struct ofport
*);
320 static void update_mtu_ofproto(struct ofproto
*);
321 static void meter_delete(struct ofproto
*, uint32_t first
, uint32_t last
);
322 static void meter_insert_rule(struct rule
*);
325 static void ofproto_unixctl_init(void);
327 /* All registered ofproto classes, in probe order. */
328 static const struct ofproto_class
**ofproto_classes
;
329 static size_t n_ofproto_classes
;
330 static size_t allocated_ofproto_classes
;
332 /* Global lock that protects all flow table operations. */
333 struct ovs_mutex ofproto_mutex
= OVS_MUTEX_INITIALIZER
;
335 unsigned ofproto_flow_limit
= OFPROTO_FLOW_LIMIT_DEFAULT
;
336 unsigned ofproto_max_idle
= OFPROTO_MAX_IDLE_DEFAULT
;
338 size_t n_handlers
, n_revalidators
;
341 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
342 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
344 /* Initial mappings of port to OpenFlow number mappings. */
345 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
347 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
349 /* The default value of true waits for flow restore. */
350 static bool flow_restore_wait
= true;
352 /* Must be called to initialize the ofproto library.
354 * The caller may pass in 'iface_hints', which contains an shash of
355 * "iface_hint" elements indexed by the interface's name. The provider
356 * may use these hints to describe the startup configuration in order to
357 * reinitialize its state. The caller owns the provided data, so a
358 * provider will make copies of anything required. An ofproto provider
359 * will remove any existing state that is not described by the hint, and
360 * may choose to remove it all. */
362 ofproto_init(const struct shash
*iface_hints
)
364 struct shash_node
*node
;
367 ofproto_class_register(&ofproto_dpif_class
);
369 /* Make a local copy, since we don't own 'iface_hints' elements. */
370 SHASH_FOR_EACH(node
, iface_hints
) {
371 const struct iface_hint
*orig_hint
= node
->data
;
372 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
373 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
375 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
376 new_hint
->br_type
= xstrdup(br_type
);
377 new_hint
->ofp_port
= orig_hint
->ofp_port
;
379 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
382 for (i
= 0; i
< n_ofproto_classes
; i
++) {
383 ofproto_classes
[i
]->init(&init_ofp_ports
);
386 ofproto_unixctl_init();
389 /* 'type' should be a normalized datapath type, as returned by
390 * ofproto_normalize_type(). Returns the corresponding ofproto_class
391 * structure, or a null pointer if there is none registered for 'type'. */
392 static const struct ofproto_class
*
393 ofproto_class_find__(const char *type
)
397 for (i
= 0; i
< n_ofproto_classes
; i
++) {
398 const struct ofproto_class
*class = ofproto_classes
[i
];
403 class->enumerate_types(&types
);
404 found
= sset_contains(&types
, type
);
405 sset_destroy(&types
);
411 VLOG_WARN("unknown datapath type %s", type
);
415 /* Registers a new ofproto class. After successful registration, new ofprotos
416 * of that type can be created using ofproto_create(). */
418 ofproto_class_register(const struct ofproto_class
*new_class
)
422 for (i
= 0; i
< n_ofproto_classes
; i
++) {
423 if (ofproto_classes
[i
] == new_class
) {
428 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
429 ofproto_classes
= x2nrealloc(ofproto_classes
,
430 &allocated_ofproto_classes
,
431 sizeof *ofproto_classes
);
433 ofproto_classes
[n_ofproto_classes
++] = new_class
;
437 /* Unregisters a datapath provider. 'type' must have been previously
438 * registered and not currently be in use by any ofprotos. After
439 * unregistration new datapaths of that type cannot be opened using
440 * ofproto_create(). */
442 ofproto_class_unregister(const struct ofproto_class
*class)
446 for (i
= 0; i
< n_ofproto_classes
; i
++) {
447 if (ofproto_classes
[i
] == class) {
448 for (i
++; i
< n_ofproto_classes
; i
++) {
449 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
455 VLOG_WARN("attempted to unregister an ofproto class that is not "
460 /* Clears 'types' and enumerates all registered ofproto types into it. The
461 * caller must first initialize the sset. */
463 ofproto_enumerate_types(struct sset
*types
)
468 for (i
= 0; i
< n_ofproto_classes
; i
++) {
469 ofproto_classes
[i
]->enumerate_types(types
);
473 /* Returns the fully spelled out name for the given ofproto 'type'.
475 * Normalized type string can be compared with strcmp(). Unnormalized type
476 * string might be the same even if they have different spellings. */
478 ofproto_normalize_type(const char *type
)
480 return type
&& type
[0] ? type
: "system";
483 /* Clears 'names' and enumerates the names of all known created ofprotos with
484 * the given 'type'. The caller must first initialize the sset. Returns 0 if
485 * successful, otherwise a positive errno value.
487 * Some kinds of datapaths might not be practically enumerable. This is not
488 * considered an error. */
490 ofproto_enumerate_names(const char *type
, struct sset
*names
)
492 const struct ofproto_class
*class = ofproto_class_find__(type
);
493 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
497 ofproto_bump_tables_version(struct ofproto
*ofproto
)
499 ++ofproto
->tables_version
;
500 ofproto
->ofproto_class
->set_tables_version(ofproto
,
501 ofproto
->tables_version
);
505 ofproto_create(const char *datapath_name
, const char *datapath_type
,
506 struct ofproto
**ofprotop
)
508 const struct ofproto_class
*class;
509 struct ofproto
*ofproto
;
515 datapath_type
= ofproto_normalize_type(datapath_type
);
516 class = ofproto_class_find__(datapath_type
);
518 VLOG_WARN("could not create datapath %s of unknown type %s",
519 datapath_name
, datapath_type
);
523 ofproto
= class->alloc();
525 VLOG_ERR("failed to allocate datapath %s of type %s",
526 datapath_name
, datapath_type
);
531 ovs_mutex_lock(&ofproto_mutex
);
532 memset(ofproto
, 0, sizeof *ofproto
);
533 ofproto
->ofproto_class
= class;
534 ofproto
->name
= xstrdup(datapath_name
);
535 ofproto
->type
= xstrdup(datapath_type
);
536 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
537 hash_string(ofproto
->name
, 0));
538 ofproto
->datapath_id
= 0;
539 ofproto
->forward_bpdu
= false;
540 ofproto
->fallback_dpid
= pick_fallback_dpid();
541 ofproto
->mfr_desc
= NULL
;
542 ofproto
->hw_desc
= NULL
;
543 ofproto
->sw_desc
= NULL
;
544 ofproto
->serial_desc
= NULL
;
545 ofproto
->dp_desc
= NULL
;
546 ofproto
->frag_handling
= OFPUTIL_FRAG_NORMAL
;
547 hmap_init(&ofproto
->ports
);
548 hmap_init(&ofproto
->ofport_usage
);
549 shash_init(&ofproto
->port_by_name
);
550 simap_init(&ofproto
->ofp_requests
);
551 ofproto
->max_ports
= ofp_to_u16(OFPP_MAX
);
552 ofproto
->eviction_group_timer
= LLONG_MIN
;
553 ofproto
->tables
= NULL
;
554 ofproto
->n_tables
= 0;
555 ofproto
->tables_version
= OVS_VERSION_MIN
;
556 hindex_init(&ofproto
->cookies
);
557 hmap_init(&ofproto
->learned_cookies
);
558 ovs_list_init(&ofproto
->expirable
);
559 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
560 guarded_list_init(&ofproto
->rule_executes
);
561 ofproto
->min_mtu
= INT_MAX
;
562 ovs_rwlock_init(&ofproto
->groups_rwlock
);
563 cmap_init(&ofproto
->groups
);
564 ovs_mutex_unlock(&ofproto_mutex
);
565 ofproto
->ogf
.types
= 0xf;
566 ofproto
->ogf
.capabilities
= OFPGFC_CHAINING
| OFPGFC_SELECT_LIVENESS
|
567 OFPGFC_SELECT_WEIGHT
;
568 for (i
= 0; i
< 4; i
++) {
569 ofproto
->ogf
.max_groups
[i
] = OFPG_MAX
;
570 ofproto
->ogf
.ofpacts
[i
] = (UINT64_C(1) << N_OFPACTS
) - 1;
574 error
= ofproto
->ofproto_class
->construct(ofproto
);
576 VLOG_ERR("failed to open datapath %s: %s",
577 datapath_name
, ovs_strerror(error
));
578 connmgr_destroy(ofproto
->connmgr
);
579 ofproto_destroy__(ofproto
);
583 /* Check that hidden tables, if any, are at the end. */
584 ovs_assert(ofproto
->n_tables
);
585 for (i
= 0; i
+ 1 < ofproto
->n_tables
; i
++) {
586 enum oftable_flags flags
= ofproto
->tables
[i
].flags
;
587 enum oftable_flags next_flags
= ofproto
->tables
[i
+ 1].flags
;
589 ovs_assert(!(flags
& OFTABLE_HIDDEN
) || next_flags
& OFTABLE_HIDDEN
);
592 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
595 /* Initialize meters table. */
596 if (ofproto
->ofproto_class
->meter_get_features
) {
597 ofproto
->ofproto_class
->meter_get_features(ofproto
,
598 &ofproto
->meter_features
);
600 memset(&ofproto
->meter_features
, 0, sizeof ofproto
->meter_features
);
602 ofproto
->meters
= xzalloc((ofproto
->meter_features
.max_meters
+ 1)
603 * sizeof(struct meter
*));
605 /* Set the initial tables version. */
606 ofproto_bump_tables_version(ofproto
);
612 /* Must be called (only) by an ofproto implementation in its constructor
613 * function. See the large comment on 'construct' in struct ofproto_class for
616 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
618 struct oftable
*table
;
620 ovs_assert(!ofproto
->n_tables
);
621 ovs_assert(n_tables
>= 1 && n_tables
<= 255);
623 ofproto
->n_tables
= n_tables
;
624 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
625 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
630 /* To be optionally called (only) by an ofproto implementation in its
631 * constructor function. See the large comment on 'construct' in struct
632 * ofproto_class for details.
634 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
635 * will then ensure that actions passed into the ofproto implementation will
636 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
637 * function is not called, there will be no such restriction.
639 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
640 * the 'max_ports' restriction. */
642 ofproto_init_max_ports(struct ofproto
*ofproto
, uint16_t max_ports
)
644 ovs_assert(max_ports
<= ofp_to_u16(OFPP_MAX
));
645 ofproto
->max_ports
= max_ports
;
649 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
651 return ofproto
->datapath_id
;
655 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
657 uint64_t old_dpid
= p
->datapath_id
;
658 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
659 if (p
->datapath_id
!= old_dpid
) {
660 /* Force all active connections to reconnect, since there is no way to
661 * notify a controller that the datapath ID has changed. */
662 ofproto_reconnect_controllers(p
);
667 ofproto_set_controllers(struct ofproto
*p
,
668 const struct ofproto_controller
*controllers
,
669 size_t n_controllers
, uint32_t allowed_versions
)
671 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
,
676 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
678 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
681 /* Drops the connections between 'ofproto' and all of its controllers, forcing
682 * them to reconnect. */
684 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
686 connmgr_reconnect(ofproto
->connmgr
);
689 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
690 * in-band control should guarantee access, in the same way that in-band
691 * control guarantees access to OpenFlow controllers. */
693 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
694 const struct sockaddr_in
*extras
, size_t n
)
696 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
699 /* Sets the OpenFlow queue used by flows set up by in-band control on
700 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
701 * flows will use the default queue. */
703 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
705 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
708 /* Sets the number of flows at which eviction from the kernel flow table
711 ofproto_set_flow_limit(unsigned limit
)
713 ofproto_flow_limit
= limit
;
716 /* Sets the maximum idle time for flows in the datapath before they are
719 ofproto_set_max_idle(unsigned max_idle
)
721 ofproto_max_idle
= max_idle
;
724 /* If forward_bpdu is true, the NORMAL action will forward frames with
725 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
726 * the NORMAL action will drop these frames. */
728 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
730 bool old_val
= ofproto
->forward_bpdu
;
731 ofproto
->forward_bpdu
= forward_bpdu
;
732 if (old_val
!= ofproto
->forward_bpdu
) {
733 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
734 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
739 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
740 * 'idle_time', in seconds, and the maximum number of MAC table entries to
743 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
746 if (ofproto
->ofproto_class
->set_mac_table_config
) {
747 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
752 /* Multicast snooping configuration. */
754 /* Configures multicast snooping on 'ofproto' using the settings
755 * defined in 's'. If 's' is NULL, disables multicast snooping.
757 * Returns 0 if successful, otherwise a positive errno value. */
759 ofproto_set_mcast_snooping(struct ofproto
*ofproto
,
760 const struct ofproto_mcast_snooping_settings
*s
)
762 return (ofproto
->ofproto_class
->set_mcast_snooping
763 ? ofproto
->ofproto_class
->set_mcast_snooping(ofproto
, s
)
767 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
769 * Returns 0 if successful, otherwise a positive errno value.*/
771 ofproto_port_set_mcast_snooping(struct ofproto
*ofproto
, void *aux
,
772 const struct ofproto_mcast_snooping_port_settings
*s
)
774 return (ofproto
->ofproto_class
->set_mcast_snooping_port
775 ? ofproto
->ofproto_class
->set_mcast_snooping_port(ofproto
, aux
, s
)
780 ofproto_set_cpu_mask(const char *cmask
)
783 pmd_cpu_mask
= nullable_xstrdup(cmask
);
787 ofproto_set_threads(int n_handlers_
, int n_revalidators_
)
789 int threads
= MAX(count_cpu_cores(), 2);
791 n_revalidators
= MAX(n_revalidators_
, 0);
792 n_handlers
= MAX(n_handlers_
, 0);
794 if (!n_revalidators
) {
795 n_revalidators
= n_handlers
796 ? MAX(threads
- (int) n_handlers
, 1)
801 n_handlers
= MAX(threads
- (int) n_revalidators
, 1);
806 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
809 p
->dp_desc
= nullable_xstrdup(dp_desc
);
813 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
815 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
819 ofproto_set_netflow(struct ofproto
*ofproto
,
820 const struct netflow_options
*nf_options
)
822 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
826 if (ofproto
->ofproto_class
->set_netflow
) {
827 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
829 return nf_options
? EOPNOTSUPP
: 0;
834 ofproto_set_sflow(struct ofproto
*ofproto
,
835 const struct ofproto_sflow_options
*oso
)
837 if (oso
&& sset_is_empty(&oso
->targets
)) {
841 if (ofproto
->ofproto_class
->set_sflow
) {
842 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
844 return oso
? EOPNOTSUPP
: 0;
849 ofproto_set_ipfix(struct ofproto
*ofproto
,
850 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
851 const struct ofproto_ipfix_flow_exporter_options
*fo
,
854 if (ofproto
->ofproto_class
->set_ipfix
) {
855 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
857 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
862 ofproto_get_ipfix_stats(struct ofproto
*ofproto
,
864 struct ovs_list
*replies
)
868 if (ofproto
->ofproto_class
->get_ipfix_stats
) {
869 error
= ofproto
->ofproto_class
->get_ipfix_stats(ofproto
,
880 handle_ipfix_bridge_stats_request(struct ofconn
*ofconn
,
881 const struct ofp_header
*request
)
883 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
884 struct ovs_list replies
;
887 ofpmp_init(&replies
, request
);
888 error
= ofproto_get_ipfix_stats(ofproto
, true, &replies
);
891 ofconn_send_replies(ofconn
, &replies
);
893 ofpbuf_list_delete(&replies
);
900 handle_ipfix_flow_stats_request(struct ofconn
*ofconn
,
901 const struct ofp_header
*request
)
903 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
904 struct ovs_list replies
;
907 ofpmp_init(&replies
, request
);
908 error
= ofproto_get_ipfix_stats(ofproto
, false, &replies
);
911 ofconn_send_replies(ofconn
, &replies
);
913 ofpbuf_list_delete(&replies
);
920 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
922 flow_restore_wait
= flow_restore_wait_db
;
926 ofproto_get_flow_restore_wait(void)
928 return flow_restore_wait
;
932 /* Spanning Tree Protocol (STP) configuration. */
934 /* Configures STP on 'ofproto' using the settings defined in 's'. If
935 * 's' is NULL, disables STP.
937 * Returns 0 if successful, otherwise a positive errno value. */
939 ofproto_set_stp(struct ofproto
*ofproto
,
940 const struct ofproto_stp_settings
*s
)
942 return (ofproto
->ofproto_class
->set_stp
943 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
947 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
948 * 'enabled' member of 's' is false, then the other members are not
951 * Returns 0 if successful, otherwise a positive errno value. */
953 ofproto_get_stp_status(struct ofproto
*ofproto
,
954 struct ofproto_stp_status
*s
)
956 return (ofproto
->ofproto_class
->get_stp_status
957 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
961 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
962 * in 's'. The caller is responsible for assigning STP port numbers
963 * (using the 'port_num' member in the range of 1 through 255, inclusive)
964 * and ensuring there are no duplicates. If the 's' is NULL, then STP
965 * is disabled on the port.
967 * Returns 0 if successful, otherwise a positive errno value.*/
969 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
970 const struct ofproto_port_stp_settings
*s
)
972 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
974 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
975 ofproto
->name
, ofp_port
);
979 return (ofproto
->ofproto_class
->set_stp_port
980 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
984 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
985 * 's'. If the 'enabled' member in 's' is false, then the other members
986 * are not meaningful.
988 * Returns 0 if successful, otherwise a positive errno value.*/
990 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
991 struct ofproto_port_stp_status
*s
)
993 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
995 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
996 "port %"PRIu16
, ofproto
->name
, ofp_port
);
1000 return (ofproto
->ofproto_class
->get_stp_port_status
1001 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
1005 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
1006 * 's'. If the 'enabled' member in 's' is false, then the other members
1007 * are not meaningful.
1009 * Returns 0 if successful, otherwise a positive errno value.*/
1011 ofproto_port_get_stp_stats(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1012 struct ofproto_port_stp_stats
*s
)
1014 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1016 VLOG_WARN_RL(&rl
, "%s: cannot get STP stats on nonexistent "
1017 "port %"PRIu16
, ofproto
->name
, ofp_port
);
1021 return (ofproto
->ofproto_class
->get_stp_port_stats
1022 ? ofproto
->ofproto_class
->get_stp_port_stats(ofport
, s
)
1026 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
1028 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
1029 * 's' is NULL, disables RSTP.
1031 * Returns 0 if successful, otherwise a positive errno value. */
1033 ofproto_set_rstp(struct ofproto
*ofproto
,
1034 const struct ofproto_rstp_settings
*s
)
1036 if (!ofproto
->ofproto_class
->set_rstp
) {
1039 ofproto
->ofproto_class
->set_rstp(ofproto
, s
);
1043 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
1044 * 'enabled' member of 's' is false, then the other members are not
1047 * Returns 0 if successful, otherwise a positive errno value. */
1049 ofproto_get_rstp_status(struct ofproto
*ofproto
,
1050 struct ofproto_rstp_status
*s
)
1052 if (!ofproto
->ofproto_class
->get_rstp_status
) {
1055 ofproto
->ofproto_class
->get_rstp_status(ofproto
, s
);
1059 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1060 * in 's'. The caller is responsible for assigning RSTP port numbers
1061 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1062 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1063 * is disabled on the port.
1065 * Returns 0 if successful, otherwise a positive errno value.*/
1067 ofproto_port_set_rstp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1068 const struct ofproto_port_rstp_settings
*s
)
1070 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1072 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16
,
1073 ofproto
->name
, ofp_port
);
1077 if (!ofproto
->ofproto_class
->set_rstp_port
) {
1080 ofproto
->ofproto_class
->set_rstp_port(ofport
, s
);
1084 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1085 * 's'. If the 'enabled' member in 's' is false, then the other members
1086 * are not meaningful.
1088 * Returns 0 if successful, otherwise a positive errno value.*/
1090 ofproto_port_get_rstp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1091 struct ofproto_port_rstp_status
*s
)
1093 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1095 VLOG_WARN_RL(&rl
, "%s: cannot get RSTP status on nonexistent "
1096 "port %"PRIu16
, ofproto
->name
, ofp_port
);
1100 if (!ofproto
->ofproto_class
->get_rstp_port_status
) {
1103 ofproto
->ofproto_class
->get_rstp_port_status(ofport
, s
);
1107 /* Queue DSCP configuration. */
1109 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1110 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1111 * to implement QoS. Instead, it is used to implement features which require
1112 * knowledge of what queues exist on a port, and some basic information about
1115 * Returns 0 if successful, otherwise a positive errno value. */
1117 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1118 const struct ofproto_port_queue
*queues
,
1121 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1124 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
1125 ofproto
->name
, ofp_port
);
1129 return (ofproto
->ofproto_class
->set_queues
1130 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
1134 /* LLDP configuration. */
1136 ofproto_port_set_lldp(struct ofproto
*ofproto
,
1137 ofp_port_t ofp_port
,
1138 const struct smap
*cfg
)
1140 struct ofport
*ofport
;
1143 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1145 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16
,
1146 ofproto
->name
, ofp_port
);
1149 error
= (ofproto
->ofproto_class
->set_lldp
1150 ? ofproto
->ofproto_class
->set_lldp(ofport
, cfg
)
1153 VLOG_WARN("%s: lldp configuration on port %"PRIu16
" (%s) failed (%s)",
1154 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1155 ovs_strerror(error
));
1160 ofproto_set_aa(struct ofproto
*ofproto
, void *aux OVS_UNUSED
,
1161 const struct aa_settings
*s
)
1163 if (!ofproto
->ofproto_class
->set_aa
) {
1166 ofproto
->ofproto_class
->set_aa(ofproto
, s
);
1171 ofproto_aa_mapping_register(struct ofproto
*ofproto
, void *aux
,
1172 const struct aa_mapping_settings
*s
)
1174 if (!ofproto
->ofproto_class
->aa_mapping_set
) {
1177 ofproto
->ofproto_class
->aa_mapping_set(ofproto
, aux
, s
);
1182 ofproto_aa_mapping_unregister(struct ofproto
*ofproto
, void *aux
)
1184 if (!ofproto
->ofproto_class
->aa_mapping_unset
) {
1187 ofproto
->ofproto_class
->aa_mapping_unset(ofproto
, aux
);
1192 ofproto_aa_vlan_get_queued(struct ofproto
*ofproto
,
1193 struct ovs_list
*list
)
1195 if (!ofproto
->ofproto_class
->aa_vlan_get_queued
) {
1198 ofproto
->ofproto_class
->aa_vlan_get_queued(ofproto
, list
);
1203 ofproto_aa_vlan_get_queue_size(struct ofproto
*ofproto
)
1205 if (!ofproto
->ofproto_class
->aa_vlan_get_queue_size
) {
1208 return ofproto
->ofproto_class
->aa_vlan_get_queue_size(ofproto
);
1211 /* Connectivity Fault Management configuration. */
1213 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1215 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1217 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1218 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
1219 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
1223 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1224 * basic configuration from the configuration members in 'cfm', and the remote
1225 * maintenance point ID from remote_mpid. Ignores the statistics members of
1228 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1230 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1231 const struct cfm_settings
*s
)
1233 struct ofport
*ofport
;
1236 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1238 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
1239 ofproto
->name
, ofp_port
);
1243 /* XXX: For configuration simplicity, we only support one remote_mpid
1244 * outside of the CFM module. It's not clear if this is the correct long
1245 * term solution or not. */
1246 error
= (ofproto
->ofproto_class
->set_cfm
1247 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
1250 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
1251 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1252 ovs_strerror(error
));
1256 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1257 * 'ofproto' does not have a port 'ofp_port'. */
1259 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1260 const struct smap
*cfg
)
1262 struct ofport
*ofport
;
1265 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1267 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16
,
1268 ofproto
->name
, ofp_port
);
1272 error
= (ofproto
->ofproto_class
->set_bfd
1273 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
1276 VLOG_WARN("%s: bfd configuration on port %"PRIu16
" (%s) failed (%s)",
1277 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1278 ovs_strerror(error
));
1282 /* Checks the status change of BFD on 'ofport'.
1284 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1286 ofproto_port_bfd_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1288 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1289 return (ofport
&& ofproto
->ofproto_class
->bfd_status_changed
1290 ? ofproto
->ofproto_class
->bfd_status_changed(ofport
)
1294 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1295 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1296 * is not an OpenFlow port in 'ofproto'.
1298 * The caller must provide and own '*status'. */
1300 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1301 struct smap
*status
)
1303 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1304 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
1305 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
1309 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1310 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1311 * 0 if LACP partner information is not current (generally indicating a
1312 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1314 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1316 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1317 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
1318 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
1323 ofproto_port_get_lacp_stats(const struct ofport
*port
, struct lacp_slave_stats
*stats
)
1325 struct ofproto
*ofproto
= port
->ofproto
;
1328 if (ofproto
->ofproto_class
->port_get_lacp_stats
) {
1329 error
= ofproto
->ofproto_class
->port_get_lacp_stats(port
, stats
);
1339 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1340 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1341 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1342 * configuration plus, if there is more than one slave, a bonding
1345 * If 'aux' is already registered then this function updates its configuration
1346 * to 's'. Otherwise, this function registers a new bundle.
1348 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1351 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
1352 const struct ofproto_bundle_settings
*s
)
1354 return (ofproto
->ofproto_class
->bundle_set
1355 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
1359 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1360 * If no such bundle has been registered, this has no effect. */
1362 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
1364 return ofproto_bundle_register(ofproto
, aux
, NULL
);
1368 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1369 * If 'aux' is already registered then this function updates its configuration
1370 * to 's'. Otherwise, this function registers a new mirror. */
1372 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
1373 const struct ofproto_mirror_settings
*s
)
1375 return (ofproto
->ofproto_class
->mirror_set
1376 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
1380 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1381 * If no mirror has been registered, this has no effect. */
1383 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
1385 return ofproto_mirror_register(ofproto
, aux
, NULL
);
1388 /* Retrieves statistics from mirror associated with client data pointer
1389 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1390 * 'bytes', respectively. If a particular counters is not supported,
1391 * the appropriate argument is set to UINT64_MAX.
1394 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
1395 uint64_t *packets
, uint64_t *bytes
)
1397 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
1398 *packets
= *bytes
= UINT64_MAX
;
1402 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
1406 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1407 * which all packets are flooded, instead of using MAC learning. If
1408 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1410 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1413 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
1415 return (ofproto
->ofproto_class
->set_flood_vlans
1416 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
1420 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1421 * output for a mirror. */
1423 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
1425 return (ofproto
->ofproto_class
->is_mirror_output_bundle
1426 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
1430 /* Configuration of OpenFlow tables. */
1432 /* Returns the number of OpenFlow tables in 'ofproto'. */
1434 ofproto_get_n_tables(const struct ofproto
*ofproto
)
1436 return ofproto
->n_tables
;
1439 /* Returns the number of Controller visible OpenFlow tables
1440 * in 'ofproto'. This number will exclude Hidden tables.
1441 * This funtion's return value should be less or equal to that of
1442 * ofproto_get_n_tables() . */
1444 ofproto_get_n_visible_tables(const struct ofproto
*ofproto
)
1446 uint8_t n
= ofproto
->n_tables
;
1448 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1449 * if present, are always at the end.) */
1450 while(n
&& (ofproto
->tables
[n
- 1].flags
& OFTABLE_HIDDEN
)) {
1457 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1458 * settings from 's'. 'table_id' must be in the range 0 through the number of
1459 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1461 * For read-only tables, only the name may be configured. */
1463 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
1464 const struct ofproto_table_settings
*s
)
1466 struct oftable
*table
;
1468 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
1469 table
= &ofproto
->tables
[table_id
];
1471 oftable_set_name(table
, s
->name
);
1473 if (table
->flags
& OFTABLE_READONLY
) {
1477 if (classifier_set_prefix_fields(&table
->cls
,
1478 s
->prefix_fields
, s
->n_prefix_fields
)) {
1479 /* XXX: Trigger revalidation. */
1482 ovs_mutex_lock(&ofproto_mutex
);
1483 unsigned int new_eviction
= (s
->enable_eviction
1484 ? table
->eviction
| EVICTION_CLIENT
1485 : table
->eviction
& ~EVICTION_CLIENT
);
1486 oftable_configure_eviction(table
, new_eviction
, s
->groups
, s
->n_groups
);
1487 table
->max_flows
= s
->max_flows
;
1488 evict_rules_from_table(table
);
1489 ovs_mutex_unlock(&ofproto_mutex
);
1493 ofproto_has_snoops(const struct ofproto
*ofproto
)
1495 return connmgr_has_snoops(ofproto
->connmgr
);
1499 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1501 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1504 /* Deletes 'rule' from 'ofproto'.
1506 * Within an ofproto implementation, this function allows an ofproto
1507 * implementation to destroy any rules that remain when its ->destruct()
1508 * function is called. This function is not suitable for use elsewhere in an
1509 * ofproto implementation.
1511 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1512 * Cycle" in ofproto-provider.h. */
1514 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1515 OVS_EXCLUDED(ofproto_mutex
)
1517 /* This skips the ofmonitor and flow-removed notifications because the
1518 * switch is being deleted and any OpenFlow channels have been or soon will
1520 ovs_mutex_lock(&ofproto_mutex
);
1522 if (!rule
->removed
) {
1523 /* Make sure there is no postponed removal of the rule. */
1524 ovs_assert(cls_rule_visible_in_version(&rule
->cr
, OVS_VERSION_MAX
));
1526 if (!classifier_remove(&rule
->ofproto
->tables
[rule
->table_id
].cls
,
1530 ofproto_rule_remove__(rule
->ofproto
, rule
);
1531 if (ofproto
->ofproto_class
->rule_delete
) {
1532 ofproto
->ofproto_class
->rule_delete(rule
);
1534 ofproto_rule_unref(rule
);
1536 ovs_mutex_unlock(&ofproto_mutex
);
1540 ofproto_flush__(struct ofproto
*ofproto
)
1541 OVS_EXCLUDED(ofproto_mutex
)
1543 struct oftable
*table
;
1545 /* This will flush all datapath flows. */
1546 if (ofproto
->ofproto_class
->flush
) {
1547 ofproto
->ofproto_class
->flush(ofproto
);
1550 /* XXX: There is a small race window here, where new datapath flows can be
1551 * created by upcall handlers based on the existing flow table. We can not
1552 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1553 * as then we could deadlock on syncing with the handler threads waiting on
1554 * the same mutex. */
1556 ovs_mutex_lock(&ofproto_mutex
);
1557 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1558 struct rule_collection rules
;
1561 if (table
->flags
& OFTABLE_HIDDEN
) {
1565 rule_collection_init(&rules
);
1567 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1568 rule_collection_add(&rules
, rule
);
1570 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
1572 /* XXX: Concurrent handler threads may insert new learned flows based on
1573 * learn actions of the now deleted flows right after we release
1574 * 'ofproto_mutex'. */
1575 ovs_mutex_unlock(&ofproto_mutex
);
1578 static void delete_group(struct ofproto
*ofproto
, uint32_t group_id
);
1581 ofproto_destroy__(struct ofproto
*ofproto
)
1582 OVS_EXCLUDED(ofproto_mutex
)
1584 struct oftable
*table
;
1586 destroy_rule_executes(ofproto
);
1588 guarded_list_destroy(&ofproto
->rule_executes
);
1589 ovs_rwlock_destroy(&ofproto
->groups_rwlock
);
1590 cmap_destroy(&ofproto
->groups
);
1592 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1593 free(ofproto
->name
);
1594 free(ofproto
->type
);
1595 free(ofproto
->mfr_desc
);
1596 free(ofproto
->hw_desc
);
1597 free(ofproto
->sw_desc
);
1598 free(ofproto
->serial_desc
);
1599 free(ofproto
->dp_desc
);
1600 hmap_destroy(&ofproto
->ports
);
1601 hmap_destroy(&ofproto
->ofport_usage
);
1602 shash_destroy(&ofproto
->port_by_name
);
1603 simap_destroy(&ofproto
->ofp_requests
);
1605 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1606 oftable_destroy(table
);
1608 free(ofproto
->tables
);
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
;
1641 meter_delete(p
, 1, p
->meter_features
.max_meters
);
1642 p
->meter_features
.max_meters
= 0;
1648 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1649 ofport_destroy(ofport
, del
);
1652 HMAP_FOR_EACH_POP (usage
, hmap_node
, &p
->ofport_usage
) {
1656 p
->ofproto_class
->destruct(p
);
1658 /* We should not postpone this because it involves deleting a listening
1659 * socket which we may want to reopen soon. 'connmgr' should not be used
1660 * by other threads */
1661 connmgr_destroy(p
->connmgr
);
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 run_rule_executes(p
);
1736 /* Restore the eviction group heap invariant occasionally. */
1737 if (p
->eviction_group_timer
< time_msec()) {
1740 p
->eviction_group_timer
= time_msec() + 1000;
1742 for (i
= 0; i
< p
->n_tables
; i
++) {
1743 struct oftable
*table
= &p
->tables
[i
];
1744 struct eviction_group
*evg
;
1747 if (!table
->eviction
) {
1751 if (table
->n_flows
> 100000) {
1752 static struct vlog_rate_limit count_rl
=
1753 VLOG_RATE_LIMIT_INIT(1, 1);
1754 VLOG_WARN_RL(&count_rl
, "Table %"PRIuSIZE
" has an excessive"
1755 " number of rules: %d", i
, table
->n_flows
);
1758 ovs_mutex_lock(&ofproto_mutex
);
1759 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1760 if (rule
->idle_timeout
|| rule
->hard_timeout
) {
1761 if (!rule
->eviction_group
) {
1762 eviction_group_add_rule(rule
);
1764 heap_raw_change(&rule
->evg_node
,
1765 rule_eviction_priority(p
, rule
));
1770 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1771 heap_rebuild(&evg
->rules
);
1773 ovs_mutex_unlock(&ofproto_mutex
);
1777 if (p
->ofproto_class
->port_poll
) {
1780 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1781 process_port_change(p
, error
, devname
);
1785 new_seq
= seq_read(connectivity_seq_get());
1786 if (new_seq
!= p
->change_seq
) {
1787 struct sset devnames
;
1788 const char *devname
;
1789 struct ofport
*ofport
;
1791 /* Update OpenFlow port status for any port whose netdev has changed.
1793 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1794 * destroyed, so it's not safe to update ports directly from the
1795 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1796 * need this two-phase approach. */
1797 sset_init(&devnames
);
1798 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1799 uint64_t port_change_seq
;
1801 port_change_seq
= netdev_get_change_seq(ofport
->netdev
);
1802 if (ofport
->change_seq
!= port_change_seq
) {
1803 ofport
->change_seq
= port_change_seq
;
1804 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1807 SSET_FOR_EACH (devname
, &devnames
) {
1808 update_port(p
, devname
);
1810 sset_destroy(&devnames
);
1812 p
->change_seq
= new_seq
;
1815 connmgr_run(p
->connmgr
, handle_openflow
);
1821 ofproto_wait(struct ofproto
*p
)
1823 p
->ofproto_class
->wait(p
);
1824 if (p
->ofproto_class
->port_poll_wait
) {
1825 p
->ofproto_class
->port_poll_wait(p
);
1827 seq_wait(connectivity_seq_get(), p
->change_seq
);
1828 connmgr_wait(p
->connmgr
);
1832 ofproto_is_alive(const struct ofproto
*p
)
1834 return connmgr_has_controllers(p
->connmgr
);
1837 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1838 * memory_report(). */
1840 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1842 const struct oftable
*table
;
1843 unsigned int n_rules
;
1845 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1848 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1849 n_rules
+= table
->n_flows
;
1851 simap_increase(usage
, "rules", n_rules
);
1853 if (ofproto
->ofproto_class
->get_memory_usage
) {
1854 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1857 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1861 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1863 const struct ofproto_class
*class;
1865 datapath_type
= ofproto_normalize_type(datapath_type
);
1866 class = ofproto_class_find__(datapath_type
);
1868 if (class && class->type_get_memory_usage
) {
1869 class->type_get_memory_usage(datapath_type
, usage
);
1874 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1877 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1881 ofproto_free_ofproto_controller_info(struct shash
*info
)
1883 connmgr_free_controller_info(info
);
1886 /* Makes a deep copy of 'old' into 'port'. */
1888 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1890 port
->name
= xstrdup(old
->name
);
1891 port
->type
= xstrdup(old
->type
);
1892 port
->ofp_port
= old
->ofp_port
;
1895 /* Frees memory allocated to members of 'ofproto_port'.
1897 * Do not call this function on an ofproto_port obtained from
1898 * ofproto_port_dump_next(): that function retains ownership of the data in the
1901 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1903 free(ofproto_port
->name
);
1904 free(ofproto_port
->type
);
1907 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1909 * This function provides no status indication. An error status for the entire
1910 * dump operation is provided when it is completed by calling
1911 * ofproto_port_dump_done().
1914 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1915 const struct ofproto
*ofproto
)
1917 dump
->ofproto
= ofproto
;
1918 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1922 /* Attempts to retrieve another port from 'dump', which must have been created
1923 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1924 * 'port' and returns true. On failure, returns false.
1926 * Failure might indicate an actual error or merely that the last port has been
1927 * dumped. An error status for the entire dump operation is provided when it
1928 * is completed by calling ofproto_port_dump_done().
1930 * The ofproto owns the data stored in 'port'. It will remain valid until at
1931 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1932 * ofproto_port_dump_done(). */
1934 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1935 struct ofproto_port
*port
)
1937 const struct ofproto
*ofproto
= dump
->ofproto
;
1943 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1946 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1952 /* Completes port table dump operation 'dump', which must have been created
1953 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1954 * error-free, otherwise a positive errno value describing the problem. */
1956 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1958 const struct ofproto
*ofproto
= dump
->ofproto
;
1960 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1963 return dump
->error
== EOF
? 0 : dump
->error
;
1966 /* Returns the type to pass to netdev_open() when a datapath of type
1967 * 'datapath_type' has a port of type 'port_type', for a few special
1968 * cases when a netdev type differs from a port type. For example, when
1969 * using the userspace datapath, a port of type "internal" needs to be
1972 * Returns either 'type' itself or a string literal, which must not be
1975 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1977 const struct ofproto_class
*class;
1979 datapath_type
= ofproto_normalize_type(datapath_type
);
1980 class = ofproto_class_find__(datapath_type
);
1985 return (class->port_open_type
1986 ? class->port_open_type(datapath_type
, port_type
)
1990 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1991 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1992 * the port's OpenFlow port number.
1994 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1995 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1996 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1997 * 'ofp_portp' is non-null). */
1999 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
2000 ofp_port_t
*ofp_portp
)
2002 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
2005 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
2007 const char *netdev_name
= netdev_get_name(netdev
);
2009 simap_put(&ofproto
->ofp_requests
, netdev_name
,
2010 ofp_to_u16(ofp_port
));
2011 error
= update_port(ofproto
, netdev_name
);
2014 *ofp_portp
= OFPP_NONE
;
2016 struct ofproto_port ofproto_port
;
2018 error
= ofproto_port_query_by_name(ofproto
,
2019 netdev_get_name(netdev
),
2022 *ofp_portp
= ofproto_port
.ofp_port
;
2023 ofproto_port_destroy(&ofproto_port
);
2030 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
2031 * initializes '*port' appropriately; on failure, returns a positive errno
2034 * The caller owns the data in 'ofproto_port' and must free it with
2035 * ofproto_port_destroy() when it is no longer needed. */
2037 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
2038 struct ofproto_port
*port
)
2042 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
2044 memset(port
, 0, sizeof *port
);
2049 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
2050 * Returns 0 if successful, otherwise a positive errno. */
2052 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2054 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2055 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
2056 struct simap_node
*ofp_request_node
;
2059 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
2060 if (ofp_request_node
) {
2061 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
2064 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
2065 if (!error
&& ofport
) {
2066 /* 'name' is the netdev's name and update_port() is going to close the
2067 * netdev. Just in case update_port() refers to 'name' after it
2068 * destroys 'ofport', make a copy of it around the update_port()
2070 char *devname
= xstrdup(name
);
2071 update_port(ofproto
, devname
);
2077 /* Refreshes datapath configuration of port number 'ofp_port' in 'ofproto'.
2079 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
2081 ofproto_port_set_config(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2082 const struct smap
*cfg
)
2084 struct ofport
*ofport
;
2087 ofport
= ofproto_get_port(ofproto
, ofp_port
);
2089 VLOG_WARN("%s: cannot configure datapath on nonexistent port %"PRIu16
,
2090 ofproto
->name
, ofp_port
);
2094 error
= (ofproto
->ofproto_class
->port_set_config
2095 ? ofproto
->ofproto_class
->port_set_config(ofport
, cfg
)
2098 VLOG_WARN("%s: datapath configuration on port %"PRIu16
2099 " (%s) failed (%s)",
2100 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
2101 ovs_strerror(error
));
2107 flow_mod_init(struct ofputil_flow_mod
*fm
,
2108 const struct match
*match
, int priority
,
2109 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
2110 enum ofp_flow_mod_command command
)
2112 *fm
= (struct ofputil_flow_mod
) {
2114 .priority
= priority
,
2117 .buffer_id
= UINT32_MAX
,
2118 .out_port
= OFPP_ANY
,
2119 .out_group
= OFPG_ANY
,
2120 .ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
),
2121 .ofpacts_len
= ofpacts_len
,
2122 .delete_reason
= OFPRR_DELETE
,
2127 simple_flow_mod(struct ofproto
*ofproto
,
2128 const struct match
*match
, int priority
,
2129 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
2130 enum ofp_flow_mod_command command
)
2132 struct ofproto_flow_mod ofm
;
2134 flow_mod_init(&ofm
.fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
2136 return handle_flow_mod__(ofproto
, &ofm
, NULL
);
2139 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2140 * performs the 'n_actions' actions in 'actions'. The new flow will not
2143 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2144 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2145 * controllers; otherwise, it will be hidden.
2147 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2149 * This is a helper function for in-band control and fail-open. */
2151 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
2153 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2154 OVS_EXCLUDED(ofproto_mutex
)
2156 const struct rule
*rule
;
2159 /* First do a cheap check whether the rule we're looking for already exists
2160 * with the actions that we want. If it does, then we're done. */
2161 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2162 &ofproto
->tables
[0].cls
, match
, priority
,
2165 const struct rule_actions
*actions
= rule_get_actions(rule
);
2166 must_add
= !ofpacts_equal(actions
->ofpacts
, actions
->ofpacts_len
,
2167 ofpacts
, ofpacts_len
);
2172 /* If there's no such rule or the rule doesn't have the actions we want,
2173 * fall back to a executing a full flow mod. We can't optimize this at
2174 * all because we didn't take enough locks above to ensure that the flow
2175 * table didn't already change beneath us. */
2177 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
2178 OFPFC_MODIFY_STRICT
);
2182 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2183 * an OFPERR_* OpenFlow error code on failure.
2185 * This is a helper function for in-band control and fail-open and the "learn"
2188 ofproto_flow_mod(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
2189 OVS_EXCLUDED(ofproto_mutex
)
2191 struct ofputil_flow_mod
*fm
= &ofm
->fm
;
2193 /* Optimize for the most common case of a repeated learn action.
2194 * If an identical flow already exists we only need to update its
2195 * 'modified' time. */
2196 if (fm
->command
== OFPFC_MODIFY_STRICT
&& fm
->table_id
!= OFPTT_ALL
2197 && !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
)) {
2198 struct oftable
*table
= &ofproto
->tables
[fm
->table_id
];
2202 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2203 &table
->cls
, &fm
->match
, fm
->priority
,
2206 /* Reading many of the rule fields and writing on 'modified'
2207 * requires the rule->mutex. Also, rule->actions may change
2208 * if rule->mutex is not held. */
2209 const struct rule_actions
*actions
;
2211 ovs_mutex_lock(&rule
->mutex
);
2212 actions
= rule_get_actions(rule
);
2213 if (rule
->idle_timeout
== fm
->idle_timeout
2214 && rule
->hard_timeout
== fm
->hard_timeout
2215 && rule
->importance
== fm
->importance
2216 && rule
->flags
== (fm
->flags
& OFPUTIL_FF_STATE
)
2217 && (!fm
->modify_cookie
|| (fm
->new_cookie
== rule
->flow_cookie
))
2218 && ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
2219 actions
->ofpacts
, actions
->ofpacts_len
)) {
2220 /* Rule already exists and need not change, only update the
2221 modified timestamp. */
2222 rule
->modified
= time_msec();
2225 ovs_mutex_unlock(&rule
->mutex
);
2233 return handle_flow_mod__(ofproto
, ofm
, NULL
);
2236 /* Searches for a rule with matching criteria exactly equal to 'target' in
2237 * ofproto's table 0 and, if it finds one, deletes it.
2239 * This is a helper function for in-band control and fail-open. */
2241 ofproto_delete_flow(struct ofproto
*ofproto
,
2242 const struct match
*target
, int priority
)
2243 OVS_EXCLUDED(ofproto_mutex
)
2245 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
2248 /* First do a cheap check whether the rule we're looking for has already
2249 * been deleted. If so, then we're done. */
2250 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2251 cls
, target
, priority
, OVS_VERSION_MAX
));
2256 /* Execute a flow mod. We can't optimize this at all because we didn't
2257 * take enough locks above to ensure that the flow table didn't already
2258 * change beneath us. */
2259 simple_flow_mod(ofproto
, target
, priority
, NULL
, 0, OFPFC_DELETE_STRICT
);
2262 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2263 * the flows required by in-band control and fail-open. */
2265 ofproto_flush_flows(struct ofproto
*ofproto
)
2267 COVERAGE_INC(ofproto_flush
);
2268 ofproto_flush__(ofproto
);
2269 connmgr_flushed(ofproto
->connmgr
);
2273 reinit_ports(struct ofproto
*p
)
2275 struct ofproto_port_dump dump
;
2276 struct sset devnames
;
2277 struct ofport
*ofport
;
2278 struct ofproto_port ofproto_port
;
2279 const char *devname
;
2281 COVERAGE_INC(ofproto_reinit_ports
);
2283 sset_init(&devnames
);
2284 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2285 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
2287 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2288 sset_add(&devnames
, ofproto_port
.name
);
2291 SSET_FOR_EACH (devname
, &devnames
) {
2292 update_port(p
, devname
);
2294 sset_destroy(&devnames
);
2298 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2302 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2303 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2305 if (port_idx
>= ofproto
->max_ports
2306 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2307 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2308 long long int last_used_at
, lru
= LLONG_MAX
;
2310 /* Search for a free OpenFlow port number. We try not to
2311 * immediately reuse them to prevent problems due to old
2314 * We limit the automatically assigned port numbers to the lower half
2315 * of the port range, to reserve the upper half for assignment by
2318 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2319 ofproto
->alloc_port_no
= 1;
2321 last_used_at
= ofport_get_usage(ofproto
,
2322 u16_to_ofp(ofproto
->alloc_port_no
));
2323 if (!last_used_at
) {
2324 port_idx
= ofproto
->alloc_port_no
;
2326 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2327 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2328 * more than an hour ago, consider it usable. */
2329 ofport_remove_usage(ofproto
,
2330 u16_to_ofp(ofproto
->alloc_port_no
));
2331 port_idx
= ofproto
->alloc_port_no
;
2333 } else if (last_used_at
< lru
) {
2335 lru_ofport
= ofproto
->alloc_port_no
;
2338 if (ofproto
->alloc_port_no
== end_port_no
) {
2340 port_idx
= lru_ofport
;
2347 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2348 return u16_to_ofp(port_idx
);
2352 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2354 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2355 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2359 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2360 * pointer if the netdev cannot be opened. On success, also fills in
2362 static struct netdev
*
2363 ofport_open(struct ofproto
*ofproto
,
2364 struct ofproto_port
*ofproto_port
,
2365 struct ofputil_phy_port
*pp
)
2367 enum netdev_flags flags
;
2368 struct netdev
*netdev
;
2371 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2373 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
2374 "cannot be opened (%s)",
2376 ofproto_port
->name
, ofproto_port
->ofp_port
,
2377 ofproto_port
->name
, ovs_strerror(error
));
2381 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2382 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2383 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2385 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2386 ofproto_port
->name
);
2389 pp
->port_no
= ofproto_port
->ofp_port
;
2390 netdev_get_etheraddr(netdev
, &pp
->hw_addr
);
2391 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2392 netdev_get_flags(netdev
, &flags
);
2393 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2394 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2395 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2396 &pp
->supported
, &pp
->peer
);
2397 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2398 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2403 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2404 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2407 ofport_equal(const struct ofputil_phy_port
*a
,
2408 const struct ofputil_phy_port
*b
)
2410 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2411 && a
->state
== b
->state
2412 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2413 && a
->curr
== b
->curr
2414 && a
->advertised
== b
->advertised
2415 && a
->supported
== b
->supported
2416 && a
->peer
== b
->peer
2417 && a
->curr_speed
== b
->curr_speed
2418 && a
->max_speed
== b
->max_speed
);
2421 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2422 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2423 * one with the same name or port number). */
2425 ofport_install(struct ofproto
*p
,
2426 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2428 const char *netdev_name
= netdev_get_name(netdev
);
2429 struct ofport
*ofport
;
2432 /* Create ofport. */
2433 ofport
= p
->ofproto_class
->port_alloc();
2438 ofport
->ofproto
= p
;
2439 ofport
->netdev
= netdev
;
2440 ofport
->change_seq
= netdev_get_change_seq(netdev
);
2442 ofport
->ofp_port
= pp
->port_no
;
2443 ofport
->created
= time_msec();
2445 /* Add port to 'p'. */
2446 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2447 hash_ofp_port(ofport
->ofp_port
));
2448 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2450 update_mtu(p
, ofport
);
2452 /* Let the ofproto_class initialize its private data. */
2453 error
= p
->ofproto_class
->port_construct(ofport
);
2457 connmgr_send_port_status(p
->connmgr
, NULL
, pp
, OFPPR_ADD
);
2461 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2462 p
->name
, netdev_name
, ovs_strerror(error
));
2464 ofport_destroy__(ofport
);
2466 netdev_close(netdev
);
2471 /* Removes 'ofport' from 'p' and destroys it. */
2473 ofport_remove(struct ofport
*ofport
)
2475 struct ofproto
*p
= ofport
->ofproto
;
2476 bool is_internal
= ofport_is_internal(ofport
);
2478 connmgr_send_port_status(ofport
->ofproto
->connmgr
, NULL
, &ofport
->pp
,
2480 ofport_destroy(ofport
, true);
2482 update_mtu_ofproto(p
);
2486 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2489 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2491 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2493 ofport_remove(port
);
2497 /* Updates 'port' with new 'pp' description.
2499 * Does not handle a name or port number change. The caller must implement
2500 * such a change as a delete followed by an add. */
2502 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2504 port
->pp
.hw_addr
= pp
->hw_addr
;
2505 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2506 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2507 port
->pp
.state
= ((port
->pp
.state
& ~OFPUTIL_PS_LINK_DOWN
)
2508 | (pp
->state
& OFPUTIL_PS_LINK_DOWN
));
2509 port
->pp
.curr
= pp
->curr
;
2510 port
->pp
.advertised
= pp
->advertised
;
2511 port
->pp
.supported
= pp
->supported
;
2512 port
->pp
.peer
= pp
->peer
;
2513 port
->pp
.curr_speed
= pp
->curr_speed
;
2514 port
->pp
.max_speed
= pp
->max_speed
;
2516 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2517 &port
->pp
, OFPPR_MODIFY
);
2520 /* Update OpenFlow 'state' in 'port' and notify controller. */
2522 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2524 if (port
->pp
.state
!= state
) {
2525 port
->pp
.state
= state
;
2526 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2527 &port
->pp
, OFPPR_MODIFY
);
2532 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2534 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2536 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2537 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2539 if (port
->ofproto
->ofproto_class
->set_rstp_port
) {
2540 port
->ofproto
->ofproto_class
->set_rstp_port(port
, NULL
);
2542 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2543 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2545 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2546 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2552 ofport_destroy__(struct ofport
*port
)
2554 struct ofproto
*ofproto
= port
->ofproto
;
2555 const char *name
= netdev_get_name(port
->netdev
);
2557 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2558 shash_delete(&ofproto
->port_by_name
,
2559 shash_find(&ofproto
->port_by_name
, name
));
2561 netdev_close(port
->netdev
);
2562 ofproto
->ofproto_class
->port_dealloc(port
);
2566 ofport_destroy(struct ofport
*port
, bool del
)
2569 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2570 port
->ofproto
->ofproto_class
->port_destruct(port
, del
);
2571 ofport_destroy__(port
);
2576 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2578 struct ofport
*port
;
2580 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2582 if (port
->ofp_port
== ofp_port
) {
2589 static long long int
2590 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2592 struct ofport_usage
*usage
;
2594 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2595 &ofproto
->ofport_usage
) {
2596 if (usage
->ofp_port
== ofp_port
) {
2597 return usage
->last_used
;
2604 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2605 long long int last_used
)
2607 struct ofport_usage
*usage
;
2608 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2609 &ofproto
->ofport_usage
) {
2610 if (usage
->ofp_port
== ofp_port
) {
2611 usage
->last_used
= last_used
;
2615 ovs_assert(last_used
== LLONG_MAX
);
2617 usage
= xmalloc(sizeof *usage
);
2618 usage
->ofp_port
= ofp_port
;
2619 usage
->last_used
= last_used
;
2620 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2621 hash_ofp_port(ofp_port
));
2625 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2627 struct ofport_usage
*usage
;
2628 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2629 &ofproto
->ofport_usage
) {
2630 if (usage
->ofp_port
== ofp_port
) {
2631 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2639 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2641 struct ofproto
*ofproto
= port
->ofproto
;
2644 if (ofproto
->ofproto_class
->port_get_stats
) {
2645 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2654 update_port(struct ofproto
*ofproto
, const char *name
)
2656 struct ofproto_port ofproto_port
;
2657 struct ofputil_phy_port pp
;
2658 struct netdev
*netdev
;
2659 struct ofport
*port
;
2662 COVERAGE_INC(ofproto_update_port
);
2664 /* Fetch 'name''s location and properties from the datapath. */
2665 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2666 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2670 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2671 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2672 struct netdev
*old_netdev
= port
->netdev
;
2674 /* 'name' hasn't changed location. Any properties changed? */
2675 if (!ofport_equal(&port
->pp
, &pp
)) {
2676 ofport_modified(port
, &pp
);
2679 update_mtu(ofproto
, port
);
2681 /* Install the newly opened netdev in case it has changed.
2682 * Don't close the old netdev yet in case port_modified has to
2683 * remove a retained reference to it.*/
2684 port
->netdev
= netdev
;
2685 port
->change_seq
= netdev_get_change_seq(netdev
);
2687 if (port
->ofproto
->ofproto_class
->port_modified
) {
2688 port
->ofproto
->ofproto_class
->port_modified(port
);
2691 netdev_close(old_netdev
);
2693 /* If 'port' is nonnull then its name differs from 'name' and thus
2694 * we should delete it. If we think there's a port named 'name'
2695 * then its port number must be wrong now so delete it too. */
2697 ofport_remove(port
);
2699 ofport_remove_with_name(ofproto
, name
);
2700 error
= ofport_install(ofproto
, netdev
, &pp
);
2703 /* Any port named 'name' is gone now. */
2704 ofport_remove_with_name(ofproto
, name
);
2706 ofproto_port_destroy(&ofproto_port
);
2712 init_ports(struct ofproto
*p
)
2714 struct ofproto_port_dump dump
;
2715 struct ofproto_port ofproto_port
;
2716 struct shash_node
*node
, *next
;
2718 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2719 const char *name
= ofproto_port
.name
;
2721 if (shash_find(&p
->port_by_name
, name
)) {
2722 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2725 struct ofputil_phy_port pp
;
2726 struct netdev
*netdev
;
2728 /* Check if an OpenFlow port number had been requested. */
2729 node
= shash_find(&init_ofp_ports
, name
);
2731 const struct iface_hint
*iface_hint
= node
->data
;
2732 simap_put(&p
->ofp_requests
, name
,
2733 ofp_to_u16(iface_hint
->ofp_port
));
2736 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2738 ofport_install(p
, netdev
, &pp
);
2739 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2740 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2741 ofp_to_u16(ofproto_port
.ofp_port
));
2747 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2748 struct iface_hint
*iface_hint
= node
->data
;
2750 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2751 free(iface_hint
->br_name
);
2752 free(iface_hint
->br_type
);
2754 shash_delete(&init_ofp_ports
, node
);
2762 ofport_is_internal(const struct ofport
*port
)
2764 return !strcmp(netdev_get_type(port
->netdev
), "internal");
2767 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2768 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2770 find_min_mtu(struct ofproto
*p
)
2772 struct ofport
*ofport
;
2775 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2776 struct netdev
*netdev
= ofport
->netdev
;
2779 /* Skip any internal ports, since that's what we're trying to
2781 if (ofport_is_internal(ofport
)) {
2785 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2788 if (!mtu
|| dev_mtu
< mtu
) {
2793 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2796 /* Update MTU of all datapath devices on 'p' to the minimum of the
2797 * non-datapath ports in event of 'port' added or changed. */
2799 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2801 struct netdev
*netdev
= port
->netdev
;
2804 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2808 if (ofport_is_internal(port
)) {
2809 if (dev_mtu
> p
->min_mtu
) {
2810 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2811 dev_mtu
= p
->min_mtu
;
2814 port
->mtu
= dev_mtu
;
2818 port
->mtu
= dev_mtu
;
2819 /* For non-internal port find new min mtu. */
2820 update_mtu_ofproto(p
);
2824 update_mtu_ofproto(struct ofproto
*p
)
2826 /* For non-internal port find new min mtu. */
2827 struct ofport
*ofport
;
2828 int old_min
= p
->min_mtu
;
2830 p
->min_mtu
= find_min_mtu(p
);
2831 if (p
->min_mtu
== old_min
) {
2835 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2836 struct netdev
*netdev
= ofport
->netdev
;
2838 if (ofport_is_internal(ofport
)) {
2839 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2840 ofport
->mtu
= p
->min_mtu
;
2847 ofproto_rule_destroy__(struct rule
*rule
)
2848 OVS_NO_THREAD_SAFETY_ANALYSIS
2850 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2851 rule_actions_destroy(rule_get_actions(rule
));
2852 ovs_mutex_destroy(&rule
->mutex
);
2853 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2857 rule_destroy_cb(struct rule
*rule
)
2858 OVS_NO_THREAD_SAFETY_ANALYSIS
2860 /* Send rule removed if needed. */
2861 if (rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
2862 && rule
->removed_reason
!= OVS_OFPRR_NONE
2863 && !rule_is_hidden(rule
)) {
2864 ofproto_rule_send_removed(rule
);
2866 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2867 ofproto_rule_destroy__(rule
);
2871 ofproto_rule_ref(struct rule
*rule
)
2874 ovs_refcount_ref(&rule
->ref_count
);
2879 ofproto_rule_try_ref(struct rule
*rule
)
2882 return ovs_refcount_try_ref_rcu(&rule
->ref_count
);
2887 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2888 * ref_count reaches 0.
2890 * Use of RCU allows short term use (between RCU quiescent periods) without
2891 * keeping a reference. A reference must be taken if the rule needs to
2892 * stay around accross the RCU quiescent periods. */
2894 ofproto_rule_unref(struct rule
*rule
)
2896 if (rule
&& ovs_refcount_unref_relaxed(&rule
->ref_count
) == 1) {
2897 ovsrcu_postpone(rule_destroy_cb
, rule
);
2902 remove_rule_rcu__(struct rule
*rule
)
2903 OVS_REQUIRES(ofproto_mutex
)
2905 struct ofproto
*ofproto
= rule
->ofproto
;
2906 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
2908 ovs_assert(!cls_rule_visible_in_version(&rule
->cr
, OVS_VERSION_MAX
));
2909 if (!classifier_remove(&table
->cls
, &rule
->cr
)) {
2912 if (ofproto
->ofproto_class
->rule_delete
) {
2913 ofproto
->ofproto_class
->rule_delete(rule
);
2915 ofproto_rule_unref(rule
);
2919 remove_rule_rcu(struct rule
*rule
)
2920 OVS_EXCLUDED(ofproto_mutex
)
2922 ovs_mutex_lock(&ofproto_mutex
);
2923 remove_rule_rcu__(rule
);
2924 ovs_mutex_unlock(&ofproto_mutex
);
2927 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2929 remove_rules_rcu(struct rule
**rules
)
2930 OVS_EXCLUDED(ofproto_mutex
)
2932 struct rule
**orig_rules
= rules
;
2935 struct ofproto
*ofproto
= rules
[0]->ofproto
;
2936 unsigned long tables
[BITMAP_N_LONGS(256)];
2940 memset(tables
, 0, sizeof tables
);
2942 ovs_mutex_lock(&ofproto_mutex
);
2943 while ((rule
= *rules
++)) {
2944 /* Defer once for each new table. This defers the subtable cleanup
2945 * until later, so that when removing large number of flows the
2946 * operation is faster. */
2947 if (!bitmap_is_set(tables
, rule
->table_id
)) {
2948 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
2950 bitmap_set1(tables
, rule
->table_id
);
2951 classifier_defer(cls
);
2953 remove_rule_rcu__(rule
);
2956 BITMAP_FOR_EACH_1(table_id
, 256, tables
) {
2957 struct classifier
*cls
= &ofproto
->tables
[table_id
].cls
;
2959 classifier_publish(cls
);
2961 ovs_mutex_unlock(&ofproto_mutex
);
2968 ofproto_group_ref(struct ofgroup
*group
)
2971 ovs_refcount_ref(&group
->ref_count
);
2976 ofproto_group_try_ref(struct ofgroup
*group
)
2979 return ovs_refcount_try_ref_rcu(&group
->ref_count
);
2985 group_destroy_cb(struct ofgroup
*group
)
2987 group
->ofproto
->ofproto_class
->group_destruct(group
);
2988 ofputil_bucket_list_destroy(CONST_CAST(struct ovs_list
*,
2990 group
->ofproto
->ofproto_class
->group_dealloc(group
);
2994 ofproto_group_unref(struct ofgroup
*group
)
2996 if (group
&& ovs_refcount_unref_relaxed(&group
->ref_count
) == 1) {
2997 ovsrcu_postpone(group_destroy_cb
, group
);
3001 static uint32_t get_provider_meter_id(const struct ofproto
*,
3002 uint32_t of_meter_id
);
3004 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
3005 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
3006 const struct rule_actions
*
3007 rule_actions_create(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
3009 struct rule_actions
*actions
;
3011 actions
= xmalloc(sizeof *actions
+ ofpacts_len
);
3012 actions
->ofpacts_len
= ofpacts_len
;
3013 actions
->has_meter
= ofpacts_get_meter(ofpacts
, ofpacts_len
) != 0;
3014 memcpy(actions
->ofpacts
, ofpacts
, ofpacts_len
);
3016 actions
->has_learn_with_delete
= (next_learn_with_delete(actions
, NULL
)
3022 /* Free the actions after the RCU quiescent period is reached. */
3024 rule_actions_destroy(const struct rule_actions
*actions
)
3027 ovsrcu_postpone(free
, CONST_CAST(struct rule_actions
*, actions
));
3031 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
3032 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
3034 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
3035 OVS_REQUIRES(ofproto_mutex
)
3037 if (port
== OFPP_ANY
) {
3040 const struct rule_actions
*actions
= rule_get_actions(rule
);
3041 return ofpacts_output_to_port(actions
->ofpacts
,
3042 actions
->ofpacts_len
, port
);
3046 /* Returns true if 'rule' has group and equals group_id. */
3048 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
3049 OVS_REQUIRES(ofproto_mutex
)
3051 if (group_id
== OFPG_ANY
) {
3054 const struct rule_actions
*actions
= rule_get_actions(rule
);
3055 return ofpacts_output_to_group(actions
->ofpacts
,
3056 actions
->ofpacts_len
, group_id
);
3061 rule_execute_destroy(struct rule_execute
*e
)
3063 ofproto_rule_unref(e
->rule
);
3064 ovs_list_remove(&e
->list_node
);
3068 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
3069 * by passing them to the ofproto provider. */
3071 run_rule_executes(struct ofproto
*ofproto
)
3072 OVS_EXCLUDED(ofproto_mutex
)
3074 struct rule_execute
*e
, *next
;
3075 struct ovs_list executes
;
3077 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
3078 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
3081 flow_extract(e
->packet
, &flow
);
3082 flow
.in_port
.ofp_port
= e
->in_port
;
3083 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
3085 rule_execute_destroy(e
);
3089 /* Destroys and discards all "rule_execute" operations queued up in
3090 * ofproto->rule_executes. */
3092 destroy_rule_executes(struct ofproto
*ofproto
)
3094 struct rule_execute
*e
, *next
;
3095 struct ovs_list executes
;
3097 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
3098 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
3099 dp_packet_delete(e
->packet
);
3100 rule_execute_destroy(e
);
3105 rule_is_readonly(const struct rule
*rule
)
3107 const struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
3108 return (table
->flags
& OFTABLE_READONLY
) != 0;
3112 hash_learned_cookie(ovs_be64 cookie_
, uint8_t table_id
)
3114 uint64_t cookie
= (OVS_FORCE
uint64_t) cookie_
;
3115 return hash_3words(cookie
, cookie
>> 32, table_id
);
3119 learned_cookies_update_one__(struct ofproto
*ofproto
,
3120 const struct ofpact_learn
*learn
,
3121 int delta
, struct ovs_list
*dead_cookies
)
3122 OVS_REQUIRES(ofproto_mutex
)
3124 uint32_t hash
= hash_learned_cookie(learn
->cookie
, learn
->table_id
);
3125 struct learned_cookie
*c
;
3127 HMAP_FOR_EACH_WITH_HASH (c
, u
.hmap_node
, hash
, &ofproto
->learned_cookies
) {
3128 if (c
->cookie
== learn
->cookie
&& c
->table_id
== learn
->table_id
) {
3130 ovs_assert(c
->n
>= 0);
3133 hmap_remove(&ofproto
->learned_cookies
, &c
->u
.hmap_node
);
3134 ovs_list_push_back(dead_cookies
, &c
->u
.list_node
);
3141 ovs_assert(delta
> 0);
3142 c
= xmalloc(sizeof *c
);
3143 hmap_insert(&ofproto
->learned_cookies
, &c
->u
.hmap_node
, hash
);
3144 c
->cookie
= learn
->cookie
;
3145 c
->table_id
= learn
->table_id
;
3149 static const struct ofpact_learn
*
3150 next_learn_with_delete(const struct rule_actions
*actions
,
3151 const struct ofpact_learn
*start
)
3153 const struct ofpact
*pos
;
3155 for (pos
= start
? ofpact_next(&start
->ofpact
) : actions
->ofpacts
;
3156 pos
< ofpact_end(actions
->ofpacts
, actions
->ofpacts_len
);
3157 pos
= ofpact_next(pos
)) {
3158 if (pos
->type
== OFPACT_LEARN
) {
3159 const struct ofpact_learn
*learn
= ofpact_get_LEARN(pos
);
3160 if (learn
->flags
& NX_LEARN_F_DELETE_LEARNED
) {
3170 learned_cookies_update__(struct ofproto
*ofproto
,
3171 const struct rule_actions
*actions
,
3172 int delta
, struct ovs_list
*dead_cookies
)
3173 OVS_REQUIRES(ofproto_mutex
)
3175 if (actions
->has_learn_with_delete
) {
3176 const struct ofpact_learn
*learn
;
3178 for (learn
= next_learn_with_delete(actions
, NULL
); learn
;
3179 learn
= next_learn_with_delete(actions
, learn
)) {
3180 learned_cookies_update_one__(ofproto
, learn
, delta
, dead_cookies
);
3186 learned_cookies_inc(struct ofproto
*ofproto
,
3187 const struct rule_actions
*actions
)
3188 OVS_REQUIRES(ofproto_mutex
)
3190 learned_cookies_update__(ofproto
, actions
, +1, NULL
);
3194 learned_cookies_dec(struct ofproto
*ofproto
,
3195 const struct rule_actions
*actions
,
3196 struct ovs_list
*dead_cookies
)
3197 OVS_REQUIRES(ofproto_mutex
)
3199 learned_cookies_update__(ofproto
, actions
, -1, dead_cookies
);
3203 learned_cookies_flush(struct ofproto
*ofproto
, struct ovs_list
*dead_cookies
)
3204 OVS_REQUIRES(ofproto_mutex
)
3206 struct learned_cookie
*c
;
3208 LIST_FOR_EACH_POP (c
, u
.list_node
, dead_cookies
) {
3209 struct rule_criteria criteria
;
3210 struct rule_collection rules
;
3213 match_init_catchall(&match
);
3214 rule_criteria_init(&criteria
, c
->table_id
, &match
, 0, OVS_VERSION_MAX
,
3215 c
->cookie
, OVS_BE64_MAX
, OFPP_ANY
, OFPG_ANY
);
3216 rule_criteria_require_rw(&criteria
, false);
3217 collect_rules_loose(ofproto
, &criteria
, &rules
);
3218 rule_criteria_destroy(&criteria
);
3219 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
3226 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3228 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
3233 query_tables(struct ofproto
*ofproto
,
3234 struct ofputil_table_features
**featuresp
,
3235 struct ofputil_table_stats
**statsp
)
3237 struct mf_bitmap rw_fields
= oxm_writable_fields();
3238 struct mf_bitmap match
= oxm_matchable_fields();
3239 struct mf_bitmap mask
= oxm_maskable_fields();
3241 struct ofputil_table_features
*features
;
3242 struct ofputil_table_stats
*stats
;
3245 features
= *featuresp
= xcalloc(ofproto
->n_tables
, sizeof *features
);
3246 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3247 struct ofputil_table_features
*f
= &features
[i
];
3250 sprintf(f
->name
, "table%d", i
);
3251 f
->metadata_match
= OVS_BE64_MAX
;
3252 f
->metadata_write
= OVS_BE64_MAX
;
3253 atomic_read_relaxed(&ofproto
->tables
[i
].miss_config
, &f
->miss_config
);
3254 f
->max_entries
= 1000000;
3256 bool more_tables
= false;
3257 for (int j
= i
+ 1; j
< ofproto
->n_tables
; j
++) {
3258 if (!(ofproto
->tables
[j
].flags
& OFTABLE_HIDDEN
)) {
3259 bitmap_set1(f
->nonmiss
.next
, j
);
3263 f
->nonmiss
.instructions
= (1u << N_OVS_INSTRUCTIONS
) - 1;
3265 f
->nonmiss
.instructions
&= ~(1u << OVSINST_OFPIT11_GOTO_TABLE
);
3267 f
->nonmiss
.write
.ofpacts
= (UINT64_C(1) << N_OFPACTS
) - 1;
3268 f
->nonmiss
.write
.set_fields
= rw_fields
;
3269 f
->nonmiss
.apply
= f
->nonmiss
.write
;
3270 f
->miss
= f
->nonmiss
;
3274 f
->wildcard
= match
;
3278 stats
= *statsp
= xcalloc(ofproto
->n_tables
, sizeof *stats
);
3279 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3280 struct ofputil_table_stats
*s
= &stats
[i
];
3283 s
->active_count
= ofproto
->tables
[i
].n_flows
;
3285 s
->active_count
-= connmgr_count_hidden_rules(
3293 ofproto
->ofproto_class
->query_tables(ofproto
, features
, stats
);
3295 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3296 const struct oftable
*table
= &ofproto
->tables
[i
];
3297 struct ofputil_table_features
*f
= &features
[i
];
3300 ovs_strzcpy(f
->name
, table
->name
, sizeof f
->name
);
3303 if (table
->max_flows
< f
->max_entries
) {
3304 f
->max_entries
= table
->max_flows
;
3310 query_switch_features(struct ofproto
*ofproto
,
3311 bool *arp_match_ip
, uint64_t *ofpacts
)
3313 struct ofputil_table_features
*features
, *f
;
3315 *arp_match_ip
= false;
3318 query_tables(ofproto
, &features
, NULL
);
3319 for (f
= features
; f
< &features
[ofproto
->n_tables
]; f
++) {
3320 *ofpacts
|= f
->nonmiss
.apply
.ofpacts
| f
->miss
.apply
.ofpacts
;
3321 if (bitmap_is_set(f
->match
.bm
, MFF_ARP_SPA
) ||
3322 bitmap_is_set(f
->match
.bm
, MFF_ARP_TPA
)) {
3323 *arp_match_ip
= true;
3329 ovs_assert(*ofpacts
& (UINT64_C(1) << OFPACT_OUTPUT
));
3333 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3335 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3336 struct ofputil_switch_features features
;
3337 struct ofport
*port
;
3341 query_switch_features(ofproto
, &arp_match_ip
, &features
.ofpacts
);
3343 features
.datapath_id
= ofproto
->datapath_id
;
3344 features
.n_buffers
= pktbuf_capacity();
3345 features
.n_tables
= ofproto_get_n_visible_tables(ofproto
);
3346 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
3347 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
|
3348 OFPUTIL_C_GROUP_STATS
);
3350 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
3352 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3353 features
.auxiliary_id
= 0;
3354 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
3356 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3357 ofputil_put_switch_features_port(&port
->pp
, b
);
3360 ofconn_send_reply(ofconn
, b
);
3365 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3367 struct ofputil_switch_config config
;
3368 config
.frag
= ofconn_get_ofproto(ofconn
)->frag_handling
;
3369 config
.invalid_ttl_to_controller
3370 = ofconn_get_invalid_ttl_to_controller(ofconn
);
3371 config
.miss_send_len
= ofconn_get_miss_send_len(ofconn
);
3373 ofconn_send_reply(ofconn
, ofputil_encode_get_config_reply(oh
, &config
));
3379 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3381 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3382 struct ofputil_switch_config config
;
3385 error
= ofputil_decode_set_config(oh
, &config
);
3390 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
3391 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
3392 enum ofputil_frag_handling cur
= ofproto
->frag_handling
;
3393 enum ofputil_frag_handling next
= config
.frag
;
3396 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
3397 ofproto
->frag_handling
= next
;
3399 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
3401 ofputil_frag_handling_to_string(next
));
3406 if (config
.invalid_ttl_to_controller
>= 0) {
3407 ofconn_set_invalid_ttl_to_controller(ofconn
,
3408 config
.invalid_ttl_to_controller
);
3411 ofconn_set_miss_send_len(ofconn
, config
.miss_send_len
);
3416 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3417 * error message code for the caller to propagate upward. Otherwise, returns
3420 * The log message mentions 'msg_type'. */
3422 reject_slave_controller(struct ofconn
*ofconn
)
3424 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
3425 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
3426 return OFPERR_OFPBRC_IS_SLAVE
;
3432 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3435 * - If they use a meter, then 'ofproto' has that meter configured.
3437 * - If they use any groups, then 'ofproto' has that group configured.
3439 * Returns 0 if successful, otherwise an OpenFlow error. */
3441 ofproto_check_ofpacts(struct ofproto
*ofproto
,
3442 const struct ofpact ofpacts
[], size_t ofpacts_len
)
3444 const struct ofpact
*a
;
3447 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
3448 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
3449 return OFPERR_OFPMMFC_INVALID_METER
;
3452 OFPACT_FOR_EACH_FLATTENED (a
, ofpacts
, ofpacts_len
) {
3453 if (a
->type
== OFPACT_GROUP
3454 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
3455 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
3463 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3465 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3466 struct ofputil_packet_out po
;
3467 struct dp_packet
*payload
;
3468 uint64_t ofpacts_stub
[1024 / 8];
3469 struct ofpbuf ofpacts
;
3473 COVERAGE_INC(ofproto_packet_out
);
3475 error
= reject_slave_controller(ofconn
);
3480 /* Decode message. */
3481 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3482 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
3484 goto exit_free_ofpacts
;
3486 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
3487 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
3488 error
= OFPERR_OFPBRC_BAD_PORT
;
3489 goto exit_free_ofpacts
;
3493 if (po
.buffer_id
!= UINT32_MAX
) {
3494 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
3496 goto exit_free_ofpacts
;
3499 /* Ensure that the L3 header is 32-bit aligned. */
3500 payload
= dp_packet_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
3503 /* Verify actions against packet, then send packet if successful. */
3504 flow_extract(payload
, &flow
);
3505 flow
.in_port
.ofp_port
= po
.in_port
;
3507 /* Check actions like for flow mods. We pass a 'table_id' of 0 to
3508 * ofproto_check_consistency(), which isn't strictly correct because these
3509 * actions aren't in any table. This is OK as 'table_id' is only used to
3510 * check instructions (e.g., goto-table), which can't appear on the action
3511 * list of a packet-out. */
3512 error
= ofpacts_check_consistency(po
.ofpacts
, po
.ofpacts_len
,
3513 &flow
, u16_to_ofp(p
->max_ports
),
3515 ofconn_get_protocol(ofconn
));
3517 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
3519 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
3520 po
.ofpacts
, po
.ofpacts_len
);
3523 dp_packet_delete(payload
);
3526 ofpbuf_uninit(&ofpacts
);
3532 handle_nxt_resume(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3534 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3535 struct ofputil_packet_in_private pin
;
3538 error
= ofputil_decode_packet_in_private(oh
, false, &pin
, NULL
, NULL
);
3543 error
= (ofproto
->ofproto_class
->nxt_resume
3544 ? ofproto
->ofproto_class
->nxt_resume(ofproto
, &pin
)
3545 : OFPERR_NXR_NOT_SUPPORTED
);
3547 ofputil_packet_in_private_destroy(&pin
);
3553 update_port_config(struct ofconn
*ofconn
, struct ofport
*port
,
3554 enum ofputil_port_config config
,
3555 enum ofputil_port_config mask
)
3557 enum ofputil_port_config toggle
= (config
^ port
->pp
.config
) & mask
;
3559 if (toggle
& OFPUTIL_PC_PORT_DOWN
3560 && (config
& OFPUTIL_PC_PORT_DOWN
3561 ? netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
)
3562 : netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
))) {
3563 /* We tried to bring the port up or down, but it failed, so don't
3564 * update the "down" bit. */
3565 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
3569 enum ofputil_port_config old_config
= port
->pp
.config
;
3570 port
->pp
.config
^= toggle
;
3571 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
3572 connmgr_send_port_status(port
->ofproto
->connmgr
, ofconn
, &port
->pp
,
3578 port_mod_start(struct ofconn
*ofconn
, struct ofputil_port_mod
*pm
,
3579 struct ofport
**port
)
3581 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3583 *port
= ofproto_get_port(p
, pm
->port_no
);
3585 return OFPERR_OFPPMFC_BAD_PORT
;
3587 if (!eth_addr_equals((*port
)->pp
.hw_addr
, pm
->hw_addr
)) {
3588 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3594 port_mod_finish(struct ofconn
*ofconn
, struct ofputil_port_mod
*pm
,
3595 struct ofport
*port
)
3597 update_port_config(ofconn
, port
, pm
->config
, pm
->mask
);
3598 if (pm
->advertise
) {
3599 netdev_set_advertisements(port
->netdev
, pm
->advertise
);
3604 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3606 struct ofputil_port_mod pm
;
3607 struct ofport
*port
;
3610 error
= reject_slave_controller(ofconn
);
3615 error
= ofputil_decode_port_mod(oh
, &pm
, false);
3620 error
= port_mod_start(ofconn
, &pm
, &port
);
3622 port_mod_finish(ofconn
, &pm
, port
);
3628 handle_desc_stats_request(struct ofconn
*ofconn
,
3629 const struct ofp_header
*request
)
3631 static const char *default_mfr_desc
= "Nicira, Inc.";
3632 static const char *default_hw_desc
= "Open vSwitch";
3633 static const char *default_sw_desc
= VERSION
;
3634 static const char *default_serial_desc
= "None";
3635 static const char *default_dp_desc
= "None";
3637 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3638 struct ofp_desc_stats
*ods
;
3641 msg
= ofpraw_alloc_stats_reply(request
, 0);
3642 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3643 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3644 sizeof ods
->mfr_desc
);
3645 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3646 sizeof ods
->hw_desc
);
3647 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3648 sizeof ods
->sw_desc
);
3649 ovs_strlcpy(ods
->serial_num
,
3650 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3651 sizeof ods
->serial_num
);
3652 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3653 sizeof ods
->dp_desc
);
3654 ofconn_send_reply(ofconn
, msg
);
3660 handle_table_stats_request(struct ofconn
*ofconn
,
3661 const struct ofp_header
*request
)
3663 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3664 struct ofputil_table_features
*features
;
3665 struct ofputil_table_stats
*stats
;
3666 struct ofpbuf
*reply
;
3669 query_tables(ofproto
, &features
, &stats
);
3671 reply
= ofputil_encode_table_stats_reply(request
);
3672 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3673 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3674 ofputil_append_table_stats_reply(reply
, &stats
[i
], &features
[i
]);
3677 ofconn_send_reply(ofconn
, reply
);
3686 handle_table_features_request(struct ofconn
*ofconn
,
3687 const struct ofp_header
*request
)
3689 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3690 struct ofpbuf msg
= ofpbuf_const_initializer(request
,
3691 ntohs(request
->length
));
3692 ofpraw_pull_assert(&msg
);
3693 if (msg
.size
|| ofpmp_more(request
)) {
3694 return OFPERR_OFPTFFC_EPERM
;
3697 struct ofputil_table_features
*features
;
3698 query_tables(ofproto
, &features
, NULL
);
3700 struct ovs_list replies
;
3701 ofpmp_init(&replies
, request
);
3702 for (size_t i
= 0; i
< ofproto
->n_tables
; i
++) {
3703 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3704 ofputil_append_table_features_reply(&features
[i
], &replies
);
3707 ofconn_send_replies(ofconn
, &replies
);
3714 /* Returns the vacancy of 'oftable', a number that ranges from 0 (if the table
3715 * is full) to 100 (if the table is empty).
3717 * A table without a limit on flows is considered to be empty. */
3719 oftable_vacancy(const struct oftable
*t
)
3721 return (!t
->max_flows
? 100
3722 : t
->n_flows
>= t
->max_flows
? 0
3723 : (t
->max_flows
- t
->n_flows
) * 100.0 / t
->max_flows
);
3727 query_table_desc__(struct ofputil_table_desc
*td
,
3728 struct ofproto
*ofproto
, uint8_t table_id
)
3730 const struct oftable
*t
= &ofproto
->tables
[table_id
];
3732 td
->table_id
= table_id
;
3733 td
->eviction
= (t
->eviction
& EVICTION_OPENFLOW
3734 ? OFPUTIL_TABLE_EVICTION_ON
3735 : OFPUTIL_TABLE_EVICTION_OFF
);
3736 td
->eviction_flags
= OFPROTO_EVICTION_FLAGS
;
3737 td
->vacancy
= (t
->vacancy_event
3738 ? OFPUTIL_TABLE_VACANCY_ON
3739 : OFPUTIL_TABLE_VACANCY_OFF
);
3740 td
->table_vacancy
.vacancy_down
= t
->vacancy_down
;
3741 td
->table_vacancy
.vacancy_up
= t
->vacancy_up
;
3742 td
->table_vacancy
.vacancy
= oftable_vacancy(t
);
3745 /* This function queries the database for dumping table-desc. */
3747 query_tables_desc(struct ofproto
*ofproto
, struct ofputil_table_desc
**descp
)
3749 struct ofputil_table_desc
*table_desc
;
3752 table_desc
= *descp
= xcalloc(ofproto
->n_tables
, sizeof *table_desc
);
3753 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3754 struct ofputil_table_desc
*td
= &table_desc
[i
];
3755 query_table_desc__(td
, ofproto
, i
);
3759 /* Function to handle dump-table-desc request. */
3761 handle_table_desc_request(struct ofconn
*ofconn
,
3762 const struct ofp_header
*request
)
3764 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3765 struct ofputil_table_desc
*table_desc
;
3766 struct ovs_list replies
;
3769 query_tables_desc(ofproto
, &table_desc
);
3770 ofpmp_init(&replies
, request
);
3771 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3772 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3773 ofputil_append_table_desc_reply(&table_desc
[i
], &replies
,
3777 ofconn_send_replies(ofconn
, &replies
);
3782 /* This function determines and sends the vacancy event, based on the value
3783 * of current vacancy and threshold vacancy. If the current vacancy is less
3784 * than or equal to vacancy_down, vacancy up events must be enabled, and when
3785 * the current vacancy is greater or equal to vacancy_up, vacancy down events
3786 * must be enabled. */
3788 send_table_status(struct ofproto
*ofproto
, uint8_t table_id
)
3790 struct oftable
*t
= &ofproto
->tables
[table_id
];
3791 if (!t
->vacancy_event
) {
3795 uint8_t vacancy
= oftable_vacancy(t
);
3796 enum ofp14_table_reason event
;
3797 if (vacancy
< t
->vacancy_down
) {
3798 event
= OFPTR_VACANCY_DOWN
;
3799 } else if (vacancy
> t
->vacancy_up
) {
3800 event
= OFPTR_VACANCY_UP
;
3805 if (event
== t
->vacancy_event
) {
3806 struct ofputil_table_desc td
;
3807 query_table_desc__(&td
, ofproto
, table_id
);
3808 connmgr_send_table_status(ofproto
->connmgr
, &td
, event
);
3810 t
->vacancy_event
= (event
== OFPTR_VACANCY_DOWN
3812 : OFPTR_VACANCY_DOWN
);
3817 append_port_stat(struct ofport
*port
, struct ovs_list
*replies
)
3819 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3821 calc_duration(port
->created
, time_msec(),
3822 &ops
.duration_sec
, &ops
.duration_nsec
);
3824 /* Intentionally ignore return value, since errors will set
3825 * 'stats' to all-1s, which is correct for OpenFlow, and
3826 * netdev_get_stats() will log errors. */
3827 ofproto_port_get_stats(port
, &ops
.stats
);
3829 ofputil_append_port_stat(replies
, &ops
);
3833 handle_port_request(struct ofconn
*ofconn
,
3834 const struct ofp_header
*request
, ofp_port_t port_no
,
3835 void (*cb
)(struct ofport
*, struct ovs_list
*replies
))
3837 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3838 struct ofport
*port
;
3839 struct ovs_list replies
;
3841 ofpmp_init(&replies
, request
);
3842 if (port_no
!= OFPP_ANY
) {
3843 port
= ofproto_get_port(ofproto
, port_no
);
3848 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3853 ofconn_send_replies(ofconn
, &replies
);
3857 handle_port_stats_request(struct ofconn
*ofconn
,
3858 const struct ofp_header
*request
)
3863 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3865 handle_port_request(ofconn
, request
, port_no
, append_port_stat
);
3871 append_port_desc(struct ofport
*port
, struct ovs_list
*replies
)
3873 ofputil_append_port_desc_stats_reply(&port
->pp
, replies
);
3877 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3878 const struct ofp_header
*request
)
3883 error
= ofputil_decode_port_desc_stats_request(request
, &port_no
);
3885 handle_port_request(ofconn
, request
, port_no
, append_port_desc
);
3891 hash_cookie(ovs_be64 cookie
)
3893 return hash_uint64((OVS_FORCE
uint64_t)cookie
);
3897 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3898 OVS_REQUIRES(ofproto_mutex
)
3900 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3901 hash_cookie(rule
->flow_cookie
));
3905 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3906 OVS_REQUIRES(ofproto_mutex
)
3908 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3912 calc_duration(long long int start
, long long int now
,
3913 uint32_t *sec
, uint32_t *nsec
)
3915 long long int msecs
= now
- start
;
3916 *sec
= msecs
/ 1000;
3917 *nsec
= (msecs
% 1000) * (1000 * 1000);
3920 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3921 * true if 'table_id' is OK, false otherwise. */
3923 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3925 return table_id
== OFPTT_ALL
|| table_id
< ofproto
->n_tables
;
3928 static struct oftable
*
3929 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3931 struct oftable
*table
;
3933 for (table
= &ofproto
->tables
[table_id
];
3934 table
< &ofproto
->tables
[ofproto
->n_tables
];
3936 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3944 static struct oftable
*
3945 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3947 if (table_id
== 0xff) {
3948 return next_visible_table(ofproto
, 0);
3949 } else if (table_id
< ofproto
->n_tables
) {
3950 return &ofproto
->tables
[table_id
];
3956 static struct oftable
*
3957 next_matching_table(const struct ofproto
*ofproto
,
3958 const struct oftable
*table
, uint8_t table_id
)
3960 return (table_id
== 0xff
3961 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3965 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3967 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3968 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3970 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3971 * only once, for that table. (This can be used to access tables marked
3974 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3975 * entered at all. (Perhaps you should have validated TABLE_ID with
3976 * check_table_id().)
3978 * All parameters are evaluated multiple times.
3980 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3981 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3983 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3985 /* Initializes 'criteria' in a straightforward way based on the other
3988 * By default, the criteria include flows that are read-only, on the assumption
3989 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3990 * if flows will be modified.
3992 * For "loose" matching, the 'priority' parameter is unimportant and may be
3995 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3996 const struct match
*match
, int priority
,
3997 ovs_version_t version
, ovs_be64 cookie
,
3998 ovs_be64 cookie_mask
, ofp_port_t out_port
,
4001 criteria
->table_id
= table_id
;
4002 cls_rule_init(&criteria
->cr
, match
, priority
);
4003 criteria
->version
= version
;
4004 criteria
->cookie
= cookie
;
4005 criteria
->cookie_mask
= cookie_mask
;
4006 criteria
->out_port
= out_port
;
4007 criteria
->out_group
= out_group
;
4009 /* We ordinarily want to skip hidden rules, but there has to be a way for
4010 * code internal to OVS to modify and delete them, so if the criteria
4011 * specify a priority that can only be for a hidden flow, then allow hidden
4012 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
4013 * with hidden flows because OpenFlow uses only a 16-bit field to specify
4015 criteria
->include_hidden
= priority
> UINT16_MAX
;
4017 /* We assume that the criteria are being used to collect flows for reading
4018 * but not modification. Thus, we should collect read-only flows. */
4019 criteria
->include_readonly
= true;
4022 /* By default, criteria initialized by rule_criteria_init() will match flows
4023 * that are read-only, on the assumption that the collected flows won't be
4024 * modified. Call this function to match only flows that are be modifiable.
4026 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
4027 * caller has special privileges that allow it to modify even "read-only"
4030 rule_criteria_require_rw(struct rule_criteria
*criteria
,
4031 bool can_write_readonly
)
4033 criteria
->include_readonly
= can_write_readonly
;
4037 rule_criteria_destroy(struct rule_criteria
*criteria
)
4039 cls_rule_destroy(&criteria
->cr
);
4043 rule_collection_init(struct rule_collection
*rules
)
4045 rules
->rules
= rules
->stub
;
4047 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
4051 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
4053 if (rules
->n
>= rules
->capacity
) {
4054 size_t old_size
, new_size
;
4056 old_size
= rules
->capacity
* sizeof *rules
->rules
;
4057 rules
->capacity
*= 2;
4058 new_size
= rules
->capacity
* sizeof *rules
->rules
;
4060 if (rules
->rules
== rules
->stub
) {
4061 rules
->rules
= xmalloc(new_size
);
4062 memcpy(rules
->rules
, rules
->stub
, old_size
);
4064 rules
->rules
= xrealloc(rules
->rules
, new_size
);
4068 rules
->rules
[rules
->n
++] = rule
;
4072 rule_collection_ref(struct rule_collection
*rules
)
4073 OVS_REQUIRES(ofproto_mutex
)
4077 for (i
= 0; i
< rules
->n
; i
++) {
4078 ofproto_rule_ref(rules
->rules
[i
]);
4083 rule_collection_unref(struct rule_collection
*rules
)
4087 for (i
= 0; i
< rules
->n
; i
++) {
4088 ofproto_rule_unref(rules
->rules
[i
]);
4092 /* Returns a NULL-terminated array of rule pointers,
4093 * destroys 'rules'. */
4094 static struct rule
**
4095 rule_collection_detach(struct rule_collection
*rules
)
4097 struct rule
**rule_array
;
4099 rule_collection_add(rules
, NULL
);
4101 if (rules
->rules
== rules
->stub
) {
4102 rules
->rules
= xmemdup(rules
->rules
, rules
->n
* sizeof *rules
->rules
);
4105 rule_array
= rules
->rules
;
4106 rule_collection_init(rules
);
4112 rule_collection_destroy(struct rule_collection
*rules
)
4114 if (rules
->rules
!= rules
->stub
) {
4118 /* Make repeated destruction harmless. */
4119 rule_collection_init(rules
);
4122 /* Schedules postponed removal of rules, destroys 'rules'. */
4124 rule_collection_remove_postponed(struct rule_collection
*rules
)
4125 OVS_REQUIRES(ofproto_mutex
)
4128 if (rules
->n
== 1) {
4129 ovsrcu_postpone(remove_rule_rcu
, rules
->rules
[0]);
4131 ovsrcu_postpone(remove_rules_rcu
, rule_collection_detach(rules
));
4136 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
4137 * function verifies most of the criteria in 'c' itself, but the caller must
4138 * check 'c->cr' itself.
4140 * Rules that have already been marked for removal are not collected.
4142 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
4143 * 'c' only includes modifiable rules). */
4145 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
4146 struct rule_collection
*rules
, size_t *n_readonly
)
4147 OVS_REQUIRES(ofproto_mutex
)
4149 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
4150 && ofproto_rule_has_out_port(rule
, c
->out_port
)
4151 && ofproto_rule_has_out_group(rule
, c
->out_group
)
4152 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)
4153 && (!rule_is_hidden(rule
) || c
->include_hidden
)
4154 && cls_rule_visible_in_version(&rule
->cr
, c
->version
)) {
4155 /* Rule matches all the criteria... */
4156 if (!rule_is_readonly(rule
) || c
->include_readonly
) {
4158 rule_collection_add(rules
, rule
);
4160 /* ...except it's read-only. */
4166 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4167 * on classifiers rules are done in the "loose" way required for OpenFlow
4168 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
4171 * Returns 0 on success, otherwise an OpenFlow error code. */
4173 collect_rules_loose(struct ofproto
*ofproto
,
4174 const struct rule_criteria
*criteria
,
4175 struct rule_collection
*rules
)
4176 OVS_REQUIRES(ofproto_mutex
)
4178 struct oftable
*table
;
4179 enum ofperr error
= 0;
4180 size_t n_readonly
= 0;
4182 rule_collection_init(rules
);
4184 if (!check_table_id(ofproto
, criteria
->table_id
)) {
4185 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4189 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
4192 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
4193 hash_cookie(criteria
->cookie
),
4194 &ofproto
->cookies
) {
4195 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
4196 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4200 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
4203 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &criteria
->cr
,
4204 criteria
->version
) {
4205 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4211 if (!error
&& !rules
->n
&& n_readonly
) {
4212 /* We didn't find any rules to modify. We did find some read-only
4213 * rules that we're not allowed to modify, so report that. */
4214 error
= OFPERR_OFPBRC_EPERM
;
4217 rule_collection_destroy(rules
);
4222 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
4223 * on classifiers rules are done in the "strict" way required for OpenFlow
4224 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
4225 * rules on list 'rules'.
4227 * Returns 0 on success, otherwise an OpenFlow error code. */
4229 collect_rules_strict(struct ofproto
*ofproto
,
4230 const struct rule_criteria
*criteria
,
4231 struct rule_collection
*rules
)
4232 OVS_REQUIRES(ofproto_mutex
)
4234 struct oftable
*table
;
4235 size_t n_readonly
= 0;
4236 enum ofperr error
= 0;
4238 rule_collection_init(rules
);
4240 if (!check_table_id(ofproto
, criteria
->table_id
)) {
4241 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4245 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
4248 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
4249 hash_cookie(criteria
->cookie
),
4250 &ofproto
->cookies
) {
4251 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
4252 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4256 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
4259 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
4260 &table
->cls
, &criteria
->cr
,
4261 criteria
->version
));
4263 collect_rule(rule
, criteria
, rules
, &n_readonly
);
4269 if (!error
&& !rules
->n
&& n_readonly
) {
4270 /* We didn't find any rules to modify. We did find some read-only
4271 * rules that we're not allowed to modify, so report that. */
4272 error
= OFPERR_OFPBRC_EPERM
;
4275 rule_collection_destroy(rules
);
4280 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4281 * forced into the range of a uint16_t. */
4283 age_secs(long long int age_ms
)
4285 return (age_ms
< 0 ? 0
4286 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
4287 : (unsigned int) age_ms
/ 1000);
4291 handle_flow_stats_request(struct ofconn
*ofconn
,
4292 const struct ofp_header
*request
)
4293 OVS_EXCLUDED(ofproto_mutex
)
4295 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4296 struct ofputil_flow_stats_request fsr
;
4297 struct rule_criteria criteria
;
4298 struct rule_collection rules
;
4299 struct ovs_list replies
;
4303 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
4308 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, OVS_VERSION_MAX
,
4309 fsr
.cookie
, fsr
.cookie_mask
, fsr
.out_port
,
4312 ovs_mutex_lock(&ofproto_mutex
);
4313 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4314 rule_criteria_destroy(&criteria
);
4316 rule_collection_ref(&rules
);
4318 ovs_mutex_unlock(&ofproto_mutex
);
4324 ofpmp_init(&replies
, request
);
4325 for (i
= 0; i
< rules
.n
; i
++) {
4326 struct rule
*rule
= rules
.rules
[i
];
4327 long long int now
= time_msec();
4328 struct ofputil_flow_stats fs
;
4329 long long int created
, used
, modified
;
4330 const struct rule_actions
*actions
;
4331 enum ofputil_flow_mod_flags flags
;
4333 ovs_mutex_lock(&rule
->mutex
);
4334 fs
.cookie
= rule
->flow_cookie
;
4335 fs
.idle_timeout
= rule
->idle_timeout
;
4336 fs
.hard_timeout
= rule
->hard_timeout
;
4337 fs
.importance
= rule
->importance
;
4338 created
= rule
->created
;
4339 modified
= rule
->modified
;
4340 actions
= rule_get_actions(rule
);
4341 flags
= rule
->flags
;
4342 ovs_mutex_unlock(&rule
->mutex
);
4344 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
4345 &fs
.byte_count
, &used
);
4347 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
4348 fs
.table_id
= rule
->table_id
;
4349 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
4350 fs
.priority
= rule
->cr
.priority
;
4351 fs
.idle_age
= age_secs(now
- used
);
4352 fs
.hard_age
= age_secs(now
- modified
);
4353 fs
.ofpacts
= actions
->ofpacts
;
4354 fs
.ofpacts_len
= actions
->ofpacts_len
;
4357 ofputil_append_flow_stats_reply(&fs
, &replies
);
4360 rule_collection_unref(&rules
);
4361 rule_collection_destroy(&rules
);
4363 ofconn_send_replies(ofconn
, &replies
);
4369 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
4371 uint64_t packet_count
, byte_count
;
4372 const struct rule_actions
*actions
;
4373 long long int created
, used
;
4375 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
4376 &byte_count
, &used
);
4378 ovs_mutex_lock(&rule
->mutex
);
4379 actions
= rule_get_actions(rule
);
4380 created
= rule
->created
;
4381 ovs_mutex_unlock(&rule
->mutex
);
4383 if (rule
->table_id
!= 0) {
4384 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
4386 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
4387 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
4388 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
4389 cls_rule_format(&rule
->cr
, results
);
4390 ds_put_char(results
, ',');
4392 ds_put_cstr(results
, "actions=");
4393 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
4395 ds_put_cstr(results
, "\n");
4398 /* Adds a pretty-printed description of all flows to 'results', including
4399 * hidden flows (e.g., set up by in-band control). */
4401 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
4403 struct oftable
*table
;
4405 OFPROTO_FOR_EACH_TABLE (table
, p
) {
4408 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
4409 flow_stats_ds(rule
, results
);
4414 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4415 * '*engine_type' and '*engine_id', respectively. */
4417 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
4418 uint8_t *engine_type
, uint8_t *engine_id
)
4420 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
4423 /* Checks the status change of CFM on 'ofport'.
4425 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4427 ofproto_port_cfm_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
4429 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
4430 return (ofport
&& ofproto
->ofproto_class
->cfm_status_changed
4431 ? ofproto
->ofproto_class
->cfm_status_changed(ofport
)
4435 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4436 * Returns 0 if the port's CFM status was successfully stored into
4437 * '*status'. Returns positive errno if the port did not have CFM
4440 * The caller must provide and own '*status', and must free 'status->rmps'.
4441 * '*status' is indeterminate if the return value is non-zero. */
4443 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
4444 struct cfm_status
*status
)
4446 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
4447 return (ofport
&& ofproto
->ofproto_class
->get_cfm_status
4448 ? ofproto
->ofproto_class
->get_cfm_status(ofport
, status
)
4453 handle_aggregate_stats_request(struct ofconn
*ofconn
,
4454 const struct ofp_header
*oh
)
4455 OVS_EXCLUDED(ofproto_mutex
)
4457 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4458 struct ofputil_flow_stats_request request
;
4459 struct ofputil_aggregate_stats stats
;
4460 bool unknown_packets
, unknown_bytes
;
4461 struct rule_criteria criteria
;
4462 struct rule_collection rules
;
4463 struct ofpbuf
*reply
;
4467 error
= ofputil_decode_flow_stats_request(&request
, oh
);
4472 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
4473 OVS_VERSION_MAX
, request
.cookie
, request
.cookie_mask
,
4474 request
.out_port
, request
.out_group
);
4476 ovs_mutex_lock(&ofproto_mutex
);
4477 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4478 rule_criteria_destroy(&criteria
);
4480 rule_collection_ref(&rules
);
4482 ovs_mutex_unlock(&ofproto_mutex
);
4488 memset(&stats
, 0, sizeof stats
);
4489 unknown_packets
= unknown_bytes
= false;
4490 for (i
= 0; i
< rules
.n
; i
++) {
4491 struct rule
*rule
= rules
.rules
[i
];
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
)
4657 OVS_REQUIRES(ofproto_mutex
)
4659 struct cls_conjunction
*conjs
= NULL
;
4662 const struct ofpact
*ofpact
;
4663 OFPACT_FOR_EACH (ofpact
, fm
->ofpacts
, fm
->ofpacts_len
) {
4664 if (ofpact
->type
== OFPACT_CONJUNCTION
) {
4666 } else if (ofpact
->type
!= OFPACT_NOTE
) {
4667 /* "conjunction" may appear with "note" actions but not with any
4668 * other type of actions. */
4669 ovs_assert(!n_conjs
);
4676 conjs
= xzalloc(n_conjs
* sizeof *conjs
);
4677 OFPACT_FOR_EACH (ofpact
, fm
->ofpacts
, fm
->ofpacts_len
) {
4678 if (ofpact
->type
== OFPACT_CONJUNCTION
) {
4679 struct ofpact_conjunction
*oc
= ofpact_get_CONJUNCTION(ofpact
);
4680 conjs
[i
].clause
= oc
->clause
;
4681 conjs
[i
].n_clauses
= oc
->n_clauses
;
4682 conjs
[i
].id
= oc
->id
;
4689 *n_conjsp
= n_conjs
;
4692 /* Implements 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 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4696 * success, or an OpenFlow error code on failure.
4698 * On successful return the caller must complete the operation either by
4699 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4702 * The caller retains ownership of 'fm->ofpacts'. */
4704 add_flow_start(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
4705 OVS_REQUIRES(ofproto_mutex
)
4707 struct ofputil_flow_mod
*fm
= &ofm
->fm
;
4708 struct rule
**old_rule
= &ofm
->old_rules
.stub
[0];
4709 struct rule
**new_rule
= &ofm
->new_rules
.stub
[0];
4710 struct oftable
*table
;
4714 struct cls_conjunction
*conjs
;
4718 if (!check_table_id(ofproto
, fm
->table_id
)) {
4719 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4724 if (fm
->table_id
== 0xff) {
4725 if (ofproto
->ofproto_class
->rule_choose_table
) {
4726 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
4732 ovs_assert(table_id
< ofproto
->n_tables
);
4736 } else if (fm
->table_id
< ofproto
->n_tables
) {
4737 table_id
= fm
->table_id
;
4739 return OFPERR_OFPBRC_BAD_TABLE_ID
;
4742 table
= &ofproto
->tables
[table_id
];
4743 if (table
->flags
& OFTABLE_READONLY
4744 && !(fm
->flags
& OFPUTIL_FF_NO_READONLY
)) {
4745 return OFPERR_OFPBRC_EPERM
;
4748 if (!(fm
->flags
& OFPUTIL_FF_HIDDEN_FIELDS
)
4749 && !match_has_default_hidden_fields(&fm
->match
)) {
4750 VLOG_WARN_RL(&rl
, "%s: (add_flow) only internal flows can set "
4751 "non-default values to hidden fields", ofproto
->name
);
4752 return OFPERR_OFPBRC_EPERM
;
4755 cls_rule_init(&cr
, &fm
->match
, fm
->priority
);
4757 /* Check for the existence of an identical rule.
4758 * This will not return rules earlier marked for removal. */
4759 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
,
4763 /* Check for overlap, if requested. */
4764 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
4765 && classifier_rule_overlaps(&table
->cls
, &cr
, ofm
->version
)) {
4766 cls_rule_destroy(&cr
);
4767 return OFPERR_OFPFMFC_OVERLAP
;
4770 /* If necessary, evict an existing rule to clear out space. */
4771 if (table
->n_flows
>= table
->max_flows
) {
4772 if (!choose_rule_to_evict(table
, &rule
)) {
4773 error
= OFPERR_OFPFMFC_TABLE_FULL
;
4774 cls_rule_destroy(&cr
);
4777 eviction_group_remove_rule(rule
);
4778 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4780 fm
->delete_reason
= OFPRR_EVICTION
;
4784 fm
->modify_cookie
= true;
4787 /* Allocate new rule. */
4788 error
= replace_rule_create(ofproto
, fm
, &cr
, table
- ofproto
->tables
,
4794 get_conjunctions(fm
, &conjs
, &n_conjs
);
4795 replace_rule_start(ofproto
, ofm
->version
, rule
, *new_rule
, conjs
, n_conjs
);
4801 /* Revert the effects of add_flow_start(). */
4803 add_flow_revert(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
4804 OVS_REQUIRES(ofproto_mutex
)
4806 struct ofputil_flow_mod
*fm
= &ofm
->fm
;
4807 struct rule
*old_rule
= ofm
->old_rules
.stub
[0];
4808 struct rule
*new_rule
= ofm
->new_rules
.stub
[0];
4810 if (old_rule
&& fm
->delete_reason
== OFPRR_EVICTION
) {
4811 /* Revert the eviction. */
4812 eviction_group_add_rule(old_rule
);
4815 replace_rule_revert(ofproto
, old_rule
, new_rule
);
4818 /* To be called after version bump. */
4820 add_flow_finish(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
4821 const struct flow_mod_requester
*req
)
4822 OVS_REQUIRES(ofproto_mutex
)
4824 struct ofputil_flow_mod
*fm
= &ofm
->fm
;
4825 struct rule
*old_rule
= ofm
->old_rules
.stub
[0];
4826 struct rule
*new_rule
= ofm
->new_rules
.stub
[0];
4827 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
4829 replace_rule_finish(ofproto
, fm
, req
, old_rule
, new_rule
, &dead_cookies
);
4830 learned_cookies_flush(ofproto
, &dead_cookies
);
4833 ovsrcu_postpone(remove_rule_rcu
, old_rule
);
4835 ofmonitor_report(ofproto
->connmgr
, new_rule
, NXFME_ADDED
, 0,
4836 req
? req
->ofconn
: NULL
,
4837 req
? req
->request
->xid
: 0, NULL
);
4839 /* Send Vacancy Events for OF1.4+. */
4840 send_table_status(ofproto
, new_rule
->table_id
);
4843 send_buffered_packet(req
, fm
->buffer_id
, new_rule
);
4846 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4848 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4849 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4850 * structures yet. Takes ownership of 'cr'. */
4852 replace_rule_create(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4853 struct cls_rule
*cr
, uint8_t table_id
,
4854 struct rule
*old_rule
, struct rule
**new_rule
)
4859 /* Allocate new rule. */
4860 rule
= ofproto
->ofproto_class
->rule_alloc();
4862 cls_rule_destroy(cr
);
4863 VLOG_WARN_RL(&rl
, "%s: failed to allocate a rule.", ofproto
->name
);
4864 return OFPERR_OFPFMFC_UNKNOWN
;
4867 /* Initialize base state. */
4868 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4869 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), cr
);
4870 ovs_refcount_init(&rule
->ref_count
);
4871 rule
->flow_cookie
= fm
->new_cookie
;
4872 rule
->created
= rule
->modified
= time_msec();
4874 ovs_mutex_init(&rule
->mutex
);
4875 ovs_mutex_lock(&rule
->mutex
);
4876 rule
->idle_timeout
= fm
->idle_timeout
;
4877 rule
->hard_timeout
= fm
->hard_timeout
;
4878 *CONST_CAST(uint16_t *, &rule
->importance
) = fm
->importance
;
4879 rule
->removed_reason
= OVS_OFPRR_NONE
;
4881 *CONST_CAST(uint8_t *, &rule
->table_id
) = table_id
;
4882 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4883 *CONST_CAST(const struct rule_actions
**, &rule
->actions
)
4884 = rule_actions_create(fm
->ofpacts
, fm
->ofpacts_len
);
4885 ovs_list_init(&rule
->meter_list_node
);
4886 rule
->eviction_group
= NULL
;
4887 ovs_list_init(&rule
->expirable
);
4888 rule
->monitor_flags
= 0;
4889 rule
->add_seqno
= 0;
4890 rule
->modify_seqno
= 0;
4892 /* Copy values from old rule for modify semantics. */
4893 if (old_rule
&& fm
->delete_reason
!= OFPRR_EVICTION
) {
4894 bool change_cookie
= (fm
->modify_cookie
4895 && fm
->new_cookie
!= OVS_BE64_MAX
4896 && fm
->new_cookie
!= old_rule
->flow_cookie
);
4898 ovs_mutex_lock(&old_rule
->mutex
);
4899 if (fm
->command
!= OFPFC_ADD
) {
4900 rule
->idle_timeout
= old_rule
->idle_timeout
;
4901 rule
->hard_timeout
= old_rule
->hard_timeout
;
4902 *CONST_CAST(uint16_t *, &rule
->importance
) = old_rule
->importance
;
4903 rule
->flags
= old_rule
->flags
;
4904 rule
->created
= old_rule
->created
;
4906 if (!change_cookie
) {
4907 rule
->flow_cookie
= old_rule
->flow_cookie
;
4909 ovs_mutex_unlock(&old_rule
->mutex
);
4911 ovs_mutex_unlock(&rule
->mutex
);
4913 /* Construct rule, initializing derived state. */
4914 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4916 ofproto_rule_destroy__(rule
);
4920 rule
->removed
= true; /* Not yet in ofproto data structures. */
4927 replace_rule_start(struct ofproto
*ofproto
, ovs_version_t version
,
4928 struct rule
*old_rule
, struct rule
*new_rule
,
4929 struct cls_conjunction
*conjs
, size_t n_conjs
)
4931 struct oftable
*table
= &ofproto
->tables
[new_rule
->table_id
];
4933 /* 'old_rule' may be either an evicted rule or replaced rule. */
4935 /* Mark the old rule for removal in the next version. */
4936 cls_rule_make_invisible_in_version(&old_rule
->cr
, version
);
4940 /* Insert flow to the classifier, so that later flow_mods may relate
4941 * to it. This is reversible, in case later errors require this to
4943 ofproto_rule_insert__(ofproto
, new_rule
);
4944 /* Make the new rule visible for classifier lookups only from the next
4946 classifier_insert(&table
->cls
, &new_rule
->cr
, version
, conjs
, n_conjs
);
4949 static void replace_rule_revert(struct ofproto
*ofproto
,
4950 struct rule
*old_rule
, struct rule
*new_rule
)
4952 struct oftable
*table
= &ofproto
->tables
[new_rule
->table_id
];
4955 /* Restore the original visibility of the old rule. */
4956 cls_rule_restore_visibility(&old_rule
->cr
);
4958 /* Restore table's rule count. */
4962 /* Remove the new rule immediately. It was never visible to lookups. */
4963 if (!classifier_remove(&table
->cls
, &new_rule
->cr
)) {
4966 ofproto_rule_remove__(ofproto
, new_rule
);
4967 /* The rule was not inserted to the ofproto provider, so we can
4968 * release it without deleting it from the ofproto provider. */
4969 ofproto_rule_unref(new_rule
);
4972 /* Adds the 'new_rule', replacing the 'old_rule'. */
4974 replace_rule_finish(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4975 const struct flow_mod_requester
*req
,
4976 struct rule
*old_rule
, struct rule
*new_rule
,
4977 struct ovs_list
*dead_cookies
)
4978 OVS_REQUIRES(ofproto_mutex
)
4980 bool forward_stats
= !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
);
4981 struct rule
*replaced_rule
;
4983 replaced_rule
= fm
->delete_reason
!= OFPRR_EVICTION
? old_rule
: NULL
;
4985 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4986 * is a duplicate rule the 'new_rule' is replacing. The provider should
4987 * link the stats from the old rule to the new one if 'forward_stats' is
4988 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4989 ofproto
->ofproto_class
->rule_insert(new_rule
, replaced_rule
,
4991 learned_cookies_inc(ofproto
, rule_get_actions(new_rule
));
4994 const struct rule_actions
*old_actions
= rule_get_actions(old_rule
);
4996 /* Remove the old rule from data structures. Removal from the
4997 * classifier and the deletion of the rule is RCU postponed by the
4999 ofproto_rule_remove__(ofproto
, old_rule
);
5000 learned_cookies_dec(ofproto
, old_actions
, dead_cookies
);
5002 if (replaced_rule
) {
5003 enum nx_flow_update_event event
= fm
->command
== OFPFC_ADD
5004 ? NXFME_ADDED
: NXFME_MODIFIED
;
5006 bool change_cookie
= (fm
->modify_cookie
5007 && fm
->new_cookie
!= OVS_BE64_MAX
5008 && fm
->new_cookie
!= old_rule
->flow_cookie
);
5010 bool change_actions
= !ofpacts_equal(fm
->ofpacts
,
5012 old_actions
->ofpacts
,
5013 old_actions
->ofpacts_len
);
5015 if (event
!= NXFME_MODIFIED
|| change_actions
|| change_cookie
) {
5016 ofmonitor_report(ofproto
->connmgr
, new_rule
, event
, 0,
5017 req
? req
->ofconn
: NULL
,
5018 req
? req
->request
->xid
: 0,
5019 change_actions
? old_actions
: NULL
);
5022 /* XXX: This is slight duplication with delete_flows_finish__() */
5024 old_rule
->removed_reason
= OFPRR_EVICTION
;
5026 ofmonitor_report(ofproto
->connmgr
, old_rule
, NXFME_DELETED
,
5028 req
? req
->ofconn
: NULL
,
5029 req
? req
->request
->xid
: 0, NULL
);
5035 modify_flows_start__(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5036 OVS_REQUIRES(ofproto_mutex
)
5038 struct ofputil_flow_mod
*fm
= &ofm
->fm
;
5039 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5040 struct rule_collection
*new_rules
= &ofm
->new_rules
;
5043 rule_collection_init(new_rules
);
5045 if (old_rules
->n
> 0) {
5046 struct cls_conjunction
*conjs
;
5050 /* Create a new 'modified' rule for each old rule. */
5051 for (i
= 0; i
< old_rules
->n
; i
++) {
5052 struct rule
*old_rule
= old_rules
->rules
[i
];
5053 struct rule
*new_rule
;
5056 cls_rule_clone(&cr
, &old_rule
->cr
);
5057 error
= replace_rule_create(ofproto
, fm
, &cr
, old_rule
->table_id
,
5058 old_rule
, &new_rule
);
5060 rule_collection_add(new_rules
, new_rule
);
5062 rule_collection_unref(new_rules
);
5063 rule_collection_destroy(new_rules
);
5067 ovs_assert(new_rules
->n
== old_rules
->n
);
5069 get_conjunctions(fm
, &conjs
, &n_conjs
);
5070 for (i
= 0; i
< old_rules
->n
; i
++) {
5071 replace_rule_start(ofproto
, ofm
->version
, old_rules
->rules
[i
],
5072 new_rules
->rules
[i
], conjs
, n_conjs
);
5075 } else if (!(fm
->cookie_mask
!= htonll(0)
5076 || fm
->new_cookie
== OVS_BE64_MAX
)) {
5077 /* No match, add a new flow. */
5078 error
= add_flow_start(ofproto
, ofm
);
5080 ovs_assert(fm
->delete_reason
== OFPRR_EVICTION
5081 || !old_rules
->rules
[0]);
5091 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
5094 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
5097 modify_flows_start_loose(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5098 OVS_REQUIRES(ofproto_mutex
)
5100 struct ofputil_flow_mod
*fm
= &ofm
->fm
;
5101 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5102 struct rule_criteria criteria
;
5105 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0, OVS_VERSION_MAX
,
5106 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG_ANY
);
5107 rule_criteria_require_rw(&criteria
,
5108 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5109 error
= collect_rules_loose(ofproto
, &criteria
, old_rules
);
5110 rule_criteria_destroy(&criteria
);
5113 error
= modify_flows_start__(ofproto
, ofm
);
5117 rule_collection_destroy(old_rules
);
5123 modify_flows_revert(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5124 OVS_REQUIRES(ofproto_mutex
)
5126 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5127 struct rule_collection
*new_rules
= &ofm
->new_rules
;
5129 /* Old rules were not changed yet, only need to revert new rules. */
5130 if (old_rules
->n
== 0 && new_rules
->n
== 1) {
5131 add_flow_revert(ofproto
, ofm
);
5132 } else if (old_rules
->n
> 0) {
5133 for (size_t i
= 0; i
< old_rules
->n
; i
++) {
5134 replace_rule_revert(ofproto
, old_rules
->rules
[i
],
5135 new_rules
->rules
[i
]);
5137 rule_collection_destroy(new_rules
);
5138 rule_collection_destroy(old_rules
);
5143 modify_flows_finish(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
5144 const struct flow_mod_requester
*req
)
5145 OVS_REQUIRES(ofproto_mutex
)
5147 struct ofputil_flow_mod
*fm
= &ofm
->fm
;
5148 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5149 struct rule_collection
*new_rules
= &ofm
->new_rules
;
5151 if (old_rules
->n
== 0 && new_rules
->n
== 1) {
5152 add_flow_finish(ofproto
, ofm
, req
);
5153 } else if (old_rules
->n
> 0) {
5154 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
5156 ovs_assert(new_rules
->n
== old_rules
->n
);
5158 for (size_t i
= 0; i
< old_rules
->n
; i
++) {
5159 replace_rule_finish(ofproto
, fm
, req
, old_rules
->rules
[i
],
5160 new_rules
->rules
[i
], &dead_cookies
);
5162 learned_cookies_flush(ofproto
, &dead_cookies
);
5163 rule_collection_remove_postponed(old_rules
);
5165 send_buffered_packet(req
, fm
->buffer_id
, new_rules
->rules
[0]);
5166 rule_collection_destroy(new_rules
);
5170 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
5171 * code on failure. */
5173 modify_flow_start_strict(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5174 OVS_REQUIRES(ofproto_mutex
)
5176 struct ofputil_flow_mod
*fm
= &ofm
->fm
;
5177 struct rule_collection
*old_rules
= &ofm
->old_rules
;
5178 struct rule_criteria criteria
;
5181 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
5182 OVS_VERSION_MAX
, fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
,
5184 rule_criteria_require_rw(&criteria
,
5185 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5186 error
= collect_rules_strict(ofproto
, &criteria
, old_rules
);
5187 rule_criteria_destroy(&criteria
);
5190 /* collect_rules_strict() can return max 1 rule. */
5191 error
= modify_flows_start__(ofproto
, ofm
);
5195 rule_collection_destroy(old_rules
);
5200 /* OFPFC_DELETE implementation. */
5203 delete_flows_start__(struct ofproto
*ofproto
, ovs_version_t version
,
5204 const struct rule_collection
*rules
)
5205 OVS_REQUIRES(ofproto_mutex
)
5207 for (size_t i
= 0; i
< rules
->n
; i
++) {
5208 struct rule
*rule
= rules
->rules
[i
];
5209 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
5212 cls_rule_make_invisible_in_version(&rule
->cr
, version
);
5217 delete_flows_finish__(struct ofproto
*ofproto
,
5218 struct rule_collection
*rules
,
5219 enum ofp_flow_removed_reason reason
,
5220 const struct flow_mod_requester
*req
)
5221 OVS_REQUIRES(ofproto_mutex
)
5224 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
5226 for (size_t i
= 0; i
< rules
->n
; i
++) {
5227 struct rule
*rule
= rules
->rules
[i
];
5229 /* This value will be used to send the flow removed message right
5230 * before the rule is actually destroyed. */
5231 rule
->removed_reason
= reason
;
5233 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_DELETED
, reason
,
5234 req
? req
->ofconn
: NULL
,
5235 req
? req
->request
->xid
: 0, NULL
);
5237 /* Send Vacancy Event for OF1.4+. */
5238 send_table_status(ofproto
, rule
->table_id
);
5240 ofproto_rule_remove__(ofproto
, rule
);
5241 learned_cookies_dec(ofproto
, rule_get_actions(rule
),
5244 rule_collection_remove_postponed(rules
);
5246 learned_cookies_flush(ofproto
, &dead_cookies
);
5250 /* Deletes the rules listed in 'rules'.
5251 * The deleted rules will become invisible to the lookups in the next version.
5252 * Destroys 'rules'. */
5254 delete_flows__(struct rule_collection
*rules
,
5255 enum ofp_flow_removed_reason reason
,
5256 const struct flow_mod_requester
*req
)
5257 OVS_REQUIRES(ofproto_mutex
)
5260 struct ofproto
*ofproto
= rules
->rules
[0]->ofproto
;
5262 delete_flows_start__(ofproto
, ofproto
->tables_version
+ 1, rules
);
5263 ofproto_bump_tables_version(ofproto
);
5264 delete_flows_finish__(ofproto
, rules
, reason
, req
);
5265 ofmonitor_flush(ofproto
->connmgr
);
5269 /* Implements OFPFC_DELETE. */
5271 delete_flows_start_loose(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5272 OVS_REQUIRES(ofproto_mutex
)
5274 const struct ofputil_flow_mod
*fm
= &ofm
->fm
;
5275 struct rule_collection
*rules
= &ofm
->old_rules
;
5276 struct rule_criteria criteria
;
5279 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0, OVS_VERSION_MAX
,
5280 fm
->cookie
, fm
->cookie_mask
, fm
->out_port
,
5282 rule_criteria_require_rw(&criteria
,
5283 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5284 error
= collect_rules_loose(ofproto
, &criteria
, rules
);
5285 rule_criteria_destroy(&criteria
);
5288 delete_flows_start__(ofproto
, ofm
->version
, rules
);
5295 delete_flows_revert(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
5296 OVS_REQUIRES(ofproto_mutex
)
5298 struct rule_collection
*rules
= &ofm
->old_rules
;
5300 for (size_t i
= 0; i
< rules
->n
; i
++) {
5301 struct rule
*rule
= rules
->rules
[i
];
5302 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
5304 /* Restore table's rule count. */
5307 /* Restore the original visibility of the rule. */
5308 cls_rule_restore_visibility(&rule
->cr
);
5310 rule_collection_destroy(rules
);
5314 delete_flows_finish(struct ofproto
*ofproto
,
5315 struct ofproto_flow_mod
*ofm
,
5316 const struct flow_mod_requester
*req
)
5317 OVS_REQUIRES(ofproto_mutex
)
5319 delete_flows_finish__(ofproto
, &ofm
->old_rules
, ofm
->fm
.delete_reason
,
5323 /* Implements OFPFC_DELETE_STRICT. */
5325 delete_flow_start_strict(struct ofproto
*ofproto
,
5326 struct ofproto_flow_mod
*ofm
)
5327 OVS_REQUIRES(ofproto_mutex
)
5329 const struct ofputil_flow_mod
*fm
= &ofm
->fm
;
5330 struct rule_collection
*rules
= &ofm
->old_rules
;
5331 struct rule_criteria criteria
;
5334 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
5335 OVS_VERSION_MAX
, fm
->cookie
, fm
->cookie_mask
,
5336 fm
->out_port
, fm
->out_group
);
5337 rule_criteria_require_rw(&criteria
,
5338 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5339 error
= collect_rules_strict(ofproto
, &criteria
, rules
);
5340 rule_criteria_destroy(&criteria
);
5343 delete_flows_start__(ofproto
, ofm
->version
, rules
);
5349 /* This may only be called by rule_destroy_cb()! */
5351 ofproto_rule_send_removed(struct rule
*rule
)
5352 OVS_EXCLUDED(ofproto_mutex
)
5354 struct ofputil_flow_removed fr
;
5357 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
5358 fr
.priority
= rule
->cr
.priority
;
5360 ovs_mutex_lock(&ofproto_mutex
);
5361 fr
.cookie
= rule
->flow_cookie
;
5362 fr
.reason
= rule
->removed_reason
;
5363 fr
.table_id
= rule
->table_id
;
5364 calc_duration(rule
->created
, time_msec(),
5365 &fr
.duration_sec
, &fr
.duration_nsec
);
5366 ovs_mutex_lock(&rule
->mutex
);
5367 fr
.idle_timeout
= rule
->idle_timeout
;
5368 fr
.hard_timeout
= rule
->hard_timeout
;
5369 ovs_mutex_unlock(&rule
->mutex
);
5370 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
5371 &fr
.byte_count
, &used
);
5372 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
5373 ovs_mutex_unlock(&ofproto_mutex
);
5376 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5377 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5380 * ofproto implementation ->run() functions should use this function to expire
5381 * OpenFlow flows. */
5383 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
5384 OVS_REQUIRES(ofproto_mutex
)
5386 struct rule_collection rules
;
5388 rules
.rules
= rules
.stub
;
5390 rules
.stub
[0] = rule
;
5391 delete_flows__(&rules
, reason
, NULL
);
5394 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5395 * means "infinite". */
5397 reduce_timeout(uint16_t max
, uint16_t *timeout
)
5399 if (max
&& (!*timeout
|| *timeout
> max
)) {
5404 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5405 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5406 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5408 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5410 ofproto_rule_reduce_timeouts(struct rule
*rule
,
5411 uint16_t idle_timeout
, uint16_t hard_timeout
)
5412 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
5414 if (!idle_timeout
&& !hard_timeout
) {
5418 ovs_mutex_lock(&ofproto_mutex
);
5419 if (ovs_list_is_empty(&rule
->expirable
)) {
5420 ovs_list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
5422 ovs_mutex_unlock(&ofproto_mutex
);
5424 ovs_mutex_lock(&rule
->mutex
);
5425 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
5426 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
5427 ovs_mutex_unlock(&rule
->mutex
);
5431 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5432 OVS_EXCLUDED(ofproto_mutex
)
5434 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5435 struct ofproto_flow_mod ofm
;
5436 uint64_t ofpacts_stub
[1024 / 8];
5437 struct ofpbuf ofpacts
;
5440 error
= reject_slave_controller(ofconn
);
5445 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
5446 error
= ofputil_decode_flow_mod(&ofm
.fm
, oh
, ofconn_get_protocol(ofconn
),
5448 u16_to_ofp(ofproto
->max_ports
),
5451 error
= ofproto_check_ofpacts(ofproto
, ofm
.fm
.ofpacts
,
5452 ofm
.fm
.ofpacts_len
);
5455 struct flow_mod_requester req
;
5457 req
.ofconn
= ofconn
;
5459 error
= handle_flow_mod__(ofproto
, &ofm
, &req
);
5462 goto exit_free_ofpacts
;
5465 ofconn_report_flow_mod(ofconn
, ofm
.fm
.command
);
5468 ofpbuf_uninit(&ofpacts
);
5474 handle_flow_mod__(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
,
5475 const struct flow_mod_requester
*req
)
5476 OVS_EXCLUDED(ofproto_mutex
)
5480 ovs_mutex_lock(&ofproto_mutex
);
5481 ofm
->version
= ofproto
->tables_version
+ 1;
5482 error
= ofproto_flow_mod_start(ofproto
, ofm
);
5484 ofproto_bump_tables_version(ofproto
);
5485 ofproto_flow_mod_finish(ofproto
, ofm
, req
);
5487 ofmonitor_flush(ofproto
->connmgr
);
5488 ovs_mutex_unlock(&ofproto_mutex
);
5490 run_rule_executes(ofproto
);
5495 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5497 struct ofputil_role_request request
;
5498 struct ofputil_role_request reply
;
5502 error
= ofputil_decode_role_message(oh
, &request
);
5507 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
5508 if (request
.role
!= OFPCR12_ROLE_EQUAL
5509 && request
.have_generation_id
5510 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
5511 return OFPERR_OFPRRFC_STALE
;
5514 ofconn_set_role(ofconn
, request
.role
);
5517 reply
.role
= ofconn_get_role(ofconn
);
5518 reply
.have_generation_id
= ofconn_get_master_election_id(
5519 ofconn
, &reply
.generation_id
);
5520 buf
= ofputil_encode_role_reply(oh
, &reply
);
5521 ofconn_send_reply(ofconn
, buf
);
5527 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
5528 const struct ofp_header
*oh
)
5530 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
5531 enum ofputil_protocol cur
, next
;
5533 cur
= ofconn_get_protocol(ofconn
);
5534 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
5535 ofconn_set_protocol(ofconn
, next
);
5541 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5543 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
5544 enum ofputil_protocol cur
, next
;
5545 enum ofputil_protocol next_base
;
5547 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
5549 return OFPERR_OFPBRC_EPERM
;
5552 cur
= ofconn_get_protocol(ofconn
);
5553 next
= ofputil_protocol_set_base(cur
, next_base
);
5554 ofconn_set_protocol(ofconn
, next
);
5560 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
5561 const struct ofp_header
*oh
)
5563 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
5566 format
= ntohl(msg
->format
);
5567 if (!ofputil_packet_in_format_is_valid(format
)) {
5568 return OFPERR_OFPBRC_EPERM
;
5571 ofconn_set_packet_in_format(ofconn
, format
);
5576 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5578 struct ofputil_async_cfg basis
= ofconn_get_async_config(ofconn
);
5579 struct ofputil_async_cfg ac
;
5582 error
= ofputil_decode_set_async_config(oh
, false, &basis
, &ac
);
5587 ofconn_set_async_config(ofconn
, &ac
);
5588 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
5589 !ofconn_get_miss_send_len(ofconn
)) {
5590 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
5597 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5599 struct ofputil_async_cfg ac
= ofconn_get_async_config(ofconn
);
5600 ofconn_send_reply(ofconn
, ofputil_encode_get_async_reply(oh
, &ac
));
5606 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
5607 const struct ofp_header
*oh
)
5609 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
5611 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
5612 return OFPERR_NXBRC_MUST_BE_ZERO
;
5615 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
5620 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5624 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
5625 ? OFPRAW_OFPT10_BARRIER_REPLY
5626 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
5627 ofconn_send_reply(ofconn
, buf
);
5632 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
5633 enum nx_flow_monitor_flags flags
,
5634 struct ovs_list
*msgs
)
5635 OVS_REQUIRES(ofproto_mutex
)
5637 const struct rule_actions
*actions
;
5638 struct ofputil_flow_update fu
;
5641 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
5642 ? NXFME_ADDED
: NXFME_MODIFIED
);
5644 ovs_mutex_lock(&rule
->mutex
);
5645 fu
.idle_timeout
= rule
->idle_timeout
;
5646 fu
.hard_timeout
= rule
->hard_timeout
;
5647 ovs_mutex_unlock(&rule
->mutex
);
5648 fu
.table_id
= rule
->table_id
;
5649 fu
.cookie
= rule
->flow_cookie
;
5650 minimatch_expand(&rule
->cr
.match
, &match
);
5652 fu
.priority
= rule
->cr
.priority
;
5654 actions
= flags
& NXFMF_ACTIONS
? rule_get_actions(rule
) : NULL
;
5655 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
5656 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
5658 if (ovs_list_is_empty(msgs
)) {
5659 ofputil_start_flow_update(msgs
);
5661 ofputil_append_flow_update(&fu
, msgs
);
5665 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
5666 struct ovs_list
*msgs
)
5667 OVS_REQUIRES(ofproto_mutex
)
5671 for (i
= 0; i
< rules
->n
; i
++) {
5672 struct rule
*rule
= rules
->rules
[i
];
5673 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
5674 rule
->monitor_flags
= 0;
5676 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
5681 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
5682 struct rule
*rule
, uint64_t seqno
,
5683 struct rule_collection
*rules
)
5684 OVS_REQUIRES(ofproto_mutex
)
5686 enum nx_flow_monitor_flags update
;
5688 if (rule_is_hidden(rule
)) {
5692 if (!ofproto_rule_has_out_port(rule
, m
->out_port
)) {
5697 if (rule
->add_seqno
> seqno
) {
5698 update
= NXFMF_ADD
| NXFMF_MODIFY
;
5699 } else if (rule
->modify_seqno
> seqno
) {
5700 update
= NXFMF_MODIFY
;
5705 if (!(m
->flags
& update
)) {
5709 update
= NXFMF_INITIAL
;
5712 if (!rule
->monitor_flags
) {
5713 rule_collection_add(rules
, rule
);
5715 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
5719 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
5721 struct rule_collection
*rules
)
5722 OVS_REQUIRES(ofproto_mutex
)
5724 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
5725 const struct oftable
*table
;
5726 struct cls_rule target
;
5728 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
5729 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
5732 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &target
, OVS_VERSION_MAX
) {
5733 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
5736 cls_rule_destroy(&target
);
5740 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
5741 struct rule_collection
*rules
)
5742 OVS_REQUIRES(ofproto_mutex
)
5744 if (m
->flags
& NXFMF_INITIAL
) {
5745 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
5750 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
5751 uint64_t seqno
, struct rule_collection
*rules
)
5752 OVS_REQUIRES(ofproto_mutex
)
5754 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
5758 flow_monitor_delete(struct ofconn
*ofconn
, uint32_t id
)
5759 OVS_REQUIRES(ofproto_mutex
)
5761 struct ofmonitor
*m
;
5764 m
= ofmonitor_lookup(ofconn
, id
);
5766 ofmonitor_destroy(m
);
5769 error
= OFPERR_OFPMOFC_UNKNOWN_MONITOR
;
5776 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5777 OVS_EXCLUDED(ofproto_mutex
)
5779 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5781 struct ofpbuf b
= ofpbuf_const_initializer(oh
, ntohs(oh
->length
));
5783 struct ofmonitor
**monitors
= NULL
;
5784 size_t allocated_monitors
= 0;
5785 size_t n_monitors
= 0;
5789 ovs_mutex_lock(&ofproto_mutex
);
5791 struct ofputil_flow_monitor_request request
;
5792 struct ofmonitor
*m
;
5795 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
5796 if (retval
== EOF
) {
5798 } else if (retval
) {
5803 if (request
.table_id
!= 0xff
5804 && request
.table_id
>= ofproto
->n_tables
) {
5805 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
5809 error
= ofmonitor_create(&request
, ofconn
, &m
);
5814 if (n_monitors
>= allocated_monitors
) {
5815 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
5818 monitors
[n_monitors
++] = m
;
5821 struct rule_collection rules
;
5822 rule_collection_init(&rules
);
5823 for (size_t i
= 0; i
< n_monitors
; i
++) {
5824 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
5827 struct ovs_list replies
;
5828 ofpmp_init(&replies
, oh
);
5829 ofmonitor_compose_refresh_updates(&rules
, &replies
);
5830 ovs_mutex_unlock(&ofproto_mutex
);
5832 rule_collection_destroy(&rules
);
5834 ofconn_send_replies(ofconn
, &replies
);
5840 for (size_t i
= 0; i
< n_monitors
; i
++) {
5841 ofmonitor_destroy(monitors
[i
]);
5844 ovs_mutex_unlock(&ofproto_mutex
);
5850 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5851 OVS_EXCLUDED(ofproto_mutex
)
5856 id
= ofputil_decode_flow_monitor_cancel(oh
);
5858 ovs_mutex_lock(&ofproto_mutex
);
5859 error
= flow_monitor_delete(ofconn
, id
);
5860 ovs_mutex_unlock(&ofproto_mutex
);
5865 /* Meters implementation.
5867 * Meter table entry, indexed by the OpenFlow meter_id.
5868 * 'created' is used to compute the duration for meter stats.
5869 * 'list rules' is needed so that we can delete the dependent rules when the
5870 * meter table entry is deleted.
5871 * 'provider_meter_id' is for the provider's private use.
5874 long long int created
; /* Time created. */
5875 struct ovs_list rules
; /* List of "struct rule_dpif"s. */
5876 ofproto_meter_id provider_meter_id
;
5877 uint16_t flags
; /* Meter flags. */
5878 uint16_t n_bands
; /* Number of meter bands. */
5879 struct ofputil_meter_band
*bands
;
5883 * This is used in instruction validation at flow set-up time,
5884 * as flows may not use non-existing meters.
5885 * Return value of UINT32_MAX signifies an invalid meter.
5888 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
5890 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
5891 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
5893 return meter
->provider_meter_id
.uint32
;
5899 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5902 meter_insert_rule(struct rule
*rule
)
5904 const struct rule_actions
*a
= rule_get_actions(rule
);
5905 uint32_t meter_id
= ofpacts_get_meter(a
->ofpacts
, a
->ofpacts_len
);
5906 struct meter
*meter
= rule
->ofproto
->meters
[meter_id
];
5908 ovs_list_insert(&meter
->rules
, &rule
->meter_list_node
);
5912 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
5916 meter
->flags
= config
->flags
;
5917 meter
->n_bands
= config
->n_bands
;
5918 meter
->bands
= xmemdup(config
->bands
,
5919 config
->n_bands
* sizeof *meter
->bands
);
5922 static struct meter
*
5923 meter_create(const struct ofputil_meter_config
*config
,
5924 ofproto_meter_id provider_meter_id
)
5926 struct meter
*meter
;
5928 meter
= xzalloc(sizeof *meter
);
5929 meter
->provider_meter_id
= provider_meter_id
;
5930 meter
->created
= time_msec();
5931 ovs_list_init(&meter
->rules
);
5933 meter_update(meter
, config
);
5939 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5940 OVS_REQUIRES(ofproto_mutex
)
5943 for (mid
= first
; mid
<= last
; ++mid
) {
5944 struct meter
*meter
= ofproto
->meters
[mid
];
5946 ofproto
->meters
[mid
] = NULL
;
5947 ofproto
->ofproto_class
->meter_del(ofproto
,
5948 meter
->provider_meter_id
);
5956 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5958 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5959 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5963 return OFPERR_OFPMMFC_METER_EXISTS
;
5966 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5969 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5970 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5976 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5978 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5980 uint32_t provider_meter_id
;
5983 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5986 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5987 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5988 &meter
->provider_meter_id
,
5990 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5992 meter_update(meter
, &mm
->meter
);
5998 handle_delete_meter(struct ofconn
*ofconn
, struct ofputil_meter_mod
*mm
)
5999 OVS_EXCLUDED(ofproto_mutex
)
6001 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6002 uint32_t meter_id
= mm
->meter
.meter_id
;
6003 struct rule_collection rules
;
6004 enum ofperr error
= 0;
6005 uint32_t first
, last
;
6007 if (meter_id
== OFPM13_ALL
) {
6009 last
= ofproto
->meter_features
.max_meters
;
6011 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
6014 first
= last
= meter_id
;
6017 /* First delete the rules that use this meter. If any of those rules are
6018 * currently being modified, postpone the whole operation until later. */
6019 rule_collection_init(&rules
);
6020 ovs_mutex_lock(&ofproto_mutex
);
6021 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
6022 struct meter
*meter
= ofproto
->meters
[meter_id
];
6023 if (meter
&& !ovs_list_is_empty(&meter
->rules
)) {
6026 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
6027 rule_collection_add(&rules
, rule
);
6031 delete_flows__(&rules
, OFPRR_METER_DELETE
, NULL
);
6033 /* Delete the meters. */
6034 meter_delete(ofproto
, first
, last
);
6036 ovs_mutex_unlock(&ofproto_mutex
);
6042 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6044 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6045 struct ofputil_meter_mod mm
;
6046 uint64_t bands_stub
[256 / 8];
6047 struct ofpbuf bands
;
6051 error
= reject_slave_controller(ofconn
);
6056 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
6058 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
6060 goto exit_free_bands
;
6063 meter_id
= mm
.meter
.meter_id
;
6065 if (mm
.command
!= OFPMC13_DELETE
) {
6066 /* Fails also when meters are not implemented by the provider. */
6067 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
6068 error
= OFPERR_OFPMMFC_INVALID_METER
;
6069 goto exit_free_bands
;
6070 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
6071 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
6072 goto exit_free_bands
;
6074 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
6075 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
6076 goto exit_free_bands
;
6080 switch (mm
.command
) {
6082 error
= handle_add_meter(ofproto
, &mm
);
6085 case OFPMC13_MODIFY
:
6086 error
= handle_modify_meter(ofproto
, &mm
);
6089 case OFPMC13_DELETE
:
6090 error
= handle_delete_meter(ofconn
, &mm
);
6094 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
6099 struct ofputil_requestforward rf
;
6101 rf
.reason
= OFPRFR_METER_MOD
;
6103 connmgr_send_requestforward(ofproto
->connmgr
, ofconn
, &rf
);
6107 ofpbuf_uninit(&bands
);
6112 handle_meter_features_request(struct ofconn
*ofconn
,
6113 const struct ofp_header
*request
)
6115 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6116 struct ofputil_meter_features features
;
6119 if (ofproto
->ofproto_class
->meter_get_features
) {
6120 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
6122 memset(&features
, 0, sizeof features
);
6124 b
= ofputil_encode_meter_features_reply(&features
, request
);
6126 ofconn_send_reply(ofconn
, b
);
6131 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
6134 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6135 struct ovs_list replies
;
6136 uint64_t bands_stub
[256 / 8];
6137 struct ofpbuf bands
;
6138 uint32_t meter_id
, first
, last
;
6140 ofputil_decode_meter_request(request
, &meter_id
);
6142 if (meter_id
== OFPM13_ALL
) {
6144 last
= ofproto
->meter_features
.max_meters
;
6146 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
6147 !ofproto
->meters
[meter_id
]) {
6148 return OFPERR_OFPMMFC_UNKNOWN_METER
;
6150 first
= last
= meter_id
;
6153 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
6154 ofpmp_init(&replies
, request
);
6156 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
6157 struct meter
*meter
= ofproto
->meters
[meter_id
];
6159 continue; /* Skip non-existing meters. */
6161 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
6162 struct ofputil_meter_stats stats
;
6164 stats
.meter_id
= meter_id
;
6166 /* Provider sets the packet and byte counts, we do the rest. */
6167 stats
.flow_count
= ovs_list_size(&meter
->rules
);
6168 calc_duration(meter
->created
, time_msec(),
6169 &stats
.duration_sec
, &stats
.duration_nsec
);
6170 stats
.n_bands
= meter
->n_bands
;
6171 ofpbuf_clear(&bands
);
6173 = ofpbuf_put_uninit(&bands
,
6174 meter
->n_bands
* sizeof *stats
.bands
);
6176 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
6177 meter
->provider_meter_id
,
6179 ofputil_append_meter_stats(&replies
, &stats
);
6181 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
6182 struct ofputil_meter_config config
;
6184 config
.meter_id
= meter_id
;
6185 config
.flags
= meter
->flags
;
6186 config
.n_bands
= meter
->n_bands
;
6187 config
.bands
= meter
->bands
;
6188 ofputil_append_meter_config(&replies
, &config
);
6192 ofconn_send_replies(ofconn
, &replies
);
6193 ofpbuf_uninit(&bands
);
6197 /* Returned group is RCU protected. */
6198 static struct ofgroup
*
6199 ofproto_group_lookup__(const struct ofproto
*ofproto
, uint32_t group_id
)
6201 struct ofgroup
*group
;
6203 CMAP_FOR_EACH_WITH_HASH (group
, cmap_node
, hash_int(group_id
, 0),
6205 if (group
->group_id
== group_id
) {
6213 /* If the group exists, this function increments the groups's reference count.
6215 * Make sure to call ofproto_group_unref() after no longer needing to maintain
6216 * a reference to the group. */
6218 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
)
6220 struct ofgroup
*group
;
6222 group
= ofproto_group_lookup__(ofproto
, group_id
);
6224 /* Not holding a lock, so it is possible that another thread releases
6225 * the last reference just before we manage to get one. */
6226 return ofproto_group_try_ref(group
) ? group
: NULL
;
6231 /* Caller should hold 'ofproto->groups_rwlock' if it is important that the
6232 * group is not removed by someone else. */
6234 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
6236 return ofproto_group_lookup__(ofproto
, group_id
) != NULL
;
6239 /* XXX: This is potentially very expensive for large flow tables, and may be
6240 * called in a loop. Maybe explicitly maintain the count of rules referring to
6241 * the group instead?. */
6243 group_get_ref_count(struct ofgroup
*group
)
6244 OVS_EXCLUDED(ofproto_mutex
)
6246 struct ofproto
*ofproto
= CONST_CAST(struct ofproto
*, group
->ofproto
);
6247 struct rule_criteria criteria
;
6248 struct rule_collection rules
;
6253 match_init_catchall(&match
);
6254 rule_criteria_init(&criteria
, 0xff, &match
, 0, OVS_VERSION_MAX
, htonll(0),
6255 htonll(0), OFPP_ANY
, group
->group_id
);
6256 ovs_mutex_lock(&ofproto_mutex
);
6257 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
6258 ovs_mutex_unlock(&ofproto_mutex
);
6259 rule_criteria_destroy(&criteria
);
6261 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
6263 rule_collection_destroy(&rules
);
6268 append_group_stats(struct ofgroup
*group
, struct ovs_list
*replies
)
6270 struct ofputil_group_stats ogs
;
6271 const struct ofproto
*ofproto
= group
->ofproto
;
6272 long long int now
= time_msec();
6275 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
6277 /* Provider sets the packet and byte counts, we do the rest. */
6278 ogs
.ref_count
= group_get_ref_count(group
);
6279 ogs
.n_buckets
= group
->n_buckets
;
6281 error
= (ofproto
->ofproto_class
->group_get_stats
6282 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
6285 ogs
.packet_count
= UINT64_MAX
;
6286 ogs
.byte_count
= UINT64_MAX
;
6287 memset(ogs
.bucket_stats
, 0xff,
6288 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
6291 ogs
.group_id
= group
->group_id
;
6292 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
6294 ofputil_append_group_stats(replies
, &ogs
);
6296 free(ogs
.bucket_stats
);
6300 handle_group_request(struct ofconn
*ofconn
,
6301 const struct ofp_header
*request
, uint32_t group_id
,
6302 void (*cb
)(struct ofgroup
*, struct ovs_list
*replies
))
6304 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6305 struct ofgroup
*group
;
6306 struct ovs_list replies
;
6308 ofpmp_init(&replies
, request
);
6309 if (group_id
== OFPG_ALL
) {
6310 /* Must exclude modifications to guarantee iterating all groups. */
6311 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
6312 CMAP_FOR_EACH (group
, cmap_node
, &ofproto
->groups
) {
6313 cb(group
, &replies
);
6315 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6317 group
= ofproto_group_lookup__(ofproto
, group_id
);
6319 cb(group
, &replies
);
6322 ofconn_send_replies(ofconn
, &replies
);
6326 handle_group_stats_request(struct ofconn
*ofconn
,
6327 const struct ofp_header
*request
)
6332 error
= ofputil_decode_group_stats_request(request
, &group_id
);
6337 handle_group_request(ofconn
, request
, group_id
, append_group_stats
);
6342 append_group_desc(struct ofgroup
*group
, struct ovs_list
*replies
)
6344 struct ofputil_group_desc gds
;
6346 gds
.group_id
= group
->group_id
;
6347 gds
.type
= group
->type
;
6348 gds
.props
= group
->props
;
6350 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, replies
);
6354 handle_group_desc_stats_request(struct ofconn
*ofconn
,
6355 const struct ofp_header
*request
)
6357 handle_group_request(ofconn
, request
,
6358 ofputil_decode_group_desc_request(request
),
6364 handle_group_features_stats_request(struct ofconn
*ofconn
,
6365 const struct ofp_header
*request
)
6367 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
6370 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
6372 ofconn_send_reply(ofconn
, msg
);
6379 put_queue_get_config_reply(struct ofport
*port
, uint32_t queue
,
6380 struct ovs_list
*replies
)
6382 struct ofputil_queue_config qc
;
6384 /* None of the existing queues have compatible properties, so we hard-code
6385 * omitting min_rate and max_rate. */
6386 qc
.port
= port
->ofp_port
;
6388 qc
.min_rate
= UINT16_MAX
;
6389 qc
.max_rate
= UINT16_MAX
;
6390 ofputil_append_queue_get_config_reply(&qc
, replies
);
6394 handle_queue_get_config_request_for_port(struct ofport
*port
, uint32_t queue
,
6395 struct ovs_list
*replies
)
6397 struct smap details
= SMAP_INITIALIZER(&details
);
6398 if (queue
!= OFPQ_ALL
) {
6399 int error
= netdev_get_queue(port
->netdev
, queue
, &details
);
6402 put_queue_get_config_reply(port
, queue
, replies
);
6406 return OFPERR_OFPQOFC_BAD_QUEUE
;
6408 return OFPERR_NXQOFC_QUEUE_ERROR
;
6411 struct netdev_queue_dump queue_dump
;
6414 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
,
6416 put_queue_get_config_reply(port
, queue_id
, replies
);
6419 smap_destroy(&details
);
6424 handle_queue_get_config_request(struct ofconn
*ofconn
,
6425 const struct ofp_header
*oh
)
6427 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6428 struct ovs_list replies
;
6429 struct ofport
*port
;
6430 ofp_port_t req_port
;
6434 error
= ofputil_decode_queue_get_config_request(oh
, &req_port
, &req_queue
);
6439 ofputil_start_queue_get_config_reply(oh
, &replies
);
6440 if (req_port
== OFPP_ANY
) {
6441 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
6442 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
6443 if (!handle_queue_get_config_request_for_port(port
, req_queue
,
6449 port
= ofproto_get_port(ofproto
, req_port
);
6451 ? handle_queue_get_config_request_for_port(port
, req_queue
,
6453 : OFPERR_OFPQOFC_BAD_PORT
);
6456 ofconn_send_replies(ofconn
, &replies
);
6458 ofpbuf_list_delete(&replies
);
6465 init_group(struct ofproto
*ofproto
, const struct ofputil_group_mod
*gm
,
6466 struct ofgroup
**ofgroup
)
6469 const long long int now
= time_msec();
6471 if (gm
->group_id
> OFPG_MAX
) {
6472 return OFPERR_OFPGMFC_INVALID_GROUP
;
6474 if (gm
->type
> OFPGT11_FF
) {
6475 return OFPERR_OFPGMFC_BAD_TYPE
;
6478 *ofgroup
= ofproto
->ofproto_class
->group_alloc();
6480 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
6481 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6484 (*ofgroup
)->ofproto
= ofproto
;
6485 *CONST_CAST(uint32_t *, &((*ofgroup
)->group_id
)) = gm
->group_id
;
6486 *CONST_CAST(enum ofp11_group_type
*, &(*ofgroup
)->type
) = gm
->type
;
6487 *CONST_CAST(long long int *, &((*ofgroup
)->created
)) = now
;
6488 *CONST_CAST(long long int *, &((*ofgroup
)->modified
)) = now
;
6489 ovs_refcount_init(&(*ofgroup
)->ref_count
);
6491 ovs_list_init(CONST_CAST(struct ovs_list
*, &(*ofgroup
)->buckets
));
6492 ofputil_bucket_clone_list(CONST_CAST(struct ovs_list
*,
6493 &(*ofgroup
)->buckets
),
6494 &gm
->buckets
, NULL
);
6496 *CONST_CAST(uint32_t *, &(*ofgroup
)->n_buckets
) =
6497 ovs_list_size(&(*ofgroup
)->buckets
);
6499 memcpy(CONST_CAST(struct ofputil_group_props
*, &(*ofgroup
)->props
),
6500 &gm
->props
, sizeof (struct ofputil_group_props
));
6502 /* Construct called BEFORE any locks are held. */
6503 error
= ofproto
->ofproto_class
->group_construct(*ofgroup
);
6505 ofputil_bucket_list_destroy(CONST_CAST(struct ovs_list
*,
6506 &(*ofgroup
)->buckets
));
6507 ofproto
->ofproto_class
->group_dealloc(*ofgroup
);
6512 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6513 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6516 add_group(struct ofproto
*ofproto
, const struct ofputil_group_mod
*gm
)
6518 struct ofgroup
*ofgroup
;
6521 /* Allocate new group and initialize it. */
6522 error
= init_group(ofproto
, gm
, &ofgroup
);
6527 /* We take the mutex as late as possible to minimize the time we jam any
6528 * other threads: No visible state changes before acquiring the lock. */
6529 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6531 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
6532 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6536 if (ofproto_group_exists(ofproto
, gm
->group_id
)) {
6537 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
6541 /* Insert new group. */
6542 cmap_insert(&ofproto
->groups
, &ofgroup
->cmap_node
,
6543 hash_int(ofgroup
->group_id
, 0));
6544 ofproto
->n_groups
[ofgroup
->type
]++;
6546 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6550 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6551 group_destroy_cb(ofgroup
);
6555 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6556 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6557 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6558 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6561 copy_buckets_for_insert_bucket(const struct ofgroup
*ofgroup
,
6562 struct ofgroup
*new_ofgroup
,
6563 uint32_t command_bucket_id
)
6565 struct ofputil_bucket
*last
= NULL
;
6567 if (command_bucket_id
<= OFPG15_BUCKET_MAX
) {
6568 /* Check here to ensure that a bucket corresponding to
6569 * command_bucket_id exists in the old bucket list.
6571 * The subsequent search of below of new_ofgroup covers
6572 * both buckets in the old bucket list and buckets added
6573 * by the insert buckets group mod message this function processes. */
6574 if (!ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
)) {
6575 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
6578 if (!ovs_list_is_empty(&new_ofgroup
->buckets
)) {
6579 last
= ofputil_bucket_list_back(&new_ofgroup
->buckets
);
6583 ofputil_bucket_clone_list(CONST_CAST(struct ovs_list
*,
6584 &new_ofgroup
->buckets
),
6585 &ofgroup
->buckets
, NULL
);
6587 if (ofputil_bucket_check_duplicate_id(&new_ofgroup
->buckets
)) {
6588 VLOG_INFO_RL(&rl
, "Duplicate bucket id");
6589 return OFPERR_OFPGMFC_BUCKET_EXISTS
;
6592 /* Rearrange list according to command_bucket_id */
6593 if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
6594 if (!ovs_list_is_empty(&ofgroup
->buckets
)) {
6595 struct ofputil_bucket
*new_first
;
6596 const struct ofputil_bucket
*first
;
6598 first
= ofputil_bucket_list_front(&ofgroup
->buckets
);
6599 new_first
= ofputil_bucket_find(&new_ofgroup
->buckets
,
6602 ovs_list_splice(new_ofgroup
->buckets
.next
, &new_first
->list_node
,
6603 CONST_CAST(struct ovs_list
*,
6604 &new_ofgroup
->buckets
));
6606 } else if (command_bucket_id
<= OFPG15_BUCKET_MAX
&& last
) {
6607 struct ofputil_bucket
*after
;
6609 /* Presence of bucket is checked above so after should never be NULL */
6610 after
= ofputil_bucket_find(&new_ofgroup
->buckets
, command_bucket_id
);
6612 ovs_list_splice(after
->list_node
.next
, new_ofgroup
->buckets
.next
,
6613 last
->list_node
.next
);
6619 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6620 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6621 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6622 * and OFPG15_BUCKET_ALL are also honored. */
6624 copy_buckets_for_remove_bucket(const struct ofgroup
*ofgroup
,
6625 struct ofgroup
*new_ofgroup
,
6626 uint32_t command_bucket_id
)
6628 const struct ofputil_bucket
*skip
= NULL
;
6630 if (command_bucket_id
== OFPG15_BUCKET_ALL
) {
6634 if (command_bucket_id
== OFPG15_BUCKET_FIRST
) {
6635 if (!ovs_list_is_empty(&ofgroup
->buckets
)) {
6636 skip
= ofputil_bucket_list_front(&ofgroup
->buckets
);
6638 } else if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
6639 if (!ovs_list_is_empty(&ofgroup
->buckets
)) {
6640 skip
= ofputil_bucket_list_back(&ofgroup
->buckets
);
6643 skip
= ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
);
6645 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
6649 ofputil_bucket_clone_list(CONST_CAST(struct ovs_list
*,
6650 &new_ofgroup
->buckets
),
6651 &ofgroup
->buckets
, skip
);
6656 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6657 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6660 * Note that the group is re-created and then replaces the old group in
6661 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6662 * the xlate module hold a pointer to the group. */
6664 modify_group(struct ofproto
*ofproto
, const struct ofputil_group_mod
*gm
)
6666 struct ofgroup
*ofgroup
, *new_ofgroup
, *retiring
;
6669 error
= init_group(ofproto
, gm
, &new_ofgroup
);
6674 retiring
= new_ofgroup
;
6676 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6677 ofgroup
= ofproto_group_lookup__(ofproto
, gm
->group_id
);
6679 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
6683 /* Ofproto's group write lock is held now. */
6684 if (ofgroup
->type
!= gm
->type
6685 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
6686 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6690 /* Manipulate bucket list for bucket commands */
6691 if (gm
->command
== OFPGC15_INSERT_BUCKET
) {
6692 error
= copy_buckets_for_insert_bucket(ofgroup
, new_ofgroup
,
6693 gm
->command_bucket_id
);
6694 } else if (gm
->command
== OFPGC15_REMOVE_BUCKET
) {
6695 error
= copy_buckets_for_remove_bucket(ofgroup
, new_ofgroup
,
6696 gm
->command_bucket_id
);
6702 /* The group creation time does not change during modification. */
6703 *CONST_CAST(long long int *, &(new_ofgroup
->created
)) = ofgroup
->created
;
6704 *CONST_CAST(long long int *, &(new_ofgroup
->modified
)) = time_msec();
6706 /* XXX: OK to lose old group's stats? */
6708 error
= ofproto
->ofproto_class
->group_modify(new_ofgroup
);
6714 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6715 cmap_replace(&ofproto
->groups
, &ofgroup
->cmap_node
,
6716 &new_ofgroup
->cmap_node
, hash_int(ofgroup
->group_id
, 0));
6718 if (ofgroup
->type
!= new_ofgroup
->type
) {
6719 ofproto
->n_groups
[ofgroup
->type
]--;
6720 ofproto
->n_groups
[new_ofgroup
->type
]++;
6724 ofproto_group_unref(retiring
);
6725 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6729 /* Implements the OFPGC11_ADD_OR_MOD command which creates the group when it does not
6730 * exist yet and modifies it otherwise */
6732 add_or_modify_group(struct ofproto
*ofproto
, const struct ofputil_group_mod
*gm
)
6737 exists
= ofproto_group_exists(ofproto
, gm
->group_id
);
6739 /* XXX: Race: Should hold groups_rwlock here. */
6742 error
= add_group(ofproto
, gm
);
6744 error
= modify_group(ofproto
, gm
);
6750 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
6751 OVS_RELEASES(ofproto
->groups_rwlock
)
6754 struct ofproto_flow_mod ofm
;
6756 /* Delete all flow entries containing this group in a group action */
6757 match_init_catchall(&match
);
6758 flow_mod_init(&ofm
.fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
6759 ofm
.fm
.delete_reason
= OFPRR_GROUP_DELETE
;
6760 ofm
.fm
.out_group
= ofgroup
->group_id
;
6761 ofm
.fm
.table_id
= OFPTT_ALL
;
6762 handle_flow_mod__(ofproto
, &ofm
, NULL
);
6764 cmap_remove(&ofproto
->groups
, &ofgroup
->cmap_node
,
6765 hash_int(ofgroup
->group_id
, 0));
6766 /* No-one can find this group any more, but current users may continue to
6768 ofproto
->n_groups
[ofgroup
->type
]--;
6769 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6770 ofproto_group_unref(ofgroup
);
6773 /* Implements OFPGC11_DELETE. */
6775 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
6777 struct ofgroup
*ofgroup
;
6779 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6780 if (group_id
== OFPG_ALL
) {
6782 struct cmap_node
*node
= cmap_first(&ofproto
->groups
);
6786 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, cmap_node
);
6787 delete_group__(ofproto
, ofgroup
); /* Releases the mutex. */
6788 /* Lock for each node separately, so that we will not jam the
6789 * other threads for too long time. */
6790 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6793 CMAP_FOR_EACH_WITH_HASH (ofgroup
, cmap_node
,
6794 hash_int(group_id
, 0), &ofproto
->groups
) {
6795 if (ofgroup
->group_id
== group_id
) {
6796 delete_group__(ofproto
, ofgroup
);
6801 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6804 /* Delete all groups from 'ofproto'.
6806 * This is intended for use within an ofproto provider's 'destruct'
6809 ofproto_group_delete_all(struct ofproto
*ofproto
)
6811 delete_group(ofproto
, OFPG_ALL
);
6815 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6817 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6818 struct ofputil_group_mod gm
;
6821 error
= reject_slave_controller(ofconn
);
6826 error
= ofputil_decode_group_mod(oh
, &gm
);
6831 switch (gm
.command
) {
6833 error
= add_group(ofproto
, &gm
);
6836 case OFPGC11_MODIFY
:
6837 error
= modify_group(ofproto
, &gm
);
6840 case OFPGC11_ADD_OR_MOD
:
6841 error
= add_or_modify_group(ofproto
, &gm
);
6844 case OFPGC11_DELETE
:
6845 delete_group(ofproto
, gm
.group_id
);
6849 case OFPGC15_INSERT_BUCKET
:
6850 error
= modify_group(ofproto
, &gm
);
6853 case OFPGC15_REMOVE_BUCKET
:
6854 error
= modify_group(ofproto
, &gm
);
6858 if (gm
.command
> OFPGC11_DELETE
) {
6859 VLOG_INFO_RL(&rl
, "%s: Invalid group_mod command type %d",
6860 ofproto
->name
, gm
.command
);
6862 error
= OFPERR_OFPGMFC_BAD_COMMAND
;
6866 struct ofputil_requestforward rf
;
6868 rf
.reason
= OFPRFR_GROUP_MOD
;
6870 connmgr_send_requestforward(ofproto
->connmgr
, ofconn
, &rf
);
6872 ofputil_bucket_list_destroy(&gm
.buckets
);
6877 enum ofputil_table_miss
6878 ofproto_table_get_miss_config(const struct ofproto
*ofproto
, uint8_t table_id
)
6880 enum ofputil_table_miss miss
;
6882 atomic_read_relaxed(&ofproto
->tables
[table_id
].miss_config
, &miss
);
6887 table_mod__(struct oftable
*oftable
,
6888 const struct ofputil_table_mod
*tm
)
6890 if (tm
->miss
== OFPUTIL_TABLE_MISS_DEFAULT
) {
6891 /* This is how an OFPT_TABLE_MOD decodes if it doesn't specify any
6892 * table-miss configuration (because the protocol used doesn't have
6893 * such a concept), so there's nothing to do. */
6895 atomic_store_relaxed(&oftable
->miss_config
, tm
->miss
);
6898 unsigned int new_eviction
= oftable
->eviction
;
6899 if (tm
->eviction
== OFPUTIL_TABLE_EVICTION_ON
) {
6900 new_eviction
|= EVICTION_OPENFLOW
;
6901 } else if (tm
->eviction
== OFPUTIL_TABLE_EVICTION_OFF
) {
6902 new_eviction
&= ~EVICTION_OPENFLOW
;
6905 if (new_eviction
!= oftable
->eviction
) {
6906 ovs_mutex_lock(&ofproto_mutex
);
6907 oftable_configure_eviction(oftable
, new_eviction
,
6908 oftable
->eviction_fields
,
6909 oftable
->n_eviction_fields
);
6910 ovs_mutex_unlock(&ofproto_mutex
);
6913 if (tm
->vacancy
!= OFPUTIL_TABLE_VACANCY_DEFAULT
) {
6914 ovs_mutex_lock(&ofproto_mutex
);
6915 oftable
->vacancy_down
= tm
->table_vacancy
.vacancy_down
;
6916 oftable
->vacancy_up
= tm
->table_vacancy
.vacancy_up
;
6917 if (tm
->vacancy
== OFPUTIL_TABLE_VACANCY_OFF
) {
6918 oftable
->vacancy_event
= 0;
6919 } else if (!oftable
->vacancy_event
) {
6920 uint8_t vacancy
= oftable_vacancy(oftable
);
6921 oftable
->vacancy_event
= (vacancy
< oftable
->vacancy_up
6923 : OFPTR_VACANCY_DOWN
);
6925 ovs_mutex_unlock(&ofproto_mutex
);
6930 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
6932 if (!check_table_id(ofproto
, tm
->table_id
)) {
6933 return OFPERR_OFPTMFC_BAD_TABLE
;
6936 /* Don't allow the eviction flags to be changed (except to the only fixed
6937 * value that OVS supports). OF1.4 says this is normal: "The
6938 * OFPTMPT_EVICTION property usually cannot be modified using a
6939 * OFP_TABLE_MOD request, because the eviction mechanism is switch
6941 if (tm
->eviction_flags
!= UINT32_MAX
6942 && tm
->eviction_flags
!= OFPROTO_EVICTION_FLAGS
) {
6943 return OFPERR_OFPTMFC_BAD_CONFIG
;
6946 if (tm
->table_id
== OFPTT_ALL
) {
6947 struct oftable
*oftable
;
6948 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
6949 if (!(oftable
->flags
& (OFTABLE_HIDDEN
| OFTABLE_READONLY
))) {
6950 table_mod__(oftable
, tm
);
6954 struct oftable
*oftable
= &ofproto
->tables
[tm
->table_id
];
6955 if (oftable
->flags
& OFTABLE_READONLY
) {
6956 return OFPERR_OFPTMFC_EPERM
;
6958 table_mod__(oftable
, tm
);
6965 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6967 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6968 struct ofputil_table_mod tm
;
6971 error
= reject_slave_controller(ofconn
);
6976 error
= ofputil_decode_table_mod(oh
, &tm
);
6981 return table_mod(ofproto
, &tm
);
6985 ofproto_flow_mod_start(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
6986 OVS_REQUIRES(ofproto_mutex
)
6988 switch (ofm
->fm
.command
) {
6990 return add_flow_start(ofproto
, ofm
);
6991 /* , &be->old_rules.stub[0],
6992 &be->new_rules.stub[0]); */
6994 return modify_flows_start_loose(ofproto
, ofm
);
6995 case OFPFC_MODIFY_STRICT
:
6996 return modify_flow_start_strict(ofproto
, ofm
);
6998 return delete_flows_start_loose(ofproto
, ofm
);
7000 case OFPFC_DELETE_STRICT
:
7001 return delete_flow_start_strict(ofproto
, ofm
);
7004 return OFPERR_OFPFMFC_BAD_COMMAND
;
7008 ofproto_flow_mod_revert(struct ofproto
*ofproto
, struct ofproto_flow_mod
*ofm
)
7009 OVS_REQUIRES(ofproto_mutex
)
7011 switch (ofm
->fm
.command
) {
7013 add_flow_revert(ofproto
, ofm
);
7017 case OFPFC_MODIFY_STRICT
:
7018 modify_flows_revert(ofproto
, ofm
);
7022 case OFPFC_DELETE_STRICT
:
7023 delete_flows_revert(ofproto
, ofm
);
7032 ofproto_flow_mod_finish(struct ofproto
*ofproto
,
7033 struct ofproto_flow_mod
*ofm
,
7034 const struct flow_mod_requester
*req
)
7035 OVS_REQUIRES(ofproto_mutex
)
7037 switch (ofm
->fm
.command
) {
7039 add_flow_finish(ofproto
, ofm
, req
);
7043 case OFPFC_MODIFY_STRICT
:
7044 modify_flows_finish(ofproto
, ofm
, req
);
7048 case OFPFC_DELETE_STRICT
:
7049 delete_flows_finish(ofproto
, ofm
, req
);
7057 /* Commit phases (all while locking ofproto_mutex):
7059 * 1. Begin: Gather resources and make changes visible in the next version.
7060 * - Mark affected rules for removal in the next version.
7061 * - Create new replacement rules, make visible in the next
7063 * - Do not send any events or notifications.
7065 * 2. Revert: Fail if any errors are found. After this point no errors are
7066 * possible. No visible changes were made, so rollback is minimal (remove
7067 * added invisible rules, restore visibility of rules marked for removal).
7069 * 3. Finish: Make the changes visible for lookups. Insert replacement rules to
7070 * the ofproto provider. Remove replaced and deleted rules from ofproto data
7071 * structures, and Schedule postponed removal of deleted rules from the
7072 * classifier. Send notifications, buffered packets, etc.
7075 do_bundle_commit(struct ofconn
*ofconn
, uint32_t id
, uint16_t flags
)
7077 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
7078 ovs_version_t version
= ofproto
->tables_version
+ 1;
7079 struct ofp_bundle
*bundle
;
7080 struct ofp_bundle_entry
*be
;
7083 bundle
= ofconn_get_bundle(ofconn
, id
);
7086 return OFPERR_OFPBFC_BAD_ID
;
7088 if (bundle
->flags
!= flags
) {
7089 error
= OFPERR_OFPBFC_BAD_FLAGS
;
7091 bool prev_is_port_mod
= false;
7094 ovs_mutex_lock(&ofproto_mutex
);
7097 LIST_FOR_EACH (be
, node
, &bundle
->msg_list
) {
7098 if (be
->type
== OFPTYPE_PORT_MOD
) {
7099 /* Our port mods are not atomic. */
7100 if (flags
& OFPBF_ATOMIC
) {
7101 error
= OFPERR_OFPBFC_MSG_FAILED
;
7103 prev_is_port_mod
= true;
7104 error
= port_mod_start(ofconn
, &be
->opm
.pm
, &be
->opm
.port
);
7106 } else if (be
->type
== OFPTYPE_FLOW_MOD
) {
7107 /* Flow mods between port mods are applied as a single
7108 * version, but the versions are published only after
7109 * we know the commit is successful. */
7110 if (prev_is_port_mod
) {
7113 prev_is_port_mod
= false;
7114 /* Store the version in which the changes should take
7116 be
->ofm
.version
= version
;
7117 error
= ofproto_flow_mod_start(ofproto
, &be
->ofm
);
7127 /* Send error referring to the original message. */
7129 ofconn_send_error(ofconn
, be
->ofp_msg
, error
);
7130 error
= OFPERR_OFPBFC_MSG_FAILED
;
7133 /* 2. Revert. Undo all the changes made above. */
7134 LIST_FOR_EACH_REVERSE_CONTINUE(be
, node
, &bundle
->msg_list
) {
7135 if (be
->type
== OFPTYPE_FLOW_MOD
) {
7136 ofproto_flow_mod_revert(ofproto
, &be
->ofm
);
7138 /* Nothing needs to be reverted for a port mod. */
7142 LIST_FOR_EACH (be
, node
, &bundle
->msg_list
) {
7143 if (be
->type
== OFPTYPE_FLOW_MOD
) {
7144 struct flow_mod_requester req
= { ofconn
, be
->ofp_msg
};
7146 /* Bump the lookup version to the one of the current
7147 * message. This makes all the changes in the bundle at
7148 * this version visible to lookups at once. */
7149 if (ofproto
->tables_version
< be
->ofm
.version
) {
7150 ofproto
->tables_version
= be
->ofm
.version
;
7151 ofproto
->ofproto_class
->set_tables_version(
7152 ofproto
, ofproto
->tables_version
);
7155 ofproto_flow_mod_finish(ofproto
, &be
->ofm
, &req
);
7156 } else if (be
->type
== OFPTYPE_PORT_MOD
) {
7157 /* Perform the actual port mod. This is not atomic, i.e.,
7158 * the effects will be immediately seen by upcall
7159 * processing regardless of the lookup version. It should
7160 * be noted that port configuration changes can originate
7161 * also from OVSDB changes asynchronously to all upcall
7163 port_mod_finish(ofconn
, &be
->opm
.pm
, be
->opm
.port
);
7168 ofmonitor_flush(ofproto
->connmgr
);
7169 ovs_mutex_unlock(&ofproto_mutex
);
7171 run_rule_executes(ofproto
);
7174 /* The bundle is discarded regardless the outcome. */
7175 ofp_bundle_remove__(ofconn
, bundle
, !error
);
7180 handle_bundle_control(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7182 struct ofputil_bundle_ctrl_msg bctrl
;
7183 struct ofputil_bundle_ctrl_msg reply
;
7187 error
= reject_slave_controller(ofconn
);
7192 error
= ofputil_decode_bundle_ctrl(oh
, &bctrl
);
7197 reply
.bundle_id
= bctrl
.bundle_id
;
7199 switch (bctrl
.type
) {
7200 case OFPBCT_OPEN_REQUEST
:
7201 error
= ofp_bundle_open(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
7202 reply
.type
= OFPBCT_OPEN_REPLY
;
7204 case OFPBCT_CLOSE_REQUEST
:
7205 error
= ofp_bundle_close(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
7206 reply
.type
= OFPBCT_CLOSE_REPLY
;
7208 case OFPBCT_COMMIT_REQUEST
:
7209 error
= do_bundle_commit(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
7210 reply
.type
= OFPBCT_COMMIT_REPLY
;
7212 case OFPBCT_DISCARD_REQUEST
:
7213 error
= ofp_bundle_discard(ofconn
, bctrl
.bundle_id
);
7214 reply
.type
= OFPBCT_DISCARD_REPLY
;
7217 case OFPBCT_OPEN_REPLY
:
7218 case OFPBCT_CLOSE_REPLY
:
7219 case OFPBCT_COMMIT_REPLY
:
7220 case OFPBCT_DISCARD_REPLY
:
7221 return OFPERR_OFPBFC_BAD_TYPE
;
7226 buf
= ofputil_encode_bundle_ctrl_reply(oh
, &reply
);
7227 ofconn_send_reply(ofconn
, buf
);
7233 handle_bundle_add(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7235 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
7237 struct ofputil_bundle_add_msg badd
;
7238 struct ofp_bundle_entry
*bmsg
;
7241 error
= reject_slave_controller(ofconn
);
7246 error
= ofputil_decode_bundle_add(oh
, &badd
, &type
);
7251 bmsg
= ofp_bundle_entry_alloc(type
, badd
.msg
);
7253 if (type
== OFPTYPE_PORT_MOD
) {
7254 error
= ofputil_decode_port_mod(badd
.msg
, &bmsg
->opm
.pm
, false);
7255 } else if (type
== OFPTYPE_FLOW_MOD
) {
7256 struct ofpbuf ofpacts
;
7257 uint64_t ofpacts_stub
[1024 / 8];
7259 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
7260 error
= ofputil_decode_flow_mod(&bmsg
->ofm
.fm
, badd
.msg
,
7261 ofconn_get_protocol(ofconn
),
7263 u16_to_ofp(ofproto
->max_ports
),
7265 /* Move actions to heap. */
7266 bmsg
->ofm
.fm
.ofpacts
= ofpbuf_steal_data(&ofpacts
);
7268 if (!error
&& bmsg
->ofm
.fm
.ofpacts_len
) {
7269 error
= ofproto_check_ofpacts(ofproto
, bmsg
->ofm
.fm
.ofpacts
,
7270 bmsg
->ofm
.fm
.ofpacts_len
);
7277 error
= ofp_bundle_add_message(ofconn
, badd
.bundle_id
, badd
.flags
,
7282 ofp_bundle_entry_free(bmsg
);
7289 handle_tlv_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7291 struct ofputil_tlv_table_mod ttm
;
7294 error
= reject_slave_controller(ofconn
);
7299 error
= ofputil_decode_tlv_table_mod(oh
, &ttm
);
7304 error
= tun_metadata_table_mod(&ttm
);
7306 ofputil_uninit_tlv_table(&ttm
.mappings
);
7311 handle_tlv_table_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
7313 struct ofputil_tlv_table_reply ttr
;
7316 tun_metadata_table_request(&ttr
);
7317 b
= ofputil_encode_tlv_table_reply(oh
, &ttr
);
7318 ofputil_uninit_tlv_table(&ttr
.mappings
);
7320 ofconn_send_reply(ofconn
, b
);
7325 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
7326 OVS_EXCLUDED(ofproto_mutex
)
7328 const struct ofp_header
*oh
= msg
->data
;
7332 error
= ofptype_decode(&type
, oh
);
7336 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
7337 && ofpmp_more(oh
)) {
7338 /* We have no buffer implementation for multipart requests.
7339 * Report overflow for requests which consists of multiple
7341 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
7345 /* OpenFlow requests. */
7346 case OFPTYPE_ECHO_REQUEST
:
7347 return handle_echo_request(ofconn
, oh
);
7349 case OFPTYPE_FEATURES_REQUEST
:
7350 return handle_features_request(ofconn
, oh
);
7352 case OFPTYPE_GET_CONFIG_REQUEST
:
7353 return handle_get_config_request(ofconn
, oh
);
7355 case OFPTYPE_SET_CONFIG
:
7356 return handle_set_config(ofconn
, oh
);
7358 case OFPTYPE_PACKET_OUT
:
7359 return handle_packet_out(ofconn
, oh
);
7361 case OFPTYPE_PORT_MOD
:
7362 return handle_port_mod(ofconn
, oh
);
7364 case OFPTYPE_FLOW_MOD
:
7365 return handle_flow_mod(ofconn
, oh
);
7367 case OFPTYPE_GROUP_MOD
:
7368 return handle_group_mod(ofconn
, oh
);
7370 case OFPTYPE_TABLE_MOD
:
7371 return handle_table_mod(ofconn
, oh
);
7373 case OFPTYPE_METER_MOD
:
7374 return handle_meter_mod(ofconn
, oh
);
7376 case OFPTYPE_BARRIER_REQUEST
:
7377 return handle_barrier_request(ofconn
, oh
);
7379 case OFPTYPE_ROLE_REQUEST
:
7380 return handle_role_request(ofconn
, oh
);
7382 /* OpenFlow replies. */
7383 case OFPTYPE_ECHO_REPLY
:
7386 /* Nicira extension requests. */
7387 case OFPTYPE_FLOW_MOD_TABLE_ID
:
7388 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
7390 case OFPTYPE_SET_FLOW_FORMAT
:
7391 return handle_nxt_set_flow_format(ofconn
, oh
);
7393 case OFPTYPE_SET_PACKET_IN_FORMAT
:
7394 return handle_nxt_set_packet_in_format(ofconn
, oh
);
7396 case OFPTYPE_SET_CONTROLLER_ID
:
7397 return handle_nxt_set_controller_id(ofconn
, oh
);
7399 case OFPTYPE_FLOW_AGE
:
7400 /* Nothing to do. */
7403 case OFPTYPE_FLOW_MONITOR_CANCEL
:
7404 return handle_flow_monitor_cancel(ofconn
, oh
);
7406 case OFPTYPE_SET_ASYNC_CONFIG
:
7407 return handle_nxt_set_async_config(ofconn
, oh
);
7409 case OFPTYPE_GET_ASYNC_REQUEST
:
7410 return handle_nxt_get_async_request(ofconn
, oh
);
7412 case OFPTYPE_NXT_RESUME
:
7413 return handle_nxt_resume(ofconn
, oh
);
7415 /* Statistics requests. */
7416 case OFPTYPE_DESC_STATS_REQUEST
:
7417 return handle_desc_stats_request(ofconn
, oh
);
7419 case OFPTYPE_FLOW_STATS_REQUEST
:
7420 return handle_flow_stats_request(ofconn
, oh
);
7422 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
7423 return handle_aggregate_stats_request(ofconn
, oh
);
7425 case OFPTYPE_TABLE_STATS_REQUEST
:
7426 return handle_table_stats_request(ofconn
, oh
);
7428 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
7429 return handle_table_features_request(ofconn
, oh
);
7431 case OFPTYPE_TABLE_DESC_REQUEST
:
7432 return handle_table_desc_request(ofconn
, oh
);
7434 case OFPTYPE_PORT_STATS_REQUEST
:
7435 return handle_port_stats_request(ofconn
, oh
);
7437 case OFPTYPE_QUEUE_STATS_REQUEST
:
7438 return handle_queue_stats_request(ofconn
, oh
);
7440 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
7441 return handle_port_desc_stats_request(ofconn
, oh
);
7443 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
7444 return handle_flow_monitor_request(ofconn
, oh
);
7446 case OFPTYPE_METER_STATS_REQUEST
:
7447 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
7448 return handle_meter_request(ofconn
, oh
, type
);
7450 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
7451 return handle_meter_features_request(ofconn
, oh
);
7453 case OFPTYPE_GROUP_STATS_REQUEST
:
7454 return handle_group_stats_request(ofconn
, oh
);
7456 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
7457 return handle_group_desc_stats_request(ofconn
, oh
);
7459 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
7460 return handle_group_features_stats_request(ofconn
, oh
);
7462 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
7463 return handle_queue_get_config_request(ofconn
, oh
);
7465 case OFPTYPE_BUNDLE_CONTROL
:
7466 return handle_bundle_control(ofconn
, oh
);
7468 case OFPTYPE_BUNDLE_ADD_MESSAGE
:
7469 return handle_bundle_add(ofconn
, oh
);
7471 case OFPTYPE_NXT_TLV_TABLE_MOD
:
7472 return handle_tlv_table_mod(ofconn
, oh
);
7474 case OFPTYPE_NXT_TLV_TABLE_REQUEST
:
7475 return handle_tlv_table_request(ofconn
, oh
);
7477 case OFPTYPE_IPFIX_BRIDGE_STATS_REQUEST
:
7478 return handle_ipfix_bridge_stats_request(ofconn
, oh
);
7480 case OFPTYPE_IPFIX_FLOW_STATS_REQUEST
:
7481 return handle_ipfix_flow_stats_request(ofconn
, oh
);
7485 case OFPTYPE_FEATURES_REPLY
:
7486 case OFPTYPE_GET_CONFIG_REPLY
:
7487 case OFPTYPE_PACKET_IN
:
7488 case OFPTYPE_FLOW_REMOVED
:
7489 case OFPTYPE_PORT_STATUS
:
7490 case OFPTYPE_BARRIER_REPLY
:
7491 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
7492 case OFPTYPE_DESC_STATS_REPLY
:
7493 case OFPTYPE_FLOW_STATS_REPLY
:
7494 case OFPTYPE_QUEUE_STATS_REPLY
:
7495 case OFPTYPE_PORT_STATS_REPLY
:
7496 case OFPTYPE_TABLE_STATS_REPLY
:
7497 case OFPTYPE_AGGREGATE_STATS_REPLY
:
7498 case OFPTYPE_PORT_DESC_STATS_REPLY
:
7499 case OFPTYPE_ROLE_REPLY
:
7500 case OFPTYPE_FLOW_MONITOR_PAUSED
:
7501 case OFPTYPE_FLOW_MONITOR_RESUMED
:
7502 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
7503 case OFPTYPE_GET_ASYNC_REPLY
:
7504 case OFPTYPE_GROUP_STATS_REPLY
:
7505 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
7506 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
7507 case OFPTYPE_METER_STATS_REPLY
:
7508 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
7509 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
7510 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
7511 case OFPTYPE_TABLE_DESC_REPLY
:
7512 case OFPTYPE_ROLE_STATUS
:
7513 case OFPTYPE_REQUESTFORWARD
:
7514 case OFPTYPE_TABLE_STATUS
:
7515 case OFPTYPE_NXT_TLV_TABLE_REPLY
:
7516 case OFPTYPE_IPFIX_BRIDGE_STATS_REPLY
:
7517 case OFPTYPE_IPFIX_FLOW_STATS_REPLY
:
7519 if (ofpmsg_is_stat_request(oh
)) {
7520 return OFPERR_OFPBRC_BAD_STAT
;
7522 return OFPERR_OFPBRC_BAD_TYPE
;
7528 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
7529 OVS_EXCLUDED(ofproto_mutex
)
7531 enum ofperr error
= handle_openflow__(ofconn
, ofp_msg
);
7534 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
7536 COVERAGE_INC(ofproto_recv_openflow
);
7539 /* Asynchronous operations. */
7542 send_buffered_packet(const struct flow_mod_requester
*req
, uint32_t buffer_id
,
7544 OVS_REQUIRES(ofproto_mutex
)
7546 if (req
&& req
->ofconn
&& buffer_id
!= UINT32_MAX
) {
7547 struct ofproto
*ofproto
= ofconn_get_ofproto(req
->ofconn
);
7548 struct dp_packet
*packet
;
7552 error
= ofconn_pktbuf_retrieve(req
->ofconn
, buffer_id
, &packet
,
7555 struct rule_execute
*re
;
7557 ofproto_rule_ref(rule
);
7559 re
= xmalloc(sizeof *re
);
7561 re
->in_port
= in_port
;
7562 re
->packet
= packet
;
7564 if (!guarded_list_push_back(&ofproto
->rule_executes
,
7565 &re
->list_node
, 1024)) {
7566 ofproto_rule_unref(rule
);
7567 dp_packet_delete(re
->packet
);
7571 ofconn_send_error(req
->ofconn
, req
->request
, error
);
7577 pick_datapath_id(const struct ofproto
*ofproto
)
7579 const struct ofport
*port
;
7581 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
7586 error
= netdev_get_etheraddr(port
->netdev
, &ea
);
7588 return eth_addr_to_uint64(ea
);
7590 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7591 ofproto
->name
, netdev_get_name(port
->netdev
),
7592 ovs_strerror(error
));
7594 return ofproto
->fallback_dpid
;
7598 pick_fallback_dpid(void)
7601 eth_addr_nicira_random(&ea
);
7602 return eth_addr_to_uint64(ea
);
7605 /* Table overflow policy. */
7607 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7608 * to NULL if the table is not configured to evict rules or if the table
7609 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7610 * or with no timeouts are not evictable.) */
7612 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
7613 OVS_REQUIRES(ofproto_mutex
)
7615 struct eviction_group
*evg
;
7618 if (!table
->eviction
) {
7622 /* In the common case, the outer and inner loops here will each be entered
7625 * - The inner loop normally "return"s in its first iteration. If the
7626 * eviction group has any evictable rules, then it always returns in
7629 * - The outer loop only iterates more than once if the largest eviction
7630 * group has no evictable rules.
7632 * - The outer loop can exit only if table's 'max_flows' is all filled up
7633 * by unevictable rules. */
7634 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
7637 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
7646 /* Eviction groups. */
7648 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7649 * rules. The priority contains low-order random bits to ensure that eviction
7650 * groups with the same number of rules are prioritized randomly. */
7652 eviction_group_priority(size_t n_rules
)
7654 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
7655 return (size
<< 16) | random_uint16();
7658 /* Updates 'evg', an eviction_group within 'table', following a change that
7659 * adds or removes rules in 'evg'. */
7661 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
7662 OVS_REQUIRES(ofproto_mutex
)
7664 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
7665 eviction_group_priority(heap_count(&evg
->rules
)));
7668 /* Destroys 'evg', an eviction_group within 'table':
7670 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7671 * rules themselves, just removes them from the eviction group.)
7673 * - Removes 'evg' from 'table'.
7677 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
7678 OVS_REQUIRES(ofproto_mutex
)
7680 while (!heap_is_empty(&evg
->rules
)) {
7683 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
7684 rule
->eviction_group
= NULL
;
7686 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
7687 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
7688 heap_destroy(&evg
->rules
);
7692 /* Removes 'rule' from its eviction group, if any. */
7694 eviction_group_remove_rule(struct rule
*rule
)
7695 OVS_REQUIRES(ofproto_mutex
)
7697 if (rule
->eviction_group
) {
7698 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
7699 struct eviction_group
*evg
= rule
->eviction_group
;
7701 rule
->eviction_group
= NULL
;
7702 heap_remove(&evg
->rules
, &rule
->evg_node
);
7703 if (heap_is_empty(&evg
->rules
)) {
7704 eviction_group_destroy(table
, evg
);
7706 eviction_group_resized(table
, evg
);
7711 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7712 * returns the hash value. */
7714 eviction_group_hash_rule(struct rule
*rule
)
7715 OVS_REQUIRES(ofproto_mutex
)
7717 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
7718 const struct mf_subfield
*sf
;
7722 hash
= table
->eviction_group_id_basis
;
7723 miniflow_expand(rule
->cr
.match
.flow
, &flow
);
7724 for (sf
= table
->eviction_fields
;
7725 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
7728 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
7729 union mf_value value
;
7731 mf_get_value(sf
->field
, &flow
, &value
);
7733 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
7735 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
7736 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
7737 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
7738 sf
->field
->n_bytes
* 8 - start
);
7740 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
7742 hash
= hash_int(hash
, 0);
7749 /* Returns an eviction group within 'table' with the given 'id', creating one
7751 static struct eviction_group
*
7752 eviction_group_find(struct oftable
*table
, uint32_t id
)
7753 OVS_REQUIRES(ofproto_mutex
)
7755 struct eviction_group
*evg
;
7757 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
7761 evg
= xmalloc(sizeof *evg
);
7762 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
7763 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
7764 eviction_group_priority(0));
7765 heap_init(&evg
->rules
);
7770 /* Returns an eviction priority for 'rule'. The return value should be
7771 * interpreted so that higher priorities make a rule a more attractive
7772 * candidate for eviction. */
7774 rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*rule
)
7775 OVS_REQUIRES(ofproto_mutex
)
7777 /* Calculate absolute time when this flow will expire. If it will never
7778 * expire, then return 0 to make it unevictable. */
7779 long long int expiration
= LLONG_MAX
;
7780 if (rule
->hard_timeout
) {
7781 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7782 ovs_mutex_lock(&rule
->mutex
);
7783 long long int modified
= rule
->modified
;
7784 ovs_mutex_unlock(&rule
->mutex
);
7786 expiration
= modified
+ rule
->hard_timeout
* 1000;
7788 if (rule
->idle_timeout
) {
7789 uint64_t packets
, bytes
;
7791 long long int idle_expiration
;
7793 ofproto
->ofproto_class
->rule_get_stats(rule
, &packets
, &bytes
, &used
);
7794 idle_expiration
= used
+ rule
->idle_timeout
* 1000;
7795 expiration
= MIN(expiration
, idle_expiration
);
7797 if (expiration
== LLONG_MAX
) {
7801 /* Calculate the time of expiration as a number of (approximate) seconds
7802 * after program startup.
7804 * This should work OK for program runs that last UINT32_MAX seconds or
7805 * less. Therefore, please restart OVS at least once every 136 years. */
7806 uint32_t expiration_ofs
= (expiration
>> 10) - (time_boot_msec() >> 10);
7808 /* Combine expiration time with OpenFlow "importance" to form a single
7809 * priority value. We want flows with relatively low "importance" to be
7810 * evicted before even considering expiration time, so put "importance" in
7811 * the most significant bits and expiration time in the least significant
7814 * Small 'priority' should be evicted before those with large 'priority'.
7815 * The caller expects the opposite convention (a large return value being
7816 * more attractive for eviction) so we invert it before returning. */
7817 uint64_t priority
= ((uint64_t) rule
->importance
<< 32) + expiration_ofs
;
7818 return UINT64_MAX
- priority
;
7821 /* Adds 'rule' to an appropriate eviction group for its oftable's
7822 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7823 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7826 * The caller must ensure that 'rule' is not already in an eviction group. */
7828 eviction_group_add_rule(struct rule
*rule
)
7829 OVS_REQUIRES(ofproto_mutex
)
7831 struct ofproto
*ofproto
= rule
->ofproto
;
7832 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
7835 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7836 * so no additional protection is needed. */
7837 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
7839 if (table
->eviction
&& has_timeout
) {
7840 struct eviction_group
*evg
;
7842 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
7844 rule
->eviction_group
= evg
;
7845 heap_insert(&evg
->rules
, &rule
->evg_node
,
7846 rule_eviction_priority(ofproto
, rule
));
7847 eviction_group_resized(table
, evg
);
7853 /* Initializes 'table'. */
7855 oftable_init(struct oftable
*table
)
7857 memset(table
, 0, sizeof *table
);
7858 classifier_init(&table
->cls
, flow_segment_u64s
);
7859 table
->max_flows
= UINT_MAX
;
7861 hmap_init(&table
->eviction_groups_by_id
);
7862 heap_init(&table
->eviction_groups_by_size
);
7863 atomic_init(&table
->miss_config
, OFPUTIL_TABLE_MISS_DEFAULT
);
7865 classifier_set_prefix_fields(&table
->cls
, default_prefix_fields
,
7866 ARRAY_SIZE(default_prefix_fields
));
7868 atomic_init(&table
->n_matched
, 0);
7869 atomic_init(&table
->n_missed
, 0);
7872 /* Destroys 'table', including its classifier and eviction groups.
7874 * The caller is responsible for freeing 'table' itself. */
7876 oftable_destroy(struct oftable
*table
)
7878 ovs_assert(classifier_is_empty(&table
->cls
));
7880 ovs_mutex_lock(&ofproto_mutex
);
7881 oftable_configure_eviction(table
, 0, NULL
, 0);
7882 ovs_mutex_unlock(&ofproto_mutex
);
7884 hmap_destroy(&table
->eviction_groups_by_id
);
7885 heap_destroy(&table
->eviction_groups_by_size
);
7886 classifier_destroy(&table
->cls
);
7890 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7891 * string, then 'table' will use its default name.
7893 * This only affects the name exposed for a table exposed through the OpenFlow
7894 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7896 oftable_set_name(struct oftable
*table
, const char *name
)
7898 if (name
&& name
[0]) {
7899 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
7900 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
7902 table
->name
= xmemdup0(name
, len
);
7910 /* oftables support a choice of two policies when adding a rule would cause the
7911 * number of flows in the table to exceed the configured maximum number: either
7912 * they can refuse to add the new flow or they can evict some existing flow.
7913 * This function configures the latter policy on 'table', with fairness based
7914 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7915 * 'n_fields' as 0 disables fairness.) */
7917 oftable_configure_eviction(struct oftable
*table
, unsigned int eviction
,
7918 const struct mf_subfield
*fields
, size_t n_fields
)
7919 OVS_REQUIRES(ofproto_mutex
)
7923 if ((table
->eviction
!= 0) == (eviction
!= 0)
7924 && n_fields
== table
->n_eviction_fields
7926 || !memcmp(fields
, table
->eviction_fields
,
7927 n_fields
* sizeof *fields
))) {
7928 /* The set of eviction fields did not change. If 'eviction' changed,
7929 * it remains nonzero, so that we can just update table->eviction
7930 * without fussing with the eviction groups. */
7931 table
->eviction
= eviction
;
7935 /* Destroy existing eviction groups, then destroy and recreate data
7936 * structures to recover memory. */
7937 struct eviction_group
*evg
, *next
;
7938 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
, &table
->eviction_groups_by_id
) {
7939 eviction_group_destroy(table
, evg
);
7941 hmap_destroy(&table
->eviction_groups_by_id
);
7942 hmap_init(&table
->eviction_groups_by_id
);
7943 heap_destroy(&table
->eviction_groups_by_size
);
7944 heap_init(&table
->eviction_groups_by_size
);
7946 /* Replace eviction groups by the new ones, if there is a change. Free the
7947 * old fields only after allocating the new ones, because 'fields ==
7948 * table->eviction_fields' is possible. */
7949 struct mf_subfield
*old_fields
= table
->eviction_fields
;
7950 table
->n_eviction_fields
= n_fields
;
7951 table
->eviction_fields
= (fields
7952 ? xmemdup(fields
, n_fields
* sizeof *fields
)
7956 /* Add the new eviction groups, if enabled. */
7957 table
->eviction
= eviction
;
7958 if (table
->eviction
) {
7959 table
->eviction_group_id_basis
= random_uint32();
7960 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
7961 eviction_group_add_rule(rule
);
7966 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7967 * it to the classifier. */
7969 ofproto_rule_insert__(struct ofproto
*ofproto
, struct rule
*rule
)
7970 OVS_REQUIRES(ofproto_mutex
)
7972 const struct rule_actions
*actions
= rule_get_actions(rule
);
7974 ovs_assert(rule
->removed
);
7976 if (rule
->hard_timeout
|| rule
->idle_timeout
) {
7977 ovs_list_insert(&ofproto
->expirable
, &rule
->expirable
);
7979 cookies_insert(ofproto
, rule
);
7980 eviction_group_add_rule(rule
);
7981 if (actions
->has_meter
) {
7982 meter_insert_rule(rule
);
7984 rule
->removed
= false;
7987 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7988 * the removal from the classifier. */
7990 ofproto_rule_remove__(struct ofproto
*ofproto
, struct rule
*rule
)
7991 OVS_REQUIRES(ofproto_mutex
)
7993 ovs_assert(!rule
->removed
);
7995 cookies_remove(ofproto
, rule
);
7997 eviction_group_remove_rule(rule
);
7998 if (!ovs_list_is_empty(&rule
->expirable
)) {
7999 ovs_list_remove(&rule
->expirable
);
8001 if (!ovs_list_is_empty(&rule
->meter_list_node
)) {
8002 ovs_list_remove(&rule
->meter_list_node
);
8003 ovs_list_init(&rule
->meter_list_node
);
8006 rule
->removed
= true;
8009 /* unixctl commands. */
8012 ofproto_lookup(const char *name
)
8014 struct ofproto
*ofproto
;
8016 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
8018 if (!strcmp(ofproto
->name
, name
)) {
8026 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
8027 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
8029 struct ofproto
*ofproto
;
8033 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
8034 ds_put_format(&results
, "%s\n", ofproto
->name
);
8036 unixctl_command_reply(conn
, ds_cstr(&results
));
8037 ds_destroy(&results
);
8041 ofproto_unixctl_init(void)
8043 static bool registered
;
8049 unixctl_command_register("ofproto/list", "", 0, 0,
8050 ofproto_unixctl_list
, NULL
);