2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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"
50 #include "poll-loop.h"
58 #include "unaligned.h"
63 VLOG_DEFINE_THIS_MODULE(ofproto
);
65 COVERAGE_DEFINE(ofproto_flush
);
66 COVERAGE_DEFINE(ofproto_packet_out
);
67 COVERAGE_DEFINE(ofproto_queue_req
);
68 COVERAGE_DEFINE(ofproto_recv_openflow
);
69 COVERAGE_DEFINE(ofproto_reinit_ports
);
70 COVERAGE_DEFINE(ofproto_update_port
);
72 /* Default fields to use for prefix tries in each flow table, unless something
73 * else is configured. */
74 const enum mf_field_id default_prefix_fields
[2] =
75 { MFF_IPV4_DST
, MFF_IPV4_SRC
};
78 static void oftable_init(struct oftable
*);
79 static void oftable_destroy(struct oftable
*);
81 static void oftable_set_name(struct oftable
*, const char *name
);
83 static enum ofperr
evict_rules_from_table(struct oftable
*,
84 unsigned int extra_space
)
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 static void oftable_remove_rule(struct rule
*rule
) OVS_REQUIRES(ofproto_mutex
);
92 static void oftable_remove_rule__(struct ofproto
*, struct rule
*)
93 OVS_REQUIRES(ofproto_mutex
);
95 /* A set of rules within a single OpenFlow table (oftable) that have the same
96 * values for the oftable's eviction_fields. A rule to be evicted, when one is
97 * needed, is taken from the eviction group that contains the greatest number
100 * An oftable owns any number of eviction groups, each of which contains any
103 * Membership in an eviction group is imprecise, based on the hash of the
104 * oftable's eviction_fields (in the eviction_group's id_node.hash member).
105 * That is, if two rules have different eviction_fields, but those
106 * eviction_fields hash to the same value, then they will belong to the same
107 * eviction_group anyway.
109 * (When eviction is not enabled on an oftable, we don't track any eviction
110 * groups, to save time and space.) */
111 struct eviction_group
{
112 struct hmap_node id_node
; /* In oftable's "eviction_groups_by_id". */
113 struct heap_node size_node
; /* In oftable's "eviction_groups_by_size". */
114 struct heap rules
; /* Contains "struct rule"s. */
117 static bool choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
118 OVS_REQUIRES(ofproto_mutex
);
119 static uint32_t rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*)
120 OVS_REQUIRES(ofproto_mutex
);;
121 static void eviction_group_add_rule(struct rule
*)
122 OVS_REQUIRES(ofproto_mutex
);
123 static void eviction_group_remove_rule(struct rule
*)
124 OVS_REQUIRES(ofproto_mutex
);
126 /* Criteria that flow_mod and other operations use for selecting rules on
127 * which to operate. */
128 struct rule_criteria
{
129 /* An OpenFlow table or 255 for all tables. */
132 /* OpenFlow matching criteria. Interpreted different in "loose" way by
133 * collect_rules_loose() and "strict" way by collect_rules_strict(), as
134 * defined in the OpenFlow spec. */
137 /* Matching criteria for the OpenFlow cookie. Consider a bit B in a rule's
138 * cookie and the corresponding bits C in 'cookie' and M in 'cookie_mask'.
139 * The rule will not be selected if M is 1 and B != C. */
141 ovs_be64 cookie_mask
;
143 /* Selection based on actions within a rule:
145 * If out_port != OFPP_ANY, selects only rules that output to out_port.
146 * If out_group != OFPG_ALL, select only rules that output to out_group. */
150 /* If true, collects only rules that are modifiable. */
152 bool include_readonly
;
155 static void rule_criteria_init(struct rule_criteria
*, uint8_t table_id
,
156 const struct match
*match
,
157 unsigned int priority
,
158 ovs_be64 cookie
, ovs_be64 cookie_mask
,
159 ofp_port_t out_port
, uint32_t out_group
);
160 static void rule_criteria_require_rw(struct rule_criteria
*,
161 bool can_write_readonly
);
162 static void rule_criteria_destroy(struct rule_criteria
*);
164 static enum ofperr
collect_rules_loose(struct ofproto
*,
165 const struct rule_criteria
*,
166 struct rule_collection
*);
168 /* A packet that needs to be passed to rule_execute().
170 * (We can't do this immediately from ofopgroup_complete() because that holds
171 * ofproto_mutex, which rule_execute() needs released.) */
172 struct rule_execute
{
173 struct list list_node
; /* In struct ofproto's "rule_executes" list. */
174 struct rule
*rule
; /* Owns a reference to the rule. */
176 struct ofpbuf
*packet
; /* Owns the packet. */
179 static void run_rule_executes(struct ofproto
*) OVS_EXCLUDED(ofproto_mutex
);
180 static void destroy_rule_executes(struct ofproto
*);
182 struct learned_cookie
{
184 /* In struct ofproto's 'learned_cookies' hmap. */
185 struct hmap_node hmap_node
OVS_GUARDED_BY(ofproto_mutex
);
187 /* In 'dead_cookies' list when removed from hmap. */
188 struct list list_node
;
192 ovs_be64 cookie
OVS_GUARDED_BY(ofproto_mutex
);
193 uint8_t table_id
OVS_GUARDED_BY(ofproto_mutex
);
195 /* Number of references from "learn" actions.
197 * When this drops to 0, all of the flows in 'table_id' with the specified
198 * 'cookie' are deleted. */
199 int n
OVS_GUARDED_BY(ofproto_mutex
);
202 static const struct ofpact_learn
*next_learn_with_delete(
203 const struct rule_actions
*, const struct ofpact_learn
*start
);
205 static void learned_cookies_inc(struct ofproto
*, const struct rule_actions
*)
206 OVS_REQUIRES(ofproto_mutex
);
207 static void learned_cookies_dec(struct ofproto
*, const struct rule_actions
*,
208 struct list
*dead_cookies
)
209 OVS_REQUIRES(ofproto_mutex
);
210 static void learned_cookies_flush(struct ofproto
*, struct list
*dead_cookies
)
211 OVS_REQUIRES(ofproto_mutex
);
214 static void ofport_destroy__(struct ofport
*) OVS_EXCLUDED(ofproto_mutex
);
215 static void ofport_destroy(struct ofport
*);
217 static void update_port(struct ofproto
*, const char *devname
);
218 static int init_ports(struct ofproto
*);
219 static void reinit_ports(struct ofproto
*);
221 static long long int ofport_get_usage(const struct ofproto
*,
222 ofp_port_t ofp_port
);
223 static void ofport_set_usage(struct ofproto
*, ofp_port_t ofp_port
,
224 long long int last_used
);
225 static void ofport_remove_usage(struct ofproto
*, ofp_port_t ofp_port
);
229 * Keeps track of the currently used and recently used ofport values and is
230 * used to prevent immediate recycling of ofport values. */
231 struct ofport_usage
{
232 struct hmap_node hmap_node
; /* In struct ofproto's "ofport_usage" hmap. */
233 ofp_port_t ofp_port
; /* OpenFlow port number. */
234 long long int last_used
; /* Last time the 'ofp_port' was used. LLONG_MAX
235 represents in-use ofports. */
239 static void ofproto_rule_send_removed(struct rule
*, uint8_t reason
);
240 static bool rule_is_readonly(const struct rule
*);
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 ovs_be32 xid
; /* OpenFlow xid of flow_mod request. */
254 static enum ofperr
add_flow(struct ofproto
*, struct ofputil_flow_mod
*,
255 const struct flow_mod_requester
*);
257 static enum ofperr
modify_flows__(struct ofproto
*, struct ofputil_flow_mod
*,
258 const struct rule_collection
*,
259 const struct flow_mod_requester
*);
260 static void delete_flows__(const struct rule_collection
*,
261 enum ofp_flow_removed_reason
,
262 const struct flow_mod_requester
*)
263 OVS_REQUIRES(ofproto_mutex
);
265 static enum ofperr
send_buffered_packet(struct ofconn
*, uint32_t buffer_id
,
267 OVS_REQUIRES(ofproto_mutex
);
269 static bool ofproto_group_exists__(const struct ofproto
*ofproto
,
271 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
);
272 static bool ofproto_group_exists(const struct ofproto
*ofproto
,
274 OVS_EXCLUDED(ofproto
->groups_rwlock
);
275 static enum ofperr
add_group(struct ofproto
*, struct ofputil_group_mod
*);
276 static void handle_openflow(struct ofconn
*, const struct ofpbuf
*);
277 static enum ofperr
handle_flow_mod__(struct ofproto
*,
278 struct ofputil_flow_mod
*,
279 const struct flow_mod_requester
*)
280 OVS_EXCLUDED(ofproto_mutex
);
281 static void calc_duration(long long int start
, long long int now
,
282 uint32_t *sec
, uint32_t *nsec
);
285 static uint64_t pick_datapath_id(const struct ofproto
*);
286 static uint64_t pick_fallback_dpid(void);
287 static void ofproto_destroy__(struct ofproto
*);
288 static void update_mtu(struct ofproto
*, struct ofport
*);
289 static void meter_delete(struct ofproto
*, uint32_t first
, uint32_t last
);
290 static void meter_insert_rule(struct rule
*);
293 static void ofproto_unixctl_init(void);
295 /* All registered ofproto classes, in probe order. */
296 static const struct ofproto_class
**ofproto_classes
;
297 static size_t n_ofproto_classes
;
298 static size_t allocated_ofproto_classes
;
300 /* Global lock that protects all flow table operations. */
301 struct ovs_mutex ofproto_mutex
= OVS_MUTEX_INITIALIZER
;
303 unsigned ofproto_flow_limit
= OFPROTO_FLOW_LIMIT_DEFAULT
;
304 unsigned ofproto_max_idle
= OFPROTO_MAX_IDLE_DEFAULT
;
306 size_t n_handlers
, n_revalidators
;
308 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
309 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
311 /* Initial mappings of port to OpenFlow number mappings. */
312 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
314 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
316 /* The default value of true waits for flow restore. */
317 static bool flow_restore_wait
= true;
319 /* Must be called to initialize the ofproto library.
321 * The caller may pass in 'iface_hints', which contains an shash of
322 * "iface_hint" elements indexed by the interface's name. The provider
323 * may use these hints to describe the startup configuration in order to
324 * reinitialize its state. The caller owns the provided data, so a
325 * provider will make copies of anything required. An ofproto provider
326 * will remove any existing state that is not described by the hint, and
327 * may choose to remove it all. */
329 ofproto_init(const struct shash
*iface_hints
)
331 struct shash_node
*node
;
334 ofproto_class_register(&ofproto_dpif_class
);
336 /* Make a local copy, since we don't own 'iface_hints' elements. */
337 SHASH_FOR_EACH(node
, iface_hints
) {
338 const struct iface_hint
*orig_hint
= node
->data
;
339 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
340 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
342 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
343 new_hint
->br_type
= xstrdup(br_type
);
344 new_hint
->ofp_port
= orig_hint
->ofp_port
;
346 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
349 for (i
= 0; i
< n_ofproto_classes
; i
++) {
350 ofproto_classes
[i
]->init(&init_ofp_ports
);
354 /* 'type' should be a normalized datapath type, as returned by
355 * ofproto_normalize_type(). Returns the corresponding ofproto_class
356 * structure, or a null pointer if there is none registered for 'type'. */
357 static const struct ofproto_class
*
358 ofproto_class_find__(const char *type
)
362 for (i
= 0; i
< n_ofproto_classes
; i
++) {
363 const struct ofproto_class
*class = ofproto_classes
[i
];
368 class->enumerate_types(&types
);
369 found
= sset_contains(&types
, type
);
370 sset_destroy(&types
);
376 VLOG_WARN("unknown datapath type %s", type
);
380 /* Registers a new ofproto class. After successful registration, new ofprotos
381 * of that type can be created using ofproto_create(). */
383 ofproto_class_register(const struct ofproto_class
*new_class
)
387 for (i
= 0; i
< n_ofproto_classes
; i
++) {
388 if (ofproto_classes
[i
] == new_class
) {
393 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
394 ofproto_classes
= x2nrealloc(ofproto_classes
,
395 &allocated_ofproto_classes
,
396 sizeof *ofproto_classes
);
398 ofproto_classes
[n_ofproto_classes
++] = new_class
;
402 /* Unregisters a datapath provider. 'type' must have been previously
403 * registered and not currently be in use by any ofprotos. After
404 * unregistration new datapaths of that type cannot be opened using
405 * ofproto_create(). */
407 ofproto_class_unregister(const struct ofproto_class
*class)
411 for (i
= 0; i
< n_ofproto_classes
; i
++) {
412 if (ofproto_classes
[i
] == class) {
413 for (i
++; i
< n_ofproto_classes
; i
++) {
414 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
420 VLOG_WARN("attempted to unregister an ofproto class that is not "
425 /* Clears 'types' and enumerates all registered ofproto types into it. The
426 * caller must first initialize the sset. */
428 ofproto_enumerate_types(struct sset
*types
)
433 for (i
= 0; i
< n_ofproto_classes
; i
++) {
434 ofproto_classes
[i
]->enumerate_types(types
);
438 /* Returns the fully spelled out name for the given ofproto 'type'.
440 * Normalized type string can be compared with strcmp(). Unnormalized type
441 * string might be the same even if they have different spellings. */
443 ofproto_normalize_type(const char *type
)
445 return type
&& type
[0] ? type
: "system";
448 /* Clears 'names' and enumerates the names of all known created ofprotos with
449 * the given 'type'. The caller must first initialize the sset. Returns 0 if
450 * successful, otherwise a positive errno value.
452 * Some kinds of datapaths might not be practically enumerable. This is not
453 * considered an error. */
455 ofproto_enumerate_names(const char *type
, struct sset
*names
)
457 const struct ofproto_class
*class = ofproto_class_find__(type
);
458 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
462 ofproto_create(const char *datapath_name
, const char *datapath_type
,
463 struct ofproto
**ofprotop
)
465 const struct ofproto_class
*class;
466 struct ofproto
*ofproto
;
472 ofproto_unixctl_init();
474 datapath_type
= ofproto_normalize_type(datapath_type
);
475 class = ofproto_class_find__(datapath_type
);
477 VLOG_WARN("could not create datapath %s of unknown type %s",
478 datapath_name
, datapath_type
);
482 ofproto
= class->alloc();
484 VLOG_ERR("failed to allocate datapath %s of type %s",
485 datapath_name
, datapath_type
);
490 ovs_mutex_lock(&ofproto_mutex
);
491 memset(ofproto
, 0, sizeof *ofproto
);
492 ofproto
->ofproto_class
= class;
493 ofproto
->name
= xstrdup(datapath_name
);
494 ofproto
->type
= xstrdup(datapath_type
);
495 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
496 hash_string(ofproto
->name
, 0));
497 ofproto
->datapath_id
= 0;
498 ofproto
->forward_bpdu
= false;
499 ofproto
->fallback_dpid
= pick_fallback_dpid();
500 ofproto
->mfr_desc
= NULL
;
501 ofproto
->hw_desc
= NULL
;
502 ofproto
->sw_desc
= NULL
;
503 ofproto
->serial_desc
= NULL
;
504 ofproto
->dp_desc
= NULL
;
505 ofproto
->frag_handling
= OFPC_FRAG_NORMAL
;
506 hmap_init(&ofproto
->ports
);
507 hmap_init(&ofproto
->ofport_usage
);
508 shash_init(&ofproto
->port_by_name
);
509 simap_init(&ofproto
->ofp_requests
);
510 ofproto
->max_ports
= ofp_to_u16(OFPP_MAX
);
511 ofproto
->eviction_group_timer
= LLONG_MIN
;
512 ofproto
->tables
= NULL
;
513 ofproto
->n_tables
= 0;
514 hindex_init(&ofproto
->cookies
);
515 hmap_init(&ofproto
->learned_cookies
);
516 list_init(&ofproto
->expirable
);
517 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
518 guarded_list_init(&ofproto
->rule_executes
);
519 ofproto
->vlan_bitmap
= NULL
;
520 ofproto
->vlans_changed
= false;
521 ofproto
->min_mtu
= INT_MAX
;
522 ovs_rwlock_init(&ofproto
->groups_rwlock
);
523 hmap_init(&ofproto
->groups
);
524 ovs_mutex_unlock(&ofproto_mutex
);
525 ofproto
->ogf
.capabilities
= OFPGFC_CHAINING
| OFPGFC_SELECT_LIVENESS
|
526 OFPGFC_SELECT_WEIGHT
;
527 for (i
= 0; i
< 4; i
++) {
528 ofproto
->ogf
.max_groups
[i
] = OFPG_MAX
;
529 ofproto
->ogf
.ofpacts
[i
] = (UINT64_C(1) << N_OFPACTS
) - 1;
532 error
= ofproto
->ofproto_class
->construct(ofproto
);
534 VLOG_ERR("failed to open datapath %s: %s",
535 datapath_name
, ovs_strerror(error
));
536 ofproto_destroy__(ofproto
);
540 /* Check that hidden tables, if any, are at the end. */
541 ovs_assert(ofproto
->n_tables
);
542 for (i
= 0; i
+ 1 < ofproto
->n_tables
; i
++) {
543 enum oftable_flags flags
= ofproto
->tables
[i
].flags
;
544 enum oftable_flags next_flags
= ofproto
->tables
[i
+ 1].flags
;
546 ovs_assert(!(flags
& OFTABLE_HIDDEN
) || next_flags
& OFTABLE_HIDDEN
);
549 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
552 /* Initialize meters table. */
553 if (ofproto
->ofproto_class
->meter_get_features
) {
554 ofproto
->ofproto_class
->meter_get_features(ofproto
,
555 &ofproto
->meter_features
);
557 memset(&ofproto
->meter_features
, 0, sizeof ofproto
->meter_features
);
559 ofproto
->meters
= xzalloc((ofproto
->meter_features
.max_meters
+ 1)
560 * sizeof(struct meter
*));
566 /* Must be called (only) by an ofproto implementation in its constructor
567 * function. See the large comment on 'construct' in struct ofproto_class for
570 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
572 struct oftable
*table
;
574 ovs_assert(!ofproto
->n_tables
);
575 ovs_assert(n_tables
>= 1 && n_tables
<= 255);
577 ofproto
->n_tables
= n_tables
;
578 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
579 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
584 /* To be optionally called (only) by an ofproto implementation in its
585 * constructor function. See the large comment on 'construct' in struct
586 * ofproto_class for details.
588 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
589 * will then ensure that actions passed into the ofproto implementation will
590 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
591 * function is not called, there will be no such restriction.
593 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
594 * the 'max_ports' restriction. */
596 ofproto_init_max_ports(struct ofproto
*ofproto
, uint16_t max_ports
)
598 ovs_assert(max_ports
<= ofp_to_u16(OFPP_MAX
));
599 ofproto
->max_ports
= max_ports
;
603 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
605 return ofproto
->datapath_id
;
609 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
611 uint64_t old_dpid
= p
->datapath_id
;
612 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
613 if (p
->datapath_id
!= old_dpid
) {
614 /* Force all active connections to reconnect, since there is no way to
615 * notify a controller that the datapath ID has changed. */
616 ofproto_reconnect_controllers(p
);
621 ofproto_set_controllers(struct ofproto
*p
,
622 const struct ofproto_controller
*controllers
,
623 size_t n_controllers
, uint32_t allowed_versions
)
625 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
,
630 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
632 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
635 /* Drops the connections between 'ofproto' and all of its controllers, forcing
636 * them to reconnect. */
638 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
640 connmgr_reconnect(ofproto
->connmgr
);
643 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
644 * in-band control should guarantee access, in the same way that in-band
645 * control guarantees access to OpenFlow controllers. */
647 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
648 const struct sockaddr_in
*extras
, size_t n
)
650 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
653 /* Sets the OpenFlow queue used by flows set up by in-band control on
654 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
655 * flows will use the default queue. */
657 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
659 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
662 /* Sets the number of flows at which eviction from the kernel flow table
665 ofproto_set_flow_limit(unsigned limit
)
667 ofproto_flow_limit
= limit
;
670 /* Sets the maximum idle time for flows in the datapath before they are
673 ofproto_set_max_idle(unsigned max_idle
)
675 ofproto_max_idle
= max_idle
;
678 /* If forward_bpdu is true, the NORMAL action will forward frames with
679 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
680 * the NORMAL action will drop these frames. */
682 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
684 bool old_val
= ofproto
->forward_bpdu
;
685 ofproto
->forward_bpdu
= forward_bpdu
;
686 if (old_val
!= ofproto
->forward_bpdu
) {
687 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
688 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
693 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
694 * 'idle_time', in seconds, and the maximum number of MAC table entries to
697 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
700 if (ofproto
->ofproto_class
->set_mac_table_config
) {
701 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
706 /* Multicast snooping configuration. */
708 /* Configures multicast snooping on 'ofproto' using the settings
709 * defined in 's'. If 's' is NULL, disables multicast snooping.
711 * Returns 0 if successful, otherwise a positive errno value. */
713 ofproto_set_mcast_snooping(struct ofproto
*ofproto
,
714 const struct ofproto_mcast_snooping_settings
*s
)
716 return (ofproto
->ofproto_class
->set_mcast_snooping
717 ? ofproto
->ofproto_class
->set_mcast_snooping(ofproto
, s
)
721 /* Configures multicast snooping flood setting on 'ofp_port' of 'ofproto'.
723 * Returns 0 if successful, otherwise a positive errno value.*/
725 ofproto_port_set_mcast_snooping(struct ofproto
*ofproto
, void *aux
, bool flood
)
727 return (ofproto
->ofproto_class
->set_mcast_snooping_port
728 ? ofproto
->ofproto_class
->set_mcast_snooping_port(ofproto
, aux
,
734 ofproto_set_threads(int n_handlers_
, int n_revalidators_
)
736 int threads
= MAX(count_cpu_cores(), 2);
738 n_revalidators
= MAX(n_revalidators_
, 0);
739 n_handlers
= MAX(n_handlers_
, 0);
741 if (!n_revalidators
) {
742 n_revalidators
= n_handlers
743 ? MAX(threads
- (int) n_handlers
, 1)
748 n_handlers
= MAX(threads
- (int) n_revalidators
, 1);
753 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
756 p
->dp_desc
= dp_desc
? xstrdup(dp_desc
) : NULL
;
760 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
762 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
766 ofproto_set_netflow(struct ofproto
*ofproto
,
767 const struct netflow_options
*nf_options
)
769 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
773 if (ofproto
->ofproto_class
->set_netflow
) {
774 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
776 return nf_options
? EOPNOTSUPP
: 0;
781 ofproto_set_sflow(struct ofproto
*ofproto
,
782 const struct ofproto_sflow_options
*oso
)
784 if (oso
&& sset_is_empty(&oso
->targets
)) {
788 if (ofproto
->ofproto_class
->set_sflow
) {
789 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
791 return oso
? EOPNOTSUPP
: 0;
796 ofproto_set_ipfix(struct ofproto
*ofproto
,
797 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
798 const struct ofproto_ipfix_flow_exporter_options
*fo
,
801 if (ofproto
->ofproto_class
->set_ipfix
) {
802 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
804 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
809 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
811 flow_restore_wait
= flow_restore_wait_db
;
815 ofproto_get_flow_restore_wait(void)
817 return flow_restore_wait
;
821 /* Spanning Tree Protocol (STP) configuration. */
823 /* Configures STP on 'ofproto' using the settings defined in 's'. If
824 * 's' is NULL, disables STP.
826 * Returns 0 if successful, otherwise a positive errno value. */
828 ofproto_set_stp(struct ofproto
*ofproto
,
829 const struct ofproto_stp_settings
*s
)
831 return (ofproto
->ofproto_class
->set_stp
832 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
836 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
837 * 'enabled' member of 's' is false, then the other members are not
840 * Returns 0 if successful, otherwise a positive errno value. */
842 ofproto_get_stp_status(struct ofproto
*ofproto
,
843 struct ofproto_stp_status
*s
)
845 return (ofproto
->ofproto_class
->get_stp_status
846 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
850 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
851 * in 's'. The caller is responsible for assigning STP port numbers
852 * (using the 'port_num' member in the range of 1 through 255, inclusive)
853 * and ensuring there are no duplicates. If the 's' is NULL, then STP
854 * is disabled on the port.
856 * Returns 0 if successful, otherwise a positive errno value.*/
858 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
859 const struct ofproto_port_stp_settings
*s
)
861 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
863 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
864 ofproto
->name
, ofp_port
);
868 return (ofproto
->ofproto_class
->set_stp_port
869 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
873 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
874 * 's'. If the 'enabled' member in 's' is false, then the other members
875 * are not meaningful.
877 * Returns 0 if successful, otherwise a positive errno value.*/
879 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
880 struct ofproto_port_stp_status
*s
)
882 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
884 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
885 "port %"PRIu16
, ofproto
->name
, ofp_port
);
889 return (ofproto
->ofproto_class
->get_stp_port_status
890 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
894 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
895 * 's'. If the 'enabled' member in 's' is false, then the other members
896 * are not meaningful.
898 * Returns 0 if successful, otherwise a positive errno value.*/
900 ofproto_port_get_stp_stats(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
901 struct ofproto_port_stp_stats
*s
)
903 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
905 VLOG_WARN_RL(&rl
, "%s: cannot get STP stats on nonexistent "
906 "port %"PRIu16
, ofproto
->name
, ofp_port
);
910 return (ofproto
->ofproto_class
->get_stp_port_stats
911 ? ofproto
->ofproto_class
->get_stp_port_stats(ofport
, s
)
915 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
917 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
918 * 's' is NULL, disables RSTP.
920 * Returns 0 if successful, otherwise a positive errno value. */
922 ofproto_set_rstp(struct ofproto
*ofproto
,
923 const struct ofproto_rstp_settings
*s
)
925 if (!ofproto
->ofproto_class
->set_rstp
) {
928 ofproto
->ofproto_class
->set_rstp(ofproto
, s
);
932 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
933 * 'enabled' member of 's' is false, then the other members are not
936 * Returns 0 if successful, otherwise a positive errno value. */
938 ofproto_get_rstp_status(struct ofproto
*ofproto
,
939 struct ofproto_rstp_status
*s
)
941 if (!ofproto
->ofproto_class
->get_rstp_status
) {
944 ofproto
->ofproto_class
->get_rstp_status(ofproto
, s
);
948 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
949 * in 's'. The caller is responsible for assigning RSTP port numbers
950 * (using the 'port_num' member in the range of 1 through 255, inclusive)
951 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
952 * is disabled on the port.
954 * Returns 0 if successful, otherwise a positive errno value.*/
956 ofproto_port_set_rstp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
957 const struct ofproto_port_rstp_settings
*s
)
959 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
961 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16
,
962 ofproto
->name
, ofp_port
);
966 if (!ofproto
->ofproto_class
->set_rstp_port
) {
969 ofproto
->ofproto_class
->set_rstp_port(ofport
, s
);
973 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
974 * 's'. If the 'enabled' member in 's' is false, then the other members
975 * are not meaningful.
977 * Returns 0 if successful, otherwise a positive errno value.*/
979 ofproto_port_get_rstp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
980 struct ofproto_port_rstp_status
*s
)
982 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
984 VLOG_WARN_RL(&rl
, "%s: cannot get RSTP status on nonexistent "
985 "port %"PRIu16
, ofproto
->name
, ofp_port
);
989 if (!ofproto
->ofproto_class
->get_rstp_port_status
) {
992 ofproto
->ofproto_class
->get_rstp_port_status(ofport
, s
);
996 /* Queue DSCP configuration. */
998 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
999 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1000 * to implement QoS. Instead, it is used to implement features which require
1001 * knowledge of what queues exist on a port, and some basic information about
1004 * Returns 0 if successful, otherwise a positive errno value. */
1006 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1007 const struct ofproto_port_queue
*queues
,
1010 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1013 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
1014 ofproto
->name
, ofp_port
);
1018 return (ofproto
->ofproto_class
->set_queues
1019 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
1023 /* Connectivity Fault Management configuration. */
1025 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1027 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1029 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1030 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
1031 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
1035 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1036 * basic configuration from the configuration members in 'cfm', and the remote
1037 * maintenance point ID from remote_mpid. Ignores the statistics members of
1040 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1042 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1043 const struct cfm_settings
*s
)
1045 struct ofport
*ofport
;
1048 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1050 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
1051 ofproto
->name
, ofp_port
);
1055 /* XXX: For configuration simplicity, we only support one remote_mpid
1056 * outside of the CFM module. It's not clear if this is the correct long
1057 * term solution or not. */
1058 error
= (ofproto
->ofproto_class
->set_cfm
1059 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
1062 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
1063 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1064 ovs_strerror(error
));
1068 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1069 * 'ofproto' does not have a port 'ofp_port'. */
1071 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1072 const struct smap
*cfg
)
1074 struct ofport
*ofport
;
1077 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1079 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16
,
1080 ofproto
->name
, ofp_port
);
1084 error
= (ofproto
->ofproto_class
->set_bfd
1085 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
1088 VLOG_WARN("%s: bfd configuration on port %"PRIu16
" (%s) failed (%s)",
1089 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1090 ovs_strerror(error
));
1094 /* Checks the status change of BFD on 'ofport'.
1096 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1098 ofproto_port_bfd_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1100 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1101 return (ofport
&& ofproto
->ofproto_class
->bfd_status_changed
1102 ? ofproto
->ofproto_class
->bfd_status_changed(ofport
)
1106 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1107 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1108 * is not an OpenFlow port in 'ofproto'.
1110 * The caller must provide and own '*status'. */
1112 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1113 struct smap
*status
)
1115 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1116 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
1117 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
1121 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1122 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1123 * 0 if LACP partner information is not current (generally indicating a
1124 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1126 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1128 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1129 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
1130 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
1136 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1137 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1138 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1139 * configuration plus, if there is more than one slave, a bonding
1142 * If 'aux' is already registered then this function updates its configuration
1143 * to 's'. Otherwise, this function registers a new bundle.
1145 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1148 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
1149 const struct ofproto_bundle_settings
*s
)
1151 return (ofproto
->ofproto_class
->bundle_set
1152 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
1156 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1157 * If no such bundle has been registered, this has no effect. */
1159 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
1161 return ofproto_bundle_register(ofproto
, aux
, NULL
);
1165 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1166 * If 'aux' is already registered then this function updates its configuration
1167 * to 's'. Otherwise, this function registers a new mirror. */
1169 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
1170 const struct ofproto_mirror_settings
*s
)
1172 return (ofproto
->ofproto_class
->mirror_set
1173 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
1177 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1178 * If no mirror has been registered, this has no effect. */
1180 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
1182 return ofproto_mirror_register(ofproto
, aux
, NULL
);
1185 /* Retrieves statistics from mirror associated with client data pointer
1186 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1187 * 'bytes', respectively. If a particular counters is not supported,
1188 * the appropriate argument is set to UINT64_MAX. */
1190 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
1191 uint64_t *packets
, uint64_t *bytes
)
1193 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
1194 *packets
= *bytes
= UINT64_MAX
;
1198 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
1202 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1203 * which all packets are flooded, instead of using MAC learning. If
1204 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1206 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1209 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
1211 return (ofproto
->ofproto_class
->set_flood_vlans
1212 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
1216 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1217 * output for a mirror. */
1219 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
1221 return (ofproto
->ofproto_class
->is_mirror_output_bundle
1222 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
1226 /* Configuration of OpenFlow tables. */
1228 /* Returns the number of OpenFlow tables in 'ofproto'. */
1230 ofproto_get_n_tables(const struct ofproto
*ofproto
)
1232 return ofproto
->n_tables
;
1235 /* Returns the number of Controller visible OpenFlow tables
1236 * in 'ofproto'. This number will exclude Hidden tables.
1237 * This funtion's return value should be less or equal to that of
1238 * ofproto_get_n_tables() . */
1240 ofproto_get_n_visible_tables(const struct ofproto
*ofproto
)
1242 uint8_t n
= ofproto
->n_tables
;
1244 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1245 * if present, are always at the end.) */
1246 while(n
&& (ofproto
->tables
[n
- 1].flags
& OFTABLE_HIDDEN
)) {
1253 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1254 * settings from 's'. 'table_id' must be in the range 0 through the number of
1255 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1257 * For read-only tables, only the name may be configured. */
1259 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
1260 const struct ofproto_table_settings
*s
)
1262 struct oftable
*table
;
1264 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
1265 table
= &ofproto
->tables
[table_id
];
1267 oftable_set_name(table
, s
->name
);
1269 if (table
->flags
& OFTABLE_READONLY
) {
1274 oftable_enable_eviction(table
, s
->groups
, s
->n_groups
);
1276 oftable_disable_eviction(table
);
1279 table
->max_flows
= s
->max_flows
;
1281 if (classifier_set_prefix_fields(&table
->cls
,
1282 s
->prefix_fields
, s
->n_prefix_fields
)) {
1283 /* XXX: Trigger revalidation. */
1286 ovs_mutex_lock(&ofproto_mutex
);
1287 evict_rules_from_table(table
, 0);
1288 ovs_mutex_unlock(&ofproto_mutex
);
1292 ofproto_has_snoops(const struct ofproto
*ofproto
)
1294 return connmgr_has_snoops(ofproto
->connmgr
);
1298 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1300 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1304 ofproto_rule_delete__(struct rule
*rule
, uint8_t reason
)
1305 OVS_REQUIRES(ofproto_mutex
)
1307 struct rule_collection rules
;
1309 rules
.rules
= rules
.stub
;
1311 rules
.stub
[0] = rule
;
1312 delete_flows__(&rules
, reason
, NULL
);
1315 /* Deletes 'rule' from 'ofproto'.
1317 * Within an ofproto implementation, this function allows an ofproto
1318 * implementation to destroy any rules that remain when its ->destruct()
1319 * function is called. This function is not suitable for use elsewhere in an
1320 * ofproto implementation.
1322 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1323 * Cycle" in ofproto-provider.h. */
1325 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1326 OVS_EXCLUDED(ofproto_mutex
)
1328 /* This skips the ofmonitor and flow-removed notifications because the
1329 * switch is being deleted and any OpenFlow channels have been or soon will
1331 ovs_mutex_lock(&ofproto_mutex
);
1332 oftable_remove_rule__(ofproto
, rule
);
1333 ofproto
->ofproto_class
->rule_delete(rule
);
1334 ovs_mutex_unlock(&ofproto_mutex
);
1338 ofproto_flush__(struct ofproto
*ofproto
)
1339 OVS_EXCLUDED(ofproto_mutex
)
1341 struct oftable
*table
;
1343 if (ofproto
->ofproto_class
->flush
) {
1344 ofproto
->ofproto_class
->flush(ofproto
);
1347 ovs_mutex_lock(&ofproto_mutex
);
1348 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1351 if (table
->flags
& OFTABLE_HIDDEN
) {
1355 CLS_FOR_EACH_SAFE (rule
, cr
, &table
->cls
) {
1356 ofproto_rule_delete__(rule
, OFPRR_DELETE
);
1359 ovs_mutex_unlock(&ofproto_mutex
);
1362 static void delete_group(struct ofproto
*ofproto
, uint32_t group_id
);
1365 ofproto_destroy__(struct ofproto
*ofproto
)
1366 OVS_EXCLUDED(ofproto_mutex
)
1368 struct oftable
*table
;
1370 destroy_rule_executes(ofproto
);
1371 delete_group(ofproto
, OFPG_ALL
);
1373 guarded_list_destroy(&ofproto
->rule_executes
);
1374 ovs_rwlock_destroy(&ofproto
->groups_rwlock
);
1375 hmap_destroy(&ofproto
->groups
);
1377 connmgr_destroy(ofproto
->connmgr
);
1379 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1380 free(ofproto
->name
);
1381 free(ofproto
->type
);
1382 free(ofproto
->mfr_desc
);
1383 free(ofproto
->hw_desc
);
1384 free(ofproto
->sw_desc
);
1385 free(ofproto
->serial_desc
);
1386 free(ofproto
->dp_desc
);
1387 hmap_destroy(&ofproto
->ports
);
1388 hmap_destroy(&ofproto
->ofport_usage
);
1389 shash_destroy(&ofproto
->port_by_name
);
1390 simap_destroy(&ofproto
->ofp_requests
);
1392 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1393 oftable_destroy(table
);
1395 free(ofproto
->tables
);
1397 ovs_assert(hindex_is_empty(&ofproto
->cookies
));
1398 hindex_destroy(&ofproto
->cookies
);
1400 ovs_assert(hmap_is_empty(&ofproto
->learned_cookies
));
1401 hmap_destroy(&ofproto
->learned_cookies
);
1403 free(ofproto
->vlan_bitmap
);
1405 ofproto
->ofproto_class
->dealloc(ofproto
);
1409 ofproto_destroy(struct ofproto
*p
)
1410 OVS_EXCLUDED(ofproto_mutex
)
1412 struct ofport
*ofport
, *next_ofport
;
1413 struct ofport_usage
*usage
, *next_usage
;
1420 meter_delete(p
, 1, p
->meter_features
.max_meters
);
1421 p
->meter_features
.max_meters
= 0;
1427 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1428 ofport_destroy(ofport
);
1431 HMAP_FOR_EACH_SAFE (usage
, next_usage
, hmap_node
, &p
->ofport_usage
) {
1432 hmap_remove(&p
->ofport_usage
, &usage
->hmap_node
);
1436 p
->ofproto_class
->destruct(p
);
1437 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1438 ovsrcu_postpone(ofproto_destroy__
, p
);
1441 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1442 * kernel datapath, for example, this destroys the datapath in the kernel, and
1443 * with the netdev-based datapath, it tears down the data structures that
1444 * represent the datapath.
1446 * The datapath should not be currently open as an ofproto. */
1448 ofproto_delete(const char *name
, const char *type
)
1450 const struct ofproto_class
*class = ofproto_class_find__(type
);
1451 return (!class ? EAFNOSUPPORT
1452 : !class->del
? EACCES
1453 : class->del(type
, name
));
1457 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1459 if (error
== ENOBUFS
) {
1460 reinit_ports(ofproto
);
1461 } else if (!error
) {
1462 update_port(ofproto
, devname
);
1468 ofproto_type_run(const char *datapath_type
)
1470 const struct ofproto_class
*class;
1473 datapath_type
= ofproto_normalize_type(datapath_type
);
1474 class = ofproto_class_find__(datapath_type
);
1476 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1477 if (error
&& error
!= EAGAIN
) {
1478 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1479 datapath_type
, ovs_strerror(error
));
1485 ofproto_type_wait(const char *datapath_type
)
1487 const struct ofproto_class
*class;
1489 datapath_type
= ofproto_normalize_type(datapath_type
);
1490 class = ofproto_class_find__(datapath_type
);
1492 if (class->type_wait
) {
1493 class->type_wait(datapath_type
);
1498 ofproto_run(struct ofproto
*p
)
1503 error
= p
->ofproto_class
->run(p
);
1504 if (error
&& error
!= EAGAIN
) {
1505 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, ovs_strerror(error
));
1508 run_rule_executes(p
);
1510 /* Restore the eviction group heap invariant occasionally. */
1511 if (p
->eviction_group_timer
< time_msec()) {
1514 p
->eviction_group_timer
= time_msec() + 1000;
1516 for (i
= 0; i
< p
->n_tables
; i
++) {
1517 struct oftable
*table
= &p
->tables
[i
];
1518 struct eviction_group
*evg
;
1521 if (!table
->eviction_fields
) {
1525 ovs_mutex_lock(&ofproto_mutex
);
1526 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1527 if (rule
->idle_timeout
|| rule
->hard_timeout
) {
1528 if (!rule
->eviction_group
) {
1529 eviction_group_add_rule(rule
);
1531 heap_raw_change(&rule
->evg_node
,
1532 rule_eviction_priority(p
, rule
));
1537 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1538 heap_rebuild(&evg
->rules
);
1540 ovs_mutex_unlock(&ofproto_mutex
);
1544 if (p
->ofproto_class
->port_poll
) {
1547 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1548 process_port_change(p
, error
, devname
);
1552 new_seq
= seq_read(connectivity_seq_get());
1553 if (new_seq
!= p
->change_seq
) {
1554 struct sset devnames
;
1555 const char *devname
;
1556 struct ofport
*ofport
;
1558 /* Update OpenFlow port status for any port whose netdev has changed.
1560 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1561 * destroyed, so it's not safe to update ports directly from the
1562 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1563 * need this two-phase approach. */
1564 sset_init(&devnames
);
1565 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1566 uint64_t port_change_seq
;
1568 port_change_seq
= netdev_get_change_seq(ofport
->netdev
);
1569 if (ofport
->change_seq
!= port_change_seq
) {
1570 ofport
->change_seq
= port_change_seq
;
1571 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1574 SSET_FOR_EACH (devname
, &devnames
) {
1575 update_port(p
, devname
);
1577 sset_destroy(&devnames
);
1579 p
->change_seq
= new_seq
;
1582 connmgr_run(p
->connmgr
, handle_openflow
);
1588 ofproto_wait(struct ofproto
*p
)
1590 p
->ofproto_class
->wait(p
);
1591 if (p
->ofproto_class
->port_poll_wait
) {
1592 p
->ofproto_class
->port_poll_wait(p
);
1594 seq_wait(connectivity_seq_get(), p
->change_seq
);
1595 connmgr_wait(p
->connmgr
);
1599 ofproto_is_alive(const struct ofproto
*p
)
1601 return connmgr_has_controllers(p
->connmgr
);
1604 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1605 * memory_report(). */
1607 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1609 const struct oftable
*table
;
1610 unsigned int n_rules
;
1612 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1615 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1616 n_rules
+= classifier_count(&table
->cls
);
1618 simap_increase(usage
, "rules", n_rules
);
1620 if (ofproto
->ofproto_class
->get_memory_usage
) {
1621 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1624 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1628 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1630 const struct ofproto_class
*class;
1632 datapath_type
= ofproto_normalize_type(datapath_type
);
1633 class = ofproto_class_find__(datapath_type
);
1635 if (class && class->type_get_memory_usage
) {
1636 class->type_get_memory_usage(datapath_type
, usage
);
1641 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1644 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1648 ofproto_free_ofproto_controller_info(struct shash
*info
)
1650 connmgr_free_controller_info(info
);
1653 /* Makes a deep copy of 'old' into 'port'. */
1655 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1657 port
->name
= xstrdup(old
->name
);
1658 port
->type
= xstrdup(old
->type
);
1659 port
->ofp_port
= old
->ofp_port
;
1662 /* Frees memory allocated to members of 'ofproto_port'.
1664 * Do not call this function on an ofproto_port obtained from
1665 * ofproto_port_dump_next(): that function retains ownership of the data in the
1668 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1670 free(ofproto_port
->name
);
1671 free(ofproto_port
->type
);
1674 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1676 * This function provides no status indication. An error status for the entire
1677 * dump operation is provided when it is completed by calling
1678 * ofproto_port_dump_done().
1681 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1682 const struct ofproto
*ofproto
)
1684 dump
->ofproto
= ofproto
;
1685 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1689 /* Attempts to retrieve another port from 'dump', which must have been created
1690 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1691 * 'port' and returns true. On failure, returns false.
1693 * Failure might indicate an actual error or merely that the last port has been
1694 * dumped. An error status for the entire dump operation is provided when it
1695 * is completed by calling ofproto_port_dump_done().
1697 * The ofproto owns the data stored in 'port'. It will remain valid until at
1698 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1699 * ofproto_port_dump_done(). */
1701 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1702 struct ofproto_port
*port
)
1704 const struct ofproto
*ofproto
= dump
->ofproto
;
1710 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1713 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1719 /* Completes port table dump operation 'dump', which must have been created
1720 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1721 * error-free, otherwise a positive errno value describing the problem. */
1723 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1725 const struct ofproto
*ofproto
= dump
->ofproto
;
1727 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1730 return dump
->error
== EOF
? 0 : dump
->error
;
1733 /* Returns the type to pass to netdev_open() when a datapath of type
1734 * 'datapath_type' has a port of type 'port_type', for a few special
1735 * cases when a netdev type differs from a port type. For example, when
1736 * using the userspace datapath, a port of type "internal" needs to be
1739 * Returns either 'type' itself or a string literal, which must not be
1742 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1744 const struct ofproto_class
*class;
1746 datapath_type
= ofproto_normalize_type(datapath_type
);
1747 class = ofproto_class_find__(datapath_type
);
1752 return (class->port_open_type
1753 ? class->port_open_type(datapath_type
, port_type
)
1757 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1758 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1759 * the port's OpenFlow port number.
1761 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1762 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1763 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1764 * 'ofp_portp' is non-null). */
1766 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1767 ofp_port_t
*ofp_portp
)
1769 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1772 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1774 const char *netdev_name
= netdev_get_name(netdev
);
1776 simap_put(&ofproto
->ofp_requests
, netdev_name
,
1777 ofp_to_u16(ofp_port
));
1778 update_port(ofproto
, netdev_name
);
1781 *ofp_portp
= OFPP_NONE
;
1783 struct ofproto_port ofproto_port
;
1785 error
= ofproto_port_query_by_name(ofproto
,
1786 netdev_get_name(netdev
),
1789 *ofp_portp
= ofproto_port
.ofp_port
;
1790 ofproto_port_destroy(&ofproto_port
);
1797 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1798 * initializes '*port' appropriately; on failure, returns a positive errno
1801 * The caller owns the data in 'ofproto_port' and must free it with
1802 * ofproto_port_destroy() when it is no longer needed. */
1804 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1805 struct ofproto_port
*port
)
1809 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1811 memset(port
, 0, sizeof *port
);
1816 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1817 * Returns 0 if successful, otherwise a positive errno. */
1819 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1821 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1822 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
1823 struct simap_node
*ofp_request_node
;
1826 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
1827 if (ofp_request_node
) {
1828 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
1831 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
1832 if (!error
&& ofport
) {
1833 /* 'name' is the netdev's name and update_port() is going to close the
1834 * netdev. Just in case update_port() refers to 'name' after it
1835 * destroys 'ofport', make a copy of it around the update_port()
1837 char *devname
= xstrdup(name
);
1838 update_port(ofproto
, devname
);
1845 flow_mod_init(struct ofputil_flow_mod
*fm
,
1846 const struct match
*match
, unsigned int priority
,
1847 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1848 enum ofp_flow_mod_command command
)
1850 memset(fm
, 0, sizeof *fm
);
1852 fm
->priority
= priority
;
1855 fm
->modify_cookie
= false;
1857 fm
->command
= command
;
1858 fm
->idle_timeout
= 0;
1859 fm
->hard_timeout
= 0;
1860 fm
->buffer_id
= UINT32_MAX
;
1861 fm
->out_port
= OFPP_ANY
;
1862 fm
->out_group
= OFPG_ANY
;
1864 fm
->ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
);
1865 fm
->ofpacts_len
= ofpacts_len
;
1866 fm
->delete_reason
= OFPRR_DELETE
;
1870 simple_flow_mod(struct ofproto
*ofproto
,
1871 const struct match
*match
, unsigned int priority
,
1872 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1873 enum ofp_flow_mod_command command
)
1875 struct ofputil_flow_mod fm
;
1877 flow_mod_init(&fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
1879 return handle_flow_mod__(ofproto
, &fm
, NULL
);
1882 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1883 * performs the 'n_actions' actions in 'actions'. The new flow will not
1886 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1887 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1888 * controllers; otherwise, it will be hidden.
1890 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1892 * This is a helper function for in-band control and fail-open. */
1894 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
1895 unsigned int priority
,
1896 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1897 OVS_EXCLUDED(ofproto_mutex
)
1899 const struct rule
*rule
;
1902 /* First do a cheap check whether the rule we're looking for already exists
1903 * with the actions that we want. If it does, then we're done. */
1904 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1905 &ofproto
->tables
[0].cls
, match
, priority
));
1907 const struct rule_actions
*actions
= rule_get_actions(rule
);
1908 must_add
= !ofpacts_equal(actions
->ofpacts
, actions
->ofpacts_len
,
1909 ofpacts
, ofpacts_len
);
1914 /* If there's no such rule or the rule doesn't have the actions we want,
1915 * fall back to a executing a full flow mod. We can't optimize this at
1916 * all because we didn't take enough locks above to ensure that the flow
1917 * table didn't already change beneath us. */
1919 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
1920 OFPFC_MODIFY_STRICT
);
1924 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1925 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1926 * operation cannot be initiated now but may be retried later.
1928 * This is a helper function for in-band control and fail-open and the "learn"
1931 ofproto_flow_mod(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
)
1932 OVS_EXCLUDED(ofproto_mutex
)
1934 /* Optimize for the most common case of a repeated learn action.
1935 * If an identical flow already exists we only need to update its
1936 * 'modified' time. */
1937 if (fm
->command
== OFPFC_MODIFY_STRICT
&& fm
->table_id
!= OFPTT_ALL
1938 && !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
)) {
1939 struct oftable
*table
= &ofproto
->tables
[fm
->table_id
];
1943 rule
= rule_from_cls_rule(classifier_find_match_exactly(&table
->cls
,
1947 /* Reading many of the rule fields and writing on 'modified'
1948 * requires the rule->mutex. Also, rule->actions may change
1949 * if rule->mutex is not held. */
1950 const struct rule_actions
*actions
;
1952 ovs_mutex_lock(&rule
->mutex
);
1953 actions
= rule_get_actions(rule
);
1954 if (rule
->idle_timeout
== fm
->idle_timeout
1955 && rule
->hard_timeout
== fm
->hard_timeout
1956 && rule
->flags
== (fm
->flags
& OFPUTIL_FF_STATE
)
1957 && (!fm
->modify_cookie
|| (fm
->new_cookie
== rule
->flow_cookie
))
1958 && ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
1959 actions
->ofpacts
, actions
->ofpacts_len
)) {
1960 /* Rule already exists and need not change, only update the
1961 modified timestamp. */
1962 rule
->modified
= time_msec();
1965 ovs_mutex_unlock(&rule
->mutex
);
1973 return handle_flow_mod__(ofproto
, fm
, NULL
);
1976 /* Searches for a rule with matching criteria exactly equal to 'target' in
1977 * ofproto's table 0 and, if it finds one, deletes it.
1979 * This is a helper function for in-band control and fail-open. */
1981 ofproto_delete_flow(struct ofproto
*ofproto
,
1982 const struct match
*target
, unsigned int priority
)
1983 OVS_EXCLUDED(ofproto_mutex
)
1985 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
1988 /* First do a cheap check whether the rule we're looking for has already
1989 * been deleted. If so, then we're done. */
1990 rule
= rule_from_cls_rule(classifier_find_match_exactly(cls
, target
,
1996 /* Execute a flow mod. We can't optimize this at all because we didn't
1997 * take enough locks above to ensure that the flow table didn't already
1998 * change beneath us. */
1999 simple_flow_mod(ofproto
, target
, priority
, NULL
, 0, OFPFC_DELETE_STRICT
);
2002 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2003 * the flows required by in-band control and fail-open. */
2005 ofproto_flush_flows(struct ofproto
*ofproto
)
2007 COVERAGE_INC(ofproto_flush
);
2008 ofproto_flush__(ofproto
);
2009 connmgr_flushed(ofproto
->connmgr
);
2013 reinit_ports(struct ofproto
*p
)
2015 struct ofproto_port_dump dump
;
2016 struct sset devnames
;
2017 struct ofport
*ofport
;
2018 struct ofproto_port ofproto_port
;
2019 const char *devname
;
2021 COVERAGE_INC(ofproto_reinit_ports
);
2023 sset_init(&devnames
);
2024 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2025 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
2027 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2028 sset_add(&devnames
, ofproto_port
.name
);
2031 SSET_FOR_EACH (devname
, &devnames
) {
2032 update_port(p
, devname
);
2034 sset_destroy(&devnames
);
2038 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2042 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2043 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2045 if (port_idx
>= ofproto
->max_ports
2046 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2047 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2048 long long int last_used_at
, lru
= LLONG_MAX
;
2050 /* Search for a free OpenFlow port number. We try not to
2051 * immediately reuse them to prevent problems due to old
2054 * We limit the automatically assigned port numbers to the lower half
2055 * of the port range, to reserve the upper half for assignment by
2058 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2059 ofproto
->alloc_port_no
= 1;
2061 last_used_at
= ofport_get_usage(ofproto
,
2062 u16_to_ofp(ofproto
->alloc_port_no
));
2063 if (!last_used_at
) {
2064 port_idx
= ofproto
->alloc_port_no
;
2066 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2067 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2068 * more than an hour ago, consider it usable. */
2069 ofport_remove_usage(ofproto
,
2070 u16_to_ofp(ofproto
->alloc_port_no
));
2071 port_idx
= ofproto
->alloc_port_no
;
2073 } else if (last_used_at
< lru
) {
2075 lru_ofport
= ofproto
->alloc_port_no
;
2078 if (ofproto
->alloc_port_no
== end_port_no
) {
2080 port_idx
= lru_ofport
;
2087 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2088 return u16_to_ofp(port_idx
);
2092 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2094 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2095 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2099 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2100 * pointer if the netdev cannot be opened. On success, also fills in
2102 static struct netdev
*
2103 ofport_open(struct ofproto
*ofproto
,
2104 struct ofproto_port
*ofproto_port
,
2105 struct ofputil_phy_port
*pp
)
2107 enum netdev_flags flags
;
2108 struct netdev
*netdev
;
2111 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2113 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
2114 "cannot be opened (%s)",
2116 ofproto_port
->name
, ofproto_port
->ofp_port
,
2117 ofproto_port
->name
, ovs_strerror(error
));
2121 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2122 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2123 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2125 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2126 ofproto_port
->name
);
2129 pp
->port_no
= ofproto_port
->ofp_port
;
2130 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
2131 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2132 netdev_get_flags(netdev
, &flags
);
2133 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2134 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2135 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2136 &pp
->supported
, &pp
->peer
);
2137 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2138 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2143 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2144 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2147 ofport_equal(const struct ofputil_phy_port
*a
,
2148 const struct ofputil_phy_port
*b
)
2150 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2151 && a
->state
== b
->state
2152 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2153 && a
->curr
== b
->curr
2154 && a
->advertised
== b
->advertised
2155 && a
->supported
== b
->supported
2156 && a
->peer
== b
->peer
2157 && a
->curr_speed
== b
->curr_speed
2158 && a
->max_speed
== b
->max_speed
);
2161 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2162 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2163 * one with the same name or port number). */
2165 ofport_install(struct ofproto
*p
,
2166 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2168 const char *netdev_name
= netdev_get_name(netdev
);
2169 struct ofport
*ofport
;
2172 /* Create ofport. */
2173 ofport
= p
->ofproto_class
->port_alloc();
2178 ofport
->ofproto
= p
;
2179 ofport
->netdev
= netdev
;
2180 ofport
->change_seq
= netdev_get_change_seq(netdev
);
2182 ofport
->ofp_port
= pp
->port_no
;
2183 ofport
->created
= time_msec();
2185 /* Add port to 'p'. */
2186 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2187 hash_ofp_port(ofport
->ofp_port
));
2188 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2190 update_mtu(p
, ofport
);
2192 /* Let the ofproto_class initialize its private data. */
2193 error
= p
->ofproto_class
->port_construct(ofport
);
2197 connmgr_send_port_status(p
->connmgr
, NULL
, pp
, OFPPR_ADD
);
2201 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2202 p
->name
, netdev_name
, ovs_strerror(error
));
2204 ofport_destroy__(ofport
);
2206 netdev_close(netdev
);
2210 /* Removes 'ofport' from 'p' and destroys it. */
2212 ofport_remove(struct ofport
*ofport
)
2214 connmgr_send_port_status(ofport
->ofproto
->connmgr
, NULL
, &ofport
->pp
,
2216 ofport_destroy(ofport
);
2219 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2222 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2224 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2226 ofport_remove(port
);
2230 /* Updates 'port' with new 'pp' description.
2232 * Does not handle a name or port number change. The caller must implement
2233 * such a change as a delete followed by an add. */
2235 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2237 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
2238 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2239 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2240 port
->pp
.state
= ((port
->pp
.state
& ~OFPUTIL_PS_LINK_DOWN
)
2241 | (pp
->state
& OFPUTIL_PS_LINK_DOWN
));
2242 port
->pp
.curr
= pp
->curr
;
2243 port
->pp
.advertised
= pp
->advertised
;
2244 port
->pp
.supported
= pp
->supported
;
2245 port
->pp
.peer
= pp
->peer
;
2246 port
->pp
.curr_speed
= pp
->curr_speed
;
2247 port
->pp
.max_speed
= pp
->max_speed
;
2249 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2250 &port
->pp
, OFPPR_MODIFY
);
2253 /* Update OpenFlow 'state' in 'port' and notify controller. */
2255 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2257 if (port
->pp
.state
!= state
) {
2258 port
->pp
.state
= state
;
2259 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2260 &port
->pp
, OFPPR_MODIFY
);
2265 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2267 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2269 if (port
->ofproto
->ofproto_class
->set_realdev
) {
2270 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
2272 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2273 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2275 if (port
->ofproto
->ofproto_class
->set_rstp_port
) {
2276 port
->ofproto
->ofproto_class
->set_rstp_port(port
, NULL
);
2278 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2279 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2281 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2282 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2288 ofport_destroy__(struct ofport
*port
)
2290 struct ofproto
*ofproto
= port
->ofproto
;
2291 const char *name
= netdev_get_name(port
->netdev
);
2293 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2294 shash_delete(&ofproto
->port_by_name
,
2295 shash_find(&ofproto
->port_by_name
, name
));
2297 netdev_close(port
->netdev
);
2298 ofproto
->ofproto_class
->port_dealloc(port
);
2302 ofport_destroy(struct ofport
*port
)
2305 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2306 port
->ofproto
->ofproto_class
->port_destruct(port
);
2307 ofport_destroy__(port
);
2312 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2314 struct ofport
*port
;
2316 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2318 if (port
->ofp_port
== ofp_port
) {
2325 static long long int
2326 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2328 struct ofport_usage
*usage
;
2330 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2331 &ofproto
->ofport_usage
) {
2332 if (usage
->ofp_port
== ofp_port
) {
2333 return usage
->last_used
;
2340 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2341 long long int last_used
)
2343 struct ofport_usage
*usage
;
2344 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2345 &ofproto
->ofport_usage
) {
2346 if (usage
->ofp_port
== ofp_port
) {
2347 usage
->last_used
= last_used
;
2351 ovs_assert(last_used
== LLONG_MAX
);
2353 usage
= xmalloc(sizeof *usage
);
2354 usage
->ofp_port
= ofp_port
;
2355 usage
->last_used
= last_used
;
2356 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2357 hash_ofp_port(ofp_port
));
2361 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2363 struct ofport_usage
*usage
;
2364 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2365 &ofproto
->ofport_usage
) {
2366 if (usage
->ofp_port
== ofp_port
) {
2367 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2375 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2377 struct ofproto
*ofproto
= port
->ofproto
;
2380 if (ofproto
->ofproto_class
->port_get_stats
) {
2381 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2390 update_port(struct ofproto
*ofproto
, const char *name
)
2392 struct ofproto_port ofproto_port
;
2393 struct ofputil_phy_port pp
;
2394 struct netdev
*netdev
;
2395 struct ofport
*port
;
2397 COVERAGE_INC(ofproto_update_port
);
2399 /* Fetch 'name''s location and properties from the datapath. */
2400 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2401 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2405 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2406 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2407 struct netdev
*old_netdev
= port
->netdev
;
2409 /* 'name' hasn't changed location. Any properties changed? */
2410 if (!ofport_equal(&port
->pp
, &pp
)) {
2411 ofport_modified(port
, &pp
);
2414 update_mtu(ofproto
, port
);
2416 /* Install the newly opened netdev in case it has changed.
2417 * Don't close the old netdev yet in case port_modified has to
2418 * remove a retained reference to it.*/
2419 port
->netdev
= netdev
;
2420 port
->change_seq
= netdev_get_change_seq(netdev
);
2422 if (port
->ofproto
->ofproto_class
->port_modified
) {
2423 port
->ofproto
->ofproto_class
->port_modified(port
);
2426 netdev_close(old_netdev
);
2428 /* If 'port' is nonnull then its name differs from 'name' and thus
2429 * we should delete it. If we think there's a port named 'name'
2430 * then its port number must be wrong now so delete it too. */
2432 ofport_remove(port
);
2434 ofport_remove_with_name(ofproto
, name
);
2435 ofport_install(ofproto
, netdev
, &pp
);
2438 /* Any port named 'name' is gone now. */
2439 ofport_remove_with_name(ofproto
, name
);
2441 ofproto_port_destroy(&ofproto_port
);
2445 init_ports(struct ofproto
*p
)
2447 struct ofproto_port_dump dump
;
2448 struct ofproto_port ofproto_port
;
2449 struct shash_node
*node
, *next
;
2451 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2452 const char *name
= ofproto_port
.name
;
2454 if (shash_find(&p
->port_by_name
, name
)) {
2455 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2458 struct ofputil_phy_port pp
;
2459 struct netdev
*netdev
;
2461 /* Check if an OpenFlow port number had been requested. */
2462 node
= shash_find(&init_ofp_ports
, name
);
2464 const struct iface_hint
*iface_hint
= node
->data
;
2465 simap_put(&p
->ofp_requests
, name
,
2466 ofp_to_u16(iface_hint
->ofp_port
));
2469 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2471 ofport_install(p
, netdev
, &pp
);
2472 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2473 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2474 ofp_to_u16(ofproto_port
.ofp_port
));
2480 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2481 struct iface_hint
*iface_hint
= node
->data
;
2483 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2484 free(iface_hint
->br_name
);
2485 free(iface_hint
->br_type
);
2487 shash_delete(&init_ofp_ports
, node
);
2494 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2495 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2497 find_min_mtu(struct ofproto
*p
)
2499 struct ofport
*ofport
;
2502 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2503 struct netdev
*netdev
= ofport
->netdev
;
2506 /* Skip any internal ports, since that's what we're trying to
2508 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2512 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2515 if (!mtu
|| dev_mtu
< mtu
) {
2520 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2523 /* Update MTU of all datapath devices on 'p' to the minimum of the
2524 * non-datapath ports in event of 'port' added or changed. */
2526 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2528 struct ofport
*ofport
;
2529 struct netdev
*netdev
= port
->netdev
;
2530 int dev_mtu
, old_min
;
2532 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2536 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2537 if (dev_mtu
> p
->min_mtu
) {
2538 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2539 dev_mtu
= p
->min_mtu
;
2542 port
->mtu
= dev_mtu
;
2546 /* For non-internal port find new min mtu. */
2547 old_min
= p
->min_mtu
;
2548 port
->mtu
= dev_mtu
;
2549 p
->min_mtu
= find_min_mtu(p
);
2550 if (p
->min_mtu
== old_min
) {
2554 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2555 struct netdev
*netdev
= ofport
->netdev
;
2557 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2558 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2559 ofport
->mtu
= p
->min_mtu
;
2566 ofproto_rule_destroy__(struct rule
*rule
)
2567 OVS_NO_THREAD_SAFETY_ANALYSIS
2569 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2570 rule_actions_destroy(rule_get_actions(rule
));
2571 ovs_mutex_destroy(&rule
->mutex
);
2572 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2576 rule_destroy_cb(struct rule
*rule
)
2578 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2579 ofproto_rule_destroy__(rule
);
2583 ofproto_rule_ref(struct rule
*rule
)
2586 ovs_refcount_ref(&rule
->ref_count
);
2591 ofproto_rule_try_ref(struct rule
*rule
)
2594 return ovs_refcount_try_ref_rcu(&rule
->ref_count
);
2599 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2600 * ref_count reaches 0.
2602 * Use of RCU allows short term use (between RCU quiescent periods) without
2603 * keeping a reference. A reference must be taken if the rule needs to
2604 * stay around accross the RCU quiescent periods. */
2606 ofproto_rule_unref(struct rule
*rule
)
2608 if (rule
&& ovs_refcount_unref_relaxed(&rule
->ref_count
) == 1) {
2609 ovsrcu_postpone(rule_destroy_cb
, rule
);
2614 ofproto_group_ref(struct ofgroup
*group
)
2617 ovs_refcount_ref(&group
->ref_count
);
2622 ofproto_group_unref(struct ofgroup
*group
)
2624 if (group
&& ovs_refcount_unref(&group
->ref_count
) == 1) {
2625 group
->ofproto
->ofproto_class
->group_destruct(group
);
2626 ofputil_bucket_list_destroy(&group
->buckets
);
2627 group
->ofproto
->ofproto_class
->group_dealloc(group
);
2631 static uint32_t get_provider_meter_id(const struct ofproto
*,
2632 uint32_t of_meter_id
);
2634 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2635 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2636 const struct rule_actions
*
2637 rule_actions_create(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2639 struct rule_actions
*actions
;
2641 actions
= xmalloc(sizeof *actions
+ ofpacts_len
);
2642 actions
->ofpacts_len
= ofpacts_len
;
2643 actions
->has_meter
= ofpacts_get_meter(ofpacts
, ofpacts_len
) != 0;
2644 memcpy(actions
->ofpacts
, ofpacts
, ofpacts_len
);
2646 actions
->has_learn_with_delete
= (next_learn_with_delete(actions
, NULL
)
2652 /* Free the actions after the RCU quiescent period is reached. */
2654 rule_actions_destroy(const struct rule_actions
*actions
)
2657 ovsrcu_postpone(free
, CONST_CAST(struct rule_actions
*, actions
));
2661 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2662 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2664 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2665 OVS_REQUIRES(ofproto_mutex
)
2667 if (port
== OFPP_ANY
) {
2670 const struct rule_actions
*actions
= rule_get_actions(rule
);
2671 return ofpacts_output_to_port(actions
->ofpacts
,
2672 actions
->ofpacts_len
, port
);
2676 /* Returns true if 'rule' has group and equals group_id. */
2678 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
2679 OVS_REQUIRES(ofproto_mutex
)
2681 if (group_id
== OFPG_ANY
) {
2684 const struct rule_actions
*actions
= rule_get_actions(rule
);
2685 return ofpacts_output_to_group(actions
->ofpacts
,
2686 actions
->ofpacts_len
, group_id
);
2691 rule_execute_destroy(struct rule_execute
*e
)
2693 ofproto_rule_unref(e
->rule
);
2694 list_remove(&e
->list_node
);
2698 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2699 * by passing them to the ofproto provider. */
2701 run_rule_executes(struct ofproto
*ofproto
)
2702 OVS_EXCLUDED(ofproto_mutex
)
2704 struct rule_execute
*e
, *next
;
2705 struct list executes
;
2707 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2708 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2711 flow_extract(e
->packet
, NULL
, &flow
);
2712 flow
.in_port
.ofp_port
= e
->in_port
;
2713 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
2715 rule_execute_destroy(e
);
2719 /* Destroys and discards all "rule_execute" operations queued up in
2720 * ofproto->rule_executes. */
2722 destroy_rule_executes(struct ofproto
*ofproto
)
2724 struct rule_execute
*e
, *next
;
2725 struct list executes
;
2727 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2728 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2729 ofpbuf_delete(e
->packet
);
2730 rule_execute_destroy(e
);
2735 rule_is_readonly(const struct rule
*rule
)
2737 const struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
2738 return (table
->flags
& OFTABLE_READONLY
) != 0;
2742 hash_learned_cookie(ovs_be64 cookie_
, uint8_t table_id
)
2744 uint64_t cookie
= (OVS_FORCE
uint64_t) cookie_
;
2745 return hash_3words(cookie
, cookie
>> 32, table_id
);
2749 learned_cookies_update_one__(struct ofproto
*ofproto
,
2750 const struct ofpact_learn
*learn
,
2751 int delta
, struct list
*dead_cookies
)
2752 OVS_REQUIRES(ofproto_mutex
)
2754 uint32_t hash
= hash_learned_cookie(learn
->cookie
, learn
->table_id
);
2755 struct learned_cookie
*c
;
2757 HMAP_FOR_EACH_WITH_HASH (c
, u
.hmap_node
, hash
, &ofproto
->learned_cookies
) {
2758 if (c
->cookie
== learn
->cookie
&& c
->table_id
== learn
->table_id
) {
2760 ovs_assert(c
->n
>= 0);
2763 hmap_remove(&ofproto
->learned_cookies
, &c
->u
.hmap_node
);
2764 list_push_back(dead_cookies
, &c
->u
.list_node
);
2771 ovs_assert(delta
> 0);
2772 c
= xmalloc(sizeof *c
);
2773 hmap_insert(&ofproto
->learned_cookies
, &c
->u
.hmap_node
, hash
);
2774 c
->cookie
= learn
->cookie
;
2775 c
->table_id
= learn
->table_id
;
2779 static const struct ofpact_learn
*
2780 next_learn_with_delete(const struct rule_actions
*actions
,
2781 const struct ofpact_learn
*start
)
2783 const struct ofpact
*pos
;
2785 for (pos
= start
? ofpact_next(&start
->ofpact
) : actions
->ofpacts
;
2786 pos
< ofpact_end(actions
->ofpacts
, actions
->ofpacts_len
);
2787 pos
= ofpact_next(pos
)) {
2788 if (pos
->type
== OFPACT_LEARN
) {
2789 const struct ofpact_learn
*learn
= ofpact_get_LEARN(pos
);
2790 if (learn
->flags
& NX_LEARN_F_DELETE_LEARNED
) {
2800 learned_cookies_update__(struct ofproto
*ofproto
,
2801 const struct rule_actions
*actions
,
2802 int delta
, struct list
*dead_cookies
)
2803 OVS_REQUIRES(ofproto_mutex
)
2805 if (actions
->has_learn_with_delete
) {
2806 const struct ofpact_learn
*learn
;
2808 for (learn
= next_learn_with_delete(actions
, NULL
); learn
;
2809 learn
= next_learn_with_delete(actions
, learn
)) {
2810 learned_cookies_update_one__(ofproto
, learn
, delta
, dead_cookies
);
2816 learned_cookies_inc(struct ofproto
*ofproto
,
2817 const struct rule_actions
*actions
)
2818 OVS_REQUIRES(ofproto_mutex
)
2820 learned_cookies_update__(ofproto
, actions
, +1, NULL
);
2824 learned_cookies_dec(struct ofproto
*ofproto
,
2825 const struct rule_actions
*actions
,
2826 struct list
*dead_cookies
)
2827 OVS_REQUIRES(ofproto_mutex
)
2829 learned_cookies_update__(ofproto
, actions
, -1, dead_cookies
);
2833 learned_cookies_flush(struct ofproto
*ofproto
, struct list
*dead_cookies
)
2834 OVS_REQUIRES(ofproto_mutex
)
2836 struct learned_cookie
*c
, *next
;
2838 LIST_FOR_EACH_SAFE (c
, next
, u
.list_node
, dead_cookies
) {
2839 struct rule_criteria criteria
;
2840 struct rule_collection rules
;
2843 match_init_catchall(&match
);
2844 rule_criteria_init(&criteria
, c
->table_id
, &match
, 0,
2845 c
->cookie
, OVS_BE64_MAX
, OFPP_ANY
, OFPG_ANY
);
2846 rule_criteria_require_rw(&criteria
, false);
2847 collect_rules_loose(ofproto
, &criteria
, &rules
);
2848 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
2849 rule_criteria_destroy(&criteria
);
2850 rule_collection_destroy(&rules
);
2852 list_remove(&c
->u
.list_node
);
2858 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2860 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
2865 query_tables(struct ofproto
*ofproto
,
2866 struct ofputil_table_features
**featuresp
,
2867 struct ofputil_table_stats
**statsp
)
2869 struct mf_bitmap rw_fields
= MF_BITMAP_INITIALIZER
;
2870 struct mf_bitmap match
= MF_BITMAP_INITIALIZER
;
2871 struct mf_bitmap mask
= MF_BITMAP_INITIALIZER
;
2873 struct ofputil_table_features
*features
;
2874 struct ofputil_table_stats
*stats
;
2877 for (i
= 0; i
< MFF_N_IDS
; i
++) {
2878 const struct mf_field
*mf
= mf_from_id(i
);
2881 bitmap_set1(rw_fields
.bm
, i
);
2883 if (mf
->oxm_header
|| mf
->nxm_header
) {
2884 bitmap_set1(match
.bm
, i
);
2885 if (mf
->maskable
== MFM_FULLY
) {
2886 bitmap_set1(mask
.bm
, i
);
2891 features
= *featuresp
= xcalloc(ofproto
->n_tables
, sizeof *features
);
2892 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2893 struct ofputil_table_features
*f
= &features
[i
];
2896 sprintf(f
->name
, "table%d", i
);
2897 f
->metadata_match
= OVS_BE64_MAX
;
2898 f
->metadata_write
= OVS_BE64_MAX
;
2899 atomic_read_relaxed(&ofproto
->tables
[i
].miss_config
, &f
->miss_config
);
2900 f
->max_entries
= 1000000;
2902 bitmap_set_multiple(f
->nonmiss
.next
, i
+ 1,
2903 ofproto
->n_tables
- (i
+ 1), true);
2904 f
->nonmiss
.instructions
= (1u << N_OVS_INSTRUCTIONS
) - 1;
2905 if (i
== ofproto
->n_tables
- 1) {
2906 f
->nonmiss
.instructions
&= ~(1u << OVSINST_OFPIT11_GOTO_TABLE
);
2908 f
->nonmiss
.write
.ofpacts
= (UINT64_C(1) << N_OFPACTS
) - 1;
2909 f
->nonmiss
.write
.set_fields
= rw_fields
;
2910 f
->nonmiss
.apply
= f
->nonmiss
.write
;
2911 f
->miss
= f
->nonmiss
;
2915 f
->wildcard
= match
;
2919 stats
= *statsp
= xcalloc(ofproto
->n_tables
, sizeof *stats
);
2920 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2921 struct ofputil_table_stats
*s
= &stats
[i
];
2922 struct classifier
*cls
= &ofproto
->tables
[i
].cls
;
2925 s
->active_count
= classifier_count(cls
);
2931 ofproto
->ofproto_class
->query_tables(ofproto
, features
, stats
);
2933 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2934 const struct oftable
*table
= &ofproto
->tables
[i
];
2935 struct ofputil_table_features
*f
= &features
[i
];
2938 ovs_strzcpy(f
->name
, table
->name
, sizeof f
->name
);
2941 if (table
->max_flows
< f
->max_entries
) {
2942 f
->max_entries
= table
->max_flows
;
2948 query_switch_features(struct ofproto
*ofproto
,
2949 bool *arp_match_ip
, uint64_t *ofpacts
)
2951 struct ofputil_table_features
*features
, *f
;
2953 *arp_match_ip
= false;
2956 query_tables(ofproto
, &features
, NULL
);
2957 for (f
= features
; f
< &features
[ofproto
->n_tables
]; f
++) {
2958 *ofpacts
|= f
->nonmiss
.apply
.ofpacts
| f
->miss
.apply
.ofpacts
;
2959 if (bitmap_is_set(f
->match
.bm
, MFF_ARP_SPA
) ||
2960 bitmap_is_set(f
->match
.bm
, MFF_ARP_TPA
)) {
2961 *arp_match_ip
= true;
2967 ovs_assert(*ofpacts
& (UINT64_C(1) << OFPACT_OUTPUT
));
2971 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2973 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
2974 struct ofputil_switch_features features
;
2975 struct ofport
*port
;
2979 query_switch_features(ofproto
, &arp_match_ip
, &features
.ofpacts
);
2981 features
.datapath_id
= ofproto
->datapath_id
;
2982 features
.n_buffers
= pktbuf_capacity();
2983 features
.n_tables
= ofproto_get_n_visible_tables(ofproto
);
2984 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
2985 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
);
2987 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
2989 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
2990 features
.auxiliary_id
= 0;
2991 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
2993 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
2994 ofputil_put_switch_features_port(&port
->pp
, b
);
2997 ofconn_send_reply(ofconn
, b
);
3002 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3004 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3005 struct ofp_switch_config
*osc
;
3006 enum ofp_config_flags flags
;
3010 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
3011 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
3012 flags
= ofproto
->frag_handling
;
3013 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3014 if (oh
->version
< OFP13_VERSION
3015 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
3016 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
3018 osc
->flags
= htons(flags
);
3019 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
3020 ofconn_send_reply(ofconn
, buf
);
3026 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3028 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
3029 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3030 uint16_t flags
= ntohs(osc
->flags
);
3032 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
3033 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
3034 enum ofp_config_flags cur
= ofproto
->frag_handling
;
3035 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
3037 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
3039 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
3040 ofproto
->frag_handling
= next
;
3042 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
3044 ofputil_frag_handling_to_string(next
));
3048 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3049 ofconn_set_invalid_ttl_to_controller(ofconn
,
3050 (oh
->version
< OFP13_VERSION
3051 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
3053 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
3058 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3059 * error message code for the caller to propagate upward. Otherwise, returns
3062 * The log message mentions 'msg_type'. */
3064 reject_slave_controller(struct ofconn
*ofconn
)
3066 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
3067 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
3068 return OFPERR_OFPBRC_EPERM
;
3074 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3077 * - If they use a meter, then 'ofproto' has that meter configured.
3079 * - If they use any groups, then 'ofproto' has that group configured.
3081 * Returns 0 if successful, otherwise an OpenFlow error. */
3083 ofproto_check_ofpacts(struct ofproto
*ofproto
,
3084 const struct ofpact ofpacts
[], size_t ofpacts_len
)
3086 const struct ofpact
*a
;
3089 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
3090 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
3091 return OFPERR_OFPMMFC_INVALID_METER
;
3094 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3095 if (a
->type
== OFPACT_GROUP
3096 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
3097 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
3105 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3107 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3108 struct ofputil_packet_out po
;
3109 struct ofpbuf
*payload
;
3110 uint64_t ofpacts_stub
[1024 / 8];
3111 struct ofpbuf ofpacts
;
3115 COVERAGE_INC(ofproto_packet_out
);
3117 error
= reject_slave_controller(ofconn
);
3122 /* Decode message. */
3123 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3124 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
3126 goto exit_free_ofpacts
;
3128 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
3129 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
3130 error
= OFPERR_OFPBRC_BAD_PORT
;
3131 goto exit_free_ofpacts
;
3135 if (po
.buffer_id
!= UINT32_MAX
) {
3136 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
3137 if (error
|| !payload
) {
3138 goto exit_free_ofpacts
;
3141 /* Ensure that the L3 header is 32-bit aligned. */
3142 payload
= ofpbuf_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
3145 /* Verify actions against packet, then send packet if successful. */
3146 flow_extract(payload
, NULL
, &flow
);
3147 flow
.in_port
.ofp_port
= po
.in_port
;
3148 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
3150 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
3151 po
.ofpacts
, po
.ofpacts_len
);
3153 ofpbuf_delete(payload
);
3156 ofpbuf_uninit(&ofpacts
);
3162 update_port_config(struct ofconn
*ofconn
, struct ofport
*port
,
3163 enum ofputil_port_config config
,
3164 enum ofputil_port_config mask
)
3166 enum ofputil_port_config toggle
= (config
^ port
->pp
.config
) & mask
;
3168 if (toggle
& OFPUTIL_PC_PORT_DOWN
3169 && (config
& OFPUTIL_PC_PORT_DOWN
3170 ? netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
)
3171 : netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
))) {
3172 /* We tried to bring the port up or down, but it failed, so don't
3173 * update the "down" bit. */
3174 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
3178 enum ofputil_port_config old_config
= port
->pp
.config
;
3179 port
->pp
.config
^= toggle
;
3180 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
3181 connmgr_send_port_status(port
->ofproto
->connmgr
, ofconn
, &port
->pp
,
3187 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3189 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3190 struct ofputil_port_mod pm
;
3191 struct ofport
*port
;
3194 error
= reject_slave_controller(ofconn
);
3199 error
= ofputil_decode_port_mod(oh
, &pm
, false);
3204 port
= ofproto_get_port(p
, pm
.port_no
);
3206 return OFPERR_OFPPMFC_BAD_PORT
;
3207 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
3208 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3210 update_port_config(ofconn
, port
, pm
.config
, pm
.mask
);
3212 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
3219 handle_desc_stats_request(struct ofconn
*ofconn
,
3220 const struct ofp_header
*request
)
3222 static const char *default_mfr_desc
= "Nicira, Inc.";
3223 static const char *default_hw_desc
= "Open vSwitch";
3224 static const char *default_sw_desc
= VERSION
;
3225 static const char *default_serial_desc
= "None";
3226 static const char *default_dp_desc
= "None";
3228 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3229 struct ofp_desc_stats
*ods
;
3232 msg
= ofpraw_alloc_stats_reply(request
, 0);
3233 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3234 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3235 sizeof ods
->mfr_desc
);
3236 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3237 sizeof ods
->hw_desc
);
3238 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3239 sizeof ods
->sw_desc
);
3240 ovs_strlcpy(ods
->serial_num
,
3241 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3242 sizeof ods
->serial_num
);
3243 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3244 sizeof ods
->dp_desc
);
3245 ofconn_send_reply(ofconn
, msg
);
3251 handle_table_stats_request(struct ofconn
*ofconn
,
3252 const struct ofp_header
*request
)
3254 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3255 struct ofputil_table_features
*features
;
3256 struct ofputil_table_stats
*stats
;
3257 struct ofpbuf
*reply
;
3260 query_tables(ofproto
, &features
, &stats
);
3262 reply
= ofputil_encode_table_stats_reply(request
);
3263 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3264 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3265 ofputil_append_table_stats_reply(reply
, &stats
[i
], &features
[i
]);
3268 ofconn_send_reply(ofconn
, reply
);
3277 handle_table_features_request(struct ofconn
*ofconn
,
3278 const struct ofp_header
*request
)
3280 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3281 struct ofputil_table_features
*features
;
3282 struct list replies
;
3286 ofpbuf_use_const(&msg
, request
, ntohs(request
->length
));
3287 ofpraw_pull_assert(&msg
);
3288 if (ofpbuf_size(&msg
) || ofpmp_more(request
)) {
3289 return OFPERR_OFPTFFC_EPERM
;
3292 query_tables(ofproto
, &features
, NULL
);
3294 ofpmp_init(&replies
, request
);
3295 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3296 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3297 ofputil_append_table_features_reply(&features
[i
], &replies
);
3300 ofconn_send_replies(ofconn
, &replies
);
3308 append_port_stat(struct ofport
*port
, struct list
*replies
)
3310 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3312 calc_duration(port
->created
, time_msec(),
3313 &ops
.duration_sec
, &ops
.duration_nsec
);
3315 /* Intentionally ignore return value, since errors will set
3316 * 'stats' to all-1s, which is correct for OpenFlow, and
3317 * netdev_get_stats() will log errors. */
3318 ofproto_port_get_stats(port
, &ops
.stats
);
3320 ofputil_append_port_stat(replies
, &ops
);
3324 handle_port_request(struct ofconn
*ofconn
,
3325 const struct ofp_header
*request
, ofp_port_t port_no
,
3326 void (*cb
)(struct ofport
*, struct list
*replies
))
3328 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3329 struct ofport
*port
;
3330 struct list replies
;
3332 ofpmp_init(&replies
, request
);
3333 if (port_no
!= OFPP_ANY
) {
3334 port
= ofproto_get_port(ofproto
, port_no
);
3339 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3344 ofconn_send_replies(ofconn
, &replies
);
3348 handle_port_stats_request(struct ofconn
*ofconn
,
3349 const struct ofp_header
*request
)
3354 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3356 handle_port_request(ofconn
, request
, port_no
, append_port_stat
);
3362 append_port_desc(struct ofport
*port
, struct list
*replies
)
3364 ofputil_append_port_desc_stats_reply(&port
->pp
, replies
);
3368 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3369 const struct ofp_header
*request
)
3374 error
= ofputil_decode_port_desc_stats_request(request
, &port_no
);
3376 handle_port_request(ofconn
, request
, port_no
, append_port_desc
);
3382 hash_cookie(ovs_be64 cookie
)
3384 return hash_uint64((OVS_FORCE
uint64_t)cookie
);
3388 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3389 OVS_REQUIRES(ofproto_mutex
)
3391 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3392 hash_cookie(rule
->flow_cookie
));
3396 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3397 OVS_REQUIRES(ofproto_mutex
)
3399 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3403 calc_duration(long long int start
, long long int now
,
3404 uint32_t *sec
, uint32_t *nsec
)
3406 long long int msecs
= now
- start
;
3407 *sec
= msecs
/ 1000;
3408 *nsec
= (msecs
% 1000) * (1000 * 1000);
3411 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3412 * true if 'table_id' is OK, false otherwise. */
3414 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3416 return table_id
== OFPTT_ALL
|| table_id
< ofproto
->n_tables
;
3419 static struct oftable
*
3420 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3422 struct oftable
*table
;
3424 for (table
= &ofproto
->tables
[table_id
];
3425 table
< &ofproto
->tables
[ofproto
->n_tables
];
3427 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3435 static struct oftable
*
3436 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3438 if (table_id
== 0xff) {
3439 return next_visible_table(ofproto
, 0);
3440 } else if (table_id
< ofproto
->n_tables
) {
3441 return &ofproto
->tables
[table_id
];
3447 static struct oftable
*
3448 next_matching_table(const struct ofproto
*ofproto
,
3449 const struct oftable
*table
, uint8_t table_id
)
3451 return (table_id
== 0xff
3452 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3456 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3458 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3459 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3461 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3462 * only once, for that table. (This can be used to access tables marked
3465 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3466 * entered at all. (Perhaps you should have validated TABLE_ID with
3467 * check_table_id().)
3469 * All parameters are evaluated multiple times.
3471 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3472 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3474 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3476 /* Initializes 'criteria' in a straightforward way based on the other
3479 * By default, the criteria include flows that are read-only, on the assumption
3480 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3481 * if flows will be modified.
3483 * For "loose" matching, the 'priority' parameter is unimportant and may be
3486 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3487 const struct match
*match
, unsigned int priority
,
3488 ovs_be64 cookie
, ovs_be64 cookie_mask
,
3489 ofp_port_t out_port
, uint32_t out_group
)
3491 criteria
->table_id
= table_id
;
3492 cls_rule_init(&criteria
->cr
, match
, priority
);
3493 criteria
->cookie
= cookie
;
3494 criteria
->cookie_mask
= cookie_mask
;
3495 criteria
->out_port
= out_port
;
3496 criteria
->out_group
= out_group
;
3498 /* We ordinarily want to skip hidden rules, but there has to be a way for
3499 * code internal to OVS to modify and delete them, so if the criteria
3500 * specify a priority that can only be for a hidden flow, then allow hidden
3501 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3502 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3504 criteria
->include_hidden
= priority
> UINT16_MAX
;
3506 /* We assume that the criteria are being used to collect flows for reading
3507 * but not modification. Thus, we should collect read-only flows. */
3508 criteria
->include_readonly
= true;
3511 /* By default, criteria initialized by rule_criteria_init() will match flows
3512 * that are read-only, on the assumption that the collected flows won't be
3513 * modified. Call this function to match only flows that are be modifiable.
3515 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3516 * caller has special privileges that allow it to modify even "read-only"
3519 rule_criteria_require_rw(struct rule_criteria
*criteria
,
3520 bool can_write_readonly
)
3522 criteria
->include_readonly
= can_write_readonly
;
3526 rule_criteria_destroy(struct rule_criteria
*criteria
)
3528 cls_rule_destroy(&criteria
->cr
);
3532 rule_collection_init(struct rule_collection
*rules
)
3534 rules
->rules
= rules
->stub
;
3536 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
3540 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
3542 if (rules
->n
>= rules
->capacity
) {
3543 size_t old_size
, new_size
;
3545 old_size
= rules
->capacity
* sizeof *rules
->rules
;
3546 rules
->capacity
*= 2;
3547 new_size
= rules
->capacity
* sizeof *rules
->rules
;
3549 if (rules
->rules
== rules
->stub
) {
3550 rules
->rules
= xmalloc(new_size
);
3551 memcpy(rules
->rules
, rules
->stub
, old_size
);
3553 rules
->rules
= xrealloc(rules
->rules
, new_size
);
3557 rules
->rules
[rules
->n
++] = rule
;
3561 rule_collection_ref(struct rule_collection
*rules
)
3562 OVS_REQUIRES(ofproto_mutex
)
3566 for (i
= 0; i
< rules
->n
; i
++) {
3567 ofproto_rule_ref(rules
->rules
[i
]);
3572 rule_collection_unref(struct rule_collection
*rules
)
3576 for (i
= 0; i
< rules
->n
; i
++) {
3577 ofproto_rule_unref(rules
->rules
[i
]);
3582 rule_collection_destroy(struct rule_collection
*rules
)
3584 if (rules
->rules
!= rules
->stub
) {
3588 /* Make repeated destruction harmless. */
3589 rule_collection_init(rules
);
3592 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3593 * function verifies most of the criteria in 'c' itself, but the caller must
3594 * check 'c->cr' itself.
3596 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3597 * 'c' only includes modifiable rules). */
3599 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
3600 struct rule_collection
*rules
, size_t *n_readonly
)
3601 OVS_REQUIRES(ofproto_mutex
)
3603 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
3604 && ofproto_rule_has_out_port(rule
, c
->out_port
)
3605 && ofproto_rule_has_out_group(rule
, c
->out_group
)
3606 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)
3607 && (!rule_is_hidden(rule
) || c
->include_hidden
)) {
3608 /* Rule matches all the criteria... */
3609 if (!rule_is_readonly(rule
) || c
->include_readonly
) {
3611 rule_collection_add(rules
, rule
);
3613 /* ...except it's read-only. */
3619 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3620 * on classifiers rules are done in the "loose" way required for OpenFlow
3621 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3624 * Returns 0 on success, otherwise an OpenFlow error code. */
3626 collect_rules_loose(struct ofproto
*ofproto
,
3627 const struct rule_criteria
*criteria
,
3628 struct rule_collection
*rules
)
3629 OVS_REQUIRES(ofproto_mutex
)
3631 struct oftable
*table
;
3632 enum ofperr error
= 0;
3633 size_t n_readonly
= 0;
3635 rule_collection_init(rules
);
3637 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3638 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3642 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3645 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3646 hash_cookie(criteria
->cookie
),
3647 &ofproto
->cookies
) {
3648 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
3649 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3653 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3656 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &criteria
->cr
) {
3657 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3663 if (!error
&& !rules
->n
&& n_readonly
) {
3664 /* We didn't find any rules to modify. We did find some read-only
3665 * rules that we're not allowed to modify, so report that. */
3666 error
= OFPERR_OFPBRC_EPERM
;
3669 rule_collection_destroy(rules
);
3674 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3675 * on classifiers rules are done in the "strict" way required for OpenFlow
3676 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3677 * rules on list 'rules'.
3679 * Returns 0 on success, otherwise an OpenFlow error code. */
3681 collect_rules_strict(struct ofproto
*ofproto
,
3682 const struct rule_criteria
*criteria
,
3683 struct rule_collection
*rules
)
3684 OVS_REQUIRES(ofproto_mutex
)
3686 struct oftable
*table
;
3687 size_t n_readonly
= 0;
3690 rule_collection_init(rules
);
3692 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3693 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3697 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3700 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3701 hash_cookie(criteria
->cookie
),
3702 &ofproto
->cookies
) {
3703 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
3704 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3708 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3711 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
3712 &table
->cls
, &criteria
->cr
));
3714 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3720 if (!error
&& !rules
->n
&& n_readonly
) {
3721 /* We didn't find any rules to modify. We did find some read-only
3722 * rules that we're not allowed to modify, so report that. */
3723 error
= OFPERR_OFPBRC_EPERM
;
3726 rule_collection_destroy(rules
);
3731 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3732 * forced into the range of a uint16_t. */
3734 age_secs(long long int age_ms
)
3736 return (age_ms
< 0 ? 0
3737 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
3738 : (unsigned int) age_ms
/ 1000);
3742 handle_flow_stats_request(struct ofconn
*ofconn
,
3743 const struct ofp_header
*request
)
3744 OVS_EXCLUDED(ofproto_mutex
)
3746 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3747 struct ofputil_flow_stats_request fsr
;
3748 struct rule_criteria criteria
;
3749 struct rule_collection rules
;
3750 struct list replies
;
3754 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
3759 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, fsr
.cookie
,
3760 fsr
.cookie_mask
, fsr
.out_port
, fsr
.out_group
);
3762 ovs_mutex_lock(&ofproto_mutex
);
3763 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3764 rule_criteria_destroy(&criteria
);
3766 rule_collection_ref(&rules
);
3768 ovs_mutex_unlock(&ofproto_mutex
);
3774 ofpmp_init(&replies
, request
);
3775 for (i
= 0; i
< rules
.n
; i
++) {
3776 struct rule
*rule
= rules
.rules
[i
];
3777 long long int now
= time_msec();
3778 struct ofputil_flow_stats fs
;
3779 long long int created
, used
, modified
;
3780 const struct rule_actions
*actions
;
3781 enum ofputil_flow_mod_flags flags
;
3783 ovs_mutex_lock(&rule
->mutex
);
3784 fs
.cookie
= rule
->flow_cookie
;
3785 fs
.idle_timeout
= rule
->idle_timeout
;
3786 fs
.hard_timeout
= rule
->hard_timeout
;
3787 created
= rule
->created
;
3788 modified
= rule
->modified
;
3789 actions
= rule_get_actions(rule
);
3790 flags
= rule
->flags
;
3791 ovs_mutex_unlock(&rule
->mutex
);
3793 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
3794 &fs
.byte_count
, &used
);
3796 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
3797 fs
.table_id
= rule
->table_id
;
3798 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
3799 fs
.priority
= rule
->cr
.priority
;
3800 fs
.idle_age
= age_secs(now
- used
);
3801 fs
.hard_age
= age_secs(now
- modified
);
3802 fs
.ofpacts
= actions
->ofpacts
;
3803 fs
.ofpacts_len
= actions
->ofpacts_len
;
3806 ofputil_append_flow_stats_reply(&fs
, &replies
);
3809 rule_collection_unref(&rules
);
3810 rule_collection_destroy(&rules
);
3812 ofconn_send_replies(ofconn
, &replies
);
3818 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
3820 uint64_t packet_count
, byte_count
;
3821 const struct rule_actions
*actions
;
3822 long long int created
, used
;
3824 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3825 &byte_count
, &used
);
3827 ovs_mutex_lock(&rule
->mutex
);
3828 actions
= rule_get_actions(rule
);
3829 created
= rule
->created
;
3830 ovs_mutex_unlock(&rule
->mutex
);
3832 if (rule
->table_id
!= 0) {
3833 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
3835 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
3836 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
3837 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
3838 cls_rule_format(&rule
->cr
, results
);
3839 ds_put_char(results
, ',');
3841 ds_put_cstr(results
, "actions=");
3842 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
3844 ds_put_cstr(results
, "\n");
3847 /* Adds a pretty-printed description of all flows to 'results', including
3848 * hidden flows (e.g., set up by in-band control). */
3850 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
3852 struct oftable
*table
;
3854 OFPROTO_FOR_EACH_TABLE (table
, p
) {
3857 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
3858 flow_stats_ds(rule
, results
);
3863 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3864 * '*engine_type' and '*engine_id', respectively. */
3866 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
3867 uint8_t *engine_type
, uint8_t *engine_id
)
3869 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
3872 /* Checks the status change of CFM on 'ofport'.
3874 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
3876 ofproto_port_cfm_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
3878 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3879 return (ofport
&& ofproto
->ofproto_class
->cfm_status_changed
3880 ? ofproto
->ofproto_class
->cfm_status_changed(ofport
)
3884 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3885 * Returns 0 if the port's CFM status was successfully stored into
3886 * '*status'. Returns positive errno if the port did not have CFM
3889 * The caller must provide and own '*status', and must free 'status->rmps'.
3890 * '*status' is indeterminate if the return value is non-zero. */
3892 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
3893 struct cfm_status
*status
)
3895 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3896 return (ofport
&& ofproto
->ofproto_class
->get_cfm_status
3897 ? ofproto
->ofproto_class
->get_cfm_status(ofport
, status
)
3902 handle_aggregate_stats_request(struct ofconn
*ofconn
,
3903 const struct ofp_header
*oh
)
3904 OVS_EXCLUDED(ofproto_mutex
)
3906 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3907 struct ofputil_flow_stats_request request
;
3908 struct ofputil_aggregate_stats stats
;
3909 bool unknown_packets
, unknown_bytes
;
3910 struct rule_criteria criteria
;
3911 struct rule_collection rules
;
3912 struct ofpbuf
*reply
;
3916 error
= ofputil_decode_flow_stats_request(&request
, oh
);
3921 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
3922 request
.cookie
, request
.cookie_mask
,
3923 request
.out_port
, request
.out_group
);
3925 ovs_mutex_lock(&ofproto_mutex
);
3926 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3927 rule_criteria_destroy(&criteria
);
3929 rule_collection_ref(&rules
);
3931 ovs_mutex_unlock(&ofproto_mutex
);
3937 memset(&stats
, 0, sizeof stats
);
3938 unknown_packets
= unknown_bytes
= false;
3939 for (i
= 0; i
< rules
.n
; i
++) {
3940 struct rule
*rule
= rules
.rules
[i
];
3941 uint64_t packet_count
;
3942 uint64_t byte_count
;
3945 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3946 &byte_count
, &used
);
3948 if (packet_count
== UINT64_MAX
) {
3949 unknown_packets
= true;
3951 stats
.packet_count
+= packet_count
;
3954 if (byte_count
== UINT64_MAX
) {
3955 unknown_bytes
= true;
3957 stats
.byte_count
+= byte_count
;
3962 if (unknown_packets
) {
3963 stats
.packet_count
= UINT64_MAX
;
3965 if (unknown_bytes
) {
3966 stats
.byte_count
= UINT64_MAX
;
3969 rule_collection_unref(&rules
);
3970 rule_collection_destroy(&rules
);
3972 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
3973 ofconn_send_reply(ofconn
, reply
);
3978 struct queue_stats_cbdata
{
3979 struct ofport
*ofport
;
3980 struct list replies
;
3985 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
3986 const struct netdev_queue_stats
*stats
)
3988 struct ofputil_queue_stats oqs
;
3990 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
3991 oqs
.queue_id
= queue_id
;
3992 oqs
.tx_bytes
= stats
->tx_bytes
;
3993 oqs
.tx_packets
= stats
->tx_packets
;
3994 oqs
.tx_errors
= stats
->tx_errors
;
3995 if (stats
->created
!= LLONG_MIN
) {
3996 calc_duration(stats
->created
, cbdata
->now
,
3997 &oqs
.duration_sec
, &oqs
.duration_nsec
);
3999 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
4001 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
4005 handle_queue_stats_dump_cb(uint32_t queue_id
,
4006 struct netdev_queue_stats
*stats
,
4009 struct queue_stats_cbdata
*cbdata
= cbdata_
;
4011 put_queue_stats(cbdata
, queue_id
, stats
);
4015 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
4016 struct queue_stats_cbdata
*cbdata
)
4018 cbdata
->ofport
= port
;
4019 if (queue_id
== OFPQ_ALL
) {
4020 netdev_dump_queue_stats(port
->netdev
,
4021 handle_queue_stats_dump_cb
, cbdata
);
4023 struct netdev_queue_stats stats
;
4025 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
4026 put_queue_stats(cbdata
, queue_id
, &stats
);
4028 return OFPERR_OFPQOFC_BAD_QUEUE
;
4035 handle_queue_stats_request(struct ofconn
*ofconn
,
4036 const struct ofp_header
*rq
)
4038 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4039 struct queue_stats_cbdata cbdata
;
4040 struct ofport
*port
;
4042 struct ofputil_queue_stats_request oqsr
;
4044 COVERAGE_INC(ofproto_queue_req
);
4046 ofpmp_init(&cbdata
.replies
, rq
);
4047 cbdata
.now
= time_msec();
4049 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
4054 if (oqsr
.port_no
== OFPP_ANY
) {
4055 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
4056 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
4057 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
4062 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
4064 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
4065 : OFPERR_OFPQOFC_BAD_PORT
);
4068 ofconn_send_replies(ofconn
, &cbdata
.replies
);
4070 ofpbuf_list_delete(&cbdata
.replies
);
4077 should_evict_a_rule(struct oftable
*table
, unsigned int extra_space
)
4078 OVS_REQUIRES(ofproto_mutex
)
4079 OVS_NO_THREAD_SAFETY_ANALYSIS
4081 return classifier_count(&table
->cls
) + extra_space
> table
->max_flows
;
4085 evict_rules_from_table(struct oftable
*table
, unsigned int extra_space
)
4086 OVS_REQUIRES(ofproto_mutex
)
4088 while (should_evict_a_rule(table
, extra_space
)) {
4091 if (!choose_rule_to_evict(table
, &rule
)) {
4092 return OFPERR_OFPFMFC_TABLE_FULL
;
4094 ofproto_rule_delete__(rule
, OFPRR_EVICTION
);
4101 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4102 * in which no matching flow already exists in the flow table.
4104 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4105 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4106 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4107 * initiated now but may be retried later.
4109 * The caller retains ownership of 'fm->ofpacts'.
4111 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4114 add_flow(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4115 const struct flow_mod_requester
*req
)
4116 OVS_REQUIRES(ofproto_mutex
)
4118 const struct rule_actions
*actions
;
4119 struct oftable
*table
;
4125 if (!check_table_id(ofproto
, fm
->table_id
)) {
4126 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4131 if (fm
->table_id
== 0xff) {
4132 if (ofproto
->ofproto_class
->rule_choose_table
) {
4133 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
4139 ovs_assert(table_id
< ofproto
->n_tables
);
4143 } else if (fm
->table_id
< ofproto
->n_tables
) {
4144 table_id
= fm
->table_id
;
4146 return OFPERR_OFPBRC_BAD_TABLE_ID
;
4149 table
= &ofproto
->tables
[table_id
];
4150 if (table
->flags
& OFTABLE_READONLY
4151 && !(fm
->flags
& OFPUTIL_FF_NO_READONLY
)) {
4152 return OFPERR_OFPBRC_EPERM
;
4155 if (!(fm
->flags
& OFPUTIL_FF_HIDDEN_FIELDS
)) {
4156 if (!match_has_default_hidden_fields(&fm
->match
)) {
4157 VLOG_WARN_RL(&rl
, "%s: (add_flow) only internal flows can set "
4158 "non-default values to hidden fields", ofproto
->name
);
4159 return OFPERR_OFPBRC_EPERM
;
4163 cls_rule_init(&cr
, &fm
->match
, fm
->priority
);
4165 /* Transform "add" into "modify" if there's an existing identical flow. */
4166 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
));
4168 struct rule_collection rules
;
4170 cls_rule_destroy(&cr
);
4172 rule_collection_init(&rules
);
4173 rule_collection_add(&rules
, rule
);
4174 fm
->modify_cookie
= true;
4175 error
= modify_flows__(ofproto
, fm
, &rules
, req
);
4176 rule_collection_destroy(&rules
);
4181 /* Check for overlap, if requested. */
4182 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
) {
4183 if (classifier_rule_overlaps(&table
->cls
, &cr
)) {
4184 cls_rule_destroy(&cr
);
4185 return OFPERR_OFPFMFC_OVERLAP
;
4189 /* If necessary, evict an existing rule to clear out space. */
4190 error
= evict_rules_from_table(table
, 1);
4192 cls_rule_destroy(&cr
);
4196 /* Allocate new rule. */
4197 rule
= ofproto
->ofproto_class
->rule_alloc();
4199 cls_rule_destroy(&cr
);
4200 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
4201 ofproto
->name
, ovs_strerror(error
));
4205 /* Initialize base state. */
4206 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4207 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), &cr
);
4208 ovs_refcount_init(&rule
->ref_count
);
4209 rule
->flow_cookie
= fm
->new_cookie
;
4210 rule
->created
= rule
->modified
= time_msec();
4212 ovs_mutex_init(&rule
->mutex
);
4213 ovs_mutex_lock(&rule
->mutex
);
4214 rule
->idle_timeout
= fm
->idle_timeout
;
4215 rule
->hard_timeout
= fm
->hard_timeout
;
4216 ovs_mutex_unlock(&rule
->mutex
);
4218 *CONST_CAST(uint8_t *, &rule
->table_id
) = table
- ofproto
->tables
;
4219 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4220 actions
= rule_actions_create(fm
->ofpacts
, fm
->ofpacts_len
);
4221 ovsrcu_set(&rule
->actions
, actions
);
4222 list_init(&rule
->meter_list_node
);
4223 rule
->eviction_group
= NULL
;
4224 list_init(&rule
->expirable
);
4225 rule
->monitor_flags
= 0;
4226 rule
->add_seqno
= 0;
4227 rule
->modify_seqno
= 0;
4229 /* Construct rule, initializing derived state. */
4230 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4232 ofproto_rule_destroy__(rule
);
4236 if (fm
->hard_timeout
|| fm
->idle_timeout
) {
4237 list_insert(&ofproto
->expirable
, &rule
->expirable
);
4239 cookies_insert(ofproto
, rule
);
4240 eviction_group_add_rule(rule
);
4241 if (actions
->has_meter
) {
4242 meter_insert_rule(rule
);
4245 classifier_insert(&table
->cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
4247 error
= ofproto
->ofproto_class
->rule_insert(rule
);
4249 oftable_remove_rule(rule
);
4250 ofproto_rule_unref(rule
);
4253 learned_cookies_inc(ofproto
, actions
);
4255 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
4256 if (ofproto
->vlan_bitmap
) {
4257 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
4258 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
4259 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
4260 ofproto
->vlans_changed
= true;
4263 ofproto
->vlans_changed
= true;
4267 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_ADDED
, 0,
4268 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0, NULL
);
4270 return req
? send_buffered_packet(req
->ofconn
, fm
->buffer_id
, rule
) : 0;
4273 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4275 /* Modifies the rules listed in 'rules', changing their actions to match those
4278 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4281 * Returns 0 on success, otherwise an OpenFlow error code. */
4283 modify_flows__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4284 const struct rule_collection
*rules
,
4285 const struct flow_mod_requester
*req
)
4286 OVS_REQUIRES(ofproto_mutex
)
4288 struct list dead_cookies
= LIST_INITIALIZER(&dead_cookies
);
4289 enum nx_flow_update_event event
;
4292 if (ofproto
->ofproto_class
->rule_premodify_actions
) {
4293 for (i
= 0; i
< rules
->n
; i
++) {
4294 struct rule
*rule
= rules
->rules
[i
];
4297 error
= ofproto
->ofproto_class
->rule_premodify_actions(
4298 rule
, fm
->ofpacts
, fm
->ofpacts_len
);
4305 event
= fm
->command
== OFPFC_ADD
? NXFME_ADDED
: NXFME_MODIFIED
;
4306 for (i
= 0; i
< rules
->n
; i
++) {
4307 struct rule
*rule
= rules
->rules
[i
];
4309 /* 'fm' says that */
4310 bool change_cookie
= (fm
->modify_cookie
4311 && fm
->new_cookie
!= OVS_BE64_MAX
4312 && fm
->new_cookie
!= rule
->flow_cookie
);
4314 const struct rule_actions
*actions
= rule_get_actions(rule
);
4315 bool change_actions
= !ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
4317 actions
->ofpacts_len
);
4319 bool reset_counters
= (fm
->flags
& OFPUTIL_FF_RESET_COUNTS
) != 0;
4321 long long int now
= time_msec();
4323 /* FIXME: Implement OFPFUTIL_FF_RESET_COUNTS */
4325 if (change_cookie
) {
4326 cookies_remove(ofproto
, rule
);
4329 ovs_mutex_lock(&rule
->mutex
);
4330 if (fm
->command
== OFPFC_ADD
) {
4331 rule
->idle_timeout
= fm
->idle_timeout
;
4332 rule
->hard_timeout
= fm
->hard_timeout
;
4333 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4334 rule
->created
= now
;
4336 if (change_cookie
) {
4337 rule
->flow_cookie
= fm
->new_cookie
;
4339 rule
->modified
= now
;
4340 ovs_mutex_unlock(&rule
->mutex
);
4342 if (change_cookie
) {
4343 cookies_insert(ofproto
, rule
);
4345 if (fm
->command
== OFPFC_ADD
) {
4346 if (fm
->idle_timeout
|| fm
->hard_timeout
) {
4347 if (!rule
->eviction_group
) {
4348 eviction_group_add_rule(rule
);
4351 eviction_group_remove_rule(rule
);
4355 if (change_actions
) {
4356 ovsrcu_set(&rule
->actions
, rule_actions_create(fm
->ofpacts
,
4360 if (change_actions
|| reset_counters
) {
4361 ofproto
->ofproto_class
->rule_modify_actions(rule
, reset_counters
);
4364 if (event
!= NXFME_MODIFIED
|| change_actions
|| change_cookie
) {
4365 ofmonitor_report(ofproto
->connmgr
, rule
, event
, 0,
4366 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0,
4367 change_actions
? actions
: NULL
);
4370 if (change_actions
) {
4371 learned_cookies_inc(ofproto
, rule_get_actions(rule
));
4372 learned_cookies_dec(ofproto
, actions
, &dead_cookies
);
4373 rule_actions_destroy(actions
);
4376 learned_cookies_flush(ofproto
, &dead_cookies
);
4378 if (fm
->buffer_id
!= UINT32_MAX
&& req
) {
4379 return send_buffered_packet(req
->ofconn
, fm
->buffer_id
,
4387 modify_flows_add(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4388 const struct flow_mod_requester
*req
)
4389 OVS_REQUIRES(ofproto_mutex
)
4391 if (fm
->cookie_mask
!= htonll(0) || fm
->new_cookie
== OVS_BE64_MAX
) {
4394 return add_flow(ofproto
, fm
, req
);
4397 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4400 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4403 modify_flows_loose(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4404 const struct flow_mod_requester
*req
)
4405 OVS_REQUIRES(ofproto_mutex
)
4407 struct rule_criteria criteria
;
4408 struct rule_collection rules
;
4411 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4412 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4413 rule_criteria_require_rw(&criteria
,
4414 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4415 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4416 rule_criteria_destroy(&criteria
);
4419 error
= (rules
.n
> 0
4420 ? modify_flows__(ofproto
, fm
, &rules
, req
)
4421 : modify_flows_add(ofproto
, fm
, req
));
4424 rule_collection_destroy(&rules
);
4429 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4430 * code on failure. */
4432 modify_flow_strict(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4433 const struct flow_mod_requester
*req
)
4434 OVS_REQUIRES(ofproto_mutex
)
4436 struct rule_criteria criteria
;
4437 struct rule_collection rules
;
4440 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4441 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4442 rule_criteria_require_rw(&criteria
,
4443 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4444 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4445 rule_criteria_destroy(&criteria
);
4449 error
= modify_flows_add(ofproto
, fm
, req
);
4450 } else if (rules
.n
== 1) {
4451 error
= modify_flows__(ofproto
, fm
, &rules
, req
);
4455 rule_collection_destroy(&rules
);
4460 /* OFPFC_DELETE implementation. */
4462 /* Deletes the rules listed in 'rules'. */
4464 delete_flows__(const struct rule_collection
*rules
,
4465 enum ofp_flow_removed_reason reason
,
4466 const struct flow_mod_requester
*req
)
4467 OVS_REQUIRES(ofproto_mutex
)
4470 struct list dead_cookies
= LIST_INITIALIZER(&dead_cookies
);
4471 struct ofproto
*ofproto
= rules
->rules
[0]->ofproto
;
4474 for (i
= 0; i
< rules
->n
; i
++) {
4475 struct rule
*rule
= rules
->rules
[i
];
4476 const struct rule_actions
*actions
= rule_get_actions(rule
);
4478 ofproto_rule_send_removed(rule
, reason
);
4480 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_DELETED
, reason
,
4481 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0,
4483 oftable_remove_rule(rule
);
4484 ofproto
->ofproto_class
->rule_delete(rule
);
4486 learned_cookies_dec(ofproto
, actions
, &dead_cookies
);
4488 learned_cookies_flush(ofproto
, &dead_cookies
);
4489 ofmonitor_flush(ofproto
->connmgr
);
4493 /* Implements OFPFC_DELETE. */
4495 delete_flows_loose(struct ofproto
*ofproto
,
4496 const struct ofputil_flow_mod
*fm
,
4497 const struct flow_mod_requester
*req
)
4498 OVS_REQUIRES(ofproto_mutex
)
4500 struct rule_criteria criteria
;
4501 struct rule_collection rules
;
4504 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4505 fm
->cookie
, fm
->cookie_mask
,
4506 fm
->out_port
, fm
->out_group
);
4507 rule_criteria_require_rw(&criteria
,
4508 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4509 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4510 rule_criteria_destroy(&criteria
);
4512 if (!error
&& rules
.n
> 0) {
4513 delete_flows__(&rules
, fm
->delete_reason
, req
);
4515 rule_collection_destroy(&rules
);
4520 /* Implements OFPFC_DELETE_STRICT. */
4522 delete_flow_strict(struct ofproto
*ofproto
, const struct ofputil_flow_mod
*fm
,
4523 const struct flow_mod_requester
*req
)
4524 OVS_REQUIRES(ofproto_mutex
)
4526 struct rule_criteria criteria
;
4527 struct rule_collection rules
;
4530 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4531 fm
->cookie
, fm
->cookie_mask
,
4532 fm
->out_port
, fm
->out_group
);
4533 rule_criteria_require_rw(&criteria
,
4534 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4535 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4536 rule_criteria_destroy(&criteria
);
4538 if (!error
&& rules
.n
> 0) {
4539 delete_flows__(&rules
, fm
->delete_reason
, req
);
4541 rule_collection_destroy(&rules
);
4547 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
4548 OVS_REQUIRES(ofproto_mutex
)
4550 struct ofputil_flow_removed fr
;
4553 if (rule_is_hidden(rule
) ||
4554 !(rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
)) {
4558 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
4559 fr
.priority
= rule
->cr
.priority
;
4560 fr
.cookie
= rule
->flow_cookie
;
4562 fr
.table_id
= rule
->table_id
;
4563 calc_duration(rule
->created
, time_msec(),
4564 &fr
.duration_sec
, &fr
.duration_nsec
);
4565 ovs_mutex_lock(&rule
->mutex
);
4566 fr
.idle_timeout
= rule
->idle_timeout
;
4567 fr
.hard_timeout
= rule
->hard_timeout
;
4568 ovs_mutex_unlock(&rule
->mutex
);
4569 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
4570 &fr
.byte_count
, &used
);
4572 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
4575 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4576 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4579 * ofproto implementation ->run() functions should use this function to expire
4580 * OpenFlow flows. */
4582 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
4583 OVS_REQUIRES(ofproto_mutex
)
4585 ofproto_rule_delete__(rule
, reason
);
4588 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4589 * means "infinite". */
4591 reduce_timeout(uint16_t max
, uint16_t *timeout
)
4593 if (max
&& (!*timeout
|| *timeout
> max
)) {
4598 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4599 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4600 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4602 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4604 ofproto_rule_reduce_timeouts(struct rule
*rule
,
4605 uint16_t idle_timeout
, uint16_t hard_timeout
)
4606 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
4608 if (!idle_timeout
&& !hard_timeout
) {
4612 ovs_mutex_lock(&ofproto_mutex
);
4613 if (list_is_empty(&rule
->expirable
)) {
4614 list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
4616 ovs_mutex_unlock(&ofproto_mutex
);
4618 ovs_mutex_lock(&rule
->mutex
);
4619 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
4620 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
4621 ovs_mutex_unlock(&rule
->mutex
);
4625 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4626 OVS_EXCLUDED(ofproto_mutex
)
4628 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4629 struct ofputil_flow_mod fm
;
4630 uint64_t ofpacts_stub
[1024 / 8];
4631 struct ofpbuf ofpacts
;
4634 error
= reject_slave_controller(ofconn
);
4639 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
4640 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
4642 u16_to_ofp(ofproto
->max_ports
),
4645 error
= ofproto_check_ofpacts(ofproto
, fm
.ofpacts
, fm
.ofpacts_len
);
4648 struct flow_mod_requester req
;
4650 req
.ofconn
= ofconn
;
4652 error
= handle_flow_mod__(ofproto
, &fm
, &req
);
4655 goto exit_free_ofpacts
;
4658 ofconn_report_flow_mod(ofconn
, fm
.command
);
4661 ofpbuf_uninit(&ofpacts
);
4667 handle_flow_mod__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4668 const struct flow_mod_requester
*req
)
4669 OVS_EXCLUDED(ofproto_mutex
)
4673 ovs_mutex_lock(&ofproto_mutex
);
4674 switch (fm
->command
) {
4676 error
= add_flow(ofproto
, fm
, req
);
4680 error
= modify_flows_loose(ofproto
, fm
, req
);
4683 case OFPFC_MODIFY_STRICT
:
4684 error
= modify_flow_strict(ofproto
, fm
, req
);
4688 error
= delete_flows_loose(ofproto
, fm
, req
);
4691 case OFPFC_DELETE_STRICT
:
4692 error
= delete_flow_strict(ofproto
, fm
, req
);
4696 if (fm
->command
> 0xff) {
4697 VLOG_WARN_RL(&rl
, "%s: flow_mod has explicit table_id but "
4698 "flow_mod_table_id extension is not enabled",
4701 error
= OFPERR_OFPFMFC_BAD_COMMAND
;
4704 ofmonitor_flush(ofproto
->connmgr
);
4705 ovs_mutex_unlock(&ofproto_mutex
);
4707 run_rule_executes(ofproto
);
4712 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4714 struct ofputil_role_request request
;
4715 struct ofputil_role_request reply
;
4719 error
= ofputil_decode_role_message(oh
, &request
);
4724 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
4725 if (request
.have_generation_id
4726 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
4727 return OFPERR_OFPRRFC_STALE
;
4730 ofconn_set_role(ofconn
, request
.role
);
4733 reply
.role
= ofconn_get_role(ofconn
);
4734 reply
.have_generation_id
= ofconn_get_master_election_id(
4735 ofconn
, &reply
.generation_id
);
4736 buf
= ofputil_encode_role_reply(oh
, &reply
);
4737 ofconn_send_reply(ofconn
, buf
);
4743 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
4744 const struct ofp_header
*oh
)
4746 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
4747 enum ofputil_protocol cur
, next
;
4749 cur
= ofconn_get_protocol(ofconn
);
4750 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
4751 ofconn_set_protocol(ofconn
, next
);
4757 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4759 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
4760 enum ofputil_protocol cur
, next
;
4761 enum ofputil_protocol next_base
;
4763 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
4765 return OFPERR_OFPBRC_EPERM
;
4768 cur
= ofconn_get_protocol(ofconn
);
4769 next
= ofputil_protocol_set_base(cur
, next_base
);
4770 ofconn_set_protocol(ofconn
, next
);
4776 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
4777 const struct ofp_header
*oh
)
4779 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
4782 format
= ntohl(msg
->format
);
4783 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
4784 return OFPERR_OFPBRC_EPERM
;
4787 ofconn_set_packet_in_format(ofconn
, format
);
4792 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4794 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
4795 uint32_t master
[OAM_N_TYPES
];
4796 uint32_t slave
[OAM_N_TYPES
];
4798 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
4799 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
4800 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
4802 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
4803 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
4804 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
4806 ofconn_set_async_config(ofconn
, master
, slave
);
4807 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
4808 !ofconn_get_miss_send_len(ofconn
)) {
4809 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
4816 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4819 uint32_t master
[OAM_N_TYPES
];
4820 uint32_t slave
[OAM_N_TYPES
];
4821 struct nx_async_config
*msg
;
4823 ofconn_get_async_config(ofconn
, master
, slave
);
4824 buf
= ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY
, oh
, 0);
4825 msg
= ofpbuf_put_zeros(buf
, sizeof *msg
);
4827 msg
->packet_in_mask
[0] = htonl(master
[OAM_PACKET_IN
]);
4828 msg
->port_status_mask
[0] = htonl(master
[OAM_PORT_STATUS
]);
4829 msg
->flow_removed_mask
[0] = htonl(master
[OAM_FLOW_REMOVED
]);
4831 msg
->packet_in_mask
[1] = htonl(slave
[OAM_PACKET_IN
]);
4832 msg
->port_status_mask
[1] = htonl(slave
[OAM_PORT_STATUS
]);
4833 msg
->flow_removed_mask
[1] = htonl(slave
[OAM_FLOW_REMOVED
]);
4835 ofconn_send_reply(ofconn
, buf
);
4841 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
4842 const struct ofp_header
*oh
)
4844 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
4846 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
4847 return OFPERR_NXBRC_MUST_BE_ZERO
;
4850 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
4855 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4859 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
4860 ? OFPRAW_OFPT10_BARRIER_REPLY
4861 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
4862 ofconn_send_reply(ofconn
, buf
);
4867 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
4868 enum nx_flow_monitor_flags flags
,
4870 OVS_REQUIRES(ofproto_mutex
)
4872 const struct rule_actions
*actions
;
4873 struct ofputil_flow_update fu
;
4876 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
4877 ? NXFME_ADDED
: NXFME_MODIFIED
);
4879 ovs_mutex_lock(&rule
->mutex
);
4880 fu
.idle_timeout
= rule
->idle_timeout
;
4881 fu
.hard_timeout
= rule
->hard_timeout
;
4882 ovs_mutex_unlock(&rule
->mutex
);
4883 fu
.table_id
= rule
->table_id
;
4884 fu
.cookie
= rule
->flow_cookie
;
4885 minimatch_expand(&rule
->cr
.match
, &match
);
4887 fu
.priority
= rule
->cr
.priority
;
4889 actions
= flags
& NXFMF_ACTIONS
? rule_get_actions(rule
) : NULL
;
4890 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
4891 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
4893 if (list_is_empty(msgs
)) {
4894 ofputil_start_flow_update(msgs
);
4896 ofputil_append_flow_update(&fu
, msgs
);
4900 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
4902 OVS_REQUIRES(ofproto_mutex
)
4906 for (i
= 0; i
< rules
->n
; i
++) {
4907 struct rule
*rule
= rules
->rules
[i
];
4908 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
4909 rule
->monitor_flags
= 0;
4911 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
4916 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
4917 struct rule
*rule
, uint64_t seqno
,
4918 struct rule_collection
*rules
)
4919 OVS_REQUIRES(ofproto_mutex
)
4921 enum nx_flow_monitor_flags update
;
4923 if (rule_is_hidden(rule
)) {
4927 if (!ofproto_rule_has_out_port(rule
, m
->out_port
)) {
4932 if (rule
->add_seqno
> seqno
) {
4933 update
= NXFMF_ADD
| NXFMF_MODIFY
;
4934 } else if (rule
->modify_seqno
> seqno
) {
4935 update
= NXFMF_MODIFY
;
4940 if (!(m
->flags
& update
)) {
4944 update
= NXFMF_INITIAL
;
4947 if (!rule
->monitor_flags
) {
4948 rule_collection_add(rules
, rule
);
4950 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
4954 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
4956 struct rule_collection
*rules
)
4957 OVS_REQUIRES(ofproto_mutex
)
4959 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
4960 const struct oftable
*table
;
4961 struct cls_rule target
;
4963 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
4964 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
4967 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &target
) {
4968 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
4971 cls_rule_destroy(&target
);
4975 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
4976 struct rule_collection
*rules
)
4977 OVS_REQUIRES(ofproto_mutex
)
4979 if (m
->flags
& NXFMF_INITIAL
) {
4980 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
4985 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
4986 uint64_t seqno
, struct rule_collection
*rules
)
4987 OVS_REQUIRES(ofproto_mutex
)
4989 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
4993 flow_monitor_delete(struct ofconn
*ofconn
, uint32_t id
)
4994 OVS_REQUIRES(ofproto_mutex
)
4996 struct ofmonitor
*m
;
4999 m
= ofmonitor_lookup(ofconn
, id
);
5001 ofmonitor_destroy(m
);
5004 error
= OFPERR_OFPMOFC_UNKNOWN_MONITOR
;
5011 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5012 OVS_EXCLUDED(ofproto_mutex
)
5014 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5015 struct ofmonitor
**monitors
;
5016 size_t n_monitors
, allocated_monitors
;
5017 struct rule_collection rules
;
5018 struct list replies
;
5023 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
5025 n_monitors
= allocated_monitors
= 0;
5027 ovs_mutex_lock(&ofproto_mutex
);
5029 struct ofputil_flow_monitor_request request
;
5030 struct ofmonitor
*m
;
5033 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
5034 if (retval
== EOF
) {
5036 } else if (retval
) {
5041 if (request
.table_id
!= 0xff
5042 && request
.table_id
>= ofproto
->n_tables
) {
5043 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
5047 error
= ofmonitor_create(&request
, ofconn
, &m
);
5052 if (n_monitors
>= allocated_monitors
) {
5053 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
5056 monitors
[n_monitors
++] = m
;
5059 rule_collection_init(&rules
);
5060 for (i
= 0; i
< n_monitors
; i
++) {
5061 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
5064 ofpmp_init(&replies
, oh
);
5065 ofmonitor_compose_refresh_updates(&rules
, &replies
);
5066 ovs_mutex_unlock(&ofproto_mutex
);
5068 rule_collection_destroy(&rules
);
5070 ofconn_send_replies(ofconn
, &replies
);
5076 for (i
= 0; i
< n_monitors
; i
++) {
5077 ofmonitor_destroy(monitors
[i
]);
5080 ovs_mutex_unlock(&ofproto_mutex
);
5086 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5087 OVS_EXCLUDED(ofproto_mutex
)
5092 id
= ofputil_decode_flow_monitor_cancel(oh
);
5094 ovs_mutex_lock(&ofproto_mutex
);
5095 error
= flow_monitor_delete(ofconn
, id
);
5096 ovs_mutex_unlock(&ofproto_mutex
);
5101 /* Meters implementation.
5103 * Meter table entry, indexed by the OpenFlow meter_id.
5104 * 'created' is used to compute the duration for meter stats.
5105 * 'list rules' is needed so that we can delete the dependent rules when the
5106 * meter table entry is deleted.
5107 * 'provider_meter_id' is for the provider's private use.
5110 long long int created
; /* Time created. */
5111 struct list rules
; /* List of "struct rule_dpif"s. */
5112 ofproto_meter_id provider_meter_id
;
5113 uint16_t flags
; /* Meter flags. */
5114 uint16_t n_bands
; /* Number of meter bands. */
5115 struct ofputil_meter_band
*bands
;
5119 * This is used in instruction validation at flow set-up time,
5120 * as flows may not use non-existing meters.
5121 * Return value of UINT32_MAX signifies an invalid meter.
5124 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
5126 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
5127 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
5129 return meter
->provider_meter_id
.uint32
;
5135 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5138 meter_insert_rule(struct rule
*rule
)
5140 const struct rule_actions
*a
= rule_get_actions(rule
);
5141 uint32_t meter_id
= ofpacts_get_meter(a
->ofpacts
, a
->ofpacts_len
);
5142 struct meter
*meter
= rule
->ofproto
->meters
[meter_id
];
5144 list_insert(&meter
->rules
, &rule
->meter_list_node
);
5148 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
5152 meter
->flags
= config
->flags
;
5153 meter
->n_bands
= config
->n_bands
;
5154 meter
->bands
= xmemdup(config
->bands
,
5155 config
->n_bands
* sizeof *meter
->bands
);
5158 static struct meter
*
5159 meter_create(const struct ofputil_meter_config
*config
,
5160 ofproto_meter_id provider_meter_id
)
5162 struct meter
*meter
;
5164 meter
= xzalloc(sizeof *meter
);
5165 meter
->provider_meter_id
= provider_meter_id
;
5166 meter
->created
= time_msec();
5167 list_init(&meter
->rules
);
5169 meter_update(meter
, config
);
5175 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5176 OVS_REQUIRES(ofproto_mutex
)
5179 for (mid
= first
; mid
<= last
; ++mid
) {
5180 struct meter
*meter
= ofproto
->meters
[mid
];
5182 ofproto
->meters
[mid
] = NULL
;
5183 ofproto
->ofproto_class
->meter_del(ofproto
,
5184 meter
->provider_meter_id
);
5192 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5194 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5195 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5199 return OFPERR_OFPMMFC_METER_EXISTS
;
5202 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5205 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5206 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5212 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5214 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5216 uint32_t provider_meter_id
;
5219 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5222 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5223 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5224 &meter
->provider_meter_id
,
5226 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5228 meter_update(meter
, &mm
->meter
);
5234 handle_delete_meter(struct ofconn
*ofconn
, struct ofputil_meter_mod
*mm
)
5235 OVS_EXCLUDED(ofproto_mutex
)
5237 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5238 uint32_t meter_id
= mm
->meter
.meter_id
;
5239 struct rule_collection rules
;
5240 enum ofperr error
= 0;
5241 uint32_t first
, last
;
5243 if (meter_id
== OFPM13_ALL
) {
5245 last
= ofproto
->meter_features
.max_meters
;
5247 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
5250 first
= last
= meter_id
;
5253 /* First delete the rules that use this meter. If any of those rules are
5254 * currently being modified, postpone the whole operation until later. */
5255 rule_collection_init(&rules
);
5256 ovs_mutex_lock(&ofproto_mutex
);
5257 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5258 struct meter
*meter
= ofproto
->meters
[meter_id
];
5259 if (meter
&& !list_is_empty(&meter
->rules
)) {
5262 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
5263 rule_collection_add(&rules
, rule
);
5268 delete_flows__(&rules
, OFPRR_METER_DELETE
, NULL
);
5271 /* Delete the meters. */
5272 meter_delete(ofproto
, first
, last
);
5274 ovs_mutex_unlock(&ofproto_mutex
);
5275 rule_collection_destroy(&rules
);
5281 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5283 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5284 struct ofputil_meter_mod mm
;
5285 uint64_t bands_stub
[256 / 8];
5286 struct ofpbuf bands
;
5290 error
= reject_slave_controller(ofconn
);
5295 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5297 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
5299 goto exit_free_bands
;
5302 meter_id
= mm
.meter
.meter_id
;
5304 if (mm
.command
!= OFPMC13_DELETE
) {
5305 /* Fails also when meters are not implemented by the provider. */
5306 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
5307 error
= OFPERR_OFPMMFC_INVALID_METER
;
5308 goto exit_free_bands
;
5309 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
5310 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
5311 goto exit_free_bands
;
5313 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
5314 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
5315 goto exit_free_bands
;
5319 switch (mm
.command
) {
5321 error
= handle_add_meter(ofproto
, &mm
);
5324 case OFPMC13_MODIFY
:
5325 error
= handle_modify_meter(ofproto
, &mm
);
5328 case OFPMC13_DELETE
:
5329 error
= handle_delete_meter(ofconn
, &mm
);
5333 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
5338 ofpbuf_uninit(&bands
);
5343 handle_meter_features_request(struct ofconn
*ofconn
,
5344 const struct ofp_header
*request
)
5346 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5347 struct ofputil_meter_features features
;
5350 if (ofproto
->ofproto_class
->meter_get_features
) {
5351 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
5353 memset(&features
, 0, sizeof features
);
5355 b
= ofputil_encode_meter_features_reply(&features
, request
);
5357 ofconn_send_reply(ofconn
, b
);
5362 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
5365 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5366 struct list replies
;
5367 uint64_t bands_stub
[256 / 8];
5368 struct ofpbuf bands
;
5369 uint32_t meter_id
, first
, last
;
5371 ofputil_decode_meter_request(request
, &meter_id
);
5373 if (meter_id
== OFPM13_ALL
) {
5375 last
= ofproto
->meter_features
.max_meters
;
5377 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
5378 !ofproto
->meters
[meter_id
]) {
5379 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5381 first
= last
= meter_id
;
5384 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5385 ofpmp_init(&replies
, request
);
5387 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5388 struct meter
*meter
= ofproto
->meters
[meter_id
];
5390 continue; /* Skip non-existing meters. */
5392 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
5393 struct ofputil_meter_stats stats
;
5395 stats
.meter_id
= meter_id
;
5397 /* Provider sets the packet and byte counts, we do the rest. */
5398 stats
.flow_count
= list_size(&meter
->rules
);
5399 calc_duration(meter
->created
, time_msec(),
5400 &stats
.duration_sec
, &stats
.duration_nsec
);
5401 stats
.n_bands
= meter
->n_bands
;
5402 ofpbuf_clear(&bands
);
5404 = ofpbuf_put_uninit(&bands
,
5405 meter
->n_bands
* sizeof *stats
.bands
);
5407 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
5408 meter
->provider_meter_id
,
5410 ofputil_append_meter_stats(&replies
, &stats
);
5412 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5413 struct ofputil_meter_config config
;
5415 config
.meter_id
= meter_id
;
5416 config
.flags
= meter
->flags
;
5417 config
.n_bands
= meter
->n_bands
;
5418 config
.bands
= meter
->bands
;
5419 ofputil_append_meter_config(&replies
, &config
);
5423 ofconn_send_replies(ofconn
, &replies
);
5424 ofpbuf_uninit(&bands
);
5429 ofproto_group_lookup__(const struct ofproto
*ofproto
, uint32_t group_id
,
5430 struct ofgroup
**group
)
5431 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5433 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5434 hash_int(group_id
, 0), &ofproto
->groups
) {
5435 if ((*group
)->group_id
== group_id
) {
5443 /* If the group exists, this function increments the groups's reference count.
5445 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5446 * a reference to the group. */
5448 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5449 struct ofgroup
**group
)
5453 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5454 found
= ofproto_group_lookup__(ofproto
, group_id
, group
);
5456 ofproto_group_ref(*group
);
5458 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5463 ofproto_group_exists__(const struct ofproto
*ofproto
, uint32_t group_id
)
5464 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5466 struct ofgroup
*grp
;
5468 HMAP_FOR_EACH_IN_BUCKET (grp
, hmap_node
,
5469 hash_int(group_id
, 0), &ofproto
->groups
) {
5470 if (grp
->group_id
== group_id
) {
5478 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
5479 OVS_EXCLUDED(ofproto
->groups_rwlock
)
5483 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5484 exists
= ofproto_group_exists__(ofproto
, group_id
);
5485 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5491 group_get_ref_count(struct ofgroup
*group
)
5492 OVS_EXCLUDED(ofproto_mutex
)
5494 struct ofproto
*ofproto
= CONST_CAST(struct ofproto
*, group
->ofproto
);
5495 struct rule_criteria criteria
;
5496 struct rule_collection rules
;
5501 match_init_catchall(&match
);
5502 rule_criteria_init(&criteria
, 0xff, &match
, 0, htonll(0), htonll(0),
5503 OFPP_ANY
, group
->group_id
);
5504 ovs_mutex_lock(&ofproto_mutex
);
5505 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
5506 ovs_mutex_unlock(&ofproto_mutex
);
5507 rule_criteria_destroy(&criteria
);
5509 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
5511 rule_collection_destroy(&rules
);
5516 append_group_stats(struct ofgroup
*group
, struct list
*replies
)
5518 struct ofputil_group_stats ogs
;
5519 const struct ofproto
*ofproto
= group
->ofproto
;
5520 long long int now
= time_msec();
5523 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
5525 /* Provider sets the packet and byte counts, we do the rest. */
5526 ogs
.ref_count
= group_get_ref_count(group
);
5527 ogs
.n_buckets
= group
->n_buckets
;
5529 error
= (ofproto
->ofproto_class
->group_get_stats
5530 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
5533 ogs
.packet_count
= UINT64_MAX
;
5534 ogs
.byte_count
= UINT64_MAX
;
5535 memset(ogs
.bucket_stats
, 0xff,
5536 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
5539 ogs
.group_id
= group
->group_id
;
5540 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
5542 ofputil_append_group_stats(replies
, &ogs
);
5544 free(ogs
.bucket_stats
);
5548 handle_group_request(struct ofconn
*ofconn
,
5549 const struct ofp_header
*request
, uint32_t group_id
,
5550 void (*cb
)(struct ofgroup
*, struct list
*replies
))
5552 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5553 struct ofgroup
*group
;
5554 struct list replies
;
5556 ofpmp_init(&replies
, request
);
5557 if (group_id
== OFPG_ALL
) {
5558 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5559 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5560 cb(group
, &replies
);
5562 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5564 if (ofproto_group_lookup(ofproto
, group_id
, &group
)) {
5565 cb(group
, &replies
);
5566 ofproto_group_unref(group
);
5569 ofconn_send_replies(ofconn
, &replies
);
5573 handle_group_stats_request(struct ofconn
*ofconn
,
5574 const struct ofp_header
*request
)
5579 error
= ofputil_decode_group_stats_request(request
, &group_id
);
5584 handle_group_request(ofconn
, request
, group_id
, append_group_stats
);
5589 append_group_desc(struct ofgroup
*group
, struct list
*replies
)
5591 struct ofputil_group_desc gds
;
5593 gds
.group_id
= group
->group_id
;
5594 gds
.type
= group
->type
;
5595 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, replies
);
5599 handle_group_desc_stats_request(struct ofconn
*ofconn
,
5600 const struct ofp_header
*request
)
5602 handle_group_request(ofconn
, request
,
5603 ofputil_decode_group_desc_request(request
),
5609 handle_group_features_stats_request(struct ofconn
*ofconn
,
5610 const struct ofp_header
*request
)
5612 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5615 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
5617 ofconn_send_reply(ofconn
, msg
);
5624 handle_queue_get_config_request(struct ofconn
*ofconn
,
5625 const struct ofp_header
*oh
)
5627 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5628 struct netdev_queue_dump queue_dump
;
5629 struct ofport
*ofport
;
5630 unsigned int queue_id
;
5631 struct ofpbuf
*reply
;
5632 struct smap details
;
5636 error
= ofputil_decode_queue_get_config_request(oh
, &request
);
5641 ofport
= ofproto_get_port(p
, request
);
5643 return OFPERR_OFPQOFC_BAD_PORT
;
5646 reply
= ofputil_encode_queue_get_config_reply(oh
);
5648 smap_init(&details
);
5649 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
, ofport
->netdev
) {
5650 struct ofputil_queue_config queue
;
5652 /* None of the existing queues have compatible properties, so we
5653 * hard-code omitting min_rate and max_rate. */
5654 queue
.queue_id
= queue_id
;
5655 queue
.min_rate
= UINT16_MAX
;
5656 queue
.max_rate
= UINT16_MAX
;
5657 ofputil_append_queue_get_config_reply(reply
, &queue
);
5659 smap_destroy(&details
);
5661 ofconn_send_reply(ofconn
, reply
);
5667 init_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
,
5668 struct ofgroup
**ofgroup
)
5671 const long long int now
= time_msec();
5673 if (gm
->group_id
> OFPG_MAX
) {
5674 return OFPERR_OFPGMFC_INVALID_GROUP
;
5676 if (gm
->type
> OFPGT11_FF
) {
5677 return OFPERR_OFPGMFC_BAD_TYPE
;
5680 *ofgroup
= ofproto
->ofproto_class
->group_alloc();
5682 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
5683 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5686 (*ofgroup
)->ofproto
= ofproto
;
5687 *CONST_CAST(uint32_t *, &((*ofgroup
)->group_id
)) = gm
->group_id
;
5688 *CONST_CAST(enum ofp11_group_type
*, &(*ofgroup
)->type
) = gm
->type
;
5689 *CONST_CAST(long long int *, &((*ofgroup
)->created
)) = now
;
5690 *CONST_CAST(long long int *, &((*ofgroup
)->modified
)) = now
;
5691 ovs_refcount_init(&(*ofgroup
)->ref_count
);
5693 list_move(&(*ofgroup
)->buckets
, &gm
->buckets
);
5694 *CONST_CAST(uint32_t *, &(*ofgroup
)->n_buckets
) =
5695 list_size(&(*ofgroup
)->buckets
);
5697 /* Construct called BEFORE any locks are held. */
5698 error
= ofproto
->ofproto_class
->group_construct(*ofgroup
);
5700 ofputil_bucket_list_destroy(&(*ofgroup
)->buckets
);
5701 ofproto
->ofproto_class
->group_dealloc(*ofgroup
);
5706 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
5707 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
5710 add_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5712 struct ofgroup
*ofgroup
;
5715 /* Allocate new group and initialize it. */
5716 error
= init_group(ofproto
, gm
, &ofgroup
);
5721 /* We wrlock as late as possible to minimize the time we jam any other
5722 * threads: No visible state changes before acquiring the lock. */
5723 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5725 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5726 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5730 if (ofproto_group_exists__(ofproto
, gm
->group_id
)) {
5731 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
5736 /* Insert new group. */
5737 hmap_insert(&ofproto
->groups
, &ofgroup
->hmap_node
,
5738 hash_int(ofgroup
->group_id
, 0));
5739 ofproto
->n_groups
[ofgroup
->type
]++;
5741 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5746 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5747 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5748 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5749 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5754 /* Implements OFPGC11_MODIFY. Returns 0 on success or an OpenFlow error code
5757 * Note that the group is re-created and then replaces the old group in
5758 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
5759 * the xlate module hold a pointer to the group. */
5761 modify_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5763 struct ofgroup
*ofgroup
, *new_ofgroup
, *retiring
;
5766 error
= init_group(ofproto
, gm
, &new_ofgroup
);
5771 retiring
= new_ofgroup
;
5773 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5774 if (!ofproto_group_lookup__(ofproto
, gm
->group_id
, &ofgroup
)) {
5775 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
5779 /* Ofproto's group write lock is held now. */
5780 if (ofgroup
->type
!= gm
->type
5781 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5782 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5786 /* The group creation time does not change during modification. */
5787 *CONST_CAST(long long int *, &(new_ofgroup
->created
)) = ofgroup
->created
;
5788 *CONST_CAST(long long int *, &(new_ofgroup
->modified
)) = time_msec();
5790 error
= ofproto
->ofproto_class
->group_modify(new_ofgroup
);
5796 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
5797 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5798 hmap_insert(&ofproto
->groups
, &new_ofgroup
->hmap_node
,
5799 hash_int(new_ofgroup
->group_id
, 0));
5800 if (ofgroup
->type
!= new_ofgroup
->type
) {
5801 ofproto
->n_groups
[ofgroup
->type
]--;
5802 ofproto
->n_groups
[new_ofgroup
->type
]++;
5806 ofproto_group_unref(retiring
);
5807 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5812 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
5813 OVS_RELEASES(ofproto
->groups_rwlock
)
5816 struct ofputil_flow_mod fm
;
5818 /* Delete all flow entries containing this group in a group action */
5819 match_init_catchall(&match
);
5820 flow_mod_init(&fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
5821 fm
.delete_reason
= OFPRR_GROUP_DELETE
;
5822 fm
.out_group
= ofgroup
->group_id
;
5823 handle_flow_mod__(ofproto
, &fm
, NULL
);
5825 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5826 /* No-one can find this group any more. */
5827 ofproto
->n_groups
[ofgroup
->type
]--;
5828 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5829 ofproto_group_unref(ofgroup
);
5832 /* Implements OFPGC11_DELETE. */
5834 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
5836 struct ofgroup
*ofgroup
;
5838 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5839 if (group_id
== OFPG_ALL
) {
5841 struct hmap_node
*node
= hmap_first(&ofproto
->groups
);
5845 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, hmap_node
);
5846 delete_group__(ofproto
, ofgroup
);
5847 /* Lock for each node separately, so that we will not jam the
5848 * other threads for too long time. */
5849 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5852 HMAP_FOR_EACH_IN_BUCKET (ofgroup
, hmap_node
,
5853 hash_int(group_id
, 0), &ofproto
->groups
) {
5854 if (ofgroup
->group_id
== group_id
) {
5855 delete_group__(ofproto
, ofgroup
);
5860 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5864 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5866 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5867 struct ofputil_group_mod gm
;
5870 error
= reject_slave_controller(ofconn
);
5875 error
= ofputil_decode_group_mod(oh
, &gm
);
5880 switch (gm
.command
) {
5882 return add_group(ofproto
, &gm
);
5884 case OFPGC11_MODIFY
:
5885 return modify_group(ofproto
, &gm
);
5887 case OFPGC11_DELETE
:
5888 delete_group(ofproto
, gm
.group_id
);
5892 if (gm
.command
> OFPGC11_DELETE
) {
5893 VLOG_WARN_RL(&rl
, "%s: Invalid group_mod command type %d",
5894 ofproto
->name
, gm
.command
);
5896 return OFPERR_OFPGMFC_BAD_COMMAND
;
5900 enum ofputil_table_miss
5901 ofproto_table_get_miss_config(const struct ofproto
*ofproto
, uint8_t table_id
)
5903 enum ofputil_table_miss value
;
5905 atomic_read_relaxed(&ofproto
->tables
[table_id
].miss_config
, &value
);
5910 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
5912 if (!check_table_id(ofproto
, tm
->table_id
)) {
5913 return OFPERR_OFPTMFC_BAD_TABLE
;
5914 } else if (tm
->miss_config
!= OFPUTIL_TABLE_MISS_DEFAULT
) {
5915 if (tm
->table_id
== OFPTT_ALL
) {
5917 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
5918 atomic_store_relaxed(&ofproto
->tables
[i
].miss_config
,
5922 atomic_store_relaxed(&ofproto
->tables
[tm
->table_id
].miss_config
,
5930 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5932 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5933 struct ofputil_table_mod tm
;
5936 error
= reject_slave_controller(ofconn
);
5941 error
= ofputil_decode_table_mod(oh
, &tm
);
5946 return table_mod(ofproto
, &tm
);
5950 handle_bundle_control(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5953 struct ofputil_bundle_ctrl_msg bctrl
;
5955 struct ofputil_bundle_ctrl_msg reply
;
5957 error
= ofputil_decode_bundle_ctrl(oh
, &bctrl
);
5962 reply
.bundle_id
= bctrl
.bundle_id
;
5964 switch (bctrl
.type
) {
5965 case OFPBCT_OPEN_REQUEST
:
5966 error
= ofp_bundle_open(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
5967 reply
.type
= OFPBCT_OPEN_REPLY
;
5969 case OFPBCT_CLOSE_REQUEST
:
5970 error
= ofp_bundle_close(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
5971 reply
.type
= OFPBCT_CLOSE_REPLY
;;
5973 case OFPBCT_COMMIT_REQUEST
:
5974 error
= ofp_bundle_commit(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
5975 reply
.type
= OFPBCT_COMMIT_REPLY
;
5977 case OFPBCT_DISCARD_REQUEST
:
5978 error
= ofp_bundle_discard(ofconn
, bctrl
.bundle_id
);
5979 reply
.type
= OFPBCT_DISCARD_REPLY
;
5982 case OFPBCT_OPEN_REPLY
:
5983 case OFPBCT_CLOSE_REPLY
:
5984 case OFPBCT_COMMIT_REPLY
:
5985 case OFPBCT_DISCARD_REPLY
:
5986 return OFPERR_OFPBFC_BAD_TYPE
;
5991 buf
= ofputil_encode_bundle_ctrl_reply(oh
, &reply
);
5992 ofconn_send_reply(ofconn
, buf
);
5999 handle_bundle_add(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6002 struct ofputil_bundle_add_msg badd
;
6004 error
= ofputil_decode_bundle_add(oh
, &badd
);
6009 return ofp_bundle_add_message(ofconn
, &badd
);
6013 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
6014 OVS_EXCLUDED(ofproto_mutex
)
6016 const struct ofp_header
*oh
= ofpbuf_data(msg
);
6020 error
= ofptype_decode(&type
, oh
);
6024 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
6025 && ofpmp_more(oh
)) {
6026 /* We have no buffer implementation for multipart requests.
6027 * Report overflow for requests which consists of multiple
6029 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
6033 /* OpenFlow requests. */
6034 case OFPTYPE_ECHO_REQUEST
:
6035 return handle_echo_request(ofconn
, oh
);
6037 case OFPTYPE_FEATURES_REQUEST
:
6038 return handle_features_request(ofconn
, oh
);
6040 case OFPTYPE_GET_CONFIG_REQUEST
:
6041 return handle_get_config_request(ofconn
, oh
);
6043 case OFPTYPE_SET_CONFIG
:
6044 return handle_set_config(ofconn
, oh
);
6046 case OFPTYPE_PACKET_OUT
:
6047 return handle_packet_out(ofconn
, oh
);
6049 case OFPTYPE_PORT_MOD
:
6050 return handle_port_mod(ofconn
, oh
);
6052 case OFPTYPE_FLOW_MOD
:
6053 return handle_flow_mod(ofconn
, oh
);
6055 case OFPTYPE_GROUP_MOD
:
6056 return handle_group_mod(ofconn
, oh
);
6058 case OFPTYPE_TABLE_MOD
:
6059 return handle_table_mod(ofconn
, oh
);
6061 case OFPTYPE_METER_MOD
:
6062 return handle_meter_mod(ofconn
, oh
);
6064 case OFPTYPE_BARRIER_REQUEST
:
6065 return handle_barrier_request(ofconn
, oh
);
6067 case OFPTYPE_ROLE_REQUEST
:
6068 return handle_role_request(ofconn
, oh
);
6070 /* OpenFlow replies. */
6071 case OFPTYPE_ECHO_REPLY
:
6074 /* Nicira extension requests. */
6075 case OFPTYPE_FLOW_MOD_TABLE_ID
:
6076 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
6078 case OFPTYPE_SET_FLOW_FORMAT
:
6079 return handle_nxt_set_flow_format(ofconn
, oh
);
6081 case OFPTYPE_SET_PACKET_IN_FORMAT
:
6082 return handle_nxt_set_packet_in_format(ofconn
, oh
);
6084 case OFPTYPE_SET_CONTROLLER_ID
:
6085 return handle_nxt_set_controller_id(ofconn
, oh
);
6087 case OFPTYPE_FLOW_AGE
:
6088 /* Nothing to do. */
6091 case OFPTYPE_FLOW_MONITOR_CANCEL
:
6092 return handle_flow_monitor_cancel(ofconn
, oh
);
6094 case OFPTYPE_SET_ASYNC_CONFIG
:
6095 return handle_nxt_set_async_config(ofconn
, oh
);
6097 case OFPTYPE_GET_ASYNC_REQUEST
:
6098 return handle_nxt_get_async_request(ofconn
, oh
);
6100 /* Statistics requests. */
6101 case OFPTYPE_DESC_STATS_REQUEST
:
6102 return handle_desc_stats_request(ofconn
, oh
);
6104 case OFPTYPE_FLOW_STATS_REQUEST
:
6105 return handle_flow_stats_request(ofconn
, oh
);
6107 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
6108 return handle_aggregate_stats_request(ofconn
, oh
);
6110 case OFPTYPE_TABLE_STATS_REQUEST
:
6111 return handle_table_stats_request(ofconn
, oh
);
6113 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
6114 return handle_table_features_request(ofconn
, oh
);
6116 case OFPTYPE_PORT_STATS_REQUEST
:
6117 return handle_port_stats_request(ofconn
, oh
);
6119 case OFPTYPE_QUEUE_STATS_REQUEST
:
6120 return handle_queue_stats_request(ofconn
, oh
);
6122 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
6123 return handle_port_desc_stats_request(ofconn
, oh
);
6125 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
6126 return handle_flow_monitor_request(ofconn
, oh
);
6128 case OFPTYPE_METER_STATS_REQUEST
:
6129 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
6130 return handle_meter_request(ofconn
, oh
, type
);
6132 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
6133 return handle_meter_features_request(ofconn
, oh
);
6135 case OFPTYPE_GROUP_STATS_REQUEST
:
6136 return handle_group_stats_request(ofconn
, oh
);
6138 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
6139 return handle_group_desc_stats_request(ofconn
, oh
);
6141 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
6142 return handle_group_features_stats_request(ofconn
, oh
);
6144 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
6145 return handle_queue_get_config_request(ofconn
, oh
);
6147 case OFPTYPE_BUNDLE_CONTROL
:
6148 return handle_bundle_control(ofconn
, oh
);
6150 case OFPTYPE_BUNDLE_ADD_MESSAGE
:
6151 return handle_bundle_add(ofconn
, oh
);
6155 case OFPTYPE_FEATURES_REPLY
:
6156 case OFPTYPE_GET_CONFIG_REPLY
:
6157 case OFPTYPE_PACKET_IN
:
6158 case OFPTYPE_FLOW_REMOVED
:
6159 case OFPTYPE_PORT_STATUS
:
6160 case OFPTYPE_BARRIER_REPLY
:
6161 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
6162 case OFPTYPE_DESC_STATS_REPLY
:
6163 case OFPTYPE_FLOW_STATS_REPLY
:
6164 case OFPTYPE_QUEUE_STATS_REPLY
:
6165 case OFPTYPE_PORT_STATS_REPLY
:
6166 case OFPTYPE_TABLE_STATS_REPLY
:
6167 case OFPTYPE_AGGREGATE_STATS_REPLY
:
6168 case OFPTYPE_PORT_DESC_STATS_REPLY
:
6169 case OFPTYPE_ROLE_REPLY
:
6170 case OFPTYPE_FLOW_MONITOR_PAUSED
:
6171 case OFPTYPE_FLOW_MONITOR_RESUMED
:
6172 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
6173 case OFPTYPE_GET_ASYNC_REPLY
:
6174 case OFPTYPE_GROUP_STATS_REPLY
:
6175 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
6176 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
6177 case OFPTYPE_METER_STATS_REPLY
:
6178 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
6179 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
6180 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
6181 case OFPTYPE_ROLE_STATUS
:
6183 if (ofpmsg_is_stat_request(oh
)) {
6184 return OFPERR_OFPBRC_BAD_STAT
;
6186 return OFPERR_OFPBRC_BAD_TYPE
;
6192 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
6193 OVS_EXCLUDED(ofproto_mutex
)
6195 int error
= handle_openflow__(ofconn
, ofp_msg
);
6197 ofconn_send_error(ofconn
, ofpbuf_data(ofp_msg
), error
);
6199 COVERAGE_INC(ofproto_recv_openflow
);
6202 /* Asynchronous operations. */
6205 send_buffered_packet(struct ofconn
*ofconn
, uint32_t buffer_id
,
6207 OVS_REQUIRES(ofproto_mutex
)
6209 enum ofperr error
= 0;
6210 if (ofconn
&& buffer_id
!= UINT32_MAX
) {
6211 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6212 struct ofpbuf
*packet
;
6215 error
= ofconn_pktbuf_retrieve(ofconn
, buffer_id
, &packet
, &in_port
);
6217 struct rule_execute
*re
;
6219 ofproto_rule_ref(rule
);
6221 re
= xmalloc(sizeof *re
);
6223 re
->in_port
= in_port
;
6224 re
->packet
= packet
;
6226 if (!guarded_list_push_back(&ofproto
->rule_executes
,
6227 &re
->list_node
, 1024)) {
6228 ofproto_rule_unref(rule
);
6229 ofpbuf_delete(re
->packet
);
6238 pick_datapath_id(const struct ofproto
*ofproto
)
6240 const struct ofport
*port
;
6242 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
6244 uint8_t ea
[ETH_ADDR_LEN
];
6247 error
= netdev_get_etheraddr(port
->netdev
, ea
);
6249 return eth_addr_to_uint64(ea
);
6251 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6252 ofproto
->name
, netdev_get_name(port
->netdev
),
6253 ovs_strerror(error
));
6255 return ofproto
->fallback_dpid
;
6259 pick_fallback_dpid(void)
6261 uint8_t ea
[ETH_ADDR_LEN
];
6262 eth_addr_nicira_random(ea
);
6263 return eth_addr_to_uint64(ea
);
6266 /* Table overflow policy. */
6268 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6269 * to NULL if the table is not configured to evict rules or if the table
6270 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6271 * or with no timeouts are not evictable.) */
6273 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
6274 OVS_REQUIRES(ofproto_mutex
)
6276 struct eviction_group
*evg
;
6279 if (!table
->eviction_fields
) {
6283 /* In the common case, the outer and inner loops here will each be entered
6286 * - The inner loop normally "return"s in its first iteration. If the
6287 * eviction group has any evictable rules, then it always returns in
6290 * - The outer loop only iterates more than once if the largest eviction
6291 * group has no evictable rules.
6293 * - The outer loop can exit only if table's 'max_flows' is all filled up
6294 * by unevictable rules. */
6295 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
6298 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
6307 /* Eviction groups. */
6309 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6310 * rules. The priority contains low-order random bits to ensure that eviction
6311 * groups with the same number of rules are prioritized randomly. */
6313 eviction_group_priority(size_t n_rules
)
6315 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
6316 return (size
<< 16) | random_uint16();
6319 /* Updates 'evg', an eviction_group within 'table', following a change that
6320 * adds or removes rules in 'evg'. */
6322 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
6323 OVS_REQUIRES(ofproto_mutex
)
6325 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
6326 eviction_group_priority(heap_count(&evg
->rules
)));
6329 /* Destroys 'evg', an eviction_group within 'table':
6331 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6332 * rules themselves, just removes them from the eviction group.)
6334 * - Removes 'evg' from 'table'.
6338 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
6339 OVS_REQUIRES(ofproto_mutex
)
6341 while (!heap_is_empty(&evg
->rules
)) {
6344 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
6345 rule
->eviction_group
= NULL
;
6347 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
6348 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
6349 heap_destroy(&evg
->rules
);
6353 /* Removes 'rule' from its eviction group, if any. */
6355 eviction_group_remove_rule(struct rule
*rule
)
6356 OVS_REQUIRES(ofproto_mutex
)
6358 if (rule
->eviction_group
) {
6359 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6360 struct eviction_group
*evg
= rule
->eviction_group
;
6362 rule
->eviction_group
= NULL
;
6363 heap_remove(&evg
->rules
, &rule
->evg_node
);
6364 if (heap_is_empty(&evg
->rules
)) {
6365 eviction_group_destroy(table
, evg
);
6367 eviction_group_resized(table
, evg
);
6372 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6373 * returns the hash value. */
6375 eviction_group_hash_rule(struct rule
*rule
)
6376 OVS_REQUIRES(ofproto_mutex
)
6378 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6379 const struct mf_subfield
*sf
;
6383 hash
= table
->eviction_group_id_basis
;
6384 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
6385 for (sf
= table
->eviction_fields
;
6386 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
6389 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
6390 union mf_value value
;
6392 mf_get_value(sf
->field
, &flow
, &value
);
6394 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
6396 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
6397 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
6398 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
6399 sf
->field
->n_bytes
* 8 - start
);
6401 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
6403 hash
= hash_int(hash
, 0);
6410 /* Returns an eviction group within 'table' with the given 'id', creating one
6412 static struct eviction_group
*
6413 eviction_group_find(struct oftable
*table
, uint32_t id
)
6414 OVS_REQUIRES(ofproto_mutex
)
6416 struct eviction_group
*evg
;
6418 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
6422 evg
= xmalloc(sizeof *evg
);
6423 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
6424 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
6425 eviction_group_priority(0));
6426 heap_init(&evg
->rules
);
6431 /* Returns an eviction priority for 'rule'. The return value should be
6432 * interpreted so that higher priorities make a rule more attractive candidates
6434 * Called only if have a timeout. */
6436 rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*rule
)
6437 OVS_REQUIRES(ofproto_mutex
)
6439 long long int expiration
= LLONG_MAX
;
6440 long long int modified
;
6441 uint32_t expiration_offset
;
6443 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6444 ovs_mutex_lock(&rule
->mutex
);
6445 modified
= rule
->modified
;
6446 ovs_mutex_unlock(&rule
->mutex
);
6448 if (rule
->hard_timeout
) {
6449 expiration
= modified
+ rule
->hard_timeout
* 1000;
6451 if (rule
->idle_timeout
) {
6452 uint64_t packets
, bytes
;
6454 long long int idle_expiration
;
6456 ofproto
->ofproto_class
->rule_get_stats(rule
, &packets
, &bytes
, &used
);
6457 idle_expiration
= used
+ rule
->idle_timeout
* 1000;
6458 expiration
= MIN(expiration
, idle_expiration
);
6461 if (expiration
== LLONG_MAX
) {
6465 /* Calculate the time of expiration as a number of (approximate) seconds
6466 * after program startup.
6468 * This should work OK for program runs that last UINT32_MAX seconds or
6469 * less. Therefore, please restart OVS at least once every 136 years. */
6470 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
6472 /* Invert the expiration offset because we're using a max-heap. */
6473 return UINT32_MAX
- expiration_offset
;
6476 /* Adds 'rule' to an appropriate eviction group for its oftable's
6477 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6478 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6481 * The caller must ensure that 'rule' is not already in an eviction group. */
6483 eviction_group_add_rule(struct rule
*rule
)
6484 OVS_REQUIRES(ofproto_mutex
)
6486 struct ofproto
*ofproto
= rule
->ofproto
;
6487 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6490 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6491 * so no additional protection is needed. */
6492 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
6494 if (table
->eviction_fields
&& has_timeout
) {
6495 struct eviction_group
*evg
;
6497 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
6499 rule
->eviction_group
= evg
;
6500 heap_insert(&evg
->rules
, &rule
->evg_node
,
6501 rule_eviction_priority(ofproto
, rule
));
6502 eviction_group_resized(table
, evg
);
6508 /* Initializes 'table'. */
6510 oftable_init(struct oftable
*table
)
6512 memset(table
, 0, sizeof *table
);
6513 classifier_init(&table
->cls
, flow_segment_u32s
);
6514 table
->max_flows
= UINT_MAX
;
6515 atomic_init(&table
->miss_config
, OFPUTIL_TABLE_MISS_DEFAULT
);
6517 classifier_set_prefix_fields(&table
->cls
, default_prefix_fields
,
6518 ARRAY_SIZE(default_prefix_fields
));
6520 atomic_init(&table
->n_matched
, 0);
6521 atomic_init(&table
->n_missed
, 0);
6524 /* Destroys 'table', including its classifier and eviction groups.
6526 * The caller is responsible for freeing 'table' itself. */
6528 oftable_destroy(struct oftable
*table
)
6530 ovs_assert(classifier_is_empty(&table
->cls
));
6531 oftable_disable_eviction(table
);
6532 classifier_destroy(&table
->cls
);
6536 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6537 * string, then 'table' will use its default name.
6539 * This only affects the name exposed for a table exposed through the OpenFlow
6540 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6542 oftable_set_name(struct oftable
*table
, const char *name
)
6544 if (name
&& name
[0]) {
6545 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
6546 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
6548 table
->name
= xmemdup0(name
, len
);
6556 /* oftables support a choice of two policies when adding a rule would cause the
6557 * number of flows in the table to exceed the configured maximum number: either
6558 * they can refuse to add the new flow or they can evict some existing flow.
6559 * This function configures the former policy on 'table'. */
6561 oftable_disable_eviction(struct oftable
*table
)
6562 OVS_REQUIRES(ofproto_mutex
)
6564 if (table
->eviction_fields
) {
6565 struct eviction_group
*evg
, *next
;
6567 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
6568 &table
->eviction_groups_by_id
) {
6569 eviction_group_destroy(table
, evg
);
6571 hmap_destroy(&table
->eviction_groups_by_id
);
6572 heap_destroy(&table
->eviction_groups_by_size
);
6574 free(table
->eviction_fields
);
6575 table
->eviction_fields
= NULL
;
6576 table
->n_eviction_fields
= 0;
6580 /* oftables support a choice of two policies when adding a rule would cause the
6581 * number of flows in the table to exceed the configured maximum number: either
6582 * they can refuse to add the new flow or they can evict some existing flow.
6583 * This function configures the latter policy on 'table', with fairness based
6584 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6585 * 'n_fields' as 0 disables fairness.) */
6587 oftable_enable_eviction(struct oftable
*table
,
6588 const struct mf_subfield
*fields
, size_t n_fields
)
6589 OVS_REQUIRES(ofproto_mutex
)
6593 if (table
->eviction_fields
6594 && n_fields
== table
->n_eviction_fields
6596 || !memcmp(fields
, table
->eviction_fields
,
6597 n_fields
* sizeof *fields
))) {
6602 oftable_disable_eviction(table
);
6604 table
->n_eviction_fields
= n_fields
;
6605 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
6607 table
->eviction_group_id_basis
= random_uint32();
6608 hmap_init(&table
->eviction_groups_by_id
);
6609 heap_init(&table
->eviction_groups_by_size
);
6611 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
6612 eviction_group_add_rule(rule
);
6616 /* Removes 'rule' from the oftable that contains it. */
6618 oftable_remove_rule__(struct ofproto
*ofproto
, struct rule
*rule
)
6619 OVS_REQUIRES(ofproto_mutex
)
6621 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
6623 classifier_remove(cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
6625 cookies_remove(ofproto
, rule
);
6627 eviction_group_remove_rule(rule
);
6628 if (!list_is_empty(&rule
->expirable
)) {
6629 list_remove(&rule
->expirable
);
6631 if (!list_is_empty(&rule
->meter_list_node
)) {
6632 list_remove(&rule
->meter_list_node
);
6633 list_init(&rule
->meter_list_node
);
6638 oftable_remove_rule(struct rule
*rule
)
6639 OVS_REQUIRES(ofproto_mutex
)
6641 oftable_remove_rule__(rule
->ofproto
, rule
);
6644 /* unixctl commands. */
6647 ofproto_lookup(const char *name
)
6649 struct ofproto
*ofproto
;
6651 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
6653 if (!strcmp(ofproto
->name
, name
)) {
6661 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
6662 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
6664 struct ofproto
*ofproto
;
6668 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
6669 ds_put_format(&results
, "%s\n", ofproto
->name
);
6671 unixctl_command_reply(conn
, ds_cstr(&results
));
6672 ds_destroy(&results
);
6676 ofproto_unixctl_init(void)
6678 static bool registered
;
6684 unixctl_command_register("ofproto/list", "", 0, 0,
6685 ofproto_unixctl_list
, NULL
);
6688 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6690 * This is deprecated. It is only for compatibility with broken device drivers
6691 * in old versions of Linux that do not properly support VLANs when VLAN
6692 * devices are not used. When broken device drivers are no longer in
6693 * widespread use, we will delete these interfaces. */
6695 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6696 * (exactly) by an OpenFlow rule in 'ofproto'. */
6698 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
6701 struct cls_rule target
;
6702 const struct oftable
*oftable
;
6704 match_init_catchall(&match
);
6705 match_set_vlan_vid_masked(&match
, htons(VLAN_CFI
), htons(VLAN_CFI
));
6706 cls_rule_init(&target
, &match
, 0);
6708 free(ofproto
->vlan_bitmap
);
6709 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
6710 ofproto
->vlans_changed
= false;
6712 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
6715 CLS_FOR_EACH_TARGET (rule
, cr
, &oftable
->cls
, &target
) {
6716 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
6717 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
6719 bitmap_set1(vlan_bitmap
, vid
);
6720 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6725 cls_rule_destroy(&target
);
6728 /* Returns true if new VLANs have come into use by the flow table since the
6729 * last call to ofproto_get_vlan_usage().
6731 * We don't track when old VLANs stop being used. */
6733 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
6735 return ofproto
->vlans_changed
;
6738 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6739 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6740 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6741 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6742 * then the VLAN device is un-enslaved. */
6744 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
6745 ofp_port_t realdev_ofp_port
, int vid
)
6747 struct ofport
*ofport
;
6750 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
6752 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
6754 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
6755 ofproto
->name
, vlandev_ofp_port
);
6759 if (!ofproto
->ofproto_class
->set_realdev
) {
6760 if (!vlandev_ofp_port
) {
6763 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
6767 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
6769 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
6770 ofproto
->name
, vlandev_ofp_port
,
6771 netdev_get_name(ofport
->netdev
), ovs_strerror(error
));