2 * Copyright (c) 2009-2015 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.
26 #include "byte-order.h"
27 #include "classifier.h"
28 #include "connectivity.h"
31 #include "dynamic-string.h"
34 #include "meta-flow.h"
37 #include "ofp-actions.h"
38 #include "ofp-errors.h"
40 #include "ofp-print.h"
43 #include "ofproto-provider.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
47 #include "dp-packet.h"
51 #include "poll-loop.h"
59 #include "unaligned.h"
61 #include "openvswitch/vlog.h"
64 VLOG_DEFINE_THIS_MODULE(ofproto
);
66 COVERAGE_DEFINE(ofproto_flush
);
67 COVERAGE_DEFINE(ofproto_packet_out
);
68 COVERAGE_DEFINE(ofproto_queue_req
);
69 COVERAGE_DEFINE(ofproto_recv_openflow
);
70 COVERAGE_DEFINE(ofproto_reinit_ports
);
71 COVERAGE_DEFINE(ofproto_update_port
);
73 /* Default fields to use for prefix tries in each flow table, unless something
74 * else is configured. */
75 const enum mf_field_id default_prefix_fields
[2] =
76 { MFF_IPV4_DST
, MFF_IPV4_SRC
};
79 static void oftable_init(struct oftable
*);
80 static void oftable_destroy(struct oftable
*);
82 static void oftable_set_name(struct oftable
*, const char *name
);
84 static enum ofperr
evict_rules_from_table(struct oftable
*)
85 OVS_REQUIRES(ofproto_mutex
);
86 static void oftable_disable_eviction(struct oftable
*);
87 static void oftable_enable_eviction(struct oftable
*,
88 const struct mf_subfield
*fields
,
91 /* A set of rules within a single OpenFlow table (oftable) that have the same
92 * values for the oftable's eviction_fields. A rule to be evicted, when one is
93 * needed, is taken from the eviction group that contains the greatest number
96 * An oftable owns any number of eviction groups, each of which contains any
99 * Membership in an eviction group is imprecise, based on the hash of the
100 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
101 * That is, if two rules have different eviction_fields, but those
102 * eviction_fields hash to the same value, then they will belong to the same
103 * eviction_group anyway.
105 * (When eviction is not enabled on an oftable, we don't track any eviction
106 * groups, to save time and space.) */
107 struct eviction_group
{
108 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
109 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
110 struct heap rules
; /* Contains "struct rule"s. */
113 static bool choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
114 OVS_REQUIRES(ofproto_mutex
);
115 static uint32_t rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*)
116 OVS_REQUIRES(ofproto_mutex
);;
117 static void eviction_group_add_rule(struct rule
*)
118 OVS_REQUIRES(ofproto_mutex
);
119 static void eviction_group_remove_rule(struct rule
*)
120 OVS_REQUIRES(ofproto_mutex
);
122 /* Criteria that flow_mod and other operations use for selecting rules on
123 * which to operate. */
124 struct rule_criteria
{
125 /* An OpenFlow table or 255 for all tables. */
128 /* OpenFlow matching criteria. Interpreted different in "loose" way by
129 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
130 * defined in the OpenFlow spec. */
133 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
134 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
135 * The rule will not be selected if M is 1 and B != C. */
137 ovs_be64 cookie_mask
;
139 /* Selection based on actions within a rule:
141 * If out_port != OFPP_ANY, selects only rules that output to out_port.
142 * If out_group != OFPG_ALL, select only rules that output to out_group. */
146 /* If true, collects only rules that are modifiable. */
148 bool include_readonly
;
151 static void rule_criteria_init(struct rule_criteria
*, uint8_t table_id
,
152 const struct match
*match
, int priority
,
154 ovs_be64 cookie
, ovs_be64 cookie_mask
,
155 ofp_port_t out_port
, uint32_t out_group
);
156 static void rule_criteria_require_rw(struct rule_criteria
*,
157 bool can_write_readonly
);
158 static void rule_criteria_destroy(struct rule_criteria
*);
160 static enum ofperr
collect_rules_loose(struct ofproto
*,
161 const struct rule_criteria
*,
162 struct rule_collection
*);
164 /* A packet that needs to be passed to rule_execute().
166 * (We can't do this immediately from ofopgroup_complete() because that holds
167 * ofproto_mutex, which rule_execute() needs released.) */
168 struct rule_execute
{
169 struct ovs_list list_node
; /* In struct ofproto's "rule_executes" list. */
170 struct rule
*rule
; /* Owns a reference to the rule. */
172 struct dp_packet
*packet
; /* Owns the packet. */
175 static void run_rule_executes(struct ofproto
*) OVS_EXCLUDED(ofproto_mutex
);
176 static void destroy_rule_executes(struct ofproto
*);
178 struct learned_cookie
{
180 /* In struct ofproto's 'learned_cookies' hmap. */
181 struct hmap_node hmap_node
OVS_GUARDED_BY(ofproto_mutex
);
183 /* In 'dead_cookies' list when removed from hmap. */
184 struct ovs_list list_node
;
188 ovs_be64 cookie
OVS_GUARDED_BY(ofproto_mutex
);
189 uint8_t table_id
OVS_GUARDED_BY(ofproto_mutex
);
191 /* Number of references from "learn" actions.
193 * When this drops to 0, all of the flows in 'table_id' with the specified
194 * 'cookie' are deleted. */
195 int n
OVS_GUARDED_BY(ofproto_mutex
);
198 static const struct ofpact_learn
*next_learn_with_delete(
199 const struct rule_actions
*, const struct ofpact_learn
*start
);
201 static void learned_cookies_inc(struct ofproto
*, const struct rule_actions
*)
202 OVS_REQUIRES(ofproto_mutex
);
203 static void learned_cookies_dec(struct ofproto
*, const struct rule_actions
*,
204 struct ovs_list
*dead_cookies
)
205 OVS_REQUIRES(ofproto_mutex
);
206 static void learned_cookies_flush(struct ofproto
*, struct ovs_list
*dead_cookies
)
207 OVS_REQUIRES(ofproto_mutex
);
210 static void ofport_destroy__(struct ofport
*) OVS_EXCLUDED(ofproto_mutex
);
211 static void ofport_destroy(struct ofport
*);
213 static void update_port(struct ofproto
*, const char *devname
);
214 static int init_ports(struct ofproto
*);
215 static void reinit_ports(struct ofproto
*);
217 static long long int ofport_get_usage(const struct ofproto
*,
218 ofp_port_t ofp_port
);
219 static void ofport_set_usage(struct ofproto
*, ofp_port_t ofp_port
,
220 long long int last_used
);
221 static void ofport_remove_usage(struct ofproto
*, ofp_port_t ofp_port
);
225 * Keeps track of the currently used and recently used ofport values and is
226 * used to prevent immediate recycling of ofport values. */
227 struct ofport_usage
{
228 struct hmap_node hmap_node
; /* In struct ofproto's "ofport_usage" hmap. */
229 ofp_port_t ofp_port
; /* OpenFlow port number. */
230 long long int last_used
; /* Last time the 'ofp_port' was used. LLONG_MAX
231 represents in-use ofports. */
235 static void ofproto_rule_send_removed(struct rule
*, uint8_t reason
);
236 static bool rule_is_readonly(const struct rule
*);
237 static void ofproto_rule_insert__(struct ofproto
*, struct rule
*)
238 OVS_REQUIRES(ofproto_mutex
);
239 static void ofproto_rule_remove__(struct ofproto
*, struct rule
*)
240 OVS_REQUIRES(ofproto_mutex
);
242 /* The source of a flow_mod request, in the code that processes flow_mods.
244 * A flow table modification request can be generated externally, via OpenFlow,
245 * or internally through a function call. This structure indicates the source
246 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
247 * meaningful and thus supplied as NULL. */
248 struct flow_mod_requester
{
249 struct ofconn
*ofconn
; /* Connection on which flow_mod arrived. */
250 const struct ofp_header
*request
;
254 static enum ofperr
replace_rule_create(struct ofproto
*,
255 struct ofputil_flow_mod
*,
256 struct cls_rule
*cr
, uint8_t table_id
,
257 struct rule
*old_rule
,
258 struct rule
**new_rule
)
259 OVS_REQUIRES(ofproto_mutex
);
261 static void replace_rule_start(struct ofproto
*,
262 struct rule
*old_rule
,
263 struct rule
*new_rule
,
264 struct cls_conjunction
*, size_t n_conjs
)
265 OVS_REQUIRES(ofproto_mutex
);
267 static void replace_rule_revert(struct ofproto
*, struct rule
*old_rule
,
268 struct rule
*new_rule
)
269 OVS_REQUIRES(ofproto_mutex
);
271 static void replace_rule_finish(struct ofproto
*, struct ofputil_flow_mod
*,
272 const struct flow_mod_requester
*,
273 struct rule
*old_rule
, struct rule
*new_rule
,
274 struct ovs_list
*dead_cookies
)
275 OVS_REQUIRES(ofproto_mutex
);
276 static void delete_flows__(struct rule_collection
*,
277 enum ofp_flow_removed_reason
,
278 const struct flow_mod_requester
*)
279 OVS_REQUIRES(ofproto_mutex
);
281 static void send_buffered_packet(const struct flow_mod_requester
*,
282 uint32_t buffer_id
, struct rule
*)
283 OVS_REQUIRES(ofproto_mutex
);
285 static bool ofproto_group_exists__(const struct ofproto
*ofproto
,
287 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
);
288 static bool ofproto_group_exists(const struct ofproto
*ofproto
,
290 OVS_EXCLUDED(ofproto
->groups_rwlock
);
291 static enum ofperr
add_group(struct ofproto
*, struct ofputil_group_mod
*);
292 static void handle_openflow(struct ofconn
*, const struct ofpbuf
*);
293 static enum ofperr
do_bundle_flow_mod_start(struct ofproto
*,
294 struct ofputil_flow_mod
*,
295 struct ofp_bundle_entry
*)
296 OVS_REQUIRES(ofproto_mutex
);
297 static void do_bundle_flow_mod_finish(struct ofproto
*,
298 struct ofputil_flow_mod
*,
299 const struct flow_mod_requester
*,
300 struct ofp_bundle_entry
*)
301 OVS_REQUIRES(ofproto_mutex
);
302 static enum ofperr
handle_flow_mod__(struct ofproto
*,
303 struct ofputil_flow_mod
*,
304 const struct flow_mod_requester
*)
305 OVS_EXCLUDED(ofproto_mutex
);
306 static void calc_duration(long long int start
, long long int now
,
307 uint32_t *sec
, uint32_t *nsec
);
310 static uint64_t pick_datapath_id(const struct ofproto
*);
311 static uint64_t pick_fallback_dpid(void);
312 static void ofproto_destroy__(struct ofproto
*);
313 static void update_mtu(struct ofproto
*, struct ofport
*);
314 static void meter_delete(struct ofproto
*, uint32_t first
, uint32_t last
);
315 static void meter_insert_rule(struct rule
*);
318 static void ofproto_unixctl_init(void);
320 /* All registered ofproto classes, in probe order. */
321 static const struct ofproto_class
**ofproto_classes
;
322 static size_t n_ofproto_classes
;
323 static size_t allocated_ofproto_classes
;
325 /* Global lock that protects all flow table operations. */
326 struct ovs_mutex ofproto_mutex
= OVS_MUTEX_INITIALIZER
;
328 unsigned ofproto_flow_limit
= OFPROTO_FLOW_LIMIT_DEFAULT
;
329 unsigned ofproto_max_idle
= OFPROTO_MAX_IDLE_DEFAULT
;
331 size_t n_handlers
, n_revalidators
;
335 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
336 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
338 /* Initial mappings of port to OpenFlow number mappings. */
339 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
341 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
343 /* The default value of true waits for flow restore. */
344 static bool flow_restore_wait
= true;
346 /* Must be called to initialize the ofproto library.
348 * The caller may pass in 'iface_hints', which contains an shash of
349 * "iface_hint" elements indexed by the interface's name. The provider
350 * may use these hints to describe the startup configuration in order to
351 * reinitialize its state. The caller owns the provided data, so a
352 * provider will make copies of anything required. An ofproto provider
353 * will remove any existing state that is not described by the hint, and
354 * may choose to remove it all. */
356 ofproto_init(const struct shash
*iface_hints
)
358 struct shash_node
*node
;
361 ofproto_class_register(&ofproto_dpif_class
);
363 /* Make a local copy, since we don't own 'iface_hints' elements. */
364 SHASH_FOR_EACH(node
, iface_hints
) {
365 const struct iface_hint
*orig_hint
= node
->data
;
366 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
367 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
369 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
370 new_hint
->br_type
= xstrdup(br_type
);
371 new_hint
->ofp_port
= orig_hint
->ofp_port
;
373 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
376 for (i
= 0; i
< n_ofproto_classes
; i
++) {
377 ofproto_classes
[i
]->init(&init_ofp_ports
);
381 /* 'type' should be a normalized datapath type, as returned by
382 * ofproto_normalize_type(). Returns the corresponding ofproto_class
383 * structure, or a null pointer if there is none registered for 'type'. */
384 static const struct ofproto_class
*
385 ofproto_class_find__(const char *type
)
389 for (i
= 0; i
< n_ofproto_classes
; i
++) {
390 const struct ofproto_class
*class = ofproto_classes
[i
];
395 class->enumerate_types(&types
);
396 found
= sset_contains(&types
, type
);
397 sset_destroy(&types
);
403 VLOG_WARN("unknown datapath type %s", type
);
407 /* Registers a new ofproto class. After successful registration, new ofprotos
408 * of that type can be created using ofproto_create(). */
410 ofproto_class_register(const struct ofproto_class
*new_class
)
414 for (i
= 0; i
< n_ofproto_classes
; i
++) {
415 if (ofproto_classes
[i
] == new_class
) {
420 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
421 ofproto_classes
= x2nrealloc(ofproto_classes
,
422 &allocated_ofproto_classes
,
423 sizeof *ofproto_classes
);
425 ofproto_classes
[n_ofproto_classes
++] = new_class
;
429 /* Unregisters a datapath provider. 'type' must have been previously
430 * registered and not currently be in use by any ofprotos. After
431 * unregistration new datapaths of that type cannot be opened using
432 * ofproto_create(). */
434 ofproto_class_unregister(const struct ofproto_class
*class)
438 for (i
= 0; i
< n_ofproto_classes
; i
++) {
439 if (ofproto_classes
[i
] == class) {
440 for (i
++; i
< n_ofproto_classes
; i
++) {
441 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
447 VLOG_WARN("attempted to unregister an ofproto class that is not "
452 /* Clears 'types' and enumerates all registered ofproto types into it. The
453 * caller must first initialize the sset. */
455 ofproto_enumerate_types(struct sset
*types
)
460 for (i
= 0; i
< n_ofproto_classes
; i
++) {
461 ofproto_classes
[i
]->enumerate_types(types
);
465 /* Returns the fully spelled out name for the given ofproto 'type'.
467 * Normalized type string can be compared with strcmp(). Unnormalized type
468 * string might be the same even if they have different spellings. */
470 ofproto_normalize_type(const char *type
)
472 return type
&& type
[0] ? type
: "system";
475 /* Clears 'names' and enumerates the names of all known created ofprotos with
476 * the given 'type'. The caller must first initialize the sset. Returns 0 if
477 * successful, otherwise a positive errno value.
479 * Some kinds of datapaths might not be practically enumerable. This is not
480 * considered an error. */
482 ofproto_enumerate_names(const char *type
, struct sset
*names
)
484 const struct ofproto_class
*class = ofproto_class_find__(type
);
485 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
489 ofproto_bump_tables_version(struct ofproto
*ofproto
)
491 ++ofproto
->tables_version
;
492 ofproto
->ofproto_class
->set_tables_version(ofproto
,
493 ofproto
->tables_version
);
497 ofproto_create(const char *datapath_name
, const char *datapath_type
,
498 struct ofproto
**ofprotop
)
500 const struct ofproto_class
*class;
501 struct ofproto
*ofproto
;
507 ofproto_unixctl_init();
509 datapath_type
= ofproto_normalize_type(datapath_type
);
510 class = ofproto_class_find__(datapath_type
);
512 VLOG_WARN("could not create datapath %s of unknown type %s",
513 datapath_name
, datapath_type
);
517 ofproto
= class->alloc();
519 VLOG_ERR("failed to allocate datapath %s of type %s",
520 datapath_name
, datapath_type
);
525 ovs_mutex_lock(&ofproto_mutex
);
526 memset(ofproto
, 0, sizeof *ofproto
);
527 ofproto
->ofproto_class
= class;
528 ofproto
->name
= xstrdup(datapath_name
);
529 ofproto
->type
= xstrdup(datapath_type
);
530 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
531 hash_string(ofproto
->name
, 0));
532 ofproto
->datapath_id
= 0;
533 ofproto
->forward_bpdu
= false;
534 ofproto
->fallback_dpid
= pick_fallback_dpid();
535 ofproto
->mfr_desc
= NULL
;
536 ofproto
->hw_desc
= NULL
;
537 ofproto
->sw_desc
= NULL
;
538 ofproto
->serial_desc
= NULL
;
539 ofproto
->dp_desc
= NULL
;
540 ofproto
->frag_handling
= OFPC_FRAG_NORMAL
;
541 hmap_init(&ofproto
->ports
);
542 hmap_init(&ofproto
->ofport_usage
);
543 shash_init(&ofproto
->port_by_name
);
544 simap_init(&ofproto
->ofp_requests
);
545 ofproto
->max_ports
= ofp_to_u16(OFPP_MAX
);
546 ofproto
->eviction_group_timer
= LLONG_MIN
;
547 ofproto
->tables
= NULL
;
548 ofproto
->n_tables
= 0;
549 ofproto
->tables_version
= CLS_MIN_VERSION
;
550 hindex_init(&ofproto
->cookies
);
551 hmap_init(&ofproto
->learned_cookies
);
552 list_init(&ofproto
->expirable
);
553 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
554 guarded_list_init(&ofproto
->rule_executes
);
555 ofproto
->vlan_bitmap
= NULL
;
556 ofproto
->vlans_changed
= false;
557 ofproto
->min_mtu
= INT_MAX
;
558 ovs_rwlock_init(&ofproto
->groups_rwlock
);
559 hmap_init(&ofproto
->groups
);
560 ovs_mutex_unlock(&ofproto_mutex
);
561 ofproto
->ogf
.types
= 0xf;
562 ofproto
->ogf
.capabilities
= OFPGFC_CHAINING
| OFPGFC_SELECT_LIVENESS
|
563 OFPGFC_SELECT_WEIGHT
;
564 for (i
= 0; i
< 4; i
++) {
565 ofproto
->ogf
.max_groups
[i
] = OFPG_MAX
;
566 ofproto
->ogf
.ofpacts
[i
] = (UINT64_C(1) << N_OFPACTS
) - 1;
569 error
= ofproto
->ofproto_class
->construct(ofproto
);
571 VLOG_ERR("failed to open datapath %s: %s",
572 datapath_name
, ovs_strerror(error
));
573 connmgr_destroy(ofproto
->connmgr
);
574 ofproto_destroy__(ofproto
);
578 /* Check that hidden tables, if any, are at the end. */
579 ovs_assert(ofproto
->n_tables
);
580 for (i
= 0; i
+ 1 < ofproto
->n_tables
; i
++) {
581 enum oftable_flags flags
= ofproto
->tables
[i
].flags
;
582 enum oftable_flags next_flags
= ofproto
->tables
[i
+ 1].flags
;
584 ovs_assert(!(flags
& OFTABLE_HIDDEN
) || next_flags
& OFTABLE_HIDDEN
);
587 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
590 /* Initialize meters table. */
591 if (ofproto
->ofproto_class
->meter_get_features
) {
592 ofproto
->ofproto_class
->meter_get_features(ofproto
,
593 &ofproto
->meter_features
);
595 memset(&ofproto
->meter_features
, 0, sizeof ofproto
->meter_features
);
597 ofproto
->meters
= xzalloc((ofproto
->meter_features
.max_meters
+ 1)
598 * sizeof(struct meter
*));
600 /* Set the initial tables version. */
601 ofproto_bump_tables_version(ofproto
);
607 /* Must be called (only) by an ofproto implementation in its constructor
608 * function. See the large comment on 'construct' in struct ofproto_class for
611 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
613 struct oftable
*table
;
615 ovs_assert(!ofproto
->n_tables
);
616 ovs_assert(n_tables
>= 1 && n_tables
<= 255);
618 ofproto
->n_tables
= n_tables
;
619 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
620 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
625 /* To be optionally called (only) by an ofproto implementation in its
626 * constructor function. See the large comment on 'construct' in struct
627 * ofproto_class for details.
629 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
630 * will then ensure that actions passed into the ofproto implementation will
631 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
632 * function is not called, there will be no such restriction.
634 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
635 * the 'max_ports' restriction. */
637 ofproto_init_max_ports(struct ofproto
*ofproto
, uint16_t max_ports
)
639 ovs_assert(max_ports
<= ofp_to_u16(OFPP_MAX
));
640 ofproto
->max_ports
= max_ports
;
644 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
646 return ofproto
->datapath_id
;
650 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
652 uint64_t old_dpid
= p
->datapath_id
;
653 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
654 if (p
->datapath_id
!= old_dpid
) {
655 /* Force all active connections to reconnect, since there is no way to
656 * notify a controller that the datapath ID has changed. */
657 ofproto_reconnect_controllers(p
);
662 ofproto_set_controllers(struct ofproto
*p
,
663 const struct ofproto_controller
*controllers
,
664 size_t n_controllers
, uint32_t allowed_versions
)
666 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
,
671 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
673 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
676 /* Drops the connections between 'ofproto' and all of its controllers, forcing
677 * them to reconnect. */
679 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
681 connmgr_reconnect(ofproto
->connmgr
);
684 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
685 * in-band control should guarantee access, in the same way that in-band
686 * control guarantees access to OpenFlow controllers. */
688 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
689 const struct sockaddr_in
*extras
, size_t n
)
691 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
694 /* Sets the OpenFlow queue used by flows set up by in-band control on
695 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
696 * flows will use the default queue. */
698 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
700 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
703 /* Sets the number of flows at which eviction from the kernel flow table
706 ofproto_set_flow_limit(unsigned limit
)
708 ofproto_flow_limit
= limit
;
711 /* Sets the maximum idle time for flows in the datapath before they are
714 ofproto_set_max_idle(unsigned max_idle
)
716 ofproto_max_idle
= max_idle
;
719 /* If forward_bpdu is true, the NORMAL action will forward frames with
720 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
721 * the NORMAL action will drop these frames. */
723 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
725 bool old_val
= ofproto
->forward_bpdu
;
726 ofproto
->forward_bpdu
= forward_bpdu
;
727 if (old_val
!= ofproto
->forward_bpdu
) {
728 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
729 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
734 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
735 * 'idle_time', in seconds, and the maximum number of MAC table entries to
738 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
741 if (ofproto
->ofproto_class
->set_mac_table_config
) {
742 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
747 /* Multicast snooping configuration. */
749 /* Configures multicast snooping on 'ofproto' using the settings
750 * defined in 's'. If 's' is NULL, disables multicast snooping.
752 * Returns 0 if successful, otherwise a positive errno value. */
754 ofproto_set_mcast_snooping(struct ofproto
*ofproto
,
755 const struct ofproto_mcast_snooping_settings
*s
)
757 return (ofproto
->ofproto_class
->set_mcast_snooping
758 ? ofproto
->ofproto_class
->set_mcast_snooping(ofproto
, s
)
762 /* Configures multicast snooping flood settings on 'ofp_port' of 'ofproto'.
764 * Returns 0 if successful, otherwise a positive errno value.*/
766 ofproto_port_set_mcast_snooping(struct ofproto
*ofproto
, void *aux
,
767 const struct ofproto_mcast_snooping_port_settings
*s
)
769 return (ofproto
->ofproto_class
->set_mcast_snooping_port
770 ? ofproto
->ofproto_class
->set_mcast_snooping_port(ofproto
, aux
, s
)
775 ofproto_set_n_dpdk_rxqs(int n_rxqs
)
777 n_dpdk_rxqs
= MAX(n_rxqs
, 0);
781 ofproto_set_cpu_mask(const char *cmask
)
785 pmd_cpu_mask
= cmask
? xstrdup(cmask
) : NULL
;
789 ofproto_set_threads(int n_handlers_
, int n_revalidators_
)
791 int threads
= MAX(count_cpu_cores(), 2);
793 n_revalidators
= MAX(n_revalidators_
, 0);
794 n_handlers
= MAX(n_handlers_
, 0);
796 if (!n_revalidators
) {
797 n_revalidators
= n_handlers
798 ? MAX(threads
- (int) n_handlers
, 1)
803 n_handlers
= MAX(threads
- (int) n_revalidators
, 1);
808 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
811 p
->dp_desc
= dp_desc
? xstrdup(dp_desc
) : NULL
;
815 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
817 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
821 ofproto_set_netflow(struct ofproto
*ofproto
,
822 const struct netflow_options
*nf_options
)
824 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
828 if (ofproto
->ofproto_class
->set_netflow
) {
829 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
831 return nf_options
? EOPNOTSUPP
: 0;
836 ofproto_set_sflow(struct ofproto
*ofproto
,
837 const struct ofproto_sflow_options
*oso
)
839 if (oso
&& sset_is_empty(&oso
->targets
)) {
843 if (ofproto
->ofproto_class
->set_sflow
) {
844 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
846 return oso
? EOPNOTSUPP
: 0;
851 ofproto_set_ipfix(struct ofproto
*ofproto
,
852 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
853 const struct ofproto_ipfix_flow_exporter_options
*fo
,
856 if (ofproto
->ofproto_class
->set_ipfix
) {
857 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
859 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
864 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
866 flow_restore_wait
= flow_restore_wait_db
;
870 ofproto_get_flow_restore_wait(void)
872 return flow_restore_wait
;
876 /* Spanning Tree Protocol (STP) configuration. */
878 /* Configures STP on 'ofproto' using the settings defined in 's'. If
879 * 's' is NULL, disables STP.
881 * Returns 0 if successful, otherwise a positive errno value. */
883 ofproto_set_stp(struct ofproto
*ofproto
,
884 const struct ofproto_stp_settings
*s
)
886 return (ofproto
->ofproto_class
->set_stp
887 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
891 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
892 * 'enabled' member of 's' is false, then the other members are not
895 * Returns 0 if successful, otherwise a positive errno value. */
897 ofproto_get_stp_status(struct ofproto
*ofproto
,
898 struct ofproto_stp_status
*s
)
900 return (ofproto
->ofproto_class
->get_stp_status
901 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
905 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
906 * in 's'. The caller is responsible for assigning STP port numbers
907 * (using the 'port_num' member in the range of 1 through 255, inclusive)
908 * and ensuring there are no duplicates. If the 's' is NULL, then STP
909 * is disabled on the port.
911 * Returns 0 if successful, otherwise a positive errno value.*/
913 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
914 const struct ofproto_port_stp_settings
*s
)
916 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
918 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
919 ofproto
->name
, ofp_port
);
923 return (ofproto
->ofproto_class
->set_stp_port
924 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
928 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
929 * 's'. If the 'enabled' member in 's' is false, then the other members
930 * are not meaningful.
932 * Returns 0 if successful, otherwise a positive errno value.*/
934 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
935 struct ofproto_port_stp_status
*s
)
937 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
939 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
940 "port %"PRIu16
, ofproto
->name
, ofp_port
);
944 return (ofproto
->ofproto_class
->get_stp_port_status
945 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
949 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
950 * 's'. If the 'enabled' member in 's' is false, then the other members
951 * are not meaningful.
953 * Returns 0 if successful, otherwise a positive errno value.*/
955 ofproto_port_get_stp_stats(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
956 struct ofproto_port_stp_stats
*s
)
958 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
960 VLOG_WARN_RL(&rl
, "%s: cannot get STP stats on nonexistent "
961 "port %"PRIu16
, ofproto
->name
, ofp_port
);
965 return (ofproto
->ofproto_class
->get_stp_port_stats
966 ? ofproto
->ofproto_class
->get_stp_port_stats(ofport
, s
)
970 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
972 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
973 * 's' is NULL, disables RSTP.
975 * Returns 0 if successful, otherwise a positive errno value. */
977 ofproto_set_rstp(struct ofproto
*ofproto
,
978 const struct ofproto_rstp_settings
*s
)
980 if (!ofproto
->ofproto_class
->set_rstp
) {
983 ofproto
->ofproto_class
->set_rstp(ofproto
, s
);
987 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
988 * 'enabled' member of 's' is false, then the other members are not
991 * Returns 0 if successful, otherwise a positive errno value. */
993 ofproto_get_rstp_status(struct ofproto
*ofproto
,
994 struct ofproto_rstp_status
*s
)
996 if (!ofproto
->ofproto_class
->get_rstp_status
) {
999 ofproto
->ofproto_class
->get_rstp_status(ofproto
, s
);
1003 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
1004 * in 's'. The caller is responsible for assigning RSTP port numbers
1005 * (using the 'port_num' member in the range of 1 through 255, inclusive)
1006 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
1007 * is disabled on the port.
1009 * Returns 0 if successful, otherwise a positive errno value.*/
1011 ofproto_port_set_rstp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1012 const struct ofproto_port_rstp_settings
*s
)
1014 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1016 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16
,
1017 ofproto
->name
, ofp_port
);
1021 if (!ofproto
->ofproto_class
->set_rstp_port
) {
1024 ofproto
->ofproto_class
->set_rstp_port(ofport
, s
);
1028 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
1029 * 's'. If the 'enabled' member in 's' is false, then the other members
1030 * are not meaningful.
1032 * Returns 0 if successful, otherwise a positive errno value.*/
1034 ofproto_port_get_rstp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1035 struct ofproto_port_rstp_status
*s
)
1037 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1039 VLOG_WARN_RL(&rl
, "%s: cannot get RSTP status on nonexistent "
1040 "port %"PRIu16
, ofproto
->name
, ofp_port
);
1044 if (!ofproto
->ofproto_class
->get_rstp_port_status
) {
1047 ofproto
->ofproto_class
->get_rstp_port_status(ofport
, s
);
1051 /* Queue DSCP configuration. */
1053 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1054 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1055 * to implement QoS. Instead, it is used to implement features which require
1056 * knowledge of what queues exist on a port, and some basic information about
1059 * Returns 0 if successful, otherwise a positive errno value. */
1061 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1062 const struct ofproto_port_queue
*queues
,
1065 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1068 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
1069 ofproto
->name
, ofp_port
);
1073 return (ofproto
->ofproto_class
->set_queues
1074 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
1078 /* LLDP configuration. */
1080 ofproto_port_set_lldp(struct ofproto
*ofproto
,
1081 ofp_port_t ofp_port
,
1082 const struct smap
*cfg
)
1084 struct ofport
*ofport
;
1087 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1089 VLOG_WARN("%s: cannot configure LLDP on nonexistent port %"PRIu16
,
1090 ofproto
->name
, ofp_port
);
1093 error
= (ofproto
->ofproto_class
->set_lldp
1094 ? ofproto
->ofproto_class
->set_lldp(ofport
, cfg
)
1097 VLOG_WARN("%s: lldp configuration on port %"PRIu16
" (%s) failed (%s)",
1098 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1099 ovs_strerror(error
));
1104 ofproto_set_aa(struct ofproto
*ofproto
, void *aux OVS_UNUSED
,
1105 const struct aa_settings
*s
)
1107 if (!ofproto
->ofproto_class
->set_aa
) {
1110 ofproto
->ofproto_class
->set_aa(ofproto
, s
);
1115 ofproto_aa_mapping_register(struct ofproto
*ofproto
, void *aux
,
1116 const struct aa_mapping_settings
*s
)
1118 if (!ofproto
->ofproto_class
->aa_mapping_set
) {
1121 ofproto
->ofproto_class
->aa_mapping_set(ofproto
, aux
, s
);
1126 ofproto_aa_mapping_unregister(struct ofproto
*ofproto
, void *aux
)
1128 if (!ofproto
->ofproto_class
->aa_mapping_unset
) {
1131 ofproto
->ofproto_class
->aa_mapping_unset(ofproto
, aux
);
1136 ofproto_aa_vlan_get_queued(struct ofproto
*ofproto
,
1137 struct ovs_list
*list
)
1139 if (!ofproto
->ofproto_class
->aa_vlan_get_queued
) {
1142 ofproto
->ofproto_class
->aa_vlan_get_queued(ofproto
, list
);
1147 ofproto_aa_vlan_get_queue_size(struct ofproto
*ofproto
)
1149 if (!ofproto
->ofproto_class
->aa_vlan_get_queue_size
) {
1152 return ofproto
->ofproto_class
->aa_vlan_get_queue_size(ofproto
);
1155 /* Connectivity Fault Management configuration. */
1157 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1159 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1161 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1162 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
1163 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
1167 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1168 * basic configuration from the configuration members in 'cfm', and the remote
1169 * maintenance point ID from remote_mpid. Ignores the statistics members of
1172 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1174 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1175 const struct cfm_settings
*s
)
1177 struct ofport
*ofport
;
1180 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1182 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
1183 ofproto
->name
, ofp_port
);
1187 /* XXX: For configuration simplicity, we only support one remote_mpid
1188 * outside of the CFM module. It's not clear if this is the correct long
1189 * term solution or not. */
1190 error
= (ofproto
->ofproto_class
->set_cfm
1191 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
1194 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
1195 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1196 ovs_strerror(error
));
1200 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1201 * 'ofproto' does not have a port 'ofp_port'. */
1203 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1204 const struct smap
*cfg
)
1206 struct ofport
*ofport
;
1209 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1211 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16
,
1212 ofproto
->name
, ofp_port
);
1216 error
= (ofproto
->ofproto_class
->set_bfd
1217 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
1220 VLOG_WARN("%s: bfd configuration on port %"PRIu16
" (%s) failed (%s)",
1221 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1222 ovs_strerror(error
));
1226 /* Checks the status change of BFD on 'ofport'.
1228 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1230 ofproto_port_bfd_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1232 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1233 return (ofport
&& ofproto
->ofproto_class
->bfd_status_changed
1234 ? ofproto
->ofproto_class
->bfd_status_changed(ofport
)
1238 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1239 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1240 * is not an OpenFlow port in 'ofproto'.
1242 * The caller must provide and own '*status'. */
1244 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1245 struct smap
*status
)
1247 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1248 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
1249 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
1253 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1254 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1255 * 0 if LACP partner information is not current (generally indicating a
1256 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1258 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1260 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1261 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
1262 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
1267 ofproto_port_get_lacp_stats(const struct ofport
*port
, struct lacp_slave_stats
*stats
)
1269 struct ofproto
*ofproto
= port
->ofproto
;
1272 if (ofproto
->ofproto_class
->port_get_lacp_stats
) {
1273 error
= ofproto
->ofproto_class
->port_get_lacp_stats(port
, stats
);
1283 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1284 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1285 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1286 * configuration plus, if there is more than one slave, a bonding
1289 * If 'aux' is already registered then this function updates its configuration
1290 * to 's'. Otherwise, this function registers a new bundle.
1292 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1295 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
1296 const struct ofproto_bundle_settings
*s
)
1298 return (ofproto
->ofproto_class
->bundle_set
1299 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
1303 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1304 * If no such bundle has been registered, this has no effect. */
1306 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
1308 return ofproto_bundle_register(ofproto
, aux
, NULL
);
1312 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1313 * If 'aux' is already registered then this function updates its configuration
1314 * to 's'. Otherwise, this function registers a new mirror. */
1316 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
1317 const struct ofproto_mirror_settings
*s
)
1319 return (ofproto
->ofproto_class
->mirror_set
1320 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
1324 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1325 * If no mirror has been registered, this has no effect. */
1327 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
1329 return ofproto_mirror_register(ofproto
, aux
, NULL
);
1332 /* Retrieves statistics from mirror associated with client data pointer
1333 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1334 * 'bytes', respectively. If a particular counters is not supported,
1335 * the appropriate argument is set to UINT64_MAX.
1338 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
1339 uint64_t *packets
, uint64_t *bytes
)
1341 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
1342 *packets
= *bytes
= UINT64_MAX
;
1346 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
1350 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1351 * which all packets are flooded, instead of using MAC learning. If
1352 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1354 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1357 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
1359 return (ofproto
->ofproto_class
->set_flood_vlans
1360 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
1364 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1365 * output for a mirror. */
1367 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
1369 return (ofproto
->ofproto_class
->is_mirror_output_bundle
1370 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
1374 /* Configuration of OpenFlow tables. */
1376 /* Returns the number of OpenFlow tables in 'ofproto'. */
1378 ofproto_get_n_tables(const struct ofproto
*ofproto
)
1380 return ofproto
->n_tables
;
1383 /* Returns the number of Controller visible OpenFlow tables
1384 * in 'ofproto'. This number will exclude Hidden tables.
1385 * This funtion's return value should be less or equal to that of
1386 * ofproto_get_n_tables() . */
1388 ofproto_get_n_visible_tables(const struct ofproto
*ofproto
)
1390 uint8_t n
= ofproto
->n_tables
;
1392 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1393 * if present, are always at the end.) */
1394 while(n
&& (ofproto
->tables
[n
- 1].flags
& OFTABLE_HIDDEN
)) {
1401 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1402 * settings from 's'. 'table_id' must be in the range 0 through the number of
1403 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1405 * For read-only tables, only the name may be configured. */
1407 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
1408 const struct ofproto_table_settings
*s
)
1410 struct oftable
*table
;
1412 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
1413 table
= &ofproto
->tables
[table_id
];
1415 oftable_set_name(table
, s
->name
);
1417 if (table
->flags
& OFTABLE_READONLY
) {
1422 oftable_enable_eviction(table
, s
->groups
, s
->n_groups
);
1424 oftable_disable_eviction(table
);
1427 table
->max_flows
= s
->max_flows
;
1429 if (classifier_set_prefix_fields(&table
->cls
,
1430 s
->prefix_fields
, s
->n_prefix_fields
)) {
1431 /* XXX: Trigger revalidation. */
1434 ovs_mutex_lock(&ofproto_mutex
);
1435 evict_rules_from_table(table
);
1436 ovs_mutex_unlock(&ofproto_mutex
);
1440 ofproto_has_snoops(const struct ofproto
*ofproto
)
1442 return connmgr_has_snoops(ofproto
->connmgr
);
1446 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1448 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1451 /* Deletes 'rule' from 'ofproto'.
1453 * Within an ofproto implementation, this function allows an ofproto
1454 * implementation to destroy any rules that remain when its ->destruct()
1455 * function is called. This function is not suitable for use elsewhere in an
1456 * ofproto implementation.
1458 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1459 * Cycle" in ofproto-provider.h. */
1461 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1462 OVS_EXCLUDED(ofproto_mutex
)
1464 /* This skips the ofmonitor and flow-removed notifications because the
1465 * switch is being deleted and any OpenFlow channels have been or soon will
1467 ovs_mutex_lock(&ofproto_mutex
);
1469 if (!rule
->removed
) {
1470 /* Make sure there is no postponed removal of the rule. */
1471 ovs_assert(cls_rule_visible_in_version(&rule
->cr
, CLS_MAX_VERSION
));
1473 if (!classifier_remove(&rule
->ofproto
->tables
[rule
->table_id
].cls
,
1477 ofproto_rule_remove__(rule
->ofproto
, rule
);
1478 ofproto
->ofproto_class
->rule_delete(rule
);
1479 ofproto_rule_unref(rule
);
1481 ovs_mutex_unlock(&ofproto_mutex
);
1485 ofproto_flush__(struct ofproto
*ofproto
)
1486 OVS_EXCLUDED(ofproto_mutex
)
1488 struct oftable
*table
;
1490 /* This will flush all datapath flows. */
1491 if (ofproto
->ofproto_class
->flush
) {
1492 ofproto
->ofproto_class
->flush(ofproto
);
1495 /* XXX: There is a small race window here, where new datapath flows can be
1496 * created by upcall handlers based on the existing flow table. We can not
1497 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1498 * as then we could deadlock on syncing with the handler threads waiting on
1499 * the same mutex. */
1501 ovs_mutex_lock(&ofproto_mutex
);
1502 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1503 struct rule_collection rules
;
1506 if (table
->flags
& OFTABLE_HIDDEN
) {
1510 rule_collection_init(&rules
);
1512 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1513 rule_collection_add(&rules
, rule
);
1515 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
1517 /* XXX: Concurrent handler threads may insert new learned flows based on
1518 * learn actions of the now deleted flows right after we release
1519 * 'ofproto_mutex'. */
1520 ovs_mutex_unlock(&ofproto_mutex
);
1523 static void delete_group(struct ofproto
*ofproto
, uint32_t group_id
);
1526 ofproto_destroy__(struct ofproto
*ofproto
)
1527 OVS_EXCLUDED(ofproto_mutex
)
1529 struct oftable
*table
;
1531 destroy_rule_executes(ofproto
);
1532 delete_group(ofproto
, OFPG_ALL
);
1534 guarded_list_destroy(&ofproto
->rule_executes
);
1535 ovs_rwlock_destroy(&ofproto
->groups_rwlock
);
1536 hmap_destroy(&ofproto
->groups
);
1538 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1539 free(ofproto
->name
);
1540 free(ofproto
->type
);
1541 free(ofproto
->mfr_desc
);
1542 free(ofproto
->hw_desc
);
1543 free(ofproto
->sw_desc
);
1544 free(ofproto
->serial_desc
);
1545 free(ofproto
->dp_desc
);
1546 hmap_destroy(&ofproto
->ports
);
1547 hmap_destroy(&ofproto
->ofport_usage
);
1548 shash_destroy(&ofproto
->port_by_name
);
1549 simap_destroy(&ofproto
->ofp_requests
);
1551 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1552 oftable_destroy(table
);
1554 free(ofproto
->tables
);
1556 ovs_assert(hindex_is_empty(&ofproto
->cookies
));
1557 hindex_destroy(&ofproto
->cookies
);
1559 ovs_assert(hmap_is_empty(&ofproto
->learned_cookies
));
1560 hmap_destroy(&ofproto
->learned_cookies
);
1562 free(ofproto
->vlan_bitmap
);
1564 ofproto
->ofproto_class
->dealloc(ofproto
);
1567 /* Destroying rules is doubly deferred, must have 'ofproto' around for them.
1568 * - 1st we defer the removal of the rules from the classifier
1569 * - 2nd we defer the actual destruction of the rules. */
1571 ofproto_destroy_defer__(struct ofproto
*ofproto
)
1572 OVS_EXCLUDED(ofproto_mutex
)
1574 ovsrcu_postpone(ofproto_destroy__
, ofproto
);
1578 ofproto_destroy(struct ofproto
*p
)
1579 OVS_EXCLUDED(ofproto_mutex
)
1581 struct ofport
*ofport
, *next_ofport
;
1582 struct ofport_usage
*usage
, *next_usage
;
1589 meter_delete(p
, 1, p
->meter_features
.max_meters
);
1590 p
->meter_features
.max_meters
= 0;
1596 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1597 ofport_destroy(ofport
);
1600 HMAP_FOR_EACH_SAFE (usage
, next_usage
, hmap_node
, &p
->ofport_usage
) {
1601 hmap_remove(&p
->ofport_usage
, &usage
->hmap_node
);
1605 p
->ofproto_class
->destruct(p
);
1607 /* We should not postpone this because it involves deleting a listening
1608 * socket which we may want to reopen soon. 'connmgr' should not be used
1609 * by other threads */
1610 connmgr_destroy(p
->connmgr
);
1612 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1613 ovsrcu_postpone(ofproto_destroy_defer__
, p
);
1616 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1617 * kernel datapath, for example, this destroys the datapath in the kernel, and
1618 * with the netdev-based datapath, it tears down the data structures that
1619 * represent the datapath.
1621 * The datapath should not be currently open as an ofproto. */
1623 ofproto_delete(const char *name
, const char *type
)
1625 const struct ofproto_class
*class = ofproto_class_find__(type
);
1626 return (!class ? EAFNOSUPPORT
1627 : !class->del
? EACCES
1628 : class->del(type
, name
));
1632 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1634 if (error
== ENOBUFS
) {
1635 reinit_ports(ofproto
);
1636 } else if (!error
) {
1637 update_port(ofproto
, devname
);
1643 ofproto_type_run(const char *datapath_type
)
1645 const struct ofproto_class
*class;
1648 datapath_type
= ofproto_normalize_type(datapath_type
);
1649 class = ofproto_class_find__(datapath_type
);
1651 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1652 if (error
&& error
!= EAGAIN
) {
1653 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1654 datapath_type
, ovs_strerror(error
));
1660 ofproto_type_wait(const char *datapath_type
)
1662 const struct ofproto_class
*class;
1664 datapath_type
= ofproto_normalize_type(datapath_type
);
1665 class = ofproto_class_find__(datapath_type
);
1667 if (class->type_wait
) {
1668 class->type_wait(datapath_type
);
1673 ofproto_run(struct ofproto
*p
)
1678 error
= p
->ofproto_class
->run(p
);
1679 if (error
&& error
!= EAGAIN
) {
1680 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, ovs_strerror(error
));
1683 run_rule_executes(p
);
1685 /* Restore the eviction group heap invariant occasionally. */
1686 if (p
->eviction_group_timer
< time_msec()) {
1689 p
->eviction_group_timer
= time_msec() + 1000;
1691 for (i
= 0; i
< p
->n_tables
; i
++) {
1692 struct oftable
*table
= &p
->tables
[i
];
1693 struct eviction_group
*evg
;
1696 if (!table
->eviction_fields
) {
1700 if (table
->n_flows
> 100000) {
1701 static struct vlog_rate_limit count_rl
=
1702 VLOG_RATE_LIMIT_INIT(1, 1);
1703 VLOG_WARN_RL(&count_rl
, "Table %"PRIuSIZE
" has an excessive"
1704 " number of rules: %d", i
, table
->n_flows
);
1707 ovs_mutex_lock(&ofproto_mutex
);
1708 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1709 if (rule
->idle_timeout
|| rule
->hard_timeout
) {
1710 if (!rule
->eviction_group
) {
1711 eviction_group_add_rule(rule
);
1713 heap_raw_change(&rule
->evg_node
,
1714 rule_eviction_priority(p
, rule
));
1719 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1720 heap_rebuild(&evg
->rules
);
1722 ovs_mutex_unlock(&ofproto_mutex
);
1726 if (p
->ofproto_class
->port_poll
) {
1729 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1730 process_port_change(p
, error
, devname
);
1734 new_seq
= seq_read(connectivity_seq_get());
1735 if (new_seq
!= p
->change_seq
) {
1736 struct sset devnames
;
1737 const char *devname
;
1738 struct ofport
*ofport
;
1740 /* Update OpenFlow port status for any port whose netdev has changed.
1742 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1743 * destroyed, so it's not safe to update ports directly from the
1744 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1745 * need this two-phase approach. */
1746 sset_init(&devnames
);
1747 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1748 uint64_t port_change_seq
;
1750 port_change_seq
= netdev_get_change_seq(ofport
->netdev
);
1751 if (ofport
->change_seq
!= port_change_seq
) {
1752 ofport
->change_seq
= port_change_seq
;
1753 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1756 SSET_FOR_EACH (devname
, &devnames
) {
1757 update_port(p
, devname
);
1759 sset_destroy(&devnames
);
1761 p
->change_seq
= new_seq
;
1764 connmgr_run(p
->connmgr
, handle_openflow
);
1770 ofproto_wait(struct ofproto
*p
)
1772 p
->ofproto_class
->wait(p
);
1773 if (p
->ofproto_class
->port_poll_wait
) {
1774 p
->ofproto_class
->port_poll_wait(p
);
1776 seq_wait(connectivity_seq_get(), p
->change_seq
);
1777 connmgr_wait(p
->connmgr
);
1781 ofproto_is_alive(const struct ofproto
*p
)
1783 return connmgr_has_controllers(p
->connmgr
);
1786 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1787 * memory_report(). */
1789 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1791 const struct oftable
*table
;
1792 unsigned int n_rules
;
1794 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1797 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1798 n_rules
+= table
->n_flows
;
1800 simap_increase(usage
, "rules", n_rules
);
1802 if (ofproto
->ofproto_class
->get_memory_usage
) {
1803 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1806 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1810 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1812 const struct ofproto_class
*class;
1814 datapath_type
= ofproto_normalize_type(datapath_type
);
1815 class = ofproto_class_find__(datapath_type
);
1817 if (class && class->type_get_memory_usage
) {
1818 class->type_get_memory_usage(datapath_type
, usage
);
1823 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1826 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1830 ofproto_free_ofproto_controller_info(struct shash
*info
)
1832 connmgr_free_controller_info(info
);
1835 /* Makes a deep copy of 'old' into 'port'. */
1837 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1839 port
->name
= xstrdup(old
->name
);
1840 port
->type
= xstrdup(old
->type
);
1841 port
->ofp_port
= old
->ofp_port
;
1844 /* Frees memory allocated to members of 'ofproto_port'.
1846 * Do not call this function on an ofproto_port obtained from
1847 * ofproto_port_dump_next(): that function retains ownership of the data in the
1850 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1852 free(ofproto_port
->name
);
1853 free(ofproto_port
->type
);
1856 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1858 * This function provides no status indication. An error status for the entire
1859 * dump operation is provided when it is completed by calling
1860 * ofproto_port_dump_done().
1863 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1864 const struct ofproto
*ofproto
)
1866 dump
->ofproto
= ofproto
;
1867 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1871 /* Attempts to retrieve another port from 'dump', which must have been created
1872 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1873 * 'port' and returns true. On failure, returns false.
1875 * Failure might indicate an actual error or merely that the last port has been
1876 * dumped. An error status for the entire dump operation is provided when it
1877 * is completed by calling ofproto_port_dump_done().
1879 * The ofproto owns the data stored in 'port'. It will remain valid until at
1880 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1881 * ofproto_port_dump_done(). */
1883 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1884 struct ofproto_port
*port
)
1886 const struct ofproto
*ofproto
= dump
->ofproto
;
1892 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1895 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1901 /* Completes port table dump operation 'dump', which must have been created
1902 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1903 * error-free, otherwise a positive errno value describing the problem. */
1905 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1907 const struct ofproto
*ofproto
= dump
->ofproto
;
1909 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1912 return dump
->error
== EOF
? 0 : dump
->error
;
1915 /* Returns the type to pass to netdev_open() when a datapath of type
1916 * 'datapath_type' has a port of type 'port_type', for a few special
1917 * cases when a netdev type differs from a port type. For example, when
1918 * using the userspace datapath, a port of type "internal" needs to be
1921 * Returns either 'type' itself or a string literal, which must not be
1924 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1926 const struct ofproto_class
*class;
1928 datapath_type
= ofproto_normalize_type(datapath_type
);
1929 class = ofproto_class_find__(datapath_type
);
1934 return (class->port_open_type
1935 ? class->port_open_type(datapath_type
, port_type
)
1939 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1940 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1941 * the port's OpenFlow port number.
1943 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1944 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1945 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1946 * 'ofp_portp' is non-null). */
1948 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1949 ofp_port_t
*ofp_portp
)
1951 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1954 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1956 const char *netdev_name
= netdev_get_name(netdev
);
1958 simap_put(&ofproto
->ofp_requests
, netdev_name
,
1959 ofp_to_u16(ofp_port
));
1960 update_port(ofproto
, netdev_name
);
1963 *ofp_portp
= OFPP_NONE
;
1965 struct ofproto_port ofproto_port
;
1967 error
= ofproto_port_query_by_name(ofproto
,
1968 netdev_get_name(netdev
),
1971 *ofp_portp
= ofproto_port
.ofp_port
;
1972 ofproto_port_destroy(&ofproto_port
);
1979 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1980 * initializes '*port' appropriately; on failure, returns a positive errno
1983 * The caller owns the data in 'ofproto_port' and must free it with
1984 * ofproto_port_destroy() when it is no longer needed. */
1986 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1987 struct ofproto_port
*port
)
1991 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1993 memset(port
, 0, sizeof *port
);
1998 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1999 * Returns 0 if successful, otherwise a positive errno. */
2001 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2003 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
2004 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
2005 struct simap_node
*ofp_request_node
;
2008 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
2009 if (ofp_request_node
) {
2010 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
2013 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
2014 if (!error
&& ofport
) {
2015 /* 'name' is the netdev's name and update_port() is going to close the
2016 * netdev. Just in case update_port() refers to 'name' after it
2017 * destroys 'ofport', make a copy of it around the update_port()
2019 char *devname
= xstrdup(name
);
2020 update_port(ofproto
, devname
);
2027 flow_mod_init(struct ofputil_flow_mod
*fm
,
2028 const struct match
*match
, int priority
,
2029 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
2030 enum ofp_flow_mod_command command
)
2032 memset(fm
, 0, sizeof *fm
);
2034 fm
->priority
= priority
;
2037 fm
->modify_cookie
= false;
2039 fm
->command
= command
;
2040 fm
->idle_timeout
= 0;
2041 fm
->hard_timeout
= 0;
2043 fm
->buffer_id
= UINT32_MAX
;
2044 fm
->out_port
= OFPP_ANY
;
2045 fm
->out_group
= OFPG_ANY
;
2047 fm
->ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
);
2048 fm
->ofpacts_len
= ofpacts_len
;
2049 fm
->delete_reason
= OFPRR_DELETE
;
2053 simple_flow_mod(struct ofproto
*ofproto
,
2054 const struct match
*match
, int priority
,
2055 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
2056 enum ofp_flow_mod_command command
)
2058 struct ofputil_flow_mod fm
;
2060 flow_mod_init(&fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
2062 return handle_flow_mod__(ofproto
, &fm
, NULL
);
2065 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
2066 * performs the 'n_actions' actions in 'actions'. The new flow will not
2069 * If cls_rule->priority is in the range of priorities supported by OpenFlow
2070 * (0...65535, inclusive) then the flow will be visible to OpenFlow
2071 * controllers; otherwise, it will be hidden.
2073 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
2075 * This is a helper function for in-band control and fail-open. */
2077 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
2079 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2080 OVS_EXCLUDED(ofproto_mutex
)
2082 const struct rule
*rule
;
2085 /* First do a cheap check whether the rule we're looking for already exists
2086 * with the actions that we want. If it does, then we're done. */
2087 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2088 &ofproto
->tables
[0].cls
, match
, priority
,
2091 const struct rule_actions
*actions
= rule_get_actions(rule
);
2092 must_add
= !ofpacts_equal(actions
->ofpacts
, actions
->ofpacts_len
,
2093 ofpacts
, ofpacts_len
);
2098 /* If there's no such rule or the rule doesn't have the actions we want,
2099 * fall back to a executing a full flow mod. We can't optimize this at
2100 * all because we didn't take enough locks above to ensure that the flow
2101 * table didn't already change beneath us. */
2103 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
2104 OFPFC_MODIFY_STRICT
);
2108 /* Executes the flow modification specified in 'fm'. Returns 0 on success, or
2109 * an OFPERR_* OpenFlow error code on failure.
2111 * This is a helper function for in-band control and fail-open and the "learn"
2114 ofproto_flow_mod(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
)
2115 OVS_EXCLUDED(ofproto_mutex
)
2117 /* Optimize for the most common case of a repeated learn action.
2118 * If an identical flow already exists we only need to update its
2119 * 'modified' time. */
2120 if (fm
->command
== OFPFC_MODIFY_STRICT
&& fm
->table_id
!= OFPTT_ALL
2121 && !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
)) {
2122 struct oftable
*table
= &ofproto
->tables
[fm
->table_id
];
2126 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2127 &table
->cls
, &fm
->match
, fm
->priority
,
2130 /* Reading many of the rule fields and writing on 'modified'
2131 * requires the rule->mutex. Also, rule->actions may change
2132 * if rule->mutex is not held. */
2133 const struct rule_actions
*actions
;
2135 ovs_mutex_lock(&rule
->mutex
);
2136 actions
= rule_get_actions(rule
);
2137 if (rule
->idle_timeout
== fm
->idle_timeout
2138 && rule
->hard_timeout
== fm
->hard_timeout
2139 && rule
->importance
== fm
->importance
2140 && rule
->flags
== (fm
->flags
& OFPUTIL_FF_STATE
)
2141 && (!fm
->modify_cookie
|| (fm
->new_cookie
== rule
->flow_cookie
))
2142 && ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
2143 actions
->ofpacts
, actions
->ofpacts_len
)) {
2144 /* Rule already exists and need not change, only update the
2145 modified timestamp. */
2146 rule
->modified
= time_msec();
2149 ovs_mutex_unlock(&rule
->mutex
);
2157 return handle_flow_mod__(ofproto
, fm
, NULL
);
2160 /* Searches for a rule with matching criteria exactly equal to 'target' in
2161 * ofproto's table 0 and, if it finds one, deletes it.
2163 * This is a helper function for in-band control and fail-open. */
2165 ofproto_delete_flow(struct ofproto
*ofproto
,
2166 const struct match
*target
, int priority
)
2167 OVS_EXCLUDED(ofproto_mutex
)
2169 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
2172 /* First do a cheap check whether the rule we're looking for has already
2173 * been deleted. If so, then we're done. */
2174 rule
= rule_from_cls_rule(classifier_find_match_exactly(
2175 cls
, target
, priority
, CLS_MAX_VERSION
));
2180 /* Execute a flow mod. We can't optimize this at all because we didn't
2181 * take enough locks above to ensure that the flow table didn't already
2182 * change beneath us. */
2183 simple_flow_mod(ofproto
, target
, priority
, NULL
, 0, OFPFC_DELETE_STRICT
);
2186 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2187 * the flows required by in-band control and fail-open. */
2189 ofproto_flush_flows(struct ofproto
*ofproto
)
2191 COVERAGE_INC(ofproto_flush
);
2192 ofproto_flush__(ofproto
);
2193 connmgr_flushed(ofproto
->connmgr
);
2197 reinit_ports(struct ofproto
*p
)
2199 struct ofproto_port_dump dump
;
2200 struct sset devnames
;
2201 struct ofport
*ofport
;
2202 struct ofproto_port ofproto_port
;
2203 const char *devname
;
2205 COVERAGE_INC(ofproto_reinit_ports
);
2207 sset_init(&devnames
);
2208 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2209 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
2211 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2212 sset_add(&devnames
, ofproto_port
.name
);
2215 SSET_FOR_EACH (devname
, &devnames
) {
2216 update_port(p
, devname
);
2218 sset_destroy(&devnames
);
2222 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2226 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2227 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2229 if (port_idx
>= ofproto
->max_ports
2230 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2231 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2232 long long int last_used_at
, lru
= LLONG_MAX
;
2234 /* Search for a free OpenFlow port number. We try not to
2235 * immediately reuse them to prevent problems due to old
2238 * We limit the automatically assigned port numbers to the lower half
2239 * of the port range, to reserve the upper half for assignment by
2242 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2243 ofproto
->alloc_port_no
= 1;
2245 last_used_at
= ofport_get_usage(ofproto
,
2246 u16_to_ofp(ofproto
->alloc_port_no
));
2247 if (!last_used_at
) {
2248 port_idx
= ofproto
->alloc_port_no
;
2250 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2251 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2252 * more than an hour ago, consider it usable. */
2253 ofport_remove_usage(ofproto
,
2254 u16_to_ofp(ofproto
->alloc_port_no
));
2255 port_idx
= ofproto
->alloc_port_no
;
2257 } else if (last_used_at
< lru
) {
2259 lru_ofport
= ofproto
->alloc_port_no
;
2262 if (ofproto
->alloc_port_no
== end_port_no
) {
2264 port_idx
= lru_ofport
;
2271 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2272 return u16_to_ofp(port_idx
);
2276 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2278 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2279 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2283 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2284 * pointer if the netdev cannot be opened. On success, also fills in
2286 static struct netdev
*
2287 ofport_open(struct ofproto
*ofproto
,
2288 struct ofproto_port
*ofproto_port
,
2289 struct ofputil_phy_port
*pp
)
2291 enum netdev_flags flags
;
2292 struct netdev
*netdev
;
2295 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2297 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
2298 "cannot be opened (%s)",
2300 ofproto_port
->name
, ofproto_port
->ofp_port
,
2301 ofproto_port
->name
, ovs_strerror(error
));
2305 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2306 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2307 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2309 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2310 ofproto_port
->name
);
2313 pp
->port_no
= ofproto_port
->ofp_port
;
2314 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
2315 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2316 netdev_get_flags(netdev
, &flags
);
2317 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2318 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2319 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2320 &pp
->supported
, &pp
->peer
);
2321 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2322 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2327 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2328 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2331 ofport_equal(const struct ofputil_phy_port
*a
,
2332 const struct ofputil_phy_port
*b
)
2334 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2335 && a
->state
== b
->state
2336 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2337 && a
->curr
== b
->curr
2338 && a
->advertised
== b
->advertised
2339 && a
->supported
== b
->supported
2340 && a
->peer
== b
->peer
2341 && a
->curr_speed
== b
->curr_speed
2342 && a
->max_speed
== b
->max_speed
);
2345 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2346 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2347 * one with the same name or port number). */
2349 ofport_install(struct ofproto
*p
,
2350 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2352 const char *netdev_name
= netdev_get_name(netdev
);
2353 struct ofport
*ofport
;
2356 /* Create ofport. */
2357 ofport
= p
->ofproto_class
->port_alloc();
2362 ofport
->ofproto
= p
;
2363 ofport
->netdev
= netdev
;
2364 ofport
->change_seq
= netdev_get_change_seq(netdev
);
2366 ofport
->ofp_port
= pp
->port_no
;
2367 ofport
->created
= time_msec();
2369 /* Add port to 'p'. */
2370 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2371 hash_ofp_port(ofport
->ofp_port
));
2372 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2374 update_mtu(p
, ofport
);
2376 /* Let the ofproto_class initialize its private data. */
2377 error
= p
->ofproto_class
->port_construct(ofport
);
2381 connmgr_send_port_status(p
->connmgr
, NULL
, pp
, OFPPR_ADD
);
2385 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2386 p
->name
, netdev_name
, ovs_strerror(error
));
2388 ofport_destroy__(ofport
);
2390 netdev_close(netdev
);
2394 /* Removes 'ofport' from 'p' and destroys it. */
2396 ofport_remove(struct ofport
*ofport
)
2398 connmgr_send_port_status(ofport
->ofproto
->connmgr
, NULL
, &ofport
->pp
,
2400 ofport_destroy(ofport
);
2403 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2406 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2408 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2410 ofport_remove(port
);
2414 /* Updates 'port' with new 'pp' description.
2416 * Does not handle a name or port number change. The caller must implement
2417 * such a change as a delete followed by an add. */
2419 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2421 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
2422 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2423 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2424 port
->pp
.state
= ((port
->pp
.state
& ~OFPUTIL_PS_LINK_DOWN
)
2425 | (pp
->state
& OFPUTIL_PS_LINK_DOWN
));
2426 port
->pp
.curr
= pp
->curr
;
2427 port
->pp
.advertised
= pp
->advertised
;
2428 port
->pp
.supported
= pp
->supported
;
2429 port
->pp
.peer
= pp
->peer
;
2430 port
->pp
.curr_speed
= pp
->curr_speed
;
2431 port
->pp
.max_speed
= pp
->max_speed
;
2433 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2434 &port
->pp
, OFPPR_MODIFY
);
2437 /* Update OpenFlow 'state' in 'port' and notify controller. */
2439 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2441 if (port
->pp
.state
!= state
) {
2442 port
->pp
.state
= state
;
2443 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2444 &port
->pp
, OFPPR_MODIFY
);
2449 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2451 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2453 if (port
->ofproto
->ofproto_class
->set_realdev
) {
2454 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
2456 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2457 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2459 if (port
->ofproto
->ofproto_class
->set_rstp_port
) {
2460 port
->ofproto
->ofproto_class
->set_rstp_port(port
, NULL
);
2462 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2463 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2465 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2466 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2472 ofport_destroy__(struct ofport
*port
)
2474 struct ofproto
*ofproto
= port
->ofproto
;
2475 const char *name
= netdev_get_name(port
->netdev
);
2477 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2478 shash_delete(&ofproto
->port_by_name
,
2479 shash_find(&ofproto
->port_by_name
, name
));
2481 netdev_close(port
->netdev
);
2482 ofproto
->ofproto_class
->port_dealloc(port
);
2486 ofport_destroy(struct ofport
*port
)
2489 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2490 port
->ofproto
->ofproto_class
->port_destruct(port
);
2491 ofport_destroy__(port
);
2496 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2498 struct ofport
*port
;
2500 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2502 if (port
->ofp_port
== ofp_port
) {
2509 static long long int
2510 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2512 struct ofport_usage
*usage
;
2514 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2515 &ofproto
->ofport_usage
) {
2516 if (usage
->ofp_port
== ofp_port
) {
2517 return usage
->last_used
;
2524 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2525 long long int last_used
)
2527 struct ofport_usage
*usage
;
2528 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2529 &ofproto
->ofport_usage
) {
2530 if (usage
->ofp_port
== ofp_port
) {
2531 usage
->last_used
= last_used
;
2535 ovs_assert(last_used
== LLONG_MAX
);
2537 usage
= xmalloc(sizeof *usage
);
2538 usage
->ofp_port
= ofp_port
;
2539 usage
->last_used
= last_used
;
2540 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2541 hash_ofp_port(ofp_port
));
2545 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2547 struct ofport_usage
*usage
;
2548 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2549 &ofproto
->ofport_usage
) {
2550 if (usage
->ofp_port
== ofp_port
) {
2551 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2559 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2561 struct ofproto
*ofproto
= port
->ofproto
;
2564 if (ofproto
->ofproto_class
->port_get_stats
) {
2565 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2574 update_port(struct ofproto
*ofproto
, const char *name
)
2576 struct ofproto_port ofproto_port
;
2577 struct ofputil_phy_port pp
;
2578 struct netdev
*netdev
;
2579 struct ofport
*port
;
2581 COVERAGE_INC(ofproto_update_port
);
2583 /* Fetch 'name''s location and properties from the datapath. */
2584 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2585 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2589 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2590 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2591 struct netdev
*old_netdev
= port
->netdev
;
2593 /* 'name' hasn't changed location. Any properties changed? */
2594 if (!ofport_equal(&port
->pp
, &pp
)) {
2595 ofport_modified(port
, &pp
);
2598 update_mtu(ofproto
, port
);
2600 /* Install the newly opened netdev in case it has changed.
2601 * Don't close the old netdev yet in case port_modified has to
2602 * remove a retained reference to it.*/
2603 port
->netdev
= netdev
;
2604 port
->change_seq
= netdev_get_change_seq(netdev
);
2606 if (port
->ofproto
->ofproto_class
->port_modified
) {
2607 port
->ofproto
->ofproto_class
->port_modified(port
);
2610 netdev_close(old_netdev
);
2612 /* If 'port' is nonnull then its name differs from 'name' and thus
2613 * we should delete it. If we think there's a port named 'name'
2614 * then its port number must be wrong now so delete it too. */
2616 ofport_remove(port
);
2618 ofport_remove_with_name(ofproto
, name
);
2619 ofport_install(ofproto
, netdev
, &pp
);
2622 /* Any port named 'name' is gone now. */
2623 ofport_remove_with_name(ofproto
, name
);
2625 ofproto_port_destroy(&ofproto_port
);
2629 init_ports(struct ofproto
*p
)
2631 struct ofproto_port_dump dump
;
2632 struct ofproto_port ofproto_port
;
2633 struct shash_node
*node
, *next
;
2635 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2636 const char *name
= ofproto_port
.name
;
2638 if (shash_find(&p
->port_by_name
, name
)) {
2639 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2642 struct ofputil_phy_port pp
;
2643 struct netdev
*netdev
;
2645 /* Check if an OpenFlow port number had been requested. */
2646 node
= shash_find(&init_ofp_ports
, name
);
2648 const struct iface_hint
*iface_hint
= node
->data
;
2649 simap_put(&p
->ofp_requests
, name
,
2650 ofp_to_u16(iface_hint
->ofp_port
));
2653 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2655 ofport_install(p
, netdev
, &pp
);
2656 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2657 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2658 ofp_to_u16(ofproto_port
.ofp_port
));
2664 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2665 struct iface_hint
*iface_hint
= node
->data
;
2667 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2668 free(iface_hint
->br_name
);
2669 free(iface_hint
->br_type
);
2671 shash_delete(&init_ofp_ports
, node
);
2678 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2679 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2681 find_min_mtu(struct ofproto
*p
)
2683 struct ofport
*ofport
;
2686 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2687 struct netdev
*netdev
= ofport
->netdev
;
2690 /* Skip any internal ports, since that's what we're trying to
2692 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2696 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2699 if (!mtu
|| dev_mtu
< mtu
) {
2704 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2707 /* Update MTU of all datapath devices on 'p' to the minimum of the
2708 * non-datapath ports in event of 'port' added or changed. */
2710 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2712 struct ofport
*ofport
;
2713 struct netdev
*netdev
= port
->netdev
;
2714 int dev_mtu
, old_min
;
2716 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2720 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2721 if (dev_mtu
> p
->min_mtu
) {
2722 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2723 dev_mtu
= p
->min_mtu
;
2726 port
->mtu
= dev_mtu
;
2730 /* For non-internal port find new min mtu. */
2731 old_min
= p
->min_mtu
;
2732 port
->mtu
= dev_mtu
;
2733 p
->min_mtu
= find_min_mtu(p
);
2734 if (p
->min_mtu
== old_min
) {
2738 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2739 struct netdev
*netdev
= ofport
->netdev
;
2741 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2742 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2743 ofport
->mtu
= p
->min_mtu
;
2750 ofproto_rule_destroy__(struct rule
*rule
)
2751 OVS_NO_THREAD_SAFETY_ANALYSIS
2753 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2754 rule_actions_destroy(rule_get_actions(rule
));
2755 ovs_mutex_destroy(&rule
->mutex
);
2756 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2760 rule_destroy_cb(struct rule
*rule
)
2762 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2763 ofproto_rule_destroy__(rule
);
2767 ofproto_rule_ref(struct rule
*rule
)
2770 ovs_refcount_ref(&rule
->ref_count
);
2775 ofproto_rule_try_ref(struct rule
*rule
)
2778 return ovs_refcount_try_ref_rcu(&rule
->ref_count
);
2783 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2784 * ref_count reaches 0.
2786 * Use of RCU allows short term use (between RCU quiescent periods) without
2787 * keeping a reference. A reference must be taken if the rule needs to
2788 * stay around accross the RCU quiescent periods. */
2790 ofproto_rule_unref(struct rule
*rule
)
2792 if (rule
&& ovs_refcount_unref_relaxed(&rule
->ref_count
) == 1) {
2793 ovsrcu_postpone(rule_destroy_cb
, rule
);
2798 remove_rule_rcu__(struct rule
*rule
)
2799 OVS_REQUIRES(ofproto_mutex
)
2801 struct ofproto
*ofproto
= rule
->ofproto
;
2802 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
2804 ovs_assert(!cls_rule_visible_in_version(&rule
->cr
, CLS_MAX_VERSION
));
2805 if (!classifier_remove(&table
->cls
, &rule
->cr
)) {
2808 ofproto
->ofproto_class
->rule_delete(rule
);
2809 ofproto_rule_unref(rule
);
2813 remove_rule_rcu(struct rule
*rule
)
2814 OVS_EXCLUDED(ofproto_mutex
)
2816 ovs_mutex_lock(&ofproto_mutex
);
2817 remove_rule_rcu__(rule
);
2818 ovs_mutex_unlock(&ofproto_mutex
);
2821 /* Removes and deletes rules from a NULL-terminated array of rule pointers. */
2823 remove_rules_rcu(struct rule
**rules
)
2824 OVS_EXCLUDED(ofproto_mutex
)
2826 struct rule
**orig_rules
= rules
;
2829 struct ofproto
*ofproto
= rules
[0]->ofproto
;
2830 unsigned long tables
[BITMAP_N_LONGS(256)];
2834 memset(tables
, 0, sizeof tables
);
2836 ovs_mutex_lock(&ofproto_mutex
);
2837 while ((rule
= *rules
++)) {
2838 /* Defer once for each new table. This defers the subtable cleanup
2839 * until later, so that when removing large number of flows the
2840 * operation is faster. */
2841 if (!bitmap_is_set(tables
, rule
->table_id
)) {
2842 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
2844 bitmap_set1(tables
, rule
->table_id
);
2845 classifier_defer(cls
);
2847 remove_rule_rcu__(rule
);
2850 BITMAP_FOR_EACH_1(table_id
, 256, tables
) {
2851 struct classifier
*cls
= &ofproto
->tables
[table_id
].cls
;
2853 classifier_publish(cls
);
2855 ovs_mutex_unlock(&ofproto_mutex
);
2862 ofproto_group_ref(struct ofgroup
*group
)
2865 ovs_refcount_ref(&group
->ref_count
);
2870 ofproto_group_unref(struct ofgroup
*group
)
2872 if (group
&& ovs_refcount_unref(&group
->ref_count
) == 1) {
2873 group
->ofproto
->ofproto_class
->group_destruct(group
);
2874 ofputil_bucket_list_destroy(&group
->buckets
);
2875 group
->ofproto
->ofproto_class
->group_dealloc(group
);
2879 static uint32_t get_provider_meter_id(const struct ofproto
*,
2880 uint32_t of_meter_id
);
2882 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2883 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2884 const struct rule_actions
*
2885 rule_actions_create(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2887 struct rule_actions
*actions
;
2889 actions
= xmalloc(sizeof *actions
+ ofpacts_len
);
2890 actions
->ofpacts_len
= ofpacts_len
;
2891 actions
->has_meter
= ofpacts_get_meter(ofpacts
, ofpacts_len
) != 0;
2892 memcpy(actions
->ofpacts
, ofpacts
, ofpacts_len
);
2894 actions
->has_learn_with_delete
= (next_learn_with_delete(actions
, NULL
)
2900 /* Free the actions after the RCU quiescent period is reached. */
2902 rule_actions_destroy(const struct rule_actions
*actions
)
2905 ovsrcu_postpone(free
, CONST_CAST(struct rule_actions
*, actions
));
2909 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2910 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2912 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2913 OVS_REQUIRES(ofproto_mutex
)
2915 if (port
== OFPP_ANY
) {
2918 const struct rule_actions
*actions
= rule_get_actions(rule
);
2919 return ofpacts_output_to_port(actions
->ofpacts
,
2920 actions
->ofpacts_len
, port
);
2924 /* Returns true if 'rule' has group and equals group_id. */
2926 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
2927 OVS_REQUIRES(ofproto_mutex
)
2929 if (group_id
== OFPG_ANY
) {
2932 const struct rule_actions
*actions
= rule_get_actions(rule
);
2933 return ofpacts_output_to_group(actions
->ofpacts
,
2934 actions
->ofpacts_len
, group_id
);
2939 rule_execute_destroy(struct rule_execute
*e
)
2941 ofproto_rule_unref(e
->rule
);
2942 list_remove(&e
->list_node
);
2946 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2947 * by passing them to the ofproto provider. */
2949 run_rule_executes(struct ofproto
*ofproto
)
2950 OVS_EXCLUDED(ofproto_mutex
)
2952 struct rule_execute
*e
, *next
;
2953 struct ovs_list executes
;
2955 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2956 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2959 flow_extract(e
->packet
, &flow
);
2960 flow
.in_port
.ofp_port
= e
->in_port
;
2961 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
2963 rule_execute_destroy(e
);
2967 /* Destroys and discards all "rule_execute" operations queued up in
2968 * ofproto->rule_executes. */
2970 destroy_rule_executes(struct ofproto
*ofproto
)
2972 struct rule_execute
*e
, *next
;
2973 struct ovs_list executes
;
2975 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2976 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2977 dp_packet_delete(e
->packet
);
2978 rule_execute_destroy(e
);
2983 rule_is_readonly(const struct rule
*rule
)
2985 const struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
2986 return (table
->flags
& OFTABLE_READONLY
) != 0;
2990 hash_learned_cookie(ovs_be64 cookie_
, uint8_t table_id
)
2992 uint64_t cookie
= (OVS_FORCE
uint64_t) cookie_
;
2993 return hash_3words(cookie
, cookie
>> 32, table_id
);
2997 learned_cookies_update_one__(struct ofproto
*ofproto
,
2998 const struct ofpact_learn
*learn
,
2999 int delta
, struct ovs_list
*dead_cookies
)
3000 OVS_REQUIRES(ofproto_mutex
)
3002 uint32_t hash
= hash_learned_cookie(learn
->cookie
, learn
->table_id
);
3003 struct learned_cookie
*c
;
3005 HMAP_FOR_EACH_WITH_HASH (c
, u
.hmap_node
, hash
, &ofproto
->learned_cookies
) {
3006 if (c
->cookie
== learn
->cookie
&& c
->table_id
== learn
->table_id
) {
3008 ovs_assert(c
->n
>= 0);
3011 hmap_remove(&ofproto
->learned_cookies
, &c
->u
.hmap_node
);
3012 list_push_back(dead_cookies
, &c
->u
.list_node
);
3019 ovs_assert(delta
> 0);
3020 c
= xmalloc(sizeof *c
);
3021 hmap_insert(&ofproto
->learned_cookies
, &c
->u
.hmap_node
, hash
);
3022 c
->cookie
= learn
->cookie
;
3023 c
->table_id
= learn
->table_id
;
3027 static const struct ofpact_learn
*
3028 next_learn_with_delete(const struct rule_actions
*actions
,
3029 const struct ofpact_learn
*start
)
3031 const struct ofpact
*pos
;
3033 for (pos
= start
? ofpact_next(&start
->ofpact
) : actions
->ofpacts
;
3034 pos
< ofpact_end(actions
->ofpacts
, actions
->ofpacts_len
);
3035 pos
= ofpact_next(pos
)) {
3036 if (pos
->type
== OFPACT_LEARN
) {
3037 const struct ofpact_learn
*learn
= ofpact_get_LEARN(pos
);
3038 if (learn
->flags
& NX_LEARN_F_DELETE_LEARNED
) {
3048 learned_cookies_update__(struct ofproto
*ofproto
,
3049 const struct rule_actions
*actions
,
3050 int delta
, struct ovs_list
*dead_cookies
)
3051 OVS_REQUIRES(ofproto_mutex
)
3053 if (actions
->has_learn_with_delete
) {
3054 const struct ofpact_learn
*learn
;
3056 for (learn
= next_learn_with_delete(actions
, NULL
); learn
;
3057 learn
= next_learn_with_delete(actions
, learn
)) {
3058 learned_cookies_update_one__(ofproto
, learn
, delta
, dead_cookies
);
3064 learned_cookies_inc(struct ofproto
*ofproto
,
3065 const struct rule_actions
*actions
)
3066 OVS_REQUIRES(ofproto_mutex
)
3068 learned_cookies_update__(ofproto
, actions
, +1, NULL
);
3072 learned_cookies_dec(struct ofproto
*ofproto
,
3073 const struct rule_actions
*actions
,
3074 struct ovs_list
*dead_cookies
)
3075 OVS_REQUIRES(ofproto_mutex
)
3077 learned_cookies_update__(ofproto
, actions
, -1, dead_cookies
);
3081 learned_cookies_flush(struct ofproto
*ofproto
, struct ovs_list
*dead_cookies
)
3082 OVS_REQUIRES(ofproto_mutex
)
3084 struct learned_cookie
*c
;
3086 LIST_FOR_EACH_POP (c
, u
.list_node
, dead_cookies
) {
3087 struct rule_criteria criteria
;
3088 struct rule_collection rules
;
3091 match_init_catchall(&match
);
3092 rule_criteria_init(&criteria
, c
->table_id
, &match
, 0, CLS_MAX_VERSION
,
3093 c
->cookie
, OVS_BE64_MAX
, OFPP_ANY
, OFPG_ANY
);
3094 rule_criteria_require_rw(&criteria
, false);
3095 collect_rules_loose(ofproto
, &criteria
, &rules
);
3096 rule_criteria_destroy(&criteria
);
3097 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
3104 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3106 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
3111 query_tables(struct ofproto
*ofproto
,
3112 struct ofputil_table_features
**featuresp
,
3113 struct ofputil_table_stats
**statsp
)
3115 struct mf_bitmap rw_fields
= oxm_writable_fields();
3116 struct mf_bitmap match
= oxm_matchable_fields();
3117 struct mf_bitmap mask
= oxm_maskable_fields();
3119 struct ofputil_table_features
*features
;
3120 struct ofputil_table_stats
*stats
;
3123 features
= *featuresp
= xcalloc(ofproto
->n_tables
, sizeof *features
);
3124 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3125 struct ofputil_table_features
*f
= &features
[i
];
3128 sprintf(f
->name
, "table%d", i
);
3129 f
->metadata_match
= OVS_BE64_MAX
;
3130 f
->metadata_write
= OVS_BE64_MAX
;
3131 atomic_read_relaxed(&ofproto
->tables
[i
].miss_config
, &f
->miss_config
);
3132 f
->max_entries
= 1000000;
3134 bool more_tables
= false;
3135 for (int j
= i
+ 1; j
< ofproto
->n_tables
; j
++) {
3136 if (!(ofproto
->tables
[j
].flags
& OFTABLE_HIDDEN
)) {
3137 bitmap_set1(f
->nonmiss
.next
, j
);
3141 f
->nonmiss
.instructions
= (1u << N_OVS_INSTRUCTIONS
) - 1;
3143 f
->nonmiss
.instructions
&= ~(1u << OVSINST_OFPIT11_GOTO_TABLE
);
3145 f
->nonmiss
.write
.ofpacts
= (UINT64_C(1) << N_OFPACTS
) - 1;
3146 f
->nonmiss
.write
.set_fields
= rw_fields
;
3147 f
->nonmiss
.apply
= f
->nonmiss
.write
;
3148 f
->miss
= f
->nonmiss
;
3152 f
->wildcard
= match
;
3156 stats
= *statsp
= xcalloc(ofproto
->n_tables
, sizeof *stats
);
3157 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3158 struct ofputil_table_stats
*s
= &stats
[i
];
3161 s
->active_count
= ofproto
->tables
[i
].n_flows
;
3163 s
->active_count
-= connmgr_count_hidden_rules(
3171 ofproto
->ofproto_class
->query_tables(ofproto
, features
, stats
);
3173 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3174 const struct oftable
*table
= &ofproto
->tables
[i
];
3175 struct ofputil_table_features
*f
= &features
[i
];
3178 ovs_strzcpy(f
->name
, table
->name
, sizeof f
->name
);
3181 if (table
->max_flows
< f
->max_entries
) {
3182 f
->max_entries
= table
->max_flows
;
3188 query_switch_features(struct ofproto
*ofproto
,
3189 bool *arp_match_ip
, uint64_t *ofpacts
)
3191 struct ofputil_table_features
*features
, *f
;
3193 *arp_match_ip
= false;
3196 query_tables(ofproto
, &features
, NULL
);
3197 for (f
= features
; f
< &features
[ofproto
->n_tables
]; f
++) {
3198 *ofpacts
|= f
->nonmiss
.apply
.ofpacts
| f
->miss
.apply
.ofpacts
;
3199 if (bitmap_is_set(f
->match
.bm
, MFF_ARP_SPA
) ||
3200 bitmap_is_set(f
->match
.bm
, MFF_ARP_TPA
)) {
3201 *arp_match_ip
= true;
3207 ovs_assert(*ofpacts
& (UINT64_C(1) << OFPACT_OUTPUT
));
3211 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3213 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3214 struct ofputil_switch_features features
;
3215 struct ofport
*port
;
3219 query_switch_features(ofproto
, &arp_match_ip
, &features
.ofpacts
);
3221 features
.datapath_id
= ofproto
->datapath_id
;
3222 features
.n_buffers
= pktbuf_capacity();
3223 features
.n_tables
= ofproto_get_n_visible_tables(ofproto
);
3224 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
3225 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
|
3226 OFPUTIL_C_GROUP_STATS
);
3228 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
3230 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3231 features
.auxiliary_id
= 0;
3232 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
3234 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3235 ofputil_put_switch_features_port(&port
->pp
, b
);
3238 ofconn_send_reply(ofconn
, b
);
3243 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3245 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3246 struct ofp_switch_config
*osc
;
3247 enum ofp_config_flags flags
;
3251 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
3252 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
3253 flags
= ofproto
->frag_handling
;
3254 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3255 if (oh
->version
< OFP13_VERSION
3256 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
3257 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
3259 osc
->flags
= htons(flags
);
3260 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
3261 ofconn_send_reply(ofconn
, buf
);
3267 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3269 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
3270 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3271 uint16_t flags
= ntohs(osc
->flags
);
3273 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
3274 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
3275 enum ofp_config_flags cur
= ofproto
->frag_handling
;
3276 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
3278 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
3280 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
3281 ofproto
->frag_handling
= next
;
3283 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
3285 ofputil_frag_handling_to_string(next
));
3289 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3290 ofconn_set_invalid_ttl_to_controller(ofconn
,
3291 (oh
->version
< OFP13_VERSION
3292 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
3294 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
3299 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3300 * error message code for the caller to propagate upward. Otherwise, returns
3303 * The log message mentions 'msg_type'. */
3305 reject_slave_controller(struct ofconn
*ofconn
)
3307 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
3308 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
3309 return OFPERR_OFPBRC_IS_SLAVE
;
3315 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3318 * - If they use a meter, then 'ofproto' has that meter configured.
3320 * - If they use any groups, then 'ofproto' has that group configured.
3322 * Returns 0 if successful, otherwise an OpenFlow error. */
3324 ofproto_check_ofpacts(struct ofproto
*ofproto
,
3325 const struct ofpact ofpacts
[], size_t ofpacts_len
)
3327 const struct ofpact
*a
;
3330 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
3331 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
3332 return OFPERR_OFPMMFC_INVALID_METER
;
3335 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3336 if (a
->type
== OFPACT_GROUP
3337 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
3338 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
3346 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3348 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3349 struct ofputil_packet_out po
;
3350 struct dp_packet
*payload
;
3351 uint64_t ofpacts_stub
[1024 / 8];
3352 struct ofpbuf ofpacts
;
3356 COVERAGE_INC(ofproto_packet_out
);
3358 error
= reject_slave_controller(ofconn
);
3363 /* Decode message. */
3364 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3365 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
3367 goto exit_free_ofpacts
;
3369 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
3370 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
3371 error
= OFPERR_OFPBRC_BAD_PORT
;
3372 goto exit_free_ofpacts
;
3376 if (po
.buffer_id
!= UINT32_MAX
) {
3377 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
3378 if (error
|| !payload
) {
3379 goto exit_free_ofpacts
;
3382 /* Ensure that the L3 header is 32-bit aligned. */
3383 payload
= dp_packet_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
3386 /* Verify actions against packet, then send packet if successful. */
3387 flow_extract(payload
, &flow
);
3388 flow
.in_port
.ofp_port
= po
.in_port
;
3389 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
3391 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
3392 po
.ofpacts
, po
.ofpacts_len
);
3394 dp_packet_delete(payload
);
3397 ofpbuf_uninit(&ofpacts
);
3403 update_port_config(struct ofconn
*ofconn
, struct ofport
*port
,
3404 enum ofputil_port_config config
,
3405 enum ofputil_port_config mask
)
3407 enum ofputil_port_config toggle
= (config
^ port
->pp
.config
) & mask
;
3409 if (toggle
& OFPUTIL_PC_PORT_DOWN
3410 && (config
& OFPUTIL_PC_PORT_DOWN
3411 ? netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
)
3412 : netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
))) {
3413 /* We tried to bring the port up or down, but it failed, so don't
3414 * update the "down" bit. */
3415 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
3419 enum ofputil_port_config old_config
= port
->pp
.config
;
3420 port
->pp
.config
^= toggle
;
3421 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
3422 connmgr_send_port_status(port
->ofproto
->connmgr
, ofconn
, &port
->pp
,
3428 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3430 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3431 struct ofputil_port_mod pm
;
3432 struct ofport
*port
;
3435 error
= reject_slave_controller(ofconn
);
3440 error
= ofputil_decode_port_mod(oh
, &pm
, false);
3445 port
= ofproto_get_port(p
, pm
.port_no
);
3447 return OFPERR_OFPPMFC_BAD_PORT
;
3448 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
3449 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3451 update_port_config(ofconn
, port
, pm
.config
, pm
.mask
);
3453 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
3460 handle_desc_stats_request(struct ofconn
*ofconn
,
3461 const struct ofp_header
*request
)
3463 static const char *default_mfr_desc
= "Nicira, Inc.";
3464 static const char *default_hw_desc
= "Open vSwitch";
3465 static const char *default_sw_desc
= VERSION
;
3466 static const char *default_serial_desc
= "None";
3467 static const char *default_dp_desc
= "None";
3469 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3470 struct ofp_desc_stats
*ods
;
3473 msg
= ofpraw_alloc_stats_reply(request
, 0);
3474 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3475 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3476 sizeof ods
->mfr_desc
);
3477 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3478 sizeof ods
->hw_desc
);
3479 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3480 sizeof ods
->sw_desc
);
3481 ovs_strlcpy(ods
->serial_num
,
3482 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3483 sizeof ods
->serial_num
);
3484 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3485 sizeof ods
->dp_desc
);
3486 ofconn_send_reply(ofconn
, msg
);
3492 handle_table_stats_request(struct ofconn
*ofconn
,
3493 const struct ofp_header
*request
)
3495 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3496 struct ofputil_table_features
*features
;
3497 struct ofputil_table_stats
*stats
;
3498 struct ofpbuf
*reply
;
3501 query_tables(ofproto
, &features
, &stats
);
3503 reply
= ofputil_encode_table_stats_reply(request
);
3504 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3505 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3506 ofputil_append_table_stats_reply(reply
, &stats
[i
], &features
[i
]);
3509 ofconn_send_reply(ofconn
, reply
);
3518 handle_table_features_request(struct ofconn
*ofconn
,
3519 const struct ofp_header
*request
)
3521 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3522 struct ofputil_table_features
*features
;
3523 struct ovs_list replies
;
3527 ofpbuf_use_const(&msg
, request
, ntohs(request
->length
));
3528 ofpraw_pull_assert(&msg
);
3529 if (msg
.size
|| ofpmp_more(request
)) {
3530 return OFPERR_OFPTFFC_EPERM
;
3533 query_tables(ofproto
, &features
, NULL
);
3535 ofpmp_init(&replies
, request
);
3536 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3537 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3538 ofputil_append_table_features_reply(&features
[i
], &replies
);
3541 ofconn_send_replies(ofconn
, &replies
);
3549 append_port_stat(struct ofport
*port
, struct ovs_list
*replies
)
3551 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3553 calc_duration(port
->created
, time_msec(),
3554 &ops
.duration_sec
, &ops
.duration_nsec
);
3556 /* Intentionally ignore return value, since errors will set
3557 * 'stats' to all-1s, which is correct for OpenFlow, and
3558 * netdev_get_stats() will log errors. */
3559 ofproto_port_get_stats(port
, &ops
.stats
);
3561 ofputil_append_port_stat(replies
, &ops
);
3565 handle_port_request(struct ofconn
*ofconn
,
3566 const struct ofp_header
*request
, ofp_port_t port_no
,
3567 void (*cb
)(struct ofport
*, struct ovs_list
*replies
))
3569 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3570 struct ofport
*port
;
3571 struct ovs_list replies
;
3573 ofpmp_init(&replies
, request
);
3574 if (port_no
!= OFPP_ANY
) {
3575 port
= ofproto_get_port(ofproto
, port_no
);
3580 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3585 ofconn_send_replies(ofconn
, &replies
);
3589 handle_port_stats_request(struct ofconn
*ofconn
,
3590 const struct ofp_header
*request
)
3595 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3597 handle_port_request(ofconn
, request
, port_no
, append_port_stat
);
3603 append_port_desc(struct ofport
*port
, struct ovs_list
*replies
)
3605 ofputil_append_port_desc_stats_reply(&port
->pp
, replies
);
3609 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3610 const struct ofp_header
*request
)
3615 error
= ofputil_decode_port_desc_stats_request(request
, &port_no
);
3617 handle_port_request(ofconn
, request
, port_no
, append_port_desc
);
3623 hash_cookie(ovs_be64 cookie
)
3625 return hash_uint64((OVS_FORCE
uint64_t)cookie
);
3629 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3630 OVS_REQUIRES(ofproto_mutex
)
3632 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3633 hash_cookie(rule
->flow_cookie
));
3637 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3638 OVS_REQUIRES(ofproto_mutex
)
3640 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3644 calc_duration(long long int start
, long long int now
,
3645 uint32_t *sec
, uint32_t *nsec
)
3647 long long int msecs
= now
- start
;
3648 *sec
= msecs
/ 1000;
3649 *nsec
= (msecs
% 1000) * (1000 * 1000);
3652 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3653 * true if 'table_id' is OK, false otherwise. */
3655 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3657 return table_id
== OFPTT_ALL
|| table_id
< ofproto
->n_tables
;
3660 static struct oftable
*
3661 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3663 struct oftable
*table
;
3665 for (table
= &ofproto
->tables
[table_id
];
3666 table
< &ofproto
->tables
[ofproto
->n_tables
];
3668 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3676 static struct oftable
*
3677 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3679 if (table_id
== 0xff) {
3680 return next_visible_table(ofproto
, 0);
3681 } else if (table_id
< ofproto
->n_tables
) {
3682 return &ofproto
->tables
[table_id
];
3688 static struct oftable
*
3689 next_matching_table(const struct ofproto
*ofproto
,
3690 const struct oftable
*table
, uint8_t table_id
)
3692 return (table_id
== 0xff
3693 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3697 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3699 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3700 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3702 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3703 * only once, for that table. (This can be used to access tables marked
3706 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3707 * entered at all. (Perhaps you should have validated TABLE_ID with
3708 * check_table_id().)
3710 * All parameters are evaluated multiple times.
3712 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3713 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3715 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3717 /* Initializes 'criteria' in a straightforward way based on the other
3720 * By default, the criteria include flows that are read-only, on the assumption
3721 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3722 * if flows will be modified.
3724 * For "loose" matching, the 'priority' parameter is unimportant and may be
3727 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3728 const struct match
*match
, int priority
, long long version
,
3729 ovs_be64 cookie
, ovs_be64 cookie_mask
,
3730 ofp_port_t out_port
, uint32_t out_group
)
3732 criteria
->table_id
= table_id
;
3733 cls_rule_init(&criteria
->cr
, match
, priority
, version
);
3734 criteria
->cookie
= cookie
;
3735 criteria
->cookie_mask
= cookie_mask
;
3736 criteria
->out_port
= out_port
;
3737 criteria
->out_group
= out_group
;
3739 /* We ordinarily want to skip hidden rules, but there has to be a way for
3740 * code internal to OVS to modify and delete them, so if the criteria
3741 * specify a priority that can only be for a hidden flow, then allow hidden
3742 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3743 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3745 criteria
->include_hidden
= priority
> UINT16_MAX
;
3747 /* We assume that the criteria are being used to collect flows for reading
3748 * but not modification. Thus, we should collect read-only flows. */
3749 criteria
->include_readonly
= true;
3752 /* By default, criteria initialized by rule_criteria_init() will match flows
3753 * that are read-only, on the assumption that the collected flows won't be
3754 * modified. Call this function to match only flows that are be modifiable.
3756 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3757 * caller has special privileges that allow it to modify even "read-only"
3760 rule_criteria_require_rw(struct rule_criteria
*criteria
,
3761 bool can_write_readonly
)
3763 criteria
->include_readonly
= can_write_readonly
;
3767 rule_criteria_destroy(struct rule_criteria
*criteria
)
3769 cls_rule_destroy(&criteria
->cr
);
3773 rule_collection_init(struct rule_collection
*rules
)
3775 rules
->rules
= rules
->stub
;
3777 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
3781 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
3783 if (rules
->n
>= rules
->capacity
) {
3784 size_t old_size
, new_size
;
3786 old_size
= rules
->capacity
* sizeof *rules
->rules
;
3787 rules
->capacity
*= 2;
3788 new_size
= rules
->capacity
* sizeof *rules
->rules
;
3790 if (rules
->rules
== rules
->stub
) {
3791 rules
->rules
= xmalloc(new_size
);
3792 memcpy(rules
->rules
, rules
->stub
, old_size
);
3794 rules
->rules
= xrealloc(rules
->rules
, new_size
);
3798 rules
->rules
[rules
->n
++] = rule
;
3802 rule_collection_ref(struct rule_collection
*rules
)
3803 OVS_REQUIRES(ofproto_mutex
)
3807 for (i
= 0; i
< rules
->n
; i
++) {
3808 ofproto_rule_ref(rules
->rules
[i
]);
3813 rule_collection_unref(struct rule_collection
*rules
)
3817 for (i
= 0; i
< rules
->n
; i
++) {
3818 ofproto_rule_unref(rules
->rules
[i
]);
3822 /* Returns a NULL-terminated array of rule pointers,
3823 * destroys 'rules'. */
3824 static struct rule
**
3825 rule_collection_detach(struct rule_collection
*rules
)
3827 struct rule
**rule_array
;
3829 rule_collection_add(rules
, NULL
);
3831 if (rules
->rules
== rules
->stub
) {
3832 rules
->rules
= xmemdup(rules
->rules
, rules
->n
* sizeof *rules
->rules
);
3835 rule_array
= rules
->rules
;
3836 rule_collection_init(rules
);
3842 rule_collection_destroy(struct rule_collection
*rules
)
3844 if (rules
->rules
!= rules
->stub
) {
3848 /* Make repeated destruction harmless. */
3849 rule_collection_init(rules
);
3852 /* Schedules postponed removal of rules, destroys 'rules'. */
3854 rule_collection_remove_postponed(struct rule_collection
*rules
)
3855 OVS_REQUIRES(ofproto_mutex
)
3858 if (rules
->n
== 1) {
3859 ovsrcu_postpone(remove_rule_rcu
, rules
->rules
[0]);
3861 ovsrcu_postpone(remove_rules_rcu
, rule_collection_detach(rules
));
3866 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3867 * function verifies most of the criteria in 'c' itself, but the caller must
3868 * check 'c->cr' itself.
3870 * Rules that have already been marked for removal are not collected.
3872 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3873 * 'c' only includes modifiable rules). */
3875 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
3876 struct rule_collection
*rules
, size_t *n_readonly
)
3877 OVS_REQUIRES(ofproto_mutex
)
3879 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
3880 && ofproto_rule_has_out_port(rule
, c
->out_port
)
3881 && ofproto_rule_has_out_group(rule
, c
->out_group
)
3882 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)
3883 && (!rule_is_hidden(rule
) || c
->include_hidden
)
3884 && cls_rule_visible_in_version(&rule
->cr
, c
->cr
.version
)) {
3885 /* Rule matches all the criteria... */
3886 if (!rule_is_readonly(rule
) || c
->include_readonly
) {
3888 rule_collection_add(rules
, rule
);
3890 /* ...except it's read-only. */
3896 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3897 * on classifiers rules are done in the "loose" way required for OpenFlow
3898 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3901 * Returns 0 on success, otherwise an OpenFlow error code. */
3903 collect_rules_loose(struct ofproto
*ofproto
,
3904 const struct rule_criteria
*criteria
,
3905 struct rule_collection
*rules
)
3906 OVS_REQUIRES(ofproto_mutex
)
3908 struct oftable
*table
;
3909 enum ofperr error
= 0;
3910 size_t n_readonly
= 0;
3912 rule_collection_init(rules
);
3914 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3915 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3919 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3922 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3923 hash_cookie(criteria
->cookie
),
3924 &ofproto
->cookies
) {
3925 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
3926 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3930 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3933 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &criteria
->cr
) {
3934 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3940 if (!error
&& !rules
->n
&& n_readonly
) {
3941 /* We didn't find any rules to modify. We did find some read-only
3942 * rules that we're not allowed to modify, so report that. */
3943 error
= OFPERR_OFPBRC_EPERM
;
3946 rule_collection_destroy(rules
);
3951 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3952 * on classifiers rules are done in the "strict" way required for OpenFlow
3953 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3954 * rules on list 'rules'.
3956 * Returns 0 on success, otherwise an OpenFlow error code. */
3958 collect_rules_strict(struct ofproto
*ofproto
,
3959 const struct rule_criteria
*criteria
,
3960 struct rule_collection
*rules
)
3961 OVS_REQUIRES(ofproto_mutex
)
3963 struct oftable
*table
;
3964 size_t n_readonly
= 0;
3965 enum ofperr error
= 0;
3967 rule_collection_init(rules
);
3969 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3970 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3974 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3977 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3978 hash_cookie(criteria
->cookie
),
3979 &ofproto
->cookies
) {
3980 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
3981 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3985 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3988 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
3989 &table
->cls
, &criteria
->cr
));
3991 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3997 if (!error
&& !rules
->n
&& n_readonly
) {
3998 /* We didn't find any rules to modify. We did find some read-only
3999 * rules that we're not allowed to modify, so report that. */
4000 error
= OFPERR_OFPBRC_EPERM
;
4003 rule_collection_destroy(rules
);
4008 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
4009 * forced into the range of a uint16_t. */
4011 age_secs(long long int age_ms
)
4013 return (age_ms
< 0 ? 0
4014 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
4015 : (unsigned int) age_ms
/ 1000);
4019 handle_flow_stats_request(struct ofconn
*ofconn
,
4020 const struct ofp_header
*request
)
4021 OVS_EXCLUDED(ofproto_mutex
)
4023 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4024 struct ofputil_flow_stats_request fsr
;
4025 struct rule_criteria criteria
;
4026 struct rule_collection rules
;
4027 struct ovs_list replies
;
4031 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
4036 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, CLS_MAX_VERSION
,
4037 fsr
.cookie
, fsr
.cookie_mask
, fsr
.out_port
,
4040 ovs_mutex_lock(&ofproto_mutex
);
4041 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4042 rule_criteria_destroy(&criteria
);
4044 rule_collection_ref(&rules
);
4046 ovs_mutex_unlock(&ofproto_mutex
);
4052 ofpmp_init(&replies
, request
);
4053 for (i
= 0; i
< rules
.n
; i
++) {
4054 struct rule
*rule
= rules
.rules
[i
];
4055 long long int now
= time_msec();
4056 struct ofputil_flow_stats fs
;
4057 long long int created
, used
, modified
;
4058 const struct rule_actions
*actions
;
4059 enum ofputil_flow_mod_flags flags
;
4061 ovs_mutex_lock(&rule
->mutex
);
4062 fs
.cookie
= rule
->flow_cookie
;
4063 fs
.idle_timeout
= rule
->idle_timeout
;
4064 fs
.hard_timeout
= rule
->hard_timeout
;
4065 fs
.importance
= rule
->importance
;
4066 created
= rule
->created
;
4067 modified
= rule
->modified
;
4068 actions
= rule_get_actions(rule
);
4069 flags
= rule
->flags
;
4070 ovs_mutex_unlock(&rule
->mutex
);
4072 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
4073 &fs
.byte_count
, &used
);
4075 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
4076 fs
.table_id
= rule
->table_id
;
4077 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
4078 fs
.priority
= rule
->cr
.priority
;
4079 fs
.idle_age
= age_secs(now
- used
);
4080 fs
.hard_age
= age_secs(now
- modified
);
4081 fs
.ofpacts
= actions
->ofpacts
;
4082 fs
.ofpacts_len
= actions
->ofpacts_len
;
4085 ofputil_append_flow_stats_reply(&fs
, &replies
);
4088 rule_collection_unref(&rules
);
4089 rule_collection_destroy(&rules
);
4091 ofconn_send_replies(ofconn
, &replies
);
4097 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
4099 uint64_t packet_count
, byte_count
;
4100 const struct rule_actions
*actions
;
4101 long long int created
, used
;
4103 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
4104 &byte_count
, &used
);
4106 ovs_mutex_lock(&rule
->mutex
);
4107 actions
= rule_get_actions(rule
);
4108 created
= rule
->created
;
4109 ovs_mutex_unlock(&rule
->mutex
);
4111 if (rule
->table_id
!= 0) {
4112 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
4114 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
4115 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
4116 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
4117 cls_rule_format(&rule
->cr
, results
);
4118 ds_put_char(results
, ',');
4120 ds_put_cstr(results
, "actions=");
4121 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
4123 ds_put_cstr(results
, "\n");
4126 /* Adds a pretty-printed description of all flows to 'results', including
4127 * hidden flows (e.g., set up by in-band control). */
4129 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
4131 struct oftable
*table
;
4133 OFPROTO_FOR_EACH_TABLE (table
, p
) {
4136 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
4137 flow_stats_ds(rule
, results
);
4142 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
4143 * '*engine_type' and '*engine_id', respectively. */
4145 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
4146 uint8_t *engine_type
, uint8_t *engine_id
)
4148 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
4151 /* Checks the status change of CFM on 'ofport'.
4153 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
4155 ofproto_port_cfm_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
4157 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
4158 return (ofport
&& ofproto
->ofproto_class
->cfm_status_changed
4159 ? ofproto
->ofproto_class
->cfm_status_changed(ofport
)
4163 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
4164 * Returns 0 if the port's CFM status was successfully stored into
4165 * '*status'. Returns positive errno if the port did not have CFM
4168 * The caller must provide and own '*status', and must free 'status->rmps'.
4169 * '*status' is indeterminate if the return value is non-zero. */
4171 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
4172 struct cfm_status
*status
)
4174 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
4175 return (ofport
&& ofproto
->ofproto_class
->get_cfm_status
4176 ? ofproto
->ofproto_class
->get_cfm_status(ofport
, status
)
4181 handle_aggregate_stats_request(struct ofconn
*ofconn
,
4182 const struct ofp_header
*oh
)
4183 OVS_EXCLUDED(ofproto_mutex
)
4185 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4186 struct ofputil_flow_stats_request request
;
4187 struct ofputil_aggregate_stats stats
;
4188 bool unknown_packets
, unknown_bytes
;
4189 struct rule_criteria criteria
;
4190 struct rule_collection rules
;
4191 struct ofpbuf
*reply
;
4195 error
= ofputil_decode_flow_stats_request(&request
, oh
);
4200 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
4201 CLS_MAX_VERSION
, request
.cookie
, request
.cookie_mask
,
4202 request
.out_port
, request
.out_group
);
4204 ovs_mutex_lock(&ofproto_mutex
);
4205 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4206 rule_criteria_destroy(&criteria
);
4208 rule_collection_ref(&rules
);
4210 ovs_mutex_unlock(&ofproto_mutex
);
4216 memset(&stats
, 0, sizeof stats
);
4217 unknown_packets
= unknown_bytes
= false;
4218 for (i
= 0; i
< rules
.n
; i
++) {
4219 struct rule
*rule
= rules
.rules
[i
];
4220 uint64_t packet_count
;
4221 uint64_t byte_count
;
4224 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
4225 &byte_count
, &used
);
4227 if (packet_count
== UINT64_MAX
) {
4228 unknown_packets
= true;
4230 stats
.packet_count
+= packet_count
;
4233 if (byte_count
== UINT64_MAX
) {
4234 unknown_bytes
= true;
4236 stats
.byte_count
+= byte_count
;
4241 if (unknown_packets
) {
4242 stats
.packet_count
= UINT64_MAX
;
4244 if (unknown_bytes
) {
4245 stats
.byte_count
= UINT64_MAX
;
4248 rule_collection_unref(&rules
);
4249 rule_collection_destroy(&rules
);
4251 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
4252 ofconn_send_reply(ofconn
, reply
);
4257 struct queue_stats_cbdata
{
4258 struct ofport
*ofport
;
4259 struct ovs_list replies
;
4264 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
4265 const struct netdev_queue_stats
*stats
)
4267 struct ofputil_queue_stats oqs
;
4269 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
4270 oqs
.queue_id
= queue_id
;
4271 oqs
.tx_bytes
= stats
->tx_bytes
;
4272 oqs
.tx_packets
= stats
->tx_packets
;
4273 oqs
.tx_errors
= stats
->tx_errors
;
4274 if (stats
->created
!= LLONG_MIN
) {
4275 calc_duration(stats
->created
, cbdata
->now
,
4276 &oqs
.duration_sec
, &oqs
.duration_nsec
);
4278 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
4280 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
4284 handle_queue_stats_dump_cb(uint32_t queue_id
,
4285 struct netdev_queue_stats
*stats
,
4288 struct queue_stats_cbdata
*cbdata
= cbdata_
;
4290 put_queue_stats(cbdata
, queue_id
, stats
);
4294 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
4295 struct queue_stats_cbdata
*cbdata
)
4297 cbdata
->ofport
= port
;
4298 if (queue_id
== OFPQ_ALL
) {
4299 netdev_dump_queue_stats(port
->netdev
,
4300 handle_queue_stats_dump_cb
, cbdata
);
4302 struct netdev_queue_stats stats
;
4304 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
4305 put_queue_stats(cbdata
, queue_id
, &stats
);
4307 return OFPERR_OFPQOFC_BAD_QUEUE
;
4314 handle_queue_stats_request(struct ofconn
*ofconn
,
4315 const struct ofp_header
*rq
)
4317 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4318 struct queue_stats_cbdata cbdata
;
4319 struct ofport
*port
;
4321 struct ofputil_queue_stats_request oqsr
;
4323 COVERAGE_INC(ofproto_queue_req
);
4325 ofpmp_init(&cbdata
.replies
, rq
);
4326 cbdata
.now
= time_msec();
4328 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
4333 if (oqsr
.port_no
== OFPP_ANY
) {
4334 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
4335 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
4336 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
4341 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
4343 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
4344 : OFPERR_OFPQOFC_BAD_PORT
);
4347 ofconn_send_replies(ofconn
, &cbdata
.replies
);
4349 ofpbuf_list_delete(&cbdata
.replies
);
4356 evict_rules_from_table(struct oftable
*table
)
4357 OVS_REQUIRES(ofproto_mutex
)
4359 enum ofperr error
= 0;
4360 struct rule_collection rules
;
4361 unsigned int count
= table
->n_flows
;
4362 unsigned int max_flows
= table
->max_flows
;
4364 rule_collection_init(&rules
);
4366 while (count
-- > max_flows
) {
4369 if (!choose_rule_to_evict(table
, &rule
)) {
4370 error
= OFPERR_OFPFMFC_TABLE_FULL
;
4373 eviction_group_remove_rule(rule
);
4374 rule_collection_add(&rules
, rule
);
4377 delete_flows__(&rules
, OFPRR_EVICTION
, NULL
);
4383 is_conjunction(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
4385 return ofpacts_len
> 0 && ofpacts
->type
== OFPACT_CONJUNCTION
;
4389 get_conjunctions(const struct ofputil_flow_mod
*fm
,
4390 struct cls_conjunction
**conjsp
, size_t *n_conjsp
)
4391 OVS_REQUIRES(ofproto_mutex
)
4393 struct cls_conjunction
*conjs
= NULL
;
4396 if (is_conjunction(fm
->ofpacts
, fm
->ofpacts_len
)) {
4397 const struct ofpact
*ofpact
;
4401 OFPACT_FOR_EACH (ofpact
, fm
->ofpacts
, fm
->ofpacts_len
) {
4405 conjs
= xzalloc(n_conjs
* sizeof *conjs
);
4407 OFPACT_FOR_EACH (ofpact
, fm
->ofpacts
, fm
->ofpacts_len
) {
4408 struct ofpact_conjunction
*oc
= ofpact_get_CONJUNCTION(ofpact
);
4409 conjs
[i
].clause
= oc
->clause
;
4410 conjs
[i
].n_clauses
= oc
->n_clauses
;
4411 conjs
[i
].id
= oc
->id
;
4417 *n_conjsp
= n_conjs
;
4420 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4421 * in which no matching flow already exists in the flow table.
4423 * Adds the flow specified by 'fm', to the ofproto's flow table. Returns 0 on
4424 * success, or an OpenFlow error code on failure.
4426 * On successful return the caller must complete the operation either by
4427 * calling add_flow_finish(), or add_flow_revert() if the operation needs to
4430 * The caller retains ownership of 'fm->ofpacts'. */
4432 add_flow_start(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4433 struct rule
**old_rule
, struct rule
**new_rule
)
4434 OVS_REQUIRES(ofproto_mutex
)
4436 struct oftable
*table
;
4440 struct cls_conjunction
*conjs
;
4444 if (!check_table_id(ofproto
, fm
->table_id
)) {
4445 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4450 if (fm
->table_id
== 0xff) {
4451 if (ofproto
->ofproto_class
->rule_choose_table
) {
4452 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
4458 ovs_assert(table_id
< ofproto
->n_tables
);
4462 } else if (fm
->table_id
< ofproto
->n_tables
) {
4463 table_id
= fm
->table_id
;
4465 return OFPERR_OFPBRC_BAD_TABLE_ID
;
4468 table
= &ofproto
->tables
[table_id
];
4469 if (table
->flags
& OFTABLE_READONLY
4470 && !(fm
->flags
& OFPUTIL_FF_NO_READONLY
)) {
4471 return OFPERR_OFPBRC_EPERM
;
4474 if (!(fm
->flags
& OFPUTIL_FF_HIDDEN_FIELDS
)
4475 && !match_has_default_hidden_fields(&fm
->match
)) {
4476 VLOG_WARN_RL(&rl
, "%s: (add_flow) only internal flows can set "
4477 "non-default values to hidden fields", ofproto
->name
);
4478 return OFPERR_OFPBRC_EPERM
;
4481 cls_rule_init(&cr
, &fm
->match
, fm
->priority
, ofproto
->tables_version
+ 1);
4483 /* Check for the existence of an identical rule.
4484 * This will not return rules earlier marked for removal. */
4485 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
));
4488 /* Check for overlap, if requested. */
4489 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
4490 && classifier_rule_overlaps(&table
->cls
, &cr
)) {
4491 cls_rule_destroy(&cr
);
4492 return OFPERR_OFPFMFC_OVERLAP
;
4495 /* If necessary, evict an existing rule to clear out space. */
4496 if (table
->n_flows
>= table
->max_flows
) {
4497 if (!choose_rule_to_evict(table
, &rule
)) {
4498 error
= OFPERR_OFPFMFC_TABLE_FULL
;
4499 cls_rule_destroy(&cr
);
4502 eviction_group_remove_rule(rule
);
4503 /* Marks '*old_rule' as an evicted rule rather than replaced rule.
4505 fm
->delete_reason
= OFPRR_EVICTION
;
4509 fm
->modify_cookie
= true;
4512 /* Allocate new rule. */
4513 error
= replace_rule_create(ofproto
, fm
, &cr
, table
- ofproto
->tables
,
4519 get_conjunctions(fm
, &conjs
, &n_conjs
);
4520 replace_rule_start(ofproto
, rule
, *new_rule
, conjs
, n_conjs
);
4526 /* Revert the effects of add_flow_start(). */
4528 add_flow_revert(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4529 struct rule
*old_rule
, struct rule
*new_rule
)
4530 OVS_REQUIRES(ofproto_mutex
)
4532 if (old_rule
&& fm
->delete_reason
== OFPRR_EVICTION
) {
4533 /* Revert the eviction. */
4534 eviction_group_add_rule(old_rule
);
4537 replace_rule_revert(ofproto
, old_rule
, new_rule
);
4540 /* To be called after version bump. */
4542 add_flow_finish(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4543 const struct flow_mod_requester
*req
,
4544 struct rule
*old_rule
, struct rule
*new_rule
)
4545 OVS_REQUIRES(ofproto_mutex
)
4547 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
4549 replace_rule_finish(ofproto
, fm
, req
, old_rule
, new_rule
, &dead_cookies
);
4550 learned_cookies_flush(ofproto
, &dead_cookies
);
4553 ovsrcu_postpone(remove_rule_rcu
, old_rule
);
4555 if (minimask_get_vid_mask(&new_rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
4556 if (ofproto
->vlan_bitmap
) {
4557 uint16_t vid
= miniflow_get_vid(&new_rule
->cr
.match
.flow
);
4559 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
4560 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
4561 ofproto
->vlans_changed
= true;
4564 ofproto
->vlans_changed
= true;
4568 ofmonitor_report(ofproto
->connmgr
, new_rule
, NXFME_ADDED
, 0,
4569 req
? req
->ofconn
: NULL
,
4570 req
? req
->request
->xid
: 0, NULL
);
4573 send_buffered_packet(req
, fm
->buffer_id
, new_rule
);
4576 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4578 /* Create a new rule based on attributes in 'fm', match in 'cr', 'table_id',
4579 * and 'old_rule'. Note that the rule is NOT inserted into a any data
4580 * structures yet. Takes ownership of 'cr'. */
4582 replace_rule_create(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4583 struct cls_rule
*cr
, uint8_t table_id
,
4584 struct rule
*old_rule
, struct rule
**new_rule
)
4589 /* Allocate new rule. */
4590 rule
= ofproto
->ofproto_class
->rule_alloc();
4592 cls_rule_destroy(cr
);
4593 VLOG_WARN_RL(&rl
, "%s: failed to allocate a rule.", ofproto
->name
);
4594 return OFPERR_OFPFMFC_UNKNOWN
;
4597 /* Initialize base state. */
4598 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4599 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), cr
);
4600 ovs_refcount_init(&rule
->ref_count
);
4601 rule
->flow_cookie
= fm
->new_cookie
;
4602 rule
->created
= rule
->modified
= time_msec();
4604 ovs_mutex_init(&rule
->mutex
);
4605 ovs_mutex_lock(&rule
->mutex
);
4606 rule
->idle_timeout
= fm
->idle_timeout
;
4607 rule
->hard_timeout
= fm
->hard_timeout
;
4608 rule
->importance
= fm
->importance
;
4610 *CONST_CAST(uint8_t *, &rule
->table_id
) = table_id
;
4611 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4612 *CONST_CAST(const struct rule_actions
**, &rule
->actions
)
4613 = rule_actions_create(fm
->ofpacts
, fm
->ofpacts_len
);
4614 list_init(&rule
->meter_list_node
);
4615 rule
->eviction_group
= NULL
;
4616 list_init(&rule
->expirable
);
4617 rule
->monitor_flags
= 0;
4618 rule
->add_seqno
= 0;
4619 rule
->modify_seqno
= 0;
4621 /* Copy values from old rule for modify semantics. */
4622 if (old_rule
&& fm
->delete_reason
!= OFPRR_EVICTION
) {
4623 /* 'fm' says that */
4624 bool change_cookie
= (fm
->modify_cookie
4625 && fm
->new_cookie
!= OVS_BE64_MAX
4626 && fm
->new_cookie
!= old_rule
->flow_cookie
);
4628 ovs_mutex_lock(&old_rule
->mutex
);
4629 if (fm
->command
!= OFPFC_ADD
) {
4630 rule
->idle_timeout
= old_rule
->idle_timeout
;
4631 rule
->hard_timeout
= old_rule
->hard_timeout
;
4632 rule
->importance
= old_rule
->importance
;
4633 rule
->flags
= old_rule
->flags
;
4634 rule
->created
= old_rule
->created
;
4636 if (!change_cookie
) {
4637 rule
->flow_cookie
= old_rule
->flow_cookie
;
4639 ovs_mutex_unlock(&old_rule
->mutex
);
4641 ovs_mutex_unlock(&rule
->mutex
);
4643 /* Construct rule, initializing derived state. */
4644 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4646 ofproto_rule_destroy__(rule
);
4650 rule
->removed
= true; /* Not yet in ofproto data structures. */
4657 replace_rule_start(struct ofproto
*ofproto
,
4658 struct rule
*old_rule
, struct rule
*new_rule
,
4659 struct cls_conjunction
*conjs
, size_t n_conjs
)
4661 struct oftable
*table
= &ofproto
->tables
[new_rule
->table_id
];
4663 /* 'old_rule' may be either an evicted rule or replaced rule. */
4665 /* Mark the old rule for removal in the next version. */
4666 cls_rule_make_invisible_in_version(&old_rule
->cr
,
4667 ofproto
->tables_version
+ 1,
4668 ofproto
->tables_version
);
4672 /* Insert flow to the classifier, so that later flow_mods may relate
4673 * to it. This is reversible, in case later errors require this to
4675 ofproto_rule_insert__(ofproto
, new_rule
);
4676 /* Make the new rule visible for classifier lookups only from the next
4678 classifier_insert(&table
->cls
, &new_rule
->cr
, conjs
, n_conjs
);
4681 static void replace_rule_revert(struct ofproto
*ofproto
,
4682 struct rule
*old_rule
, struct rule
*new_rule
)
4684 struct oftable
*table
= &ofproto
->tables
[new_rule
->table_id
];
4687 /* Restore the original visibility of the old rule. */
4688 cls_rule_restore_visibility(&old_rule
->cr
);
4690 /* Restore table's rule count. */
4694 /* Remove the new rule immediately. It was never visible to lookups. */
4695 if (!classifier_remove(&table
->cls
, &new_rule
->cr
)) {
4698 ofproto_rule_remove__(ofproto
, new_rule
);
4699 /* The rule was not inserted to the ofproto provider, so we can
4700 * release it without deleting it from the ofproto provider. */
4701 ofproto_rule_unref(new_rule
);
4704 /* Adds the 'new_rule', replacing the 'old_rule'. */
4706 replace_rule_finish(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4707 const struct flow_mod_requester
*req
,
4708 struct rule
*old_rule
, struct rule
*new_rule
,
4709 struct ovs_list
*dead_cookies
)
4710 OVS_REQUIRES(ofproto_mutex
)
4712 bool forward_stats
= !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
);
4713 struct rule
*replaced_rule
;
4715 replaced_rule
= fm
->delete_reason
!= OFPRR_EVICTION
? old_rule
: NULL
;
4717 /* Insert the new flow to the ofproto provider. A non-NULL 'replaced_rule'
4718 * is a duplicate rule the 'new_rule' is replacing. The provider should
4719 * link the stats from the old rule to the new one if 'forward_stats' is
4720 * 'true'. The 'replaced_rule' will be deleted right after this call. */
4721 ofproto
->ofproto_class
->rule_insert(new_rule
, replaced_rule
,
4723 learned_cookies_inc(ofproto
, rule_get_actions(new_rule
));
4726 const struct rule_actions
*old_actions
= rule_get_actions(old_rule
);
4728 /* Remove the old rule from data structures. Removal from the
4729 * classifier and the deletion of the rule is RCU postponed by the
4731 ofproto_rule_remove__(ofproto
, old_rule
);
4732 learned_cookies_dec(ofproto
, old_actions
, dead_cookies
);
4734 if (replaced_rule
) {
4735 enum nx_flow_update_event event
= fm
->command
== OFPFC_ADD
4736 ? NXFME_ADDED
: NXFME_MODIFIED
;
4738 bool change_cookie
= (fm
->modify_cookie
4739 && fm
->new_cookie
!= OVS_BE64_MAX
4740 && fm
->new_cookie
!= old_rule
->flow_cookie
);
4742 bool change_actions
= !ofpacts_equal(fm
->ofpacts
,
4744 old_actions
->ofpacts
,
4745 old_actions
->ofpacts_len
);
4747 if (event
!= NXFME_MODIFIED
|| change_actions
|| change_cookie
) {
4748 ofmonitor_report(ofproto
->connmgr
, new_rule
, event
, 0,
4749 req
? req
->ofconn
: NULL
,
4750 req
? req
->request
->xid
: 0,
4751 change_actions
? old_actions
: NULL
);
4754 /* XXX: This is slight duplication with delete_flows_finish__() */
4756 /* XXX: This call should done when rule's refcount reaches
4757 * zero to get accurate stats in the flow removed message. */
4758 ofproto_rule_send_removed(old_rule
, OFPRR_EVICTION
);
4760 ofmonitor_report(ofproto
->connmgr
, old_rule
, NXFME_DELETED
,
4762 req
? req
->ofconn
: NULL
,
4763 req
? req
->request
->xid
: 0, NULL
);
4769 modify_flows_start__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4770 struct rule_collection
*old_rules
,
4771 struct rule_collection
*new_rules
)
4772 OVS_REQUIRES(ofproto_mutex
)
4776 rule_collection_init(new_rules
);
4778 if (old_rules
->n
> 0) {
4779 struct cls_conjunction
*conjs
;
4783 /* Create a new 'modified' rule for each old rule. */
4784 for (i
= 0; i
< old_rules
->n
; i
++) {
4785 struct rule
*old_rule
= old_rules
->rules
[i
];
4786 struct rule
*new_rule
;
4789 cls_rule_clone_in_version(&cr
, &old_rule
->cr
,
4790 ofproto
->tables_version
+ 1);
4791 error
= replace_rule_create(ofproto
, fm
, &cr
, old_rule
->table_id
,
4792 old_rule
, &new_rule
);
4794 rule_collection_add(new_rules
, new_rule
);
4796 rule_collection_unref(new_rules
);
4797 rule_collection_destroy(new_rules
);
4801 ovs_assert(new_rules
->n
== old_rules
->n
);
4803 get_conjunctions(fm
, &conjs
, &n_conjs
);
4804 for (i
= 0; i
< old_rules
->n
; i
++) {
4805 replace_rule_start(ofproto
, old_rules
->rules
[i
],
4806 new_rules
->rules
[i
], conjs
, n_conjs
);
4809 } else if (!(fm
->cookie_mask
!= htonll(0)
4810 || fm
->new_cookie
== OVS_BE64_MAX
)) {
4811 /* No match, add a new flow. */
4812 error
= add_flow_start(ofproto
, fm
, &old_rules
->rules
[0],
4813 &new_rules
->rules
[0]);
4815 ovs_assert(fm
->delete_reason
== OFPRR_EVICTION
4816 || !old_rules
->rules
[0]);
4826 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4829 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4832 modify_flows_start_loose(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4833 struct rule_collection
*old_rules
,
4834 struct rule_collection
*new_rules
)
4835 OVS_REQUIRES(ofproto_mutex
)
4837 struct rule_criteria criteria
;
4840 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0, CLS_MAX_VERSION
,
4841 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4842 rule_criteria_require_rw(&criteria
,
4843 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4844 error
= collect_rules_loose(ofproto
, &criteria
, old_rules
);
4845 rule_criteria_destroy(&criteria
);
4848 error
= modify_flows_start__(ofproto
, fm
, old_rules
, new_rules
);
4852 rule_collection_destroy(old_rules
);
4858 modify_flows_revert(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4859 struct rule_collection
*old_rules
,
4860 struct rule_collection
*new_rules
)
4861 OVS_REQUIRES(ofproto_mutex
)
4863 /* Old rules were not changed yet, only need to revert new rules. */
4864 if (old_rules
->n
== 0 && new_rules
->n
== 1) {
4865 add_flow_revert(ofproto
, fm
, old_rules
->rules
[0], new_rules
->rules
[0]);
4866 } else if (old_rules
->n
> 0) {
4867 for (size_t i
= 0; i
< old_rules
->n
; i
++) {
4868 replace_rule_revert(ofproto
, old_rules
->rules
[i
],
4869 new_rules
->rules
[i
]);
4871 rule_collection_destroy(new_rules
);
4872 rule_collection_destroy(old_rules
);
4877 modify_flows_finish(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4878 const struct flow_mod_requester
*req
,
4879 struct rule_collection
*old_rules
,
4880 struct rule_collection
*new_rules
)
4881 OVS_REQUIRES(ofproto_mutex
)
4883 if (old_rules
->n
== 0 && new_rules
->n
== 1) {
4884 add_flow_finish(ofproto
, fm
, req
, old_rules
->rules
[0],
4885 new_rules
->rules
[0]);
4886 } else if (old_rules
->n
> 0) {
4887 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
4889 ovs_assert(new_rules
->n
== old_rules
->n
);
4891 for (size_t i
= 0; i
< old_rules
->n
; i
++) {
4892 replace_rule_finish(ofproto
, fm
, req
, old_rules
->rules
[i
],
4893 new_rules
->rules
[i
], &dead_cookies
);
4895 learned_cookies_flush(ofproto
, &dead_cookies
);
4896 rule_collection_remove_postponed(old_rules
);
4898 send_buffered_packet(req
, fm
->buffer_id
, new_rules
->rules
[0]);
4899 rule_collection_destroy(new_rules
);
4903 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4904 * code on failure. */
4906 modify_flow_start_strict(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4907 struct rule_collection
*old_rules
,
4908 struct rule_collection
*new_rules
)
4909 OVS_REQUIRES(ofproto_mutex
)
4911 struct rule_criteria criteria
;
4914 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4915 CLS_MAX_VERSION
, fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
,
4917 rule_criteria_require_rw(&criteria
,
4918 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4919 error
= collect_rules_strict(ofproto
, &criteria
, old_rules
);
4920 rule_criteria_destroy(&criteria
);
4923 /* collect_rules_strict() can return max 1 rule. */
4924 error
= modify_flows_start__(ofproto
, fm
, old_rules
, new_rules
);
4928 rule_collection_destroy(old_rules
);
4933 /* OFPFC_DELETE implementation. */
4936 delete_flows_start__(struct ofproto
*ofproto
,
4937 const struct rule_collection
*rules
)
4938 OVS_REQUIRES(ofproto_mutex
)
4940 for (size_t i
= 0; i
< rules
->n
; i
++) {
4941 struct rule
*rule
= rules
->rules
[i
];
4942 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
4945 cls_rule_make_invisible_in_version(&rule
->cr
,
4946 ofproto
->tables_version
+ 1,
4947 ofproto
->tables_version
);
4952 delete_flows_finish__(struct ofproto
*ofproto
,
4953 struct rule_collection
*rules
,
4954 enum ofp_flow_removed_reason reason
,
4955 const struct flow_mod_requester
*req
)
4956 OVS_REQUIRES(ofproto_mutex
)
4959 struct ovs_list dead_cookies
= OVS_LIST_INITIALIZER(&dead_cookies
);
4961 for (size_t i
= 0; i
< rules
->n
; i
++) {
4962 struct rule
*rule
= rules
->rules
[i
];
4964 ofproto_rule_send_removed(rule
, reason
);
4965 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_DELETED
, reason
,
4966 req
? req
->ofconn
: NULL
,
4967 req
? req
->request
->xid
: 0, NULL
);
4968 ofproto_rule_remove__(ofproto
, rule
);
4969 learned_cookies_dec(ofproto
, rule_get_actions(rule
),
4972 rule_collection_remove_postponed(rules
);
4974 learned_cookies_flush(ofproto
, &dead_cookies
);
4978 /* Deletes the rules listed in 'rules'.
4979 * The deleted rules will become invisible to the lookups in the next version.
4980 * Destroys 'rules'. */
4982 delete_flows__(struct rule_collection
*rules
,
4983 enum ofp_flow_removed_reason reason
,
4984 const struct flow_mod_requester
*req
)
4985 OVS_REQUIRES(ofproto_mutex
)
4988 struct ofproto
*ofproto
= rules
->rules
[0]->ofproto
;
4990 delete_flows_start__(ofproto
, rules
);
4991 ofproto_bump_tables_version(ofproto
);
4992 delete_flows_finish__(ofproto
, rules
, reason
, req
);
4993 ofmonitor_flush(ofproto
->connmgr
);
4997 /* Implements OFPFC_DELETE. */
4999 delete_flows_start_loose(struct ofproto
*ofproto
,
5000 const struct ofputil_flow_mod
*fm
,
5001 struct rule_collection
*rules
)
5002 OVS_REQUIRES(ofproto_mutex
)
5004 struct rule_criteria criteria
;
5007 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0, CLS_MAX_VERSION
,
5008 fm
->cookie
, fm
->cookie_mask
, fm
->out_port
,
5010 rule_criteria_require_rw(&criteria
,
5011 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5012 error
= collect_rules_loose(ofproto
, &criteria
, rules
);
5013 rule_criteria_destroy(&criteria
);
5016 delete_flows_start__(ofproto
, rules
);
5023 delete_flows_revert(struct ofproto
*ofproto
,
5024 struct rule_collection
*rules
)
5025 OVS_REQUIRES(ofproto_mutex
)
5027 for (size_t i
= 0; i
< rules
->n
; i
++) {
5028 struct rule
*rule
= rules
->rules
[i
];
5029 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
5031 /* Restore table's rule count. */
5034 /* Restore the original visibility of the rule. */
5035 cls_rule_restore_visibility(&rule
->cr
);
5037 rule_collection_destroy(rules
);
5041 delete_flows_finish(struct ofproto
*ofproto
,
5042 const struct ofputil_flow_mod
*fm
,
5043 const struct flow_mod_requester
*req
,
5044 struct rule_collection
*rules
)
5045 OVS_REQUIRES(ofproto_mutex
)
5047 delete_flows_finish__(ofproto
, rules
, fm
->delete_reason
, req
);
5050 /* Implements OFPFC_DELETE_STRICT. */
5052 delete_flow_start_strict(struct ofproto
*ofproto
,
5053 const struct ofputil_flow_mod
*fm
,
5054 struct rule_collection
*rules
)
5055 OVS_REQUIRES(ofproto_mutex
)
5057 struct rule_criteria criteria
;
5060 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
5061 CLS_MAX_VERSION
, fm
->cookie
, fm
->cookie_mask
,
5062 fm
->out_port
, fm
->out_group
);
5063 rule_criteria_require_rw(&criteria
,
5064 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
5065 error
= collect_rules_strict(ofproto
, &criteria
, rules
);
5066 rule_criteria_destroy(&criteria
);
5069 delete_flows_start__(ofproto
, rules
);
5075 /* XXX: This should be sent right when the rule refcount gets to zero! */
5077 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
5078 OVS_REQUIRES(ofproto_mutex
)
5080 struct ofputil_flow_removed fr
;
5083 if (rule_is_hidden(rule
) ||
5084 !(rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
)) {
5088 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
5089 fr
.priority
= rule
->cr
.priority
;
5090 fr
.cookie
= rule
->flow_cookie
;
5092 fr
.table_id
= rule
->table_id
;
5093 calc_duration(rule
->created
, time_msec(),
5094 &fr
.duration_sec
, &fr
.duration_nsec
);
5095 ovs_mutex_lock(&rule
->mutex
);
5096 fr
.idle_timeout
= rule
->idle_timeout
;
5097 fr
.hard_timeout
= rule
->hard_timeout
;
5098 ovs_mutex_unlock(&rule
->mutex
);
5099 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
5100 &fr
.byte_count
, &used
);
5102 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
5105 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
5106 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
5109 * ofproto implementation ->run() functions should use this function to expire
5110 * OpenFlow flows. */
5112 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
5113 OVS_REQUIRES(ofproto_mutex
)
5115 struct rule_collection rules
;
5117 rules
.rules
= rules
.stub
;
5119 rules
.stub
[0] = rule
;
5120 delete_flows__(&rules
, reason
, NULL
);
5123 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
5124 * means "infinite". */
5126 reduce_timeout(uint16_t max
, uint16_t *timeout
)
5128 if (max
&& (!*timeout
|| *timeout
> max
)) {
5133 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
5134 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
5135 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
5137 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
5139 ofproto_rule_reduce_timeouts(struct rule
*rule
,
5140 uint16_t idle_timeout
, uint16_t hard_timeout
)
5141 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
5143 if (!idle_timeout
&& !hard_timeout
) {
5147 ovs_mutex_lock(&ofproto_mutex
);
5148 if (list_is_empty(&rule
->expirable
)) {
5149 list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
5151 ovs_mutex_unlock(&ofproto_mutex
);
5153 ovs_mutex_lock(&rule
->mutex
);
5154 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
5155 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
5156 ovs_mutex_unlock(&rule
->mutex
);
5160 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5161 OVS_EXCLUDED(ofproto_mutex
)
5163 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5164 struct ofputil_flow_mod fm
;
5165 uint64_t ofpacts_stub
[1024 / 8];
5166 struct ofpbuf ofpacts
;
5169 error
= reject_slave_controller(ofconn
);
5174 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
5175 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
5177 u16_to_ofp(ofproto
->max_ports
),
5180 error
= ofproto_check_ofpacts(ofproto
, fm
.ofpacts
, fm
.ofpacts_len
);
5183 struct flow_mod_requester req
;
5185 req
.ofconn
= ofconn
;
5187 error
= handle_flow_mod__(ofproto
, &fm
, &req
);
5190 goto exit_free_ofpacts
;
5193 ofconn_report_flow_mod(ofconn
, fm
.command
);
5196 ofpbuf_uninit(&ofpacts
);
5202 handle_flow_mod__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
5203 const struct flow_mod_requester
*req
)
5204 OVS_EXCLUDED(ofproto_mutex
)
5206 struct ofp_bundle_entry be
;
5209 ovs_mutex_lock(&ofproto_mutex
);
5210 error
= do_bundle_flow_mod_start(ofproto
, fm
, &be
);
5212 ofproto_bump_tables_version(ofproto
);
5213 do_bundle_flow_mod_finish(ofproto
, fm
, req
, &be
);
5215 ofmonitor_flush(ofproto
->connmgr
);
5216 ovs_mutex_unlock(&ofproto_mutex
);
5218 run_rule_executes(ofproto
);
5223 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5225 struct ofputil_role_request request
;
5226 struct ofputil_role_request reply
;
5230 error
= ofputil_decode_role_message(oh
, &request
);
5235 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
5236 if (request
.have_generation_id
5237 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
5238 return OFPERR_OFPRRFC_STALE
;
5241 ofconn_set_role(ofconn
, request
.role
);
5244 reply
.role
= ofconn_get_role(ofconn
);
5245 reply
.have_generation_id
= ofconn_get_master_election_id(
5246 ofconn
, &reply
.generation_id
);
5247 buf
= ofputil_encode_role_reply(oh
, &reply
);
5248 ofconn_send_reply(ofconn
, buf
);
5254 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
5255 const struct ofp_header
*oh
)
5257 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
5258 enum ofputil_protocol cur
, next
;
5260 cur
= ofconn_get_protocol(ofconn
);
5261 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
5262 ofconn_set_protocol(ofconn
, next
);
5268 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5270 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
5271 enum ofputil_protocol cur
, next
;
5272 enum ofputil_protocol next_base
;
5274 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
5276 return OFPERR_OFPBRC_EPERM
;
5279 cur
= ofconn_get_protocol(ofconn
);
5280 next
= ofputil_protocol_set_base(cur
, next_base
);
5281 ofconn_set_protocol(ofconn
, next
);
5287 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
5288 const struct ofp_header
*oh
)
5290 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
5293 format
= ntohl(msg
->format
);
5294 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
5295 return OFPERR_OFPBRC_EPERM
;
5298 ofconn_set_packet_in_format(ofconn
, format
);
5303 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5305 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
5306 uint32_t master
[OAM_N_TYPES
];
5307 uint32_t slave
[OAM_N_TYPES
];
5309 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
5310 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
5311 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
5313 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
5314 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
5315 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
5317 ofconn_set_async_config(ofconn
, master
, slave
);
5318 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
5319 !ofconn_get_miss_send_len(ofconn
)) {
5320 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
5327 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5330 uint32_t master
[OAM_N_TYPES
];
5331 uint32_t slave
[OAM_N_TYPES
];
5332 struct nx_async_config
*msg
;
5334 ofconn_get_async_config(ofconn
, master
, slave
);
5335 buf
= ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY
, oh
, 0);
5336 msg
= ofpbuf_put_zeros(buf
, sizeof *msg
);
5338 msg
->packet_in_mask
[0] = htonl(master
[OAM_PACKET_IN
]);
5339 msg
->port_status_mask
[0] = htonl(master
[OAM_PORT_STATUS
]);
5340 msg
->flow_removed_mask
[0] = htonl(master
[OAM_FLOW_REMOVED
]);
5342 msg
->packet_in_mask
[1] = htonl(slave
[OAM_PACKET_IN
]);
5343 msg
->port_status_mask
[1] = htonl(slave
[OAM_PORT_STATUS
]);
5344 msg
->flow_removed_mask
[1] = htonl(slave
[OAM_FLOW_REMOVED
]);
5346 ofconn_send_reply(ofconn
, buf
);
5352 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
5353 const struct ofp_header
*oh
)
5355 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
5357 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
5358 return OFPERR_NXBRC_MUST_BE_ZERO
;
5361 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
5366 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5370 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
5371 ? OFPRAW_OFPT10_BARRIER_REPLY
5372 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
5373 ofconn_send_reply(ofconn
, buf
);
5378 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
5379 enum nx_flow_monitor_flags flags
,
5380 struct ovs_list
*msgs
)
5381 OVS_REQUIRES(ofproto_mutex
)
5383 const struct rule_actions
*actions
;
5384 struct ofputil_flow_update fu
;
5387 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
5388 ? NXFME_ADDED
: NXFME_MODIFIED
);
5390 ovs_mutex_lock(&rule
->mutex
);
5391 fu
.idle_timeout
= rule
->idle_timeout
;
5392 fu
.hard_timeout
= rule
->hard_timeout
;
5393 ovs_mutex_unlock(&rule
->mutex
);
5394 fu
.table_id
= rule
->table_id
;
5395 fu
.cookie
= rule
->flow_cookie
;
5396 minimatch_expand(&rule
->cr
.match
, &match
);
5398 fu
.priority
= rule
->cr
.priority
;
5400 actions
= flags
& NXFMF_ACTIONS
? rule_get_actions(rule
) : NULL
;
5401 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
5402 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
5404 if (list_is_empty(msgs
)) {
5405 ofputil_start_flow_update(msgs
);
5407 ofputil_append_flow_update(&fu
, msgs
);
5411 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
5412 struct ovs_list
*msgs
)
5413 OVS_REQUIRES(ofproto_mutex
)
5417 for (i
= 0; i
< rules
->n
; i
++) {
5418 struct rule
*rule
= rules
->rules
[i
];
5419 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
5420 rule
->monitor_flags
= 0;
5422 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
5427 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
5428 struct rule
*rule
, uint64_t seqno
,
5429 struct rule_collection
*rules
)
5430 OVS_REQUIRES(ofproto_mutex
)
5432 enum nx_flow_monitor_flags update
;
5434 if (rule_is_hidden(rule
)) {
5438 if (!ofproto_rule_has_out_port(rule
, m
->out_port
)) {
5443 if (rule
->add_seqno
> seqno
) {
5444 update
= NXFMF_ADD
| NXFMF_MODIFY
;
5445 } else if (rule
->modify_seqno
> seqno
) {
5446 update
= NXFMF_MODIFY
;
5451 if (!(m
->flags
& update
)) {
5455 update
= NXFMF_INITIAL
;
5458 if (!rule
->monitor_flags
) {
5459 rule_collection_add(rules
, rule
);
5461 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
5465 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
5467 struct rule_collection
*rules
)
5468 OVS_REQUIRES(ofproto_mutex
)
5470 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
5471 const struct oftable
*table
;
5472 struct cls_rule target
;
5474 cls_rule_init_from_minimatch(&target
, &m
->match
, 0, CLS_MAX_VERSION
);
5475 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
5478 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &target
) {
5479 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
5482 cls_rule_destroy(&target
);
5486 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
5487 struct rule_collection
*rules
)
5488 OVS_REQUIRES(ofproto_mutex
)
5490 if (m
->flags
& NXFMF_INITIAL
) {
5491 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
5496 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
5497 uint64_t seqno
, struct rule_collection
*rules
)
5498 OVS_REQUIRES(ofproto_mutex
)
5500 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
5504 flow_monitor_delete(struct ofconn
*ofconn
, uint32_t id
)
5505 OVS_REQUIRES(ofproto_mutex
)
5507 struct ofmonitor
*m
;
5510 m
= ofmonitor_lookup(ofconn
, id
);
5512 ofmonitor_destroy(m
);
5515 error
= OFPERR_OFPMOFC_UNKNOWN_MONITOR
;
5522 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5523 OVS_EXCLUDED(ofproto_mutex
)
5525 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5526 struct ofmonitor
**monitors
;
5527 size_t n_monitors
, allocated_monitors
;
5528 struct rule_collection rules
;
5529 struct ovs_list replies
;
5534 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
5536 n_monitors
= allocated_monitors
= 0;
5538 ovs_mutex_lock(&ofproto_mutex
);
5540 struct ofputil_flow_monitor_request request
;
5541 struct ofmonitor
*m
;
5544 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
5545 if (retval
== EOF
) {
5547 } else if (retval
) {
5552 if (request
.table_id
!= 0xff
5553 && request
.table_id
>= ofproto
->n_tables
) {
5554 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
5558 error
= ofmonitor_create(&request
, ofconn
, &m
);
5563 if (n_monitors
>= allocated_monitors
) {
5564 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
5567 monitors
[n_monitors
++] = m
;
5570 rule_collection_init(&rules
);
5571 for (i
= 0; i
< n_monitors
; i
++) {
5572 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
5575 ofpmp_init(&replies
, oh
);
5576 ofmonitor_compose_refresh_updates(&rules
, &replies
);
5577 ovs_mutex_unlock(&ofproto_mutex
);
5579 rule_collection_destroy(&rules
);
5581 ofconn_send_replies(ofconn
, &replies
);
5587 for (i
= 0; i
< n_monitors
; i
++) {
5588 ofmonitor_destroy(monitors
[i
]);
5591 ovs_mutex_unlock(&ofproto_mutex
);
5597 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5598 OVS_EXCLUDED(ofproto_mutex
)
5603 id
= ofputil_decode_flow_monitor_cancel(oh
);
5605 ovs_mutex_lock(&ofproto_mutex
);
5606 error
= flow_monitor_delete(ofconn
, id
);
5607 ovs_mutex_unlock(&ofproto_mutex
);
5612 /* Meters implementation.
5614 * Meter table entry, indexed by the OpenFlow meter_id.
5615 * 'created' is used to compute the duration for meter stats.
5616 * 'list rules' is needed so that we can delete the dependent rules when the
5617 * meter table entry is deleted.
5618 * 'provider_meter_id' is for the provider's private use.
5621 long long int created
; /* Time created. */
5622 struct ovs_list rules
; /* List of "struct rule_dpif"s. */
5623 ofproto_meter_id provider_meter_id
;
5624 uint16_t flags
; /* Meter flags. */
5625 uint16_t n_bands
; /* Number of meter bands. */
5626 struct ofputil_meter_band
*bands
;
5630 * This is used in instruction validation at flow set-up time,
5631 * as flows may not use non-existing meters.
5632 * Return value of UINT32_MAX signifies an invalid meter.
5635 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
5637 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
5638 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
5640 return meter
->provider_meter_id
.uint32
;
5646 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5649 meter_insert_rule(struct rule
*rule
)
5651 const struct rule_actions
*a
= rule_get_actions(rule
);
5652 uint32_t meter_id
= ofpacts_get_meter(a
->ofpacts
, a
->ofpacts_len
);
5653 struct meter
*meter
= rule
->ofproto
->meters
[meter_id
];
5655 list_insert(&meter
->rules
, &rule
->meter_list_node
);
5659 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
5663 meter
->flags
= config
->flags
;
5664 meter
->n_bands
= config
->n_bands
;
5665 meter
->bands
= xmemdup(config
->bands
,
5666 config
->n_bands
* sizeof *meter
->bands
);
5669 static struct meter
*
5670 meter_create(const struct ofputil_meter_config
*config
,
5671 ofproto_meter_id provider_meter_id
)
5673 struct meter
*meter
;
5675 meter
= xzalloc(sizeof *meter
);
5676 meter
->provider_meter_id
= provider_meter_id
;
5677 meter
->created
= time_msec();
5678 list_init(&meter
->rules
);
5680 meter_update(meter
, config
);
5686 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5687 OVS_REQUIRES(ofproto_mutex
)
5690 for (mid
= first
; mid
<= last
; ++mid
) {
5691 struct meter
*meter
= ofproto
->meters
[mid
];
5693 ofproto
->meters
[mid
] = NULL
;
5694 ofproto
->ofproto_class
->meter_del(ofproto
,
5695 meter
->provider_meter_id
);
5703 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5705 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5706 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5710 return OFPERR_OFPMMFC_METER_EXISTS
;
5713 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5716 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5717 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5723 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5725 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5727 uint32_t provider_meter_id
;
5730 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5733 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5734 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5735 &meter
->provider_meter_id
,
5737 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5739 meter_update(meter
, &mm
->meter
);
5745 handle_delete_meter(struct ofconn
*ofconn
, struct ofputil_meter_mod
*mm
)
5746 OVS_EXCLUDED(ofproto_mutex
)
5748 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5749 uint32_t meter_id
= mm
->meter
.meter_id
;
5750 struct rule_collection rules
;
5751 enum ofperr error
= 0;
5752 uint32_t first
, last
;
5754 if (meter_id
== OFPM13_ALL
) {
5756 last
= ofproto
->meter_features
.max_meters
;
5758 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
5761 first
= last
= meter_id
;
5764 /* First delete the rules that use this meter. If any of those rules are
5765 * currently being modified, postpone the whole operation until later. */
5766 rule_collection_init(&rules
);
5767 ovs_mutex_lock(&ofproto_mutex
);
5768 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5769 struct meter
*meter
= ofproto
->meters
[meter_id
];
5770 if (meter
&& !list_is_empty(&meter
->rules
)) {
5773 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
5774 rule_collection_add(&rules
, rule
);
5778 delete_flows__(&rules
, OFPRR_METER_DELETE
, NULL
);
5780 /* Delete the meters. */
5781 meter_delete(ofproto
, first
, last
);
5783 ovs_mutex_unlock(&ofproto_mutex
);
5789 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5791 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5792 struct ofputil_meter_mod mm
;
5793 uint64_t bands_stub
[256 / 8];
5794 struct ofpbuf bands
;
5798 error
= reject_slave_controller(ofconn
);
5803 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5805 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
5807 goto exit_free_bands
;
5810 meter_id
= mm
.meter
.meter_id
;
5812 if (mm
.command
!= OFPMC13_DELETE
) {
5813 /* Fails also when meters are not implemented by the provider. */
5814 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
5815 error
= OFPERR_OFPMMFC_INVALID_METER
;
5816 goto exit_free_bands
;
5817 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
5818 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
5819 goto exit_free_bands
;
5821 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
5822 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
5823 goto exit_free_bands
;
5827 switch (mm
.command
) {
5829 error
= handle_add_meter(ofproto
, &mm
);
5832 case OFPMC13_MODIFY
:
5833 error
= handle_modify_meter(ofproto
, &mm
);
5836 case OFPMC13_DELETE
:
5837 error
= handle_delete_meter(ofconn
, &mm
);
5841 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
5846 ofpbuf_uninit(&bands
);
5851 handle_meter_features_request(struct ofconn
*ofconn
,
5852 const struct ofp_header
*request
)
5854 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5855 struct ofputil_meter_features features
;
5858 if (ofproto
->ofproto_class
->meter_get_features
) {
5859 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
5861 memset(&features
, 0, sizeof features
);
5863 b
= ofputil_encode_meter_features_reply(&features
, request
);
5865 ofconn_send_reply(ofconn
, b
);
5870 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
5873 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5874 struct ovs_list replies
;
5875 uint64_t bands_stub
[256 / 8];
5876 struct ofpbuf bands
;
5877 uint32_t meter_id
, first
, last
;
5879 ofputil_decode_meter_request(request
, &meter_id
);
5881 if (meter_id
== OFPM13_ALL
) {
5883 last
= ofproto
->meter_features
.max_meters
;
5885 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
5886 !ofproto
->meters
[meter_id
]) {
5887 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5889 first
= last
= meter_id
;
5892 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5893 ofpmp_init(&replies
, request
);
5895 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5896 struct meter
*meter
= ofproto
->meters
[meter_id
];
5898 continue; /* Skip non-existing meters. */
5900 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
5901 struct ofputil_meter_stats stats
;
5903 stats
.meter_id
= meter_id
;
5905 /* Provider sets the packet and byte counts, we do the rest. */
5906 stats
.flow_count
= list_size(&meter
->rules
);
5907 calc_duration(meter
->created
, time_msec(),
5908 &stats
.duration_sec
, &stats
.duration_nsec
);
5909 stats
.n_bands
= meter
->n_bands
;
5910 ofpbuf_clear(&bands
);
5912 = ofpbuf_put_uninit(&bands
,
5913 meter
->n_bands
* sizeof *stats
.bands
);
5915 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
5916 meter
->provider_meter_id
,
5918 ofputil_append_meter_stats(&replies
, &stats
);
5920 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5921 struct ofputil_meter_config config
;
5923 config
.meter_id
= meter_id
;
5924 config
.flags
= meter
->flags
;
5925 config
.n_bands
= meter
->n_bands
;
5926 config
.bands
= meter
->bands
;
5927 ofputil_append_meter_config(&replies
, &config
);
5931 ofconn_send_replies(ofconn
, &replies
);
5932 ofpbuf_uninit(&bands
);
5937 ofproto_group_lookup__(const struct ofproto
*ofproto
, uint32_t group_id
,
5938 struct ofgroup
**group
)
5939 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5941 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5942 hash_int(group_id
, 0), &ofproto
->groups
) {
5943 if ((*group
)->group_id
== group_id
) {
5951 /* If the group exists, this function increments the groups's reference count.
5953 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5954 * a reference to the group. */
5956 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5957 struct ofgroup
**group
)
5961 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5962 found
= ofproto_group_lookup__(ofproto
, group_id
, group
);
5964 ofproto_group_ref(*group
);
5966 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5971 ofproto_group_exists__(const struct ofproto
*ofproto
, uint32_t group_id
)
5972 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5974 struct ofgroup
*grp
;
5976 HMAP_FOR_EACH_IN_BUCKET (grp
, hmap_node
,
5977 hash_int(group_id
, 0), &ofproto
->groups
) {
5978 if (grp
->group_id
== group_id
) {
5986 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
5987 OVS_EXCLUDED(ofproto
->groups_rwlock
)
5991 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5992 exists
= ofproto_group_exists__(ofproto
, group_id
);
5993 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5999 group_get_ref_count(struct ofgroup
*group
)
6000 OVS_EXCLUDED(ofproto_mutex
)
6002 struct ofproto
*ofproto
= CONST_CAST(struct ofproto
*, group
->ofproto
);
6003 struct rule_criteria criteria
;
6004 struct rule_collection rules
;
6009 match_init_catchall(&match
);
6010 rule_criteria_init(&criteria
, 0xff, &match
, 0, CLS_MAX_VERSION
, htonll(0),
6011 htonll(0), OFPP_ANY
, group
->group_id
);
6012 ovs_mutex_lock(&ofproto_mutex
);
6013 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
6014 ovs_mutex_unlock(&ofproto_mutex
);
6015 rule_criteria_destroy(&criteria
);
6017 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
6019 rule_collection_destroy(&rules
);
6024 append_group_stats(struct ofgroup
*group
, struct ovs_list
*replies
)
6026 struct ofputil_group_stats ogs
;
6027 const struct ofproto
*ofproto
= group
->ofproto
;
6028 long long int now
= time_msec();
6031 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
6033 /* Provider sets the packet and byte counts, we do the rest. */
6034 ogs
.ref_count
= group_get_ref_count(group
);
6035 ogs
.n_buckets
= group
->n_buckets
;
6037 error
= (ofproto
->ofproto_class
->group_get_stats
6038 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
6041 ogs
.packet_count
= UINT64_MAX
;
6042 ogs
.byte_count
= UINT64_MAX
;
6043 memset(ogs
.bucket_stats
, 0xff,
6044 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
6047 ogs
.group_id
= group
->group_id
;
6048 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
6050 ofputil_append_group_stats(replies
, &ogs
);
6052 free(ogs
.bucket_stats
);
6056 handle_group_request(struct ofconn
*ofconn
,
6057 const struct ofp_header
*request
, uint32_t group_id
,
6058 void (*cb
)(struct ofgroup
*, struct ovs_list
*replies
))
6060 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6061 struct ofgroup
*group
;
6062 struct ovs_list replies
;
6064 ofpmp_init(&replies
, request
);
6065 if (group_id
== OFPG_ALL
) {
6066 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
6067 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
6068 cb(group
, &replies
);
6070 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6072 if (ofproto_group_lookup(ofproto
, group_id
, &group
)) {
6073 cb(group
, &replies
);
6074 ofproto_group_unref(group
);
6077 ofconn_send_replies(ofconn
, &replies
);
6081 handle_group_stats_request(struct ofconn
*ofconn
,
6082 const struct ofp_header
*request
)
6087 error
= ofputil_decode_group_stats_request(request
, &group_id
);
6092 handle_group_request(ofconn
, request
, group_id
, append_group_stats
);
6097 append_group_desc(struct ofgroup
*group
, struct ovs_list
*replies
)
6099 struct ofputil_group_desc gds
;
6101 gds
.group_id
= group
->group_id
;
6102 gds
.type
= group
->type
;
6103 gds
.props
= group
->props
;
6105 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, replies
);
6109 handle_group_desc_stats_request(struct ofconn
*ofconn
,
6110 const struct ofp_header
*request
)
6112 handle_group_request(ofconn
, request
,
6113 ofputil_decode_group_desc_request(request
),
6119 handle_group_features_stats_request(struct ofconn
*ofconn
,
6120 const struct ofp_header
*request
)
6122 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
6125 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
6127 ofconn_send_reply(ofconn
, msg
);
6134 handle_queue_get_config_request(struct ofconn
*ofconn
,
6135 const struct ofp_header
*oh
)
6137 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
6138 struct netdev_queue_dump queue_dump
;
6139 struct ofport
*ofport
;
6140 unsigned int queue_id
;
6141 struct ofpbuf
*reply
;
6142 struct smap details
;
6146 error
= ofputil_decode_queue_get_config_request(oh
, &request
);
6151 ofport
= ofproto_get_port(p
, request
);
6153 return OFPERR_OFPQOFC_BAD_PORT
;
6156 reply
= ofputil_encode_queue_get_config_reply(oh
);
6158 smap_init(&details
);
6159 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
, ofport
->netdev
) {
6160 struct ofputil_queue_config queue
;
6162 /* None of the existing queues have compatible properties, so we
6163 * hard-code omitting min_rate and max_rate. */
6164 queue
.queue_id
= queue_id
;
6165 queue
.min_rate
= UINT16_MAX
;
6166 queue
.max_rate
= UINT16_MAX
;
6167 ofputil_append_queue_get_config_reply(reply
, &queue
);
6169 smap_destroy(&details
);
6171 ofconn_send_reply(ofconn
, reply
);
6177 init_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
,
6178 struct ofgroup
**ofgroup
)
6181 const long long int now
= time_msec();
6183 if (gm
->group_id
> OFPG_MAX
) {
6184 return OFPERR_OFPGMFC_INVALID_GROUP
;
6186 if (gm
->type
> OFPGT11_FF
) {
6187 return OFPERR_OFPGMFC_BAD_TYPE
;
6190 *ofgroup
= ofproto
->ofproto_class
->group_alloc();
6192 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
6193 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6196 (*ofgroup
)->ofproto
= ofproto
;
6197 *CONST_CAST(uint32_t *, &((*ofgroup
)->group_id
)) = gm
->group_id
;
6198 *CONST_CAST(enum ofp11_group_type
*, &(*ofgroup
)->type
) = gm
->type
;
6199 *CONST_CAST(long long int *, &((*ofgroup
)->created
)) = now
;
6200 *CONST_CAST(long long int *, &((*ofgroup
)->modified
)) = now
;
6201 ovs_refcount_init(&(*ofgroup
)->ref_count
);
6203 list_move(&(*ofgroup
)->buckets
, &gm
->buckets
);
6204 *CONST_CAST(uint32_t *, &(*ofgroup
)->n_buckets
) =
6205 list_size(&(*ofgroup
)->buckets
);
6207 memcpy(CONST_CAST(struct ofputil_group_props
*, &(*ofgroup
)->props
),
6208 &gm
->props
, sizeof (struct ofputil_group_props
));
6210 /* Construct called BEFORE any locks are held. */
6211 error
= ofproto
->ofproto_class
->group_construct(*ofgroup
);
6213 ofputil_bucket_list_destroy(&(*ofgroup
)->buckets
);
6214 ofproto
->ofproto_class
->group_dealloc(*ofgroup
);
6219 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
6220 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
6223 add_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
6225 struct ofgroup
*ofgroup
;
6228 /* Allocate new group and initialize it. */
6229 error
= init_group(ofproto
, gm
, &ofgroup
);
6234 /* We wrlock as late as possible to minimize the time we jam any other
6235 * threads: No visible state changes before acquiring the lock. */
6236 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6238 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
6239 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6243 if (ofproto_group_exists__(ofproto
, gm
->group_id
)) {
6244 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
6249 /* Insert new group. */
6250 hmap_insert(&ofproto
->groups
, &ofgroup
->hmap_node
,
6251 hash_int(ofgroup
->group_id
, 0));
6252 ofproto
->n_groups
[ofgroup
->type
]++;
6254 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6259 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6260 ofproto
->ofproto_class
->group_destruct(ofgroup
);
6261 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
6262 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
6267 /* Adds all of the buckets from 'ofgroup' to 'new_ofgroup'. The buckets
6268 * already in 'new_ofgroup' will be placed just after the (copy of the) bucket
6269 * in 'ofgroup' with bucket ID 'command_bucket_id'. Special
6270 * 'command_bucket_id' values OFPG15_BUCKET_FIRST and OFPG15_BUCKET_LAST are
6273 copy_buckets_for_insert_bucket(const struct ofgroup
*ofgroup
,
6274 struct ofgroup
*new_ofgroup
,
6275 uint32_t command_bucket_id
)
6277 struct ofputil_bucket
*last
= NULL
;
6279 if (command_bucket_id
<= OFPG15_BUCKET_MAX
) {
6280 /* Check here to ensure that a bucket corresponding to
6281 * command_bucket_id exists in the old bucket list.
6283 * The subsequent search of below of new_ofgroup covers
6284 * both buckets in the old bucket list and buckets added
6285 * by the insert buckets group mod message this function processes. */
6286 if (!ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
)) {
6287 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
6290 if (!list_is_empty(&new_ofgroup
->buckets
)) {
6291 last
= ofputil_bucket_list_back(&new_ofgroup
->buckets
);
6295 ofputil_bucket_clone_list(&new_ofgroup
->buckets
, &ofgroup
->buckets
, NULL
);
6297 if (ofputil_bucket_check_duplicate_id(&ofgroup
->buckets
)) {
6298 VLOG_WARN_RL(&rl
, "Duplicate bucket id");
6299 return OFPERR_OFPGMFC_BUCKET_EXISTS
;
6302 /* Rearrange list according to command_bucket_id */
6303 if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
6304 struct ofputil_bucket
*new_first
;
6305 const struct ofputil_bucket
*first
;
6307 first
= ofputil_bucket_list_front(&ofgroup
->buckets
);
6308 new_first
= ofputil_bucket_find(&new_ofgroup
->buckets
,
6311 list_splice(new_ofgroup
->buckets
.next
, &new_first
->list_node
,
6312 &new_ofgroup
->buckets
);
6313 } else if (command_bucket_id
<= OFPG15_BUCKET_MAX
&& last
) {
6314 struct ofputil_bucket
*after
;
6316 /* Presence of bucket is checked above so after should never be NULL */
6317 after
= ofputil_bucket_find(&new_ofgroup
->buckets
, command_bucket_id
);
6319 list_splice(after
->list_node
.next
, new_ofgroup
->buckets
.next
,
6320 last
->list_node
.next
);
6326 /* Appends all of the a copy of all the buckets from 'ofgroup' to 'new_ofgroup'
6327 * with the exception of the bucket whose bucket id is 'command_bucket_id'.
6328 * Special 'command_bucket_id' values OFPG15_BUCKET_FIRST, OFPG15_BUCKET_LAST
6329 * and OFPG15_BUCKET_ALL are also honored. */
6331 copy_buckets_for_remove_bucket(const struct ofgroup
*ofgroup
,
6332 struct ofgroup
*new_ofgroup
,
6333 uint32_t command_bucket_id
)
6335 const struct ofputil_bucket
*skip
= NULL
;
6337 if (command_bucket_id
== OFPG15_BUCKET_ALL
) {
6341 if (command_bucket_id
== OFPG15_BUCKET_FIRST
) {
6342 if (!list_is_empty(&ofgroup
->buckets
)) {
6343 skip
= ofputil_bucket_list_front(&ofgroup
->buckets
);
6345 } else if (command_bucket_id
== OFPG15_BUCKET_LAST
) {
6346 if (!list_is_empty(&ofgroup
->buckets
)) {
6347 skip
= ofputil_bucket_list_back(&ofgroup
->buckets
);
6350 skip
= ofputil_bucket_find(&ofgroup
->buckets
, command_bucket_id
);
6352 return OFPERR_OFPGMFC_UNKNOWN_BUCKET
;
6356 ofputil_bucket_clone_list(&new_ofgroup
->buckets
, &ofgroup
->buckets
, skip
);
6361 /* Implements OFPGC11_MODIFY, OFPGC15_INSERT_BUCKET and
6362 * OFPGC15_REMOVE_BUCKET. Returns 0 on success or an OpenFlow error code
6365 * Note that the group is re-created and then replaces the old group in
6366 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
6367 * the xlate module hold a pointer to the group. */
6369 modify_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
6371 struct ofgroup
*ofgroup
, *new_ofgroup
, *retiring
;
6374 error
= init_group(ofproto
, gm
, &new_ofgroup
);
6379 retiring
= new_ofgroup
;
6381 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6382 if (!ofproto_group_lookup__(ofproto
, gm
->group_id
, &ofgroup
)) {
6383 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
6387 /* Ofproto's group write lock is held now. */
6388 if (ofgroup
->type
!= gm
->type
6389 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
6390 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
6394 /* Manipulate bucket list for bucket commands */
6395 if (gm
->command
== OFPGC15_INSERT_BUCKET
) {
6396 error
= copy_buckets_for_insert_bucket(ofgroup
, new_ofgroup
,
6397 gm
->command_bucket_id
);
6398 } else if (gm
->command
== OFPGC15_REMOVE_BUCKET
) {
6399 error
= copy_buckets_for_remove_bucket(ofgroup
, new_ofgroup
,
6400 gm
->command_bucket_id
);
6406 /* The group creation time does not change during modification. */
6407 *CONST_CAST(long long int *, &(new_ofgroup
->created
)) = ofgroup
->created
;
6408 *CONST_CAST(long long int *, &(new_ofgroup
->modified
)) = time_msec();
6410 error
= ofproto
->ofproto_class
->group_modify(new_ofgroup
);
6416 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
6417 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
6418 hmap_insert(&ofproto
->groups
, &new_ofgroup
->hmap_node
,
6419 hash_int(new_ofgroup
->group_id
, 0));
6420 if (ofgroup
->type
!= new_ofgroup
->type
) {
6421 ofproto
->n_groups
[ofgroup
->type
]--;
6422 ofproto
->n_groups
[new_ofgroup
->type
]++;
6426 ofproto_group_unref(retiring
);
6427 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6432 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
6433 OVS_RELEASES(ofproto
->groups_rwlock
)
6436 struct ofputil_flow_mod fm
;
6438 /* Delete all flow entries containing this group in a group action */
6439 match_init_catchall(&match
);
6440 flow_mod_init(&fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
6441 fm
.delete_reason
= OFPRR_GROUP_DELETE
;
6442 fm
.out_group
= ofgroup
->group_id
;
6443 handle_flow_mod__(ofproto
, &fm
, NULL
);
6445 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
6446 /* No-one can find this group any more. */
6447 ofproto
->n_groups
[ofgroup
->type
]--;
6448 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6449 ofproto_group_unref(ofgroup
);
6452 /* Implements OFPGC11_DELETE. */
6454 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
6456 struct ofgroup
*ofgroup
;
6458 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6459 if (group_id
== OFPG_ALL
) {
6461 struct hmap_node
*node
= hmap_first(&ofproto
->groups
);
6465 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, hmap_node
);
6466 delete_group__(ofproto
, ofgroup
);
6467 /* Lock for each node separately, so that we will not jam the
6468 * other threads for too long time. */
6469 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
6472 HMAP_FOR_EACH_IN_BUCKET (ofgroup
, hmap_node
,
6473 hash_int(group_id
, 0), &ofproto
->groups
) {
6474 if (ofgroup
->group_id
== group_id
) {
6475 delete_group__(ofproto
, ofgroup
);
6480 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
6484 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6486 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6487 struct ofputil_group_mod gm
;
6490 error
= reject_slave_controller(ofconn
);
6495 error
= ofputil_decode_group_mod(oh
, &gm
);
6500 switch (gm
.command
) {
6502 return add_group(ofproto
, &gm
);
6504 case OFPGC11_MODIFY
:
6505 return modify_group(ofproto
, &gm
);
6507 case OFPGC11_DELETE
:
6508 delete_group(ofproto
, gm
.group_id
);
6511 case OFPGC15_INSERT_BUCKET
:
6512 return modify_group(ofproto
, &gm
);
6514 case OFPGC15_REMOVE_BUCKET
:
6515 return modify_group(ofproto
, &gm
);
6518 if (gm
.command
> OFPGC11_DELETE
) {
6519 VLOG_WARN_RL(&rl
, "%s: Invalid group_mod command type %d",
6520 ofproto
->name
, gm
.command
);
6522 return OFPERR_OFPGMFC_BAD_COMMAND
;
6526 enum ofputil_table_miss
6527 ofproto_table_get_miss_config(const struct ofproto
*ofproto
, uint8_t table_id
)
6529 enum ofputil_table_miss value
;
6531 atomic_read_relaxed(&ofproto
->tables
[table_id
].miss_config
, &value
);
6536 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
6538 if (!check_table_id(ofproto
, tm
->table_id
)) {
6539 return OFPERR_OFPTMFC_BAD_TABLE
;
6540 } else if (tm
->miss_config
!= OFPUTIL_TABLE_MISS_DEFAULT
) {
6541 if (tm
->table_id
== OFPTT_ALL
) {
6543 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
6544 atomic_store_relaxed(&ofproto
->tables
[i
].miss_config
,
6548 atomic_store_relaxed(&ofproto
->tables
[tm
->table_id
].miss_config
,
6556 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6558 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6559 struct ofputil_table_mod tm
;
6562 error
= reject_slave_controller(ofconn
);
6567 error
= ofputil_decode_table_mod(oh
, &tm
);
6572 return table_mod(ofproto
, &tm
);
6576 do_bundle_flow_mod_start(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
6577 struct ofp_bundle_entry
*be
)
6578 OVS_REQUIRES(ofproto_mutex
)
6580 switch (fm
->command
) {
6582 return add_flow_start(ofproto
, fm
, &be
->old_rules
.stub
[0],
6583 &be
->new_rules
.stub
[0]);
6585 return modify_flows_start_loose(ofproto
, fm
, &be
->old_rules
,
6587 case OFPFC_MODIFY_STRICT
:
6588 return modify_flow_start_strict(ofproto
, fm
, &be
->old_rules
,
6591 return delete_flows_start_loose(ofproto
, fm
, &be
->old_rules
);
6593 case OFPFC_DELETE_STRICT
:
6594 return delete_flow_start_strict(ofproto
, fm
, &be
->old_rules
);
6597 return OFPERR_OFPFMFC_BAD_COMMAND
;
6601 do_bundle_flow_mod_revert(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
6602 struct ofp_bundle_entry
*be
)
6603 OVS_REQUIRES(ofproto_mutex
)
6605 switch (fm
->command
) {
6607 add_flow_revert(ofproto
, fm
, be
->old_rules
.stub
[0],
6608 be
->new_rules
.stub
[0]);
6612 case OFPFC_MODIFY_STRICT
:
6613 modify_flows_revert(ofproto
, fm
, &be
->old_rules
, &be
->new_rules
);
6617 case OFPFC_DELETE_STRICT
:
6618 delete_flows_revert(ofproto
, &be
->old_rules
);
6627 do_bundle_flow_mod_finish(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
6628 const struct flow_mod_requester
*req
,
6629 struct ofp_bundle_entry
*be
)
6630 OVS_REQUIRES(ofproto_mutex
)
6632 switch (fm
->command
) {
6634 add_flow_finish(ofproto
, fm
, req
, be
->old_rules
.stub
[0],
6635 be
->new_rules
.stub
[0]);
6639 case OFPFC_MODIFY_STRICT
:
6640 modify_flows_finish(ofproto
, fm
, req
, &be
->old_rules
, &be
->new_rules
);
6644 case OFPFC_DELETE_STRICT
:
6645 delete_flows_finish(ofproto
, fm
, req
, &be
->old_rules
);
6653 /* Commit phases (all while locking ofproto_mutex):
6655 * 1. Begin: Gather resources and make changes visible in the next version.
6656 * - Mark affected rules for removal in the next version.
6657 * - Create new replacement rules, make visible in the next
6659 * - Do not send any events or notifications.
6661 * 2. Revert: Fail if any errors are found. After this point no errors are
6662 * possible. No visible changes were made, so rollback is minimal (remove
6663 * added invisible rules, restore visibility of rules marked for removal).
6665 * 3. Bump the version visible to lookups.
6667 * 4. Finish: Insert replacement rules to the ofproto provider. Remove replaced
6668 * and deleted rules from ofproto data structures, and Schedule postponed
6669 * removal of deleted rules from the classifier. Send notifications, buffered
6673 do_bundle_commit(struct ofconn
*ofconn
, uint32_t id
, uint16_t flags
)
6675 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6676 struct ofp_bundle
*bundle
;
6677 struct ofp_bundle_entry
*be
;
6680 bundle
= ofconn_get_bundle(ofconn
, id
);
6683 return OFPERR_OFPBFC_BAD_ID
;
6685 if (bundle
->flags
!= flags
) {
6686 error
= OFPERR_OFPBFC_BAD_FLAGS
;
6689 ovs_mutex_lock(&ofproto_mutex
);
6692 LIST_FOR_EACH (be
, node
, &bundle
->msg_list
) {
6693 if (be
->type
== OFPTYPE_PORT_MOD
) {
6694 /* Not supported yet. */
6695 error
= OFPERR_OFPBFC_MSG_FAILED
;
6696 } else if (be
->type
== OFPTYPE_FLOW_MOD
) {
6697 error
= do_bundle_flow_mod_start(ofproto
, &be
->fm
, be
);
6706 /* Send error referring to the original message. */
6708 ofconn_send_error(ofconn
, be
->ofp_msg
, error
);
6709 error
= OFPERR_OFPBFC_MSG_FAILED
;
6712 /* 2. Revert. Undo all the changes made above. */
6713 LIST_FOR_EACH_REVERSE_CONTINUE(be
, node
, &bundle
->msg_list
) {
6714 if (be
->type
== OFPTYPE_FLOW_MOD
) {
6715 do_bundle_flow_mod_revert(ofproto
, &be
->fm
, be
);
6719 /* 3. Bump the version. This makes all the changes in the bundle
6720 * visible to the lookups at once. For this to work an upcall must
6721 * read the tables_version once at the beginning and keep using the
6722 * same version number for the whole duration of the upcall
6724 ofproto_bump_tables_version(ofproto
);
6727 LIST_FOR_EACH (be
, node
, &bundle
->msg_list
) {
6728 if (be
->type
== OFPTYPE_FLOW_MOD
) {
6729 struct flow_mod_requester req
= { ofconn
, be
->ofp_msg
};
6731 do_bundle_flow_mod_finish(ofproto
, &be
->fm
, &req
, be
);
6735 ofmonitor_flush(ofproto
->connmgr
);
6736 ovs_mutex_unlock(&ofproto_mutex
);
6738 run_rule_executes(ofproto
);
6741 /* The bundle is discarded regardless the outcome. */
6742 ofp_bundle_remove__(ofconn
, bundle
, !error
);
6747 handle_bundle_control(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6749 struct ofputil_bundle_ctrl_msg bctrl
;
6750 struct ofputil_bundle_ctrl_msg reply
;
6754 error
= reject_slave_controller(ofconn
);
6759 error
= ofputil_decode_bundle_ctrl(oh
, &bctrl
);
6764 reply
.bundle_id
= bctrl
.bundle_id
;
6766 switch (bctrl
.type
) {
6767 case OFPBCT_OPEN_REQUEST
:
6768 error
= ofp_bundle_open(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6769 reply
.type
= OFPBCT_OPEN_REPLY
;
6771 case OFPBCT_CLOSE_REQUEST
:
6772 error
= ofp_bundle_close(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6773 reply
.type
= OFPBCT_CLOSE_REPLY
;;
6775 case OFPBCT_COMMIT_REQUEST
:
6776 error
= do_bundle_commit(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6777 reply
.type
= OFPBCT_COMMIT_REPLY
;
6779 case OFPBCT_DISCARD_REQUEST
:
6780 error
= ofp_bundle_discard(ofconn
, bctrl
.bundle_id
);
6781 reply
.type
= OFPBCT_DISCARD_REPLY
;
6784 case OFPBCT_OPEN_REPLY
:
6785 case OFPBCT_CLOSE_REPLY
:
6786 case OFPBCT_COMMIT_REPLY
:
6787 case OFPBCT_DISCARD_REPLY
:
6788 return OFPERR_OFPBFC_BAD_TYPE
;
6793 buf
= ofputil_encode_bundle_ctrl_reply(oh
, &reply
);
6794 ofconn_send_reply(ofconn
, buf
);
6800 handle_bundle_add(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6802 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6804 struct ofputil_bundle_add_msg badd
;
6805 struct ofp_bundle_entry
*bmsg
;
6808 error
= reject_slave_controller(ofconn
);
6813 error
= ofputil_decode_bundle_add(oh
, &badd
, &type
);
6818 bmsg
= ofp_bundle_entry_alloc(type
, badd
.msg
);
6820 if (type
== OFPTYPE_PORT_MOD
) {
6821 error
= ofputil_decode_port_mod(badd
.msg
, &bmsg
->pm
, false);
6822 } else if (type
== OFPTYPE_FLOW_MOD
) {
6823 struct ofpbuf ofpacts
;
6824 uint64_t ofpacts_stub
[1024 / 8];
6826 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
6827 error
= ofputil_decode_flow_mod(&bmsg
->fm
, badd
.msg
,
6828 ofconn_get_protocol(ofconn
),
6830 u16_to_ofp(ofproto
->max_ports
),
6832 /* Move actions to heap. */
6833 bmsg
->fm
.ofpacts
= ofpbuf_steal_data(&ofpacts
);
6835 if (!error
&& bmsg
->fm
.ofpacts_len
) {
6836 error
= ofproto_check_ofpacts(ofproto
, bmsg
->fm
.ofpacts
,
6837 bmsg
->fm
.ofpacts_len
);
6844 error
= ofp_bundle_add_message(ofconn
, badd
.bundle_id
, badd
.flags
,
6849 ofp_bundle_entry_free(bmsg
);
6856 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
6857 OVS_EXCLUDED(ofproto_mutex
)
6859 const struct ofp_header
*oh
= msg
->data
;
6863 error
= ofptype_decode(&type
, oh
);
6867 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
6868 && ofpmp_more(oh
)) {
6869 /* We have no buffer implementation for multipart requests.
6870 * Report overflow for requests which consists of multiple
6872 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
6876 /* OpenFlow requests. */
6877 case OFPTYPE_ECHO_REQUEST
:
6878 return handle_echo_request(ofconn
, oh
);
6880 case OFPTYPE_FEATURES_REQUEST
:
6881 return handle_features_request(ofconn
, oh
);
6883 case OFPTYPE_GET_CONFIG_REQUEST
:
6884 return handle_get_config_request(ofconn
, oh
);
6886 case OFPTYPE_SET_CONFIG
:
6887 return handle_set_config(ofconn
, oh
);
6889 case OFPTYPE_PACKET_OUT
:
6890 return handle_packet_out(ofconn
, oh
);
6892 case OFPTYPE_PORT_MOD
:
6893 return handle_port_mod(ofconn
, oh
);
6895 case OFPTYPE_FLOW_MOD
:
6896 return handle_flow_mod(ofconn
, oh
);
6898 case OFPTYPE_GROUP_MOD
:
6899 return handle_group_mod(ofconn
, oh
);
6901 case OFPTYPE_TABLE_MOD
:
6902 return handle_table_mod(ofconn
, oh
);
6904 case OFPTYPE_METER_MOD
:
6905 return handle_meter_mod(ofconn
, oh
);
6907 case OFPTYPE_BARRIER_REQUEST
:
6908 return handle_barrier_request(ofconn
, oh
);
6910 case OFPTYPE_ROLE_REQUEST
:
6911 return handle_role_request(ofconn
, oh
);
6913 /* OpenFlow replies. */
6914 case OFPTYPE_ECHO_REPLY
:
6917 /* Nicira extension requests. */
6918 case OFPTYPE_FLOW_MOD_TABLE_ID
:
6919 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
6921 case OFPTYPE_SET_FLOW_FORMAT
:
6922 return handle_nxt_set_flow_format(ofconn
, oh
);
6924 case OFPTYPE_SET_PACKET_IN_FORMAT
:
6925 return handle_nxt_set_packet_in_format(ofconn
, oh
);
6927 case OFPTYPE_SET_CONTROLLER_ID
:
6928 return handle_nxt_set_controller_id(ofconn
, oh
);
6930 case OFPTYPE_FLOW_AGE
:
6931 /* Nothing to do. */
6934 case OFPTYPE_FLOW_MONITOR_CANCEL
:
6935 return handle_flow_monitor_cancel(ofconn
, oh
);
6937 case OFPTYPE_SET_ASYNC_CONFIG
:
6938 return handle_nxt_set_async_config(ofconn
, oh
);
6940 case OFPTYPE_GET_ASYNC_REQUEST
:
6941 return handle_nxt_get_async_request(ofconn
, oh
);
6943 /* Statistics requests. */
6944 case OFPTYPE_DESC_STATS_REQUEST
:
6945 return handle_desc_stats_request(ofconn
, oh
);
6947 case OFPTYPE_FLOW_STATS_REQUEST
:
6948 return handle_flow_stats_request(ofconn
, oh
);
6950 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
6951 return handle_aggregate_stats_request(ofconn
, oh
);
6953 case OFPTYPE_TABLE_STATS_REQUEST
:
6954 return handle_table_stats_request(ofconn
, oh
);
6956 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
6957 return handle_table_features_request(ofconn
, oh
);
6959 case OFPTYPE_PORT_STATS_REQUEST
:
6960 return handle_port_stats_request(ofconn
, oh
);
6962 case OFPTYPE_QUEUE_STATS_REQUEST
:
6963 return handle_queue_stats_request(ofconn
, oh
);
6965 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
6966 return handle_port_desc_stats_request(ofconn
, oh
);
6968 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
6969 return handle_flow_monitor_request(ofconn
, oh
);
6971 case OFPTYPE_METER_STATS_REQUEST
:
6972 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
6973 return handle_meter_request(ofconn
, oh
, type
);
6975 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
6976 return handle_meter_features_request(ofconn
, oh
);
6978 case OFPTYPE_GROUP_STATS_REQUEST
:
6979 return handle_group_stats_request(ofconn
, oh
);
6981 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
6982 return handle_group_desc_stats_request(ofconn
, oh
);
6984 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
6985 return handle_group_features_stats_request(ofconn
, oh
);
6987 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
6988 return handle_queue_get_config_request(ofconn
, oh
);
6990 case OFPTYPE_BUNDLE_CONTROL
:
6991 return handle_bundle_control(ofconn
, oh
);
6993 case OFPTYPE_BUNDLE_ADD_MESSAGE
:
6994 return handle_bundle_add(ofconn
, oh
);
6998 case OFPTYPE_FEATURES_REPLY
:
6999 case OFPTYPE_GET_CONFIG_REPLY
:
7000 case OFPTYPE_PACKET_IN
:
7001 case OFPTYPE_FLOW_REMOVED
:
7002 case OFPTYPE_PORT_STATUS
:
7003 case OFPTYPE_BARRIER_REPLY
:
7004 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
7005 case OFPTYPE_DESC_STATS_REPLY
:
7006 case OFPTYPE_FLOW_STATS_REPLY
:
7007 case OFPTYPE_QUEUE_STATS_REPLY
:
7008 case OFPTYPE_PORT_STATS_REPLY
:
7009 case OFPTYPE_TABLE_STATS_REPLY
:
7010 case OFPTYPE_AGGREGATE_STATS_REPLY
:
7011 case OFPTYPE_PORT_DESC_STATS_REPLY
:
7012 case OFPTYPE_ROLE_REPLY
:
7013 case OFPTYPE_FLOW_MONITOR_PAUSED
:
7014 case OFPTYPE_FLOW_MONITOR_RESUMED
:
7015 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
7016 case OFPTYPE_GET_ASYNC_REPLY
:
7017 case OFPTYPE_GROUP_STATS_REPLY
:
7018 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
7019 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
7020 case OFPTYPE_METER_STATS_REPLY
:
7021 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
7022 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
7023 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
7024 case OFPTYPE_ROLE_STATUS
:
7026 if (ofpmsg_is_stat_request(oh
)) {
7027 return OFPERR_OFPBRC_BAD_STAT
;
7029 return OFPERR_OFPBRC_BAD_TYPE
;
7035 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
7036 OVS_EXCLUDED(ofproto_mutex
)
7038 enum ofperr error
= handle_openflow__(ofconn
, ofp_msg
);
7041 ofconn_send_error(ofconn
, ofp_msg
->data
, error
);
7043 COVERAGE_INC(ofproto_recv_openflow
);
7046 /* Asynchronous operations. */
7049 send_buffered_packet(const struct flow_mod_requester
*req
, uint32_t buffer_id
,
7051 OVS_REQUIRES(ofproto_mutex
)
7053 if (req
&& req
->ofconn
&& buffer_id
!= UINT32_MAX
) {
7054 struct ofproto
*ofproto
= ofconn_get_ofproto(req
->ofconn
);
7055 struct dp_packet
*packet
;
7059 error
= ofconn_pktbuf_retrieve(req
->ofconn
, buffer_id
, &packet
,
7062 struct rule_execute
*re
;
7064 ofproto_rule_ref(rule
);
7066 re
= xmalloc(sizeof *re
);
7068 re
->in_port
= in_port
;
7069 re
->packet
= packet
;
7071 if (!guarded_list_push_back(&ofproto
->rule_executes
,
7072 &re
->list_node
, 1024)) {
7073 ofproto_rule_unref(rule
);
7074 dp_packet_delete(re
->packet
);
7078 ofconn_send_error(req
->ofconn
, req
->request
, error
);
7084 pick_datapath_id(const struct ofproto
*ofproto
)
7086 const struct ofport
*port
;
7088 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
7090 uint8_t ea
[ETH_ADDR_LEN
];
7093 error
= netdev_get_etheraddr(port
->netdev
, ea
);
7095 return eth_addr_to_uint64(ea
);
7097 VLOG_WARN("%s: could not get MAC address for %s (%s)",
7098 ofproto
->name
, netdev_get_name(port
->netdev
),
7099 ovs_strerror(error
));
7101 return ofproto
->fallback_dpid
;
7105 pick_fallback_dpid(void)
7107 uint8_t ea
[ETH_ADDR_LEN
];
7108 eth_addr_nicira_random(ea
);
7109 return eth_addr_to_uint64(ea
);
7112 /* Table overflow policy. */
7114 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
7115 * to NULL if the table is not configured to evict rules or if the table
7116 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
7117 * or with no timeouts are not evictable.) */
7119 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
7120 OVS_REQUIRES(ofproto_mutex
)
7122 struct eviction_group
*evg
;
7125 if (!table
->eviction_fields
) {
7129 /* In the common case, the outer and inner loops here will each be entered
7132 * - The inner loop normally "return"s in its first iteration. If the
7133 * eviction group has any evictable rules, then it always returns in
7136 * - The outer loop only iterates more than once if the largest eviction
7137 * group has no evictable rules.
7139 * - The outer loop can exit only if table's 'max_flows' is all filled up
7140 * by unevictable rules. */
7141 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
7144 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
7153 /* Eviction groups. */
7155 /* Returns the priority to use for an eviction_group that contains 'n_rules'
7156 * rules. The priority contains low-order random bits to ensure that eviction
7157 * groups with the same number of rules are prioritized randomly. */
7159 eviction_group_priority(size_t n_rules
)
7161 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
7162 return (size
<< 16) | random_uint16();
7165 /* Updates 'evg', an eviction_group within 'table', following a change that
7166 * adds or removes rules in 'evg'. */
7168 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
7169 OVS_REQUIRES(ofproto_mutex
)
7171 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
7172 eviction_group_priority(heap_count(&evg
->rules
)));
7175 /* Destroys 'evg', an eviction_group within 'table':
7177 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
7178 * rules themselves, just removes them from the eviction group.)
7180 * - Removes 'evg' from 'table'.
7184 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
7185 OVS_REQUIRES(ofproto_mutex
)
7187 while (!heap_is_empty(&evg
->rules
)) {
7190 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
7191 rule
->eviction_group
= NULL
;
7193 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
7194 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
7195 heap_destroy(&evg
->rules
);
7199 /* Removes 'rule' from its eviction group, if any. */
7201 eviction_group_remove_rule(struct rule
*rule
)
7202 OVS_REQUIRES(ofproto_mutex
)
7204 if (rule
->eviction_group
) {
7205 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
7206 struct eviction_group
*evg
= rule
->eviction_group
;
7208 rule
->eviction_group
= NULL
;
7209 heap_remove(&evg
->rules
, &rule
->evg_node
);
7210 if (heap_is_empty(&evg
->rules
)) {
7211 eviction_group_destroy(table
, evg
);
7213 eviction_group_resized(table
, evg
);
7218 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
7219 * returns the hash value. */
7221 eviction_group_hash_rule(struct rule
*rule
)
7222 OVS_REQUIRES(ofproto_mutex
)
7224 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
7225 const struct mf_subfield
*sf
;
7229 hash
= table
->eviction_group_id_basis
;
7230 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
7231 for (sf
= table
->eviction_fields
;
7232 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
7235 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
7236 union mf_value value
;
7238 mf_get_value(sf
->field
, &flow
, &value
);
7240 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
7242 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
7243 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
7244 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
7245 sf
->field
->n_bytes
* 8 - start
);
7247 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
7249 hash
= hash_int(hash
, 0);
7256 /* Returns an eviction group within 'table' with the given 'id', creating one
7258 static struct eviction_group
*
7259 eviction_group_find(struct oftable
*table
, uint32_t id
)
7260 OVS_REQUIRES(ofproto_mutex
)
7262 struct eviction_group
*evg
;
7264 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
7268 evg
= xmalloc(sizeof *evg
);
7269 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
7270 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
7271 eviction_group_priority(0));
7272 heap_init(&evg
->rules
);
7277 /* Returns an eviction priority for 'rule'. The return value should be
7278 * interpreted so that higher priorities make a rule more attractive candidates
7280 * Called only if have a timeout. */
7282 rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*rule
)
7283 OVS_REQUIRES(ofproto_mutex
)
7285 long long int expiration
= LLONG_MAX
;
7286 long long int modified
;
7287 uint32_t expiration_offset
;
7289 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
7290 ovs_mutex_lock(&rule
->mutex
);
7291 modified
= rule
->modified
;
7292 ovs_mutex_unlock(&rule
->mutex
);
7294 if (rule
->hard_timeout
) {
7295 expiration
= modified
+ rule
->hard_timeout
* 1000;
7297 if (rule
->idle_timeout
) {
7298 uint64_t packets
, bytes
;
7300 long long int idle_expiration
;
7302 ofproto
->ofproto_class
->rule_get_stats(rule
, &packets
, &bytes
, &used
);
7303 idle_expiration
= used
+ rule
->idle_timeout
* 1000;
7304 expiration
= MIN(expiration
, idle_expiration
);
7307 if (expiration
== LLONG_MAX
) {
7311 /* Calculate the time of expiration as a number of (approximate) seconds
7312 * after program startup.
7314 * This should work OK for program runs that last UINT32_MAX seconds or
7315 * less. Therefore, please restart OVS at least once every 136 years. */
7316 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
7318 /* Invert the expiration offset because we're using a max-heap. */
7319 return UINT32_MAX
- expiration_offset
;
7322 /* Adds 'rule' to an appropriate eviction group for its oftable's
7323 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
7324 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
7327 * The caller must ensure that 'rule' is not already in an eviction group. */
7329 eviction_group_add_rule(struct rule
*rule
)
7330 OVS_REQUIRES(ofproto_mutex
)
7332 struct ofproto
*ofproto
= rule
->ofproto
;
7333 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
7336 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
7337 * so no additional protection is needed. */
7338 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
7340 if (table
->eviction_fields
&& has_timeout
) {
7341 struct eviction_group
*evg
;
7343 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
7345 rule
->eviction_group
= evg
;
7346 heap_insert(&evg
->rules
, &rule
->evg_node
,
7347 rule_eviction_priority(ofproto
, rule
));
7348 eviction_group_resized(table
, evg
);
7354 /* Initializes 'table'. */
7356 oftable_init(struct oftable
*table
)
7358 memset(table
, 0, sizeof *table
);
7359 classifier_init(&table
->cls
, flow_segment_u64s
);
7360 table
->max_flows
= UINT_MAX
;
7362 atomic_init(&table
->miss_config
, OFPUTIL_TABLE_MISS_DEFAULT
);
7364 classifier_set_prefix_fields(&table
->cls
, default_prefix_fields
,
7365 ARRAY_SIZE(default_prefix_fields
));
7367 atomic_init(&table
->n_matched
, 0);
7368 atomic_init(&table
->n_missed
, 0);
7371 /* Destroys 'table', including its classifier and eviction groups.
7373 * The caller is responsible for freeing 'table' itself. */
7375 oftable_destroy(struct oftable
*table
)
7377 ovs_assert(classifier_is_empty(&table
->cls
));
7378 oftable_disable_eviction(table
);
7379 classifier_destroy(&table
->cls
);
7383 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
7384 * string, then 'table' will use its default name.
7386 * This only affects the name exposed for a table exposed through the OpenFlow
7387 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
7389 oftable_set_name(struct oftable
*table
, const char *name
)
7391 if (name
&& name
[0]) {
7392 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
7393 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
7395 table
->name
= xmemdup0(name
, len
);
7403 /* oftables support a choice of two policies when adding a rule would cause the
7404 * number of flows in the table to exceed the configured maximum number: either
7405 * they can refuse to add the new flow or they can evict some existing flow.
7406 * This function configures the former policy on 'table'. */
7408 oftable_disable_eviction(struct oftable
*table
)
7409 OVS_REQUIRES(ofproto_mutex
)
7411 if (table
->eviction_fields
) {
7412 struct eviction_group
*evg
, *next
;
7414 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
7415 &table
->eviction_groups_by_id
) {
7416 eviction_group_destroy(table
, evg
);
7418 hmap_destroy(&table
->eviction_groups_by_id
);
7419 heap_destroy(&table
->eviction_groups_by_size
);
7421 free(table
->eviction_fields
);
7422 table
->eviction_fields
= NULL
;
7423 table
->n_eviction_fields
= 0;
7427 /* oftables support a choice of two policies when adding a rule would cause the
7428 * number of flows in the table to exceed the configured maximum number: either
7429 * they can refuse to add the new flow or they can evict some existing flow.
7430 * This function configures the latter policy on 'table', with fairness based
7431 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
7432 * 'n_fields' as 0 disables fairness.) */
7434 oftable_enable_eviction(struct oftable
*table
,
7435 const struct mf_subfield
*fields
, size_t n_fields
)
7436 OVS_REQUIRES(ofproto_mutex
)
7440 if (table
->eviction_fields
7441 && n_fields
== table
->n_eviction_fields
7443 || !memcmp(fields
, table
->eviction_fields
,
7444 n_fields
* sizeof *fields
))) {
7449 oftable_disable_eviction(table
);
7451 table
->n_eviction_fields
= n_fields
;
7452 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
7454 table
->eviction_group_id_basis
= random_uint32();
7455 hmap_init(&table
->eviction_groups_by_id
);
7456 heap_init(&table
->eviction_groups_by_size
);
7458 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
7459 eviction_group_add_rule(rule
);
7463 /* Inserts 'rule' from the ofproto data structures BEFORE caller has inserted
7464 * it to the classifier. */
7466 ofproto_rule_insert__(struct ofproto
*ofproto
, struct rule
*rule
)
7467 OVS_REQUIRES(ofproto_mutex
)
7469 const struct rule_actions
*actions
= rule_get_actions(rule
);
7471 ovs_assert(rule
->removed
);
7473 if (rule
->hard_timeout
|| rule
->idle_timeout
) {
7474 list_insert(&ofproto
->expirable
, &rule
->expirable
);
7476 cookies_insert(ofproto
, rule
);
7477 eviction_group_add_rule(rule
);
7478 if (actions
->has_meter
) {
7479 meter_insert_rule(rule
);
7481 rule
->removed
= false;
7484 /* Removes 'rule' from the ofproto data structures. Caller may have deferred
7485 * the removal from the classifier. */
7487 ofproto_rule_remove__(struct ofproto
*ofproto
, struct rule
*rule
)
7488 OVS_REQUIRES(ofproto_mutex
)
7490 ovs_assert(!rule
->removed
);
7492 cookies_remove(ofproto
, rule
);
7494 eviction_group_remove_rule(rule
);
7495 if (!list_is_empty(&rule
->expirable
)) {
7496 list_remove(&rule
->expirable
);
7498 if (!list_is_empty(&rule
->meter_list_node
)) {
7499 list_remove(&rule
->meter_list_node
);
7500 list_init(&rule
->meter_list_node
);
7503 rule
->removed
= true;
7506 /* unixctl commands. */
7509 ofproto_lookup(const char *name
)
7511 struct ofproto
*ofproto
;
7513 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
7515 if (!strcmp(ofproto
->name
, name
)) {
7523 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
7524 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
7526 struct ofproto
*ofproto
;
7530 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
7531 ds_put_format(&results
, "%s\n", ofproto
->name
);
7533 unixctl_command_reply(conn
, ds_cstr(&results
));
7534 ds_destroy(&results
);
7538 ofproto_unixctl_init(void)
7540 static bool registered
;
7546 unixctl_command_register("ofproto/list", "", 0, 0,
7547 ofproto_unixctl_list
, NULL
);
7550 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
7552 * This is deprecated. It is only for compatibility with broken device drivers
7553 * in old versions of Linux that do not properly support VLANs when VLAN
7554 * devices are not used. When broken device drivers are no longer in
7555 * widespread use, we will delete these interfaces. */
7557 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
7558 * (exactly) by an OpenFlow rule in 'ofproto'. */
7560 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
7563 struct cls_rule target
;
7564 const struct oftable
*oftable
;
7566 match_init_catchall(&match
);
7567 match_set_vlan_vid_masked(&match
, htons(VLAN_CFI
), htons(VLAN_CFI
));
7568 cls_rule_init(&target
, &match
, 0, CLS_MAX_VERSION
);
7570 free(ofproto
->vlan_bitmap
);
7571 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
7572 ofproto
->vlans_changed
= false;
7574 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
7577 CLS_FOR_EACH_TARGET (rule
, cr
, &oftable
->cls
, &target
) {
7578 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
7579 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
7581 bitmap_set1(vlan_bitmap
, vid
);
7582 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
7587 cls_rule_destroy(&target
);
7590 /* Returns true if new VLANs have come into use by the flow table since the
7591 * last call to ofproto_get_vlan_usage().
7593 * We don't track when old VLANs stop being used. */
7595 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
7597 return ofproto
->vlans_changed
;
7600 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
7601 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
7602 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
7603 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
7604 * then the VLAN device is un-enslaved. */
7606 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
7607 ofp_port_t realdev_ofp_port
, int vid
)
7609 struct ofport
*ofport
;
7612 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
7614 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
7616 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
7617 ofproto
->name
, vlandev_ofp_port
);
7621 if (!ofproto
->ofproto_class
->set_realdev
) {
7622 if (!vlandev_ofp_port
) {
7625 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
7629 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
7631 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
7632 ofproto
->name
, vlandev_ofp_port
,
7633 netdev_get_name(ofport
->netdev
), ovs_strerror(error
));