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
, int priority
,
157 ovs_be64 cookie
, ovs_be64 cookie_mask
,
158 ofp_port_t out_port
, uint32_t out_group
);
159 static void rule_criteria_require_rw(struct rule_criteria
*,
160 bool can_write_readonly
);
161 static void rule_criteria_destroy(struct rule_criteria
*);
163 static enum ofperr
collect_rules_loose(struct ofproto
*,
164 const struct rule_criteria
*,
165 struct rule_collection
*);
167 /* A packet that needs to be passed to rule_execute().
169 * (We can't do this immediately from ofopgroup_complete() because that holds
170 * ofproto_mutex, which rule_execute() needs released.) */
171 struct rule_execute
{
172 struct list list_node
; /* In struct ofproto's "rule_executes" list. */
173 struct rule
*rule
; /* Owns a reference to the rule. */
175 struct ofpbuf
*packet
; /* Owns the packet. */
178 static void run_rule_executes(struct ofproto
*) OVS_EXCLUDED(ofproto_mutex
);
179 static void destroy_rule_executes(struct ofproto
*);
181 struct learned_cookie
{
183 /* In struct ofproto's 'learned_cookies' hmap. */
184 struct hmap_node hmap_node
OVS_GUARDED_BY(ofproto_mutex
);
186 /* In 'dead_cookies' list when removed from hmap. */
187 struct list list_node
;
191 ovs_be64 cookie
OVS_GUARDED_BY(ofproto_mutex
);
192 uint8_t table_id
OVS_GUARDED_BY(ofproto_mutex
);
194 /* Number of references from "learn" actions.
196 * When this drops to 0, all of the flows in 'table_id' with the specified
197 * 'cookie' are deleted. */
198 int n
OVS_GUARDED_BY(ofproto_mutex
);
201 static const struct ofpact_learn
*next_learn_with_delete(
202 const struct rule_actions
*, const struct ofpact_learn
*start
);
204 static void learned_cookies_inc(struct ofproto
*, const struct rule_actions
*)
205 OVS_REQUIRES(ofproto_mutex
);
206 static void learned_cookies_dec(struct ofproto
*, const struct rule_actions
*,
207 struct list
*dead_cookies
)
208 OVS_REQUIRES(ofproto_mutex
);
209 static void learned_cookies_flush(struct ofproto
*, struct list
*dead_cookies
)
210 OVS_REQUIRES(ofproto_mutex
);
213 static void ofport_destroy__(struct ofport
*) OVS_EXCLUDED(ofproto_mutex
);
214 static void ofport_destroy(struct ofport
*);
216 static void update_port(struct ofproto
*, const char *devname
);
217 static int init_ports(struct ofproto
*);
218 static void reinit_ports(struct ofproto
*);
220 static long long int ofport_get_usage(const struct ofproto
*,
221 ofp_port_t ofp_port
);
222 static void ofport_set_usage(struct ofproto
*, ofp_port_t ofp_port
,
223 long long int last_used
);
224 static void ofport_remove_usage(struct ofproto
*, ofp_port_t ofp_port
);
228 * Keeps track of the currently used and recently used ofport values and is
229 * used to prevent immediate recycling of ofport values. */
230 struct ofport_usage
{
231 struct hmap_node hmap_node
; /* In struct ofproto's "ofport_usage" hmap. */
232 ofp_port_t ofp_port
; /* OpenFlow port number. */
233 long long int last_used
; /* Last time the 'ofp_port' was used. LLONG_MAX
234 represents in-use ofports. */
238 static void ofproto_rule_send_removed(struct rule
*, uint8_t reason
);
239 static bool rule_is_readonly(const struct rule
*);
241 /* The source of a flow_mod request, in the code that processes flow_mods.
243 * A flow table modification request can be generated externally, via OpenFlow,
244 * or internally through a function call. This structure indicates the source
245 * of an OpenFlow-generated flow_mod. For an internal flow_mod, it isn't
246 * meaningful and thus supplied as NULL. */
247 struct flow_mod_requester
{
248 struct ofconn
*ofconn
; /* Connection on which flow_mod arrived. */
249 ovs_be32 xid
; /* OpenFlow xid of flow_mod request. */
253 static enum ofperr
add_flow(struct ofproto
*, struct ofputil_flow_mod
*,
254 const struct flow_mod_requester
*);
256 static enum ofperr
modify_flows__(struct ofproto
*, struct ofputil_flow_mod
*,
257 const struct rule_collection
*,
258 const struct flow_mod_requester
*);
259 static void delete_flows__(const struct rule_collection
*,
260 enum ofp_flow_removed_reason
,
261 const struct flow_mod_requester
*)
262 OVS_REQUIRES(ofproto_mutex
);
264 static enum ofperr
send_buffered_packet(struct ofconn
*, uint32_t buffer_id
,
266 OVS_REQUIRES(ofproto_mutex
);
268 static bool ofproto_group_exists__(const struct ofproto
*ofproto
,
270 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
);
271 static bool ofproto_group_exists(const struct ofproto
*ofproto
,
273 OVS_EXCLUDED(ofproto
->groups_rwlock
);
274 static enum ofperr
add_group(struct ofproto
*, struct ofputil_group_mod
*);
275 static void handle_openflow(struct ofconn
*, const struct ofpbuf
*);
276 static enum ofperr
handle_flow_mod__(struct ofproto
*,
277 struct ofputil_flow_mod
*,
278 const struct flow_mod_requester
*)
279 OVS_EXCLUDED(ofproto_mutex
);
280 static void calc_duration(long long int start
, long long int now
,
281 uint32_t *sec
, uint32_t *nsec
);
284 static uint64_t pick_datapath_id(const struct ofproto
*);
285 static uint64_t pick_fallback_dpid(void);
286 static void ofproto_destroy__(struct ofproto
*);
287 static void update_mtu(struct ofproto
*, struct ofport
*);
288 static void meter_delete(struct ofproto
*, uint32_t first
, uint32_t last
);
289 static void meter_insert_rule(struct rule
*);
292 static void ofproto_unixctl_init(void);
294 /* All registered ofproto classes, in probe order. */
295 static const struct ofproto_class
**ofproto_classes
;
296 static size_t n_ofproto_classes
;
297 static size_t allocated_ofproto_classes
;
299 /* Global lock that protects all flow table operations. */
300 struct ovs_mutex ofproto_mutex
= OVS_MUTEX_INITIALIZER
;
302 unsigned ofproto_flow_limit
= OFPROTO_FLOW_LIMIT_DEFAULT
;
303 unsigned ofproto_max_idle
= OFPROTO_MAX_IDLE_DEFAULT
;
305 size_t n_handlers
, n_revalidators
;
309 /* Map from datapath name to struct ofproto, for use by unixctl commands. */
310 static struct hmap all_ofprotos
= HMAP_INITIALIZER(&all_ofprotos
);
312 /* Initial mappings of port to OpenFlow number mappings. */
313 static struct shash init_ofp_ports
= SHASH_INITIALIZER(&init_ofp_ports
);
315 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
317 /* The default value of true waits for flow restore. */
318 static bool flow_restore_wait
= true;
320 /* Must be called to initialize the ofproto library.
322 * The caller may pass in 'iface_hints', which contains an shash of
323 * "iface_hint" elements indexed by the interface's name. The provider
324 * may use these hints to describe the startup configuration in order to
325 * reinitialize its state. The caller owns the provided data, so a
326 * provider will make copies of anything required. An ofproto provider
327 * will remove any existing state that is not described by the hint, and
328 * may choose to remove it all. */
330 ofproto_init(const struct shash
*iface_hints
)
332 struct shash_node
*node
;
335 ofproto_class_register(&ofproto_dpif_class
);
337 /* Make a local copy, since we don't own 'iface_hints' elements. */
338 SHASH_FOR_EACH(node
, iface_hints
) {
339 const struct iface_hint
*orig_hint
= node
->data
;
340 struct iface_hint
*new_hint
= xmalloc(sizeof *new_hint
);
341 const char *br_type
= ofproto_normalize_type(orig_hint
->br_type
);
343 new_hint
->br_name
= xstrdup(orig_hint
->br_name
);
344 new_hint
->br_type
= xstrdup(br_type
);
345 new_hint
->ofp_port
= orig_hint
->ofp_port
;
347 shash_add(&init_ofp_ports
, node
->name
, new_hint
);
350 for (i
= 0; i
< n_ofproto_classes
; i
++) {
351 ofproto_classes
[i
]->init(&init_ofp_ports
);
355 /* 'type' should be a normalized datapath type, as returned by
356 * ofproto_normalize_type(). Returns the corresponding ofproto_class
357 * structure, or a null pointer if there is none registered for 'type'. */
358 static const struct ofproto_class
*
359 ofproto_class_find__(const char *type
)
363 for (i
= 0; i
< n_ofproto_classes
; i
++) {
364 const struct ofproto_class
*class = ofproto_classes
[i
];
369 class->enumerate_types(&types
);
370 found
= sset_contains(&types
, type
);
371 sset_destroy(&types
);
377 VLOG_WARN("unknown datapath type %s", type
);
381 /* Registers a new ofproto class. After successful registration, new ofprotos
382 * of that type can be created using ofproto_create(). */
384 ofproto_class_register(const struct ofproto_class
*new_class
)
388 for (i
= 0; i
< n_ofproto_classes
; i
++) {
389 if (ofproto_classes
[i
] == new_class
) {
394 if (n_ofproto_classes
>= allocated_ofproto_classes
) {
395 ofproto_classes
= x2nrealloc(ofproto_classes
,
396 &allocated_ofproto_classes
,
397 sizeof *ofproto_classes
);
399 ofproto_classes
[n_ofproto_classes
++] = new_class
;
403 /* Unregisters a datapath provider. 'type' must have been previously
404 * registered and not currently be in use by any ofprotos. After
405 * unregistration new datapaths of that type cannot be opened using
406 * ofproto_create(). */
408 ofproto_class_unregister(const struct ofproto_class
*class)
412 for (i
= 0; i
< n_ofproto_classes
; i
++) {
413 if (ofproto_classes
[i
] == class) {
414 for (i
++; i
< n_ofproto_classes
; i
++) {
415 ofproto_classes
[i
- 1] = ofproto_classes
[i
];
421 VLOG_WARN("attempted to unregister an ofproto class that is not "
426 /* Clears 'types' and enumerates all registered ofproto types into it. The
427 * caller must first initialize the sset. */
429 ofproto_enumerate_types(struct sset
*types
)
434 for (i
= 0; i
< n_ofproto_classes
; i
++) {
435 ofproto_classes
[i
]->enumerate_types(types
);
439 /* Returns the fully spelled out name for the given ofproto 'type'.
441 * Normalized type string can be compared with strcmp(). Unnormalized type
442 * string might be the same even if they have different spellings. */
444 ofproto_normalize_type(const char *type
)
446 return type
&& type
[0] ? type
: "system";
449 /* Clears 'names' and enumerates the names of all known created ofprotos with
450 * the given 'type'. The caller must first initialize the sset. Returns 0 if
451 * successful, otherwise a positive errno value.
453 * Some kinds of datapaths might not be practically enumerable. This is not
454 * considered an error. */
456 ofproto_enumerate_names(const char *type
, struct sset
*names
)
458 const struct ofproto_class
*class = ofproto_class_find__(type
);
459 return class ? class->enumerate_names(type
, names
) : EAFNOSUPPORT
;
463 ofproto_create(const char *datapath_name
, const char *datapath_type
,
464 struct ofproto
**ofprotop
)
466 const struct ofproto_class
*class;
467 struct ofproto
*ofproto
;
473 ofproto_unixctl_init();
475 datapath_type
= ofproto_normalize_type(datapath_type
);
476 class = ofproto_class_find__(datapath_type
);
478 VLOG_WARN("could not create datapath %s of unknown type %s",
479 datapath_name
, datapath_type
);
483 ofproto
= class->alloc();
485 VLOG_ERR("failed to allocate datapath %s of type %s",
486 datapath_name
, datapath_type
);
491 ovs_mutex_lock(&ofproto_mutex
);
492 memset(ofproto
, 0, sizeof *ofproto
);
493 ofproto
->ofproto_class
= class;
494 ofproto
->name
= xstrdup(datapath_name
);
495 ofproto
->type
= xstrdup(datapath_type
);
496 hmap_insert(&all_ofprotos
, &ofproto
->hmap_node
,
497 hash_string(ofproto
->name
, 0));
498 ofproto
->datapath_id
= 0;
499 ofproto
->forward_bpdu
= false;
500 ofproto
->fallback_dpid
= pick_fallback_dpid();
501 ofproto
->mfr_desc
= NULL
;
502 ofproto
->hw_desc
= NULL
;
503 ofproto
->sw_desc
= NULL
;
504 ofproto
->serial_desc
= NULL
;
505 ofproto
->dp_desc
= NULL
;
506 ofproto
->frag_handling
= OFPC_FRAG_NORMAL
;
507 hmap_init(&ofproto
->ports
);
508 hmap_init(&ofproto
->ofport_usage
);
509 shash_init(&ofproto
->port_by_name
);
510 simap_init(&ofproto
->ofp_requests
);
511 ofproto
->max_ports
= ofp_to_u16(OFPP_MAX
);
512 ofproto
->eviction_group_timer
= LLONG_MIN
;
513 ofproto
->tables
= NULL
;
514 ofproto
->n_tables
= 0;
515 hindex_init(&ofproto
->cookies
);
516 hmap_init(&ofproto
->learned_cookies
);
517 list_init(&ofproto
->expirable
);
518 ofproto
->connmgr
= connmgr_create(ofproto
, datapath_name
, datapath_name
);
519 guarded_list_init(&ofproto
->rule_executes
);
520 ofproto
->vlan_bitmap
= NULL
;
521 ofproto
->vlans_changed
= false;
522 ofproto
->min_mtu
= INT_MAX
;
523 ovs_rwlock_init(&ofproto
->groups_rwlock
);
524 hmap_init(&ofproto
->groups
);
525 ovs_mutex_unlock(&ofproto_mutex
);
526 ofproto
->ogf
.types
= 0xf;
527 ofproto
->ogf
.capabilities
= OFPGFC_CHAINING
| OFPGFC_SELECT_LIVENESS
|
528 OFPGFC_SELECT_WEIGHT
;
529 for (i
= 0; i
< 4; i
++) {
530 ofproto
->ogf
.max_groups
[i
] = OFPG_MAX
;
531 ofproto
->ogf
.ofpacts
[i
] = (UINT64_C(1) << N_OFPACTS
) - 1;
534 error
= ofproto
->ofproto_class
->construct(ofproto
);
536 VLOG_ERR("failed to open datapath %s: %s",
537 datapath_name
, ovs_strerror(error
));
538 connmgr_destroy(ofproto
->connmgr
);
539 ofproto_destroy__(ofproto
);
543 /* Check that hidden tables, if any, are at the end. */
544 ovs_assert(ofproto
->n_tables
);
545 for (i
= 0; i
+ 1 < ofproto
->n_tables
; i
++) {
546 enum oftable_flags flags
= ofproto
->tables
[i
].flags
;
547 enum oftable_flags next_flags
= ofproto
->tables
[i
+ 1].flags
;
549 ovs_assert(!(flags
& OFTABLE_HIDDEN
) || next_flags
& OFTABLE_HIDDEN
);
552 ofproto
->datapath_id
= pick_datapath_id(ofproto
);
555 /* Initialize meters table. */
556 if (ofproto
->ofproto_class
->meter_get_features
) {
557 ofproto
->ofproto_class
->meter_get_features(ofproto
,
558 &ofproto
->meter_features
);
560 memset(&ofproto
->meter_features
, 0, sizeof ofproto
->meter_features
);
562 ofproto
->meters
= xzalloc((ofproto
->meter_features
.max_meters
+ 1)
563 * sizeof(struct meter
*));
569 /* Must be called (only) by an ofproto implementation in its constructor
570 * function. See the large comment on 'construct' in struct ofproto_class for
573 ofproto_init_tables(struct ofproto
*ofproto
, int n_tables
)
575 struct oftable
*table
;
577 ovs_assert(!ofproto
->n_tables
);
578 ovs_assert(n_tables
>= 1 && n_tables
<= 255);
580 ofproto
->n_tables
= n_tables
;
581 ofproto
->tables
= xmalloc(n_tables
* sizeof *ofproto
->tables
);
582 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
587 /* To be optionally called (only) by an ofproto implementation in its
588 * constructor function. See the large comment on 'construct' in struct
589 * ofproto_class for details.
591 * Sets the maximum number of ports to 'max_ports'. The ofproto generic layer
592 * will then ensure that actions passed into the ofproto implementation will
593 * not refer to OpenFlow ports numbered 'max_ports' or higher. If this
594 * function is not called, there will be no such restriction.
596 * Reserved ports numbered OFPP_MAX and higher are special and not subject to
597 * the 'max_ports' restriction. */
599 ofproto_init_max_ports(struct ofproto
*ofproto
, uint16_t max_ports
)
601 ovs_assert(max_ports
<= ofp_to_u16(OFPP_MAX
));
602 ofproto
->max_ports
= max_ports
;
606 ofproto_get_datapath_id(const struct ofproto
*ofproto
)
608 return ofproto
->datapath_id
;
612 ofproto_set_datapath_id(struct ofproto
*p
, uint64_t datapath_id
)
614 uint64_t old_dpid
= p
->datapath_id
;
615 p
->datapath_id
= datapath_id
? datapath_id
: pick_datapath_id(p
);
616 if (p
->datapath_id
!= old_dpid
) {
617 /* Force all active connections to reconnect, since there is no way to
618 * notify a controller that the datapath ID has changed. */
619 ofproto_reconnect_controllers(p
);
624 ofproto_set_controllers(struct ofproto
*p
,
625 const struct ofproto_controller
*controllers
,
626 size_t n_controllers
, uint32_t allowed_versions
)
628 connmgr_set_controllers(p
->connmgr
, controllers
, n_controllers
,
633 ofproto_set_fail_mode(struct ofproto
*p
, enum ofproto_fail_mode fail_mode
)
635 connmgr_set_fail_mode(p
->connmgr
, fail_mode
);
638 /* Drops the connections between 'ofproto' and all of its controllers, forcing
639 * them to reconnect. */
641 ofproto_reconnect_controllers(struct ofproto
*ofproto
)
643 connmgr_reconnect(ofproto
->connmgr
);
646 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'ofproto''s
647 * in-band control should guarantee access, in the same way that in-band
648 * control guarantees access to OpenFlow controllers. */
650 ofproto_set_extra_in_band_remotes(struct ofproto
*ofproto
,
651 const struct sockaddr_in
*extras
, size_t n
)
653 connmgr_set_extra_in_band_remotes(ofproto
->connmgr
, extras
, n
);
656 /* Sets the OpenFlow queue used by flows set up by in-band control on
657 * 'ofproto' to 'queue_id'. If 'queue_id' is negative, then in-band control
658 * flows will use the default queue. */
660 ofproto_set_in_band_queue(struct ofproto
*ofproto
, int queue_id
)
662 connmgr_set_in_band_queue(ofproto
->connmgr
, queue_id
);
665 /* Sets the number of flows at which eviction from the kernel flow table
668 ofproto_set_flow_limit(unsigned limit
)
670 ofproto_flow_limit
= limit
;
673 /* Sets the maximum idle time for flows in the datapath before they are
676 ofproto_set_max_idle(unsigned max_idle
)
678 ofproto_max_idle
= max_idle
;
681 /* If forward_bpdu is true, the NORMAL action will forward frames with
682 * reserved (e.g. STP) destination Ethernet addresses. if forward_bpdu is false,
683 * the NORMAL action will drop these frames. */
685 ofproto_set_forward_bpdu(struct ofproto
*ofproto
, bool forward_bpdu
)
687 bool old_val
= ofproto
->forward_bpdu
;
688 ofproto
->forward_bpdu
= forward_bpdu
;
689 if (old_val
!= ofproto
->forward_bpdu
) {
690 if (ofproto
->ofproto_class
->forward_bpdu_changed
) {
691 ofproto
->ofproto_class
->forward_bpdu_changed(ofproto
);
696 /* Sets the MAC aging timeout for the OFPP_NORMAL action on 'ofproto' to
697 * 'idle_time', in seconds, and the maximum number of MAC table entries to
700 ofproto_set_mac_table_config(struct ofproto
*ofproto
, unsigned idle_time
,
703 if (ofproto
->ofproto_class
->set_mac_table_config
) {
704 ofproto
->ofproto_class
->set_mac_table_config(ofproto
, idle_time
,
709 /* Multicast snooping configuration. */
711 /* Configures multicast snooping on 'ofproto' using the settings
712 * defined in 's'. If 's' is NULL, disables multicast snooping.
714 * Returns 0 if successful, otherwise a positive errno value. */
716 ofproto_set_mcast_snooping(struct ofproto
*ofproto
,
717 const struct ofproto_mcast_snooping_settings
*s
)
719 return (ofproto
->ofproto_class
->set_mcast_snooping
720 ? ofproto
->ofproto_class
->set_mcast_snooping(ofproto
, s
)
724 /* Configures multicast snooping flood setting on 'ofp_port' of 'ofproto'.
726 * Returns 0 if successful, otherwise a positive errno value.*/
728 ofproto_port_set_mcast_snooping(struct ofproto
*ofproto
, void *aux
, bool flood
)
730 return (ofproto
->ofproto_class
->set_mcast_snooping_port
731 ? ofproto
->ofproto_class
->set_mcast_snooping_port(ofproto
, aux
,
737 ofproto_set_n_dpdk_rxqs(int n_rxqs
)
739 n_dpdk_rxqs
= MAX(n_rxqs
, 0);
743 ofproto_set_cpu_mask(const char *cmask
)
747 pmd_cpu_mask
= cmask
? xstrdup(cmask
) : NULL
;
751 ofproto_set_threads(int n_handlers_
, int n_revalidators_
)
753 int threads
= MAX(count_cpu_cores(), 2);
755 n_revalidators
= MAX(n_revalidators_
, 0);
756 n_handlers
= MAX(n_handlers_
, 0);
758 if (!n_revalidators
) {
759 n_revalidators
= n_handlers
760 ? MAX(threads
- (int) n_handlers
, 1)
765 n_handlers
= MAX(threads
- (int) n_revalidators
, 1);
770 ofproto_set_dp_desc(struct ofproto
*p
, const char *dp_desc
)
773 p
->dp_desc
= dp_desc
? xstrdup(dp_desc
) : NULL
;
777 ofproto_set_snoops(struct ofproto
*ofproto
, const struct sset
*snoops
)
779 return connmgr_set_snoops(ofproto
->connmgr
, snoops
);
783 ofproto_set_netflow(struct ofproto
*ofproto
,
784 const struct netflow_options
*nf_options
)
786 if (nf_options
&& sset_is_empty(&nf_options
->collectors
)) {
790 if (ofproto
->ofproto_class
->set_netflow
) {
791 return ofproto
->ofproto_class
->set_netflow(ofproto
, nf_options
);
793 return nf_options
? EOPNOTSUPP
: 0;
798 ofproto_set_sflow(struct ofproto
*ofproto
,
799 const struct ofproto_sflow_options
*oso
)
801 if (oso
&& sset_is_empty(&oso
->targets
)) {
805 if (ofproto
->ofproto_class
->set_sflow
) {
806 return ofproto
->ofproto_class
->set_sflow(ofproto
, oso
);
808 return oso
? EOPNOTSUPP
: 0;
813 ofproto_set_ipfix(struct ofproto
*ofproto
,
814 const struct ofproto_ipfix_bridge_exporter_options
*bo
,
815 const struct ofproto_ipfix_flow_exporter_options
*fo
,
818 if (ofproto
->ofproto_class
->set_ipfix
) {
819 return ofproto
->ofproto_class
->set_ipfix(ofproto
, bo
, fo
, n_fo
);
821 return (bo
|| fo
) ? EOPNOTSUPP
: 0;
826 ofproto_set_flow_restore_wait(bool flow_restore_wait_db
)
828 flow_restore_wait
= flow_restore_wait_db
;
832 ofproto_get_flow_restore_wait(void)
834 return flow_restore_wait
;
838 /* Spanning Tree Protocol (STP) configuration. */
840 /* Configures STP on 'ofproto' using the settings defined in 's'. If
841 * 's' is NULL, disables STP.
843 * Returns 0 if successful, otherwise a positive errno value. */
845 ofproto_set_stp(struct ofproto
*ofproto
,
846 const struct ofproto_stp_settings
*s
)
848 return (ofproto
->ofproto_class
->set_stp
849 ? ofproto
->ofproto_class
->set_stp(ofproto
, s
)
853 /* Retrieves STP status of 'ofproto' and stores it in 's'. If the
854 * 'enabled' member of 's' is false, then the other members are not
857 * Returns 0 if successful, otherwise a positive errno value. */
859 ofproto_get_stp_status(struct ofproto
*ofproto
,
860 struct ofproto_stp_status
*s
)
862 return (ofproto
->ofproto_class
->get_stp_status
863 ? ofproto
->ofproto_class
->get_stp_status(ofproto
, s
)
867 /* Configures STP on 'ofp_port' of 'ofproto' using the settings defined
868 * in 's'. The caller is responsible for assigning STP port numbers
869 * (using the 'port_num' member in the range of 1 through 255, inclusive)
870 * and ensuring there are no duplicates. If the 's' is NULL, then STP
871 * is disabled on the port.
873 * Returns 0 if successful, otherwise a positive errno value.*/
875 ofproto_port_set_stp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
876 const struct ofproto_port_stp_settings
*s
)
878 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
880 VLOG_WARN("%s: cannot configure STP on nonexistent port %"PRIu16
,
881 ofproto
->name
, ofp_port
);
885 return (ofproto
->ofproto_class
->set_stp_port
886 ? ofproto
->ofproto_class
->set_stp_port(ofport
, s
)
890 /* Retrieves STP port status of 'ofp_port' on 'ofproto' and stores it in
891 * 's'. If the 'enabled' member in 's' is false, then the other members
892 * are not meaningful.
894 * Returns 0 if successful, otherwise a positive errno value.*/
896 ofproto_port_get_stp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
897 struct ofproto_port_stp_status
*s
)
899 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
901 VLOG_WARN_RL(&rl
, "%s: cannot get STP status on nonexistent "
902 "port %"PRIu16
, ofproto
->name
, ofp_port
);
906 return (ofproto
->ofproto_class
->get_stp_port_status
907 ? ofproto
->ofproto_class
->get_stp_port_status(ofport
, s
)
911 /* Retrieves STP port statistics of 'ofp_port' on 'ofproto' and stores it in
912 * 's'. If the 'enabled' member in 's' is false, then the other members
913 * are not meaningful.
915 * Returns 0 if successful, otherwise a positive errno value.*/
917 ofproto_port_get_stp_stats(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
918 struct ofproto_port_stp_stats
*s
)
920 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
922 VLOG_WARN_RL(&rl
, "%s: cannot get STP stats on nonexistent "
923 "port %"PRIu16
, ofproto
->name
, ofp_port
);
927 return (ofproto
->ofproto_class
->get_stp_port_stats
928 ? ofproto
->ofproto_class
->get_stp_port_stats(ofport
, s
)
932 /* Rapid Spanning Tree Protocol (RSTP) configuration. */
934 /* Configures RSTP on 'ofproto' using the settings defined in 's'. If
935 * 's' is NULL, disables RSTP.
937 * Returns 0 if successful, otherwise a positive errno value. */
939 ofproto_set_rstp(struct ofproto
*ofproto
,
940 const struct ofproto_rstp_settings
*s
)
942 if (!ofproto
->ofproto_class
->set_rstp
) {
945 ofproto
->ofproto_class
->set_rstp(ofproto
, s
);
949 /* Retrieves RSTP status of 'ofproto' and stores it in 's'. If the
950 * 'enabled' member of 's' is false, then the other members are not
953 * Returns 0 if successful, otherwise a positive errno value. */
955 ofproto_get_rstp_status(struct ofproto
*ofproto
,
956 struct ofproto_rstp_status
*s
)
958 if (!ofproto
->ofproto_class
->get_rstp_status
) {
961 ofproto
->ofproto_class
->get_rstp_status(ofproto
, s
);
965 /* Configures RSTP on 'ofp_port' of 'ofproto' using the settings defined
966 * in 's'. The caller is responsible for assigning RSTP port numbers
967 * (using the 'port_num' member in the range of 1 through 255, inclusive)
968 * and ensuring there are no duplicates. If the 's' is NULL, then RSTP
969 * is disabled on the port.
971 * Returns 0 if successful, otherwise a positive errno value.*/
973 ofproto_port_set_rstp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
974 const struct ofproto_port_rstp_settings
*s
)
976 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
978 VLOG_WARN("%s: cannot configure RSTP on nonexistent port %"PRIu16
,
979 ofproto
->name
, ofp_port
);
983 if (!ofproto
->ofproto_class
->set_rstp_port
) {
986 ofproto
->ofproto_class
->set_rstp_port(ofport
, s
);
990 /* Retrieves RSTP port status of 'ofp_port' on 'ofproto' and stores it in
991 * 's'. If the 'enabled' member in 's' is false, then the other members
992 * are not meaningful.
994 * Returns 0 if successful, otherwise a positive errno value.*/
996 ofproto_port_get_rstp_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
997 struct ofproto_port_rstp_status
*s
)
999 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1001 VLOG_WARN_RL(&rl
, "%s: cannot get RSTP status on nonexistent "
1002 "port %"PRIu16
, ofproto
->name
, ofp_port
);
1006 if (!ofproto
->ofproto_class
->get_rstp_port_status
) {
1009 ofproto
->ofproto_class
->get_rstp_port_status(ofport
, s
);
1013 /* Queue DSCP configuration. */
1015 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1016 * 'queues' attached to 'ofport'. This data is not intended to be sufficient
1017 * to implement QoS. Instead, it is used to implement features which require
1018 * knowledge of what queues exist on a port, and some basic information about
1021 * Returns 0 if successful, otherwise a positive errno value. */
1023 ofproto_port_set_queues(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1024 const struct ofproto_port_queue
*queues
,
1027 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1030 VLOG_WARN("%s: cannot set queues on nonexistent port %"PRIu16
,
1031 ofproto
->name
, ofp_port
);
1035 return (ofproto
->ofproto_class
->set_queues
1036 ? ofproto
->ofproto_class
->set_queues(ofport
, queues
, n_queues
)
1040 /* Connectivity Fault Management configuration. */
1042 /* Clears the CFM configuration from 'ofp_port' on 'ofproto'. */
1044 ofproto_port_clear_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1046 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1047 if (ofport
&& ofproto
->ofproto_class
->set_cfm
) {
1048 ofproto
->ofproto_class
->set_cfm(ofport
, NULL
);
1052 /* Configures connectivity fault management on 'ofp_port' in 'ofproto'. Takes
1053 * basic configuration from the configuration members in 'cfm', and the remote
1054 * maintenance point ID from remote_mpid. Ignores the statistics members of
1057 * This function has no effect if 'ofproto' does not have a port 'ofp_port'. */
1059 ofproto_port_set_cfm(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1060 const struct cfm_settings
*s
)
1062 struct ofport
*ofport
;
1065 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1067 VLOG_WARN("%s: cannot configure CFM on nonexistent port %"PRIu16
,
1068 ofproto
->name
, ofp_port
);
1072 /* XXX: For configuration simplicity, we only support one remote_mpid
1073 * outside of the CFM module. It's not clear if this is the correct long
1074 * term solution or not. */
1075 error
= (ofproto
->ofproto_class
->set_cfm
1076 ? ofproto
->ofproto_class
->set_cfm(ofport
, s
)
1079 VLOG_WARN("%s: CFM configuration on port %"PRIu16
" (%s) failed (%s)",
1080 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1081 ovs_strerror(error
));
1085 /* Configures BFD on 'ofp_port' in 'ofproto'. This function has no effect if
1086 * 'ofproto' does not have a port 'ofp_port'. */
1088 ofproto_port_set_bfd(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1089 const struct smap
*cfg
)
1091 struct ofport
*ofport
;
1094 ofport
= ofproto_get_port(ofproto
, ofp_port
);
1096 VLOG_WARN("%s: cannot configure bfd on nonexistent port %"PRIu16
,
1097 ofproto
->name
, ofp_port
);
1101 error
= (ofproto
->ofproto_class
->set_bfd
1102 ? ofproto
->ofproto_class
->set_bfd(ofport
, cfg
)
1105 VLOG_WARN("%s: bfd configuration on port %"PRIu16
" (%s) failed (%s)",
1106 ofproto
->name
, ofp_port
, netdev_get_name(ofport
->netdev
),
1107 ovs_strerror(error
));
1111 /* Checks the status change of BFD on 'ofport'.
1113 * Returns true if 'ofproto_class' does not support 'bfd_status_changed'. */
1115 ofproto_port_bfd_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1117 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1118 return (ofport
&& ofproto
->ofproto_class
->bfd_status_changed
1119 ? ofproto
->ofproto_class
->bfd_status_changed(ofport
)
1123 /* Populates 'status' with the status of BFD on 'ofport'. Returns 0 on
1124 * success. Returns a positive errno otherwise. Has no effect if 'ofp_port'
1125 * is not an OpenFlow port in 'ofproto'.
1127 * The caller must provide and own '*status'. */
1129 ofproto_port_get_bfd_status(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
1130 struct smap
*status
)
1132 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1133 return (ofport
&& ofproto
->ofproto_class
->get_bfd_status
1134 ? ofproto
->ofproto_class
->get_bfd_status(ofport
, status
)
1138 /* Checks the status of LACP negotiation for 'ofp_port' within ofproto.
1139 * Returns 1 if LACP partner information for 'ofp_port' is up-to-date,
1140 * 0 if LACP partner information is not current (generally indicating a
1141 * connectivity problem), or -1 if LACP is not enabled on 'ofp_port'. */
1143 ofproto_port_is_lacp_current(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1145 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1146 return (ofport
&& ofproto
->ofproto_class
->port_is_lacp_current
1147 ? ofproto
->ofproto_class
->port_is_lacp_current(ofport
)
1152 ofproto_port_get_lacp_stats(const struct ofport
*port
, struct lacp_slave_stats
*stats
)
1154 struct ofproto
*ofproto
= port
->ofproto
;
1157 if (ofproto
->ofproto_class
->port_get_lacp_stats
) {
1158 error
= ofproto
->ofproto_class
->port_get_lacp_stats(port
, stats
);
1168 /* Registers a "bundle" associated with client data pointer 'aux' in 'ofproto'.
1169 * A bundle is the same concept as a Port in OVSDB, that is, it consists of one
1170 * or more "slave" devices (Interfaces, in OVSDB) along with a VLAN
1171 * configuration plus, if there is more than one slave, a bonding
1174 * If 'aux' is already registered then this function updates its configuration
1175 * to 's'. Otherwise, this function registers a new bundle.
1177 * Bundles only affect the NXAST_AUTOPATH action and output to the OFPP_NORMAL
1180 ofproto_bundle_register(struct ofproto
*ofproto
, void *aux
,
1181 const struct ofproto_bundle_settings
*s
)
1183 return (ofproto
->ofproto_class
->bundle_set
1184 ? ofproto
->ofproto_class
->bundle_set(ofproto
, aux
, s
)
1188 /* Unregisters the bundle registered on 'ofproto' with auxiliary data 'aux'.
1189 * If no such bundle has been registered, this has no effect. */
1191 ofproto_bundle_unregister(struct ofproto
*ofproto
, void *aux
)
1193 return ofproto_bundle_register(ofproto
, aux
, NULL
);
1197 /* Registers a mirror associated with client data pointer 'aux' in 'ofproto'.
1198 * If 'aux' is already registered then this function updates its configuration
1199 * to 's'. Otherwise, this function registers a new mirror. */
1201 ofproto_mirror_register(struct ofproto
*ofproto
, void *aux
,
1202 const struct ofproto_mirror_settings
*s
)
1204 return (ofproto
->ofproto_class
->mirror_set
1205 ? ofproto
->ofproto_class
->mirror_set(ofproto
, aux
, s
)
1209 /* Unregisters the mirror registered on 'ofproto' with auxiliary data 'aux'.
1210 * If no mirror has been registered, this has no effect. */
1212 ofproto_mirror_unregister(struct ofproto
*ofproto
, void *aux
)
1214 return ofproto_mirror_register(ofproto
, aux
, NULL
);
1217 /* Retrieves statistics from mirror associated with client data pointer
1218 * 'aux' in 'ofproto'. Stores packet and byte counts in 'packets' and
1219 * 'bytes', respectively. If a particular counters is not supported,
1220 * the appropriate argument is set to UINT64_MAX. */
1222 ofproto_mirror_get_stats(struct ofproto
*ofproto
, void *aux
,
1223 uint64_t *packets
, uint64_t *bytes
)
1225 if (!ofproto
->ofproto_class
->mirror_get_stats
) {
1226 *packets
= *bytes
= UINT64_MAX
;
1230 return ofproto
->ofproto_class
->mirror_get_stats(ofproto
, aux
,
1234 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs on
1235 * which all packets are flooded, instead of using MAC learning. If
1236 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1238 * Flood VLANs affect only the treatment of packets output to the OFPP_NORMAL
1241 ofproto_set_flood_vlans(struct ofproto
*ofproto
, unsigned long *flood_vlans
)
1243 return (ofproto
->ofproto_class
->set_flood_vlans
1244 ? ofproto
->ofproto_class
->set_flood_vlans(ofproto
, flood_vlans
)
1248 /* Returns true if 'aux' is a registered bundle that is currently in use as the
1249 * output for a mirror. */
1251 ofproto_is_mirror_output_bundle(const struct ofproto
*ofproto
, void *aux
)
1253 return (ofproto
->ofproto_class
->is_mirror_output_bundle
1254 ? ofproto
->ofproto_class
->is_mirror_output_bundle(ofproto
, aux
)
1258 /* Configuration of OpenFlow tables. */
1260 /* Returns the number of OpenFlow tables in 'ofproto'. */
1262 ofproto_get_n_tables(const struct ofproto
*ofproto
)
1264 return ofproto
->n_tables
;
1267 /* Returns the number of Controller visible OpenFlow tables
1268 * in 'ofproto'. This number will exclude Hidden tables.
1269 * This funtion's return value should be less or equal to that of
1270 * ofproto_get_n_tables() . */
1272 ofproto_get_n_visible_tables(const struct ofproto
*ofproto
)
1274 uint8_t n
= ofproto
->n_tables
;
1276 /* Count only non-hidden tables in the number of tables. (Hidden tables,
1277 * if present, are always at the end.) */
1278 while(n
&& (ofproto
->tables
[n
- 1].flags
& OFTABLE_HIDDEN
)) {
1285 /* Configures the OpenFlow table in 'ofproto' with id 'table_id' with the
1286 * settings from 's'. 'table_id' must be in the range 0 through the number of
1287 * OpenFlow tables in 'ofproto' minus 1, inclusive.
1289 * For read-only tables, only the name may be configured. */
1291 ofproto_configure_table(struct ofproto
*ofproto
, int table_id
,
1292 const struct ofproto_table_settings
*s
)
1294 struct oftable
*table
;
1296 ovs_assert(table_id
>= 0 && table_id
< ofproto
->n_tables
);
1297 table
= &ofproto
->tables
[table_id
];
1299 oftable_set_name(table
, s
->name
);
1301 if (table
->flags
& OFTABLE_READONLY
) {
1306 oftable_enable_eviction(table
, s
->groups
, s
->n_groups
);
1308 oftable_disable_eviction(table
);
1311 table
->max_flows
= s
->max_flows
;
1313 if (classifier_set_prefix_fields(&table
->cls
,
1314 s
->prefix_fields
, s
->n_prefix_fields
)) {
1315 /* XXX: Trigger revalidation. */
1318 ovs_mutex_lock(&ofproto_mutex
);
1319 evict_rules_from_table(table
, 0);
1320 ovs_mutex_unlock(&ofproto_mutex
);
1324 ofproto_has_snoops(const struct ofproto
*ofproto
)
1326 return connmgr_has_snoops(ofproto
->connmgr
);
1330 ofproto_get_snoops(const struct ofproto
*ofproto
, struct sset
*snoops
)
1332 connmgr_get_snoops(ofproto
->connmgr
, snoops
);
1336 ofproto_rule_delete__(struct rule
*rule
, uint8_t reason
)
1337 OVS_REQUIRES(ofproto_mutex
)
1339 struct rule_collection rules
;
1341 rules
.rules
= rules
.stub
;
1343 rules
.stub
[0] = rule
;
1344 delete_flows__(&rules
, reason
, NULL
);
1347 /* Deletes 'rule' from 'ofproto'.
1349 * Within an ofproto implementation, this function allows an ofproto
1350 * implementation to destroy any rules that remain when its ->destruct()
1351 * function is called. This function is not suitable for use elsewhere in an
1352 * ofproto implementation.
1354 * This function implements steps 4.4 and 4.5 in the section titled "Rule Life
1355 * Cycle" in ofproto-provider.h. */
1357 ofproto_rule_delete(struct ofproto
*ofproto
, struct rule
*rule
)
1358 OVS_EXCLUDED(ofproto_mutex
)
1360 /* This skips the ofmonitor and flow-removed notifications because the
1361 * switch is being deleted and any OpenFlow channels have been or soon will
1363 ovs_mutex_lock(&ofproto_mutex
);
1364 oftable_remove_rule__(ofproto
, rule
);
1365 ofproto
->ofproto_class
->rule_delete(rule
);
1366 ovs_mutex_unlock(&ofproto_mutex
);
1370 ofproto_flush__(struct ofproto
*ofproto
)
1371 OVS_EXCLUDED(ofproto_mutex
)
1373 struct oftable
*table
;
1375 /* This will flush all datapath flows. */
1376 if (ofproto
->ofproto_class
->flush
) {
1377 ofproto
->ofproto_class
->flush(ofproto
);
1380 /* XXX: There is a small race window here, where new datapath flows can be
1381 * created by upcall handlers based on the existing flow table. We can not
1382 * call ofproto class flush while holding 'ofproto_mutex' to prevent this,
1383 * as then we could deadlock on syncing with the handler threads waiting on
1384 * the same mutex. */
1386 ovs_mutex_lock(&ofproto_mutex
);
1387 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1390 if (table
->flags
& OFTABLE_HIDDEN
) {
1394 CLS_FOR_EACH_SAFE (rule
, cr
, &table
->cls
) {
1395 ofproto_rule_delete__(rule
, OFPRR_DELETE
);
1398 /* XXX: Concurrent handler threads may insert new learned flows based on
1399 * learn actions of the now deleted flows right after we release
1400 * 'ofproto_mutex'. */
1401 ovs_mutex_unlock(&ofproto_mutex
);
1404 static void delete_group(struct ofproto
*ofproto
, uint32_t group_id
);
1407 ofproto_destroy__(struct ofproto
*ofproto
)
1408 OVS_EXCLUDED(ofproto_mutex
)
1410 struct oftable
*table
;
1412 destroy_rule_executes(ofproto
);
1413 delete_group(ofproto
, OFPG_ALL
);
1415 guarded_list_destroy(&ofproto
->rule_executes
);
1416 ovs_rwlock_destroy(&ofproto
->groups_rwlock
);
1417 hmap_destroy(&ofproto
->groups
);
1419 hmap_remove(&all_ofprotos
, &ofproto
->hmap_node
);
1420 free(ofproto
->name
);
1421 free(ofproto
->type
);
1422 free(ofproto
->mfr_desc
);
1423 free(ofproto
->hw_desc
);
1424 free(ofproto
->sw_desc
);
1425 free(ofproto
->serial_desc
);
1426 free(ofproto
->dp_desc
);
1427 hmap_destroy(&ofproto
->ports
);
1428 hmap_destroy(&ofproto
->ofport_usage
);
1429 shash_destroy(&ofproto
->port_by_name
);
1430 simap_destroy(&ofproto
->ofp_requests
);
1432 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1433 oftable_destroy(table
);
1435 free(ofproto
->tables
);
1437 ovs_assert(hindex_is_empty(&ofproto
->cookies
));
1438 hindex_destroy(&ofproto
->cookies
);
1440 ovs_assert(hmap_is_empty(&ofproto
->learned_cookies
));
1441 hmap_destroy(&ofproto
->learned_cookies
);
1443 free(ofproto
->vlan_bitmap
);
1445 ofproto
->ofproto_class
->dealloc(ofproto
);
1449 ofproto_destroy(struct ofproto
*p
)
1450 OVS_EXCLUDED(ofproto_mutex
)
1452 struct ofport
*ofport
, *next_ofport
;
1453 struct ofport_usage
*usage
, *next_usage
;
1460 meter_delete(p
, 1, p
->meter_features
.max_meters
);
1461 p
->meter_features
.max_meters
= 0;
1467 HMAP_FOR_EACH_SAFE (ofport
, next_ofport
, hmap_node
, &p
->ports
) {
1468 ofport_destroy(ofport
);
1471 HMAP_FOR_EACH_SAFE (usage
, next_usage
, hmap_node
, &p
->ofport_usage
) {
1472 hmap_remove(&p
->ofport_usage
, &usage
->hmap_node
);
1476 p
->ofproto_class
->destruct(p
);
1478 /* We should not postpone this because it involves deleting a listening
1479 * socket which we may want to reopen soon. 'connmgr' should not be used
1480 * by other threads */
1481 connmgr_destroy(p
->connmgr
);
1483 /* Destroying rules is deferred, must have 'ofproto' around for them. */
1484 ovsrcu_postpone(ofproto_destroy__
, p
);
1487 /* Destroys the datapath with the respective 'name' and 'type'. With the Linux
1488 * kernel datapath, for example, this destroys the datapath in the kernel, and
1489 * with the netdev-based datapath, it tears down the data structures that
1490 * represent the datapath.
1492 * The datapath should not be currently open as an ofproto. */
1494 ofproto_delete(const char *name
, const char *type
)
1496 const struct ofproto_class
*class = ofproto_class_find__(type
);
1497 return (!class ? EAFNOSUPPORT
1498 : !class->del
? EACCES
1499 : class->del(type
, name
));
1503 process_port_change(struct ofproto
*ofproto
, int error
, char *devname
)
1505 if (error
== ENOBUFS
) {
1506 reinit_ports(ofproto
);
1507 } else if (!error
) {
1508 update_port(ofproto
, devname
);
1514 ofproto_type_run(const char *datapath_type
)
1516 const struct ofproto_class
*class;
1519 datapath_type
= ofproto_normalize_type(datapath_type
);
1520 class = ofproto_class_find__(datapath_type
);
1522 error
= class->type_run
? class->type_run(datapath_type
) : 0;
1523 if (error
&& error
!= EAGAIN
) {
1524 VLOG_ERR_RL(&rl
, "%s: type_run failed (%s)",
1525 datapath_type
, ovs_strerror(error
));
1531 ofproto_type_wait(const char *datapath_type
)
1533 const struct ofproto_class
*class;
1535 datapath_type
= ofproto_normalize_type(datapath_type
);
1536 class = ofproto_class_find__(datapath_type
);
1538 if (class->type_wait
) {
1539 class->type_wait(datapath_type
);
1544 ofproto_run(struct ofproto
*p
)
1549 error
= p
->ofproto_class
->run(p
);
1550 if (error
&& error
!= EAGAIN
) {
1551 VLOG_ERR_RL(&rl
, "%s: run failed (%s)", p
->name
, ovs_strerror(error
));
1554 run_rule_executes(p
);
1556 /* Restore the eviction group heap invariant occasionally. */
1557 if (p
->eviction_group_timer
< time_msec()) {
1560 p
->eviction_group_timer
= time_msec() + 1000;
1562 for (i
= 0; i
< p
->n_tables
; i
++) {
1563 struct oftable
*table
= &p
->tables
[i
];
1564 struct eviction_group
*evg
;
1567 if (!table
->eviction_fields
) {
1571 if (classifier_count(&table
->cls
) > 100000) {
1572 static struct vlog_rate_limit count_rl
=
1573 VLOG_RATE_LIMIT_INIT(1, 1);
1574 VLOG_WARN_RL(&count_rl
, "Table %"PRIuSIZE
" has an excessive"
1575 " number of rules: %d", i
,
1576 classifier_count(&table
->cls
));
1579 ovs_mutex_lock(&ofproto_mutex
);
1580 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
1581 if (rule
->idle_timeout
|| rule
->hard_timeout
) {
1582 if (!rule
->eviction_group
) {
1583 eviction_group_add_rule(rule
);
1585 heap_raw_change(&rule
->evg_node
,
1586 rule_eviction_priority(p
, rule
));
1591 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
1592 heap_rebuild(&evg
->rules
);
1594 ovs_mutex_unlock(&ofproto_mutex
);
1598 if (p
->ofproto_class
->port_poll
) {
1601 while ((error
= p
->ofproto_class
->port_poll(p
, &devname
)) != EAGAIN
) {
1602 process_port_change(p
, error
, devname
);
1606 new_seq
= seq_read(connectivity_seq_get());
1607 if (new_seq
!= p
->change_seq
) {
1608 struct sset devnames
;
1609 const char *devname
;
1610 struct ofport
*ofport
;
1612 /* Update OpenFlow port status for any port whose netdev has changed.
1614 * Refreshing a given 'ofport' can cause an arbitrary ofport to be
1615 * destroyed, so it's not safe to update ports directly from the
1616 * HMAP_FOR_EACH loop, or even to use HMAP_FOR_EACH_SAFE. Instead, we
1617 * need this two-phase approach. */
1618 sset_init(&devnames
);
1619 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
1620 uint64_t port_change_seq
;
1622 port_change_seq
= netdev_get_change_seq(ofport
->netdev
);
1623 if (ofport
->change_seq
!= port_change_seq
) {
1624 ofport
->change_seq
= port_change_seq
;
1625 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
1628 SSET_FOR_EACH (devname
, &devnames
) {
1629 update_port(p
, devname
);
1631 sset_destroy(&devnames
);
1633 p
->change_seq
= new_seq
;
1636 connmgr_run(p
->connmgr
, handle_openflow
);
1642 ofproto_wait(struct ofproto
*p
)
1644 p
->ofproto_class
->wait(p
);
1645 if (p
->ofproto_class
->port_poll_wait
) {
1646 p
->ofproto_class
->port_poll_wait(p
);
1648 seq_wait(connectivity_seq_get(), p
->change_seq
);
1649 connmgr_wait(p
->connmgr
);
1653 ofproto_is_alive(const struct ofproto
*p
)
1655 return connmgr_has_controllers(p
->connmgr
);
1658 /* Adds some memory usage statistics for 'ofproto' into 'usage', for use with
1659 * memory_report(). */
1661 ofproto_get_memory_usage(const struct ofproto
*ofproto
, struct simap
*usage
)
1663 const struct oftable
*table
;
1664 unsigned int n_rules
;
1666 simap_increase(usage
, "ports", hmap_count(&ofproto
->ports
));
1669 OFPROTO_FOR_EACH_TABLE (table
, ofproto
) {
1670 n_rules
+= classifier_count(&table
->cls
);
1672 simap_increase(usage
, "rules", n_rules
);
1674 if (ofproto
->ofproto_class
->get_memory_usage
) {
1675 ofproto
->ofproto_class
->get_memory_usage(ofproto
, usage
);
1678 connmgr_get_memory_usage(ofproto
->connmgr
, usage
);
1682 ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*usage
)
1684 const struct ofproto_class
*class;
1686 datapath_type
= ofproto_normalize_type(datapath_type
);
1687 class = ofproto_class_find__(datapath_type
);
1689 if (class && class->type_get_memory_usage
) {
1690 class->type_get_memory_usage(datapath_type
, usage
);
1695 ofproto_get_ofproto_controller_info(const struct ofproto
*ofproto
,
1698 connmgr_get_controller_info(ofproto
->connmgr
, info
);
1702 ofproto_free_ofproto_controller_info(struct shash
*info
)
1704 connmgr_free_controller_info(info
);
1707 /* Makes a deep copy of 'old' into 'port'. */
1709 ofproto_port_clone(struct ofproto_port
*port
, const struct ofproto_port
*old
)
1711 port
->name
= xstrdup(old
->name
);
1712 port
->type
= xstrdup(old
->type
);
1713 port
->ofp_port
= old
->ofp_port
;
1716 /* Frees memory allocated to members of 'ofproto_port'.
1718 * Do not call this function on an ofproto_port obtained from
1719 * ofproto_port_dump_next(): that function retains ownership of the data in the
1722 ofproto_port_destroy(struct ofproto_port
*ofproto_port
)
1724 free(ofproto_port
->name
);
1725 free(ofproto_port
->type
);
1728 /* Initializes 'dump' to begin dumping the ports in an ofproto.
1730 * This function provides no status indication. An error status for the entire
1731 * dump operation is provided when it is completed by calling
1732 * ofproto_port_dump_done().
1735 ofproto_port_dump_start(struct ofproto_port_dump
*dump
,
1736 const struct ofproto
*ofproto
)
1738 dump
->ofproto
= ofproto
;
1739 dump
->error
= ofproto
->ofproto_class
->port_dump_start(ofproto
,
1743 /* Attempts to retrieve another port from 'dump', which must have been created
1744 * with ofproto_port_dump_start(). On success, stores a new ofproto_port into
1745 * 'port' and returns true. On failure, returns false.
1747 * Failure might indicate an actual error or merely that the last port has been
1748 * dumped. An error status for the entire dump operation is provided when it
1749 * is completed by calling ofproto_port_dump_done().
1751 * The ofproto owns the data stored in 'port'. It will remain valid until at
1752 * least the next time 'dump' is passed to ofproto_port_dump_next() or
1753 * ofproto_port_dump_done(). */
1755 ofproto_port_dump_next(struct ofproto_port_dump
*dump
,
1756 struct ofproto_port
*port
)
1758 const struct ofproto
*ofproto
= dump
->ofproto
;
1764 dump
->error
= ofproto
->ofproto_class
->port_dump_next(ofproto
, dump
->state
,
1767 ofproto
->ofproto_class
->port_dump_done(ofproto
, dump
->state
);
1773 /* Completes port table dump operation 'dump', which must have been created
1774 * with ofproto_port_dump_start(). Returns 0 if the dump operation was
1775 * error-free, otherwise a positive errno value describing the problem. */
1777 ofproto_port_dump_done(struct ofproto_port_dump
*dump
)
1779 const struct ofproto
*ofproto
= dump
->ofproto
;
1781 dump
->error
= ofproto
->ofproto_class
->port_dump_done(ofproto
,
1784 return dump
->error
== EOF
? 0 : dump
->error
;
1787 /* Returns the type to pass to netdev_open() when a datapath of type
1788 * 'datapath_type' has a port of type 'port_type', for a few special
1789 * cases when a netdev type differs from a port type. For example, when
1790 * using the userspace datapath, a port of type "internal" needs to be
1793 * Returns either 'type' itself or a string literal, which must not be
1796 ofproto_port_open_type(const char *datapath_type
, const char *port_type
)
1798 const struct ofproto_class
*class;
1800 datapath_type
= ofproto_normalize_type(datapath_type
);
1801 class = ofproto_class_find__(datapath_type
);
1806 return (class->port_open_type
1807 ? class->port_open_type(datapath_type
, port_type
)
1811 /* Attempts to add 'netdev' as a port on 'ofproto'. If 'ofp_portp' is
1812 * non-null and '*ofp_portp' is not OFPP_NONE, attempts to use that as
1813 * the port's OpenFlow port number.
1815 * If successful, returns 0 and sets '*ofp_portp' to the new port's
1816 * OpenFlow port number (if 'ofp_portp' is non-null). On failure,
1817 * returns a positive errno value and sets '*ofp_portp' to OFPP_NONE (if
1818 * 'ofp_portp' is non-null). */
1820 ofproto_port_add(struct ofproto
*ofproto
, struct netdev
*netdev
,
1821 ofp_port_t
*ofp_portp
)
1823 ofp_port_t ofp_port
= ofp_portp
? *ofp_portp
: OFPP_NONE
;
1826 error
= ofproto
->ofproto_class
->port_add(ofproto
, netdev
);
1828 const char *netdev_name
= netdev_get_name(netdev
);
1830 simap_put(&ofproto
->ofp_requests
, netdev_name
,
1831 ofp_to_u16(ofp_port
));
1832 update_port(ofproto
, netdev_name
);
1835 *ofp_portp
= OFPP_NONE
;
1837 struct ofproto_port ofproto_port
;
1839 error
= ofproto_port_query_by_name(ofproto
,
1840 netdev_get_name(netdev
),
1843 *ofp_portp
= ofproto_port
.ofp_port
;
1844 ofproto_port_destroy(&ofproto_port
);
1851 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
1852 * initializes '*port' appropriately; on failure, returns a positive errno
1855 * The caller owns the data in 'ofproto_port' and must free it with
1856 * ofproto_port_destroy() when it is no longer needed. */
1858 ofproto_port_query_by_name(const struct ofproto
*ofproto
, const char *devname
,
1859 struct ofproto_port
*port
)
1863 error
= ofproto
->ofproto_class
->port_query_by_name(ofproto
, devname
, port
);
1865 memset(port
, 0, sizeof *port
);
1870 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.
1871 * Returns 0 if successful, otherwise a positive errno. */
1873 ofproto_port_del(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
1875 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
1876 const char *name
= ofport
? netdev_get_name(ofport
->netdev
) : "<unknown>";
1877 struct simap_node
*ofp_request_node
;
1880 ofp_request_node
= simap_find(&ofproto
->ofp_requests
, name
);
1881 if (ofp_request_node
) {
1882 simap_delete(&ofproto
->ofp_requests
, ofp_request_node
);
1885 error
= ofproto
->ofproto_class
->port_del(ofproto
, ofp_port
);
1886 if (!error
&& ofport
) {
1887 /* 'name' is the netdev's name and update_port() is going to close the
1888 * netdev. Just in case update_port() refers to 'name' after it
1889 * destroys 'ofport', make a copy of it around the update_port()
1891 char *devname
= xstrdup(name
);
1892 update_port(ofproto
, devname
);
1899 flow_mod_init(struct ofputil_flow_mod
*fm
,
1900 const struct match
*match
, int priority
,
1901 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1902 enum ofp_flow_mod_command command
)
1904 memset(fm
, 0, sizeof *fm
);
1906 fm
->priority
= priority
;
1909 fm
->modify_cookie
= false;
1911 fm
->command
= command
;
1912 fm
->idle_timeout
= 0;
1913 fm
->hard_timeout
= 0;
1915 fm
->buffer_id
= UINT32_MAX
;
1916 fm
->out_port
= OFPP_ANY
;
1917 fm
->out_group
= OFPG_ANY
;
1919 fm
->ofpacts
= CONST_CAST(struct ofpact
*, ofpacts
);
1920 fm
->ofpacts_len
= ofpacts_len
;
1921 fm
->delete_reason
= OFPRR_DELETE
;
1925 simple_flow_mod(struct ofproto
*ofproto
,
1926 const struct match
*match
, int priority
,
1927 const struct ofpact
*ofpacts
, size_t ofpacts_len
,
1928 enum ofp_flow_mod_command command
)
1930 struct ofputil_flow_mod fm
;
1932 flow_mod_init(&fm
, match
, priority
, ofpacts
, ofpacts_len
, command
);
1934 return handle_flow_mod__(ofproto
, &fm
, NULL
);
1937 /* Adds a flow to OpenFlow flow table 0 in 'p' that matches 'cls_rule' and
1938 * performs the 'n_actions' actions in 'actions'. The new flow will not
1941 * If cls_rule->priority is in the range of priorities supported by OpenFlow
1942 * (0...65535, inclusive) then the flow will be visible to OpenFlow
1943 * controllers; otherwise, it will be hidden.
1945 * The caller retains ownership of 'cls_rule' and 'ofpacts'.
1947 * This is a helper function for in-band control and fail-open. */
1949 ofproto_add_flow(struct ofproto
*ofproto
, const struct match
*match
,
1951 const struct ofpact
*ofpacts
, size_t ofpacts_len
)
1952 OVS_EXCLUDED(ofproto_mutex
)
1954 const struct rule
*rule
;
1957 /* First do a cheap check whether the rule we're looking for already exists
1958 * with the actions that we want. If it does, then we're done. */
1959 rule
= rule_from_cls_rule(classifier_find_match_exactly(
1960 &ofproto
->tables
[0].cls
, match
, priority
));
1962 const struct rule_actions
*actions
= rule_get_actions(rule
);
1963 must_add
= !ofpacts_equal(actions
->ofpacts
, actions
->ofpacts_len
,
1964 ofpacts
, ofpacts_len
);
1969 /* If there's no such rule or the rule doesn't have the actions we want,
1970 * fall back to a executing a full flow mod. We can't optimize this at
1971 * all because we didn't take enough locks above to ensure that the flow
1972 * table didn't already change beneath us. */
1974 simple_flow_mod(ofproto
, match
, priority
, ofpacts
, ofpacts_len
,
1975 OFPFC_MODIFY_STRICT
);
1979 /* Executes the flow modification specified in 'fm'. Returns 0 on success, an
1980 * OFPERR_* OpenFlow error code on failure, or OFPROTO_POSTPONE if the
1981 * operation cannot be initiated now but may be retried later.
1983 * This is a helper function for in-band control and fail-open and the "learn"
1986 ofproto_flow_mod(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
)
1987 OVS_EXCLUDED(ofproto_mutex
)
1989 /* Optimize for the most common case of a repeated learn action.
1990 * If an identical flow already exists we only need to update its
1991 * 'modified' time. */
1992 if (fm
->command
== OFPFC_MODIFY_STRICT
&& fm
->table_id
!= OFPTT_ALL
1993 && !(fm
->flags
& OFPUTIL_FF_RESET_COUNTS
)) {
1994 struct oftable
*table
= &ofproto
->tables
[fm
->table_id
];
1998 rule
= rule_from_cls_rule(classifier_find_match_exactly(&table
->cls
,
2002 /* Reading many of the rule fields and writing on 'modified'
2003 * requires the rule->mutex. Also, rule->actions may change
2004 * if rule->mutex is not held. */
2005 const struct rule_actions
*actions
;
2007 ovs_mutex_lock(&rule
->mutex
);
2008 actions
= rule_get_actions(rule
);
2009 if (rule
->idle_timeout
== fm
->idle_timeout
2010 && rule
->hard_timeout
== fm
->hard_timeout
2011 && rule
->importance
== fm
->importance
2012 && rule
->flags
== (fm
->flags
& OFPUTIL_FF_STATE
)
2013 && (!fm
->modify_cookie
|| (fm
->new_cookie
== rule
->flow_cookie
))
2014 && ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
2015 actions
->ofpacts
, actions
->ofpacts_len
)) {
2016 /* Rule already exists and need not change, only update the
2017 modified timestamp. */
2018 rule
->modified
= time_msec();
2021 ovs_mutex_unlock(&rule
->mutex
);
2029 return handle_flow_mod__(ofproto
, fm
, NULL
);
2032 /* Searches for a rule with matching criteria exactly equal to 'target' in
2033 * ofproto's table 0 and, if it finds one, deletes it.
2035 * This is a helper function for in-band control and fail-open. */
2037 ofproto_delete_flow(struct ofproto
*ofproto
,
2038 const struct match
*target
, int priority
)
2039 OVS_EXCLUDED(ofproto_mutex
)
2041 struct classifier
*cls
= &ofproto
->tables
[0].cls
;
2044 /* First do a cheap check whether the rule we're looking for has already
2045 * been deleted. If so, then we're done. */
2046 rule
= rule_from_cls_rule(classifier_find_match_exactly(cls
, target
,
2052 /* Execute a flow mod. We can't optimize this at all because we didn't
2053 * take enough locks above to ensure that the flow table didn't already
2054 * change beneath us. */
2055 simple_flow_mod(ofproto
, target
, priority
, NULL
, 0, OFPFC_DELETE_STRICT
);
2058 /* Delete all of the flows from all of ofproto's flow tables, then reintroduce
2059 * the flows required by in-band control and fail-open. */
2061 ofproto_flush_flows(struct ofproto
*ofproto
)
2063 COVERAGE_INC(ofproto_flush
);
2064 ofproto_flush__(ofproto
);
2065 connmgr_flushed(ofproto
->connmgr
);
2069 reinit_ports(struct ofproto
*p
)
2071 struct ofproto_port_dump dump
;
2072 struct sset devnames
;
2073 struct ofport
*ofport
;
2074 struct ofproto_port ofproto_port
;
2075 const char *devname
;
2077 COVERAGE_INC(ofproto_reinit_ports
);
2079 sset_init(&devnames
);
2080 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2081 sset_add(&devnames
, netdev_get_name(ofport
->netdev
));
2083 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2084 sset_add(&devnames
, ofproto_port
.name
);
2087 SSET_FOR_EACH (devname
, &devnames
) {
2088 update_port(p
, devname
);
2090 sset_destroy(&devnames
);
2094 alloc_ofp_port(struct ofproto
*ofproto
, const char *netdev_name
)
2098 port_idx
= simap_get(&ofproto
->ofp_requests
, netdev_name
);
2099 port_idx
= port_idx
? port_idx
: UINT16_MAX
;
2101 if (port_idx
>= ofproto
->max_ports
2102 || ofport_get_usage(ofproto
, u16_to_ofp(port_idx
)) == LLONG_MAX
) {
2103 uint16_t lru_ofport
= 0, end_port_no
= ofproto
->alloc_port_no
;
2104 long long int last_used_at
, lru
= LLONG_MAX
;
2106 /* Search for a free OpenFlow port number. We try not to
2107 * immediately reuse them to prevent problems due to old
2110 * We limit the automatically assigned port numbers to the lower half
2111 * of the port range, to reserve the upper half for assignment by
2114 if (++ofproto
->alloc_port_no
>= MIN(ofproto
->max_ports
, 32768)) {
2115 ofproto
->alloc_port_no
= 1;
2117 last_used_at
= ofport_get_usage(ofproto
,
2118 u16_to_ofp(ofproto
->alloc_port_no
));
2119 if (!last_used_at
) {
2120 port_idx
= ofproto
->alloc_port_no
;
2122 } else if ( last_used_at
< time_msec() - 60*60*1000) {
2123 /* If the port with ofport 'ofproto->alloc_port_no' was deleted
2124 * more than an hour ago, consider it usable. */
2125 ofport_remove_usage(ofproto
,
2126 u16_to_ofp(ofproto
->alloc_port_no
));
2127 port_idx
= ofproto
->alloc_port_no
;
2129 } else if (last_used_at
< lru
) {
2131 lru_ofport
= ofproto
->alloc_port_no
;
2134 if (ofproto
->alloc_port_no
== end_port_no
) {
2136 port_idx
= lru_ofport
;
2143 ofport_set_usage(ofproto
, u16_to_ofp(port_idx
), LLONG_MAX
);
2144 return u16_to_ofp(port_idx
);
2148 dealloc_ofp_port(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2150 if (ofp_to_u16(ofp_port
) < ofproto
->max_ports
) {
2151 ofport_set_usage(ofproto
, ofp_port
, time_msec());
2155 /* Opens and returns a netdev for 'ofproto_port' in 'ofproto', or a null
2156 * pointer if the netdev cannot be opened. On success, also fills in
2158 static struct netdev
*
2159 ofport_open(struct ofproto
*ofproto
,
2160 struct ofproto_port
*ofproto_port
,
2161 struct ofputil_phy_port
*pp
)
2163 enum netdev_flags flags
;
2164 struct netdev
*netdev
;
2167 error
= netdev_open(ofproto_port
->name
, ofproto_port
->type
, &netdev
);
2169 VLOG_WARN_RL(&rl
, "%s: ignoring port %s (%"PRIu16
") because netdev %s "
2170 "cannot be opened (%s)",
2172 ofproto_port
->name
, ofproto_port
->ofp_port
,
2173 ofproto_port
->name
, ovs_strerror(error
));
2177 if (ofproto_port
->ofp_port
== OFPP_NONE
) {
2178 if (!strcmp(ofproto
->name
, ofproto_port
->name
)) {
2179 ofproto_port
->ofp_port
= OFPP_LOCAL
;
2181 ofproto_port
->ofp_port
= alloc_ofp_port(ofproto
,
2182 ofproto_port
->name
);
2185 pp
->port_no
= ofproto_port
->ofp_port
;
2186 netdev_get_etheraddr(netdev
, pp
->hw_addr
);
2187 ovs_strlcpy(pp
->name
, ofproto_port
->name
, sizeof pp
->name
);
2188 netdev_get_flags(netdev
, &flags
);
2189 pp
->config
= flags
& NETDEV_UP
? 0 : OFPUTIL_PC_PORT_DOWN
;
2190 pp
->state
= netdev_get_carrier(netdev
) ? 0 : OFPUTIL_PS_LINK_DOWN
;
2191 netdev_get_features(netdev
, &pp
->curr
, &pp
->advertised
,
2192 &pp
->supported
, &pp
->peer
);
2193 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
2194 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
2199 /* Returns true if most fields of 'a' and 'b' are equal. Differences in name,
2200 * port number, and 'config' bits other than OFPUTIL_PC_PORT_DOWN are
2203 ofport_equal(const struct ofputil_phy_port
*a
,
2204 const struct ofputil_phy_port
*b
)
2206 return (eth_addr_equals(a
->hw_addr
, b
->hw_addr
)
2207 && a
->state
== b
->state
2208 && !((a
->config
^ b
->config
) & OFPUTIL_PC_PORT_DOWN
)
2209 && a
->curr
== b
->curr
2210 && a
->advertised
== b
->advertised
2211 && a
->supported
== b
->supported
2212 && a
->peer
== b
->peer
2213 && a
->curr_speed
== b
->curr_speed
2214 && a
->max_speed
== b
->max_speed
);
2217 /* Adds an ofport to 'p' initialized based on the given 'netdev' and 'opp'.
2218 * The caller must ensure that 'p' does not have a conflicting ofport (that is,
2219 * one with the same name or port number). */
2221 ofport_install(struct ofproto
*p
,
2222 struct netdev
*netdev
, const struct ofputil_phy_port
*pp
)
2224 const char *netdev_name
= netdev_get_name(netdev
);
2225 struct ofport
*ofport
;
2228 /* Create ofport. */
2229 ofport
= p
->ofproto_class
->port_alloc();
2234 ofport
->ofproto
= p
;
2235 ofport
->netdev
= netdev
;
2236 ofport
->change_seq
= netdev_get_change_seq(netdev
);
2238 ofport
->ofp_port
= pp
->port_no
;
2239 ofport
->created
= time_msec();
2241 /* Add port to 'p'. */
2242 hmap_insert(&p
->ports
, &ofport
->hmap_node
,
2243 hash_ofp_port(ofport
->ofp_port
));
2244 shash_add(&p
->port_by_name
, netdev_name
, ofport
);
2246 update_mtu(p
, ofport
);
2248 /* Let the ofproto_class initialize its private data. */
2249 error
= p
->ofproto_class
->port_construct(ofport
);
2253 connmgr_send_port_status(p
->connmgr
, NULL
, pp
, OFPPR_ADD
);
2257 VLOG_WARN_RL(&rl
, "%s: could not add port %s (%s)",
2258 p
->name
, netdev_name
, ovs_strerror(error
));
2260 ofport_destroy__(ofport
);
2262 netdev_close(netdev
);
2266 /* Removes 'ofport' from 'p' and destroys it. */
2268 ofport_remove(struct ofport
*ofport
)
2270 connmgr_send_port_status(ofport
->ofproto
->connmgr
, NULL
, &ofport
->pp
,
2272 ofport_destroy(ofport
);
2275 /* If 'ofproto' contains an ofport named 'name', removes it from 'ofproto' and
2278 ofport_remove_with_name(struct ofproto
*ofproto
, const char *name
)
2280 struct ofport
*port
= shash_find_data(&ofproto
->port_by_name
, name
);
2282 ofport_remove(port
);
2286 /* Updates 'port' with new 'pp' description.
2288 * Does not handle a name or port number change. The caller must implement
2289 * such a change as a delete followed by an add. */
2291 ofport_modified(struct ofport
*port
, struct ofputil_phy_port
*pp
)
2293 memcpy(port
->pp
.hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
2294 port
->pp
.config
= ((port
->pp
.config
& ~OFPUTIL_PC_PORT_DOWN
)
2295 | (pp
->config
& OFPUTIL_PC_PORT_DOWN
));
2296 port
->pp
.state
= ((port
->pp
.state
& ~OFPUTIL_PS_LINK_DOWN
)
2297 | (pp
->state
& OFPUTIL_PS_LINK_DOWN
));
2298 port
->pp
.curr
= pp
->curr
;
2299 port
->pp
.advertised
= pp
->advertised
;
2300 port
->pp
.supported
= pp
->supported
;
2301 port
->pp
.peer
= pp
->peer
;
2302 port
->pp
.curr_speed
= pp
->curr_speed
;
2303 port
->pp
.max_speed
= pp
->max_speed
;
2305 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2306 &port
->pp
, OFPPR_MODIFY
);
2309 /* Update OpenFlow 'state' in 'port' and notify controller. */
2311 ofproto_port_set_state(struct ofport
*port
, enum ofputil_port_state state
)
2313 if (port
->pp
.state
!= state
) {
2314 port
->pp
.state
= state
;
2315 connmgr_send_port_status(port
->ofproto
->connmgr
, NULL
,
2316 &port
->pp
, OFPPR_MODIFY
);
2321 ofproto_port_unregister(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2323 struct ofport
*port
= ofproto_get_port(ofproto
, ofp_port
);
2325 if (port
->ofproto
->ofproto_class
->set_realdev
) {
2326 port
->ofproto
->ofproto_class
->set_realdev(port
, 0, 0);
2328 if (port
->ofproto
->ofproto_class
->set_stp_port
) {
2329 port
->ofproto
->ofproto_class
->set_stp_port(port
, NULL
);
2331 if (port
->ofproto
->ofproto_class
->set_rstp_port
) {
2332 port
->ofproto
->ofproto_class
->set_rstp_port(port
, NULL
);
2334 if (port
->ofproto
->ofproto_class
->set_cfm
) {
2335 port
->ofproto
->ofproto_class
->set_cfm(port
, NULL
);
2337 if (port
->ofproto
->ofproto_class
->bundle_remove
) {
2338 port
->ofproto
->ofproto_class
->bundle_remove(port
);
2344 ofport_destroy__(struct ofport
*port
)
2346 struct ofproto
*ofproto
= port
->ofproto
;
2347 const char *name
= netdev_get_name(port
->netdev
);
2349 hmap_remove(&ofproto
->ports
, &port
->hmap_node
);
2350 shash_delete(&ofproto
->port_by_name
,
2351 shash_find(&ofproto
->port_by_name
, name
));
2353 netdev_close(port
->netdev
);
2354 ofproto
->ofproto_class
->port_dealloc(port
);
2358 ofport_destroy(struct ofport
*port
)
2361 dealloc_ofp_port(port
->ofproto
, port
->ofp_port
);
2362 port
->ofproto
->ofproto_class
->port_destruct(port
);
2363 ofport_destroy__(port
);
2368 ofproto_get_port(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2370 struct ofport
*port
;
2372 HMAP_FOR_EACH_IN_BUCKET (port
, hmap_node
, hash_ofp_port(ofp_port
),
2374 if (port
->ofp_port
== ofp_port
) {
2381 static long long int
2382 ofport_get_usage(const struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2384 struct ofport_usage
*usage
;
2386 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2387 &ofproto
->ofport_usage
) {
2388 if (usage
->ofp_port
== ofp_port
) {
2389 return usage
->last_used
;
2396 ofport_set_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
2397 long long int last_used
)
2399 struct ofport_usage
*usage
;
2400 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2401 &ofproto
->ofport_usage
) {
2402 if (usage
->ofp_port
== ofp_port
) {
2403 usage
->last_used
= last_used
;
2407 ovs_assert(last_used
== LLONG_MAX
);
2409 usage
= xmalloc(sizeof *usage
);
2410 usage
->ofp_port
= ofp_port
;
2411 usage
->last_used
= last_used
;
2412 hmap_insert(&ofproto
->ofport_usage
, &usage
->hmap_node
,
2413 hash_ofp_port(ofp_port
));
2417 ofport_remove_usage(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
2419 struct ofport_usage
*usage
;
2420 HMAP_FOR_EACH_IN_BUCKET (usage
, hmap_node
, hash_ofp_port(ofp_port
),
2421 &ofproto
->ofport_usage
) {
2422 if (usage
->ofp_port
== ofp_port
) {
2423 hmap_remove(&ofproto
->ofport_usage
, &usage
->hmap_node
);
2431 ofproto_port_get_stats(const struct ofport
*port
, struct netdev_stats
*stats
)
2433 struct ofproto
*ofproto
= port
->ofproto
;
2436 if (ofproto
->ofproto_class
->port_get_stats
) {
2437 error
= ofproto
->ofproto_class
->port_get_stats(port
, stats
);
2446 update_port(struct ofproto
*ofproto
, const char *name
)
2448 struct ofproto_port ofproto_port
;
2449 struct ofputil_phy_port pp
;
2450 struct netdev
*netdev
;
2451 struct ofport
*port
;
2453 COVERAGE_INC(ofproto_update_port
);
2455 /* Fetch 'name''s location and properties from the datapath. */
2456 netdev
= (!ofproto_port_query_by_name(ofproto
, name
, &ofproto_port
)
2457 ? ofport_open(ofproto
, &ofproto_port
, &pp
)
2461 port
= ofproto_get_port(ofproto
, ofproto_port
.ofp_port
);
2462 if (port
&& !strcmp(netdev_get_name(port
->netdev
), name
)) {
2463 struct netdev
*old_netdev
= port
->netdev
;
2465 /* 'name' hasn't changed location. Any properties changed? */
2466 if (!ofport_equal(&port
->pp
, &pp
)) {
2467 ofport_modified(port
, &pp
);
2470 update_mtu(ofproto
, port
);
2472 /* Install the newly opened netdev in case it has changed.
2473 * Don't close the old netdev yet in case port_modified has to
2474 * remove a retained reference to it.*/
2475 port
->netdev
= netdev
;
2476 port
->change_seq
= netdev_get_change_seq(netdev
);
2478 if (port
->ofproto
->ofproto_class
->port_modified
) {
2479 port
->ofproto
->ofproto_class
->port_modified(port
);
2482 netdev_close(old_netdev
);
2484 /* If 'port' is nonnull then its name differs from 'name' and thus
2485 * we should delete it. If we think there's a port named 'name'
2486 * then its port number must be wrong now so delete it too. */
2488 ofport_remove(port
);
2490 ofport_remove_with_name(ofproto
, name
);
2491 ofport_install(ofproto
, netdev
, &pp
);
2494 /* Any port named 'name' is gone now. */
2495 ofport_remove_with_name(ofproto
, name
);
2497 ofproto_port_destroy(&ofproto_port
);
2501 init_ports(struct ofproto
*p
)
2503 struct ofproto_port_dump dump
;
2504 struct ofproto_port ofproto_port
;
2505 struct shash_node
*node
, *next
;
2507 OFPROTO_PORT_FOR_EACH (&ofproto_port
, &dump
, p
) {
2508 const char *name
= ofproto_port
.name
;
2510 if (shash_find(&p
->port_by_name
, name
)) {
2511 VLOG_WARN_RL(&rl
, "%s: ignoring duplicate device %s in datapath",
2514 struct ofputil_phy_port pp
;
2515 struct netdev
*netdev
;
2517 /* Check if an OpenFlow port number had been requested. */
2518 node
= shash_find(&init_ofp_ports
, name
);
2520 const struct iface_hint
*iface_hint
= node
->data
;
2521 simap_put(&p
->ofp_requests
, name
,
2522 ofp_to_u16(iface_hint
->ofp_port
));
2525 netdev
= ofport_open(p
, &ofproto_port
, &pp
);
2527 ofport_install(p
, netdev
, &pp
);
2528 if (ofp_to_u16(ofproto_port
.ofp_port
) < p
->max_ports
) {
2529 p
->alloc_port_no
= MAX(p
->alloc_port_no
,
2530 ofp_to_u16(ofproto_port
.ofp_port
));
2536 SHASH_FOR_EACH_SAFE(node
, next
, &init_ofp_ports
) {
2537 struct iface_hint
*iface_hint
= node
->data
;
2539 if (!strcmp(iface_hint
->br_name
, p
->name
)) {
2540 free(iface_hint
->br_name
);
2541 free(iface_hint
->br_type
);
2543 shash_delete(&init_ofp_ports
, node
);
2550 /* Find the minimum MTU of all non-datapath devices attached to 'p'.
2551 * Returns ETH_PAYLOAD_MAX or the minimum of the ports. */
2553 find_min_mtu(struct ofproto
*p
)
2555 struct ofport
*ofport
;
2558 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2559 struct netdev
*netdev
= ofport
->netdev
;
2562 /* Skip any internal ports, since that's what we're trying to
2564 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2568 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2571 if (!mtu
|| dev_mtu
< mtu
) {
2576 return mtu
? mtu
: ETH_PAYLOAD_MAX
;
2579 /* Update MTU of all datapath devices on 'p' to the minimum of the
2580 * non-datapath ports in event of 'port' added or changed. */
2582 update_mtu(struct ofproto
*p
, struct ofport
*port
)
2584 struct ofport
*ofport
;
2585 struct netdev
*netdev
= port
->netdev
;
2586 int dev_mtu
, old_min
;
2588 if (netdev_get_mtu(netdev
, &dev_mtu
)) {
2592 if (!strcmp(netdev_get_type(port
->netdev
), "internal")) {
2593 if (dev_mtu
> p
->min_mtu
) {
2594 if (!netdev_set_mtu(port
->netdev
, p
->min_mtu
)) {
2595 dev_mtu
= p
->min_mtu
;
2598 port
->mtu
= dev_mtu
;
2602 /* For non-internal port find new min mtu. */
2603 old_min
= p
->min_mtu
;
2604 port
->mtu
= dev_mtu
;
2605 p
->min_mtu
= find_min_mtu(p
);
2606 if (p
->min_mtu
== old_min
) {
2610 HMAP_FOR_EACH (ofport
, hmap_node
, &p
->ports
) {
2611 struct netdev
*netdev
= ofport
->netdev
;
2613 if (!strcmp(netdev_get_type(netdev
), "internal")) {
2614 if (!netdev_set_mtu(netdev
, p
->min_mtu
)) {
2615 ofport
->mtu
= p
->min_mtu
;
2622 ofproto_rule_destroy__(struct rule
*rule
)
2623 OVS_NO_THREAD_SAFETY_ANALYSIS
2625 cls_rule_destroy(CONST_CAST(struct cls_rule
*, &rule
->cr
));
2626 rule_actions_destroy(rule_get_actions(rule
));
2627 ovs_mutex_destroy(&rule
->mutex
);
2628 rule
->ofproto
->ofproto_class
->rule_dealloc(rule
);
2632 rule_destroy_cb(struct rule
*rule
)
2634 rule
->ofproto
->ofproto_class
->rule_destruct(rule
);
2635 ofproto_rule_destroy__(rule
);
2639 ofproto_rule_ref(struct rule
*rule
)
2642 ovs_refcount_ref(&rule
->ref_count
);
2647 ofproto_rule_try_ref(struct rule
*rule
)
2650 return ovs_refcount_try_ref_rcu(&rule
->ref_count
);
2655 /* Decrements 'rule''s ref_count and schedules 'rule' to be destroyed if the
2656 * ref_count reaches 0.
2658 * Use of RCU allows short term use (between RCU quiescent periods) without
2659 * keeping a reference. A reference must be taken if the rule needs to
2660 * stay around accross the RCU quiescent periods. */
2662 ofproto_rule_unref(struct rule
*rule
)
2664 if (rule
&& ovs_refcount_unref_relaxed(&rule
->ref_count
) == 1) {
2665 ovsrcu_postpone(rule_destroy_cb
, rule
);
2670 ofproto_group_ref(struct ofgroup
*group
)
2673 ovs_refcount_ref(&group
->ref_count
);
2678 ofproto_group_unref(struct ofgroup
*group
)
2680 if (group
&& ovs_refcount_unref(&group
->ref_count
) == 1) {
2681 group
->ofproto
->ofproto_class
->group_destruct(group
);
2682 ofputil_bucket_list_destroy(&group
->buckets
);
2683 group
->ofproto
->ofproto_class
->group_dealloc(group
);
2687 static uint32_t get_provider_meter_id(const struct ofproto
*,
2688 uint32_t of_meter_id
);
2690 /* Creates and returns a new 'struct rule_actions', whose actions are a copy
2691 * of from the 'ofpacts_len' bytes of 'ofpacts'. */
2692 const struct rule_actions
*
2693 rule_actions_create(const struct ofpact
*ofpacts
, size_t ofpacts_len
)
2695 struct rule_actions
*actions
;
2697 actions
= xmalloc(sizeof *actions
+ ofpacts_len
);
2698 actions
->ofpacts_len
= ofpacts_len
;
2699 actions
->has_meter
= ofpacts_get_meter(ofpacts
, ofpacts_len
) != 0;
2700 memcpy(actions
->ofpacts
, ofpacts
, ofpacts_len
);
2702 actions
->has_learn_with_delete
= (next_learn_with_delete(actions
, NULL
)
2708 /* Free the actions after the RCU quiescent period is reached. */
2710 rule_actions_destroy(const struct rule_actions
*actions
)
2713 ovsrcu_postpone(free
, CONST_CAST(struct rule_actions
*, actions
));
2717 /* Returns true if 'rule' has an OpenFlow OFPAT_OUTPUT or OFPAT_ENQUEUE action
2718 * that outputs to 'port' (output to OFPP_FLOOD and OFPP_ALL doesn't count). */
2720 ofproto_rule_has_out_port(const struct rule
*rule
, ofp_port_t port
)
2721 OVS_REQUIRES(ofproto_mutex
)
2723 if (port
== OFPP_ANY
) {
2726 const struct rule_actions
*actions
= rule_get_actions(rule
);
2727 return ofpacts_output_to_port(actions
->ofpacts
,
2728 actions
->ofpacts_len
, port
);
2732 /* Returns true if 'rule' has group and equals group_id. */
2734 ofproto_rule_has_out_group(const struct rule
*rule
, uint32_t group_id
)
2735 OVS_REQUIRES(ofproto_mutex
)
2737 if (group_id
== OFPG_ANY
) {
2740 const struct rule_actions
*actions
= rule_get_actions(rule
);
2741 return ofpacts_output_to_group(actions
->ofpacts
,
2742 actions
->ofpacts_len
, group_id
);
2747 rule_execute_destroy(struct rule_execute
*e
)
2749 ofproto_rule_unref(e
->rule
);
2750 list_remove(&e
->list_node
);
2754 /* Executes all "rule_execute" operations queued up in ofproto->rule_executes,
2755 * by passing them to the ofproto provider. */
2757 run_rule_executes(struct ofproto
*ofproto
)
2758 OVS_EXCLUDED(ofproto_mutex
)
2760 struct rule_execute
*e
, *next
;
2761 struct list executes
;
2763 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2764 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2767 flow_extract(e
->packet
, NULL
, &flow
);
2768 flow
.in_port
.ofp_port
= e
->in_port
;
2769 ofproto
->ofproto_class
->rule_execute(e
->rule
, &flow
, e
->packet
);
2771 rule_execute_destroy(e
);
2775 /* Destroys and discards all "rule_execute" operations queued up in
2776 * ofproto->rule_executes. */
2778 destroy_rule_executes(struct ofproto
*ofproto
)
2780 struct rule_execute
*e
, *next
;
2781 struct list executes
;
2783 guarded_list_pop_all(&ofproto
->rule_executes
, &executes
);
2784 LIST_FOR_EACH_SAFE (e
, next
, list_node
, &executes
) {
2785 ofpbuf_delete(e
->packet
);
2786 rule_execute_destroy(e
);
2791 rule_is_readonly(const struct rule
*rule
)
2793 const struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
2794 return (table
->flags
& OFTABLE_READONLY
) != 0;
2798 hash_learned_cookie(ovs_be64 cookie_
, uint8_t table_id
)
2800 uint64_t cookie
= (OVS_FORCE
uint64_t) cookie_
;
2801 return hash_3words(cookie
, cookie
>> 32, table_id
);
2805 learned_cookies_update_one__(struct ofproto
*ofproto
,
2806 const struct ofpact_learn
*learn
,
2807 int delta
, struct list
*dead_cookies
)
2808 OVS_REQUIRES(ofproto_mutex
)
2810 uint32_t hash
= hash_learned_cookie(learn
->cookie
, learn
->table_id
);
2811 struct learned_cookie
*c
;
2813 HMAP_FOR_EACH_WITH_HASH (c
, u
.hmap_node
, hash
, &ofproto
->learned_cookies
) {
2814 if (c
->cookie
== learn
->cookie
&& c
->table_id
== learn
->table_id
) {
2816 ovs_assert(c
->n
>= 0);
2819 hmap_remove(&ofproto
->learned_cookies
, &c
->u
.hmap_node
);
2820 list_push_back(dead_cookies
, &c
->u
.list_node
);
2827 ovs_assert(delta
> 0);
2828 c
= xmalloc(sizeof *c
);
2829 hmap_insert(&ofproto
->learned_cookies
, &c
->u
.hmap_node
, hash
);
2830 c
->cookie
= learn
->cookie
;
2831 c
->table_id
= learn
->table_id
;
2835 static const struct ofpact_learn
*
2836 next_learn_with_delete(const struct rule_actions
*actions
,
2837 const struct ofpact_learn
*start
)
2839 const struct ofpact
*pos
;
2841 for (pos
= start
? ofpact_next(&start
->ofpact
) : actions
->ofpacts
;
2842 pos
< ofpact_end(actions
->ofpacts
, actions
->ofpacts_len
);
2843 pos
= ofpact_next(pos
)) {
2844 if (pos
->type
== OFPACT_LEARN
) {
2845 const struct ofpact_learn
*learn
= ofpact_get_LEARN(pos
);
2846 if (learn
->flags
& NX_LEARN_F_DELETE_LEARNED
) {
2856 learned_cookies_update__(struct ofproto
*ofproto
,
2857 const struct rule_actions
*actions
,
2858 int delta
, struct list
*dead_cookies
)
2859 OVS_REQUIRES(ofproto_mutex
)
2861 if (actions
->has_learn_with_delete
) {
2862 const struct ofpact_learn
*learn
;
2864 for (learn
= next_learn_with_delete(actions
, NULL
); learn
;
2865 learn
= next_learn_with_delete(actions
, learn
)) {
2866 learned_cookies_update_one__(ofproto
, learn
, delta
, dead_cookies
);
2872 learned_cookies_inc(struct ofproto
*ofproto
,
2873 const struct rule_actions
*actions
)
2874 OVS_REQUIRES(ofproto_mutex
)
2876 learned_cookies_update__(ofproto
, actions
, +1, NULL
);
2880 learned_cookies_dec(struct ofproto
*ofproto
,
2881 const struct rule_actions
*actions
,
2882 struct list
*dead_cookies
)
2883 OVS_REQUIRES(ofproto_mutex
)
2885 learned_cookies_update__(ofproto
, actions
, -1, dead_cookies
);
2889 learned_cookies_flush(struct ofproto
*ofproto
, struct list
*dead_cookies
)
2890 OVS_REQUIRES(ofproto_mutex
)
2892 struct learned_cookie
*c
, *next
;
2894 LIST_FOR_EACH_SAFE (c
, next
, u
.list_node
, dead_cookies
) {
2895 struct rule_criteria criteria
;
2896 struct rule_collection rules
;
2899 match_init_catchall(&match
);
2900 rule_criteria_init(&criteria
, c
->table_id
, &match
, 0,
2901 c
->cookie
, OVS_BE64_MAX
, OFPP_ANY
, OFPG_ANY
);
2902 rule_criteria_require_rw(&criteria
, false);
2903 collect_rules_loose(ofproto
, &criteria
, &rules
);
2904 delete_flows__(&rules
, OFPRR_DELETE
, NULL
);
2905 rule_criteria_destroy(&criteria
);
2906 rule_collection_destroy(&rules
);
2908 list_remove(&c
->u
.list_node
);
2914 handle_echo_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
2916 ofconn_send_reply(ofconn
, make_echo_reply(oh
));
2921 query_tables(struct ofproto
*ofproto
,
2922 struct ofputil_table_features
**featuresp
,
2923 struct ofputil_table_stats
**statsp
)
2925 struct mf_bitmap rw_fields
= oxm_writable_fields();
2926 struct mf_bitmap match
= oxm_matchable_fields();
2927 struct mf_bitmap mask
= oxm_maskable_fields();
2929 struct ofputil_table_features
*features
;
2930 struct ofputil_table_stats
*stats
;
2933 features
= *featuresp
= xcalloc(ofproto
->n_tables
, sizeof *features
);
2934 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2935 struct ofputil_table_features
*f
= &features
[i
];
2938 sprintf(f
->name
, "table%d", i
);
2939 f
->metadata_match
= OVS_BE64_MAX
;
2940 f
->metadata_write
= OVS_BE64_MAX
;
2941 atomic_read_relaxed(&ofproto
->tables
[i
].miss_config
, &f
->miss_config
);
2942 f
->max_entries
= 1000000;
2944 bitmap_set_multiple(f
->nonmiss
.next
, i
+ 1,
2945 ofproto
->n_tables
- (i
+ 1), true);
2946 f
->nonmiss
.instructions
= (1u << N_OVS_INSTRUCTIONS
) - 1;
2947 if (i
== ofproto
->n_tables
- 1) {
2948 f
->nonmiss
.instructions
&= ~(1u << OVSINST_OFPIT11_GOTO_TABLE
);
2950 f
->nonmiss
.write
.ofpacts
= (UINT64_C(1) << N_OFPACTS
) - 1;
2951 f
->nonmiss
.write
.set_fields
= rw_fields
;
2952 f
->nonmiss
.apply
= f
->nonmiss
.write
;
2953 f
->miss
= f
->nonmiss
;
2957 f
->wildcard
= match
;
2961 stats
= *statsp
= xcalloc(ofproto
->n_tables
, sizeof *stats
);
2962 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2963 struct ofputil_table_stats
*s
= &stats
[i
];
2964 struct classifier
*cls
= &ofproto
->tables
[i
].cls
;
2967 s
->active_count
= classifier_count(cls
);
2973 ofproto
->ofproto_class
->query_tables(ofproto
, features
, stats
);
2975 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
2976 const struct oftable
*table
= &ofproto
->tables
[i
];
2977 struct ofputil_table_features
*f
= &features
[i
];
2980 ovs_strzcpy(f
->name
, table
->name
, sizeof f
->name
);
2983 if (table
->max_flows
< f
->max_entries
) {
2984 f
->max_entries
= table
->max_flows
;
2990 query_switch_features(struct ofproto
*ofproto
,
2991 bool *arp_match_ip
, uint64_t *ofpacts
)
2993 struct ofputil_table_features
*features
, *f
;
2995 *arp_match_ip
= false;
2998 query_tables(ofproto
, &features
, NULL
);
2999 for (f
= features
; f
< &features
[ofproto
->n_tables
]; f
++) {
3000 *ofpacts
|= f
->nonmiss
.apply
.ofpacts
| f
->miss
.apply
.ofpacts
;
3001 if (bitmap_is_set(f
->match
.bm
, MFF_ARP_SPA
) ||
3002 bitmap_is_set(f
->match
.bm
, MFF_ARP_TPA
)) {
3003 *arp_match_ip
= true;
3009 ovs_assert(*ofpacts
& (UINT64_C(1) << OFPACT_OUTPUT
));
3013 handle_features_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3015 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3016 struct ofputil_switch_features features
;
3017 struct ofport
*port
;
3021 query_switch_features(ofproto
, &arp_match_ip
, &features
.ofpacts
);
3023 features
.datapath_id
= ofproto
->datapath_id
;
3024 features
.n_buffers
= pktbuf_capacity();
3025 features
.n_tables
= ofproto_get_n_visible_tables(ofproto
);
3026 features
.capabilities
= (OFPUTIL_C_FLOW_STATS
| OFPUTIL_C_TABLE_STATS
|
3027 OFPUTIL_C_PORT_STATS
| OFPUTIL_C_QUEUE_STATS
|
3028 OFPUTIL_C_GROUP_STATS
);
3030 features
.capabilities
|= OFPUTIL_C_ARP_MATCH_IP
;
3032 /* FIXME: Fill in proper features.auxiliary_id for auxiliary connections */
3033 features
.auxiliary_id
= 0;
3034 b
= ofputil_encode_switch_features(&features
, ofconn_get_protocol(ofconn
),
3036 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3037 ofputil_put_switch_features_port(&port
->pp
, b
);
3040 ofconn_send_reply(ofconn
, b
);
3045 handle_get_config_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3047 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3048 struct ofp_switch_config
*osc
;
3049 enum ofp_config_flags flags
;
3053 buf
= ofpraw_alloc_reply(OFPRAW_OFPT_GET_CONFIG_REPLY
, oh
, 0);
3054 osc
= ofpbuf_put_uninit(buf
, sizeof *osc
);
3055 flags
= ofproto
->frag_handling
;
3056 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3057 if (oh
->version
< OFP13_VERSION
3058 && ofconn_get_invalid_ttl_to_controller(ofconn
)) {
3059 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
3061 osc
->flags
= htons(flags
);
3062 osc
->miss_send_len
= htons(ofconn_get_miss_send_len(ofconn
));
3063 ofconn_send_reply(ofconn
, buf
);
3069 handle_set_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3071 const struct ofp_switch_config
*osc
= ofpmsg_body(oh
);
3072 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3073 uint16_t flags
= ntohs(osc
->flags
);
3075 if (ofconn_get_type(ofconn
) != OFCONN_PRIMARY
3076 || ofconn_get_role(ofconn
) != OFPCR12_ROLE_SLAVE
) {
3077 enum ofp_config_flags cur
= ofproto
->frag_handling
;
3078 enum ofp_config_flags next
= flags
& OFPC_FRAG_MASK
;
3080 ovs_assert((cur
& OFPC_FRAG_MASK
) == cur
);
3082 if (ofproto
->ofproto_class
->set_frag_handling(ofproto
, next
)) {
3083 ofproto
->frag_handling
= next
;
3085 VLOG_WARN_RL(&rl
, "%s: unsupported fragment handling mode %s",
3087 ofputil_frag_handling_to_string(next
));
3091 /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OF 1.3 */
3092 ofconn_set_invalid_ttl_to_controller(ofconn
,
3093 (oh
->version
< OFP13_VERSION
3094 && flags
& OFPC_INVALID_TTL_TO_CONTROLLER
));
3096 ofconn_set_miss_send_len(ofconn
, ntohs(osc
->miss_send_len
));
3101 /* Checks whether 'ofconn' is a slave controller. If so, returns an OpenFlow
3102 * error message code for the caller to propagate upward. Otherwise, returns
3105 * The log message mentions 'msg_type'. */
3107 reject_slave_controller(struct ofconn
*ofconn
)
3109 if (ofconn_get_type(ofconn
) == OFCONN_PRIMARY
3110 && ofconn_get_role(ofconn
) == OFPCR12_ROLE_SLAVE
) {
3111 return OFPERR_OFPBRC_EPERM
;
3117 /* Checks that the 'ofpacts_len' bytes of action in 'ofpacts' are appropriate
3120 * - If they use a meter, then 'ofproto' has that meter configured.
3122 * - If they use any groups, then 'ofproto' has that group configured.
3124 * Returns 0 if successful, otherwise an OpenFlow error. */
3126 ofproto_check_ofpacts(struct ofproto
*ofproto
,
3127 const struct ofpact ofpacts
[], size_t ofpacts_len
)
3129 const struct ofpact
*a
;
3132 mid
= ofpacts_get_meter(ofpacts
, ofpacts_len
);
3133 if (mid
&& get_provider_meter_id(ofproto
, mid
) == UINT32_MAX
) {
3134 return OFPERR_OFPMMFC_INVALID_METER
;
3137 OFPACT_FOR_EACH (a
, ofpacts
, ofpacts_len
) {
3138 if (a
->type
== OFPACT_GROUP
3139 && !ofproto_group_exists(ofproto
, ofpact_get_GROUP(a
)->group_id
)) {
3140 return OFPERR_OFPBAC_BAD_OUT_GROUP
;
3148 handle_packet_out(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3150 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3151 struct ofputil_packet_out po
;
3152 struct ofpbuf
*payload
;
3153 uint64_t ofpacts_stub
[1024 / 8];
3154 struct ofpbuf ofpacts
;
3158 COVERAGE_INC(ofproto_packet_out
);
3160 error
= reject_slave_controller(ofconn
);
3165 /* Decode message. */
3166 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
3167 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
3169 goto exit_free_ofpacts
;
3171 if (ofp_to_u16(po
.in_port
) >= p
->max_ports
3172 && ofp_to_u16(po
.in_port
) < ofp_to_u16(OFPP_MAX
)) {
3173 error
= OFPERR_OFPBRC_BAD_PORT
;
3174 goto exit_free_ofpacts
;
3178 if (po
.buffer_id
!= UINT32_MAX
) {
3179 error
= ofconn_pktbuf_retrieve(ofconn
, po
.buffer_id
, &payload
, NULL
);
3180 if (error
|| !payload
) {
3181 goto exit_free_ofpacts
;
3184 /* Ensure that the L3 header is 32-bit aligned. */
3185 payload
= ofpbuf_clone_data_with_headroom(po
.packet
, po
.packet_len
, 2);
3188 /* Verify actions against packet, then send packet if successful. */
3189 flow_extract(payload
, NULL
, &flow
);
3190 flow
.in_port
.ofp_port
= po
.in_port
;
3191 error
= ofproto_check_ofpacts(p
, po
.ofpacts
, po
.ofpacts_len
);
3193 error
= p
->ofproto_class
->packet_out(p
, payload
, &flow
,
3194 po
.ofpacts
, po
.ofpacts_len
);
3196 ofpbuf_delete(payload
);
3199 ofpbuf_uninit(&ofpacts
);
3205 update_port_config(struct ofconn
*ofconn
, struct ofport
*port
,
3206 enum ofputil_port_config config
,
3207 enum ofputil_port_config mask
)
3209 enum ofputil_port_config toggle
= (config
^ port
->pp
.config
) & mask
;
3211 if (toggle
& OFPUTIL_PC_PORT_DOWN
3212 && (config
& OFPUTIL_PC_PORT_DOWN
3213 ? netdev_turn_flags_off(port
->netdev
, NETDEV_UP
, NULL
)
3214 : netdev_turn_flags_on(port
->netdev
, NETDEV_UP
, NULL
))) {
3215 /* We tried to bring the port up or down, but it failed, so don't
3216 * update the "down" bit. */
3217 toggle
&= ~OFPUTIL_PC_PORT_DOWN
;
3221 enum ofputil_port_config old_config
= port
->pp
.config
;
3222 port
->pp
.config
^= toggle
;
3223 port
->ofproto
->ofproto_class
->port_reconfigured(port
, old_config
);
3224 connmgr_send_port_status(port
->ofproto
->connmgr
, ofconn
, &port
->pp
,
3230 handle_port_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
3232 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3233 struct ofputil_port_mod pm
;
3234 struct ofport
*port
;
3237 error
= reject_slave_controller(ofconn
);
3242 error
= ofputil_decode_port_mod(oh
, &pm
, false);
3247 port
= ofproto_get_port(p
, pm
.port_no
);
3249 return OFPERR_OFPPMFC_BAD_PORT
;
3250 } else if (!eth_addr_equals(port
->pp
.hw_addr
, pm
.hw_addr
)) {
3251 return OFPERR_OFPPMFC_BAD_HW_ADDR
;
3253 update_port_config(ofconn
, port
, pm
.config
, pm
.mask
);
3255 netdev_set_advertisements(port
->netdev
, pm
.advertise
);
3262 handle_desc_stats_request(struct ofconn
*ofconn
,
3263 const struct ofp_header
*request
)
3265 static const char *default_mfr_desc
= "Nicira, Inc.";
3266 static const char *default_hw_desc
= "Open vSwitch";
3267 static const char *default_sw_desc
= VERSION
;
3268 static const char *default_serial_desc
= "None";
3269 static const char *default_dp_desc
= "None";
3271 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
3272 struct ofp_desc_stats
*ods
;
3275 msg
= ofpraw_alloc_stats_reply(request
, 0);
3276 ods
= ofpbuf_put_zeros(msg
, sizeof *ods
);
3277 ovs_strlcpy(ods
->mfr_desc
, p
->mfr_desc
? p
->mfr_desc
: default_mfr_desc
,
3278 sizeof ods
->mfr_desc
);
3279 ovs_strlcpy(ods
->hw_desc
, p
->hw_desc
? p
->hw_desc
: default_hw_desc
,
3280 sizeof ods
->hw_desc
);
3281 ovs_strlcpy(ods
->sw_desc
, p
->sw_desc
? p
->sw_desc
: default_sw_desc
,
3282 sizeof ods
->sw_desc
);
3283 ovs_strlcpy(ods
->serial_num
,
3284 p
->serial_desc
? p
->serial_desc
: default_serial_desc
,
3285 sizeof ods
->serial_num
);
3286 ovs_strlcpy(ods
->dp_desc
, p
->dp_desc
? p
->dp_desc
: default_dp_desc
,
3287 sizeof ods
->dp_desc
);
3288 ofconn_send_reply(ofconn
, msg
);
3294 handle_table_stats_request(struct ofconn
*ofconn
,
3295 const struct ofp_header
*request
)
3297 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3298 struct ofputil_table_features
*features
;
3299 struct ofputil_table_stats
*stats
;
3300 struct ofpbuf
*reply
;
3303 query_tables(ofproto
, &features
, &stats
);
3305 reply
= ofputil_encode_table_stats_reply(request
);
3306 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3307 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3308 ofputil_append_table_stats_reply(reply
, &stats
[i
], &features
[i
]);
3311 ofconn_send_reply(ofconn
, reply
);
3320 handle_table_features_request(struct ofconn
*ofconn
,
3321 const struct ofp_header
*request
)
3323 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3324 struct ofputil_table_features
*features
;
3325 struct list replies
;
3329 ofpbuf_use_const(&msg
, request
, ntohs(request
->length
));
3330 ofpraw_pull_assert(&msg
);
3331 if (ofpbuf_size(&msg
) || ofpmp_more(request
)) {
3332 return OFPERR_OFPTFFC_EPERM
;
3335 query_tables(ofproto
, &features
, NULL
);
3337 ofpmp_init(&replies
, request
);
3338 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
3339 if (!(ofproto
->tables
[i
].flags
& OFTABLE_HIDDEN
)) {
3340 ofputil_append_table_features_reply(&features
[i
], &replies
);
3343 ofconn_send_replies(ofconn
, &replies
);
3351 append_port_stat(struct ofport
*port
, struct list
*replies
)
3353 struct ofputil_port_stats ops
= { .port_no
= port
->pp
.port_no
};
3355 calc_duration(port
->created
, time_msec(),
3356 &ops
.duration_sec
, &ops
.duration_nsec
);
3358 /* Intentionally ignore return value, since errors will set
3359 * 'stats' to all-1s, which is correct for OpenFlow, and
3360 * netdev_get_stats() will log errors. */
3361 ofproto_port_get_stats(port
, &ops
.stats
);
3363 ofputil_append_port_stat(replies
, &ops
);
3367 handle_port_request(struct ofconn
*ofconn
,
3368 const struct ofp_header
*request
, ofp_port_t port_no
,
3369 void (*cb
)(struct ofport
*, struct list
*replies
))
3371 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3372 struct ofport
*port
;
3373 struct list replies
;
3375 ofpmp_init(&replies
, request
);
3376 if (port_no
!= OFPP_ANY
) {
3377 port
= ofproto_get_port(ofproto
, port_no
);
3382 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
3387 ofconn_send_replies(ofconn
, &replies
);
3391 handle_port_stats_request(struct ofconn
*ofconn
,
3392 const struct ofp_header
*request
)
3397 error
= ofputil_decode_port_stats_request(request
, &port_no
);
3399 handle_port_request(ofconn
, request
, port_no
, append_port_stat
);
3405 append_port_desc(struct ofport
*port
, struct list
*replies
)
3407 ofputil_append_port_desc_stats_reply(&port
->pp
, replies
);
3411 handle_port_desc_stats_request(struct ofconn
*ofconn
,
3412 const struct ofp_header
*request
)
3417 error
= ofputil_decode_port_desc_stats_request(request
, &port_no
);
3419 handle_port_request(ofconn
, request
, port_no
, append_port_desc
);
3425 hash_cookie(ovs_be64 cookie
)
3427 return hash_uint64((OVS_FORCE
uint64_t)cookie
);
3431 cookies_insert(struct ofproto
*ofproto
, struct rule
*rule
)
3432 OVS_REQUIRES(ofproto_mutex
)
3434 hindex_insert(&ofproto
->cookies
, &rule
->cookie_node
,
3435 hash_cookie(rule
->flow_cookie
));
3439 cookies_remove(struct ofproto
*ofproto
, struct rule
*rule
)
3440 OVS_REQUIRES(ofproto_mutex
)
3442 hindex_remove(&ofproto
->cookies
, &rule
->cookie_node
);
3446 calc_duration(long long int start
, long long int now
,
3447 uint32_t *sec
, uint32_t *nsec
)
3449 long long int msecs
= now
- start
;
3450 *sec
= msecs
/ 1000;
3451 *nsec
= (msecs
% 1000) * (1000 * 1000);
3454 /* Checks whether 'table_id' is 0xff or a valid table ID in 'ofproto'. Returns
3455 * true if 'table_id' is OK, false otherwise. */
3457 check_table_id(const struct ofproto
*ofproto
, uint8_t table_id
)
3459 return table_id
== OFPTT_ALL
|| table_id
< ofproto
->n_tables
;
3462 static struct oftable
*
3463 next_visible_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3465 struct oftable
*table
;
3467 for (table
= &ofproto
->tables
[table_id
];
3468 table
< &ofproto
->tables
[ofproto
->n_tables
];
3470 if (!(table
->flags
& OFTABLE_HIDDEN
)) {
3478 static struct oftable
*
3479 first_matching_table(const struct ofproto
*ofproto
, uint8_t table_id
)
3481 if (table_id
== 0xff) {
3482 return next_visible_table(ofproto
, 0);
3483 } else if (table_id
< ofproto
->n_tables
) {
3484 return &ofproto
->tables
[table_id
];
3490 static struct oftable
*
3491 next_matching_table(const struct ofproto
*ofproto
,
3492 const struct oftable
*table
, uint8_t table_id
)
3494 return (table_id
== 0xff
3495 ? next_visible_table(ofproto
, (table
- ofproto
->tables
) + 1)
3499 /* Assigns TABLE to each oftable, in turn, that matches TABLE_ID in OFPROTO:
3501 * - If TABLE_ID is 0xff, this iterates over every classifier table in
3502 * OFPROTO, skipping tables marked OFTABLE_HIDDEN.
3504 * - If TABLE_ID is the number of a table in OFPROTO, then the loop iterates
3505 * only once, for that table. (This can be used to access tables marked
3508 * - Otherwise, TABLE_ID isn't valid for OFPROTO, so the loop won't be
3509 * entered at all. (Perhaps you should have validated TABLE_ID with
3510 * check_table_id().)
3512 * All parameters are evaluated multiple times.
3514 #define FOR_EACH_MATCHING_TABLE(TABLE, TABLE_ID, OFPROTO) \
3515 for ((TABLE) = first_matching_table(OFPROTO, TABLE_ID); \
3517 (TABLE) = next_matching_table(OFPROTO, TABLE, TABLE_ID))
3519 /* Initializes 'criteria' in a straightforward way based on the other
3522 * By default, the criteria include flows that are read-only, on the assumption
3523 * that the collected flows won't be modified. Call rule_criteria_require_rw()
3524 * if flows will be modified.
3526 * For "loose" matching, the 'priority' parameter is unimportant and may be
3529 rule_criteria_init(struct rule_criteria
*criteria
, uint8_t table_id
,
3530 const struct match
*match
, int priority
,
3531 ovs_be64 cookie
, ovs_be64 cookie_mask
,
3532 ofp_port_t out_port
, uint32_t out_group
)
3534 criteria
->table_id
= table_id
;
3535 cls_rule_init(&criteria
->cr
, match
, priority
);
3536 criteria
->cookie
= cookie
;
3537 criteria
->cookie_mask
= cookie_mask
;
3538 criteria
->out_port
= out_port
;
3539 criteria
->out_group
= out_group
;
3541 /* We ordinarily want to skip hidden rules, but there has to be a way for
3542 * code internal to OVS to modify and delete them, so if the criteria
3543 * specify a priority that can only be for a hidden flow, then allow hidden
3544 * rules to be selected. (This doesn't allow OpenFlow clients to meddle
3545 * with hidden flows because OpenFlow uses only a 16-bit field to specify
3547 criteria
->include_hidden
= priority
> UINT16_MAX
;
3549 /* We assume that the criteria are being used to collect flows for reading
3550 * but not modification. Thus, we should collect read-only flows. */
3551 criteria
->include_readonly
= true;
3554 /* By default, criteria initialized by rule_criteria_init() will match flows
3555 * that are read-only, on the assumption that the collected flows won't be
3556 * modified. Call this function to match only flows that are be modifiable.
3558 * Specify 'can_write_readonly' as false in ordinary circumstances, true if the
3559 * caller has special privileges that allow it to modify even "read-only"
3562 rule_criteria_require_rw(struct rule_criteria
*criteria
,
3563 bool can_write_readonly
)
3565 criteria
->include_readonly
= can_write_readonly
;
3569 rule_criteria_destroy(struct rule_criteria
*criteria
)
3571 cls_rule_destroy(&criteria
->cr
);
3575 rule_collection_init(struct rule_collection
*rules
)
3577 rules
->rules
= rules
->stub
;
3579 rules
->capacity
= ARRAY_SIZE(rules
->stub
);
3583 rule_collection_add(struct rule_collection
*rules
, struct rule
*rule
)
3585 if (rules
->n
>= rules
->capacity
) {
3586 size_t old_size
, new_size
;
3588 old_size
= rules
->capacity
* sizeof *rules
->rules
;
3589 rules
->capacity
*= 2;
3590 new_size
= rules
->capacity
* sizeof *rules
->rules
;
3592 if (rules
->rules
== rules
->stub
) {
3593 rules
->rules
= xmalloc(new_size
);
3594 memcpy(rules
->rules
, rules
->stub
, old_size
);
3596 rules
->rules
= xrealloc(rules
->rules
, new_size
);
3600 rules
->rules
[rules
->n
++] = rule
;
3604 rule_collection_ref(struct rule_collection
*rules
)
3605 OVS_REQUIRES(ofproto_mutex
)
3609 for (i
= 0; i
< rules
->n
; i
++) {
3610 ofproto_rule_ref(rules
->rules
[i
]);
3615 rule_collection_unref(struct rule_collection
*rules
)
3619 for (i
= 0; i
< rules
->n
; i
++) {
3620 ofproto_rule_unref(rules
->rules
[i
]);
3625 rule_collection_destroy(struct rule_collection
*rules
)
3627 if (rules
->rules
!= rules
->stub
) {
3631 /* Make repeated destruction harmless. */
3632 rule_collection_init(rules
);
3635 /* Checks whether 'rule' matches 'c' and, if so, adds it to 'rules'. This
3636 * function verifies most of the criteria in 'c' itself, but the caller must
3637 * check 'c->cr' itself.
3639 * Increments '*n_readonly' if 'rule' wasn't added because it's read-only (and
3640 * 'c' only includes modifiable rules). */
3642 collect_rule(struct rule
*rule
, const struct rule_criteria
*c
,
3643 struct rule_collection
*rules
, size_t *n_readonly
)
3644 OVS_REQUIRES(ofproto_mutex
)
3646 if ((c
->table_id
== rule
->table_id
|| c
->table_id
== 0xff)
3647 && ofproto_rule_has_out_port(rule
, c
->out_port
)
3648 && ofproto_rule_has_out_group(rule
, c
->out_group
)
3649 && !((rule
->flow_cookie
^ c
->cookie
) & c
->cookie_mask
)
3650 && (!rule_is_hidden(rule
) || c
->include_hidden
)) {
3651 /* Rule matches all the criteria... */
3652 if (!rule_is_readonly(rule
) || c
->include_readonly
) {
3654 rule_collection_add(rules
, rule
);
3656 /* ...except it's read-only. */
3662 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3663 * on classifiers rules are done in the "loose" way required for OpenFlow
3664 * OFPFC_MODIFY and OFPFC_DELETE requests. Puts the selected rules on list
3667 * Returns 0 on success, otherwise an OpenFlow error code. */
3669 collect_rules_loose(struct ofproto
*ofproto
,
3670 const struct rule_criteria
*criteria
,
3671 struct rule_collection
*rules
)
3672 OVS_REQUIRES(ofproto_mutex
)
3674 struct oftable
*table
;
3675 enum ofperr error
= 0;
3676 size_t n_readonly
= 0;
3678 rule_collection_init(rules
);
3680 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3681 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3685 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3688 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3689 hash_cookie(criteria
->cookie
),
3690 &ofproto
->cookies
) {
3691 if (cls_rule_is_loose_match(&rule
->cr
, &criteria
->cr
.match
)) {
3692 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3696 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3699 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &criteria
->cr
) {
3700 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3706 if (!error
&& !rules
->n
&& n_readonly
) {
3707 /* We didn't find any rules to modify. We did find some read-only
3708 * rules that we're not allowed to modify, so report that. */
3709 error
= OFPERR_OFPBRC_EPERM
;
3712 rule_collection_destroy(rules
);
3717 /* Searches 'ofproto' for rules that match the criteria in 'criteria'. Matches
3718 * on classifiers rules are done in the "strict" way required for OpenFlow
3719 * OFPFC_MODIFY_STRICT and OFPFC_DELETE_STRICT requests. Puts the selected
3720 * rules on list 'rules'.
3722 * Returns 0 on success, otherwise an OpenFlow error code. */
3724 collect_rules_strict(struct ofproto
*ofproto
,
3725 const struct rule_criteria
*criteria
,
3726 struct rule_collection
*rules
)
3727 OVS_REQUIRES(ofproto_mutex
)
3729 struct oftable
*table
;
3730 size_t n_readonly
= 0;
3733 rule_collection_init(rules
);
3735 if (!check_table_id(ofproto
, criteria
->table_id
)) {
3736 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
3740 if (criteria
->cookie_mask
== OVS_BE64_MAX
) {
3743 HINDEX_FOR_EACH_WITH_HASH (rule
, cookie_node
,
3744 hash_cookie(criteria
->cookie
),
3745 &ofproto
->cookies
) {
3746 if (cls_rule_equal(&rule
->cr
, &criteria
->cr
)) {
3747 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3751 FOR_EACH_MATCHING_TABLE (table
, criteria
->table_id
, ofproto
) {
3754 rule
= rule_from_cls_rule(classifier_find_rule_exactly(
3755 &table
->cls
, &criteria
->cr
));
3757 collect_rule(rule
, criteria
, rules
, &n_readonly
);
3763 if (!error
&& !rules
->n
&& n_readonly
) {
3764 /* We didn't find any rules to modify. We did find some read-only
3765 * rules that we're not allowed to modify, so report that. */
3766 error
= OFPERR_OFPBRC_EPERM
;
3769 rule_collection_destroy(rules
);
3774 /* Returns 'age_ms' (a duration in milliseconds), converted to seconds and
3775 * forced into the range of a uint16_t. */
3777 age_secs(long long int age_ms
)
3779 return (age_ms
< 0 ? 0
3780 : age_ms
>= UINT16_MAX
* 1000 ? UINT16_MAX
3781 : (unsigned int) age_ms
/ 1000);
3785 handle_flow_stats_request(struct ofconn
*ofconn
,
3786 const struct ofp_header
*request
)
3787 OVS_EXCLUDED(ofproto_mutex
)
3789 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3790 struct ofputil_flow_stats_request fsr
;
3791 struct rule_criteria criteria
;
3792 struct rule_collection rules
;
3793 struct list replies
;
3797 error
= ofputil_decode_flow_stats_request(&fsr
, request
);
3802 rule_criteria_init(&criteria
, fsr
.table_id
, &fsr
.match
, 0, fsr
.cookie
,
3803 fsr
.cookie_mask
, fsr
.out_port
, fsr
.out_group
);
3805 ovs_mutex_lock(&ofproto_mutex
);
3806 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3807 rule_criteria_destroy(&criteria
);
3809 rule_collection_ref(&rules
);
3811 ovs_mutex_unlock(&ofproto_mutex
);
3817 ofpmp_init(&replies
, request
);
3818 for (i
= 0; i
< rules
.n
; i
++) {
3819 struct rule
*rule
= rules
.rules
[i
];
3820 long long int now
= time_msec();
3821 struct ofputil_flow_stats fs
;
3822 long long int created
, used
, modified
;
3823 const struct rule_actions
*actions
;
3824 enum ofputil_flow_mod_flags flags
;
3826 ovs_mutex_lock(&rule
->mutex
);
3827 fs
.cookie
= rule
->flow_cookie
;
3828 fs
.idle_timeout
= rule
->idle_timeout
;
3829 fs
.hard_timeout
= rule
->hard_timeout
;
3830 fs
.importance
= rule
->importance
;
3831 created
= rule
->created
;
3832 modified
= rule
->modified
;
3833 actions
= rule_get_actions(rule
);
3834 flags
= rule
->flags
;
3835 ovs_mutex_unlock(&rule
->mutex
);
3837 ofproto
->ofproto_class
->rule_get_stats(rule
, &fs
.packet_count
,
3838 &fs
.byte_count
, &used
);
3840 minimatch_expand(&rule
->cr
.match
, &fs
.match
);
3841 fs
.table_id
= rule
->table_id
;
3842 calc_duration(created
, now
, &fs
.duration_sec
, &fs
.duration_nsec
);
3843 fs
.priority
= rule
->cr
.priority
;
3844 fs
.idle_age
= age_secs(now
- used
);
3845 fs
.hard_age
= age_secs(now
- modified
);
3846 fs
.ofpacts
= actions
->ofpacts
;
3847 fs
.ofpacts_len
= actions
->ofpacts_len
;
3850 ofputil_append_flow_stats_reply(&fs
, &replies
);
3853 rule_collection_unref(&rules
);
3854 rule_collection_destroy(&rules
);
3856 ofconn_send_replies(ofconn
, &replies
);
3862 flow_stats_ds(struct rule
*rule
, struct ds
*results
)
3864 uint64_t packet_count
, byte_count
;
3865 const struct rule_actions
*actions
;
3866 long long int created
, used
;
3868 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3869 &byte_count
, &used
);
3871 ovs_mutex_lock(&rule
->mutex
);
3872 actions
= rule_get_actions(rule
);
3873 created
= rule
->created
;
3874 ovs_mutex_unlock(&rule
->mutex
);
3876 if (rule
->table_id
!= 0) {
3877 ds_put_format(results
, "table_id=%"PRIu8
", ", rule
->table_id
);
3879 ds_put_format(results
, "duration=%llds, ", (time_msec() - created
) / 1000);
3880 ds_put_format(results
, "n_packets=%"PRIu64
", ", packet_count
);
3881 ds_put_format(results
, "n_bytes=%"PRIu64
", ", byte_count
);
3882 cls_rule_format(&rule
->cr
, results
);
3883 ds_put_char(results
, ',');
3885 ds_put_cstr(results
, "actions=");
3886 ofpacts_format(actions
->ofpacts
, actions
->ofpacts_len
, results
);
3888 ds_put_cstr(results
, "\n");
3891 /* Adds a pretty-printed description of all flows to 'results', including
3892 * hidden flows (e.g., set up by in-band control). */
3894 ofproto_get_all_flows(struct ofproto
*p
, struct ds
*results
)
3896 struct oftable
*table
;
3898 OFPROTO_FOR_EACH_TABLE (table
, p
) {
3901 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
3902 flow_stats_ds(rule
, results
);
3907 /* Obtains the NetFlow engine type and engine ID for 'ofproto' into
3908 * '*engine_type' and '*engine_id', respectively. */
3910 ofproto_get_netflow_ids(const struct ofproto
*ofproto
,
3911 uint8_t *engine_type
, uint8_t *engine_id
)
3913 ofproto
->ofproto_class
->get_netflow_ids(ofproto
, engine_type
, engine_id
);
3916 /* Checks the status change of CFM on 'ofport'.
3918 * Returns true if 'ofproto_class' does not support 'cfm_status_changed'. */
3920 ofproto_port_cfm_status_changed(struct ofproto
*ofproto
, ofp_port_t ofp_port
)
3922 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3923 return (ofport
&& ofproto
->ofproto_class
->cfm_status_changed
3924 ? ofproto
->ofproto_class
->cfm_status_changed(ofport
)
3928 /* Checks the status of CFM configured on 'ofp_port' within 'ofproto'.
3929 * Returns 0 if the port's CFM status was successfully stored into
3930 * '*status'. Returns positive errno if the port did not have CFM
3933 * The caller must provide and own '*status', and must free 'status->rmps'.
3934 * '*status' is indeterminate if the return value is non-zero. */
3936 ofproto_port_get_cfm_status(const struct ofproto
*ofproto
, ofp_port_t ofp_port
,
3937 struct cfm_status
*status
)
3939 struct ofport
*ofport
= ofproto_get_port(ofproto
, ofp_port
);
3940 return (ofport
&& ofproto
->ofproto_class
->get_cfm_status
3941 ? ofproto
->ofproto_class
->get_cfm_status(ofport
, status
)
3946 handle_aggregate_stats_request(struct ofconn
*ofconn
,
3947 const struct ofp_header
*oh
)
3948 OVS_EXCLUDED(ofproto_mutex
)
3950 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
3951 struct ofputil_flow_stats_request request
;
3952 struct ofputil_aggregate_stats stats
;
3953 bool unknown_packets
, unknown_bytes
;
3954 struct rule_criteria criteria
;
3955 struct rule_collection rules
;
3956 struct ofpbuf
*reply
;
3960 error
= ofputil_decode_flow_stats_request(&request
, oh
);
3965 rule_criteria_init(&criteria
, request
.table_id
, &request
.match
, 0,
3966 request
.cookie
, request
.cookie_mask
,
3967 request
.out_port
, request
.out_group
);
3969 ovs_mutex_lock(&ofproto_mutex
);
3970 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
3971 rule_criteria_destroy(&criteria
);
3973 rule_collection_ref(&rules
);
3975 ovs_mutex_unlock(&ofproto_mutex
);
3981 memset(&stats
, 0, sizeof stats
);
3982 unknown_packets
= unknown_bytes
= false;
3983 for (i
= 0; i
< rules
.n
; i
++) {
3984 struct rule
*rule
= rules
.rules
[i
];
3985 uint64_t packet_count
;
3986 uint64_t byte_count
;
3989 ofproto
->ofproto_class
->rule_get_stats(rule
, &packet_count
,
3990 &byte_count
, &used
);
3992 if (packet_count
== UINT64_MAX
) {
3993 unknown_packets
= true;
3995 stats
.packet_count
+= packet_count
;
3998 if (byte_count
== UINT64_MAX
) {
3999 unknown_bytes
= true;
4001 stats
.byte_count
+= byte_count
;
4006 if (unknown_packets
) {
4007 stats
.packet_count
= UINT64_MAX
;
4009 if (unknown_bytes
) {
4010 stats
.byte_count
= UINT64_MAX
;
4013 rule_collection_unref(&rules
);
4014 rule_collection_destroy(&rules
);
4016 reply
= ofputil_encode_aggregate_stats_reply(&stats
, oh
);
4017 ofconn_send_reply(ofconn
, reply
);
4022 struct queue_stats_cbdata
{
4023 struct ofport
*ofport
;
4024 struct list replies
;
4029 put_queue_stats(struct queue_stats_cbdata
*cbdata
, uint32_t queue_id
,
4030 const struct netdev_queue_stats
*stats
)
4032 struct ofputil_queue_stats oqs
;
4034 oqs
.port_no
= cbdata
->ofport
->pp
.port_no
;
4035 oqs
.queue_id
= queue_id
;
4036 oqs
.tx_bytes
= stats
->tx_bytes
;
4037 oqs
.tx_packets
= stats
->tx_packets
;
4038 oqs
.tx_errors
= stats
->tx_errors
;
4039 if (stats
->created
!= LLONG_MIN
) {
4040 calc_duration(stats
->created
, cbdata
->now
,
4041 &oqs
.duration_sec
, &oqs
.duration_nsec
);
4043 oqs
.duration_sec
= oqs
.duration_nsec
= UINT32_MAX
;
4045 ofputil_append_queue_stat(&cbdata
->replies
, &oqs
);
4049 handle_queue_stats_dump_cb(uint32_t queue_id
,
4050 struct netdev_queue_stats
*stats
,
4053 struct queue_stats_cbdata
*cbdata
= cbdata_
;
4055 put_queue_stats(cbdata
, queue_id
, stats
);
4059 handle_queue_stats_for_port(struct ofport
*port
, uint32_t queue_id
,
4060 struct queue_stats_cbdata
*cbdata
)
4062 cbdata
->ofport
= port
;
4063 if (queue_id
== OFPQ_ALL
) {
4064 netdev_dump_queue_stats(port
->netdev
,
4065 handle_queue_stats_dump_cb
, cbdata
);
4067 struct netdev_queue_stats stats
;
4069 if (!netdev_get_queue_stats(port
->netdev
, queue_id
, &stats
)) {
4070 put_queue_stats(cbdata
, queue_id
, &stats
);
4072 return OFPERR_OFPQOFC_BAD_QUEUE
;
4079 handle_queue_stats_request(struct ofconn
*ofconn
,
4080 const struct ofp_header
*rq
)
4082 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4083 struct queue_stats_cbdata cbdata
;
4084 struct ofport
*port
;
4086 struct ofputil_queue_stats_request oqsr
;
4088 COVERAGE_INC(ofproto_queue_req
);
4090 ofpmp_init(&cbdata
.replies
, rq
);
4091 cbdata
.now
= time_msec();
4093 error
= ofputil_decode_queue_stats_request(rq
, &oqsr
);
4098 if (oqsr
.port_no
== OFPP_ANY
) {
4099 error
= OFPERR_OFPQOFC_BAD_QUEUE
;
4100 HMAP_FOR_EACH (port
, hmap_node
, &ofproto
->ports
) {
4101 if (!handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)) {
4106 port
= ofproto_get_port(ofproto
, oqsr
.port_no
);
4108 ? handle_queue_stats_for_port(port
, oqsr
.queue_id
, &cbdata
)
4109 : OFPERR_OFPQOFC_BAD_PORT
);
4112 ofconn_send_replies(ofconn
, &cbdata
.replies
);
4114 ofpbuf_list_delete(&cbdata
.replies
);
4121 should_evict_a_rule(struct oftable
*table
, unsigned int extra_space
)
4122 OVS_REQUIRES(ofproto_mutex
)
4123 OVS_NO_THREAD_SAFETY_ANALYSIS
4125 return classifier_count(&table
->cls
) + extra_space
> table
->max_flows
;
4129 evict_rules_from_table(struct oftable
*table
, unsigned int extra_space
)
4130 OVS_REQUIRES(ofproto_mutex
)
4132 while (should_evict_a_rule(table
, extra_space
)) {
4135 if (!choose_rule_to_evict(table
, &rule
)) {
4136 return OFPERR_OFPFMFC_TABLE_FULL
;
4138 ofproto_rule_delete__(rule
, OFPRR_EVICTION
);
4145 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
4146 * in which no matching flow already exists in the flow table.
4148 * Adds the flow specified by 'ofm', which is followed by 'n_actions'
4149 * ofp_actions, to the ofproto's flow table. Returns 0 on success, an OpenFlow
4150 * error code on failure, or OFPROTO_POSTPONE if the operation cannot be
4151 * initiated now but may be retried later.
4153 * The caller retains ownership of 'fm->ofpacts'.
4155 * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
4158 add_flow(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4159 const struct flow_mod_requester
*req
)
4160 OVS_REQUIRES(ofproto_mutex
)
4162 const struct rule_actions
*actions
;
4163 struct oftable
*table
;
4169 if (!check_table_id(ofproto
, fm
->table_id
)) {
4170 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
4175 if (fm
->table_id
== 0xff) {
4176 if (ofproto
->ofproto_class
->rule_choose_table
) {
4177 error
= ofproto
->ofproto_class
->rule_choose_table(ofproto
,
4183 ovs_assert(table_id
< ofproto
->n_tables
);
4187 } else if (fm
->table_id
< ofproto
->n_tables
) {
4188 table_id
= fm
->table_id
;
4190 return OFPERR_OFPBRC_BAD_TABLE_ID
;
4193 table
= &ofproto
->tables
[table_id
];
4194 if (table
->flags
& OFTABLE_READONLY
4195 && !(fm
->flags
& OFPUTIL_FF_NO_READONLY
)) {
4196 return OFPERR_OFPBRC_EPERM
;
4199 if (!(fm
->flags
& OFPUTIL_FF_HIDDEN_FIELDS
)) {
4200 if (!match_has_default_hidden_fields(&fm
->match
)) {
4201 VLOG_WARN_RL(&rl
, "%s: (add_flow) only internal flows can set "
4202 "non-default values to hidden fields", ofproto
->name
);
4203 return OFPERR_OFPBRC_EPERM
;
4207 cls_rule_init(&cr
, &fm
->match
, fm
->priority
);
4209 /* Transform "add" into "modify" if there's an existing identical flow. */
4210 rule
= rule_from_cls_rule(classifier_find_rule_exactly(&table
->cls
, &cr
));
4212 struct rule_collection rules
;
4214 cls_rule_destroy(&cr
);
4216 rule_collection_init(&rules
);
4217 rule_collection_add(&rules
, rule
);
4218 fm
->modify_cookie
= true;
4219 error
= modify_flows__(ofproto
, fm
, &rules
, req
);
4220 rule_collection_destroy(&rules
);
4225 /* Check for overlap, if requested. */
4226 if (fm
->flags
& OFPUTIL_FF_CHECK_OVERLAP
) {
4227 if (classifier_rule_overlaps(&table
->cls
, &cr
)) {
4228 cls_rule_destroy(&cr
);
4229 return OFPERR_OFPFMFC_OVERLAP
;
4233 /* If necessary, evict an existing rule to clear out space. */
4234 error
= evict_rules_from_table(table
, 1);
4236 cls_rule_destroy(&cr
);
4240 /* Allocate new rule. */
4241 rule
= ofproto
->ofproto_class
->rule_alloc();
4243 cls_rule_destroy(&cr
);
4244 VLOG_WARN_RL(&rl
, "%s: failed to create rule (%s)",
4245 ofproto
->name
, ovs_strerror(error
));
4249 /* Initialize base state. */
4250 *CONST_CAST(struct ofproto
**, &rule
->ofproto
) = ofproto
;
4251 cls_rule_move(CONST_CAST(struct cls_rule
*, &rule
->cr
), &cr
);
4252 ovs_refcount_init(&rule
->ref_count
);
4253 rule
->flow_cookie
= fm
->new_cookie
;
4254 rule
->created
= rule
->modified
= time_msec();
4256 ovs_mutex_init(&rule
->mutex
);
4257 ovs_mutex_lock(&rule
->mutex
);
4258 rule
->idle_timeout
= fm
->idle_timeout
;
4259 rule
->hard_timeout
= fm
->hard_timeout
;
4260 rule
->importance
= fm
->importance
;
4261 ovs_mutex_unlock(&rule
->mutex
);
4263 *CONST_CAST(uint8_t *, &rule
->table_id
) = table
- ofproto
->tables
;
4264 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4265 actions
= rule_actions_create(fm
->ofpacts
, fm
->ofpacts_len
);
4266 ovsrcu_set(&rule
->actions
, actions
);
4267 list_init(&rule
->meter_list_node
);
4268 rule
->eviction_group
= NULL
;
4269 list_init(&rule
->expirable
);
4270 rule
->monitor_flags
= 0;
4271 rule
->add_seqno
= 0;
4272 rule
->modify_seqno
= 0;
4274 /* Construct rule, initializing derived state. */
4275 error
= ofproto
->ofproto_class
->rule_construct(rule
);
4277 ofproto_rule_destroy__(rule
);
4281 if (fm
->hard_timeout
|| fm
->idle_timeout
) {
4282 list_insert(&ofproto
->expirable
, &rule
->expirable
);
4284 cookies_insert(ofproto
, rule
);
4285 eviction_group_add_rule(rule
);
4286 if (actions
->has_meter
) {
4287 meter_insert_rule(rule
);
4290 classifier_insert(&table
->cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
4292 error
= ofproto
->ofproto_class
->rule_insert(rule
);
4294 oftable_remove_rule(rule
);
4295 ofproto_rule_unref(rule
);
4298 learned_cookies_inc(ofproto
, actions
);
4300 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
4301 if (ofproto
->vlan_bitmap
) {
4302 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
4303 if (!bitmap_is_set(ofproto
->vlan_bitmap
, vid
)) {
4304 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
4305 ofproto
->vlans_changed
= true;
4308 ofproto
->vlans_changed
= true;
4312 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_ADDED
, 0,
4313 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0, NULL
);
4315 return req
? send_buffered_packet(req
->ofconn
, fm
->buffer_id
, rule
) : 0;
4318 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
4320 /* Modifies the rules listed in 'rules', changing their actions to match those
4323 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4326 * Returns 0 on success, otherwise an OpenFlow error code. */
4328 modify_flows__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4329 const struct rule_collection
*rules
,
4330 const struct flow_mod_requester
*req
)
4331 OVS_REQUIRES(ofproto_mutex
)
4333 struct list dead_cookies
= LIST_INITIALIZER(&dead_cookies
);
4334 enum nx_flow_update_event event
;
4337 if (ofproto
->ofproto_class
->rule_premodify_actions
) {
4338 for (i
= 0; i
< rules
->n
; i
++) {
4339 struct rule
*rule
= rules
->rules
[i
];
4342 error
= ofproto
->ofproto_class
->rule_premodify_actions(
4343 rule
, fm
->ofpacts
, fm
->ofpacts_len
);
4350 event
= fm
->command
== OFPFC_ADD
? NXFME_ADDED
: NXFME_MODIFIED
;
4351 for (i
= 0; i
< rules
->n
; i
++) {
4352 struct rule
*rule
= rules
->rules
[i
];
4354 /* 'fm' says that */
4355 bool change_cookie
= (fm
->modify_cookie
4356 && fm
->new_cookie
!= OVS_BE64_MAX
4357 && fm
->new_cookie
!= rule
->flow_cookie
);
4359 const struct rule_actions
*actions
= rule_get_actions(rule
);
4360 bool change_actions
= !ofpacts_equal(fm
->ofpacts
, fm
->ofpacts_len
,
4362 actions
->ofpacts_len
);
4364 bool reset_counters
= (fm
->flags
& OFPUTIL_FF_RESET_COUNTS
) != 0;
4366 long long int now
= time_msec();
4368 if (change_cookie
) {
4369 cookies_remove(ofproto
, rule
);
4372 ovs_mutex_lock(&rule
->mutex
);
4373 if (fm
->command
== OFPFC_ADD
) {
4374 rule
->idle_timeout
= fm
->idle_timeout
;
4375 rule
->hard_timeout
= fm
->hard_timeout
;
4376 rule
->importance
= fm
->importance
;
4377 rule
->flags
= fm
->flags
& OFPUTIL_FF_STATE
;
4378 rule
->created
= now
;
4380 if (change_cookie
) {
4381 rule
->flow_cookie
= fm
->new_cookie
;
4383 rule
->modified
= now
;
4384 ovs_mutex_unlock(&rule
->mutex
);
4386 if (change_cookie
) {
4387 cookies_insert(ofproto
, rule
);
4389 if (fm
->command
== OFPFC_ADD
) {
4390 if (fm
->idle_timeout
|| fm
->hard_timeout
|| fm
->importance
) {
4391 if (!rule
->eviction_group
) {
4392 eviction_group_add_rule(rule
);
4395 eviction_group_remove_rule(rule
);
4399 if (change_actions
) {
4400 ovsrcu_set(&rule
->actions
, rule_actions_create(fm
->ofpacts
,
4404 if (change_actions
|| reset_counters
) {
4405 ofproto
->ofproto_class
->rule_modify_actions(rule
, reset_counters
);
4408 if (event
!= NXFME_MODIFIED
|| change_actions
|| change_cookie
) {
4409 ofmonitor_report(ofproto
->connmgr
, rule
, event
, 0,
4410 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0,
4411 change_actions
? actions
: NULL
);
4414 if (change_actions
) {
4415 learned_cookies_inc(ofproto
, rule_get_actions(rule
));
4416 learned_cookies_dec(ofproto
, actions
, &dead_cookies
);
4417 rule_actions_destroy(actions
);
4420 learned_cookies_flush(ofproto
, &dead_cookies
);
4422 if (fm
->buffer_id
!= UINT32_MAX
&& req
) {
4423 return send_buffered_packet(req
->ofconn
, fm
->buffer_id
,
4431 modify_flows_add(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4432 const struct flow_mod_requester
*req
)
4433 OVS_REQUIRES(ofproto_mutex
)
4435 if (fm
->cookie_mask
!= htonll(0) || fm
->new_cookie
== OVS_BE64_MAX
) {
4438 return add_flow(ofproto
, fm
, req
);
4441 /* Implements OFPFC_MODIFY. Returns 0 on success or an OpenFlow error code on
4444 * 'ofconn' is used to retrieve the packet buffer specified in fm->buffer_id,
4447 modify_flows_loose(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4448 const struct flow_mod_requester
*req
)
4449 OVS_REQUIRES(ofproto_mutex
)
4451 struct rule_criteria criteria
;
4452 struct rule_collection rules
;
4455 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4456 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4457 rule_criteria_require_rw(&criteria
,
4458 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4459 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4460 rule_criteria_destroy(&criteria
);
4463 error
= (rules
.n
> 0
4464 ? modify_flows__(ofproto
, fm
, &rules
, req
)
4465 : modify_flows_add(ofproto
, fm
, req
));
4468 rule_collection_destroy(&rules
);
4473 /* Implements OFPFC_MODIFY_STRICT. Returns 0 on success or an OpenFlow error
4474 * code on failure. */
4476 modify_flow_strict(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4477 const struct flow_mod_requester
*req
)
4478 OVS_REQUIRES(ofproto_mutex
)
4480 struct rule_criteria criteria
;
4481 struct rule_collection rules
;
4484 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4485 fm
->cookie
, fm
->cookie_mask
, OFPP_ANY
, OFPG11_ANY
);
4486 rule_criteria_require_rw(&criteria
,
4487 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4488 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4489 rule_criteria_destroy(&criteria
);
4493 error
= modify_flows_add(ofproto
, fm
, req
);
4494 } else if (rules
.n
== 1) {
4495 error
= modify_flows__(ofproto
, fm
, &rules
, req
);
4499 rule_collection_destroy(&rules
);
4504 /* OFPFC_DELETE implementation. */
4506 /* Deletes the rules listed in 'rules'. */
4508 delete_flows__(const struct rule_collection
*rules
,
4509 enum ofp_flow_removed_reason reason
,
4510 const struct flow_mod_requester
*req
)
4511 OVS_REQUIRES(ofproto_mutex
)
4514 struct list dead_cookies
= LIST_INITIALIZER(&dead_cookies
);
4515 struct ofproto
*ofproto
= rules
->rules
[0]->ofproto
;
4518 for (i
= 0; i
< rules
->n
; i
++) {
4519 struct rule
*rule
= rules
->rules
[i
];
4520 const struct rule_actions
*actions
= rule_get_actions(rule
);
4522 ofproto_rule_send_removed(rule
, reason
);
4524 ofmonitor_report(ofproto
->connmgr
, rule
, NXFME_DELETED
, reason
,
4525 req
? req
->ofconn
: NULL
, req
? req
->xid
: 0,
4527 oftable_remove_rule(rule
);
4528 ofproto
->ofproto_class
->rule_delete(rule
);
4530 learned_cookies_dec(ofproto
, actions
, &dead_cookies
);
4532 learned_cookies_flush(ofproto
, &dead_cookies
);
4533 ofmonitor_flush(ofproto
->connmgr
);
4537 /* Implements OFPFC_DELETE. */
4539 delete_flows_loose(struct ofproto
*ofproto
,
4540 const struct ofputil_flow_mod
*fm
,
4541 const struct flow_mod_requester
*req
)
4542 OVS_REQUIRES(ofproto_mutex
)
4544 struct rule_criteria criteria
;
4545 struct rule_collection rules
;
4548 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, 0,
4549 fm
->cookie
, fm
->cookie_mask
,
4550 fm
->out_port
, fm
->out_group
);
4551 rule_criteria_require_rw(&criteria
,
4552 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4553 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
4554 rule_criteria_destroy(&criteria
);
4556 if (!error
&& rules
.n
> 0) {
4557 delete_flows__(&rules
, fm
->delete_reason
, req
);
4559 rule_collection_destroy(&rules
);
4564 /* Implements OFPFC_DELETE_STRICT. */
4566 delete_flow_strict(struct ofproto
*ofproto
, const struct ofputil_flow_mod
*fm
,
4567 const struct flow_mod_requester
*req
)
4568 OVS_REQUIRES(ofproto_mutex
)
4570 struct rule_criteria criteria
;
4571 struct rule_collection rules
;
4574 rule_criteria_init(&criteria
, fm
->table_id
, &fm
->match
, fm
->priority
,
4575 fm
->cookie
, fm
->cookie_mask
,
4576 fm
->out_port
, fm
->out_group
);
4577 rule_criteria_require_rw(&criteria
,
4578 (fm
->flags
& OFPUTIL_FF_NO_READONLY
) != 0);
4579 error
= collect_rules_strict(ofproto
, &criteria
, &rules
);
4580 rule_criteria_destroy(&criteria
);
4582 if (!error
&& rules
.n
> 0) {
4583 delete_flows__(&rules
, fm
->delete_reason
, req
);
4585 rule_collection_destroy(&rules
);
4591 ofproto_rule_send_removed(struct rule
*rule
, uint8_t reason
)
4592 OVS_REQUIRES(ofproto_mutex
)
4594 struct ofputil_flow_removed fr
;
4597 if (rule_is_hidden(rule
) ||
4598 !(rule
->flags
& OFPUTIL_FF_SEND_FLOW_REM
)) {
4602 minimatch_expand(&rule
->cr
.match
, &fr
.match
);
4603 fr
.priority
= rule
->cr
.priority
;
4604 fr
.cookie
= rule
->flow_cookie
;
4606 fr
.table_id
= rule
->table_id
;
4607 calc_duration(rule
->created
, time_msec(),
4608 &fr
.duration_sec
, &fr
.duration_nsec
);
4609 ovs_mutex_lock(&rule
->mutex
);
4610 fr
.idle_timeout
= rule
->idle_timeout
;
4611 fr
.hard_timeout
= rule
->hard_timeout
;
4612 ovs_mutex_unlock(&rule
->mutex
);
4613 rule
->ofproto
->ofproto_class
->rule_get_stats(rule
, &fr
.packet_count
,
4614 &fr
.byte_count
, &used
);
4616 connmgr_send_flow_removed(rule
->ofproto
->connmgr
, &fr
);
4619 /* Sends an OpenFlow "flow removed" message with the given 'reason' (either
4620 * OFPRR_HARD_TIMEOUT or OFPRR_IDLE_TIMEOUT), and then removes 'rule' from its
4623 * ofproto implementation ->run() functions should use this function to expire
4624 * OpenFlow flows. */
4626 ofproto_rule_expire(struct rule
*rule
, uint8_t reason
)
4627 OVS_REQUIRES(ofproto_mutex
)
4629 ofproto_rule_delete__(rule
, reason
);
4632 /* Reduces '*timeout' to no more than 'max'. A value of zero in either case
4633 * means "infinite". */
4635 reduce_timeout(uint16_t max
, uint16_t *timeout
)
4637 if (max
&& (!*timeout
|| *timeout
> max
)) {
4642 /* If 'idle_timeout' is nonzero, and 'rule' has no idle timeout or an idle
4643 * timeout greater than 'idle_timeout', lowers 'rule''s idle timeout to
4644 * 'idle_timeout' seconds. Similarly for 'hard_timeout'.
4646 * Suitable for implementing OFPACT_FIN_TIMEOUT. */
4648 ofproto_rule_reduce_timeouts(struct rule
*rule
,
4649 uint16_t idle_timeout
, uint16_t hard_timeout
)
4650 OVS_EXCLUDED(ofproto_mutex
, rule
->mutex
)
4652 if (!idle_timeout
&& !hard_timeout
) {
4656 ovs_mutex_lock(&ofproto_mutex
);
4657 if (list_is_empty(&rule
->expirable
)) {
4658 list_insert(&rule
->ofproto
->expirable
, &rule
->expirable
);
4660 ovs_mutex_unlock(&ofproto_mutex
);
4662 ovs_mutex_lock(&rule
->mutex
);
4663 reduce_timeout(idle_timeout
, &rule
->idle_timeout
);
4664 reduce_timeout(hard_timeout
, &rule
->hard_timeout
);
4665 ovs_mutex_unlock(&rule
->mutex
);
4669 handle_flow_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4670 OVS_EXCLUDED(ofproto_mutex
)
4672 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
4673 struct ofputil_flow_mod fm
;
4674 uint64_t ofpacts_stub
[1024 / 8];
4675 struct ofpbuf ofpacts
;
4678 error
= reject_slave_controller(ofconn
);
4683 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
4684 error
= ofputil_decode_flow_mod(&fm
, oh
, ofconn_get_protocol(ofconn
),
4686 u16_to_ofp(ofproto
->max_ports
),
4689 error
= ofproto_check_ofpacts(ofproto
, fm
.ofpacts
, fm
.ofpacts_len
);
4692 struct flow_mod_requester req
;
4694 req
.ofconn
= ofconn
;
4696 error
= handle_flow_mod__(ofproto
, &fm
, &req
);
4699 goto exit_free_ofpacts
;
4702 ofconn_report_flow_mod(ofconn
, fm
.command
);
4705 ofpbuf_uninit(&ofpacts
);
4711 handle_flow_mod__(struct ofproto
*ofproto
, struct ofputil_flow_mod
*fm
,
4712 const struct flow_mod_requester
*req
)
4713 OVS_EXCLUDED(ofproto_mutex
)
4717 ovs_mutex_lock(&ofproto_mutex
);
4718 switch (fm
->command
) {
4720 error
= add_flow(ofproto
, fm
, req
);
4724 error
= modify_flows_loose(ofproto
, fm
, req
);
4727 case OFPFC_MODIFY_STRICT
:
4728 error
= modify_flow_strict(ofproto
, fm
, req
);
4732 error
= delete_flows_loose(ofproto
, fm
, req
);
4735 case OFPFC_DELETE_STRICT
:
4736 error
= delete_flow_strict(ofproto
, fm
, req
);
4740 if (fm
->command
> 0xff) {
4741 VLOG_WARN_RL(&rl
, "%s: flow_mod has explicit table_id but "
4742 "flow_mod_table_id extension is not enabled",
4745 error
= OFPERR_OFPFMFC_BAD_COMMAND
;
4748 ofmonitor_flush(ofproto
->connmgr
);
4749 ovs_mutex_unlock(&ofproto_mutex
);
4751 run_rule_executes(ofproto
);
4756 handle_role_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4758 struct ofputil_role_request request
;
4759 struct ofputil_role_request reply
;
4763 error
= ofputil_decode_role_message(oh
, &request
);
4768 if (request
.role
!= OFPCR12_ROLE_NOCHANGE
) {
4769 if (request
.have_generation_id
4770 && !ofconn_set_master_election_id(ofconn
, request
.generation_id
)) {
4771 return OFPERR_OFPRRFC_STALE
;
4774 ofconn_set_role(ofconn
, request
.role
);
4777 reply
.role
= ofconn_get_role(ofconn
);
4778 reply
.have_generation_id
= ofconn_get_master_election_id(
4779 ofconn
, &reply
.generation_id
);
4780 buf
= ofputil_encode_role_reply(oh
, &reply
);
4781 ofconn_send_reply(ofconn
, buf
);
4787 handle_nxt_flow_mod_table_id(struct ofconn
*ofconn
,
4788 const struct ofp_header
*oh
)
4790 const struct nx_flow_mod_table_id
*msg
= ofpmsg_body(oh
);
4791 enum ofputil_protocol cur
, next
;
4793 cur
= ofconn_get_protocol(ofconn
);
4794 next
= ofputil_protocol_set_tid(cur
, msg
->set
!= 0);
4795 ofconn_set_protocol(ofconn
, next
);
4801 handle_nxt_set_flow_format(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4803 const struct nx_set_flow_format
*msg
= ofpmsg_body(oh
);
4804 enum ofputil_protocol cur
, next
;
4805 enum ofputil_protocol next_base
;
4807 next_base
= ofputil_nx_flow_format_to_protocol(ntohl(msg
->format
));
4809 return OFPERR_OFPBRC_EPERM
;
4812 cur
= ofconn_get_protocol(ofconn
);
4813 next
= ofputil_protocol_set_base(cur
, next_base
);
4814 ofconn_set_protocol(ofconn
, next
);
4820 handle_nxt_set_packet_in_format(struct ofconn
*ofconn
,
4821 const struct ofp_header
*oh
)
4823 const struct nx_set_packet_in_format
*msg
= ofpmsg_body(oh
);
4826 format
= ntohl(msg
->format
);
4827 if (format
!= NXPIF_OPENFLOW10
&& format
!= NXPIF_NXM
) {
4828 return OFPERR_OFPBRC_EPERM
;
4831 ofconn_set_packet_in_format(ofconn
, format
);
4836 handle_nxt_set_async_config(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4838 const struct nx_async_config
*msg
= ofpmsg_body(oh
);
4839 uint32_t master
[OAM_N_TYPES
];
4840 uint32_t slave
[OAM_N_TYPES
];
4842 master
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[0]);
4843 master
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[0]);
4844 master
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[0]);
4846 slave
[OAM_PACKET_IN
] = ntohl(msg
->packet_in_mask
[1]);
4847 slave
[OAM_PORT_STATUS
] = ntohl(msg
->port_status_mask
[1]);
4848 slave
[OAM_FLOW_REMOVED
] = ntohl(msg
->flow_removed_mask
[1]);
4850 ofconn_set_async_config(ofconn
, master
, slave
);
4851 if (ofconn_get_type(ofconn
) == OFCONN_SERVICE
&&
4852 !ofconn_get_miss_send_len(ofconn
)) {
4853 ofconn_set_miss_send_len(ofconn
, OFP_DEFAULT_MISS_SEND_LEN
);
4860 handle_nxt_get_async_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4863 uint32_t master
[OAM_N_TYPES
];
4864 uint32_t slave
[OAM_N_TYPES
];
4865 struct nx_async_config
*msg
;
4867 ofconn_get_async_config(ofconn
, master
, slave
);
4868 buf
= ofpraw_alloc_reply(OFPRAW_OFPT13_GET_ASYNC_REPLY
, oh
, 0);
4869 msg
= ofpbuf_put_zeros(buf
, sizeof *msg
);
4871 msg
->packet_in_mask
[0] = htonl(master
[OAM_PACKET_IN
]);
4872 msg
->port_status_mask
[0] = htonl(master
[OAM_PORT_STATUS
]);
4873 msg
->flow_removed_mask
[0] = htonl(master
[OAM_FLOW_REMOVED
]);
4875 msg
->packet_in_mask
[1] = htonl(slave
[OAM_PACKET_IN
]);
4876 msg
->port_status_mask
[1] = htonl(slave
[OAM_PORT_STATUS
]);
4877 msg
->flow_removed_mask
[1] = htonl(slave
[OAM_FLOW_REMOVED
]);
4879 ofconn_send_reply(ofconn
, buf
);
4885 handle_nxt_set_controller_id(struct ofconn
*ofconn
,
4886 const struct ofp_header
*oh
)
4888 const struct nx_controller_id
*nci
= ofpmsg_body(oh
);
4890 if (!is_all_zeros(nci
->zero
, sizeof nci
->zero
)) {
4891 return OFPERR_NXBRC_MUST_BE_ZERO
;
4894 ofconn_set_controller_id(ofconn
, ntohs(nci
->controller_id
));
4899 handle_barrier_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
4903 buf
= ofpraw_alloc_reply((oh
->version
== OFP10_VERSION
4904 ? OFPRAW_OFPT10_BARRIER_REPLY
4905 : OFPRAW_OFPT11_BARRIER_REPLY
), oh
, 0);
4906 ofconn_send_reply(ofconn
, buf
);
4911 ofproto_compose_flow_refresh_update(const struct rule
*rule
,
4912 enum nx_flow_monitor_flags flags
,
4914 OVS_REQUIRES(ofproto_mutex
)
4916 const struct rule_actions
*actions
;
4917 struct ofputil_flow_update fu
;
4920 fu
.event
= (flags
& (NXFMF_INITIAL
| NXFMF_ADD
)
4921 ? NXFME_ADDED
: NXFME_MODIFIED
);
4923 ovs_mutex_lock(&rule
->mutex
);
4924 fu
.idle_timeout
= rule
->idle_timeout
;
4925 fu
.hard_timeout
= rule
->hard_timeout
;
4926 ovs_mutex_unlock(&rule
->mutex
);
4927 fu
.table_id
= rule
->table_id
;
4928 fu
.cookie
= rule
->flow_cookie
;
4929 minimatch_expand(&rule
->cr
.match
, &match
);
4931 fu
.priority
= rule
->cr
.priority
;
4933 actions
= flags
& NXFMF_ACTIONS
? rule_get_actions(rule
) : NULL
;
4934 fu
.ofpacts
= actions
? actions
->ofpacts
: NULL
;
4935 fu
.ofpacts_len
= actions
? actions
->ofpacts_len
: 0;
4937 if (list_is_empty(msgs
)) {
4938 ofputil_start_flow_update(msgs
);
4940 ofputil_append_flow_update(&fu
, msgs
);
4944 ofmonitor_compose_refresh_updates(struct rule_collection
*rules
,
4946 OVS_REQUIRES(ofproto_mutex
)
4950 for (i
= 0; i
< rules
->n
; i
++) {
4951 struct rule
*rule
= rules
->rules
[i
];
4952 enum nx_flow_monitor_flags flags
= rule
->monitor_flags
;
4953 rule
->monitor_flags
= 0;
4955 ofproto_compose_flow_refresh_update(rule
, flags
, msgs
);
4960 ofproto_collect_ofmonitor_refresh_rule(const struct ofmonitor
*m
,
4961 struct rule
*rule
, uint64_t seqno
,
4962 struct rule_collection
*rules
)
4963 OVS_REQUIRES(ofproto_mutex
)
4965 enum nx_flow_monitor_flags update
;
4967 if (rule_is_hidden(rule
)) {
4971 if (!ofproto_rule_has_out_port(rule
, m
->out_port
)) {
4976 if (rule
->add_seqno
> seqno
) {
4977 update
= NXFMF_ADD
| NXFMF_MODIFY
;
4978 } else if (rule
->modify_seqno
> seqno
) {
4979 update
= NXFMF_MODIFY
;
4984 if (!(m
->flags
& update
)) {
4988 update
= NXFMF_INITIAL
;
4991 if (!rule
->monitor_flags
) {
4992 rule_collection_add(rules
, rule
);
4994 rule
->monitor_flags
|= update
| (m
->flags
& NXFMF_ACTIONS
);
4998 ofproto_collect_ofmonitor_refresh_rules(const struct ofmonitor
*m
,
5000 struct rule_collection
*rules
)
5001 OVS_REQUIRES(ofproto_mutex
)
5003 const struct ofproto
*ofproto
= ofconn_get_ofproto(m
->ofconn
);
5004 const struct oftable
*table
;
5005 struct cls_rule target
;
5007 cls_rule_init_from_minimatch(&target
, &m
->match
, 0);
5008 FOR_EACH_MATCHING_TABLE (table
, m
->table_id
, ofproto
) {
5011 CLS_FOR_EACH_TARGET (rule
, cr
, &table
->cls
, &target
) {
5012 ofproto_collect_ofmonitor_refresh_rule(m
, rule
, seqno
, rules
);
5015 cls_rule_destroy(&target
);
5019 ofproto_collect_ofmonitor_initial_rules(struct ofmonitor
*m
,
5020 struct rule_collection
*rules
)
5021 OVS_REQUIRES(ofproto_mutex
)
5023 if (m
->flags
& NXFMF_INITIAL
) {
5024 ofproto_collect_ofmonitor_refresh_rules(m
, 0, rules
);
5029 ofmonitor_collect_resume_rules(struct ofmonitor
*m
,
5030 uint64_t seqno
, struct rule_collection
*rules
)
5031 OVS_REQUIRES(ofproto_mutex
)
5033 ofproto_collect_ofmonitor_refresh_rules(m
, seqno
, rules
);
5037 flow_monitor_delete(struct ofconn
*ofconn
, uint32_t id
)
5038 OVS_REQUIRES(ofproto_mutex
)
5040 struct ofmonitor
*m
;
5043 m
= ofmonitor_lookup(ofconn
, id
);
5045 ofmonitor_destroy(m
);
5048 error
= OFPERR_OFPMOFC_UNKNOWN_MONITOR
;
5055 handle_flow_monitor_request(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5056 OVS_EXCLUDED(ofproto_mutex
)
5058 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5059 struct ofmonitor
**monitors
;
5060 size_t n_monitors
, allocated_monitors
;
5061 struct rule_collection rules
;
5062 struct list replies
;
5067 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
5069 n_monitors
= allocated_monitors
= 0;
5071 ovs_mutex_lock(&ofproto_mutex
);
5073 struct ofputil_flow_monitor_request request
;
5074 struct ofmonitor
*m
;
5077 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
5078 if (retval
== EOF
) {
5080 } else if (retval
) {
5085 if (request
.table_id
!= 0xff
5086 && request
.table_id
>= ofproto
->n_tables
) {
5087 error
= OFPERR_OFPBRC_BAD_TABLE_ID
;
5091 error
= ofmonitor_create(&request
, ofconn
, &m
);
5096 if (n_monitors
>= allocated_monitors
) {
5097 monitors
= x2nrealloc(monitors
, &allocated_monitors
,
5100 monitors
[n_monitors
++] = m
;
5103 rule_collection_init(&rules
);
5104 for (i
= 0; i
< n_monitors
; i
++) {
5105 ofproto_collect_ofmonitor_initial_rules(monitors
[i
], &rules
);
5108 ofpmp_init(&replies
, oh
);
5109 ofmonitor_compose_refresh_updates(&rules
, &replies
);
5110 ovs_mutex_unlock(&ofproto_mutex
);
5112 rule_collection_destroy(&rules
);
5114 ofconn_send_replies(ofconn
, &replies
);
5120 for (i
= 0; i
< n_monitors
; i
++) {
5121 ofmonitor_destroy(monitors
[i
]);
5124 ovs_mutex_unlock(&ofproto_mutex
);
5130 handle_flow_monitor_cancel(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5131 OVS_EXCLUDED(ofproto_mutex
)
5136 id
= ofputil_decode_flow_monitor_cancel(oh
);
5138 ovs_mutex_lock(&ofproto_mutex
);
5139 error
= flow_monitor_delete(ofconn
, id
);
5140 ovs_mutex_unlock(&ofproto_mutex
);
5145 /* Meters implementation.
5147 * Meter table entry, indexed by the OpenFlow meter_id.
5148 * 'created' is used to compute the duration for meter stats.
5149 * 'list rules' is needed so that we can delete the dependent rules when the
5150 * meter table entry is deleted.
5151 * 'provider_meter_id' is for the provider's private use.
5154 long long int created
; /* Time created. */
5155 struct list rules
; /* List of "struct rule_dpif"s. */
5156 ofproto_meter_id provider_meter_id
;
5157 uint16_t flags
; /* Meter flags. */
5158 uint16_t n_bands
; /* Number of meter bands. */
5159 struct ofputil_meter_band
*bands
;
5163 * This is used in instruction validation at flow set-up time,
5164 * as flows may not use non-existing meters.
5165 * Return value of UINT32_MAX signifies an invalid meter.
5168 get_provider_meter_id(const struct ofproto
*ofproto
, uint32_t of_meter_id
)
5170 if (of_meter_id
&& of_meter_id
<= ofproto
->meter_features
.max_meters
) {
5171 const struct meter
*meter
= ofproto
->meters
[of_meter_id
];
5173 return meter
->provider_meter_id
.uint32
;
5179 /* Finds the meter invoked by 'rule''s actions and adds 'rule' to the meter's
5182 meter_insert_rule(struct rule
*rule
)
5184 const struct rule_actions
*a
= rule_get_actions(rule
);
5185 uint32_t meter_id
= ofpacts_get_meter(a
->ofpacts
, a
->ofpacts_len
);
5186 struct meter
*meter
= rule
->ofproto
->meters
[meter_id
];
5188 list_insert(&meter
->rules
, &rule
->meter_list_node
);
5192 meter_update(struct meter
*meter
, const struct ofputil_meter_config
*config
)
5196 meter
->flags
= config
->flags
;
5197 meter
->n_bands
= config
->n_bands
;
5198 meter
->bands
= xmemdup(config
->bands
,
5199 config
->n_bands
* sizeof *meter
->bands
);
5202 static struct meter
*
5203 meter_create(const struct ofputil_meter_config
*config
,
5204 ofproto_meter_id provider_meter_id
)
5206 struct meter
*meter
;
5208 meter
= xzalloc(sizeof *meter
);
5209 meter
->provider_meter_id
= provider_meter_id
;
5210 meter
->created
= time_msec();
5211 list_init(&meter
->rules
);
5213 meter_update(meter
, config
);
5219 meter_delete(struct ofproto
*ofproto
, uint32_t first
, uint32_t last
)
5220 OVS_REQUIRES(ofproto_mutex
)
5223 for (mid
= first
; mid
<= last
; ++mid
) {
5224 struct meter
*meter
= ofproto
->meters
[mid
];
5226 ofproto
->meters
[mid
] = NULL
;
5227 ofproto
->ofproto_class
->meter_del(ofproto
,
5228 meter
->provider_meter_id
);
5236 handle_add_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5238 ofproto_meter_id provider_meter_id
= { UINT32_MAX
};
5239 struct meter
**meterp
= &ofproto
->meters
[mm
->meter
.meter_id
];
5243 return OFPERR_OFPMMFC_METER_EXISTS
;
5246 error
= ofproto
->ofproto_class
->meter_set(ofproto
, &provider_meter_id
,
5249 ovs_assert(provider_meter_id
.uint32
!= UINT32_MAX
);
5250 *meterp
= meter_create(&mm
->meter
, provider_meter_id
);
5256 handle_modify_meter(struct ofproto
*ofproto
, struct ofputil_meter_mod
*mm
)
5258 struct meter
*meter
= ofproto
->meters
[mm
->meter
.meter_id
];
5260 uint32_t provider_meter_id
;
5263 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5266 provider_meter_id
= meter
->provider_meter_id
.uint32
;
5267 error
= ofproto
->ofproto_class
->meter_set(ofproto
,
5268 &meter
->provider_meter_id
,
5270 ovs_assert(meter
->provider_meter_id
.uint32
== provider_meter_id
);
5272 meter_update(meter
, &mm
->meter
);
5278 handle_delete_meter(struct ofconn
*ofconn
, struct ofputil_meter_mod
*mm
)
5279 OVS_EXCLUDED(ofproto_mutex
)
5281 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5282 uint32_t meter_id
= mm
->meter
.meter_id
;
5283 struct rule_collection rules
;
5284 enum ofperr error
= 0;
5285 uint32_t first
, last
;
5287 if (meter_id
== OFPM13_ALL
) {
5289 last
= ofproto
->meter_features
.max_meters
;
5291 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
) {
5294 first
= last
= meter_id
;
5297 /* First delete the rules that use this meter. If any of those rules are
5298 * currently being modified, postpone the whole operation until later. */
5299 rule_collection_init(&rules
);
5300 ovs_mutex_lock(&ofproto_mutex
);
5301 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5302 struct meter
*meter
= ofproto
->meters
[meter_id
];
5303 if (meter
&& !list_is_empty(&meter
->rules
)) {
5306 LIST_FOR_EACH (rule
, meter_list_node
, &meter
->rules
) {
5307 rule_collection_add(&rules
, rule
);
5312 delete_flows__(&rules
, OFPRR_METER_DELETE
, NULL
);
5315 /* Delete the meters. */
5316 meter_delete(ofproto
, first
, last
);
5318 ovs_mutex_unlock(&ofproto_mutex
);
5319 rule_collection_destroy(&rules
);
5325 handle_meter_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5327 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5328 struct ofputil_meter_mod mm
;
5329 uint64_t bands_stub
[256 / 8];
5330 struct ofpbuf bands
;
5334 error
= reject_slave_controller(ofconn
);
5339 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5341 error
= ofputil_decode_meter_mod(oh
, &mm
, &bands
);
5343 goto exit_free_bands
;
5346 meter_id
= mm
.meter
.meter_id
;
5348 if (mm
.command
!= OFPMC13_DELETE
) {
5349 /* Fails also when meters are not implemented by the provider. */
5350 if (meter_id
== 0 || meter_id
> OFPM13_MAX
) {
5351 error
= OFPERR_OFPMMFC_INVALID_METER
;
5352 goto exit_free_bands
;
5353 } else if (meter_id
> ofproto
->meter_features
.max_meters
) {
5354 error
= OFPERR_OFPMMFC_OUT_OF_METERS
;
5355 goto exit_free_bands
;
5357 if (mm
.meter
.n_bands
> ofproto
->meter_features
.max_bands
) {
5358 error
= OFPERR_OFPMMFC_OUT_OF_BANDS
;
5359 goto exit_free_bands
;
5363 switch (mm
.command
) {
5365 error
= handle_add_meter(ofproto
, &mm
);
5368 case OFPMC13_MODIFY
:
5369 error
= handle_modify_meter(ofproto
, &mm
);
5372 case OFPMC13_DELETE
:
5373 error
= handle_delete_meter(ofconn
, &mm
);
5377 error
= OFPERR_OFPMMFC_BAD_COMMAND
;
5382 ofpbuf_uninit(&bands
);
5387 handle_meter_features_request(struct ofconn
*ofconn
,
5388 const struct ofp_header
*request
)
5390 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5391 struct ofputil_meter_features features
;
5394 if (ofproto
->ofproto_class
->meter_get_features
) {
5395 ofproto
->ofproto_class
->meter_get_features(ofproto
, &features
);
5397 memset(&features
, 0, sizeof features
);
5399 b
= ofputil_encode_meter_features_reply(&features
, request
);
5401 ofconn_send_reply(ofconn
, b
);
5406 handle_meter_request(struct ofconn
*ofconn
, const struct ofp_header
*request
,
5409 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5410 struct list replies
;
5411 uint64_t bands_stub
[256 / 8];
5412 struct ofpbuf bands
;
5413 uint32_t meter_id
, first
, last
;
5415 ofputil_decode_meter_request(request
, &meter_id
);
5417 if (meter_id
== OFPM13_ALL
) {
5419 last
= ofproto
->meter_features
.max_meters
;
5421 if (!meter_id
|| meter_id
> ofproto
->meter_features
.max_meters
||
5422 !ofproto
->meters
[meter_id
]) {
5423 return OFPERR_OFPMMFC_UNKNOWN_METER
;
5425 first
= last
= meter_id
;
5428 ofpbuf_use_stub(&bands
, bands_stub
, sizeof bands_stub
);
5429 ofpmp_init(&replies
, request
);
5431 for (meter_id
= first
; meter_id
<= last
; ++meter_id
) {
5432 struct meter
*meter
= ofproto
->meters
[meter_id
];
5434 continue; /* Skip non-existing meters. */
5436 if (type
== OFPTYPE_METER_STATS_REQUEST
) {
5437 struct ofputil_meter_stats stats
;
5439 stats
.meter_id
= meter_id
;
5441 /* Provider sets the packet and byte counts, we do the rest. */
5442 stats
.flow_count
= list_size(&meter
->rules
);
5443 calc_duration(meter
->created
, time_msec(),
5444 &stats
.duration_sec
, &stats
.duration_nsec
);
5445 stats
.n_bands
= meter
->n_bands
;
5446 ofpbuf_clear(&bands
);
5448 = ofpbuf_put_uninit(&bands
,
5449 meter
->n_bands
* sizeof *stats
.bands
);
5451 if (!ofproto
->ofproto_class
->meter_get(ofproto
,
5452 meter
->provider_meter_id
,
5454 ofputil_append_meter_stats(&replies
, &stats
);
5456 } else { /* type == OFPTYPE_METER_CONFIG_REQUEST */
5457 struct ofputil_meter_config config
;
5459 config
.meter_id
= meter_id
;
5460 config
.flags
= meter
->flags
;
5461 config
.n_bands
= meter
->n_bands
;
5462 config
.bands
= meter
->bands
;
5463 ofputil_append_meter_config(&replies
, &config
);
5467 ofconn_send_replies(ofconn
, &replies
);
5468 ofpbuf_uninit(&bands
);
5473 ofproto_group_lookup__(const struct ofproto
*ofproto
, uint32_t group_id
,
5474 struct ofgroup
**group
)
5475 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5477 HMAP_FOR_EACH_IN_BUCKET (*group
, hmap_node
,
5478 hash_int(group_id
, 0), &ofproto
->groups
) {
5479 if ((*group
)->group_id
== group_id
) {
5487 /* If the group exists, this function increments the groups's reference count.
5489 * Make sure to call ofproto_group_unref() after no longer needing to maintain
5490 * a reference to the group. */
5492 ofproto_group_lookup(const struct ofproto
*ofproto
, uint32_t group_id
,
5493 struct ofgroup
**group
)
5497 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5498 found
= ofproto_group_lookup__(ofproto
, group_id
, group
);
5500 ofproto_group_ref(*group
);
5502 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5507 ofproto_group_exists__(const struct ofproto
*ofproto
, uint32_t group_id
)
5508 OVS_REQ_RDLOCK(ofproto
->groups_rwlock
)
5510 struct ofgroup
*grp
;
5512 HMAP_FOR_EACH_IN_BUCKET (grp
, hmap_node
,
5513 hash_int(group_id
, 0), &ofproto
->groups
) {
5514 if (grp
->group_id
== group_id
) {
5522 ofproto_group_exists(const struct ofproto
*ofproto
, uint32_t group_id
)
5523 OVS_EXCLUDED(ofproto
->groups_rwlock
)
5527 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5528 exists
= ofproto_group_exists__(ofproto
, group_id
);
5529 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5535 group_get_ref_count(struct ofgroup
*group
)
5536 OVS_EXCLUDED(ofproto_mutex
)
5538 struct ofproto
*ofproto
= CONST_CAST(struct ofproto
*, group
->ofproto
);
5539 struct rule_criteria criteria
;
5540 struct rule_collection rules
;
5545 match_init_catchall(&match
);
5546 rule_criteria_init(&criteria
, 0xff, &match
, 0, htonll(0), htonll(0),
5547 OFPP_ANY
, group
->group_id
);
5548 ovs_mutex_lock(&ofproto_mutex
);
5549 error
= collect_rules_loose(ofproto
, &criteria
, &rules
);
5550 ovs_mutex_unlock(&ofproto_mutex
);
5551 rule_criteria_destroy(&criteria
);
5553 count
= !error
&& rules
.n
< UINT32_MAX
? rules
.n
: UINT32_MAX
;
5555 rule_collection_destroy(&rules
);
5560 append_group_stats(struct ofgroup
*group
, struct list
*replies
)
5562 struct ofputil_group_stats ogs
;
5563 const struct ofproto
*ofproto
= group
->ofproto
;
5564 long long int now
= time_msec();
5567 ogs
.bucket_stats
= xmalloc(group
->n_buckets
* sizeof *ogs
.bucket_stats
);
5569 /* Provider sets the packet and byte counts, we do the rest. */
5570 ogs
.ref_count
= group_get_ref_count(group
);
5571 ogs
.n_buckets
= group
->n_buckets
;
5573 error
= (ofproto
->ofproto_class
->group_get_stats
5574 ? ofproto
->ofproto_class
->group_get_stats(group
, &ogs
)
5577 ogs
.packet_count
= UINT64_MAX
;
5578 ogs
.byte_count
= UINT64_MAX
;
5579 memset(ogs
.bucket_stats
, 0xff,
5580 ogs
.n_buckets
* sizeof *ogs
.bucket_stats
);
5583 ogs
.group_id
= group
->group_id
;
5584 calc_duration(group
->created
, now
, &ogs
.duration_sec
, &ogs
.duration_nsec
);
5586 ofputil_append_group_stats(replies
, &ogs
);
5588 free(ogs
.bucket_stats
);
5592 handle_group_request(struct ofconn
*ofconn
,
5593 const struct ofp_header
*request
, uint32_t group_id
,
5594 void (*cb
)(struct ofgroup
*, struct list
*replies
))
5596 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5597 struct ofgroup
*group
;
5598 struct list replies
;
5600 ofpmp_init(&replies
, request
);
5601 if (group_id
== OFPG_ALL
) {
5602 ovs_rwlock_rdlock(&ofproto
->groups_rwlock
);
5603 HMAP_FOR_EACH (group
, hmap_node
, &ofproto
->groups
) {
5604 cb(group
, &replies
);
5606 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5608 if (ofproto_group_lookup(ofproto
, group_id
, &group
)) {
5609 cb(group
, &replies
);
5610 ofproto_group_unref(group
);
5613 ofconn_send_replies(ofconn
, &replies
);
5617 handle_group_stats_request(struct ofconn
*ofconn
,
5618 const struct ofp_header
*request
)
5623 error
= ofputil_decode_group_stats_request(request
, &group_id
);
5628 handle_group_request(ofconn
, request
, group_id
, append_group_stats
);
5633 append_group_desc(struct ofgroup
*group
, struct list
*replies
)
5635 struct ofputil_group_desc gds
;
5637 gds
.group_id
= group
->group_id
;
5638 gds
.type
= group
->type
;
5639 ofputil_append_group_desc_reply(&gds
, &group
->buckets
, replies
);
5643 handle_group_desc_stats_request(struct ofconn
*ofconn
,
5644 const struct ofp_header
*request
)
5646 handle_group_request(ofconn
, request
,
5647 ofputil_decode_group_desc_request(request
),
5653 handle_group_features_stats_request(struct ofconn
*ofconn
,
5654 const struct ofp_header
*request
)
5656 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5659 msg
= ofputil_encode_group_features_reply(&p
->ogf
, request
);
5661 ofconn_send_reply(ofconn
, msg
);
5668 handle_queue_get_config_request(struct ofconn
*ofconn
,
5669 const struct ofp_header
*oh
)
5671 struct ofproto
*p
= ofconn_get_ofproto(ofconn
);
5672 struct netdev_queue_dump queue_dump
;
5673 struct ofport
*ofport
;
5674 unsigned int queue_id
;
5675 struct ofpbuf
*reply
;
5676 struct smap details
;
5680 error
= ofputil_decode_queue_get_config_request(oh
, &request
);
5685 ofport
= ofproto_get_port(p
, request
);
5687 return OFPERR_OFPQOFC_BAD_PORT
;
5690 reply
= ofputil_encode_queue_get_config_reply(oh
);
5692 smap_init(&details
);
5693 NETDEV_QUEUE_FOR_EACH (&queue_id
, &details
, &queue_dump
, ofport
->netdev
) {
5694 struct ofputil_queue_config queue
;
5696 /* None of the existing queues have compatible properties, so we
5697 * hard-code omitting min_rate and max_rate. */
5698 queue
.queue_id
= queue_id
;
5699 queue
.min_rate
= UINT16_MAX
;
5700 queue
.max_rate
= UINT16_MAX
;
5701 ofputil_append_queue_get_config_reply(reply
, &queue
);
5703 smap_destroy(&details
);
5705 ofconn_send_reply(ofconn
, reply
);
5711 init_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
,
5712 struct ofgroup
**ofgroup
)
5715 const long long int now
= time_msec();
5717 if (gm
->group_id
> OFPG_MAX
) {
5718 return OFPERR_OFPGMFC_INVALID_GROUP
;
5720 if (gm
->type
> OFPGT11_FF
) {
5721 return OFPERR_OFPGMFC_BAD_TYPE
;
5724 *ofgroup
= ofproto
->ofproto_class
->group_alloc();
5726 VLOG_WARN_RL(&rl
, "%s: failed to allocate group", ofproto
->name
);
5727 return OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5730 (*ofgroup
)->ofproto
= ofproto
;
5731 *CONST_CAST(uint32_t *, &((*ofgroup
)->group_id
)) = gm
->group_id
;
5732 *CONST_CAST(enum ofp11_group_type
*, &(*ofgroup
)->type
) = gm
->type
;
5733 *CONST_CAST(long long int *, &((*ofgroup
)->created
)) = now
;
5734 *CONST_CAST(long long int *, &((*ofgroup
)->modified
)) = now
;
5735 ovs_refcount_init(&(*ofgroup
)->ref_count
);
5737 list_move(&(*ofgroup
)->buckets
, &gm
->buckets
);
5738 *CONST_CAST(uint32_t *, &(*ofgroup
)->n_buckets
) =
5739 list_size(&(*ofgroup
)->buckets
);
5741 /* Construct called BEFORE any locks are held. */
5742 error
= ofproto
->ofproto_class
->group_construct(*ofgroup
);
5744 ofputil_bucket_list_destroy(&(*ofgroup
)->buckets
);
5745 ofproto
->ofproto_class
->group_dealloc(*ofgroup
);
5750 /* Implements the OFPGC11_ADD operation specified by 'gm', adding a group to
5751 * 'ofproto''s group table. Returns 0 on success or an OpenFlow error code on
5754 add_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5756 struct ofgroup
*ofgroup
;
5759 /* Allocate new group and initialize it. */
5760 error
= init_group(ofproto
, gm
, &ofgroup
);
5765 /* We wrlock as late as possible to minimize the time we jam any other
5766 * threads: No visible state changes before acquiring the lock. */
5767 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5769 if (ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5770 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5774 if (ofproto_group_exists__(ofproto
, gm
->group_id
)) {
5775 error
= OFPERR_OFPGMFC_GROUP_EXISTS
;
5780 /* Insert new group. */
5781 hmap_insert(&ofproto
->groups
, &ofgroup
->hmap_node
,
5782 hash_int(ofgroup
->group_id
, 0));
5783 ofproto
->n_groups
[ofgroup
->type
]++;
5785 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5790 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5791 ofproto
->ofproto_class
->group_destruct(ofgroup
);
5792 ofputil_bucket_list_destroy(&ofgroup
->buckets
);
5793 ofproto
->ofproto_class
->group_dealloc(ofgroup
);
5798 /* Implements OFPGC11_MODIFY. Returns 0 on success or an OpenFlow error code
5801 * Note that the group is re-created and then replaces the old group in
5802 * ofproto's ofgroup hash map. Thus, the group is never altered while users of
5803 * the xlate module hold a pointer to the group. */
5805 modify_group(struct ofproto
*ofproto
, struct ofputil_group_mod
*gm
)
5807 struct ofgroup
*ofgroup
, *new_ofgroup
, *retiring
;
5810 error
= init_group(ofproto
, gm
, &new_ofgroup
);
5815 retiring
= new_ofgroup
;
5817 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5818 if (!ofproto_group_lookup__(ofproto
, gm
->group_id
, &ofgroup
)) {
5819 error
= OFPERR_OFPGMFC_UNKNOWN_GROUP
;
5823 /* Ofproto's group write lock is held now. */
5824 if (ofgroup
->type
!= gm
->type
5825 && ofproto
->n_groups
[gm
->type
] >= ofproto
->ogf
.max_groups
[gm
->type
]) {
5826 error
= OFPERR_OFPGMFC_OUT_OF_GROUPS
;
5830 /* The group creation time does not change during modification. */
5831 *CONST_CAST(long long int *, &(new_ofgroup
->created
)) = ofgroup
->created
;
5832 *CONST_CAST(long long int *, &(new_ofgroup
->modified
)) = time_msec();
5834 error
= ofproto
->ofproto_class
->group_modify(new_ofgroup
);
5840 /* Replace ofgroup in ofproto's groups hash map with new_ofgroup. */
5841 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5842 hmap_insert(&ofproto
->groups
, &new_ofgroup
->hmap_node
,
5843 hash_int(new_ofgroup
->group_id
, 0));
5844 if (ofgroup
->type
!= new_ofgroup
->type
) {
5845 ofproto
->n_groups
[ofgroup
->type
]--;
5846 ofproto
->n_groups
[new_ofgroup
->type
]++;
5850 ofproto_group_unref(retiring
);
5851 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5856 delete_group__(struct ofproto
*ofproto
, struct ofgroup
*ofgroup
)
5857 OVS_RELEASES(ofproto
->groups_rwlock
)
5860 struct ofputil_flow_mod fm
;
5862 /* Delete all flow entries containing this group in a group action */
5863 match_init_catchall(&match
);
5864 flow_mod_init(&fm
, &match
, 0, NULL
, 0, OFPFC_DELETE
);
5865 fm
.delete_reason
= OFPRR_GROUP_DELETE
;
5866 fm
.out_group
= ofgroup
->group_id
;
5867 handle_flow_mod__(ofproto
, &fm
, NULL
);
5869 hmap_remove(&ofproto
->groups
, &ofgroup
->hmap_node
);
5870 /* No-one can find this group any more. */
5871 ofproto
->n_groups
[ofgroup
->type
]--;
5872 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5873 ofproto_group_unref(ofgroup
);
5876 /* Implements OFPGC11_DELETE. */
5878 delete_group(struct ofproto
*ofproto
, uint32_t group_id
)
5880 struct ofgroup
*ofgroup
;
5882 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5883 if (group_id
== OFPG_ALL
) {
5885 struct hmap_node
*node
= hmap_first(&ofproto
->groups
);
5889 ofgroup
= CONTAINER_OF(node
, struct ofgroup
, hmap_node
);
5890 delete_group__(ofproto
, ofgroup
);
5891 /* Lock for each node separately, so that we will not jam the
5892 * other threads for too long time. */
5893 ovs_rwlock_wrlock(&ofproto
->groups_rwlock
);
5896 HMAP_FOR_EACH_IN_BUCKET (ofgroup
, hmap_node
,
5897 hash_int(group_id
, 0), &ofproto
->groups
) {
5898 if (ofgroup
->group_id
== group_id
) {
5899 delete_group__(ofproto
, ofgroup
);
5904 ovs_rwlock_unlock(&ofproto
->groups_rwlock
);
5908 handle_group_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5910 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5911 struct ofputil_group_mod gm
;
5914 error
= reject_slave_controller(ofconn
);
5919 error
= ofputil_decode_group_mod(oh
, &gm
);
5924 switch (gm
.command
) {
5926 return add_group(ofproto
, &gm
);
5928 case OFPGC11_MODIFY
:
5929 return modify_group(ofproto
, &gm
);
5931 case OFPGC11_DELETE
:
5932 delete_group(ofproto
, gm
.group_id
);
5936 if (gm
.command
> OFPGC11_DELETE
) {
5937 VLOG_WARN_RL(&rl
, "%s: Invalid group_mod command type %d",
5938 ofproto
->name
, gm
.command
);
5940 return OFPERR_OFPGMFC_BAD_COMMAND
;
5944 enum ofputil_table_miss
5945 ofproto_table_get_miss_config(const struct ofproto
*ofproto
, uint8_t table_id
)
5947 enum ofputil_table_miss value
;
5949 atomic_read_relaxed(&ofproto
->tables
[table_id
].miss_config
, &value
);
5954 table_mod(struct ofproto
*ofproto
, const struct ofputil_table_mod
*tm
)
5956 if (!check_table_id(ofproto
, tm
->table_id
)) {
5957 return OFPERR_OFPTMFC_BAD_TABLE
;
5958 } else if (tm
->miss_config
!= OFPUTIL_TABLE_MISS_DEFAULT
) {
5959 if (tm
->table_id
== OFPTT_ALL
) {
5961 for (i
= 0; i
< ofproto
->n_tables
; i
++) {
5962 atomic_store_relaxed(&ofproto
->tables
[i
].miss_config
,
5966 atomic_store_relaxed(&ofproto
->tables
[tm
->table_id
].miss_config
,
5974 handle_table_mod(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5976 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
5977 struct ofputil_table_mod tm
;
5980 error
= reject_slave_controller(ofconn
);
5985 error
= ofputil_decode_table_mod(oh
, &tm
);
5990 return table_mod(ofproto
, &tm
);
5994 handle_bundle_control(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
5997 struct ofputil_bundle_ctrl_msg bctrl
;
5999 struct ofputil_bundle_ctrl_msg reply
;
6001 error
= ofputil_decode_bundle_ctrl(oh
, &bctrl
);
6006 reply
.bundle_id
= bctrl
.bundle_id
;
6008 switch (bctrl
.type
) {
6009 case OFPBCT_OPEN_REQUEST
:
6010 error
= ofp_bundle_open(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6011 reply
.type
= OFPBCT_OPEN_REPLY
;
6013 case OFPBCT_CLOSE_REQUEST
:
6014 error
= ofp_bundle_close(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6015 reply
.type
= OFPBCT_CLOSE_REPLY
;;
6017 case OFPBCT_COMMIT_REQUEST
:
6018 error
= ofp_bundle_commit(ofconn
, bctrl
.bundle_id
, bctrl
.flags
);
6019 reply
.type
= OFPBCT_COMMIT_REPLY
;
6021 case OFPBCT_DISCARD_REQUEST
:
6022 error
= ofp_bundle_discard(ofconn
, bctrl
.bundle_id
);
6023 reply
.type
= OFPBCT_DISCARD_REPLY
;
6026 case OFPBCT_OPEN_REPLY
:
6027 case OFPBCT_CLOSE_REPLY
:
6028 case OFPBCT_COMMIT_REPLY
:
6029 case OFPBCT_DISCARD_REPLY
:
6030 return OFPERR_OFPBFC_BAD_TYPE
;
6035 buf
= ofputil_encode_bundle_ctrl_reply(oh
, &reply
);
6036 ofconn_send_reply(ofconn
, buf
);
6043 handle_bundle_add(struct ofconn
*ofconn
, const struct ofp_header
*oh
)
6046 struct ofputil_bundle_add_msg badd
;
6048 error
= ofputil_decode_bundle_add(oh
, &badd
);
6053 return ofp_bundle_add_message(ofconn
, &badd
);
6057 handle_openflow__(struct ofconn
*ofconn
, const struct ofpbuf
*msg
)
6058 OVS_EXCLUDED(ofproto_mutex
)
6060 const struct ofp_header
*oh
= ofpbuf_data(msg
);
6064 error
= ofptype_decode(&type
, oh
);
6068 if (oh
->version
>= OFP13_VERSION
&& ofpmsg_is_stat_request(oh
)
6069 && ofpmp_more(oh
)) {
6070 /* We have no buffer implementation for multipart requests.
6071 * Report overflow for requests which consists of multiple
6073 return OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW
;
6077 /* OpenFlow requests. */
6078 case OFPTYPE_ECHO_REQUEST
:
6079 return handle_echo_request(ofconn
, oh
);
6081 case OFPTYPE_FEATURES_REQUEST
:
6082 return handle_features_request(ofconn
, oh
);
6084 case OFPTYPE_GET_CONFIG_REQUEST
:
6085 return handle_get_config_request(ofconn
, oh
);
6087 case OFPTYPE_SET_CONFIG
:
6088 return handle_set_config(ofconn
, oh
);
6090 case OFPTYPE_PACKET_OUT
:
6091 return handle_packet_out(ofconn
, oh
);
6093 case OFPTYPE_PORT_MOD
:
6094 return handle_port_mod(ofconn
, oh
);
6096 case OFPTYPE_FLOW_MOD
:
6097 return handle_flow_mod(ofconn
, oh
);
6099 case OFPTYPE_GROUP_MOD
:
6100 return handle_group_mod(ofconn
, oh
);
6102 case OFPTYPE_TABLE_MOD
:
6103 return handle_table_mod(ofconn
, oh
);
6105 case OFPTYPE_METER_MOD
:
6106 return handle_meter_mod(ofconn
, oh
);
6108 case OFPTYPE_BARRIER_REQUEST
:
6109 return handle_barrier_request(ofconn
, oh
);
6111 case OFPTYPE_ROLE_REQUEST
:
6112 return handle_role_request(ofconn
, oh
);
6114 /* OpenFlow replies. */
6115 case OFPTYPE_ECHO_REPLY
:
6118 /* Nicira extension requests. */
6119 case OFPTYPE_FLOW_MOD_TABLE_ID
:
6120 return handle_nxt_flow_mod_table_id(ofconn
, oh
);
6122 case OFPTYPE_SET_FLOW_FORMAT
:
6123 return handle_nxt_set_flow_format(ofconn
, oh
);
6125 case OFPTYPE_SET_PACKET_IN_FORMAT
:
6126 return handle_nxt_set_packet_in_format(ofconn
, oh
);
6128 case OFPTYPE_SET_CONTROLLER_ID
:
6129 return handle_nxt_set_controller_id(ofconn
, oh
);
6131 case OFPTYPE_FLOW_AGE
:
6132 /* Nothing to do. */
6135 case OFPTYPE_FLOW_MONITOR_CANCEL
:
6136 return handle_flow_monitor_cancel(ofconn
, oh
);
6138 case OFPTYPE_SET_ASYNC_CONFIG
:
6139 return handle_nxt_set_async_config(ofconn
, oh
);
6141 case OFPTYPE_GET_ASYNC_REQUEST
:
6142 return handle_nxt_get_async_request(ofconn
, oh
);
6144 /* Statistics requests. */
6145 case OFPTYPE_DESC_STATS_REQUEST
:
6146 return handle_desc_stats_request(ofconn
, oh
);
6148 case OFPTYPE_FLOW_STATS_REQUEST
:
6149 return handle_flow_stats_request(ofconn
, oh
);
6151 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
6152 return handle_aggregate_stats_request(ofconn
, oh
);
6154 case OFPTYPE_TABLE_STATS_REQUEST
:
6155 return handle_table_stats_request(ofconn
, oh
);
6157 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST
:
6158 return handle_table_features_request(ofconn
, oh
);
6160 case OFPTYPE_PORT_STATS_REQUEST
:
6161 return handle_port_stats_request(ofconn
, oh
);
6163 case OFPTYPE_QUEUE_STATS_REQUEST
:
6164 return handle_queue_stats_request(ofconn
, oh
);
6166 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
6167 return handle_port_desc_stats_request(ofconn
, oh
);
6169 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
6170 return handle_flow_monitor_request(ofconn
, oh
);
6172 case OFPTYPE_METER_STATS_REQUEST
:
6173 case OFPTYPE_METER_CONFIG_STATS_REQUEST
:
6174 return handle_meter_request(ofconn
, oh
, type
);
6176 case OFPTYPE_METER_FEATURES_STATS_REQUEST
:
6177 return handle_meter_features_request(ofconn
, oh
);
6179 case OFPTYPE_GROUP_STATS_REQUEST
:
6180 return handle_group_stats_request(ofconn
, oh
);
6182 case OFPTYPE_GROUP_DESC_STATS_REQUEST
:
6183 return handle_group_desc_stats_request(ofconn
, oh
);
6185 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST
:
6186 return handle_group_features_stats_request(ofconn
, oh
);
6188 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
6189 return handle_queue_get_config_request(ofconn
, oh
);
6191 case OFPTYPE_BUNDLE_CONTROL
:
6192 return handle_bundle_control(ofconn
, oh
);
6194 case OFPTYPE_BUNDLE_ADD_MESSAGE
:
6195 return handle_bundle_add(ofconn
, oh
);
6199 case OFPTYPE_FEATURES_REPLY
:
6200 case OFPTYPE_GET_CONFIG_REPLY
:
6201 case OFPTYPE_PACKET_IN
:
6202 case OFPTYPE_FLOW_REMOVED
:
6203 case OFPTYPE_PORT_STATUS
:
6204 case OFPTYPE_BARRIER_REPLY
:
6205 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
6206 case OFPTYPE_DESC_STATS_REPLY
:
6207 case OFPTYPE_FLOW_STATS_REPLY
:
6208 case OFPTYPE_QUEUE_STATS_REPLY
:
6209 case OFPTYPE_PORT_STATS_REPLY
:
6210 case OFPTYPE_TABLE_STATS_REPLY
:
6211 case OFPTYPE_AGGREGATE_STATS_REPLY
:
6212 case OFPTYPE_PORT_DESC_STATS_REPLY
:
6213 case OFPTYPE_ROLE_REPLY
:
6214 case OFPTYPE_FLOW_MONITOR_PAUSED
:
6215 case OFPTYPE_FLOW_MONITOR_RESUMED
:
6216 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
6217 case OFPTYPE_GET_ASYNC_REPLY
:
6218 case OFPTYPE_GROUP_STATS_REPLY
:
6219 case OFPTYPE_GROUP_DESC_STATS_REPLY
:
6220 case OFPTYPE_GROUP_FEATURES_STATS_REPLY
:
6221 case OFPTYPE_METER_STATS_REPLY
:
6222 case OFPTYPE_METER_CONFIG_STATS_REPLY
:
6223 case OFPTYPE_METER_FEATURES_STATS_REPLY
:
6224 case OFPTYPE_TABLE_FEATURES_STATS_REPLY
:
6225 case OFPTYPE_ROLE_STATUS
:
6227 if (ofpmsg_is_stat_request(oh
)) {
6228 return OFPERR_OFPBRC_BAD_STAT
;
6230 return OFPERR_OFPBRC_BAD_TYPE
;
6236 handle_openflow(struct ofconn
*ofconn
, const struct ofpbuf
*ofp_msg
)
6237 OVS_EXCLUDED(ofproto_mutex
)
6239 int error
= handle_openflow__(ofconn
, ofp_msg
);
6241 ofconn_send_error(ofconn
, ofpbuf_data(ofp_msg
), error
);
6243 COVERAGE_INC(ofproto_recv_openflow
);
6246 /* Asynchronous operations. */
6249 send_buffered_packet(struct ofconn
*ofconn
, uint32_t buffer_id
,
6251 OVS_REQUIRES(ofproto_mutex
)
6253 enum ofperr error
= 0;
6254 if (ofconn
&& buffer_id
!= UINT32_MAX
) {
6255 struct ofproto
*ofproto
= ofconn_get_ofproto(ofconn
);
6256 struct ofpbuf
*packet
;
6259 error
= ofconn_pktbuf_retrieve(ofconn
, buffer_id
, &packet
, &in_port
);
6261 struct rule_execute
*re
;
6263 ofproto_rule_ref(rule
);
6265 re
= xmalloc(sizeof *re
);
6267 re
->in_port
= in_port
;
6268 re
->packet
= packet
;
6270 if (!guarded_list_push_back(&ofproto
->rule_executes
,
6271 &re
->list_node
, 1024)) {
6272 ofproto_rule_unref(rule
);
6273 ofpbuf_delete(re
->packet
);
6282 pick_datapath_id(const struct ofproto
*ofproto
)
6284 const struct ofport
*port
;
6286 port
= ofproto_get_port(ofproto
, OFPP_LOCAL
);
6288 uint8_t ea
[ETH_ADDR_LEN
];
6291 error
= netdev_get_etheraddr(port
->netdev
, ea
);
6293 return eth_addr_to_uint64(ea
);
6295 VLOG_WARN("%s: could not get MAC address for %s (%s)",
6296 ofproto
->name
, netdev_get_name(port
->netdev
),
6297 ovs_strerror(error
));
6299 return ofproto
->fallback_dpid
;
6303 pick_fallback_dpid(void)
6305 uint8_t ea
[ETH_ADDR_LEN
];
6306 eth_addr_nicira_random(ea
);
6307 return eth_addr_to_uint64(ea
);
6310 /* Table overflow policy. */
6312 /* Chooses and updates 'rulep' with a rule to evict from 'table'. Sets 'rulep'
6313 * to NULL if the table is not configured to evict rules or if the table
6314 * contains no evictable rules. (Rules with a readlock on their evict rwlock,
6315 * or with no timeouts are not evictable.) */
6317 choose_rule_to_evict(struct oftable
*table
, struct rule
**rulep
)
6318 OVS_REQUIRES(ofproto_mutex
)
6320 struct eviction_group
*evg
;
6323 if (!table
->eviction_fields
) {
6327 /* In the common case, the outer and inner loops here will each be entered
6330 * - The inner loop normally "return"s in its first iteration. If the
6331 * eviction group has any evictable rules, then it always returns in
6334 * - The outer loop only iterates more than once if the largest eviction
6335 * group has no evictable rules.
6337 * - The outer loop can exit only if table's 'max_flows' is all filled up
6338 * by unevictable rules. */
6339 HEAP_FOR_EACH (evg
, size_node
, &table
->eviction_groups_by_size
) {
6342 HEAP_FOR_EACH (rule
, evg_node
, &evg
->rules
) {
6351 /* Eviction groups. */
6353 /* Returns the priority to use for an eviction_group that contains 'n_rules'
6354 * rules. The priority contains low-order random bits to ensure that eviction
6355 * groups with the same number of rules are prioritized randomly. */
6357 eviction_group_priority(size_t n_rules
)
6359 uint16_t size
= MIN(UINT16_MAX
, n_rules
);
6360 return (size
<< 16) | random_uint16();
6363 /* Updates 'evg', an eviction_group within 'table', following a change that
6364 * adds or removes rules in 'evg'. */
6366 eviction_group_resized(struct oftable
*table
, struct eviction_group
*evg
)
6367 OVS_REQUIRES(ofproto_mutex
)
6369 heap_change(&table
->eviction_groups_by_size
, &evg
->size_node
,
6370 eviction_group_priority(heap_count(&evg
->rules
)));
6373 /* Destroys 'evg', an eviction_group within 'table':
6375 * - Removes all the rules, if any, from 'evg'. (It doesn't destroy the
6376 * rules themselves, just removes them from the eviction group.)
6378 * - Removes 'evg' from 'table'.
6382 eviction_group_destroy(struct oftable
*table
, struct eviction_group
*evg
)
6383 OVS_REQUIRES(ofproto_mutex
)
6385 while (!heap_is_empty(&evg
->rules
)) {
6388 rule
= CONTAINER_OF(heap_pop(&evg
->rules
), struct rule
, evg_node
);
6389 rule
->eviction_group
= NULL
;
6391 hmap_remove(&table
->eviction_groups_by_id
, &evg
->id_node
);
6392 heap_remove(&table
->eviction_groups_by_size
, &evg
->size_node
);
6393 heap_destroy(&evg
->rules
);
6397 /* Removes 'rule' from its eviction group, if any. */
6399 eviction_group_remove_rule(struct rule
*rule
)
6400 OVS_REQUIRES(ofproto_mutex
)
6402 if (rule
->eviction_group
) {
6403 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6404 struct eviction_group
*evg
= rule
->eviction_group
;
6406 rule
->eviction_group
= NULL
;
6407 heap_remove(&evg
->rules
, &rule
->evg_node
);
6408 if (heap_is_empty(&evg
->rules
)) {
6409 eviction_group_destroy(table
, evg
);
6411 eviction_group_resized(table
, evg
);
6416 /* Hashes the 'rule''s values for the eviction_fields of 'rule''s table, and
6417 * returns the hash value. */
6419 eviction_group_hash_rule(struct rule
*rule
)
6420 OVS_REQUIRES(ofproto_mutex
)
6422 struct oftable
*table
= &rule
->ofproto
->tables
[rule
->table_id
];
6423 const struct mf_subfield
*sf
;
6427 hash
= table
->eviction_group_id_basis
;
6428 miniflow_expand(&rule
->cr
.match
.flow
, &flow
);
6429 for (sf
= table
->eviction_fields
;
6430 sf
< &table
->eviction_fields
[table
->n_eviction_fields
];
6433 if (mf_are_prereqs_ok(sf
->field
, &flow
)) {
6434 union mf_value value
;
6436 mf_get_value(sf
->field
, &flow
, &value
);
6438 bitwise_zero(&value
, sf
->field
->n_bytes
, 0, sf
->ofs
);
6440 if (sf
->ofs
+ sf
->n_bits
< sf
->field
->n_bytes
* 8) {
6441 unsigned int start
= sf
->ofs
+ sf
->n_bits
;
6442 bitwise_zero(&value
, sf
->field
->n_bytes
, start
,
6443 sf
->field
->n_bytes
* 8 - start
);
6445 hash
= hash_bytes(&value
, sf
->field
->n_bytes
, hash
);
6447 hash
= hash_int(hash
, 0);
6454 /* Returns an eviction group within 'table' with the given 'id', creating one
6456 static struct eviction_group
*
6457 eviction_group_find(struct oftable
*table
, uint32_t id
)
6458 OVS_REQUIRES(ofproto_mutex
)
6460 struct eviction_group
*evg
;
6462 HMAP_FOR_EACH_WITH_HASH (evg
, id_node
, id
, &table
->eviction_groups_by_id
) {
6466 evg
= xmalloc(sizeof *evg
);
6467 hmap_insert(&table
->eviction_groups_by_id
, &evg
->id_node
, id
);
6468 heap_insert(&table
->eviction_groups_by_size
, &evg
->size_node
,
6469 eviction_group_priority(0));
6470 heap_init(&evg
->rules
);
6475 /* Returns an eviction priority for 'rule'. The return value should be
6476 * interpreted so that higher priorities make a rule more attractive candidates
6478 * Called only if have a timeout. */
6480 rule_eviction_priority(struct ofproto
*ofproto
, struct rule
*rule
)
6481 OVS_REQUIRES(ofproto_mutex
)
6483 long long int expiration
= LLONG_MAX
;
6484 long long int modified
;
6485 uint32_t expiration_offset
;
6487 /* 'modified' needs protection even when we hold 'ofproto_mutex'. */
6488 ovs_mutex_lock(&rule
->mutex
);
6489 modified
= rule
->modified
;
6490 ovs_mutex_unlock(&rule
->mutex
);
6492 if (rule
->hard_timeout
) {
6493 expiration
= modified
+ rule
->hard_timeout
* 1000;
6495 if (rule
->idle_timeout
) {
6496 uint64_t packets
, bytes
;
6498 long long int idle_expiration
;
6500 ofproto
->ofproto_class
->rule_get_stats(rule
, &packets
, &bytes
, &used
);
6501 idle_expiration
= used
+ rule
->idle_timeout
* 1000;
6502 expiration
= MIN(expiration
, idle_expiration
);
6505 if (expiration
== LLONG_MAX
) {
6509 /* Calculate the time of expiration as a number of (approximate) seconds
6510 * after program startup.
6512 * This should work OK for program runs that last UINT32_MAX seconds or
6513 * less. Therefore, please restart OVS at least once every 136 years. */
6514 expiration_offset
= (expiration
>> 10) - (time_boot_msec() >> 10);
6516 /* Invert the expiration offset because we're using a max-heap. */
6517 return UINT32_MAX
- expiration_offset
;
6520 /* Adds 'rule' to an appropriate eviction group for its oftable's
6521 * configuration. Does nothing if 'rule''s oftable doesn't have eviction
6522 * enabled, or if 'rule' is a permanent rule (one that will never expire on its
6525 * The caller must ensure that 'rule' is not already in an eviction group. */
6527 eviction_group_add_rule(struct rule
*rule
)
6528 OVS_REQUIRES(ofproto_mutex
)
6530 struct ofproto
*ofproto
= rule
->ofproto
;
6531 struct oftable
*table
= &ofproto
->tables
[rule
->table_id
];
6534 /* Timeouts may be modified only when holding 'ofproto_mutex'. We have it
6535 * so no additional protection is needed. */
6536 has_timeout
= rule
->hard_timeout
|| rule
->idle_timeout
;
6538 if (table
->eviction_fields
&& has_timeout
) {
6539 struct eviction_group
*evg
;
6541 evg
= eviction_group_find(table
, eviction_group_hash_rule(rule
));
6543 rule
->eviction_group
= evg
;
6544 heap_insert(&evg
->rules
, &rule
->evg_node
,
6545 rule_eviction_priority(ofproto
, rule
));
6546 eviction_group_resized(table
, evg
);
6552 /* Initializes 'table'. */
6554 oftable_init(struct oftable
*table
)
6556 memset(table
, 0, sizeof *table
);
6557 classifier_init(&table
->cls
, flow_segment_u32s
);
6558 table
->max_flows
= UINT_MAX
;
6559 atomic_init(&table
->miss_config
, OFPUTIL_TABLE_MISS_DEFAULT
);
6561 classifier_set_prefix_fields(&table
->cls
, default_prefix_fields
,
6562 ARRAY_SIZE(default_prefix_fields
));
6564 atomic_init(&table
->n_matched
, 0);
6565 atomic_init(&table
->n_missed
, 0);
6568 /* Destroys 'table', including its classifier and eviction groups.
6570 * The caller is responsible for freeing 'table' itself. */
6572 oftable_destroy(struct oftable
*table
)
6574 ovs_assert(classifier_is_empty(&table
->cls
));
6575 oftable_disable_eviction(table
);
6576 classifier_destroy(&table
->cls
);
6580 /* Changes the name of 'table' to 'name'. If 'name' is NULL or the empty
6581 * string, then 'table' will use its default name.
6583 * This only affects the name exposed for a table exposed through the OpenFlow
6584 * OFPST_TABLE (as printed by "ovs-ofctl dump-tables"). */
6586 oftable_set_name(struct oftable
*table
, const char *name
)
6588 if (name
&& name
[0]) {
6589 int len
= strnlen(name
, OFP_MAX_TABLE_NAME_LEN
);
6590 if (!table
->name
|| strncmp(name
, table
->name
, len
)) {
6592 table
->name
= xmemdup0(name
, len
);
6600 /* oftables support a choice of two policies when adding a rule would cause the
6601 * number of flows in the table to exceed the configured maximum number: either
6602 * they can refuse to add the new flow or they can evict some existing flow.
6603 * This function configures the former policy on 'table'. */
6605 oftable_disable_eviction(struct oftable
*table
)
6606 OVS_REQUIRES(ofproto_mutex
)
6608 if (table
->eviction_fields
) {
6609 struct eviction_group
*evg
, *next
;
6611 HMAP_FOR_EACH_SAFE (evg
, next
, id_node
,
6612 &table
->eviction_groups_by_id
) {
6613 eviction_group_destroy(table
, evg
);
6615 hmap_destroy(&table
->eviction_groups_by_id
);
6616 heap_destroy(&table
->eviction_groups_by_size
);
6618 free(table
->eviction_fields
);
6619 table
->eviction_fields
= NULL
;
6620 table
->n_eviction_fields
= 0;
6624 /* oftables support a choice of two policies when adding a rule would cause the
6625 * number of flows in the table to exceed the configured maximum number: either
6626 * they can refuse to add the new flow or they can evict some existing flow.
6627 * This function configures the latter policy on 'table', with fairness based
6628 * on the values of the 'n_fields' fields specified in 'fields'. (Specifying
6629 * 'n_fields' as 0 disables fairness.) */
6631 oftable_enable_eviction(struct oftable
*table
,
6632 const struct mf_subfield
*fields
, size_t n_fields
)
6633 OVS_REQUIRES(ofproto_mutex
)
6637 if (table
->eviction_fields
6638 && n_fields
== table
->n_eviction_fields
6640 || !memcmp(fields
, table
->eviction_fields
,
6641 n_fields
* sizeof *fields
))) {
6646 oftable_disable_eviction(table
);
6648 table
->n_eviction_fields
= n_fields
;
6649 table
->eviction_fields
= xmemdup(fields
, n_fields
* sizeof *fields
);
6651 table
->eviction_group_id_basis
= random_uint32();
6652 hmap_init(&table
->eviction_groups_by_id
);
6653 heap_init(&table
->eviction_groups_by_size
);
6655 CLS_FOR_EACH (rule
, cr
, &table
->cls
) {
6656 eviction_group_add_rule(rule
);
6660 /* Removes 'rule' from the oftable that contains it. */
6662 oftable_remove_rule__(struct ofproto
*ofproto
, struct rule
*rule
)
6663 OVS_REQUIRES(ofproto_mutex
)
6665 struct classifier
*cls
= &ofproto
->tables
[rule
->table_id
].cls
;
6667 classifier_remove(cls
, CONST_CAST(struct cls_rule
*, &rule
->cr
));
6669 cookies_remove(ofproto
, rule
);
6671 eviction_group_remove_rule(rule
);
6672 if (!list_is_empty(&rule
->expirable
)) {
6673 list_remove(&rule
->expirable
);
6675 if (!list_is_empty(&rule
->meter_list_node
)) {
6676 list_remove(&rule
->meter_list_node
);
6677 list_init(&rule
->meter_list_node
);
6682 oftable_remove_rule(struct rule
*rule
)
6683 OVS_REQUIRES(ofproto_mutex
)
6685 oftable_remove_rule__(rule
->ofproto
, rule
);
6688 /* unixctl commands. */
6691 ofproto_lookup(const char *name
)
6693 struct ofproto
*ofproto
;
6695 HMAP_FOR_EACH_WITH_HASH (ofproto
, hmap_node
, hash_string(name
, 0),
6697 if (!strcmp(ofproto
->name
, name
)) {
6705 ofproto_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
6706 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
6708 struct ofproto
*ofproto
;
6712 HMAP_FOR_EACH (ofproto
, hmap_node
, &all_ofprotos
) {
6713 ds_put_format(&results
, "%s\n", ofproto
->name
);
6715 unixctl_command_reply(conn
, ds_cstr(&results
));
6716 ds_destroy(&results
);
6720 ofproto_unixctl_init(void)
6722 static bool registered
;
6728 unixctl_command_register("ofproto/list", "", 0, 0,
6729 ofproto_unixctl_list
, NULL
);
6732 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
6734 * This is deprecated. It is only for compatibility with broken device drivers
6735 * in old versions of Linux that do not properly support VLANs when VLAN
6736 * devices are not used. When broken device drivers are no longer in
6737 * widespread use, we will delete these interfaces. */
6739 /* Sets a 1-bit in the 4096-bit 'vlan_bitmap' for each VLAN ID that is matched
6740 * (exactly) by an OpenFlow rule in 'ofproto'. */
6742 ofproto_get_vlan_usage(struct ofproto
*ofproto
, unsigned long int *vlan_bitmap
)
6745 struct cls_rule target
;
6746 const struct oftable
*oftable
;
6748 match_init_catchall(&match
);
6749 match_set_vlan_vid_masked(&match
, htons(VLAN_CFI
), htons(VLAN_CFI
));
6750 cls_rule_init(&target
, &match
, 0);
6752 free(ofproto
->vlan_bitmap
);
6753 ofproto
->vlan_bitmap
= bitmap_allocate(4096);
6754 ofproto
->vlans_changed
= false;
6756 OFPROTO_FOR_EACH_TABLE (oftable
, ofproto
) {
6759 CLS_FOR_EACH_TARGET (rule
, cr
, &oftable
->cls
, &target
) {
6760 if (minimask_get_vid_mask(&rule
->cr
.match
.mask
) == VLAN_VID_MASK
) {
6761 uint16_t vid
= miniflow_get_vid(&rule
->cr
.match
.flow
);
6763 bitmap_set1(vlan_bitmap
, vid
);
6764 bitmap_set1(ofproto
->vlan_bitmap
, vid
);
6769 cls_rule_destroy(&target
);
6772 /* Returns true if new VLANs have come into use by the flow table since the
6773 * last call to ofproto_get_vlan_usage().
6775 * We don't track when old VLANs stop being used. */
6777 ofproto_has_vlan_usage_changed(const struct ofproto
*ofproto
)
6779 return ofproto
->vlans_changed
;
6782 /* Configures a VLAN splinter binding between the ports identified by OpenFlow
6783 * port numbers 'vlandev_ofp_port' and 'realdev_ofp_port'. If
6784 * 'realdev_ofp_port' is nonzero, then the VLAN device is enslaved to the real
6785 * device as a VLAN splinter for VLAN ID 'vid'. If 'realdev_ofp_port' is zero,
6786 * then the VLAN device is un-enslaved. */
6788 ofproto_port_set_realdev(struct ofproto
*ofproto
, ofp_port_t vlandev_ofp_port
,
6789 ofp_port_t realdev_ofp_port
, int vid
)
6791 struct ofport
*ofport
;
6794 ovs_assert(vlandev_ofp_port
!= realdev_ofp_port
);
6796 ofport
= ofproto_get_port(ofproto
, vlandev_ofp_port
);
6798 VLOG_WARN("%s: cannot set realdev on nonexistent port %"PRIu16
,
6799 ofproto
->name
, vlandev_ofp_port
);
6803 if (!ofproto
->ofproto_class
->set_realdev
) {
6804 if (!vlandev_ofp_port
) {
6807 VLOG_WARN("%s: vlan splinters not supported", ofproto
->name
);
6811 error
= ofproto
->ofproto_class
->set_realdev(ofport
, realdev_ofp_port
, vid
);
6813 VLOG_WARN("%s: setting realdev on port %"PRIu16
" (%s) failed (%s)",
6814 ofproto
->name
, vlandev_ofp_port
,
6815 netdev_get_name(ofport
->netdev
), ovs_strerror(error
));